gdb/symfile.h

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