/* Definitions for reading symbol files into GDB.
- Copyright (C) 1990, 1991, 1992 Free Software Foundation, Inc.
-This file is part of GDB.
+ Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
+ 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
+ This file is part of GDB.
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA. */
#if !defined (SYMFILE_H)
#define SYMFILE_H
/* This file requires that you first include "bfd.h". */
-struct psymbol_allocation_list {
- struct partial_symbol *list;
- struct partial_symbol *next;
- int size;
-};
-
-/* Structure to keep track of symbol reading functions for various
- object file types. */
-
-struct sym_fns {
-
- /* is the name, or name prefix, of the BFD "target type" that this
- set of functions handles. E.g. "a.out" or "sunOs" or "coff" or "elf". */
-
- char *sym_name;
-
- /* counts how many bytes of sym_name should be checked against the
- BFD target type of the file being read. If an exact match is
- desired, specify the number of characters in sym_name plus 1 for the
- NUL. If a prefix match is desired, specify the number of characters in
- sym_name. */
-
- int sym_namelen;
-
- /* Initializes anything that is global to the entire symbol table. It is
- called during symbol_file_add, when we begin debugging an entirely new
- program. */
-
- void (*sym_new_init) PARAMS ((struct objfile *));
-
- /* Reads any initial information from a symbol file, and initializes the
- struct sym_fns SF in preparation for sym_read(). It is called every
- time we read a symbol file for any reason. */
-
- void (*sym_init) PARAMS ((struct objfile *));
+/* Opaque declarations. */
+struct section_table;
+struct objfile;
+struct obstack;
+struct block;
+
+/* Partial symbols are stored in the psymbol_cache and pointers to
+ them are kept in a dynamically grown array that is obtained from
+ malloc and grown as necessary via realloc. Each objfile typically
+ has two of these, one for global symbols and one for static
+ symbols. Although this adds a level of indirection for storing or
+ accessing the partial symbols, it allows us to throw away duplicate
+ psymbols and set all pointers to the single saved instance. */
+
+struct psymbol_allocation_list
+{
- /* sym_read (objfile, addr, mainline)
- Reads a symbol file into a psymtab (or possibly a symtab).
- OBJFILE is the objfile struct for the file we are reading. ADDR
- is the offset between the file's specified start address and
- its true address in memory. MAINLINE is 1 if this is the
- main symbol table being read, and 0 if a secondary
- symbol file (e.g. shared library or dynamically loaded file)
- is being read. */
+ /* Pointer to beginning of dynamically allocated array of pointers
+ to partial symbols. The array is dynamically expanded as
+ necessary to accommodate more pointers. */
- void (*sym_read) PARAMS ((struct objfile *, CORE_ADDR, int));
+ struct partial_symbol **list;
- /* Called when we are finished with an objfile. Should do all cleanup
- that is specific to the object file format for the particular objfile. */
-
- void (*sym_finish) PARAMS ((struct objfile *));
+ /* Pointer to next available slot in which to store a pointer to a
+ partial symbol. */
- /* Finds the next struct sym_fns. They are allocated and initialized
- in whatever module implements the functions pointed to; an
- initializer calls add_symtab_fns to add them to the global chain. */
+ struct partial_symbol **next;
- struct sym_fns *next;
+ /* Number of allocated pointer slots in current dynamic array (not
+ the number of bytes of storage). The "next" pointer will always
+ point somewhere between list[0] and list[size], and when at
+ list[size] the array will be expanded on the next attempt to
+ store a pointer. */
+ int size;
};
-/* Master structure for keeping track of each input file from which
- gdb reads symbols. One of these is allocated for each such file we
- access, e.g. the exec_file, symbol_file, and any shared library object
- files. */
+/* Define an array of addresses to accommodate non-contiguous dynamic
+ loading of modules. This is for use when entering commands, so we
+ can keep track of the section names until we read the file and can
+ map them to bfd sections. This structure is also used by solib.c
+ to communicate the section addresses in shared objects to
+ symbol_file_add (). */
-struct objfile
+struct section_addr_info
{
+ /* The number of sections for which address information is
+ available. */
+ size_t num_sections;
+ /* Sections whose names are file format dependent. */
+ struct other_sections
+ {
+ CORE_ADDR addr;
+ char *name;
+ int sectindex;
+ } other[1];
+};
- /* All struct objfile's are chained together by their next pointers.
- The global variable "object_files" points to the first link in this
- chain. */
+/* Structure to keep track of symbol reading functions for various
+ object file types. */
- struct objfile *next;
+struct sym_fns
+{
- /* The object file's name. Malloc'd; free it if you free this struct. */
+ /* BFD flavour that we handle, or (as a special kludge, see
+ xcoffread.c, (enum bfd_flavour)-1 for xcoff). */
- char *name;
+ enum bfd_flavour sym_flavour;
- /* Some flag bits for this objfile. */
+ /* Initializes anything that is global to the entire symbol table.
+ It is called during symbol_file_add, when we begin debugging an
+ entirely new program. */
- unsigned short flags;
+ void (*sym_new_init) (struct objfile *);
- /* Each objfile points to a linked list of symtabs derived from this file,
- one symtab structure for each compilation unit (source file). Each link
- in the symtab list contains a backpointer to this objfile. */
+ /* Reads any initial information from a symbol file, and initializes
+ the struct sym_fns SF in preparation for sym_read(). It is
+ called every time we read a symbol file for any reason. */
- struct symtab *symtabs;
+ void (*sym_init) (struct objfile *);
- /* Each objfile points to a linked list of partial symtabs derived from
- this file, one partial symtab structure for each compilation unit
- (source file). */
+ /* sym_read (objfile, mainline) Reads a symbol file into a psymtab
+ (or possibly a symtab). OBJFILE is the objfile struct for the
+ file we are reading. MAINLINE is 1 if this is the main symbol
+ table being read, and 0 if a secondary symbol file (e.g. shared
+ library or dynamically loaded file) is being read. */
- struct partial_symtab *psymtabs;
+ void (*sym_read) (struct objfile *, int);
- /* List of freed partial symtabs, available for re-use */
+ /* Called when we are finished with an objfile. Should do all
+ cleanup that is specific to the object file format for the
+ particular objfile. */
- struct partial_symtab *free_psymtabs;
+ void (*sym_finish) (struct objfile *);
- /* The object file's BFD. Can be null, in which case bfd_open (name) and
- put the result here. */
+ /* This function produces a file-dependent section_offsets
+ structure, allocated in the objfile's storage, and based on the
+ parameter. The parameter is currently a CORE_ADDR (FIXME!) for
+ backward compatibility with the higher levels of GDB. It should
+ probably be changed to a string, where NULL means the default,
+ and others are parsed in a file dependent way. */
- bfd *obfd;
+ void (*sym_offsets) (struct objfile *, struct section_addr_info *);
- /* The modification timestamp of the object file, as of the last time
- we read its symbols. */
+ /* Finds the next struct sym_fns. They are allocated and
+ initialized in whatever module implements the functions pointed
+ to; an initializer calls add_symtab_fns to add them to the global
+ chain. */
- long mtime;
+ struct sym_fns *next;
- /* Obstacks to hold objects that should be freed when we load a new symbol
- table from this object file. */
+};
- struct obstack psymbol_obstack; /* Partial symbols */
- struct obstack symbol_obstack; /* Full symbols */
- struct obstack type_obstack; /* Types */
+/* The default version of sym_fns.sym_offsets for readers that don't
+ do anything special. */
- /* Vectors of all partial symbols read in from file. The actual data
- is stored in the psymbol_obstack. */
+extern void default_symfile_offsets (struct objfile *objfile,
+ struct section_addr_info *);
- struct psymbol_allocation_list global_psymbols;
- struct psymbol_allocation_list static_psymbols;
- /* Each file contains a pointer to an array of minimal symbols for all
- global symbols that are defined within the file. The array is terminated
- by a "null symbol", one that has a NULL pointer for the name and a zero
- value for the address. This makes it easy to walk through the array
- when passed a pointer to somewhere in the middle of it. There is also
- a count of the number of symbols, which does include the terminating
- null symbol. The array itself, as well as all the data that it points
- to, should be allocated on the symbol_obstack for this file. */
+extern void extend_psymbol_list (struct psymbol_allocation_list *,
+ struct objfile *);
- struct minimal_symbol *msymbols;
- int minimal_symbol_count;
+/* Add any kind of symbol to a psymbol_allocation_list. */
- /* For object file formats which don't specify fundamental types, gdb
- can create such types. For now, it maintains a vector of pointers
- to these internally created fundamental types on a per objfile basis,
- however it really should ultimately keep them on a per-compilation-unit
- basis, to account for linkage-units that consist of a number of
- compilation units that may have different fundamental types, such as
- linking C modules with ADA modules, or linking C modules that are
- compiled with 32-bit ints with C modules that are compiled with 64-bit
- ints (not inherently evil with a smarter linker). */
+/* #include "demangle.h" */
- struct type **fundamental_types;
+extern const
+struct partial_symbol *add_psymbol_to_list (char *, int, domain_enum,
+ enum address_class,
+ struct psymbol_allocation_list *,
+ long, CORE_ADDR,
+ enum language, struct objfile *);
- /* The mmalloc() malloc-descriptor for this objfile if we are using
- the memory mapped malloc() package to manage storage for this objfile's
- data. NULL if we are not. */
+extern void add_psymbol_with_dem_name_to_list (char *, int, char *, int,
+ domain_enum,
+ enum address_class,
+ struct psymbol_allocation_list
+ *, long, CORE_ADDR,
+ enum language,
+ struct objfile *);
- PTR md;
- /* Structure which keeps track of functions that manipulate objfile's
- of the same type as this objfile. I.E. the function to read partial
- symbols for example. Note that this structure is in statically
- allocated memory, and is shared by all objfiles that use the
- object module reader of this type. */
+extern void init_psymbol_list (struct objfile *, int);
- struct sym_fns *sf;
+extern void sort_pst_symbols (struct partial_symtab *);
- /* Hook for information which is shared by sym_init and sym_read for
- this objfile. It is typically a pointer to malloc'd memory. */
+extern struct symtab *allocate_symtab (char *, struct objfile *);
- PTR sym_private;
+extern int free_named_symtabs (char *);
-};
+extern void fill_in_vptr_fieldno (struct type *);
-/* Defines for the objfile flag word. */
+extern void add_symtab_fns (struct sym_fns *);
-/* Gdb can arrange to allocate storage for all objects related to a
- particular objfile in a designated section of it's address space,
- managed at a low level by mmap() and using a special version of
- malloc that handles malloc/free/realloc on top of the mmap() interface.
- This allows the "internal gdb state" for a particular objfile to be
- dumped to a gdb state file and subsequently reloaded at a later time. */
+extern void syms_from_objfile (struct objfile *,
+ struct section_addr_info *,
+ struct section_offsets *, int, int, int);
-#define OBJF_MAPPED (1 << 0) /* Objfile data is mmap'd */
+extern void new_symfile_objfile (struct objfile *, int, int);
+extern struct objfile *symbol_file_add (char *, int,
+ struct section_addr_info *, int, int);
-extern void
-extend_psymbol_list PARAMS ((struct psymbol_allocation_list *,
- struct objfile *));
+extern struct objfile *symbol_file_add_from_bfd (bfd *, int,
+ struct section_addr_info *,
+ int, int);
-/* Add any kind of symbol to a psymbol_allocation_list. */
+/* Create a new section_addr_info, with room for NUM_SECTIONS. */
-#define ADD_PSYMBOL_VT_TO_LIST(NAME,NAMELENGTH,NAMESPACE,CLASS,LIST,VALUE,VT) \
- do { \
- register struct partial_symbol *psym; \
- if ((LIST).next >= (LIST).list + (LIST).size) \
- extend_psymbol_list (&(LIST),objfile); \
- psym = (LIST).next++; \
- \
- SYMBOL_NAME (psym) = (char *) obstack_alloc (&objfile->psymbol_obstack, \
- (NAMELENGTH) + 1); \
- memcpy (SYMBOL_NAME (psym), (NAME), (NAMELENGTH)); \
- SYMBOL_NAME (psym)[(NAMELENGTH)] = '\0'; \
- SYMBOL_NAMESPACE (psym) = (NAMESPACE); \
- SYMBOL_CLASS (psym) = (CLASS); \
- VT (psym) = (VALUE); \
- } while (0);
+extern struct section_addr_info *alloc_section_addr_info (size_t
+ num_sections);
-#ifdef DEBUG
+/* Return a freshly allocated copy of ADDRS. The section names, if
+ any, are also freshly allocated copies of those in ADDRS. */
+extern struct section_addr_info *(copy_section_addr_info
+ (struct section_addr_info *addrs));
-/* Since one arg is a struct, we have to pass in a ptr and deref it (sigh) */
+/* Build (allocate and populate) a section_addr_info struct from an
+ existing section table. */
-#define ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value) \
- add_psymbol_to_list (name, namelength, namespace, class, &list, value)
+extern struct section_addr_info
+ *build_section_addr_info_from_section_table (const struct section_table
+ *start,
+ const struct section_table
+ *end);
-#define ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value) \
- add_psymbol_addr_to_list (name, namelength, namespace, class, &list, value)
+/* Free all memory allocated by
+ build_section_addr_info_from_section_table. */
-#else /* !DEBUG */
+extern void free_section_addr_info (struct section_addr_info *);
-/* Add a symbol with an integer value to a psymtab. */
-#define ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value) \
- ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE)
+extern struct partial_symtab *start_psymtab_common (struct objfile *,
+ struct section_offsets *,
+ char *, CORE_ADDR,
+ struct partial_symbol **,
+ struct partial_symbol **);
-/* Add a symbol with a CORE_ADDR value to a psymtab. */
+/* Make a copy of the string at PTR with SIZE characters in the symbol
+ obstack (and add a null character at the end in the copy). Returns
+ the address of the copy. */
-#define ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value)\
- ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE_ADDRESS)
+extern char *obsavestring (const char *, int, struct obstack *);
-#endif /* DEBUG */
+/* Concatenate strings S1, S2 and S3; return the new string. Space is
+ found in the OBSTACKP */
- /* Functions */
+extern char *obconcat (struct obstack *obstackp, const char *, const char *,
+ const char *);
-extern void
-sort_pst_symbols PARAMS ((struct partial_symtab *));
+ /* Variables */
-extern struct symtab *
-allocate_symtab PARAMS ((char *, struct objfile *));
+/* If non-zero, shared library symbols will be added automatically
+ when the inferior is created, new libraries are loaded, or when
+ attaching to the inferior. This is almost always what users will
+ want to have happen; but for very large programs, the startup time
+ will be excessive, and so if this is a problem, the user can clear
+ this flag and then add the shared library symbols as needed. Note
+ that there is a potential for confusion, since if the shared
+ library symbols are not loaded, commands like "info fun" will *not*
+ report all the functions that are actually present. */
-extern struct objfile *
-allocate_objfile PARAMS ((bfd *, int));
+extern int auto_solib_add;
-extern void
-free_objfile PARAMS ((struct objfile *));
+/* For systems that support it, a threshold size in megabytes. If
+ automatically adding a new library's symbol table to those already
+ known to the debugger would cause the total shared library symbol
+ size to exceed this threshhold, then the shlib's symbols are not
+ added. The threshold is ignored if the user explicitly asks for a
+ shlib to be added, such as when using the "sharedlibrary" command. */
-extern void
-free_all_objfiles PARAMS ((void));
+extern int auto_solib_limit;
-extern int
-free_named_symtabs PARAMS ((char *));
+/* From symfile.c */
-extern void
-fill_in_vptr_fieldno PARAMS ((struct type *));
+extern struct partial_symtab *allocate_psymtab (char *, struct objfile *);
-extern void
-add_symtab_fns PARAMS ((struct sym_fns *));
+extern void discard_psymtab (struct partial_symtab *);
-extern void
-syms_from_objfile PARAMS ((struct objfile *, CORE_ADDR, int, int));
+extern void find_lowest_section (bfd *, asection *, void *);
-extern struct partial_symtab *
-start_psymtab_common PARAMS ((struct objfile *, CORE_ADDR, char *, CORE_ADDR,
- struct partial_symbol *,
- struct partial_symbol *));
+extern bfd *symfile_bfd_open (char *);
-/* Sorting your symbols for fast lookup or alphabetical printing. */
+extern int get_section_index (struct objfile *, char *);
-extern void
-sort_block_syms PARAMS ((struct block *));
+/* Utility functions for overlay sections: */
+extern enum overlay_debugging_state
+{
+ ovly_off,
+ ovly_on,
+ ovly_auto
+} overlay_debugging;
+extern int overlay_cache_invalid;
-extern void
-sort_symtab_syms PARAMS ((struct symtab *));
+/* Return the "mapped" overlay section containing the PC. */
+extern asection *find_pc_mapped_section (CORE_ADDR);
-extern void
-sort_all_symtab_syms PARAMS ((void));
+/* Return any overlay section containing the PC (even in its LMA
+ region). */
+extern asection *find_pc_overlay (CORE_ADDR);
-/* Make a copy of the string at PTR with SIZE characters in the symbol obstack
- (and add a null character at the end in the copy).
- Returns the address of the copy. */
+/* Return true if the section is an overlay. */
+extern int section_is_overlay (asection *);
-extern char *
-obsavestring PARAMS ((char *, int, struct obstack *));
+/* Return true if the overlay section is currently "mapped". */
+extern int section_is_mapped (asection *);
-/* Concatenate strings S1, S2 and S3; return the new string.
- Space is found in the symbol_obstack. */
+/* Return true if pc belongs to section's VMA. */
+extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *);
-extern char *
-obconcat PARAMS ((struct obstack *obstackp, const char *, const char *,
- const char *));
+/* Return true if pc belongs to section's LMA. */
+extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *);
- /* Variables */
+/* Map an address from a section's LMA to its VMA. */
+extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *);
-/* The object file that the main symbol table was loaded from (e.g. the
- argument to the "symbol-file" or "file" command). */
+/* Map an address from a section's VMA to its LMA. */
+extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *);
-extern struct objfile *symfile_objfile;
+/* Convert an address in an overlay section (force into VMA range). */
+extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *);
-/* Where execution starts in symfile */
+/* Load symbols from a file. */
+extern void symbol_file_add_main (char *args, int from_tty);
-extern CORE_ADDR entry_point;
+/* Clear GDB symbol tables. */
+extern void symbol_file_clear (int from_tty);
-/* Root of object file struct chain. */
+extern bfd_byte *symfile_relocate_debug_section (bfd *abfd, asection *sectp,
+ bfd_byte * buf);
-extern struct objfile *object_files;
+/* From dwarfread.c */
-/* Traverse all object files. ALL_OBJFILES_SAFE works even if you delete
- the objfile during the traversal. */
+extern void dwarf_build_psymtabs (struct objfile *, int, file_ptr,
+ unsigned int, file_ptr, unsigned int);
-#define ALL_OBJFILES(obj) \
- for (obj = object_files; 0 != obj; obj = obj->next)
+/* From dwarf2read.c */
-#define ALL_OBJFILES_SAFE(obj,nxt) \
- for (obj = object_files; obj? (nxt=obj->next, 1): 0; obj = nxt)
+extern int dwarf2_has_info (struct objfile *);
-/* Support for complaining about things in the symbol file that aren't
- catastrophic.
+extern void dwarf2_build_psymtabs (struct objfile *, int);
+extern void dwarf2_build_frame_info (struct objfile *);
- Each such thing gets a counter. The first time we have the problem,
- during a symbol read, we report it. At the end of symbol reading,
- if verbose, we report how many of each problem we had. */
+/* From mdebugread.c */
-struct complaint {
- char *message;
- unsigned counter;
- struct complaint *next;
+/* Hack to force structures to exist before use in parameter list. */
+struct ecoff_debug_hack
+{
+ struct ecoff_debug_swap *a;
+ struct ecoff_debug_info *b;
};
-/* Root of the chain of complaints that have at some point been issued.
- This is used to reset the counters, and/or report the total counts. */
-
-extern struct complaint complaint_root[1];
-
-/* Functions that handle complaints. (in symfile.c) */
-
-extern void
-complain PARAMS ((struct complaint *, char *));
-
-extern void
-clear_complaints PARAMS ((int sym_reading, int noisy));
-
-/* From symfile.c */
-
-extern struct partial_symtab *
-allocate_psymtab PARAMS ((char *, struct objfile *));
-
-/* From minsyms.c */
-
-extern PTR
-iterate_over_msymbols PARAMS ((PTR (*func) (struct objfile *,
- struct minimal_symbol *,
- PTR arg1, PTR arg2, PTR arg3),
- PTR arg1, PTR arg2, PTR arg3));
-
-/* From objfiles.c */
-
-extern PTR
-iterate_over_objfiles PARAMS ((PTR (*func) (struct objfile *,
- PTR arg1, PTR arg2, PTR arg3),
- PTR arg1, PTR arg2, PTR arg3));
-
-extern PTR
-iterate_over_symtabs PARAMS ((PTR (*func) (struct objfile *, struct symtab *,
- PTR arg1, PTR arg2, PTR arg3),
- PTR arg1, PTR arg2, PTR arg3));
-
-extern PTR
-iterate_over_psymtabs PARAMS ((PTR (*func) (struct objfile *,
- struct partial_symtab *,
- PTR arg1, PTR arg2, PTR arg3),
- PTR arg1, PTR arg2, PTR arg3));
-
-/* From dwarfread.c */
+extern void mdebug_build_psymtabs (struct objfile *,
+ const struct ecoff_debug_swap *,
+ struct ecoff_debug_info *);
-extern void
-dwarf_build_psymtabs PARAMS ((int, char *, CORE_ADDR, int, unsigned int,
- unsigned int, unsigned int, unsigned int,
- struct objfile *));
+extern void elfmdebug_build_psymtabs (struct objfile *,
+ const struct ecoff_debug_swap *,
+ asection *);
-#endif /* !defined(SYMFILE_H) */
+#endif /* !defined(SYMFILE_H) */
projects / deliverable / binutils-gdb.git / blobdiff