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