2003-06-07 Andrew Cagney <cagney@redhat.com>

* symfile.h: Re-indent, clean up comments.
This commit is contained in:
Andrew Cagney 2003-06-07 23:50:23 +00:00
parent b46e02f67c
commit 3a6c33433d
2 changed files with 133 additions and 126 deletions

View File

@ -1,3 +1,7 @@
2003-06-07 Andrew Cagney <cagney@redhat.com>
* symfile.h: Re-indent, clean up comments.
2003-06-07 Andrew Cagney <cagney@redhat.com> 2003-06-07 Andrew Cagney <cagney@redhat.com>
* inferior.h (deprecated_write_sp): Replace * inferior.h (deprecated_write_sp): Replace

View File

@ -1,7 +1,7 @@
/* Definitions for reading symbol files into GDB. /* Definitions for reading symbol files into GDB.
Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
Free Software Foundation, Inc. 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
This file is part of GDB. This file is part of GDB.
@ -26,48 +26,50 @@
/* This file requires that you first include "bfd.h". */ /* This file requires that you first include "bfd.h". */
/* Opaque declarations. */ /* Opaque declarations. */
struct section_table;
struct objfile; struct objfile;
struct obstack; struct obstack;
struct block; struct block;
/* Partial symbols are stored in the psymbol_cache and pointers to them /* Partial symbols are stored in the psymbol_cache and pointers to
are kept in a dynamically grown array that is obtained from malloc and them are kept in a dynamically grown array that is obtained from
grown as necessary via realloc. Each objfile typically has two of these, malloc and grown as necessary via realloc. Each objfile typically
one for global symbols and one for static symbols. Although this adds has two of these, one for global symbols and one for static
a level of indirection for storing or accessing the partial symbols, symbols. Although this adds a level of indirection for storing or
it allows us to throw away duplicate psymbols and set all pointers accessing the partial symbols, it allows us to throw away duplicate
to the single saved instance. */ psymbols and set all pointers to the single saved instance. */
struct psymbol_allocation_list struct psymbol_allocation_list
{ {
/* Pointer to beginning of dynamically allocated array of pointers to /* Pointer to beginning of dynamically allocated array of pointers
partial symbols. The array is dynamically expanded as necessary to to partial symbols. The array is dynamically expanded as
accommodate more pointers. */ necessary to accommodate more pointers. */
struct partial_symbol **list; struct partial_symbol **list;
/* Pointer to next available slot in which to store a pointer to a partial /* Pointer to next available slot in which to store a pointer to a
symbol. */ partial symbol. */
struct partial_symbol **next; struct partial_symbol **next;
/* Number of allocated pointer slots in current dynamic array (not the /* Number of allocated pointer slots in current dynamic array (not
number of bytes of storage). The "next" pointer will always point the number of bytes of storage). The "next" pointer will always
somewhere between list[0] and list[size], and when at list[size] the point somewhere between list[0] and list[size], and when at
array will be expanded on the next attempt to store a pointer. */ list[size] the array will be expanded on the next attempt to
store a pointer. */
int size; int size;
}; };
/* Define an array of addresses to accommodate non-contiguous dynamic /* Define an array of addresses to accommodate non-contiguous dynamic
loading of modules. This is for use when entering commands, so we 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 keep track of the section names until we read the file and can
can map them to bfd sections. This structure is also used by map them to bfd sections. This structure is also used by solib.c
solib.c to communicate the section addresses in shared objects to to communicate the section addresses in shared objects to
symbol_file_add (). */ symbol_file_add (). */
struct section_addr_info struct section_addr_info
{ {
/* The number of sections for which address information is /* The number of sections for which address information is
available. */ available. */
@ -85,56 +87,56 @@ struct section_addr_info
object file types. */ object file types. */
struct sym_fns struct sym_fns
{ {
/* BFD flavour that we handle, or (as a special kludge, see xcoffread.c, /* BFD flavour that we handle, or (as a special kludge, see
(enum bfd_flavour)-1 for xcoff). */ xcoffread.c, (enum bfd_flavour)-1 for xcoff). */
enum bfd_flavour sym_flavour; enum bfd_flavour sym_flavour;
/* Initializes anything that is global to the entire symbol table. It is /* Initializes anything that is global to the entire symbol table.
called during symbol_file_add, when we begin debugging an entirely new It is called during symbol_file_add, when we begin debugging an
program. */ entirely new program. */
void (*sym_new_init) (struct objfile *); void (*sym_new_init) (struct objfile *);
/* Reads any initial information from a symbol file, and initializes the /* Reads any initial information from a symbol file, and initializes
struct sym_fns SF in preparation for sym_read(). It is called every the struct sym_fns SF in preparation for sym_read(). It is
time we read a symbol file for any reason. */ called every time we read a symbol file for any reason. */
void (*sym_init) (struct objfile *); void (*sym_init) (struct objfile *);
/* sym_read (objfile, mainline) /* sym_read (objfile, mainline) Reads a symbol file into a psymtab
Reads a symbol file into a psymtab (or possibly a symtab). (or possibly a symtab). OBJFILE is the objfile struct for the
OBJFILE is the objfile struct for the file we are reading. file we are reading. MAINLINE is 1 if this is the main symbol
MAINLINE is 1 if this is the table being read, and 0 if a secondary symbol file (e.g. shared
main symbol table being read, and 0 if a secondary library or dynamically loaded file) is being read. */
symbol file (e.g. shared library or dynamically loaded file)
is being read. */
void (*sym_read) (struct objfile *, int); void (*sym_read) (struct objfile *, int);
/* Called when we are finished with an objfile. Should do all cleanup /* Called when we are finished with an objfile. Should do all
that is specific to the object file format for the particular objfile. */ cleanup that is specific to the object file format for the
particular objfile. */
void (*sym_finish) (struct objfile *); void (*sym_finish) (struct objfile *);
/* This function produces a file-dependent section_offsets structure, /* This function produces a file-dependent section_offsets
allocated in the objfile's storage, and based on the parameter. structure, allocated in the objfile's storage, and based on the
The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility parameter. The parameter is currently a CORE_ADDR (FIXME!) for
with the higher levels of GDB. It should probably be changed to backward compatibility with the higher levels of GDB. It should
a string, where NULL means the default, and others are parsed in a file probably be changed to a string, where NULL means the default,
dependent way. */ and others are parsed in a file dependent way. */
void (*sym_offsets) (struct objfile *, struct section_addr_info *); void (*sym_offsets) (struct objfile *, struct section_addr_info *);
/* Finds the next struct sym_fns. They are allocated and initialized /* Finds the next struct sym_fns. They are allocated and
in whatever module implements the functions pointed to; an initialized in whatever module implements the functions pointed
initializer calls add_symtab_fns to add them to the global chain. */ to; an initializer calls add_symtab_fns to add them to the global
chain. */
struct sym_fns *next; struct sym_fns *next;
}; };
/* The default version of sym_fns.sym_offsets for readers that don't /* The default version of sym_fns.sym_offsets for readers that don't
do anything special. */ do anything special. */
@ -146,21 +148,21 @@ extern void default_symfile_offsets (struct objfile *objfile,
extern void extend_psymbol_list (struct psymbol_allocation_list *, extern void extend_psymbol_list (struct psymbol_allocation_list *,
struct objfile *); struct objfile *);
/* Add any kind of symbol to a psymbol_allocation_list. */ /* Add any kind of symbol to a psymbol_allocation_list. */
/* #include "demangle.h" */ /* #include "demangle.h" */
extern void extern void add_psymbol_to_list (char *, int, domain_enum, enum address_class,
add_psymbol_to_list (char *, int, domain_enum, enum address_class, struct psymbol_allocation_list *, long,
struct psymbol_allocation_list *, long, CORE_ADDR, CORE_ADDR, enum language, struct objfile *);
enum language, struct objfile *);
extern void extern void add_psymbol_with_dem_name_to_list (char *, int, char *, int,
add_psymbol_with_dem_name_to_list (char *, int, char *, int, domain_enum, domain_enum,
enum address_class, enum address_class,
struct psymbol_allocation_list *, struct psymbol_allocation_list
long, CORE_ADDR, *, long, CORE_ADDR,
enum language, struct objfile *); enum language,
struct objfile *);
extern void init_psymbol_list (struct objfile *, int); extern void init_psymbol_list (struct objfile *, int);
@ -178,9 +180,8 @@ extern void add_symtab_fns (struct sym_fns *);
extern void init_entry_point_info (struct objfile *); extern void init_entry_point_info (struct objfile *);
extern void syms_from_objfile (struct objfile *, extern void syms_from_objfile (struct objfile *,
struct section_addr_info *, struct section_addr_info *,
struct section_offsets *, int, struct section_offsets *, int, int, int);
int, int);
extern void new_symfile_objfile (struct objfile *, int, int); extern void new_symfile_objfile (struct objfile *, int, int);
@ -189,18 +190,20 @@ extern struct objfile *symbol_file_add (char *, int,
/* Create a new section_addr_info, with room for NUM_SECTIONS. */ /* Create a new section_addr_info, with room for NUM_SECTIONS. */
extern struct section_addr_info * extern struct section_addr_info *alloc_section_addr_info (size_t
alloc_section_addr_info (size_t num_sections); num_sections);
/* Build (allocate and populate) a section_addr_info struct from /* Build (allocate and populate) a section_addr_info struct from an
an existing section table. */ existing section table. */
struct section_table; extern struct section_addr_info
extern struct section_addr_info * *build_section_addr_info_from_section_table (const struct section_table
build_section_addr_info_from_section_table (const struct section_table *start, *start,
const struct section_table *end); const struct section_table
*end);
/* Free all memory allocated by build_section_addr_info_from_section_table. */ /* Free all memory allocated by
build_section_addr_info_from_section_table. */
extern void free_section_addr_info (struct section_addr_info *); extern void free_section_addr_info (struct section_addr_info *);
@ -217,14 +220,14 @@ extern void sort_block_syms (struct block *);
extern void sort_symtab_syms (struct symtab *); extern void sort_symtab_syms (struct symtab *);
/* Make a copy of the string at PTR with SIZE characters in the symbol obstack /* Make a copy of the string at PTR with SIZE characters in the symbol
(and add a null character at the end in the copy). obstack (and add a null character at the end in the copy). Returns
Returns the address of the copy. */ the address of the copy. */
extern char *obsavestring (const char *, int, struct obstack *); extern char *obsavestring (const char *, int, struct obstack *);
/* Concatenate strings S1, S2 and S3; return the new string. /* Concatenate strings S1, S2 and S3; return the new string. Space is
Space is found in the symbol_obstack. */ found in the symbol_obstack. */
extern char *obconcat (struct obstack *obstackp, const char *, const char *, extern char *obconcat (struct obstack *obstackp, const char *, const char *,
const char *); const char *);
@ -239,7 +242,7 @@ extern char *obconcat (struct obstack *obstackp, const char *, const char *,
this flag and then add the shared library symbols as needed. Note this flag and then add the shared library symbols as needed. Note
that there is a potential for confusion, since if the shared that there is a potential for confusion, since if the shared
library symbols are not loaded, commands like "info fun" will *not* library symbols are not loaded, commands like "info fun" will *not*
report all the functions that are actually present. */ report all the functions that are actually present. */
extern int auto_solib_add; extern int auto_solib_add;
@ -248,8 +251,7 @@ extern int auto_solib_add;
known to the debugger would cause the total shared library symbol known to the debugger would cause the total shared library symbol
size to exceed this threshhold, then the shlib's symbols are not size to exceed this threshhold, then the shlib's symbols are not
added. The threshold is ignored if the user explicitly asks for a added. The threshold is ignored if the user explicitly asks for a
shlib to be added, such as when using the "sharedlibrary" shlib to be added, such as when using the "sharedlibrary" command. */
command. */
extern int auto_solib_limit; extern int auto_solib_limit;
@ -268,58 +270,59 @@ extern bfd *symfile_bfd_open (char *);
extern int get_section_index (struct objfile *, char *); extern int get_section_index (struct objfile *, char *);
/* Utility functions for overlay sections: */ /* Utility functions for overlay sections: */
extern enum overlay_debugging_state { extern enum overlay_debugging_state
ovly_off, {
ovly_on, ovly_off,
ovly_on,
ovly_auto ovly_auto
} overlay_debugging; } overlay_debugging;
extern int overlay_cache_invalid; extern int overlay_cache_invalid;
/* return the "mapped" overlay section containing the PC */ /* Return the "mapped" overlay section containing the PC. */
extern asection *find_pc_mapped_section (CORE_ADDR); extern asection *find_pc_mapped_section (CORE_ADDR);
/* return any overlay section containing the PC (even in its LMA region) */ /* Return any overlay section containing the PC (even in its LMA
region). */
extern asection *find_pc_overlay (CORE_ADDR); extern asection *find_pc_overlay (CORE_ADDR);
/* return true if the section is an overlay */ /* Return true if the section is an overlay. */
extern int section_is_overlay (asection *); extern int section_is_overlay (asection *);
/* return true if the overlay section is currently "mapped" */ /* Return true if the overlay section is currently "mapped". */
extern int section_is_mapped (asection *); extern int section_is_mapped (asection *);
/* return true if pc belongs to section's VMA */ /* Return true if pc belongs to section's VMA. */
extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *); extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *);
/* return true if pc belongs to section's LMA */ /* Return true if pc belongs to section's LMA. */
extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *); extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *);
/* map an address from a section's LMA to its VMA */ /* Map an address from a section's LMA to its VMA. */
extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *); extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *);
/* map an address from a section's VMA to its LMA */ /* Map an address from a section's VMA to its LMA. */
extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *); extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *);
/* convert an address in an overlay section (force into VMA range) */ /* Convert an address in an overlay section (force into VMA range). */
extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *); extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *);
/* Load symbols from a file. */ /* Load symbols from a file. */
extern void symbol_file_add_main (char *args, int from_tty); extern void symbol_file_add_main (char *args, int from_tty);
/* Clear GDB symbol tables. */ /* Clear GDB symbol tables. */
extern void symbol_file_clear (int from_tty); extern void symbol_file_clear (int from_tty);
extern bfd_byte *symfile_relocate_debug_section (bfd *abfd, asection *sectp, extern bfd_byte *symfile_relocate_debug_section (bfd *abfd, asection *sectp,
bfd_byte *buf); bfd_byte * buf);
/* From dwarfread.c */ /* From dwarfread.c */
extern void extern void dwarf_build_psymtabs (struct objfile *, int, file_ptr,
dwarf_build_psymtabs (struct objfile *, int, file_ptr, unsigned int, unsigned int, file_ptr, unsigned int);
file_ptr, unsigned int);
/* From dwarf2read.c */ /* From dwarf2read.c */
extern int dwarf2_has_info (bfd * abfd); extern int dwarf2_has_info (bfd *abfd);
extern void dwarf2_build_psymtabs (struct objfile *, int); extern void dwarf2_build_psymtabs (struct objfile *, int);
extern void dwarf2_build_frame_info (struct objfile *); extern void dwarf2_build_frame_info (struct objfile *);
@ -328,17 +331,17 @@ extern void dwarf2_build_frame_info (struct objfile *);
/* Hack to force structures to exist before use in parameter list. */ /* Hack to force structures to exist before use in parameter list. */
struct ecoff_debug_hack struct ecoff_debug_hack
{ {
struct ecoff_debug_swap *a; struct ecoff_debug_swap *a;
struct ecoff_debug_info *b; struct ecoff_debug_info *b;
}; };
extern void
mdebug_build_psymtabs (struct objfile *,
const struct ecoff_debug_swap *,
struct ecoff_debug_info *);
extern void extern void mdebug_build_psymtabs (struct objfile *,
elfmdebug_build_psymtabs (struct objfile *, const struct ecoff_debug_swap *,
const struct ecoff_debug_swap *, asection *); struct ecoff_debug_info *);
extern void elfmdebug_build_psymtabs (struct objfile *,
const struct ecoff_debug_swap *,
asection *);
#endif /* !defined(SYMFILE_H) */ #endif /* !defined(SYMFILE_H) */