gdb/symfile.h

   1 /* Definitions for reading symbol files into GDB.
   2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   3    2000, 2001
   4    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 (SYMFILE_H)
  24 #define SYMFILE_H
  25
  26 /* This file requires that you first include "bfd.h".  */
  27
  28 /* Partial symbols are stored in the psymbol_cache and pointers to them
  29    are kept in a dynamically grown array that is obtained from malloc and
  30    grown as necessary via realloc.  Each objfile typically has two of these,
  31    one for global symbols and one for static symbols.  Although this adds
  32    a level of indirection for storing or accessing the partial symbols,
  33    it allows us to throw away duplicate psymbols and set all pointers
  34    to the single saved instance. */
  35
  36 struct psymbol_allocation_list
  37   {
  38
  39     /* Pointer to beginning of dynamically allocated array of pointers to
  40        partial symbols.  The array is dynamically expanded as necessary to
  41        accommodate more pointers. */
  42
  43     struct partial_symbol **list;
  44
  45     /* Pointer to next available slot in which to store a pointer to a partial
  46        symbol. */
  47
  48     struct partial_symbol **next;
  49
  50     /* Number of allocated pointer slots in current dynamic array (not the
  51        number of bytes of storage).  The "next" pointer will always point
  52        somewhere between list[0] and list[size], and when at list[size] the
  53        array will be expanded on the next attempt to store a pointer. */
  54
  55     int size;
  56   };
  57
  58 /* Define an array of addresses to accommodate non-contiguous dynamic
  59    loading of modules.  This is for use when entering commands, so we
  60    can keep track of the section names until we read the file and
  61    can map them to bfd sections.  This structure is also used by
  62    solib.c to communicate the section addresses in shared objects to
  63    symbol_file_add (). */
  64
  65 #define MAX_SECTIONS 64
  66 struct section_addr_info
  67 {
  68   /* Sections whose names are file format dependent. */
  69   struct other_sections
  70   {
  71     CORE_ADDR addr;
  72     char *name;
  73     int sectindex;
  74   } other[MAX_SECTIONS];
  75 };
  76
  77 /* Structure to keep track of symbol reading functions for various
  78    object file types.  */
  79
  80 struct sym_fns
  81   {
  82
  83     /* BFD flavour that we handle, or (as a special kludge, see xcoffread.c,
  84        (enum bfd_flavour)-1 for xcoff).  */
  85
  86     enum bfd_flavour sym_flavour;
  87
  88     /* Initializes anything that is global to the entire symbol table.  It is
  89        called during symbol_file_add, when we begin debugging an entirely new
  90        program. */
  91
  92     void (*sym_new_init) (struct objfile *);
  93
  94     /* Reads any initial information from a symbol file, and initializes the
  95        struct sym_fns SF in preparation for sym_read().  It is called every
  96        time we read a symbol file for any reason. */
  97
  98     void (*sym_init) (struct objfile *);
  99
 100     /* sym_read (objfile, mainline)
 101        Reads a symbol file into a psymtab (or possibly a symtab).
 102        OBJFILE is the objfile struct for the file we are reading.
 103        MAINLINE is 1 if this is the
 104        main symbol table being read, and 0 if a secondary
 105        symbol file (e.g. shared library or dynamically loaded file)
 106        is being read.  */
 107
 108     void (*sym_read) (struct objfile *, int);
 109
 110     /* Called when we are finished with an objfile.  Should do all cleanup
 111        that is specific to the object file format for the particular objfile. */
 112
 113     void (*sym_finish) (struct objfile *);
 114
 115     /* This function produces a file-dependent section_offsets structure,
 116        allocated in the objfile's storage, and based on the parameter.
 117        The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility
 118        with the higher levels of GDB.  It should probably be changed to
 119        a string, where NULL means the default, and others are parsed in a file
 120        dependent way. */
 121
 122     void (*sym_offsets) (struct objfile *, struct section_addr_info *);
 123
 124     /* Finds the next struct sym_fns.  They are allocated and initialized
 125        in whatever module implements the functions pointed to; an
 126        initializer calls add_symtab_fns to add them to the global chain.  */
 127
 128     struct sym_fns *next;
 129
 130   };
 131
 132 /* The default version of sym_fns.sym_offsets for readers that don't
 133    do anything special.  */
 134
 135 extern void
 136 default_symfile_offsets (struct objfile *objfile, struct section_addr_info *);
 137
 138
 139 extern void
 140 extend_psymbol_list (struct psymbol_allocation_list *, struct objfile *);
 141
 142 /* Add any kind of symbol to a psymbol_allocation_list. */
 143
 144 /* #include "demangle.h" */
 145
 146 extern void
 147 add_psymbol_to_list (char *, int, namespace_enum, enum address_class,
 148                      struct psymbol_allocation_list *, long, CORE_ADDR,
 149                      enum language, struct objfile *);
 150
 151 extern void
 152 add_psymbol_with_dem_name_to_list (char *, int, char *, int, namespace_enum,
 153                                    enum address_class,
 154                                    struct psymbol_allocation_list *,
 155                                    long, CORE_ADDR,
 156                                    enum language, struct objfile *);
 157
 158
 159 extern void init_psymbol_list (struct objfile *, int);
 160
 161 extern void sort_pst_symbols (struct partial_symtab *);
 162
 163 extern struct symtab *allocate_symtab (char *, struct objfile *);
 164
 165 extern int free_named_symtabs (char *);
 166
 167 extern void fill_in_vptr_fieldno (struct type *);
 168
 169 extern void add_symtab_fns (struct sym_fns *);
 170
 171 extern void init_entry_point_info (struct objfile *);
 172
 173 extern void
 174 syms_from_objfile (struct objfile *, struct section_addr_info *, int, int);
 175
 176 extern void new_symfile_objfile (struct objfile *, int, int);
 177
 178 extern struct objfile *symbol_file_add (char *, int,
 179                                         struct section_addr_info *, int, int);
 180
 181 /* Build (allocate and populate) a section_addr_info struct from
 182    an existing section table. */
 183
 184 struct section_table;
 185 extern struct section_addr_info *
 186 build_section_addr_info_from_section_table (const struct section_table *start,
 187                                             const struct section_table *end);
 188
 189 /* Free all memory allocated by build_section_addr_info_from_section_table. */
 190
 191 extern void
 192 free_section_addr_info (struct section_addr_info *);
 193
 194
 195 extern struct partial_symtab *start_psymtab_common (struct objfile *,
 196                                                     struct section_offsets *,
 197                                                     char *, CORE_ADDR,
 198                                                     struct partial_symbol **,
 199                                                     struct partial_symbol **);
 200
 201 /* Sorting your symbols for fast lookup or alphabetical printing.  */
 202
 203 extern void sort_block_syms (struct block *);
 204
 205 extern void sort_symtab_syms (struct symtab *);
 206
 207 /* Make a copy of the string at PTR with SIZE characters in the symbol obstack
 208    (and add a null character at the end in the copy).
 209    Returns the address of the copy.  */
 210
 211 extern char *obsavestring (char *, int, struct obstack *);
 212
 213 /* Concatenate strings S1, S2 and S3; return the new string.
 214    Space is found in the symbol_obstack.  */
 215
 216 extern char *obconcat (struct obstack *obstackp, const char *, const char *,
 217                        const char *);
 218
 219                         /*   Variables   */
 220
 221 /* If non-zero, shared library symbols will be added automatically
 222    when the inferior is created, new libraries are loaded, or when
 223    attaching to the inferior.  This is almost always what users will
 224    want to have happen; but for very large programs, the startup time
 225    will be excessive, and so if this is a problem, the user can clear
 226    this flag and then add the shared library symbols as needed.  Note
 227    that there is a potential for confusion, since if the shared
 228    library symbols are not loaded, commands like "info fun" will *not*
 229    report all the functions that are actually present. */
 230
 231 extern int auto_solib_add;
 232
 233 /* For systems that support it, a threshold size in megabytes.  If
 234    automatically adding a new library's symbol table to those already
 235    known to the debugger would cause the total shared library symbol
 236    size to exceed this threshhold, then the shlib's symbols are not
 237    added.  The threshold is ignored if the user explicitly asks for a
 238    shlib to be added, such as when using the "sharedlibrary"
 239    command. */
 240
 241 extern int auto_solib_limit;
 242
 243 /* From symfile.c */
 244
 245 extern CORE_ADDR entry_point_address (void);
 246
 247 extern struct partial_symtab *allocate_psymtab (char *, struct objfile *);
 248
 249 extern void discard_psymtab (struct partial_symtab *);
 250
 251 extern void find_lowest_section (bfd *, asection *, PTR);
 252
 253 extern bfd *symfile_bfd_open (char *);
 254
 255 extern int get_section_index (struct objfile *, char *);
 256
 257 /* Utility functions for overlay sections: */
 258 extern enum overlay_debugging_state {
 259   ovly_off,
 260   ovly_on,
 261   ovly_auto
 262 } overlay_debugging;
 263 extern int overlay_cache_invalid;
 264
 265 /* return the "mapped" overlay section  containing the PC */
 266 extern asection *find_pc_mapped_section (CORE_ADDR);
 267
 268 /* return any overlay section containing the PC (even in its LMA region) */
 269 extern asection *find_pc_overlay (CORE_ADDR);
 270
 271 /* return true if the section is an overlay */
 272 extern int section_is_overlay (asection *);
 273
 274 /* return true if the overlay section is currently "mapped" */
 275 extern int section_is_mapped (asection *);
 276
 277 /* return true if pc belongs to section's VMA */
 278 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *);
 279
 280 /* return true if pc belongs to section's LMA */
 281 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *);
 282
 283 /* map an address from a section's LMA to its VMA */
 284 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *);
 285
 286 /* map an address from a section's VMA to its LMA */
 287 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *);
 288
 289 /* convert an address in an overlay section (force into VMA range) */
 290 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *);
 291
 292 /* Load symbols from a file. */
 293 extern void symbol_file_add_main (char *args, int from_tty);
 294
 295 /* Clear GDB symbol tables. */
 296 extern void symbol_file_clear (int from_tty);
 297
 298 /* From dwarfread.c */
 299
 300 extern void
 301 dwarf_build_psymtabs (struct objfile *, int, file_ptr, unsigned int,
 302                       file_ptr, unsigned int);
 303
 304 /* From dwarf2read.c */
 305
 306 extern int dwarf2_has_info (bfd * abfd);
 307
 308 extern void dwarf2_build_psymtabs (struct objfile *, int);
 309 extern void dwarf2_build_frame_info (struct objfile *);
 310
 311 /* From mdebugread.c */
 312
 313 /* Hack to force structures to exist before use in parameter list.  */
 314 struct ecoff_debug_hack
 315   {
 316     struct ecoff_debug_swap *a;
 317     struct ecoff_debug_info *b;
 318   };
 319 extern void
 320 mdebug_build_psymtabs (struct objfile *,
 321                        const struct ecoff_debug_swap *,
 322                        struct ecoff_debug_info *);
 323
 324 extern void
 325 elfmdebug_build_psymtabs (struct objfile *,
 326                           const struct ecoff_debug_swap *, asection *);
 327
 328 #endif /* !defined(SYMFILE_H) */