contrib/gdb/gdb/objfiles.h

   1 /* Definitions for symbol file management in GDB.
   2    Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
   3
   4 This file is part of GDB.
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  19
  20 #if !defined (OBJFILES_H)
  21 #define OBJFILES_H
  22
  23 /* This structure maintains information on a per-objfile basis about the
  24    "entry point" of the objfile, and the scope within which the entry point
  25    exists.  It is possible that gdb will see more than one objfile that is
  26    executable, each with its own entry point.
  27
  28    For example, for dynamically linked executables in SVR4, the dynamic linker
  29    code is contained within the shared C library, which is actually executable
  30    and is run by the kernel first when an exec is done of a user executable
  31    that is dynamically linked.  The dynamic linker within the shared C library
  32    then maps in the various program segments in the user executable and jumps
  33    to the user executable's recorded entry point, as if the call had been made
  34    directly by the kernel.
  35
  36    The traditional gdb method of using this info is to use the recorded entry
  37    point to set the variables entry_file_lowpc and entry_file_highpc from
  38    the debugging information, where these values are the starting address
  39    (inclusive) and ending address (exclusive) of the instruction space in the
  40    executable which correspond to the "startup file", I.E. crt0.o in most
  41    cases.  This file is assumed to be a startup file and frames with pc's
  42    inside it are treated as nonexistent.  Setting these variables is necessary
  43    so that backtraces do not fly off the bottom of the stack.
  44
  45    Gdb also supports an alternate method to avoid running off the bottom
  46    of the stack.
  47
  48    There are two frames that are "special", the frame for the function
  49    containing the process entry point, since it has no predecessor frame,
  50    and the frame for the function containing the user code entry point
  51    (the main() function), since all the predecessor frames are for the
  52    process startup code.  Since we have no guarantee that the linked
  53    in startup modules have any debugging information that gdb can use,
  54    we need to avoid following frame pointers back into frames that might
  55    have been built in the startup code, as we might get hopelessly
  56    confused.  However, we almost always have debugging information
  57    available for main().
  58
  59    These variables are used to save the range of PC values which are valid
  60    within the main() function and within the function containing the process
  61    entry point.  If we always consider the frame for main() as the outermost
  62    frame when debugging user code, and the frame for the process entry
  63    point function as the outermost frame when debugging startup code, then
  64    all we have to do is have FRAME_CHAIN_VALID return false whenever a
  65    frame's current PC is within the range specified by these variables.
  66    In essence, we set "ceilings" in the frame chain beyond which we will
  67    not proceed when following the frame chain back up the stack.
  68
  69    A nice side effect is that we can still debug startup code without
  70    running off the end of the frame chain, assuming that we have usable
  71    debugging information in the startup modules, and if we choose to not
  72    use the block at main, or can't find it for some reason, everything
  73    still works as before.  And if we have no startup code debugging
  74    information but we do have usable information for main(), backtraces
  75    from user code don't go wandering off into the startup code.
  76
  77    To use this method, define your FRAME_CHAIN_VALID macro like:
  78
  79         #define FRAME_CHAIN_VALID(chain, thisframe)     \
  80           (chain != 0                                   \
  81            && !(inside_main_func ((thisframe)->pc))     \
  82            && !(inside_entry_func ((thisframe)->pc)))
  83
  84    and add initializations of the four scope controlling variables inside
  85    the object file / debugging information processing modules.  */
  86
  87 struct entry_info
  88 {
  89
  90   /* The value we should use for this objects entry point.
  91      The illegal/unknown value needs to be something other than 0, ~0
  92      for instance, which is much less likely than 0. */
  93
  94   CORE_ADDR entry_point;
  95
  96 #define INVALID_ENTRY_POINT (~0) /* ~0 will not be in any file, we hope.  */
  97
  98   /* Start (inclusive) and end (exclusive) of function containing the
  99      entry point. */
 100
 101   CORE_ADDR entry_func_lowpc;
 102   CORE_ADDR entry_func_highpc;
 103
 104   /* Start (inclusive) and end (exclusive) of object file containing the
 105      entry point. */
 106
 107   CORE_ADDR entry_file_lowpc;
 108   CORE_ADDR entry_file_highpc;
 109
 110   /* Start (inclusive) and end (exclusive) of the user code main() function. */
 111
 112   CORE_ADDR main_func_lowpc;
 113   CORE_ADDR main_func_highpc;
 114
 115 /* Use these values when any of the above ranges is invalid.  */
 116
 117 /* We use these values because it guarantees that there is no number that is
 118    both >= LOWPC && < HIGHPC.  It is also highly unlikely that 3 is a valid
 119    module or function start address (as opposed to 0).  */
 120
 121 #define INVALID_ENTRY_LOWPC (3)
 122 #define INVALID_ENTRY_HIGHPC (1)
 123
 124 };
 125
 126 /* Sections in an objfile.
 127
 128    It is strange that we have both this notion of "sections"
 129    and the one used by section_offsets.  Section as used
 130    here, (currently at least) means a BFD section, and the sections
 131    are set up from the BFD sections in allocate_objfile.
 132
 133    The sections in section_offsets have their meaning determined by
 134    the symbol format, and they are set up by the sym_offsets function
 135    for that symbol file format.
 136
 137    I'm not sure this could or should be changed, however.  */
 138
 139 struct obj_section {
 140   CORE_ADDR     addr;    /* lowest address in section */
 141   CORE_ADDR     endaddr; /* 1+highest address in section */
 142
 143   /* This field is being used for nefarious purposes by syms_from_objfile.
 144      It is said to be redundant with section_offsets; it's not really being
 145      used that way, however, it's some sort of hack I don't understand
 146      and am not going to try to eliminate (yet, anyway).  FIXME.
 147
 148      It was documented as "offset between (end)addr and actual memory
 149      addresses", but that's not true; addr & endaddr are actual memory
 150      addresses.  */
 151   CORE_ADDR offset;
 152
 153   sec_ptr the_bfd_section; /* BFD section pointer */
 154
 155   /* Objfile this section is part of.  */
 156   struct objfile *objfile;
 157
 158   /* True if this "overlay section" is mapped into an "overlay region". */
 159   int ovly_mapped;
 160 };
 161
 162 /* An import entry contains information about a symbol that
 163    is used in this objfile but not defined in it, and so needs
 164    to be imported from some other objfile */
 165 /* Currently we just store the name; no attributes. 1997-08-05 */
 166 typedef char * ImportEntry;
 167
 168
 169 /* An export entry contains information about a symbol that
 170    is defined in this objfile and available for use in other
 171    objfiles */
 172 typedef struct {
 173   char * name; /* name of exported symbol */
 174   int address; /* offset subject to relocation */
 175   /* Currently no other attributes 1997-08-05 */
 176 } ExportEntry;
 177
 178
 179
 180 /* The "objstats" structure provides a place for gdb to record some
 181    interesting information about its internal state at runtime, on a
 182    per objfile basis, such as information about the number of symbols
 183    read, size of string table (if any), etc. */
 184
 185 #if MAINTENANCE_CMDS
 186
 187 struct objstats {
 188   int n_minsyms;        /* Number of minimal symbols read */
 189   int n_psyms;          /* Number of partial symbols read */
 190   int n_syms;           /* Number of full symbols read */
 191   int n_stabs;          /* Number of ".stabs" read (if applicable) */
 192   int n_types;          /* Number of types */
 193   int sz_strtab;        /* Size of stringtable, (if applicable) */
 194 };
 195
 196 #define OBJSTAT(objfile, expr) (objfile -> stats.expr)
 197 #define OBJSTATS struct objstats stats
 198 extern void print_objfile_statistics PARAMS ((void));
 199 extern void print_symbol_bcache_statistics PARAMS ((void));
 200
 201 #else
 202
 203 #define OBJSTAT(objfile, expr)  /* Nothing */
 204 #define OBJSTATS                /* Nothing */
 205
 206 #endif  /* MAINTENANCE_CMDS */
 207
 208 /* Master structure for keeping track of each file from which
 209    gdb reads symbols.  There are several ways these get allocated: 1.
 210    The main symbol file, symfile_objfile, set by the symbol-file command,
 211    2.  Additional symbol files added by the add-symbol-file command,
 212    3.  Shared library objfiles, added by ADD_SOLIB,  4.  symbol files
 213    for modules that were loaded when GDB attached to a remote system
 214    (see remote-vx.c).  */
 215
 216 struct objfile
 217 {
 218
 219   /* All struct objfile's are chained together by their next pointers.
 220      The global variable "object_files" points to the first link in this
 221      chain.
 222
 223      FIXME:  There is a problem here if the objfile is reusable, and if
 224      multiple users are to be supported.  The problem is that the objfile
 225      list is linked through a member of the objfile struct itself, which
 226      is only valid for one gdb process.  The list implementation needs to
 227      be changed to something like:
 228
 229      struct list {struct list *next; struct objfile *objfile};
 230
 231      where the list structure is completely maintained separately within
 232      each gdb process. */
 233
 234   struct objfile *next;
 235
 236   /* The object file's name.  Malloc'd; free it if you free this struct.  */
 237
 238   char *name;
 239
 240   /* TRUE if this objfile was created because the user explicitly caused
 241      it (e.g., used the add-symbol-file command).
 242      */
 243   int  user_loaded;
 244
 245   /* TRUE if this objfile was explicitly created to represent a solib.
 246
 247      (If FALSE, the objfile may actually be a solib.  This can happen if
 248      the user created the objfile by using the add-symbol-file command.
 249      GDB doesn't in that situation actually check whether the file is a
 250      solib.  Rather, the target's implementation of the solib interface
 251      is responsible for setting this flag when noticing solibs used by
 252      an inferior.)
 253      */
 254   int  is_solib;
 255
 256   /* Some flag bits for this objfile. */
 257
 258   unsigned short flags;
 259
 260   /* Each objfile points to a linked list of symtabs derived from this file,
 261      one symtab structure for each compilation unit (source file).  Each link
 262      in the symtab list contains a backpointer to this objfile. */
 263
 264   struct symtab *symtabs;
 265
 266   /* Each objfile points to a linked list of partial symtabs derived from
 267      this file, one partial symtab structure for each compilation unit
 268      (source file). */
 269
 270   struct partial_symtab *psymtabs;
 271
 272   /* List of freed partial symtabs, available for re-use */
 273
 274   struct partial_symtab *free_psymtabs;
 275
 276   /* The object file's BFD.  Can be null if the objfile contains only
 277      minimal symbols, e.g. the run time common symbols for SunOS4.  */
 278
 279   bfd *obfd;
 280
 281   /* The modification timestamp of the object file, as of the last time
 282      we read its symbols.  */
 283
 284   long mtime;
 285
 286   /* Obstacks to hold objects that should be freed when we load a new symbol
 287      table from this object file. */
 288
 289   struct obstack psymbol_obstack;       /* Partial symbols */
 290   struct obstack symbol_obstack;        /* Full symbols */
 291   struct obstack type_obstack;          /* Types */
 292
 293   /* A byte cache where we can stash arbitrary "chunks" of bytes that
 294      will not change. */
 295
 296   struct bcache psymbol_cache;          /* Byte cache for partial syms */
 297
 298   /* Vectors of all partial symbols read in from file.  The actual data
 299      is stored in the psymbol_obstack. */
 300
 301   struct psymbol_allocation_list global_psymbols;
 302   struct psymbol_allocation_list static_psymbols;
 303
 304   /* Each file contains a pointer to an array of minimal symbols for all
 305      global symbols that are defined within the file.  The array is terminated
 306      by a "null symbol", one that has a NULL pointer for the name and a zero
 307      value for the address.  This makes it easy to walk through the array
 308      when passed a pointer to somewhere in the middle of it.  There is also
 309      a count of the number of symbols, which does not include the terminating
 310      null symbol.  The array itself, as well as all the data that it points
 311      to, should be allocated on the symbol_obstack for this file. */
 312
 313   struct minimal_symbol *msymbols;
 314   int minimal_symbol_count;
 315
 316   /* For object file formats which don't specify fundamental types, gdb
 317      can create such types.  For now, it maintains a vector of pointers
 318      to these internally created fundamental types on a per objfile basis,
 319      however it really should ultimately keep them on a per-compilation-unit
 320      basis, to account for linkage-units that consist of a number of
 321      compilation units that may have different fundamental types, such as
 322      linking C modules with ADA modules, or linking C modules that are
 323      compiled with 32-bit ints with C modules that are compiled with 64-bit
 324      ints (not inherently evil with a smarter linker). */
 325
 326   struct type **fundamental_types;
 327
 328   /* The mmalloc() malloc-descriptor for this objfile if we are using
 329      the memory mapped malloc() package to manage storage for this objfile's
 330      data.  NULL if we are not. */
 331
 332   PTR md;
 333
 334   /* The file descriptor that was used to obtain the mmalloc descriptor
 335      for this objfile.  If we call mmalloc_detach with the malloc descriptor
 336      we should then close this file descriptor. */
 337
 338   int mmfd;
 339
 340   /* Structure which keeps track of functions that manipulate objfile's
 341      of the same type as this objfile.  I.E. the function to read partial
 342      symbols for example.  Note that this structure is in statically
 343      allocated memory, and is shared by all objfiles that use the
 344      object module reader of this type. */
 345
 346   struct sym_fns *sf;
 347
 348   /* The per-objfile information about the entry point, the scope (file/func)
 349      containing the entry point, and the scope of the user's main() func. */
 350
 351   struct entry_info ei;
 352
 353   /* Information about stabs.  Will be filled in with a dbx_symfile_info
 354      struct by those readers that need it. */
 355
 356   struct dbx_symfile_info *sym_stab_info;
 357
 358   /* Hook for information for use by the symbol reader (currently used
 359      for information shared by sym_init and sym_read).  It is
 360      typically a pointer to malloc'd memory.  The symbol reader's finish
 361      function is responsible for freeing the memory thusly allocated.  */
 362
 363   PTR sym_private;
 364
 365   /* Hook for target-architecture-specific information.  This must
 366      point to memory allocated on one of the obstacks in this objfile,
 367      so that it gets freed automatically when reading a new object
 368      file. */
 369
 370   PTR obj_private;
 371
 372   /* Set of relocation offsets to apply to each section.
 373      Currently on the psymbol_obstack (which makes no sense, but I'm
 374      not sure it's harming anything).
 375
 376      These offsets indicate that all symbols (including partial and
 377      minimal symbols) which have been read have been relocated by this
 378      much.  Symbols which are yet to be read need to be relocated by
 379      it.  */
 380
 381   struct section_offsets *section_offsets;
 382   int num_sections;
 383
 384   /* set of section begin and end addresses used to map pc addresses
 385      into sections.  Currently on the psymbol_obstack (which makes no
 386      sense, but I'm not sure it's harming anything).  */
 387
 388   struct obj_section
 389     *sections,
 390     *sections_end;
 391
 392   /* two auxiliary fields, used to hold the fp of separate symbol files */
 393   FILE *auxf1, *auxf2;
 394
 395   /* Imported symbols */
 396   ImportEntry * import_list;
 397   int import_list_size;
 398
 399   /* Exported symbols */
 400   ExportEntry * export_list;
 401   int export_list_size;
 402
 403   /* Place to stash various statistics about this objfile */
 404   OBJSTATS;
 405 };
 406
 407 /* Defines for the objfile flag word. */
 408
 409 /* Gdb can arrange to allocate storage for all objects related to a
 410    particular objfile in a designated section of its address space,
 411    managed at a low level by mmap() and using a special version of
 412    malloc that handles malloc/free/realloc on top of the mmap() interface.
 413    This allows the "internal gdb state" for a particular objfile to be
 414    dumped to a gdb state file and subsequently reloaded at a later time. */
 415
 416 #define OBJF_MAPPED     (1 << 0)        /* Objfile data is mmap'd */
 417
 418 /* When using mapped/remapped predigested gdb symbol information, we need
 419    a flag that indicates that we have previously done an initial symbol
 420    table read from this particular objfile.  We can't just look for the
 421    absence of any of the three symbol tables (msymbols, psymtab, symtab)
 422    because if the file has no symbols for example, none of these will
 423    exist. */
 424
 425 #define OBJF_SYMS       (1 << 1)        /* Have tried to read symbols */
 426
 427 /* When an object file has its functions reordered (currently Irix-5.2
 428    shared libraries exhibit this behaviour), we will need an expensive
 429    algorithm to locate a partial symtab or symtab via an address.
 430    To avoid this penalty for normal object files, we use this flag,
 431    whose setting is determined upon symbol table read in.  */
 432
 433 #define OBJF_REORDERED  (1 << 2)        /* Functions are reordered */
 434
 435 /* Distinguish between an objfile for a shared library and a
 436    "vanilla" objfile. */
 437
 438 #define OBJF_SHARED     (1 << 3)        /* From a shared library */
 439
 440 /* The object file that the main symbol table was loaded from (e.g. the
 441    argument to the "symbol-file" or "file" command).  */
 442
 443 extern struct objfile *symfile_objfile;
 444
 445 /* The object file that contains the runtime common minimal symbols
 446    for SunOS4. Note that this objfile has no associated BFD.  */
 447
 448 extern struct objfile *rt_common_objfile;
 449
 450 /* When we need to allocate a new type, we need to know which type_obstack
 451    to allocate the type on, since there is one for each objfile.  The places
 452    where types are allocated are deeply buried in function call hierarchies
 453    which know nothing about objfiles, so rather than trying to pass a
 454    particular objfile down to them, we just do an end run around them and
 455    set current_objfile to be whatever objfile we expect to be using at the
 456    time types are being allocated.  For instance, when we start reading
 457    symbols for a particular objfile, we set current_objfile to point to that
 458    objfile, and when we are done, we set it back to NULL, to ensure that we
 459    never put a type someplace other than where we are expecting to put it.
 460    FIXME:  Maybe we should review the entire type handling system and
 461    see if there is a better way to avoid this problem. */
 462
 463 extern struct objfile *current_objfile;
 464
 465 /* All known objfiles are kept in a linked list.  This points to the
 466    root of this list. */
 467
 468 extern struct objfile *object_files;
 469
 470 /* Declarations for functions defined in objfiles.c */
 471
 472 extern struct objfile *
 473 allocate_objfile PARAMS ((bfd *, int, int, int));
 474
 475 extern int
 476 build_objfile_section_table PARAMS ((struct objfile *));
 477
 478 extern void objfile_to_front PARAMS ((struct objfile *));
 479
 480 extern void
 481 unlink_objfile PARAMS ((struct objfile *));
 482
 483 extern void
 484 free_objfile PARAMS ((struct objfile *));
 485
 486 extern void
 487 free_all_objfiles PARAMS ((void));
 488
 489 extern void
 490 objfile_relocate PARAMS ((struct objfile *, struct section_offsets *));
 491
 492 extern int
 493 have_partial_symbols PARAMS ((void));
 494
 495 extern int
 496 have_full_symbols PARAMS ((void));
 497
 498 /* This operation deletes all objfile entries that represent solibs that
 499    weren't explicitly loaded by the user, via e.g., the add-symbol-file
 500    command.
 501    */
 502 extern void
 503 objfile_purge_solibs PARAMS ((void));
 504
 505 /* Functions for dealing with the minimal symbol table, really a misc
 506    address<->symbol mapping for things we don't have debug symbols for.  */
 507
 508 extern int
 509 have_minimal_symbols PARAMS ((void));
 510
 511 extern struct obj_section *
 512 find_pc_section PARAMS((CORE_ADDR pc));
 513
 514 extern struct obj_section *
 515 find_pc_sect_section PARAMS((CORE_ADDR pc, asection *section));
 516
 517 extern int
 518 in_plt_section PARAMS ((CORE_ADDR, char *));
 519
 520 /* Traverse all object files.  ALL_OBJFILES_SAFE works even if you delete
 521    the objfile during the traversal.  */
 522
 523 #define ALL_OBJFILES(obj) \
 524   for ((obj) = object_files; (obj) != NULL; (obj) = (obj)->next)
 525
 526 #define ALL_OBJFILES_SAFE(obj,nxt) \
 527   for ((obj) = object_files;       \
 528        (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
 529        (obj) = (nxt))
 530
 531 /* Traverse all symtabs in one objfile.  */
 532
 533 #define ALL_OBJFILE_SYMTABS(objfile, s) \
 534     for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next)
 535
 536 /* Traverse all psymtabs in one objfile.  */
 537
 538 #define ALL_OBJFILE_PSYMTABS(objfile, p) \
 539     for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next)
 540
 541 /* Traverse all minimal symbols in one objfile.  */
 542
 543 #define ALL_OBJFILE_MSYMBOLS(objfile, m) \
 544     for ((m) = (objfile) -> msymbols; SYMBOL_NAME(m) != NULL; (m)++)
 545
 546 /* Traverse all symtabs in all objfiles.  */
 547
 548 #define ALL_SYMTABS(objfile, s) \
 549   ALL_OBJFILES (objfile)         \
 550     ALL_OBJFILE_SYMTABS (objfile, s)
 551
 552 /* Traverse all psymtabs in all objfiles.  */
 553
 554 #define ALL_PSYMTABS(objfile, p) \
 555   ALL_OBJFILES (objfile)         \
 556     ALL_OBJFILE_PSYMTABS (objfile, p)
 557
 558 /* Traverse all minimal symbols in all objfiles.  */
 559
 560 #define ALL_MSYMBOLS(objfile, m) \
 561   ALL_OBJFILES (objfile)         \
 562     if ((objfile)->msymbols)     \
 563       ALL_OBJFILE_MSYMBOLS (objfile, m)
 564
 565 #define ALL_OBJFILE_OSECTIONS(objfile, osect)   \
 566   for (osect = objfile->sections; osect < objfile->sections_end; osect++)
 567
 568 #define ALL_OBJSECTIONS(objfile, osect)         \
 569   ALL_OBJFILES (objfile)                        \
 570     ALL_OBJFILE_OSECTIONS (objfile, osect)
 571
 572 #endif  /* !defined (OBJFILES_H) */