| 1 | /* Definitions for symbol file management in GDB. |
| 2 | |
| 3 | Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, |
| 4 | 2001, 2002, 2003 Free Software Foundation, Inc. |
| 5 | |
| 6 | This file is part of GDB. |
| 7 | |
| 8 | This program is free software; you can redistribute it and/or modify |
| 9 | it under the terms of the GNU General Public License as published by |
| 10 | the Free Software Foundation; either version 2 of the License, or |
| 11 | (at your option) any later version. |
| 12 | |
| 13 | This program is distributed in the hope that it will be useful, |
| 14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | GNU General Public License for more details. |
| 17 | |
| 18 | You should have received a copy of the GNU General Public License |
| 19 | along with this program; if not, write to the Free Software |
| 20 | Foundation, Inc., 59 Temple Place - Suite 330, |
| 21 | Boston, MA 02111-1307, USA. */ |
| 22 | |
| 23 | #if !defined (OBJFILES_H) |
| 24 | #define OBJFILES_H |
| 25 | |
| 26 | #include "gdb_obstack.h" /* For obstack internals. */ |
| 27 | #include "symfile.h" /* For struct psymbol_allocation_list */ |
| 28 | |
| 29 | struct bcache; |
| 30 | struct htab; |
| 31 | struct symtab; |
| 32 | struct objfile_data; |
| 33 | |
| 34 | /* This structure maintains information on a per-objfile basis about the |
| 35 | "entry point" of the objfile, and the scope within which the entry point |
| 36 | exists. It is possible that gdb will see more than one objfile that is |
| 37 | executable, each with its own entry point. |
| 38 | |
| 39 | For example, for dynamically linked executables in SVR4, the dynamic linker |
| 40 | code is contained within the shared C library, which is actually executable |
| 41 | and is run by the kernel first when an exec is done of a user executable |
| 42 | that is dynamically linked. The dynamic linker within the shared C library |
| 43 | then maps in the various program segments in the user executable and jumps |
| 44 | to the user executable's recorded entry point, as if the call had been made |
| 45 | directly by the kernel. |
| 46 | |
| 47 | The traditional gdb method of using this info is to use the |
| 48 | recorded entry point to set the variables |
| 49 | deprecated_entry_file_lowpc and deprecated_entry_file_highpc from |
| 50 | the debugging information, where these values are the starting |
| 51 | address (inclusive) and ending address (exclusive) of the |
| 52 | instruction space in the executable which correspond to the |
| 53 | "startup file", I.E. crt0.o in most cases. This file is assumed to |
| 54 | be a startup file and frames with pc's inside it are treated as |
| 55 | nonexistent. Setting these variables is necessary so that |
| 56 | backtraces do not fly off the bottom of the stack. |
| 57 | |
| 58 | NOTE: cagney/2003-09-09: It turns out that this "traditional" |
| 59 | method doesn't work. Corinna writes: ``It turns out that the call |
| 60 | to deprecated_inside_entry_file destroys a meaningful backtrace |
| 61 | under some conditions. E. g. the backtrace tests in the asm-source |
| 62 | testcase are broken for some targets. In this test the functions |
| 63 | are all implemented as part of one file and the testcase is not |
| 64 | necessarily linked with a start file (depending on the target). |
| 65 | What happens is, that the first frame is printed normaly and |
| 66 | following frames are treated as being inside the enttry file then. |
| 67 | This way, only the #0 frame is printed in the backtrace output.'' |
| 68 | Ref "frame.c" "NOTE: vinschen/2003-04-01". |
| 69 | |
| 70 | Gdb also supports an alternate method to avoid running off the bottom |
| 71 | of the stack. |
| 72 | |
| 73 | There are two frames that are "special", the frame for the function |
| 74 | containing the process entry point, since it has no predecessor frame, |
| 75 | and the frame for the function containing the user code entry point |
| 76 | (the main() function), since all the predecessor frames are for the |
| 77 | process startup code. Since we have no guarantee that the linked |
| 78 | in startup modules have any debugging information that gdb can use, |
| 79 | we need to avoid following frame pointers back into frames that might |
| 80 | have been built in the startup code, as we might get hopelessly |
| 81 | confused. However, we almost always have debugging information |
| 82 | available for main(). |
| 83 | |
| 84 | These variables are used to save the range of PC values which are |
| 85 | valid within the main() function and within the function containing |
| 86 | the process entry point. If we always consider the frame for |
| 87 | main() as the outermost frame when debugging user code, and the |
| 88 | frame for the process entry point function as the outermost frame |
| 89 | when debugging startup code, then all we have to do is have |
| 90 | DEPRECATED_FRAME_CHAIN_VALID return false whenever a frame's |
| 91 | current PC is within the range specified by these variables. In |
| 92 | essence, we set "ceilings" in the frame chain beyond which we will |
| 93 | not proceed when following the frame chain back up the stack. |
| 94 | |
| 95 | A nice side effect is that we can still debug startup code without |
| 96 | running off the end of the frame chain, assuming that we have usable |
| 97 | debugging information in the startup modules, and if we choose to not |
| 98 | use the block at main, or can't find it for some reason, everything |
| 99 | still works as before. And if we have no startup code debugging |
| 100 | information but we do have usable information for main(), backtraces |
| 101 | from user code don't go wandering off into the startup code. |
| 102 | |
| 103 | To use this method, define your DEPRECATED_FRAME_CHAIN_VALID macro |
| 104 | like: |
| 105 | |
| 106 | #define DEPRECATED_FRAME_CHAIN_VALID(chain, thisframe) \ |
| 107 | (chain != 0 \ |
| 108 | && !(inside_main_func ((thisframe)->pc)) \ |
| 109 | && !(inside_entry_func ((thisframe)->pc))) |
| 110 | |
| 111 | and add initializations of the four scope controlling variables inside |
| 112 | the object file / debugging information processing modules. */ |
| 113 | |
| 114 | struct entry_info |
| 115 | { |
| 116 | |
| 117 | /* The value we should use for this objects entry point. |
| 118 | The illegal/unknown value needs to be something other than 0, ~0 |
| 119 | for instance, which is much less likely than 0. */ |
| 120 | |
| 121 | CORE_ADDR entry_point; |
| 122 | |
| 123 | #define INVALID_ENTRY_POINT (~0) /* ~0 will not be in any file, we hope. */ |
| 124 | |
| 125 | /* Start (inclusive) and end (exclusive) of function containing the |
| 126 | entry point. */ |
| 127 | |
| 128 | CORE_ADDR entry_func_lowpc; |
| 129 | CORE_ADDR entry_func_highpc; |
| 130 | |
| 131 | /* Start (inclusive) and end (exclusive) of object file containing the |
| 132 | entry point. */ |
| 133 | |
| 134 | CORE_ADDR deprecated_entry_file_lowpc; |
| 135 | CORE_ADDR deprecated_entry_file_highpc; |
| 136 | |
| 137 | /* Start (inclusive) and end (exclusive) of the user code main() function. */ |
| 138 | |
| 139 | CORE_ADDR main_func_lowpc; |
| 140 | CORE_ADDR main_func_highpc; |
| 141 | |
| 142 | /* Use these values when any of the above ranges is invalid. */ |
| 143 | |
| 144 | /* We use these values because it guarantees that there is no number that is |
| 145 | both >= LOWPC && < HIGHPC. It is also highly unlikely that 3 is a valid |
| 146 | module or function start address (as opposed to 0). */ |
| 147 | |
| 148 | #define INVALID_ENTRY_LOWPC (3) |
| 149 | #define INVALID_ENTRY_HIGHPC (1) |
| 150 | |
| 151 | }; |
| 152 | |
| 153 | /* Sections in an objfile. |
| 154 | |
| 155 | It is strange that we have both this notion of "sections" |
| 156 | and the one used by section_offsets. Section as used |
| 157 | here, (currently at least) means a BFD section, and the sections |
| 158 | are set up from the BFD sections in allocate_objfile. |
| 159 | |
| 160 | The sections in section_offsets have their meaning determined by |
| 161 | the symbol format, and they are set up by the sym_offsets function |
| 162 | for that symbol file format. |
| 163 | |
| 164 | I'm not sure this could or should be changed, however. */ |
| 165 | |
| 166 | struct obj_section |
| 167 | { |
| 168 | CORE_ADDR addr; /* lowest address in section */ |
| 169 | CORE_ADDR endaddr; /* 1+highest address in section */ |
| 170 | |
| 171 | /* This field is being used for nefarious purposes by syms_from_objfile. |
| 172 | It is said to be redundant with section_offsets; it's not really being |
| 173 | used that way, however, it's some sort of hack I don't understand |
| 174 | and am not going to try to eliminate (yet, anyway). FIXME. |
| 175 | |
| 176 | It was documented as "offset between (end)addr and actual memory |
| 177 | addresses", but that's not true; addr & endaddr are actual memory |
| 178 | addresses. */ |
| 179 | CORE_ADDR offset; |
| 180 | |
| 181 | struct bfd_section *the_bfd_section; /* BFD section pointer */ |
| 182 | |
| 183 | /* Objfile this section is part of. */ |
| 184 | struct objfile *objfile; |
| 185 | |
| 186 | /* True if this "overlay section" is mapped into an "overlay region". */ |
| 187 | int ovly_mapped; |
| 188 | }; |
| 189 | |
| 190 | /* An import entry contains information about a symbol that |
| 191 | is used in this objfile but not defined in it, and so needs |
| 192 | to be imported from some other objfile */ |
| 193 | /* Currently we just store the name; no attributes. 1997-08-05 */ |
| 194 | typedef char *ImportEntry; |
| 195 | |
| 196 | |
| 197 | /* An export entry contains information about a symbol that |
| 198 | is defined in this objfile and available for use in other |
| 199 | objfiles */ |
| 200 | typedef struct |
| 201 | { |
| 202 | char *name; /* name of exported symbol */ |
| 203 | int address; /* offset subject to relocation */ |
| 204 | /* Currently no other attributes 1997-08-05 */ |
| 205 | } |
| 206 | ExportEntry; |
| 207 | |
| 208 | |
| 209 | /* The "objstats" structure provides a place for gdb to record some |
| 210 | interesting information about its internal state at runtime, on a |
| 211 | per objfile basis, such as information about the number of symbols |
| 212 | read, size of string table (if any), etc. */ |
| 213 | |
| 214 | struct objstats |
| 215 | { |
| 216 | int n_minsyms; /* Number of minimal symbols read */ |
| 217 | int n_psyms; /* Number of partial symbols read */ |
| 218 | int n_syms; /* Number of full symbols read */ |
| 219 | int n_stabs; /* Number of ".stabs" read (if applicable) */ |
| 220 | int n_types; /* Number of types */ |
| 221 | int sz_strtab; /* Size of stringtable, (if applicable) */ |
| 222 | }; |
| 223 | |
| 224 | #define OBJSTAT(objfile, expr) (objfile -> stats.expr) |
| 225 | #define OBJSTATS struct objstats stats |
| 226 | extern void print_objfile_statistics (void); |
| 227 | extern void print_symbol_bcache_statistics (void); |
| 228 | |
| 229 | /* Number of entries in the minimal symbol hash table. */ |
| 230 | #define MINIMAL_SYMBOL_HASH_SIZE 2039 |
| 231 | |
| 232 | /* Master structure for keeping track of each file from which |
| 233 | gdb reads symbols. There are several ways these get allocated: 1. |
| 234 | The main symbol file, symfile_objfile, set by the symbol-file command, |
| 235 | 2. Additional symbol files added by the add-symbol-file command, |
| 236 | 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files |
| 237 | for modules that were loaded when GDB attached to a remote system |
| 238 | (see remote-vx.c). */ |
| 239 | |
| 240 | struct objfile |
| 241 | { |
| 242 | |
| 243 | /* All struct objfile's are chained together by their next pointers. |
| 244 | The global variable "object_files" points to the first link in this |
| 245 | chain. |
| 246 | |
| 247 | FIXME: There is a problem here if the objfile is reusable, and if |
| 248 | multiple users are to be supported. The problem is that the objfile |
| 249 | list is linked through a member of the objfile struct itself, which |
| 250 | is only valid for one gdb process. The list implementation needs to |
| 251 | be changed to something like: |
| 252 | |
| 253 | struct list {struct list *next; struct objfile *objfile}; |
| 254 | |
| 255 | where the list structure is completely maintained separately within |
| 256 | each gdb process. */ |
| 257 | |
| 258 | struct objfile *next; |
| 259 | |
| 260 | /* The object file's name, tilde-expanded and absolute. |
| 261 | Malloc'd; free it if you free this struct. */ |
| 262 | |
| 263 | char *name; |
| 264 | |
| 265 | /* Some flag bits for this objfile. */ |
| 266 | |
| 267 | unsigned short flags; |
| 268 | |
| 269 | /* Each objfile points to a linked list of symtabs derived from this file, |
| 270 | one symtab structure for each compilation unit (source file). Each link |
| 271 | in the symtab list contains a backpointer to this objfile. */ |
| 272 | |
| 273 | struct symtab *symtabs; |
| 274 | |
| 275 | /* Each objfile points to a linked list of partial symtabs derived from |
| 276 | this file, one partial symtab structure for each compilation unit |
| 277 | (source file). */ |
| 278 | |
| 279 | struct partial_symtab *psymtabs; |
| 280 | |
| 281 | /* List of freed partial symtabs, available for re-use */ |
| 282 | |
| 283 | struct partial_symtab *free_psymtabs; |
| 284 | |
| 285 | /* The object file's BFD. Can be null if the objfile contains only |
| 286 | minimal symbols, e.g. the run time common symbols for SunOS4. */ |
| 287 | |
| 288 | bfd *obfd; |
| 289 | |
| 290 | /* The modification timestamp of the object file, as of the last time |
| 291 | we read its symbols. */ |
| 292 | |
| 293 | long mtime; |
| 294 | |
| 295 | /* Obstacks to hold objects that should be freed when we load a new symbol |
| 296 | table from this object file. */ |
| 297 | |
| 298 | struct obstack psymbol_obstack; /* Partial symbols */ |
| 299 | struct obstack symbol_obstack; /* Full symbols */ |
| 300 | struct obstack type_obstack; /* Types */ |
| 301 | |
| 302 | /* A byte cache where we can stash arbitrary "chunks" of bytes that |
| 303 | will not change. */ |
| 304 | |
| 305 | struct bcache *psymbol_cache; /* Byte cache for partial syms */ |
| 306 | struct bcache *macro_cache; /* Byte cache for macros */ |
| 307 | |
| 308 | /* Hash table for mapping symbol names to demangled names. Each |
| 309 | entry in the hash table is actually two consecutive strings, |
| 310 | both null-terminated; the first one is a mangled or linkage |
| 311 | name, and the second is the demangled name or just a zero byte |
| 312 | if the name doesn't demangle. */ |
| 313 | struct htab *demangled_names_hash; |
| 314 | |
| 315 | /* Vectors of all partial symbols read in from file. The actual data |
| 316 | is stored in the psymbol_obstack. */ |
| 317 | |
| 318 | struct psymbol_allocation_list global_psymbols; |
| 319 | struct psymbol_allocation_list static_psymbols; |
| 320 | |
| 321 | /* Each file contains a pointer to an array of minimal symbols for all |
| 322 | global symbols that are defined within the file. The array is terminated |
| 323 | by a "null symbol", one that has a NULL pointer for the name and a zero |
| 324 | value for the address. This makes it easy to walk through the array |
| 325 | when passed a pointer to somewhere in the middle of it. There is also |
| 326 | a count of the number of symbols, which does not include the terminating |
| 327 | null symbol. The array itself, as well as all the data that it points |
| 328 | to, should be allocated on the symbol_obstack for this file. */ |
| 329 | |
| 330 | struct minimal_symbol *msymbols; |
| 331 | int minimal_symbol_count; |
| 332 | |
| 333 | /* This is a hash table used to index the minimal symbols by name. */ |
| 334 | |
| 335 | struct minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE]; |
| 336 | |
| 337 | /* This hash table is used to index the minimal symbols by their |
| 338 | demangled names. */ |
| 339 | |
| 340 | struct minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE]; |
| 341 | |
| 342 | /* For object file formats which don't specify fundamental types, gdb |
| 343 | can create such types. For now, it maintains a vector of pointers |
| 344 | to these internally created fundamental types on a per objfile basis, |
| 345 | however it really should ultimately keep them on a per-compilation-unit |
| 346 | basis, to account for linkage-units that consist of a number of |
| 347 | compilation units that may have different fundamental types, such as |
| 348 | linking C modules with ADA modules, or linking C modules that are |
| 349 | compiled with 32-bit ints with C modules that are compiled with 64-bit |
| 350 | ints (not inherently evil with a smarter linker). */ |
| 351 | |
| 352 | struct type **fundamental_types; |
| 353 | |
| 354 | /* The mmalloc() malloc-descriptor for this objfile if we are using |
| 355 | the memory mapped malloc() package to manage storage for this objfile's |
| 356 | data. NULL if we are not. */ |
| 357 | |
| 358 | void *md; |
| 359 | |
| 360 | /* The file descriptor that was used to obtain the mmalloc descriptor |
| 361 | for this objfile. If we call mmalloc_detach with the malloc descriptor |
| 362 | we should then close this file descriptor. */ |
| 363 | |
| 364 | int mmfd; |
| 365 | |
| 366 | /* Structure which keeps track of functions that manipulate objfile's |
| 367 | of the same type as this objfile. I.E. the function to read partial |
| 368 | symbols for example. Note that this structure is in statically |
| 369 | allocated memory, and is shared by all objfiles that use the |
| 370 | object module reader of this type. */ |
| 371 | |
| 372 | struct sym_fns *sf; |
| 373 | |
| 374 | /* The per-objfile information about the entry point, the scope (file/func) |
| 375 | containing the entry point, and the scope of the user's main() func. */ |
| 376 | |
| 377 | struct entry_info ei; |
| 378 | |
| 379 | /* Information about stabs. Will be filled in with a dbx_symfile_info |
| 380 | struct by those readers that need it. */ |
| 381 | |
| 382 | struct dbx_symfile_info *sym_stab_info; |
| 383 | |
| 384 | /* Hook for information for use by the symbol reader (currently used |
| 385 | for information shared by sym_init and sym_read). It is |
| 386 | typically a pointer to malloc'd memory. The symbol reader's finish |
| 387 | function is responsible for freeing the memory thusly allocated. */ |
| 388 | |
| 389 | void *sym_private; |
| 390 | |
| 391 | /* Hook for target-architecture-specific information. This must |
| 392 | point to memory allocated on one of the obstacks in this objfile, |
| 393 | so that it gets freed automatically when reading a new object |
| 394 | file. */ |
| 395 | |
| 396 | void *obj_private; |
| 397 | |
| 398 | /* Per objfile data-pointers required by other GDB modules. */ |
| 399 | /* FIXME: kettenis/20030711: This mechanism could replace |
| 400 | sym_stab_info, sym_private and obj_private entirely. */ |
| 401 | |
| 402 | void **data; |
| 403 | unsigned num_data; |
| 404 | |
| 405 | /* Set of relocation offsets to apply to each section. |
| 406 | Currently on the psymbol_obstack (which makes no sense, but I'm |
| 407 | not sure it's harming anything). |
| 408 | |
| 409 | These offsets indicate that all symbols (including partial and |
| 410 | minimal symbols) which have been read have been relocated by this |
| 411 | much. Symbols which are yet to be read need to be relocated by |
| 412 | it. */ |
| 413 | |
| 414 | struct section_offsets *section_offsets; |
| 415 | int num_sections; |
| 416 | |
| 417 | /* Indexes in the section_offsets array. These are initialized by the |
| 418 | *_symfile_offsets() family of functions (som_symfile_offsets, |
| 419 | xcoff_symfile_offsets, default_symfile_offsets). In theory they |
| 420 | should correspond to the section indexes used by bfd for the |
| 421 | current objfile. The exception to this for the time being is the |
| 422 | SOM version. */ |
| 423 | |
| 424 | int sect_index_text; |
| 425 | int sect_index_data; |
| 426 | int sect_index_bss; |
| 427 | int sect_index_rodata; |
| 428 | |
| 429 | /* These pointers are used to locate the section table, which |
| 430 | among other things, is used to map pc addresses into sections. |
| 431 | SECTIONS points to the first entry in the table, and |
| 432 | SECTIONS_END points to the first location past the last entry |
| 433 | in the table. Currently the table is stored on the |
| 434 | psymbol_obstack (which makes no sense, but I'm not sure it's |
| 435 | harming anything). */ |
| 436 | |
| 437 | struct obj_section |
| 438 | *sections, *sections_end; |
| 439 | |
| 440 | /* two auxiliary fields, used to hold the fp of separate symbol files */ |
| 441 | FILE *auxf1, *auxf2; |
| 442 | |
| 443 | /* Imported symbols */ |
| 444 | ImportEntry *import_list; |
| 445 | int import_list_size; |
| 446 | |
| 447 | /* Exported symbols */ |
| 448 | ExportEntry *export_list; |
| 449 | int export_list_size; |
| 450 | |
| 451 | /* Link to objfile that contains the debug symbols for this one. |
| 452 | One is loaded if this file has an debug link to an existing |
| 453 | debug file with the right checksum */ |
| 454 | struct objfile *separate_debug_objfile; |
| 455 | |
| 456 | /* If this is a separate debug object, this is used as a link to the |
| 457 | actual executable objfile. */ |
| 458 | struct objfile *separate_debug_objfile_backlink; |
| 459 | |
| 460 | /* Place to stash various statistics about this objfile */ |
| 461 | OBJSTATS; |
| 462 | |
| 463 | /* A symtab that the C++ code uses to stash special symbols |
| 464 | associated to namespaces. */ |
| 465 | |
| 466 | /* FIXME/carlton-2003-06-27: Delete this in a few years once |
| 467 | "possible namespace symbols" go away. */ |
| 468 | struct symtab *cp_namespace_symtab; |
| 469 | }; |
| 470 | |
| 471 | /* Defines for the objfile flag word. */ |
| 472 | |
| 473 | /* Gdb can arrange to allocate storage for all objects related to a |
| 474 | particular objfile in a designated section of its address space, |
| 475 | managed at a low level by mmap() and using a special version of |
| 476 | malloc that handles malloc/free/realloc on top of the mmap() interface. |
| 477 | This allows the "internal gdb state" for a particular objfile to be |
| 478 | dumped to a gdb state file and subsequently reloaded at a later time. */ |
| 479 | |
| 480 | #define OBJF_MAPPED (1 << 0) /* Objfile data is mmap'd */ |
| 481 | |
| 482 | /* When using mapped/remapped predigested gdb symbol information, we need |
| 483 | a flag that indicates that we have previously done an initial symbol |
| 484 | table read from this particular objfile. We can't just look for the |
| 485 | absence of any of the three symbol tables (msymbols, psymtab, symtab) |
| 486 | because if the file has no symbols for example, none of these will |
| 487 | exist. */ |
| 488 | |
| 489 | #define OBJF_SYMS (1 << 1) /* Have tried to read symbols */ |
| 490 | |
| 491 | /* When an object file has its functions reordered (currently Irix-5.2 |
| 492 | shared libraries exhibit this behaviour), we will need an expensive |
| 493 | algorithm to locate a partial symtab or symtab via an address. |
| 494 | To avoid this penalty for normal object files, we use this flag, |
| 495 | whose setting is determined upon symbol table read in. */ |
| 496 | |
| 497 | #define OBJF_REORDERED (1 << 2) /* Functions are reordered */ |
| 498 | |
| 499 | /* Distinguish between an objfile for a shared library and a "vanilla" |
| 500 | objfile. (If not set, the objfile may still actually be a solib. |
| 501 | This can happen if the user created the objfile by using the |
| 502 | add-symbol-file command. GDB doesn't in that situation actually |
| 503 | check whether the file is a solib. Rather, the target's |
| 504 | implementation of the solib interface is responsible for setting |
| 505 | this flag when noticing solibs used by an inferior.) */ |
| 506 | |
| 507 | #define OBJF_SHARED (1 << 3) /* From a shared library */ |
| 508 | |
| 509 | /* User requested that this objfile be read in it's entirety. */ |
| 510 | |
| 511 | #define OBJF_READNOW (1 << 4) /* Immediate full read */ |
| 512 | |
| 513 | /* This objfile was created because the user explicitly caused it |
| 514 | (e.g., used the add-symbol-file command). This bit offers a way |
| 515 | for run_command to remove old objfile entries which are no longer |
| 516 | valid (i.e., are associated with an old inferior), but to preserve |
| 517 | ones that the user explicitly loaded via the add-symbol-file |
| 518 | command. */ |
| 519 | |
| 520 | #define OBJF_USERLOADED (1 << 5) /* User loaded */ |
| 521 | |
| 522 | /* The object file that the main symbol table was loaded from (e.g. the |
| 523 | argument to the "symbol-file" or "file" command). */ |
| 524 | |
| 525 | extern struct objfile *symfile_objfile; |
| 526 | |
| 527 | /* The object file that contains the runtime common minimal symbols |
| 528 | for SunOS4. Note that this objfile has no associated BFD. */ |
| 529 | |
| 530 | extern struct objfile *rt_common_objfile; |
| 531 | |
| 532 | /* When we need to allocate a new type, we need to know which type_obstack |
| 533 | to allocate the type on, since there is one for each objfile. The places |
| 534 | where types are allocated are deeply buried in function call hierarchies |
| 535 | which know nothing about objfiles, so rather than trying to pass a |
| 536 | particular objfile down to them, we just do an end run around them and |
| 537 | set current_objfile to be whatever objfile we expect to be using at the |
| 538 | time types are being allocated. For instance, when we start reading |
| 539 | symbols for a particular objfile, we set current_objfile to point to that |
| 540 | objfile, and when we are done, we set it back to NULL, to ensure that we |
| 541 | never put a type someplace other than where we are expecting to put it. |
| 542 | FIXME: Maybe we should review the entire type handling system and |
| 543 | see if there is a better way to avoid this problem. */ |
| 544 | |
| 545 | extern struct objfile *current_objfile; |
| 546 | |
| 547 | /* All known objfiles are kept in a linked list. This points to the |
| 548 | root of this list. */ |
| 549 | |
| 550 | extern struct objfile *object_files; |
| 551 | |
| 552 | /* Declarations for functions defined in objfiles.c */ |
| 553 | |
| 554 | extern struct objfile *allocate_objfile (bfd *, int); |
| 555 | |
| 556 | extern int build_objfile_section_table (struct objfile *); |
| 557 | |
| 558 | extern void terminate_minimal_symbol_table (struct objfile *objfile); |
| 559 | |
| 560 | extern void put_objfile_before (struct objfile *, struct objfile *); |
| 561 | |
| 562 | extern void objfile_to_front (struct objfile *); |
| 563 | |
| 564 | extern void unlink_objfile (struct objfile *); |
| 565 | |
| 566 | extern void free_objfile (struct objfile *); |
| 567 | |
| 568 | extern struct cleanup *make_cleanup_free_objfile (struct objfile *); |
| 569 | |
| 570 | extern void free_all_objfiles (void); |
| 571 | |
| 572 | extern void objfile_relocate (struct objfile *, struct section_offsets *); |
| 573 | |
| 574 | extern int have_partial_symbols (void); |
| 575 | |
| 576 | extern int have_full_symbols (void); |
| 577 | |
| 578 | /* This operation deletes all objfile entries that represent solibs that |
| 579 | weren't explicitly loaded by the user, via e.g., the add-symbol-file |
| 580 | command. |
| 581 | */ |
| 582 | extern void objfile_purge_solibs (void); |
| 583 | |
| 584 | /* Functions for dealing with the minimal symbol table, really a misc |
| 585 | address<->symbol mapping for things we don't have debug symbols for. */ |
| 586 | |
| 587 | extern int have_minimal_symbols (void); |
| 588 | |
| 589 | extern struct obj_section *find_pc_section (CORE_ADDR pc); |
| 590 | |
| 591 | extern struct obj_section *find_pc_sect_section (CORE_ADDR pc, |
| 592 | asection * section); |
| 593 | |
| 594 | extern int in_plt_section (CORE_ADDR, char *); |
| 595 | |
| 596 | extern int is_in_import_list (char *, struct objfile *); |
| 597 | |
| 598 | /* Keep a registry of per-objfile data-pointers required by other GDB |
| 599 | modules. */ |
| 600 | |
| 601 | extern const struct objfile_data *register_objfile_data (void); |
| 602 | extern void clear_objfile_data (struct objfile *objfile); |
| 603 | extern void set_objfile_data (struct objfile *objfile, |
| 604 | const struct objfile_data *data, void *value); |
| 605 | extern void *objfile_data (struct objfile *objfile, |
| 606 | const struct objfile_data *data); |
| 607 | \f |
| 608 | |
| 609 | /* Traverse all object files. ALL_OBJFILES_SAFE works even if you delete |
| 610 | the objfile during the traversal. */ |
| 611 | |
| 612 | #define ALL_OBJFILES(obj) \ |
| 613 | for ((obj) = object_files; (obj) != NULL; (obj) = (obj)->next) |
| 614 | |
| 615 | #define ALL_OBJFILES_SAFE(obj,nxt) \ |
| 616 | for ((obj) = object_files; \ |
| 617 | (obj) != NULL? ((nxt)=(obj)->next,1) :0; \ |
| 618 | (obj) = (nxt)) |
| 619 | |
| 620 | /* Traverse all symtabs in one objfile. */ |
| 621 | |
| 622 | #define ALL_OBJFILE_SYMTABS(objfile, s) \ |
| 623 | for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next) |
| 624 | |
| 625 | /* Traverse all psymtabs in one objfile. */ |
| 626 | |
| 627 | #define ALL_OBJFILE_PSYMTABS(objfile, p) \ |
| 628 | for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next) |
| 629 | |
| 630 | /* Traverse all minimal symbols in one objfile. */ |
| 631 | |
| 632 | #define ALL_OBJFILE_MSYMBOLS(objfile, m) \ |
| 633 | for ((m) = (objfile) -> msymbols; DEPRECATED_SYMBOL_NAME(m) != NULL; (m)++) |
| 634 | |
| 635 | /* Traverse all symtabs in all objfiles. */ |
| 636 | |
| 637 | #define ALL_SYMTABS(objfile, s) \ |
| 638 | ALL_OBJFILES (objfile) \ |
| 639 | ALL_OBJFILE_SYMTABS (objfile, s) |
| 640 | |
| 641 | /* Traverse all psymtabs in all objfiles. */ |
| 642 | |
| 643 | #define ALL_PSYMTABS(objfile, p) \ |
| 644 | ALL_OBJFILES (objfile) \ |
| 645 | ALL_OBJFILE_PSYMTABS (objfile, p) |
| 646 | |
| 647 | /* Traverse all minimal symbols in all objfiles. */ |
| 648 | |
| 649 | #define ALL_MSYMBOLS(objfile, m) \ |
| 650 | ALL_OBJFILES (objfile) \ |
| 651 | ALL_OBJFILE_MSYMBOLS (objfile, m) |
| 652 | |
| 653 | #define ALL_OBJFILE_OSECTIONS(objfile, osect) \ |
| 654 | for (osect = objfile->sections; osect < objfile->sections_end; osect++) |
| 655 | |
| 656 | #define ALL_OBJSECTIONS(objfile, osect) \ |
| 657 | ALL_OBJFILES (objfile) \ |
| 658 | ALL_OBJFILE_OSECTIONS (objfile, osect) |
| 659 | |
| 660 | #define SECT_OFF_DATA(objfile) \ |
| 661 | ((objfile->sect_index_data == -1) \ |
| 662 | ? (internal_error (__FILE__, __LINE__, "sect_index_data not initialized"), -1) \ |
| 663 | : objfile->sect_index_data) |
| 664 | |
| 665 | #define SECT_OFF_RODATA(objfile) \ |
| 666 | ((objfile->sect_index_rodata == -1) \ |
| 667 | ? (internal_error (__FILE__, __LINE__, "sect_index_rodata not initialized"), -1) \ |
| 668 | : objfile->sect_index_rodata) |
| 669 | |
| 670 | #define SECT_OFF_TEXT(objfile) \ |
| 671 | ((objfile->sect_index_text == -1) \ |
| 672 | ? (internal_error (__FILE__, __LINE__, "sect_index_text not initialized"), -1) \ |
| 673 | : objfile->sect_index_text) |
| 674 | |
| 675 | /* Sometimes the .bss section is missing from the objfile, so we don't |
| 676 | want to die here. Let the users of SECT_OFF_BSS deal with an |
| 677 | uninitialized section index. */ |
| 678 | #define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss |
| 679 | |
| 680 | #endif /* !defined (OBJFILES_H) */ |