1 /* Definitions for symbol file management in GDB.
3 Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
6 This file is part of GDB.
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.
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.
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. */
23 #if !defined (OBJFILES_H)
26 #include "gdb_obstack.h" /* For obstack internals. */
27 #include "symfile.h" /* For struct psymbol_allocation_list */
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.
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.
47 The traditional gdb method of using this info was to use the
48 recorded entry point to set the entry-file's lowpc and highpc from
49 the debugging information, where these values are the starting
50 address (inclusive) and ending address (exclusive) of the
51 instruction space in the executable which correspond to the
52 "startup file", I.E. crt0.o in most cases. This file is assumed to
53 be a startup file and frames with pc's inside it are treated as
54 nonexistent. Setting these variables is necessary so that
55 backtraces do not fly off the bottom of the stack.
57 NOTE: cagney/2003-09-09: It turns out that this "traditional"
58 method doesn't work. Corinna writes: ``It turns out that the call
59 to test for "inside entry file" destroys a meaningful backtrace
60 under some conditions. E. g. the backtrace tests in the asm-source
61 testcase are broken for some targets. In this test the functions
62 are all implemented as part of one file and the testcase is not
63 necessarily linked with a start file (depending on the target).
64 What happens is, that the first frame is printed normaly and
65 following frames are treated as being inside the enttry file then.
66 This way, only the #0 frame is printed in the backtrace output.''
67 Ref "frame.c" "NOTE: vinschen/2003-04-01".
69 Gdb also supports an alternate method to avoid running off the bottom
72 There are two frames that are "special", the frame for the function
73 containing the process entry point, since it has no predecessor frame,
74 and the frame for the function containing the user code entry point
75 (the main() function), since all the predecessor frames are for the
76 process startup code. Since we have no guarantee that the linked
77 in startup modules have any debugging information that gdb can use,
78 we need to avoid following frame pointers back into frames that might
79 have been built in the startup code, as we might get hopelessly
80 confused. However, we almost always have debugging information
83 These variables are used to save the range of PC values which are
84 valid within the main() function and within the function containing
85 the process entry point. If we always consider the frame for
86 main() as the outermost frame when debugging user code, and the
87 frame for the process entry point function as the outermost frame
88 when debugging startup code, then all we have to do is have
89 DEPRECATED_FRAME_CHAIN_VALID return false whenever a frame's
90 current PC is within the range specified by these variables. In
91 essence, we set "ceilings" in the frame chain beyond which we will
92 not proceed when following the frame chain back up the stack.
94 A nice side effect is that we can still debug startup code without
95 running off the end of the frame chain, assuming that we have usable
96 debugging information in the startup modules, and if we choose to not
97 use the block at main, or can't find it for some reason, everything
98 still works as before. And if we have no startup code debugging
99 information but we do have usable information for main(), backtraces
100 from user code don't go wandering off into the startup code. */
105 /* The value we should use for this objects entry point.
106 The illegal/unknown value needs to be something other than 0, ~0
107 for instance, which is much less likely than 0. */
109 CORE_ADDR entry_point
;
111 #define INVALID_ENTRY_POINT (~0) /* ~0 will not be in any file, we hope. */
113 /* Start (inclusive) and end (exclusive) of function containing the
116 CORE_ADDR entry_func_lowpc
;
117 CORE_ADDR entry_func_highpc
;
119 /* Start (inclusive) and end (exclusive) of the user code main() function. */
121 CORE_ADDR main_func_lowpc
;
122 CORE_ADDR main_func_highpc
;
124 /* Use these values when any of the above ranges is invalid. */
126 /* We use these values because it guarantees that there is no number that is
127 both >= LOWPC && < HIGHPC. It is also highly unlikely that 3 is a valid
128 module or function start address (as opposed to 0). */
130 #define INVALID_ENTRY_LOWPC (3)
131 #define INVALID_ENTRY_HIGHPC (1)
135 /* Sections in an objfile.
137 It is strange that we have both this notion of "sections"
138 and the one used by section_offsets. Section as used
139 here, (currently at least) means a BFD section, and the sections
140 are set up from the BFD sections in allocate_objfile.
142 The sections in section_offsets have their meaning determined by
143 the symbol format, and they are set up by the sym_offsets function
144 for that symbol file format.
146 I'm not sure this could or should be changed, however. */
150 CORE_ADDR addr
; /* lowest address in section */
151 CORE_ADDR endaddr
; /* 1+highest address in section */
153 /* This field is being used for nefarious purposes by syms_from_objfile.
154 It is said to be redundant with section_offsets; it's not really being
155 used that way, however, it's some sort of hack I don't understand
156 and am not going to try to eliminate (yet, anyway). FIXME.
158 It was documented as "offset between (end)addr and actual memory
159 addresses", but that's not true; addr & endaddr are actual memory
163 struct bfd_section
*the_bfd_section
; /* BFD section pointer */
165 /* Objfile this section is part of. */
166 struct objfile
*objfile
;
168 /* True if this "overlay section" is mapped into an "overlay region". */
172 /* An import entry contains information about a symbol that
173 is used in this objfile but not defined in it, and so needs
174 to be imported from some other objfile */
175 /* Currently we just store the name; no attributes. 1997-08-05 */
176 typedef char *ImportEntry
;
179 /* An export entry contains information about a symbol that
180 is defined in this objfile and available for use in other
184 char *name
; /* name of exported symbol */
185 int address
; /* offset subject to relocation */
186 /* Currently no other attributes 1997-08-05 */
191 /* The "objstats" structure provides a place for gdb to record some
192 interesting information about its internal state at runtime, on a
193 per objfile basis, such as information about the number of symbols
194 read, size of string table (if any), etc. */
198 int n_minsyms
; /* Number of minimal symbols read */
199 int n_psyms
; /* Number of partial symbols read */
200 int n_syms
; /* Number of full symbols read */
201 int n_stabs
; /* Number of ".stabs" read (if applicable) */
202 int n_types
; /* Number of types */
203 int sz_strtab
; /* Size of stringtable, (if applicable) */
206 #define OBJSTAT(objfile, expr) (objfile -> stats.expr)
207 #define OBJSTATS struct objstats stats
208 extern void print_objfile_statistics (void);
209 extern void print_symbol_bcache_statistics (void);
211 /* Number of entries in the minimal symbol hash table. */
212 #define MINIMAL_SYMBOL_HASH_SIZE 2039
214 /* Master structure for keeping track of each file from which
215 gdb reads symbols. There are several ways these get allocated: 1.
216 The main symbol file, symfile_objfile, set by the symbol-file command,
217 2. Additional symbol files added by the add-symbol-file command,
218 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files
219 for modules that were loaded when GDB attached to a remote system
220 (see remote-vx.c). */
225 /* All struct objfile's are chained together by their next pointers.
226 The global variable "object_files" points to the first link in this
229 FIXME: There is a problem here if the objfile is reusable, and if
230 multiple users are to be supported. The problem is that the objfile
231 list is linked through a member of the objfile struct itself, which
232 is only valid for one gdb process. The list implementation needs to
233 be changed to something like:
235 struct list {struct list *next; struct objfile *objfile};
237 where the list structure is completely maintained separately within
240 struct objfile
*next
;
242 /* The object file's name, tilde-expanded and absolute.
243 Malloc'd; free it if you free this struct. */
247 /* Some flag bits for this objfile. */
249 unsigned short flags
;
251 /* Each objfile points to a linked list of symtabs derived from this file,
252 one symtab structure for each compilation unit (source file). Each link
253 in the symtab list contains a backpointer to this objfile. */
255 struct symtab
*symtabs
;
257 /* Each objfile points to a linked list of partial symtabs derived from
258 this file, one partial symtab structure for each compilation unit
261 struct partial_symtab
*psymtabs
;
263 /* List of freed partial symtabs, available for re-use */
265 struct partial_symtab
*free_psymtabs
;
267 /* The object file's BFD. Can be null if the objfile contains only
268 minimal symbols, e.g. the run time common symbols for SunOS4. */
272 /* The modification timestamp of the object file, as of the last time
273 we read its symbols. */
277 /* Obstack to hold objects that should be freed when we load a new symbol
278 table from this object file. */
280 struct obstack objfile_obstack
;
282 /* A byte cache where we can stash arbitrary "chunks" of bytes that
285 struct bcache
*psymbol_cache
; /* Byte cache for partial syms */
286 struct bcache
*macro_cache
; /* Byte cache for macros */
288 /* Hash table for mapping symbol names to demangled names. Each
289 entry in the hash table is actually two consecutive strings,
290 both null-terminated; the first one is a mangled or linkage
291 name, and the second is the demangled name or just a zero byte
292 if the name doesn't demangle. */
293 struct htab
*demangled_names_hash
;
295 /* Vectors of all partial symbols read in from file. The actual data
296 is stored in the objfile_obstack. */
298 struct psymbol_allocation_list global_psymbols
;
299 struct psymbol_allocation_list static_psymbols
;
301 /* Each file contains a pointer to an array of minimal symbols for all
302 global symbols that are defined within the file. The array is terminated
303 by a "null symbol", one that has a NULL pointer for the name and a zero
304 value for the address. This makes it easy to walk through the array
305 when passed a pointer to somewhere in the middle of it. There is also
306 a count of the number of symbols, which does not include the terminating
307 null symbol. The array itself, as well as all the data that it points
308 to, should be allocated on the objfile_obstack for this file. */
310 struct minimal_symbol
*msymbols
;
311 int minimal_symbol_count
;
313 /* This is a hash table used to index the minimal symbols by name. */
315 struct minimal_symbol
*msymbol_hash
[MINIMAL_SYMBOL_HASH_SIZE
];
317 /* This hash table is used to index the minimal symbols by their
320 struct minimal_symbol
*msymbol_demangled_hash
[MINIMAL_SYMBOL_HASH_SIZE
];
322 /* For object file formats which don't specify fundamental types, gdb
323 can create such types. For now, it maintains a vector of pointers
324 to these internally created fundamental types on a per objfile basis,
325 however it really should ultimately keep them on a per-compilation-unit
326 basis, to account for linkage-units that consist of a number of
327 compilation units that may have different fundamental types, such as
328 linking C modules with ADA modules, or linking C modules that are
329 compiled with 32-bit ints with C modules that are compiled with 64-bit
330 ints (not inherently evil with a smarter linker). */
332 struct type
**fundamental_types
;
334 /* The mmalloc() malloc-descriptor for this objfile if we are using
335 the memory mapped malloc() package to manage storage for this objfile's
336 data. NULL if we are not. */
340 /* The file descriptor that was used to obtain the mmalloc descriptor
341 for this objfile. If we call mmalloc_detach with the malloc descriptor
342 we should then close this file descriptor. */
346 /* Structure which keeps track of functions that manipulate objfile's
347 of the same type as this objfile. I.E. the function to read partial
348 symbols for example. Note that this structure is in statically
349 allocated memory, and is shared by all objfiles that use the
350 object module reader of this type. */
354 /* The per-objfile information about the entry point, the scope (file/func)
355 containing the entry point, and the scope of the user's main() func. */
357 struct entry_info ei
;
359 /* Information about stabs. Will be filled in with a dbx_symfile_info
360 struct by those readers that need it. */
362 struct dbx_symfile_info
*sym_stab_info
;
364 /* Hook for information for use by the symbol reader (currently used
365 for information shared by sym_init and sym_read). It is
366 typically a pointer to malloc'd memory. The symbol reader's finish
367 function is responsible for freeing the memory thusly allocated. */
371 /* Hook for target-architecture-specific information. This must
372 point to memory allocated on one of the obstacks in this objfile,
373 so that it gets freed automatically when reading a new object
378 /* Per objfile data-pointers required by other GDB modules. */
379 /* FIXME: kettenis/20030711: This mechanism could replace
380 sym_stab_info, sym_private and obj_private entirely. */
385 /* Set of relocation offsets to apply to each section.
386 Currently on the objfile_obstack (which makes no sense, but I'm
387 not sure it's harming anything).
389 These offsets indicate that all symbols (including partial and
390 minimal symbols) which have been read have been relocated by this
391 much. Symbols which are yet to be read need to be relocated by
394 struct section_offsets
*section_offsets
;
397 /* Indexes in the section_offsets array. These are initialized by the
398 *_symfile_offsets() family of functions (som_symfile_offsets,
399 xcoff_symfile_offsets, default_symfile_offsets). In theory they
400 should correspond to the section indexes used by bfd for the
401 current objfile. The exception to this for the time being is the
407 int sect_index_rodata
;
409 /* These pointers are used to locate the section table, which
410 among other things, is used to map pc addresses into sections.
411 SECTIONS points to the first entry in the table, and
412 SECTIONS_END points to the first location past the last entry
413 in the table. Currently the table is stored on the
414 objfile_obstack (which makes no sense, but I'm not sure it's
415 harming anything). */
418 *sections
, *sections_end
;
420 /* Imported symbols */
421 /* FIXME: ezannoni 2004-02-10: This is just SOM (HP) specific (see
422 somread.c). It should not pollute generic objfiles. */
423 ImportEntry
*import_list
;
424 int import_list_size
;
426 /* Exported symbols */
427 /* FIXME: ezannoni 2004-02-10: This is just SOM (HP) specific (see
428 somread.c). It should not pollute generic objfiles. */
429 ExportEntry
*export_list
;
430 int export_list_size
;
432 /* Link to objfile that contains the debug symbols for this one.
433 One is loaded if this file has an debug link to an existing
434 debug file with the right checksum */
435 struct objfile
*separate_debug_objfile
;
437 /* If this is a separate debug object, this is used as a link to the
438 actual executable objfile. */
439 struct objfile
*separate_debug_objfile_backlink
;
441 /* Place to stash various statistics about this objfile */
444 /* A symtab that the C++ code uses to stash special symbols
445 associated to namespaces. */
447 /* FIXME/carlton-2003-06-27: Delete this in a few years once
448 "possible namespace symbols" go away. */
449 struct symtab
*cp_namespace_symtab
;
452 /* Defines for the objfile flag word. */
454 /* When using mapped/remapped predigested gdb symbol information, we need
455 a flag that indicates that we have previously done an initial symbol
456 table read from this particular objfile. We can't just look for the
457 absence of any of the three symbol tables (msymbols, psymtab, symtab)
458 because if the file has no symbols for example, none of these will
461 #define OBJF_SYMS (1 << 1) /* Have tried to read symbols */
463 /* When an object file has its functions reordered (currently Irix-5.2
464 shared libraries exhibit this behaviour), we will need an expensive
465 algorithm to locate a partial symtab or symtab via an address.
466 To avoid this penalty for normal object files, we use this flag,
467 whose setting is determined upon symbol table read in. */
469 #define OBJF_REORDERED (1 << 2) /* Functions are reordered */
471 /* Distinguish between an objfile for a shared library and a "vanilla"
472 objfile. (If not set, the objfile may still actually be a solib.
473 This can happen if the user created the objfile by using the
474 add-symbol-file command. GDB doesn't in that situation actually
475 check whether the file is a solib. Rather, the target's
476 implementation of the solib interface is responsible for setting
477 this flag when noticing solibs used by an inferior.) */
479 #define OBJF_SHARED (1 << 3) /* From a shared library */
481 /* User requested that this objfile be read in it's entirety. */
483 #define OBJF_READNOW (1 << 4) /* Immediate full read */
485 /* This objfile was created because the user explicitly caused it
486 (e.g., used the add-symbol-file command). This bit offers a way
487 for run_command to remove old objfile entries which are no longer
488 valid (i.e., are associated with an old inferior), but to preserve
489 ones that the user explicitly loaded via the add-symbol-file
492 #define OBJF_USERLOADED (1 << 5) /* User loaded */
494 /* The object file that the main symbol table was loaded from (e.g. the
495 argument to the "symbol-file" or "file" command). */
497 extern struct objfile
*symfile_objfile
;
499 /* The object file that contains the runtime common minimal symbols
500 for SunOS4. Note that this objfile has no associated BFD. */
502 extern struct objfile
*rt_common_objfile
;
504 /* When we need to allocate a new type, we need to know which objfile_obstack
505 to allocate the type on, since there is one for each objfile. The places
506 where types are allocated are deeply buried in function call hierarchies
507 which know nothing about objfiles, so rather than trying to pass a
508 particular objfile down to them, we just do an end run around them and
509 set current_objfile to be whatever objfile we expect to be using at the
510 time types are being allocated. For instance, when we start reading
511 symbols for a particular objfile, we set current_objfile to point to that
512 objfile, and when we are done, we set it back to NULL, to ensure that we
513 never put a type someplace other than where we are expecting to put it.
514 FIXME: Maybe we should review the entire type handling system and
515 see if there is a better way to avoid this problem. */
517 extern struct objfile
*current_objfile
;
519 /* All known objfiles are kept in a linked list. This points to the
520 root of this list. */
522 extern struct objfile
*object_files
;
524 /* Declarations for functions defined in objfiles.c */
526 extern struct objfile
*allocate_objfile (bfd
*, int);
528 extern void init_entry_point_info (struct objfile
*);
530 extern CORE_ADDR
entry_point_address (void);
532 extern int build_objfile_section_table (struct objfile
*);
534 extern void terminate_minimal_symbol_table (struct objfile
*objfile
);
536 extern void put_objfile_before (struct objfile
*, struct objfile
*);
538 extern void objfile_to_front (struct objfile
*);
540 extern void unlink_objfile (struct objfile
*);
542 extern void free_objfile (struct objfile
*);
544 extern struct cleanup
*make_cleanup_free_objfile (struct objfile
*);
546 extern void free_all_objfiles (void);
548 extern void objfile_relocate (struct objfile
*, struct section_offsets
*);
550 extern int have_partial_symbols (void);
552 extern int have_full_symbols (void);
554 /* This operation deletes all objfile entries that represent solibs that
555 weren't explicitly loaded by the user, via e.g., the add-symbol-file
558 extern void objfile_purge_solibs (void);
560 /* Functions for dealing with the minimal symbol table, really a misc
561 address<->symbol mapping for things we don't have debug symbols for. */
563 extern int have_minimal_symbols (void);
565 extern struct obj_section
*find_pc_section (CORE_ADDR pc
);
567 extern struct obj_section
*find_pc_sect_section (CORE_ADDR pc
,
570 extern int in_plt_section (CORE_ADDR
, char *);
572 extern int is_in_import_list (char *, struct objfile
*);
574 /* Keep a registry of per-objfile data-pointers required by other GDB
577 extern const struct objfile_data
*register_objfile_data (void);
578 extern void clear_objfile_data (struct objfile
*objfile
);
579 extern void set_objfile_data (struct objfile
*objfile
,
580 const struct objfile_data
*data
, void *value
);
581 extern void *objfile_data (struct objfile
*objfile
,
582 const struct objfile_data
*data
);
585 /* Traverse all object files. ALL_OBJFILES_SAFE works even if you delete
586 the objfile during the traversal. */
588 #define ALL_OBJFILES(obj) \
589 for ((obj) = object_files; (obj) != NULL; (obj) = (obj)->next)
591 #define ALL_OBJFILES_SAFE(obj,nxt) \
592 for ((obj) = object_files; \
593 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
596 /* Traverse all symtabs in one objfile. */
598 #define ALL_OBJFILE_SYMTABS(objfile, s) \
599 for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next)
601 /* Traverse all psymtabs in one objfile. */
603 #define ALL_OBJFILE_PSYMTABS(objfile, p) \
604 for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next)
606 /* Traverse all minimal symbols in one objfile. */
608 #define ALL_OBJFILE_MSYMBOLS(objfile, m) \
609 for ((m) = (objfile) -> msymbols; DEPRECATED_SYMBOL_NAME(m) != NULL; (m)++)
611 /* Traverse all symtabs in all objfiles. */
613 #define ALL_SYMTABS(objfile, s) \
614 ALL_OBJFILES (objfile) \
615 ALL_OBJFILE_SYMTABS (objfile, s)
617 /* Traverse all psymtabs in all objfiles. */
619 #define ALL_PSYMTABS(objfile, p) \
620 ALL_OBJFILES (objfile) \
621 ALL_OBJFILE_PSYMTABS (objfile, p)
623 /* Traverse all minimal symbols in all objfiles. */
625 #define ALL_MSYMBOLS(objfile, m) \
626 ALL_OBJFILES (objfile) \
627 ALL_OBJFILE_MSYMBOLS (objfile, m)
629 #define ALL_OBJFILE_OSECTIONS(objfile, osect) \
630 for (osect = objfile->sections; osect < objfile->sections_end; osect++)
632 #define ALL_OBJSECTIONS(objfile, osect) \
633 ALL_OBJFILES (objfile) \
634 ALL_OBJFILE_OSECTIONS (objfile, osect)
636 #define SECT_OFF_DATA(objfile) \
637 ((objfile->sect_index_data == -1) \
638 ? (internal_error (__FILE__, __LINE__, "sect_index_data not initialized"), -1) \
639 : objfile->sect_index_data)
641 #define SECT_OFF_RODATA(objfile) \
642 ((objfile->sect_index_rodata == -1) \
643 ? (internal_error (__FILE__, __LINE__, "sect_index_rodata not initialized"), -1) \
644 : objfile->sect_index_rodata)
646 #define SECT_OFF_TEXT(objfile) \
647 ((objfile->sect_index_text == -1) \
648 ? (internal_error (__FILE__, __LINE__, "sect_index_text not initialized"), -1) \
649 : objfile->sect_index_text)
651 /* Sometimes the .bss section is missing from the objfile, so we don't
652 want to die here. Let the users of SECT_OFF_BSS deal with an
653 uninitialized section index. */
654 #define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
656 #endif /* !defined (OBJFILES_H) */