| 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, 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 | MAINLINE is 1 if this is the |
| 84 | main symbol table being read, and 0 if a secondary |
| 85 | symbol file (e.g. shared library or dynamically loaded file) |
| 86 | is being read. */ |
| 87 | |
| 88 | void (*sym_read) PARAMS ((struct objfile *, int)); |
| 89 | |
| 90 | /* Called when we are finished with an objfile. Should do all cleanup |
| 91 | that is specific to the object file format for the particular objfile. */ |
| 92 | |
| 93 | void (*sym_finish) PARAMS ((struct objfile *)); |
| 94 | |
| 95 | /* This function produces a file-dependent section_offsets structure, |
| 96 | allocated in the objfile's storage, and based on the parameter. |
| 97 | The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility |
| 98 | with the higher levels of GDB. It should probably be changed to |
| 99 | a string, where NULL means the default, and others are parsed in a file |
| 100 | dependent way. */ |
| 101 | |
| 102 | void (*sym_offsets) PARAMS ((struct objfile *, struct section_addr_info *)); |
| 103 | |
| 104 | /* Finds the next struct sym_fns. They are allocated and initialized |
| 105 | in whatever module implements the functions pointed to; an |
| 106 | initializer calls add_symtab_fns to add them to the global chain. */ |
| 107 | |
| 108 | struct sym_fns *next; |
| 109 | |
| 110 | }; |
| 111 | |
| 112 | /* The default version of sym_fns.sym_offsets for readers that don't |
| 113 | do anything special. */ |
| 114 | |
| 115 | extern void |
| 116 | default_symfile_offsets PARAMS ((struct objfile * objfile, struct section_addr_info *)); |
| 117 | |
| 118 | |
| 119 | extern void |
| 120 | extend_psymbol_list PARAMS ((struct psymbol_allocation_list *, |
| 121 | struct objfile *)); |
| 122 | |
| 123 | /* Add any kind of symbol to a psymbol_allocation_list. */ |
| 124 | |
| 125 | /* #include "demangle.h" */ |
| 126 | |
| 127 | extern void |
| 128 | add_psymbol_to_list PARAMS ((char *, int, namespace_enum, enum address_class, |
| 129 | struct psymbol_allocation_list *, long, CORE_ADDR, |
| 130 | enum language, struct objfile *)); |
| 131 | |
| 132 | extern void |
| 133 | add_psymbol_with_dem_name_to_list PARAMS ((char *, int, char *, int, namespace_enum, |
| 134 | enum address_class, |
| 135 | struct psymbol_allocation_list *, |
| 136 | long, CORE_ADDR, |
| 137 | enum language, struct objfile *)); |
| 138 | |
| 139 | |
| 140 | extern void init_psymbol_list PARAMS ((struct objfile *, int)); |
| 141 | |
| 142 | extern void |
| 143 | sort_pst_symbols PARAMS ((struct partial_symtab *)); |
| 144 | |
| 145 | extern struct symtab * |
| 146 | allocate_symtab PARAMS ((char *, struct objfile *)); |
| 147 | |
| 148 | extern int |
| 149 | free_named_symtabs PARAMS ((char *)); |
| 150 | |
| 151 | extern void |
| 152 | fill_in_vptr_fieldno PARAMS ((struct type *)); |
| 153 | |
| 154 | extern void |
| 155 | add_symtab_fns PARAMS ((struct sym_fns *)); |
| 156 | |
| 157 | extern void |
| 158 | init_entry_point_info PARAMS ((struct objfile *)); |
| 159 | |
| 160 | extern void |
| 161 | syms_from_objfile PARAMS ((struct objfile *, struct section_addr_info *, int, int)); |
| 162 | |
| 163 | extern void |
| 164 | new_symfile_objfile PARAMS ((struct objfile *, int, int)); |
| 165 | |
| 166 | extern struct partial_symtab * |
| 167 | start_psymtab_common PARAMS ((struct objfile *, struct section_offsets *, |
| 168 | char *, CORE_ADDR, |
| 169 | struct partial_symbol **, |
| 170 | struct partial_symbol **)); |
| 171 | |
| 172 | /* Sorting your symbols for fast lookup or alphabetical printing. */ |
| 173 | |
| 174 | extern void |
| 175 | sort_block_syms PARAMS ((struct block *)); |
| 176 | |
| 177 | extern void |
| 178 | sort_symtab_syms PARAMS ((struct symtab *)); |
| 179 | |
| 180 | /* Make a copy of the string at PTR with SIZE characters in the symbol obstack |
| 181 | (and add a null character at the end in the copy). |
| 182 | Returns the address of the copy. */ |
| 183 | |
| 184 | extern char * |
| 185 | obsavestring PARAMS ((char *, int, struct obstack *)); |
| 186 | |
| 187 | /* Concatenate strings S1, S2 and S3; return the new string. |
| 188 | Space is found in the symbol_obstack. */ |
| 189 | |
| 190 | extern char * |
| 191 | obconcat PARAMS ((struct obstack * obstackp, const char *, const char *, |
| 192 | const char *)); |
| 193 | |
| 194 | /* Variables */ |
| 195 | |
| 196 | /* whether to auto load solibs at startup time: 0/1. |
| 197 | |
| 198 | On all platforms, 0 means "don't auto load". |
| 199 | |
| 200 | On HP-UX, > 0 means a threshhold, in megabytes, of symbol table which will |
| 201 | be auto loaded. When the cumulative size of solib symbol table exceeds |
| 202 | this threshhold, solibs' symbol tables will not be loaded. |
| 203 | |
| 204 | On other platforms, > 0 means, "always auto load". |
| 205 | */ |
| 206 | |
| 207 | extern int auto_solib_add; |
| 208 | |
| 209 | /* From symfile.c */ |
| 210 | |
| 211 | extern CORE_ADDR |
| 212 | entry_point_address PARAMS ((void)); |
| 213 | |
| 214 | extern struct partial_symtab * |
| 215 | allocate_psymtab PARAMS ((char *, struct objfile *)); |
| 216 | |
| 217 | extern void |
| 218 | discard_psymtab PARAMS ((struct partial_symtab *)); |
| 219 | |
| 220 | extern void find_lowest_section PARAMS ((bfd *, asection *, PTR)); |
| 221 | |
| 222 | extern bfd *symfile_bfd_open PARAMS ((char *)); |
| 223 | |
| 224 | /* Utility functions for overlay sections: */ |
| 225 | extern int overlay_debugging; |
| 226 | extern int overlay_cache_invalid; |
| 227 | |
| 228 | /* return the "mapped" overlay section containing the PC */ |
| 229 | extern asection * |
| 230 | find_pc_mapped_section PARAMS ((CORE_ADDR)); |
| 231 | |
| 232 | /* return any overlay section containing the PC (even in its LMA region) */ |
| 233 | extern asection * |
| 234 | find_pc_overlay PARAMS ((CORE_ADDR)); |
| 235 | |
| 236 | /* return true if the section is an overlay */ |
| 237 | extern int |
| 238 | section_is_overlay PARAMS ((asection *)); |
| 239 | |
| 240 | /* return true if the overlay section is currently "mapped" */ |
| 241 | extern int |
| 242 | section_is_mapped PARAMS ((asection *)); |
| 243 | |
| 244 | /* return true if pc belongs to section's VMA */ |
| 245 | extern CORE_ADDR |
| 246 | pc_in_mapped_range PARAMS ((CORE_ADDR, asection *)); |
| 247 | |
| 248 | /* return true if pc belongs to section's LMA */ |
| 249 | extern CORE_ADDR |
| 250 | pc_in_unmapped_range PARAMS ((CORE_ADDR, asection *)); |
| 251 | |
| 252 | /* map an address from a section's LMA to its VMA */ |
| 253 | extern CORE_ADDR |
| 254 | overlay_mapped_address PARAMS ((CORE_ADDR, asection *)); |
| 255 | |
| 256 | /* map an address from a section's VMA to its LMA */ |
| 257 | extern CORE_ADDR |
| 258 | overlay_unmapped_address PARAMS ((CORE_ADDR, asection *)); |
| 259 | |
| 260 | /* convert an address in an overlay section (force into VMA range) */ |
| 261 | extern CORE_ADDR |
| 262 | symbol_overlayed_address PARAMS ((CORE_ADDR, asection *)); |
| 263 | |
| 264 | /* From dwarfread.c */ |
| 265 | |
| 266 | extern void |
| 267 | dwarf_build_psymtabs PARAMS ((struct objfile *, int, file_ptr, unsigned int, |
| 268 | file_ptr, unsigned int)); |
| 269 | |
| 270 | /* From dwarf2read.c */ |
| 271 | |
| 272 | extern int dwarf2_has_info PARAMS ((bfd * abfd)); |
| 273 | |
| 274 | extern void dwarf2_build_psymtabs PARAMS ((struct objfile *, int)); |
| 275 | |
| 276 | /* From mdebugread.c */ |
| 277 | |
| 278 | /* Hack to force structures to exist before use in parameter list. */ |
| 279 | struct ecoff_debug_hack |
| 280 | { |
| 281 | struct ecoff_debug_swap *a; |
| 282 | struct ecoff_debug_info *b; |
| 283 | }; |
| 284 | extern void |
| 285 | mdebug_build_psymtabs PARAMS ((struct objfile *, |
| 286 | const struct ecoff_debug_swap *, |
| 287 | struct ecoff_debug_info *)); |
| 288 | |
| 289 | extern void |
| 290 | elfmdebug_build_psymtabs PARAMS ((struct objfile *, |
| 291 | const struct ecoff_debug_swap *, |
| 292 | asection *)); |
| 293 | |
| 294 | #endif /* !defined(SYMFILE_H) */ |