gdb/symfile.h

   1 /* Definitions for reading symbol files into GDB.
   2    Copyright (C) 1990, 1991, 1992, 1993, 1994, 1996
   3    Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22 #if !defined (SYMFILE_H)
  23 #define SYMFILE_H
  24
  25 /* This file requires that you first include "bfd.h".  */
  26
  27 /* Partial symbols are stored in the psymbol_cache and pointers to them
  28    are kept in a dynamically grown array that is obtained from malloc and
  29    grown as necessary via realloc.  Each objfile typically has two of these,
  30    one for global symbols and one for static symbols.  Although this adds
  31    a level of indirection for storing or accessing the partial symbols,
  32    it allows us to throw away duplicate psymbols and set all pointers
  33    to the single saved instance. */
  34
  35 struct psymbol_allocation_list
  36   {
  37
  38     /* Pointer to beginning of dynamically allocated array of pointers to
  39        partial symbols.  The array is dynamically expanded as necessary to
  40        accommodate more pointers. */
  41
  42     struct partial_symbol **list;
  43
  44     /* Pointer to next available slot in which to store a pointer to a partial
  45        symbol. */
  46
  47     struct partial_symbol **next;
  48
  49     /* Number of allocated pointer slots in current dynamic array (not the
  50        number of bytes of storage).  The "next" pointer will always point
  51        somewhere between list[0] and list[size], and when at list[size] the
  52        array will be expanded on the next attempt to store a pointer. */
  53
  54     int size;
  55   };
  56
  57 /* Structure to keep track of symbol reading functions for various
  58    object file types.  */
  59
  60 struct sym_fns
  61   {
  62
  63     /* BFD flavour that we handle, or (as a special kludge, see xcoffread.c,
  64        (enum bfd_flavour)-1 for xcoff).  */
  65
  66     enum bfd_flavour sym_flavour;
  67
  68     /* Initializes anything that is global to the entire symbol table.  It is
  69        called during symbol_file_add, when we begin debugging an entirely new
  70        program. */
  71
  72     void (*sym_new_init) PARAMS ((struct objfile *));
  73
  74     /* Reads any initial information from a symbol file, and initializes the
  75        struct sym_fns SF in preparation for sym_read().  It is called every
  76        time we read a symbol file for any reason. */
  77
  78     void (*sym_init) PARAMS ((struct objfile *));
  79
  80     /* sym_read (objfile, addr, mainline)
  81        Reads a symbol file into a psymtab (or possibly a symtab).
  82        OBJFILE is the objfile struct for the file we are reading.
  83        SECTION_OFFSETS
  84        are the offset between the file's specified section addresses and
  85        their true addresses in memory.
  86        MAINLINE is 1 if this is the
  87        main symbol table being read, and 0 if a secondary
  88        symbol file (e.g. shared library or dynamically loaded file)
  89        is being read.  */
  90
  91     void (*sym_read) PARAMS ((struct objfile *, struct section_offsets *, int));
  92
  93     /* Called when we are finished with an objfile.  Should do all cleanup
  94        that is specific to the object file format for the particular objfile. */
  95
  96     void (*sym_finish) PARAMS ((struct objfile *));
  97
  98     /* This function produces a file-dependent section_offsets structure,
  99        allocated in the objfile's storage, and based on the parameter.
 100        The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility
 101        with the higher levels of GDB.  It should probably be changed to
 102        a string, where NULL means the default, and others are parsed in a file
 103        dependent way.  The result of this function is handed in to sym_read.  */
 104
 105     struct section_offsets *(*sym_offsets) PARAMS ((struct objfile *, CORE_ADDR));
 106
 107     /* Finds the next struct sym_fns.  They are allocated and initialized
 108        in whatever module implements the functions pointed to; an
 109        initializer calls add_symtab_fns to add them to the global chain.  */
 110
 111     struct sym_fns *next;
 112
 113   };
 114
 115 /* The default version of sym_fns.sym_offsets for readers that don't
 116    do anything special.  */
 117
 118 extern struct section_offsets *
 119   default_symfile_offsets PARAMS ((struct objfile * objfile, CORE_ADDR addr));
 120
 121
 122 extern void
 123 extend_psymbol_list PARAMS ((struct psymbol_allocation_list *,
 124                              struct objfile *));
 125
 126 /* Add any kind of symbol to a psymbol_allocation_list. */
 127
 128 /* #include "demangle.h" */
 129
 130 extern void
 131 add_psymbol_to_list PARAMS ((char *, int, namespace_enum, enum address_class,
 132                           struct psymbol_allocation_list *, long, CORE_ADDR,
 133                              enum language, struct objfile *));
 134
 135 extern void
 136 add_psymbol_with_dem_name_to_list PARAMS ((char *, int, char *, int, namespace_enum,
 137                                            enum address_class,
 138                                            struct psymbol_allocation_list *,
 139                                            long, CORE_ADDR,
 140                                            enum language, struct objfile *));
 141
 142
 143 extern void init_psymbol_list PARAMS ((struct objfile *, int));
 144
 145 extern void
 146 sort_pst_symbols PARAMS ((struct partial_symtab *));
 147
 148 extern struct symtab *
 149   allocate_symtab PARAMS ((char *, struct objfile *));
 150
 151 extern int
 152 free_named_symtabs PARAMS ((char *));
 153
 154 extern void
 155 fill_in_vptr_fieldno PARAMS ((struct type *));
 156
 157 extern void
 158 add_symtab_fns PARAMS ((struct sym_fns *));
 159
 160 extern void
 161 init_entry_point_info PARAMS ((struct objfile *));
 162
 163 extern void
 164 syms_from_objfile PARAMS ((struct objfile *, CORE_ADDR, int, int));
 165
 166 extern void
 167 new_symfile_objfile PARAMS ((struct objfile *, int, int));
 168
 169 extern struct partial_symtab *
 170   start_psymtab_common PARAMS ((struct objfile *, struct section_offsets *,
 171                                 char *, CORE_ADDR,
 172                                 struct partial_symbol **,
 173                                 struct partial_symbol **));
 174
 175 /* Sorting your symbols for fast lookup or alphabetical printing.  */
 176
 177 extern void
 178 sort_block_syms PARAMS ((struct block *));
 179
 180 extern void
 181 sort_symtab_syms PARAMS ((struct symtab *));
 182
 183 /* Make a copy of the string at PTR with SIZE characters in the symbol obstack
 184    (and add a null character at the end in the copy).
 185    Returns the address of the copy.  */
 186
 187 extern char *
 188   obsavestring PARAMS ((char *, int, struct obstack *));
 189
 190 /* Concatenate strings S1, S2 and S3; return the new string.
 191    Space is found in the symbol_obstack.  */
 192
 193 extern char *
 194   obconcat PARAMS ((struct obstack * obstackp, const char *, const char *,
 195                     const char *));
 196
 197                         /*   Variables   */
 198
 199 /* whether to auto load solibs at startup time:  0/1.
 200
 201    On all platforms, 0 means "don't auto load".
 202
 203    On HP-UX, > 0 means a threshhold, in megabytes, of symbol table which will
 204    be auto loaded.  When the cumulative size of solib symbol table exceeds
 205    this threshhold, solibs' symbol tables will not be loaded.
 206
 207    On other platforms, > 0 means, "always auto load".
 208  */
 209
 210 extern int auto_solib_add;
 211
 212 /* From symfile.c */
 213
 214 extern CORE_ADDR
 215   entry_point_address PARAMS ((void));
 216
 217 extern struct partial_symtab *
 218   allocate_psymtab PARAMS ((char *, struct objfile *));
 219
 220 extern void
 221 discard_psymtab PARAMS ((struct partial_symtab *));
 222
 223 extern void find_lowest_section PARAMS ((bfd *, asection *, PTR));
 224
 225 extern bfd *symfile_bfd_open PARAMS ((char *));
 226
 227 /* Remote targets may wish to use this as their load function.  */
 228 extern void generic_load PARAMS ((char *name, int from_tty));
 229
 230 /* Utility functions for overlay sections: */
 231 extern int overlay_debugging;
 232 extern int overlay_cache_invalid;
 233
 234 /* return the "mapped" overlay section  containing the PC */
 235 extern asection *
 236   find_pc_mapped_section PARAMS ((CORE_ADDR));
 237
 238 /* return any overlay section containing the PC (even in its LMA region) */
 239 extern asection *
 240   find_pc_overlay PARAMS ((CORE_ADDR));
 241
 242 /* return true if the section is an overlay */
 243 extern int
 244 section_is_overlay PARAMS ((asection *));
 245
 246 /* return true if the overlay section is currently "mapped" */
 247 extern int
 248 section_is_mapped PARAMS ((asection *));
 249
 250 /* return true if pc belongs to section's VMA */
 251 extern CORE_ADDR
 252   pc_in_mapped_range PARAMS ((CORE_ADDR, asection *));
 253
 254 /* return true if pc belongs to section's LMA */
 255 extern CORE_ADDR
 256   pc_in_unmapped_range PARAMS ((CORE_ADDR, asection *));
 257
 258 /* map an address from a section's LMA to its VMA */
 259 extern CORE_ADDR
 260   overlay_mapped_address PARAMS ((CORE_ADDR, asection *));
 261
 262 /* map an address from a section's VMA to its LMA */
 263 extern CORE_ADDR
 264   overlay_unmapped_address PARAMS ((CORE_ADDR, asection *));
 265
 266 /* convert an address in an overlay section (force into VMA range) */
 267 extern CORE_ADDR
 268   symbol_overlayed_address PARAMS ((CORE_ADDR, asection *));
 269
 270 /* From dwarfread.c */
 271
 272 extern void
 273 dwarf_build_psymtabs PARAMS ((struct objfile *, struct section_offsets *, int,
 274                            file_ptr, unsigned int, file_ptr, unsigned int));
 275
 276 /* From dwarf2read.c */
 277
 278 extern int dwarf2_has_info PARAMS ((bfd * abfd));
 279
 280 extern void dwarf2_build_psymtabs PARAMS ((struct objfile *,
 281                                            struct section_offsets *,
 282                                            int));
 283 /* From mdebugread.c */
 284
 285 /* Hack to force structures to exist before use in parameter list.  */
 286 struct ecoff_debug_hack
 287   {
 288     struct ecoff_debug_swap *a;
 289     struct ecoff_debug_info *b;
 290   };
 291 extern void
 292 mdebug_build_psymtabs PARAMS ((struct objfile *,
 293                                const struct ecoff_debug_swap *,
 294                                struct ecoff_debug_info *,
 295                                struct section_offsets *));
 296
 297 extern void
 298 elfmdebug_build_psymtabs PARAMS ((struct objfile *,
 299                                   const struct ecoff_debug_swap *,
 300                                   asection *,
 301                                   struct section_offsets *));
 302
 303 #endif /* !defined(SYMFILE_H) */