Commit | Line | Data |
---|---|---|
ccefe4c4 TT |
1 | /* Private partial symbol table definitions. |
2 | ||
3666a048 | 3 | Copyright (C) 2009-2021 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" | |
906768f9 | 24 | #include "objfiles.h" |
31edb802 | 25 | #include "gdbsupport/gdb_string_view.h" |
ccefe4c4 TT |
26 | |
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 | 36 | |
af97b416 | 37 | struct partial_symbol |
ccefe4c4 | 38 | { |
8a6d4234 TT |
39 | /* Return the section for this partial symbol, or nullptr if no |
40 | section has been set. */ | |
41 | struct obj_section *obj_section (struct objfile *objfile) const | |
42 | { | |
af97b416 TT |
43 | if (ginfo.section >= 0) |
44 | return &objfile->sections[ginfo.section]; | |
8a6d4234 TT |
45 | return nullptr; |
46 | } | |
ccefe4c4 | 47 | |
02e9e7f7 TT |
48 | /* Return the unrelocated address of this partial symbol. */ |
49 | CORE_ADDR unrelocated_address () const | |
50 | { | |
af97b416 | 51 | return ginfo.value.address; |
02e9e7f7 TT |
52 | } |
53 | ||
54 | /* Return the address of this partial symbol, relocated according to | |
55 | the offsets provided in OBJFILE. */ | |
56 | CORE_ADDR address (const struct objfile *objfile) const | |
57 | { | |
6a053cb1 | 58 | return ginfo.value.address + objfile->section_offsets[ginfo.section]; |
02e9e7f7 TT |
59 | } |
60 | ||
61 | /* Set the address of this partial symbol. The address must be | |
62 | unrelocated. */ | |
79748972 | 63 | void set_unrelocated_address (CORE_ADDR addr) |
02e9e7f7 | 64 | { |
af97b416 | 65 | ginfo.value.address = addr; |
02e9e7f7 TT |
66 | } |
67 | ||
af97b416 TT |
68 | /* Note that partial_symbol does not derive from general_symbol_info |
69 | due to the bcache. See add_psymbol_to_bcache. */ | |
70 | ||
71 | struct general_symbol_info ginfo; | |
72 | ||
ccefe4c4 TT |
73 | /* Name space code. */ |
74 | ||
51cdc993 | 75 | ENUM_BITFIELD(domain_enum_tag) domain : SYMBOL_DOMAIN_BITS; |
ccefe4c4 | 76 | |
f1e6e072 TT |
77 | /* Address class (for info_symbols). Note that we don't allow |
78 | synthetic "aclass" values here at present, simply because there's | |
79 | no need. */ | |
ccefe4c4 | 80 | |
51cdc993 | 81 | ENUM_BITFIELD(address_class) aclass : SYMBOL_ACLASS_BITS; |
ccefe4c4 TT |
82 | }; |
83 | ||
9439a077 TT |
84 | /* A convenience enum to give names to some constants used when |
85 | searching psymtabs. This is internal to psymtab and should not be | |
86 | used elsewhere. */ | |
87 | ||
88 | enum psymtab_search_status | |
89 | { | |
90 | PST_NOT_SEARCHED, | |
91 | PST_SEARCHED_AND_FOUND, | |
92 | PST_SEARCHED_AND_NOT_FOUND | |
93 | }; | |
94 | ||
932539d7 TT |
95 | /* Specify whether a partial psymbol should be allocated on the global |
96 | list or the static list. */ | |
97 | ||
98 | enum class psymbol_placement | |
99 | { | |
100 | STATIC, | |
101 | GLOBAL | |
102 | }; | |
103 | ||
ccefe4c4 TT |
104 | /* Each source file that has not been fully read in is represented by |
105 | a partial_symtab. This contains the information on where in the | |
106 | executable the debugging symbols for a specific file are, and a | |
107 | list of names of global symbols which are located in this file. | |
108 | They are all chained on partial symtab lists. | |
109 | ||
110 | Even after the source file has been read into a symtab, the | |
d4d947ae | 111 | partial_symtab remains around. */ |
ccefe4c4 TT |
112 | |
113 | struct partial_symtab | |
114 | { | |
32caafd0 TT |
115 | /* Allocate a new partial symbol table associated with OBJFILE. |
116 | FILENAME (which must be non-NULL) is the filename of this partial | |
117 | symbol table; it is copied into the appropriate storage. The | |
118 | partial symtab will also be installed using | |
119 | psymtab_storage::install. */ | |
120 | ||
121 | partial_symtab (const char *filename, struct objfile *objfile) | |
122 | ATTRIBUTE_NONNULL (2) ATTRIBUTE_NONNULL (3); | |
6f17252b | 123 | |
c3693a1d TT |
124 | /* Like the above, but also sets the initial text low and text high |
125 | from the ADDR argument, and sets the global- and | |
126 | static-offsets. */ | |
127 | ||
128 | partial_symtab (const char *filename, struct objfile *objfile, | |
129 | CORE_ADDR addr) | |
130 | ATTRIBUTE_NONNULL (2) ATTRIBUTE_NONNULL (3); | |
131 | ||
891813be TT |
132 | virtual ~partial_symtab () |
133 | { | |
134 | } | |
135 | ||
194d088f TV |
136 | /* Psymtab expansion is done in two steps: |
137 | - a call to read_symtab | |
138 | - while that call is in progress, calls to expand_psymtab can be made, | |
139 | both for this psymtab, and its dependencies. | |
140 | This makes a distinction between a toplevel psymtab (for which both | |
141 | read_symtab and expand_psymtab will be called) and a non-toplevel | |
142 | psymtab (for which only expand_psymtab will be called). The | |
143 | distinction can be used f.i. to do things before and after all | |
144 | dependencies of a top-level psymtab have been expanded. | |
145 | ||
146 | Read the full symbol table corresponding to this partial symbol | |
147 | table. Typically calls expand_psymtab. */ | |
891813be TT |
148 | virtual void read_symtab (struct objfile *) = 0; |
149 | ||
194d088f TV |
150 | /* Expand the full symbol table for this partial symbol table. Typically |
151 | calls expand_dependencies. */ | |
8566b89b TT |
152 | virtual void expand_psymtab (struct objfile *) = 0; |
153 | ||
194d088f TV |
154 | /* Ensure that all the dependencies are read in. Calls |
155 | expand_psymtab for each non-shared dependency. */ | |
48993951 | 156 | void expand_dependencies (struct objfile *); |
0494dbec | 157 | |
128a391f | 158 | /* Return true if the symtab corresponding to this psymtab has been |
5717c425 TT |
159 | read in in the context of this objfile. */ |
160 | virtual bool readin_p (struct objfile *) const = 0; | |
128a391f | 161 | |
5717c425 TT |
162 | /* Return a pointer to the compunit allocated for this source file |
163 | in the context of this objfile. | |
128a391f | 164 | |
5717c425 TT |
165 | Return nullptr if the compunit was not read in or if there was no |
166 | symtab. */ | |
167 | virtual struct compunit_symtab *get_compunit_symtab | |
168 | (struct objfile *) const = 0; | |
128a391f | 169 | |
79748972 TT |
170 | /* Return the raw low text address of this partial_symtab. */ |
171 | CORE_ADDR raw_text_low () const | |
4ae976d1 TT |
172 | { |
173 | return m_text_low; | |
174 | } | |
175 | ||
79748972 TT |
176 | /* Return the raw high text address of this partial_symtab. */ |
177 | CORE_ADDR raw_text_high () const | |
4ae976d1 TT |
178 | { |
179 | return m_text_high; | |
180 | } | |
181 | ||
79748972 TT |
182 | /* Return the relocated low text address of this partial_symtab. */ |
183 | CORE_ADDR text_low (struct objfile *objfile) const | |
184 | { | |
b3b3bada | 185 | return m_text_low + objfile->text_section_offset (); |
79748972 TT |
186 | } |
187 | ||
188 | /* Return the relocated high text address of this partial_symtab. */ | |
189 | CORE_ADDR text_high (struct objfile *objfile) const | |
190 | { | |
b3b3bada | 191 | return m_text_high + objfile->text_section_offset (); |
79748972 TT |
192 | } |
193 | ||
4ae976d1 TT |
194 | /* Set the low text address of this partial_symtab. */ |
195 | void set_text_low (CORE_ADDR addr) | |
196 | { | |
197 | m_text_low = addr; | |
52948f01 | 198 | text_low_valid = 1; |
4ae976d1 TT |
199 | } |
200 | ||
201 | /* Set the hight text address of this partial_symtab. */ | |
202 | void set_text_high (CORE_ADDR addr) | |
203 | { | |
204 | m_text_high = addr; | |
52948f01 | 205 | text_high_valid = 1; |
4ae976d1 TT |
206 | } |
207 | ||
932539d7 TT |
208 | /* Return true if this symtab is empty -- meaning that it contains |
209 | no symbols. It may still have dependencies. */ | |
210 | bool empty () const | |
211 | { | |
212 | return global_psymbols.empty () && static_psymbols.empty (); | |
213 | } | |
214 | ||
215 | /* Add a symbol to this partial symbol table of OBJFILE. | |
216 | ||
217 | If COPY_NAME is true, make a copy of NAME, otherwise use the passed | |
218 | reference. | |
219 | ||
220 | THECLASS is the type of symbol. | |
221 | ||
222 | SECTION is the index of the section of OBJFILE in which the symbol is found. | |
223 | ||
224 | WHERE determines whether the symbol goes in the list of static or global | |
225 | partial symbols. | |
226 | ||
227 | COREADDR is the address of the symbol. For partial symbols that don't have | |
228 | an address, zero is passed. | |
229 | ||
230 | LANGUAGE is the language from which the symbol originates. This will | |
231 | influence, amongst other things, how the symbol name is demangled. */ | |
232 | ||
233 | void add_psymbol (gdb::string_view name, | |
234 | bool copy_name, domain_enum domain, | |
235 | enum address_class theclass, | |
236 | short section, | |
237 | psymbol_placement where, | |
238 | CORE_ADDR coreaddr, | |
239 | enum language language, | |
240 | struct objfile *objfile); | |
241 | ||
242 | /* Add a symbol to this partial symbol table of OBJFILE. The psymbol | |
243 | must be fully constructed, and the names must be set and intern'd | |
244 | as appropriate. */ | |
245 | ||
246 | void add_psymbol (const partial_symbol &psym, | |
247 | psymbol_placement where, | |
248 | struct objfile *objfile); | |
249 | ||
4ae976d1 | 250 | |
ae7754b2 TT |
251 | /* Indicate that this partial symtab is complete. */ |
252 | ||
253 | void end (); | |
254 | ||
ccefe4c4 TT |
255 | /* Chain of all existing partial symtabs. */ |
256 | ||
6f17252b | 257 | struct partial_symtab *next = nullptr; |
ccefe4c4 | 258 | |
b4c41fc7 DE |
259 | /* Name of the source file which this partial_symtab defines, |
260 | or if the psymtab is anonymous then a descriptive name for | |
261 | debugging purposes, or "". It must not be NULL. */ | |
ccefe4c4 | 262 | |
6f17252b | 263 | const char *filename = nullptr; |
ccefe4c4 TT |
264 | |
265 | /* Full path of the source file. NULL if not known. */ | |
266 | ||
6f17252b | 267 | char *fullname = nullptr; |
ccefe4c4 TT |
268 | |
269 | /* Directory in which it was compiled, or NULL if we don't know. */ | |
270 | ||
6f17252b | 271 | const char *dirname = nullptr; |
ccefe4c4 | 272 | |
ccefe4c4 | 273 | /* Range of text addresses covered by this file; texthigh is the |
9750bca9 | 274 | beginning of the next section. Do not use if PSYMTABS_ADDRMAP_SUPPORTED |
4ae976d1 | 275 | is set. Do not refer directly to these fields. Instead, use the |
52948f01 TT |
276 | accessors. The validity of these fields is determined by the |
277 | text_low_valid and text_high_valid fields; these are located later | |
278 | in this structure for better packing. */ | |
ccefe4c4 | 279 | |
6f17252b TT |
280 | CORE_ADDR m_text_low = 0; |
281 | CORE_ADDR m_text_high = 0; | |
ccefe4c4 | 282 | |
9439a077 TT |
283 | /* If NULL, this is an ordinary partial symbol table. |
284 | ||
285 | If non-NULL, this holds a single includer of this partial symbol | |
286 | table, and this partial symbol table is a shared one. | |
287 | ||
288 | A shared psymtab is one that is referenced by multiple other | |
289 | psymtabs, and which conceptually has its contents directly | |
290 | included in those. | |
291 | ||
292 | Shared psymtabs have special semantics. When a search finds a | |
293 | symbol in a shared table, we instead return one of the non-shared | |
294 | tables that include this one. | |
295 | ||
296 | A shared psymtabs can be referred to by other shared ones. | |
297 | ||
298 | The psymtabs that refer to a shared psymtab will list the shared | |
299 | psymtab in their 'dependencies' array. | |
300 | ||
301 | In DWARF terms, a shared psymtab is a DW_TAG_partial_unit; but | |
302 | of course using a name based on that would be too confusing, so | |
303 | "shared" was chosen instead. | |
95cf5869 | 304 | |
9439a077 TT |
305 | Only a single user is needed because, when expanding a shared |
306 | psymtab, we only need to expand its "canonical" non-shared user. | |
307 | The choice of which one should be canonical is left to the | |
308 | debuginfo reader; it can be arbitrary. */ | |
309 | ||
6f17252b | 310 | struct partial_symtab *user = nullptr; |
9439a077 | 311 | |
e1b06ae2 TT |
312 | /* Array of pointers to all of the partial_symtab's which this one |
313 | depends on. Since this array can only be set to previous or | |
314 | the current (?) psymtab, this dependency tree is guaranteed not | |
315 | to have any loops. "depends on" means that symbols must be read | |
316 | for the dependencies before being read for this psymtab; this is | |
317 | for type references in stabs, where if foo.c includes foo.h, declarations | |
318 | in foo.h may use type numbers defined in foo.c. For other debugging | |
319 | formats there may be no need to use dependencies. */ | |
320 | ||
6f17252b | 321 | struct partial_symtab **dependencies = nullptr; |
e1b06ae2 | 322 | |
6f17252b | 323 | int number_of_dependencies = 0; |
e1b06ae2 | 324 | |
ccefe4c4 TT |
325 | /* Global symbol list. This list will be sorted after readin to |
326 | improve access. Binary search will be the usual method of | |
932539d7 | 327 | finding a symbol within it. */ |
ccefe4c4 | 328 | |
932539d7 | 329 | std::vector<partial_symbol *> global_psymbols; |
ccefe4c4 TT |
330 | |
331 | /* Static symbol list. This list will *not* be sorted after readin; | |
332 | to find a symbol in it, exhaustive search must be used. This is | |
333 | reasonable because searches through this list will eventually | |
334 | lead to either the read in of a files symbols for real (assumed | |
335 | to take a *lot* of time; check) or an error (and we don't care | |
932539d7 | 336 | how long errors take). */ |
ccefe4c4 | 337 | |
932539d7 | 338 | std::vector<partial_symbol *> static_psymbols; |
ccefe4c4 | 339 | |
9750bca9 JK |
340 | /* True iff objfile->psymtabs_addrmap is properly populated for this |
341 | partial_symtab. For discontiguous overlapping psymtabs is the only usable | |
342 | info in PSYMTABS_ADDRMAP. */ | |
343 | ||
6d94535f | 344 | bool psymtabs_addrmap_supported = false; |
9750bca9 | 345 | |
b4c41fc7 DE |
346 | /* True if the name of this partial symtab is not a source file name. */ |
347 | ||
6d94535f | 348 | bool anonymous = false; |
b4c41fc7 | 349 | |
9439a077 TT |
350 | /* A flag that is temporarily used when searching psymtabs. */ |
351 | ||
352 | ENUM_BITFIELD (psymtab_search_status) searched_flag : 2; | |
353 | ||
52948f01 TT |
354 | /* Validity of the m_text_low and m_text_high fields. */ |
355 | ||
356 | unsigned int text_low_valid : 1; | |
357 | unsigned int text_high_valid : 1; | |
128a391f TT |
358 | }; |
359 | ||
360 | /* A partial symtab that tracks the "readin" and "compunit_symtab" | |
361 | information in the ordinary way -- by storing it directly in this | |
362 | object. */ | |
363 | struct standard_psymtab : public partial_symtab | |
364 | { | |
365 | standard_psymtab (const char *filename, struct objfile *objfile) | |
366 | : partial_symtab (filename, objfile) | |
367 | { | |
368 | } | |
369 | ||
370 | standard_psymtab (const char *filename, struct objfile *objfile, | |
371 | CORE_ADDR addr) | |
372 | : partial_symtab (filename, objfile, addr) | |
373 | { | |
374 | } | |
375 | ||
5717c425 | 376 | bool readin_p (struct objfile *) const override |
128a391f TT |
377 | { |
378 | return readin; | |
379 | } | |
380 | ||
5717c425 | 381 | struct compunit_symtab *get_compunit_symtab (struct objfile *) const override |
128a391f TT |
382 | { |
383 | return compunit_symtab; | |
384 | } | |
385 | ||
386 | /* True if the symtab corresponding to this psymtab has been | |
387 | readin. */ | |
388 | ||
389 | bool readin = false; | |
52948f01 | 390 | |
43f3e411 | 391 | /* Pointer to compunit eventually allocated for this source file, 0 if |
ccefe4c4 TT |
392 | !readin or if we haven't looked for the symtab after it was readin. */ |
393 | ||
6f17252b | 394 | struct compunit_symtab *compunit_symtab = nullptr; |
891813be TT |
395 | }; |
396 | ||
397 | /* A partial_symtab that works in the historical db way. This should | |
398 | not be used in new code, but exists to transition the somewhat | |
399 | unmaintained "legacy" debug formats. */ | |
400 | ||
128a391f | 401 | struct legacy_psymtab : public standard_psymtab |
891813be TT |
402 | { |
403 | legacy_psymtab (const char *filename, struct objfile *objfile) | |
128a391f | 404 | : standard_psymtab (filename, objfile) |
891813be TT |
405 | { |
406 | } | |
407 | ||
408 | legacy_psymtab (const char *filename, struct objfile *objfile, | |
409 | CORE_ADDR addr) | |
128a391f | 410 | : standard_psymtab (filename, objfile, addr) |
891813be TT |
411 | { |
412 | } | |
413 | ||
414 | void read_symtab (struct objfile *objf) override | |
415 | { | |
416 | if (legacy_read_symtab) | |
417 | (*legacy_read_symtab) (this, objf); | |
418 | } | |
ccefe4c4 | 419 | |
8566b89b TT |
420 | void expand_psymtab (struct objfile *objf) override |
421 | { | |
422 | (*legacy_expand_psymtab) (this, objf); | |
423 | } | |
424 | ||
ccefe4c4 TT |
425 | /* Pointer to function which will read in the symtab corresponding to |
426 | this psymtab. */ | |
427 | ||
891813be | 428 | void (*legacy_read_symtab) (legacy_psymtab *, struct objfile *) = nullptr; |
ccefe4c4 | 429 | |
8566b89b TT |
430 | /* Pointer to function which will actually expand this psymtab into |
431 | a full symtab. */ | |
432 | ||
433 | void (*legacy_expand_psymtab) (legacy_psymtab *, struct objfile *) = nullptr; | |
434 | ||
ccefe4c4 TT |
435 | /* Information that lets read_symtab() locate the part of the symbol table |
436 | that this psymtab corresponds to. This information is private to the | |
437 | format-dependent symbol reading routines. For further detail examine | |
e38df1d0 | 438 | the various symbol reading modules. */ |
ccefe4c4 | 439 | |
6f17252b | 440 | void *read_symtab_private = nullptr; |
ccefe4c4 TT |
441 | }; |
442 | ||
906768f9 TT |
443 | /* Used when recording partial symbol tables. On destruction, |
444 | discards any partial symbol tables that have been built. However, | |
445 | the tables can be kept by calling the "keep" method. */ | |
446 | class psymtab_discarder | |
447 | { | |
448 | public: | |
449 | ||
450 | psymtab_discarder (struct objfile *objfile) | |
451 | : m_objfile (objfile), | |
d320c2b5 | 452 | m_psymtab (objfile->partial_symtabs->psymtabs) |
906768f9 TT |
453 | { |
454 | } | |
455 | ||
456 | ~psymtab_discarder () | |
457 | { | |
458 | if (m_objfile != NULL) | |
d320c2b5 | 459 | m_objfile->partial_symtabs->discard_psymtabs_to (m_psymtab); |
906768f9 TT |
460 | } |
461 | ||
462 | /* Keep any partial symbol tables that were built. */ | |
463 | void keep () | |
464 | { | |
465 | m_objfile = NULL; | |
466 | } | |
467 | ||
468 | private: | |
469 | ||
470 | /* The objfile. If NULL this serves as a sentinel to indicate that | |
471 | the psymtabs should be kept. */ | |
472 | struct objfile *m_objfile; | |
473 | /* How far back to free. */ | |
474 | struct partial_symtab *m_psymtab; | |
475 | }; | |
c9bf0622 | 476 | |
ccefe4c4 | 477 | #endif /* PSYMPRIV_H */ |