| 1 | /* Definitions for symbol file management in GDB. |
| 2 | |
| 3 | Copyright (C) 1992-2018 Free Software Foundation, Inc. |
| 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 | #if !defined (OBJFILES_H) |
| 21 | #define OBJFILES_H |
| 22 | |
| 23 | #include "hashtab.h" |
| 24 | #include "gdb_obstack.h" /* For obstack internals. */ |
| 25 | #include "objfile-flags.h" |
| 26 | #include "symfile.h" |
| 27 | #include "progspace.h" |
| 28 | #include "registry.h" |
| 29 | #include "gdb_bfd.h" |
| 30 | #include <vector> |
| 31 | |
| 32 | struct bcache; |
| 33 | struct htab; |
| 34 | struct objfile_data; |
| 35 | struct partial_symbol; |
| 36 | |
| 37 | /* This structure maintains information on a per-objfile basis about the |
| 38 | "entry point" of the objfile, and the scope within which the entry point |
| 39 | exists. It is possible that gdb will see more than one objfile that is |
| 40 | executable, each with its own entry point. |
| 41 | |
| 42 | For example, for dynamically linked executables in SVR4, the dynamic linker |
| 43 | code is contained within the shared C library, which is actually executable |
| 44 | and is run by the kernel first when an exec is done of a user executable |
| 45 | that is dynamically linked. The dynamic linker within the shared C library |
| 46 | then maps in the various program segments in the user executable and jumps |
| 47 | to the user executable's recorded entry point, as if the call had been made |
| 48 | directly by the kernel. |
| 49 | |
| 50 | The traditional gdb method of using this info was to use the |
| 51 | recorded entry point to set the entry-file's lowpc and highpc from |
| 52 | the debugging information, where these values are the starting |
| 53 | address (inclusive) and ending address (exclusive) of the |
| 54 | instruction space in the executable which correspond to the |
| 55 | "startup file", i.e. crt0.o in most cases. This file is assumed to |
| 56 | be a startup file and frames with pc's inside it are treated as |
| 57 | nonexistent. Setting these variables is necessary so that |
| 58 | backtraces do not fly off the bottom of the stack. |
| 59 | |
| 60 | NOTE: cagney/2003-09-09: It turns out that this "traditional" |
| 61 | method doesn't work. Corinna writes: ``It turns out that the call |
| 62 | to test for "inside entry file" destroys a meaningful backtrace |
| 63 | under some conditions. E.g. the backtrace tests in the asm-source |
| 64 | testcase are broken for some targets. In this test the functions |
| 65 | are all implemented as part of one file and the testcase is not |
| 66 | necessarily linked with a start file (depending on the target). |
| 67 | What happens is, that the first frame is printed normaly and |
| 68 | following frames are treated as being inside the enttry file then. |
| 69 | This way, only the #0 frame is printed in the backtrace output.'' |
| 70 | Ref "frame.c" "NOTE: vinschen/2003-04-01". |
| 71 | |
| 72 | Gdb also supports an alternate method to avoid running off the bottom |
| 73 | of the stack. |
| 74 | |
| 75 | There are two frames that are "special", the frame for the function |
| 76 | containing the process entry point, since it has no predecessor frame, |
| 77 | and the frame for the function containing the user code entry point |
| 78 | (the main() function), since all the predecessor frames are for the |
| 79 | process startup code. Since we have no guarantee that the linked |
| 80 | in startup modules have any debugging information that gdb can use, |
| 81 | we need to avoid following frame pointers back into frames that might |
| 82 | have been built in the startup code, as we might get hopelessly |
| 83 | confused. However, we almost always have debugging information |
| 84 | available for main(). |
| 85 | |
| 86 | These variables are used to save the range of PC values which are |
| 87 | valid within the main() function and within the function containing |
| 88 | the process entry point. If we always consider the frame for |
| 89 | main() as the outermost frame when debugging user code, and the |
| 90 | frame for the process entry point function as the outermost frame |
| 91 | when debugging startup code, then all we have to do is have |
| 92 | DEPRECATED_FRAME_CHAIN_VALID return false whenever a frame's |
| 93 | current PC is within the range specified by these variables. In |
| 94 | essence, we set "ceilings" in the frame chain beyond which we will |
| 95 | not proceed when following the frame chain back up the stack. |
| 96 | |
| 97 | A nice side effect is that we can still debug startup code without |
| 98 | running off the end of the frame chain, assuming that we have usable |
| 99 | debugging information in the startup modules, and if we choose to not |
| 100 | use the block at main, or can't find it for some reason, everything |
| 101 | still works as before. And if we have no startup code debugging |
| 102 | information but we do have usable information for main(), backtraces |
| 103 | from user code don't go wandering off into the startup code. */ |
| 104 | |
| 105 | struct entry_info |
| 106 | { |
| 107 | /* The unrelocated value we should use for this objfile entry point. */ |
| 108 | CORE_ADDR entry_point; |
| 109 | |
| 110 | /* The index of the section in which the entry point appears. */ |
| 111 | int the_bfd_section_index; |
| 112 | |
| 113 | /* Set to 1 iff ENTRY_POINT contains a valid value. */ |
| 114 | unsigned entry_point_p : 1; |
| 115 | |
| 116 | /* Set to 1 iff this object was initialized. */ |
| 117 | unsigned initialized : 1; |
| 118 | }; |
| 119 | |
| 120 | /* Sections in an objfile. The section offsets are stored in the |
| 121 | OBJFILE. */ |
| 122 | |
| 123 | struct obj_section |
| 124 | { |
| 125 | /* BFD section pointer */ |
| 126 | struct bfd_section *the_bfd_section; |
| 127 | |
| 128 | /* Objfile this section is part of. */ |
| 129 | struct objfile *objfile; |
| 130 | |
| 131 | /* True if this "overlay section" is mapped into an "overlay region". */ |
| 132 | int ovly_mapped; |
| 133 | }; |
| 134 | |
| 135 | /* Relocation offset applied to S. */ |
| 136 | #define obj_section_offset(s) \ |
| 137 | (((s)->objfile->section_offsets)->offsets[gdb_bfd_section_index ((s)->objfile->obfd, (s)->the_bfd_section)]) |
| 138 | |
| 139 | /* The memory address of section S (vma + offset). */ |
| 140 | #define obj_section_addr(s) \ |
| 141 | (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \ |
| 142 | + obj_section_offset (s)) |
| 143 | |
| 144 | /* The one-passed-the-end memory address of section S |
| 145 | (vma + size + offset). */ |
| 146 | #define obj_section_endaddr(s) \ |
| 147 | (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \ |
| 148 | + bfd_get_section_size ((s)->the_bfd_section) \ |
| 149 | + obj_section_offset (s)) |
| 150 | |
| 151 | /* The "objstats" structure provides a place for gdb to record some |
| 152 | interesting information about its internal state at runtime, on a |
| 153 | per objfile basis, such as information about the number of symbols |
| 154 | read, size of string table (if any), etc. */ |
| 155 | |
| 156 | struct objstats |
| 157 | { |
| 158 | /* Number of partial symbols read. */ |
| 159 | int n_psyms = 0; |
| 160 | |
| 161 | /* Number of full symbols read. */ |
| 162 | int n_syms = 0; |
| 163 | |
| 164 | /* Number of ".stabs" read (if applicable). */ |
| 165 | int n_stabs = 0; |
| 166 | |
| 167 | /* Number of types. */ |
| 168 | int n_types = 0; |
| 169 | |
| 170 | /* Size of stringtable, (if applicable). */ |
| 171 | int sz_strtab = 0; |
| 172 | }; |
| 173 | |
| 174 | #define OBJSTAT(objfile, expr) (objfile -> stats.expr) |
| 175 | #define OBJSTATS struct objstats stats |
| 176 | extern void print_objfile_statistics (void); |
| 177 | extern void print_symbol_bcache_statistics (void); |
| 178 | |
| 179 | /* Number of entries in the minimal symbol hash table. */ |
| 180 | #define MINIMAL_SYMBOL_HASH_SIZE 2039 |
| 181 | |
| 182 | /* Some objfile data is hung off the BFD. This enables sharing of the |
| 183 | data across all objfiles using the BFD. The data is stored in an |
| 184 | instance of this structure, and associated with the BFD using the |
| 185 | registry system. */ |
| 186 | |
| 187 | struct objfile_per_bfd_storage |
| 188 | { |
| 189 | objfile_per_bfd_storage () |
| 190 | : minsyms_read (false) |
| 191 | {} |
| 192 | |
| 193 | /* The storage has an obstack of its own. */ |
| 194 | |
| 195 | auto_obstack storage_obstack; |
| 196 | |
| 197 | /* Byte cache for file names. */ |
| 198 | |
| 199 | bcache *filename_cache = NULL; |
| 200 | |
| 201 | /* Byte cache for macros. */ |
| 202 | |
| 203 | bcache *macro_cache = NULL; |
| 204 | |
| 205 | /* The gdbarch associated with the BFD. Note that this gdbarch is |
| 206 | determined solely from BFD information, without looking at target |
| 207 | information. The gdbarch determined from a running target may |
| 208 | differ from this e.g. with respect to register types and names. */ |
| 209 | |
| 210 | struct gdbarch *gdbarch = NULL; |
| 211 | |
| 212 | /* Hash table for mapping symbol names to demangled names. Each |
| 213 | entry in the hash table is actually two consecutive strings, |
| 214 | both null-terminated; the first one is a mangled or linkage |
| 215 | name, and the second is the demangled name or just a zero byte |
| 216 | if the name doesn't demangle. */ |
| 217 | |
| 218 | htab *demangled_names_hash = NULL; |
| 219 | |
| 220 | /* The per-objfile information about the entry point, the scope (file/func) |
| 221 | containing the entry point, and the scope of the user's main() func. */ |
| 222 | |
| 223 | entry_info ei {}; |
| 224 | |
| 225 | /* The name and language of any "main" found in this objfile. The |
| 226 | name can be NULL, which means that the information was not |
| 227 | recorded. */ |
| 228 | |
| 229 | const char *name_of_main = NULL; |
| 230 | enum language language_of_main = language_unknown; |
| 231 | |
| 232 | /* Each file contains a pointer to an array of minimal symbols for all |
| 233 | global symbols that are defined within the file. The array is |
| 234 | terminated by a "null symbol", one that has a NULL pointer for the |
| 235 | name and a zero value for the address. This makes it easy to walk |
| 236 | through the array when passed a pointer to somewhere in the middle |
| 237 | of it. There is also a count of the number of symbols, which does |
| 238 | not include the terminating null symbol. The array itself, as well |
| 239 | as all the data that it points to, should be allocated on the |
| 240 | objfile_obstack for this file. */ |
| 241 | |
| 242 | minimal_symbol *msymbols = NULL; |
| 243 | int minimal_symbol_count = 0; |
| 244 | |
| 245 | /* The number of minimal symbols read, before any minimal symbol |
| 246 | de-duplication is applied. Note in particular that this has only |
| 247 | a passing relationship with the actual size of the table above; |
| 248 | use minimal_symbol_count if you need the true size. */ |
| 249 | |
| 250 | int n_minsyms = 0; |
| 251 | |
| 252 | /* This is true if minimal symbols have already been read. Symbol |
| 253 | readers can use this to bypass minimal symbol reading. Also, the |
| 254 | minimal symbol table management code in minsyms.c uses this to |
| 255 | suppress new minimal symbols. You might think that MSYMBOLS or |
| 256 | MINIMAL_SYMBOL_COUNT could be used for this, but it is possible |
| 257 | for multiple readers to install minimal symbols into a given |
| 258 | per-BFD. */ |
| 259 | |
| 260 | bool minsyms_read : 1; |
| 261 | |
| 262 | /* This is a hash table used to index the minimal symbols by name. */ |
| 263 | |
| 264 | minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE] {}; |
| 265 | |
| 266 | /* This hash table is used to index the minimal symbols by their |
| 267 | demangled names. */ |
| 268 | |
| 269 | minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE] {}; |
| 270 | |
| 271 | /* All the different languages of symbols found in the demangled |
| 272 | hash table. A flat/vector-based map is more efficient than a map |
| 273 | or hash table here, since this will only usually contain zero or |
| 274 | one entries. */ |
| 275 | std::vector<enum language> demangled_hash_languages; |
| 276 | }; |
| 277 | |
| 278 | /* Master structure for keeping track of each file from which |
| 279 | gdb reads symbols. There are several ways these get allocated: 1. |
| 280 | The main symbol file, symfile_objfile, set by the symbol-file command, |
| 281 | 2. Additional symbol files added by the add-symbol-file command, |
| 282 | 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files |
| 283 | for modules that were loaded when GDB attached to a remote system |
| 284 | (see remote-vx.c). */ |
| 285 | |
| 286 | struct objfile |
| 287 | { |
| 288 | objfile (bfd *, const char *, objfile_flags); |
| 289 | ~objfile (); |
| 290 | |
| 291 | DISABLE_COPY_AND_ASSIGN (objfile); |
| 292 | |
| 293 | /* All struct objfile's are chained together by their next pointers. |
| 294 | The program space field "objfiles" (frequently referenced via |
| 295 | the macro "object_files") points to the first link in this chain. */ |
| 296 | |
| 297 | struct objfile *next = nullptr; |
| 298 | |
| 299 | /* The object file's original name as specified by the user, |
| 300 | made absolute, and tilde-expanded. However, it is not canonicalized |
| 301 | (i.e., it has not been passed through gdb_realpath). |
| 302 | This pointer is never NULL. This does not have to be freed; it is |
| 303 | guaranteed to have a lifetime at least as long as the objfile. */ |
| 304 | |
| 305 | char *original_name = nullptr; |
| 306 | |
| 307 | CORE_ADDR addr_low = 0; |
| 308 | |
| 309 | /* Some flag bits for this objfile. */ |
| 310 | |
| 311 | objfile_flags flags; |
| 312 | |
| 313 | /* The program space associated with this objfile. */ |
| 314 | |
| 315 | struct program_space *pspace; |
| 316 | |
| 317 | /* List of compunits. |
| 318 | These are used to do symbol lookups and file/line-number lookups. */ |
| 319 | |
| 320 | struct compunit_symtab *compunit_symtabs = nullptr; |
| 321 | |
| 322 | /* Each objfile points to a linked list of partial symtabs derived from |
| 323 | this file, one partial symtab structure for each compilation unit |
| 324 | (source file). */ |
| 325 | |
| 326 | struct partial_symtab *psymtabs = nullptr; |
| 327 | |
| 328 | /* Map addresses to the entries of PSYMTABS. It would be more efficient to |
| 329 | have a map per the whole process but ADDRMAP cannot selectively remove |
| 330 | its items during FREE_OBJFILE. This mapping is already present even for |
| 331 | PARTIAL_SYMTABs which still have no corresponding full SYMTABs read. */ |
| 332 | |
| 333 | struct addrmap *psymtabs_addrmap = nullptr; |
| 334 | |
| 335 | /* List of freed partial symtabs, available for re-use. */ |
| 336 | |
| 337 | struct partial_symtab *free_psymtabs = nullptr; |
| 338 | |
| 339 | /* The object file's BFD. Can be null if the objfile contains only |
| 340 | minimal symbols, e.g. the run time common symbols for SunOS4. */ |
| 341 | |
| 342 | bfd *obfd; |
| 343 | |
| 344 | /* The per-BFD data. Note that this is treated specially if OBFD |
| 345 | is NULL. */ |
| 346 | |
| 347 | struct objfile_per_bfd_storage *per_bfd = nullptr; |
| 348 | |
| 349 | /* The modification timestamp of the object file, as of the last time |
| 350 | we read its symbols. */ |
| 351 | |
| 352 | long mtime = 0; |
| 353 | |
| 354 | /* Obstack to hold objects that should be freed when we load a new symbol |
| 355 | table from this object file. */ |
| 356 | |
| 357 | struct obstack objfile_obstack {}; |
| 358 | |
| 359 | /* A byte cache where we can stash arbitrary "chunks" of bytes that |
| 360 | will not change. */ |
| 361 | |
| 362 | struct psymbol_bcache *psymbol_cache; |
| 363 | |
| 364 | /* Map symbol addresses to the partial symtab that defines the |
| 365 | object at that address. */ |
| 366 | |
| 367 | std::vector<std::pair<CORE_ADDR, partial_symtab *>> psymbol_map; |
| 368 | |
| 369 | /* Vectors of all partial symbols read in from file. The actual data |
| 370 | is stored in the objfile_obstack. */ |
| 371 | |
| 372 | std::vector<partial_symbol *> global_psymbols; |
| 373 | std::vector<partial_symbol *> static_psymbols; |
| 374 | |
| 375 | /* Structure which keeps track of functions that manipulate objfile's |
| 376 | of the same type as this objfile. I.e. the function to read partial |
| 377 | symbols for example. Note that this structure is in statically |
| 378 | allocated memory, and is shared by all objfiles that use the |
| 379 | object module reader of this type. */ |
| 380 | |
| 381 | const struct sym_fns *sf = nullptr; |
| 382 | |
| 383 | /* Per objfile data-pointers required by other GDB modules. */ |
| 384 | |
| 385 | REGISTRY_FIELDS {}; |
| 386 | |
| 387 | /* Set of relocation offsets to apply to each section. |
| 388 | The table is indexed by the_bfd_section->index, thus it is generally |
| 389 | as large as the number of sections in the binary. |
| 390 | The table is stored on the objfile_obstack. |
| 391 | |
| 392 | These offsets indicate that all symbols (including partial and |
| 393 | minimal symbols) which have been read have been relocated by this |
| 394 | much. Symbols which are yet to be read need to be relocated by it. */ |
| 395 | |
| 396 | struct section_offsets *section_offsets = nullptr; |
| 397 | int num_sections = 0; |
| 398 | |
| 399 | /* Indexes in the section_offsets array. These are initialized by the |
| 400 | *_symfile_offsets() family of functions (som_symfile_offsets, |
| 401 | xcoff_symfile_offsets, default_symfile_offsets). In theory they |
| 402 | should correspond to the section indexes used by bfd for the |
| 403 | current objfile. The exception to this for the time being is the |
| 404 | SOM version. |
| 405 | |
| 406 | These are initialized to -1 so that we can later detect if they |
| 407 | are used w/o being properly assigned to. */ |
| 408 | |
| 409 | int sect_index_text = -1; |
| 410 | int sect_index_data = -1; |
| 411 | int sect_index_bss = -1; |
| 412 | int sect_index_rodata = -1; |
| 413 | |
| 414 | /* These pointers are used to locate the section table, which |
| 415 | among other things, is used to map pc addresses into sections. |
| 416 | SECTIONS points to the first entry in the table, and |
| 417 | SECTIONS_END points to the first location past the last entry |
| 418 | in the table. The table is stored on the objfile_obstack. The |
| 419 | sections are indexed by the BFD section index; but the |
| 420 | structure data is only valid for certain sections |
| 421 | (e.g. non-empty, SEC_ALLOC). */ |
| 422 | |
| 423 | struct obj_section *sections = nullptr; |
| 424 | struct obj_section *sections_end = nullptr; |
| 425 | |
| 426 | /* GDB allows to have debug symbols in separate object files. This is |
| 427 | used by .gnu_debuglink, ELF build id note and Mach-O OSO. |
| 428 | Although this is a tree structure, GDB only support one level |
| 429 | (ie a separate debug for a separate debug is not supported). Note that |
| 430 | separate debug object are in the main chain and therefore will be |
| 431 | visited by ALL_OBJFILES & co iterators. Separate debug objfile always |
| 432 | has a non-nul separate_debug_objfile_backlink. */ |
| 433 | |
| 434 | /* Link to the first separate debug object, if any. */ |
| 435 | |
| 436 | struct objfile *separate_debug_objfile = nullptr; |
| 437 | |
| 438 | /* If this is a separate debug object, this is used as a link to the |
| 439 | actual executable objfile. */ |
| 440 | |
| 441 | struct objfile *separate_debug_objfile_backlink = nullptr; |
| 442 | |
| 443 | /* If this is a separate debug object, this is a link to the next one |
| 444 | for the same executable objfile. */ |
| 445 | |
| 446 | struct objfile *separate_debug_objfile_link = nullptr; |
| 447 | |
| 448 | /* Place to stash various statistics about this objfile. */ |
| 449 | |
| 450 | OBJSTATS; |
| 451 | |
| 452 | /* A linked list of symbols created when reading template types or |
| 453 | function templates. These symbols are not stored in any symbol |
| 454 | table, so we have to keep them here to relocate them |
| 455 | properly. */ |
| 456 | |
| 457 | struct symbol *template_symbols = nullptr; |
| 458 | |
| 459 | /* Associate a static link (struct dynamic_prop *) to all blocks (struct |
| 460 | block *) that have one. |
| 461 | |
| 462 | In the context of nested functions (available in Pascal, Ada and GNU C, |
| 463 | for instance), a static link (as in DWARF's DW_AT_static_link attribute) |
| 464 | for a function is a way to get the frame corresponding to the enclosing |
| 465 | function. |
| 466 | |
| 467 | Very few blocks have a static link, so it's more memory efficient to |
| 468 | store these here rather than in struct block. Static links must be |
| 469 | allocated on the objfile's obstack. */ |
| 470 | htab_t static_links {}; |
| 471 | }; |
| 472 | |
| 473 | /* Declarations for functions defined in objfiles.c */ |
| 474 | |
| 475 | extern struct gdbarch *get_objfile_arch (const struct objfile *); |
| 476 | |
| 477 | extern int entry_point_address_query (CORE_ADDR *entry_p); |
| 478 | |
| 479 | extern CORE_ADDR entry_point_address (void); |
| 480 | |
| 481 | extern void build_objfile_section_table (struct objfile *); |
| 482 | |
| 483 | extern struct objfile *objfile_separate_debug_iterate (const struct objfile *, |
| 484 | const struct objfile *); |
| 485 | |
| 486 | extern void put_objfile_before (struct objfile *, struct objfile *); |
| 487 | |
| 488 | extern void add_separate_debug_objfile (struct objfile *, struct objfile *); |
| 489 | |
| 490 | extern void unlink_objfile (struct objfile *); |
| 491 | |
| 492 | extern void free_objfile_separate_debug (struct objfile *); |
| 493 | |
| 494 | extern void free_all_objfiles (void); |
| 495 | |
| 496 | extern void objfile_relocate (struct objfile *, const struct section_offsets *); |
| 497 | extern void objfile_rebase (struct objfile *, CORE_ADDR); |
| 498 | |
| 499 | extern int objfile_has_partial_symbols (struct objfile *objfile); |
| 500 | |
| 501 | extern int objfile_has_full_symbols (struct objfile *objfile); |
| 502 | |
| 503 | extern int objfile_has_symbols (struct objfile *objfile); |
| 504 | |
| 505 | extern int have_partial_symbols (void); |
| 506 | |
| 507 | extern int have_full_symbols (void); |
| 508 | |
| 509 | extern void objfile_set_sym_fns (struct objfile *objfile, |
| 510 | const struct sym_fns *sf); |
| 511 | |
| 512 | extern void objfiles_changed (void); |
| 513 | |
| 514 | extern int is_addr_in_objfile (CORE_ADDR addr, const struct objfile *objfile); |
| 515 | |
| 516 | /* Return true if ADDRESS maps into one of the sections of a |
| 517 | OBJF_SHARED objfile of PSPACE and false otherwise. */ |
| 518 | |
| 519 | extern int shared_objfile_contains_address_p (struct program_space *pspace, |
| 520 | CORE_ADDR address); |
| 521 | |
| 522 | /* This operation deletes all objfile entries that represent solibs that |
| 523 | weren't explicitly loaded by the user, via e.g., the add-symbol-file |
| 524 | command. */ |
| 525 | |
| 526 | extern void objfile_purge_solibs (void); |
| 527 | |
| 528 | /* Functions for dealing with the minimal symbol table, really a misc |
| 529 | address<->symbol mapping for things we don't have debug symbols for. */ |
| 530 | |
| 531 | extern int have_minimal_symbols (void); |
| 532 | |
| 533 | extern struct obj_section *find_pc_section (CORE_ADDR pc); |
| 534 | |
| 535 | /* Return non-zero if PC is in a section called NAME. */ |
| 536 | extern int pc_in_section (CORE_ADDR, const char *); |
| 537 | |
| 538 | /* Return non-zero if PC is in a SVR4-style procedure linkage table |
| 539 | section. */ |
| 540 | |
| 541 | static inline int |
| 542 | in_plt_section (CORE_ADDR pc) |
| 543 | { |
| 544 | return pc_in_section (pc, ".plt"); |
| 545 | } |
| 546 | |
| 547 | /* Keep a registry of per-objfile data-pointers required by other GDB |
| 548 | modules. */ |
| 549 | DECLARE_REGISTRY(objfile); |
| 550 | |
| 551 | /* In normal use, the section map will be rebuilt by find_pc_section |
| 552 | if objfiles have been added, removed or relocated since it was last |
| 553 | called. Calling inhibit_section_map_updates will inhibit this |
| 554 | behavior until the returned scoped_restore object is destroyed. If |
| 555 | you call inhibit_section_map_updates you must ensure that every |
| 556 | call to find_pc_section in the inhibited region relates to a |
| 557 | section that is already in the section map and has not since been |
| 558 | removed or relocated. */ |
| 559 | extern scoped_restore_tmpl<int> inhibit_section_map_updates |
| 560 | (struct program_space *pspace); |
| 561 | |
| 562 | extern void default_iterate_over_objfiles_in_search_order |
| 563 | (struct gdbarch *gdbarch, |
| 564 | iterate_over_objfiles_in_search_order_cb_ftype *cb, |
| 565 | void *cb_data, struct objfile *current_objfile); |
| 566 | \f |
| 567 | |
| 568 | /* Traverse all object files in the current program space. |
| 569 | ALL_OBJFILES_SAFE works even if you delete the objfile during the |
| 570 | traversal. */ |
| 571 | |
| 572 | /* Traverse all object files in program space SS. */ |
| 573 | |
| 574 | #define ALL_PSPACE_OBJFILES(ss, obj) \ |
| 575 | for ((obj) = ss->objfiles; (obj) != NULL; (obj) = (obj)->next) |
| 576 | |
| 577 | #define ALL_OBJFILES(obj) \ |
| 578 | for ((obj) = current_program_space->objfiles; \ |
| 579 | (obj) != NULL; \ |
| 580 | (obj) = (obj)->next) |
| 581 | |
| 582 | #define ALL_OBJFILES_SAFE(obj,nxt) \ |
| 583 | for ((obj) = current_program_space->objfiles; \ |
| 584 | (obj) != NULL? ((nxt)=(obj)->next,1) :0; \ |
| 585 | (obj) = (nxt)) |
| 586 | |
| 587 | /* Traverse all symtabs in one objfile. */ |
| 588 | |
| 589 | #define ALL_OBJFILE_FILETABS(objfile, cu, s) \ |
| 590 | ALL_OBJFILE_COMPUNITS (objfile, cu) \ |
| 591 | ALL_COMPUNIT_FILETABS (cu, s) |
| 592 | |
| 593 | /* Traverse all compunits in one objfile. */ |
| 594 | |
| 595 | #define ALL_OBJFILE_COMPUNITS(objfile, cu) \ |
| 596 | for ((cu) = (objfile) -> compunit_symtabs; (cu) != NULL; (cu) = (cu) -> next) |
| 597 | |
| 598 | /* Traverse all minimal symbols in one objfile. */ |
| 599 | |
| 600 | #define ALL_OBJFILE_MSYMBOLS(objfile, m) \ |
| 601 | for ((m) = (objfile)->per_bfd->msymbols; \ |
| 602 | MSYMBOL_LINKAGE_NAME (m) != NULL; \ |
| 603 | (m)++) |
| 604 | |
| 605 | /* Traverse all symtabs in all objfiles in the current symbol |
| 606 | space. */ |
| 607 | |
| 608 | #define ALL_FILETABS(objfile, ps, s) \ |
| 609 | ALL_OBJFILES (objfile) \ |
| 610 | ALL_OBJFILE_FILETABS (objfile, ps, s) |
| 611 | |
| 612 | /* Traverse all compunits in all objfiles in the current program space. */ |
| 613 | |
| 614 | #define ALL_COMPUNITS(objfile, cu) \ |
| 615 | ALL_OBJFILES (objfile) \ |
| 616 | ALL_OBJFILE_COMPUNITS (objfile, cu) |
| 617 | |
| 618 | /* Traverse all minimal symbols in all objfiles in the current symbol |
| 619 | space. */ |
| 620 | |
| 621 | #define ALL_MSYMBOLS(objfile, m) \ |
| 622 | ALL_OBJFILES (objfile) \ |
| 623 | ALL_OBJFILE_MSYMBOLS (objfile, m) |
| 624 | |
| 625 | #define ALL_OBJFILE_OSECTIONS(objfile, osect) \ |
| 626 | for (osect = objfile->sections; osect < objfile->sections_end; osect++) \ |
| 627 | if (osect->the_bfd_section == NULL) \ |
| 628 | { \ |
| 629 | /* Nothing. */ \ |
| 630 | } \ |
| 631 | else |
| 632 | |
| 633 | /* Traverse all obj_sections in all objfiles in the current program |
| 634 | space. |
| 635 | |
| 636 | Note that this detects a "break" in the inner loop, and exits |
| 637 | immediately from the outer loop as well, thus, client code doesn't |
| 638 | need to know that this is implemented with a double for. The extra |
| 639 | hair is to make sure that a "break;" stops the outer loop iterating |
| 640 | as well, and both OBJFILE and OSECT are left unmodified: |
| 641 | |
| 642 | - The outer loop learns about the inner loop's end condition, and |
| 643 | stops iterating if it detects the inner loop didn't reach its |
| 644 | end. In other words, the outer loop keeps going only if the |
| 645 | inner loop reached its end cleanly [(osect) == |
| 646 | (objfile)->sections_end]. |
| 647 | |
| 648 | - OSECT is initialized in the outer loop initialization |
| 649 | expressions, such as if the inner loop has reached its end, so |
| 650 | the check mentioned above succeeds the first time. |
| 651 | |
| 652 | - The trick to not clearing OBJFILE on a "break;" is, in the outer |
| 653 | loop's loop expression, advance OBJFILE, but iff the inner loop |
| 654 | reached its end. If not, there was a "break;", so leave OBJFILE |
| 655 | as is; the outer loop's conditional will break immediately as |
| 656 | well (as OSECT will be different from OBJFILE->sections_end). */ |
| 657 | |
| 658 | #define ALL_OBJSECTIONS(objfile, osect) \ |
| 659 | for ((objfile) = current_program_space->objfiles, \ |
| 660 | (objfile) != NULL ? ((osect) = (objfile)->sections_end) : 0; \ |
| 661 | (objfile) != NULL \ |
| 662 | && (osect) == (objfile)->sections_end; \ |
| 663 | ((osect) == (objfile)->sections_end \ |
| 664 | ? ((objfile) = (objfile)->next, \ |
| 665 | (objfile) != NULL ? (osect) = (objfile)->sections_end : 0) \ |
| 666 | : 0)) \ |
| 667 | ALL_OBJFILE_OSECTIONS (objfile, osect) |
| 668 | |
| 669 | #define SECT_OFF_DATA(objfile) \ |
| 670 | ((objfile->sect_index_data == -1) \ |
| 671 | ? (internal_error (__FILE__, __LINE__, \ |
| 672 | _("sect_index_data not initialized")), -1) \ |
| 673 | : objfile->sect_index_data) |
| 674 | |
| 675 | #define SECT_OFF_RODATA(objfile) \ |
| 676 | ((objfile->sect_index_rodata == -1) \ |
| 677 | ? (internal_error (__FILE__, __LINE__, \ |
| 678 | _("sect_index_rodata not initialized")), -1) \ |
| 679 | : objfile->sect_index_rodata) |
| 680 | |
| 681 | #define SECT_OFF_TEXT(objfile) \ |
| 682 | ((objfile->sect_index_text == -1) \ |
| 683 | ? (internal_error (__FILE__, __LINE__, \ |
| 684 | _("sect_index_text not initialized")), -1) \ |
| 685 | : objfile->sect_index_text) |
| 686 | |
| 687 | /* Sometimes the .bss section is missing from the objfile, so we don't |
| 688 | want to die here. Let the users of SECT_OFF_BSS deal with an |
| 689 | uninitialized section index. */ |
| 690 | #define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss |
| 691 | |
| 692 | /* Answer whether there is more than one object file loaded. */ |
| 693 | |
| 694 | #define MULTI_OBJFILE_P() (object_files && object_files->next) |
| 695 | |
| 696 | /* Reset the per-BFD storage area on OBJ. */ |
| 697 | |
| 698 | void set_objfile_per_bfd (struct objfile *obj); |
| 699 | |
| 700 | /* Return canonical name for OBJFILE. |
| 701 | This is the real file name if the file has been opened. |
| 702 | Otherwise it is the original name supplied by the user. */ |
| 703 | |
| 704 | const char *objfile_name (const struct objfile *objfile); |
| 705 | |
| 706 | /* Return the (real) file name of OBJFILE if the file has been opened, |
| 707 | otherwise return NULL. */ |
| 708 | |
| 709 | const char *objfile_filename (const struct objfile *objfile); |
| 710 | |
| 711 | /* Return the name to print for OBJFILE in debugging messages. */ |
| 712 | |
| 713 | extern const char *objfile_debug_name (const struct objfile *objfile); |
| 714 | |
| 715 | /* Return the name of the file format of OBJFILE if the file has been opened, |
| 716 | otherwise return NULL. */ |
| 717 | |
| 718 | const char *objfile_flavour_name (struct objfile *objfile); |
| 719 | |
| 720 | /* Set the objfile's notion of the "main" name and language. */ |
| 721 | |
| 722 | extern void set_objfile_main_name (struct objfile *objfile, |
| 723 | const char *name, enum language lang); |
| 724 | |
| 725 | extern void objfile_register_static_link |
| 726 | (struct objfile *objfile, |
| 727 | const struct block *block, |
| 728 | const struct dynamic_prop *static_link); |
| 729 | |
| 730 | extern const struct dynamic_prop *objfile_lookup_static_link |
| 731 | (struct objfile *objfile, const struct block *block); |
| 732 | |
| 733 | #endif /* !defined (OBJFILES_H) */ |