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