Commit | Line | Data |
---|---|---|
ccefe4c4 TT |
1 | /* Private partial symbol table definitions. |
2 | ||
32d0add0 | 3 | Copyright (C) 2009-2015 Free Software Foundation, Inc. |
ccefe4c4 TT |
4 | |
5 | This file is part of GDB. | |
6 | ||
7 | This program is free software; you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
9 | the Free Software Foundation; either version 3 of the License, or | |
10 | (at your option) any later version. | |
11 | ||
12 | This program is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ | |
19 | ||
20 | #ifndef PSYMPRIV_H | |
21 | #define PSYMPRIV_H | |
22 | ||
23 | #include "psymtab.h" | |
24 | ||
923c6a3d TT |
25 | struct psymbol_allocation_list; |
26 | ||
ccefe4c4 TT |
27 | /* A partial_symbol records the name, domain, and address class of |
28 | symbols whose types we have not parsed yet. For functions, it also | |
29 | contains their memory address, so we can find them from a PC value. | |
30 | Each partial_symbol sits in a partial_symtab, all of which are chained | |
95cf5869 | 31 | on a partial symtab list and which points to the corresponding |
ccefe4c4 TT |
32 | normal symtab once the partial_symtab has been referenced. */ |
33 | ||
34 | /* This structure is space critical. See space comments at the top of | |
0df8b418 | 35 | symtab.h. */ |
ccefe4c4 TT |
36 | |
37 | struct partial_symbol | |
38 | { | |
0df8b418 | 39 | /* The general symbol info required for all types of symbols. */ |
ccefe4c4 TT |
40 | |
41 | struct general_symbol_info ginfo; | |
42 | ||
43 | /* Name space code. */ | |
44 | ||
51cdc993 | 45 | ENUM_BITFIELD(domain_enum_tag) domain : SYMBOL_DOMAIN_BITS; |
ccefe4c4 | 46 | |
f1e6e072 TT |
47 | /* Address class (for info_symbols). Note that we don't allow |
48 | synthetic "aclass" values here at present, simply because there's | |
49 | no need. */ | |
ccefe4c4 | 50 | |
51cdc993 | 51 | ENUM_BITFIELD(address_class) aclass : SYMBOL_ACLASS_BITS; |
ccefe4c4 TT |
52 | }; |
53 | ||
54 | #define PSYMBOL_DOMAIN(psymbol) (psymbol)->domain | |
55 | #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass | |
56 | ||
9439a077 TT |
57 | /* A convenience enum to give names to some constants used when |
58 | searching psymtabs. This is internal to psymtab and should not be | |
59 | used elsewhere. */ | |
60 | ||
61 | enum psymtab_search_status | |
62 | { | |
63 | PST_NOT_SEARCHED, | |
64 | PST_SEARCHED_AND_FOUND, | |
65 | PST_SEARCHED_AND_NOT_FOUND | |
66 | }; | |
67 | ||
ccefe4c4 TT |
68 | /* Each source file that has not been fully read in is represented by |
69 | a partial_symtab. This contains the information on where in the | |
70 | executable the debugging symbols for a specific file are, and a | |
71 | list of names of global symbols which are located in this file. | |
72 | They are all chained on partial symtab lists. | |
73 | ||
74 | Even after the source file has been read into a symtab, the | |
75 | partial_symtab remains around. They are allocated on an obstack, | |
76 | objfile_obstack. */ | |
77 | ||
78 | struct partial_symtab | |
79 | { | |
ccefe4c4 TT |
80 | /* Chain of all existing partial symtabs. */ |
81 | ||
82 | struct partial_symtab *next; | |
83 | ||
b4c41fc7 DE |
84 | /* Name of the source file which this partial_symtab defines, |
85 | or if the psymtab is anonymous then a descriptive name for | |
86 | debugging purposes, or "". It must not be NULL. */ | |
ccefe4c4 | 87 | |
72b9f47f | 88 | const char *filename; |
ccefe4c4 TT |
89 | |
90 | /* Full path of the source file. NULL if not known. */ | |
91 | ||
92 | char *fullname; | |
93 | ||
94 | /* Directory in which it was compiled, or NULL if we don't know. */ | |
95 | ||
72b9f47f | 96 | const char *dirname; |
ccefe4c4 | 97 | |
ccefe4c4 | 98 | /* Range of text addresses covered by this file; texthigh is the |
9750bca9 JK |
99 | beginning of the next section. Do not use if PSYMTABS_ADDRMAP_SUPPORTED |
100 | is set. */ | |
ccefe4c4 TT |
101 | |
102 | CORE_ADDR textlow; | |
103 | CORE_ADDR texthigh; | |
104 | ||
9439a077 TT |
105 | /* If NULL, this is an ordinary partial symbol table. |
106 | ||
107 | If non-NULL, this holds a single includer of this partial symbol | |
108 | table, and this partial symbol table is a shared one. | |
109 | ||
110 | A shared psymtab is one that is referenced by multiple other | |
111 | psymtabs, and which conceptually has its contents directly | |
112 | included in those. | |
113 | ||
114 | Shared psymtabs have special semantics. When a search finds a | |
115 | symbol in a shared table, we instead return one of the non-shared | |
116 | tables that include this one. | |
117 | ||
118 | A shared psymtabs can be referred to by other shared ones. | |
119 | ||
120 | The psymtabs that refer to a shared psymtab will list the shared | |
121 | psymtab in their 'dependencies' array. | |
122 | ||
123 | In DWARF terms, a shared psymtab is a DW_TAG_partial_unit; but | |
124 | of course using a name based on that would be too confusing, so | |
125 | "shared" was chosen instead. | |
95cf5869 | 126 | |
9439a077 TT |
127 | Only a single user is needed because, when expanding a shared |
128 | psymtab, we only need to expand its "canonical" non-shared user. | |
129 | The choice of which one should be canonical is left to the | |
130 | debuginfo reader; it can be arbitrary. */ | |
131 | ||
132 | struct partial_symtab *user; | |
133 | ||
e1b06ae2 TT |
134 | /* Array of pointers to all of the partial_symtab's which this one |
135 | depends on. Since this array can only be set to previous or | |
136 | the current (?) psymtab, this dependency tree is guaranteed not | |
137 | to have any loops. "depends on" means that symbols must be read | |
138 | for the dependencies before being read for this psymtab; this is | |
139 | for type references in stabs, where if foo.c includes foo.h, declarations | |
140 | in foo.h may use type numbers defined in foo.c. For other debugging | |
141 | formats there may be no need to use dependencies. */ | |
142 | ||
143 | struct partial_symtab **dependencies; | |
144 | ||
145 | int number_of_dependencies; | |
146 | ||
ccefe4c4 TT |
147 | /* Global symbol list. This list will be sorted after readin to |
148 | improve access. Binary search will be the usual method of | |
0df8b418 | 149 | finding a symbol within it. globals_offset is an integer offset |
ccefe4c4 TT |
150 | within global_psymbols[]. */ |
151 | ||
152 | int globals_offset; | |
153 | int n_global_syms; | |
154 | ||
155 | /* Static symbol list. This list will *not* be sorted after readin; | |
156 | to find a symbol in it, exhaustive search must be used. This is | |
157 | reasonable because searches through this list will eventually | |
158 | lead to either the read in of a files symbols for real (assumed | |
159 | to take a *lot* of time; check) or an error (and we don't care | |
160 | how long errors take). This is an offset and size within | |
161 | static_psymbols[]. */ | |
162 | ||
163 | int statics_offset; | |
164 | int n_static_syms; | |
165 | ||
900c7f9d TT |
166 | /* Non-zero if the symtab corresponding to this psymtab has been |
167 | readin. This is located here so that this structure packs better | |
168 | on 64-bit systems. */ | |
169 | ||
170 | unsigned char readin; | |
171 | ||
9750bca9 JK |
172 | /* True iff objfile->psymtabs_addrmap is properly populated for this |
173 | partial_symtab. For discontiguous overlapping psymtabs is the only usable | |
174 | info in PSYMTABS_ADDRMAP. */ | |
175 | ||
176 | unsigned char psymtabs_addrmap_supported; | |
177 | ||
b4c41fc7 DE |
178 | /* True if the name of this partial symtab is not a source file name. */ |
179 | ||
180 | unsigned char anonymous; | |
181 | ||
9439a077 TT |
182 | /* A flag that is temporarily used when searching psymtabs. */ |
183 | ||
184 | ENUM_BITFIELD (psymtab_search_status) searched_flag : 2; | |
185 | ||
43f3e411 | 186 | /* Pointer to compunit eventually allocated for this source file, 0 if |
ccefe4c4 TT |
187 | !readin or if we haven't looked for the symtab after it was readin. */ |
188 | ||
43f3e411 | 189 | struct compunit_symtab *compunit_symtab; |
ccefe4c4 TT |
190 | |
191 | /* Pointer to function which will read in the symtab corresponding to | |
192 | this psymtab. */ | |
193 | ||
257e7a09 | 194 | void (*read_symtab) (struct partial_symtab *, struct objfile *); |
ccefe4c4 TT |
195 | |
196 | /* Information that lets read_symtab() locate the part of the symbol table | |
197 | that this psymtab corresponds to. This information is private to the | |
198 | format-dependent symbol reading routines. For further detail examine | |
e38df1d0 | 199 | the various symbol reading modules. */ |
ccefe4c4 | 200 | |
e38df1d0 | 201 | void *read_symtab_private; |
ccefe4c4 TT |
202 | }; |
203 | ||
923c6a3d TT |
204 | /* Add any kind of symbol to a psymbol_allocation_list. */ |
205 | ||
7dc25483 DE |
206 | extern void add_psymbol_to_list (const char *, int, |
207 | int, domain_enum, | |
208 | enum address_class, | |
209 | struct psymbol_allocation_list *, | |
1762568f | 210 | CORE_ADDR, |
7dc25483 | 211 | enum language, struct objfile *); |
923c6a3d TT |
212 | |
213 | extern void init_psymbol_list (struct objfile *, int); | |
214 | ||
215 | extern struct partial_symtab *start_psymtab_common (struct objfile *, | |
923c6a3d TT |
216 | const char *, CORE_ADDR, |
217 | struct partial_symbol **, | |
218 | struct partial_symbol **); | |
219 | ||
8763cede DE |
220 | extern void end_psymtab_common (struct objfile *, struct partial_symtab *); |
221 | ||
923c6a3d | 222 | extern struct partial_symtab *allocate_psymtab (const char *, |
4e04028d JK |
223 | struct objfile *) |
224 | ATTRIBUTE_NONNULL (1); | |
923c6a3d | 225 | |
5c80ed9d | 226 | extern void discard_psymtab (struct objfile *, struct partial_symtab *); |
923c6a3d | 227 | |
c9bf0622 TT |
228 | extern struct cleanup *make_cleanup_discard_psymtabs (struct objfile *); |
229 | ||
ccefe4c4 TT |
230 | /* Traverse all psymtabs in one objfile. */ |
231 | ||
232 | #define ALL_OBJFILE_PSYMTABS(objfile, p) \ | |
233 | for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next) | |
234 | ||
ccefe4c4 | 235 | #endif /* PSYMPRIV_H */ |