1 /* Private partial symbol table definitions. 2 3 Copyright (C) 2009-2012 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 3 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, see <http://www.gnu.org/licenses/>. */ 19 20 #ifndef PSYMPRIV_H 21 #define PSYMPRIV_H 22 23 #include "psymtab.h" 24 25 struct psymbol_allocation_list; 26 27 /* A partial_symbol records the name, domain, and address class of 28 symbols whose types we have not parsed yet. For functions, it also 29 contains their memory address, so we can find them from a PC value. 30 Each partial_symbol sits in a partial_symtab, all of which are chained 31 on a partial symtab list and which points to the corresponding 32 normal symtab once the partial_symtab has been referenced. */ 33 34 /* This structure is space critical. See space comments at the top of 35 symtab.h. */ 36 37 struct partial_symbol 38 { 39 40 /* The general symbol info required for all types of symbols. */ 41 42 struct general_symbol_info ginfo; 43 44 /* Name space code. */ 45 46 ENUM_BITFIELD(domain_enum_tag) domain : 6; 47 48 /* Address class (for info_symbols). */ 49 50 ENUM_BITFIELD(address_class) aclass : 6; 51 52 }; 53 54 #define PSYMBOL_DOMAIN(psymbol) (psymbol)->domain 55 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass 56 57 /* Each source file that has not been fully read in is represented by 58 a partial_symtab. This contains the information on where in the 59 executable the debugging symbols for a specific file are, and a 60 list of names of global symbols which are located in this file. 61 They are all chained on partial symtab lists. 62 63 Even after the source file has been read into a symtab, the 64 partial_symtab remains around. They are allocated on an obstack, 65 objfile_obstack. */ 66 67 struct partial_symtab 68 { 69 70 /* Chain of all existing partial symtabs. */ 71 72 struct partial_symtab *next; 73 74 /* Name of the source file which this partial_symtab defines. */ 75 76 const char *filename; 77 78 /* Full path of the source file. NULL if not known. */ 79 80 char *fullname; 81 82 /* Directory in which it was compiled, or NULL if we don't know. */ 83 84 const char *dirname; 85 86 /* Information about the object file from which symbols should be read. */ 87 88 struct objfile *objfile; 89 90 /* Set of relocation offsets to apply to each section. */ 91 92 struct section_offsets *section_offsets; 93 94 /* Range of text addresses covered by this file; texthigh is the 95 beginning of the next section. Do not use if PSYMTABS_ADDRMAP_SUPPORTED 96 is set. */ 97 98 CORE_ADDR textlow; 99 CORE_ADDR texthigh; 100 101 /* Array of pointers to all of the partial_symtab's which this one 102 depends on. Since this array can only be set to previous or 103 the current (?) psymtab, this dependency tree is guaranteed not 104 to have any loops. "depends on" means that symbols must be read 105 for the dependencies before being read for this psymtab; this is 106 for type references in stabs, where if foo.c includes foo.h, declarations 107 in foo.h may use type numbers defined in foo.c. For other debugging 108 formats there may be no need to use dependencies. */ 109 110 struct partial_symtab **dependencies; 111 112 int number_of_dependencies; 113 114 /* Global symbol list. This list will be sorted after readin to 115 improve access. Binary search will be the usual method of 116 finding a symbol within it. globals_offset is an integer offset 117 within global_psymbols[]. */ 118 119 int globals_offset; 120 int n_global_syms; 121 122 /* Static symbol list. This list will *not* be sorted after readin; 123 to find a symbol in it, exhaustive search must be used. This is 124 reasonable because searches through this list will eventually 125 lead to either the read in of a files symbols for real (assumed 126 to take a *lot* of time; check) or an error (and we don't care 127 how long errors take). This is an offset and size within 128 static_psymbols[]. */ 129 130 int statics_offset; 131 int n_static_syms; 132 133 /* Non-zero if the symtab corresponding to this psymtab has been 134 readin. This is located here so that this structure packs better 135 on 64-bit systems. */ 136 137 unsigned char readin; 138 139 /* True iff objfile->psymtabs_addrmap is properly populated for this 140 partial_symtab. For discontiguous overlapping psymtabs is the only usable 141 info in PSYMTABS_ADDRMAP. */ 142 143 unsigned char psymtabs_addrmap_supported; 144 145 /* Pointer to symtab eventually allocated for this source file, 0 if 146 !readin or if we haven't looked for the symtab after it was readin. */ 147 148 struct symtab *symtab; 149 150 /* Pointer to function which will read in the symtab corresponding to 151 this psymtab. */ 152 153 void (*read_symtab) (struct partial_symtab *); 154 155 /* Information that lets read_symtab() locate the part of the symbol table 156 that this psymtab corresponds to. This information is private to the 157 format-dependent symbol reading routines. For further detail examine 158 the various symbol reading modules. */ 159 160 void *read_symtab_private; 161 }; 162 163 extern void sort_pst_symbols (struct partial_symtab *); 164 165 /* Add any kind of symbol to a psymbol_allocation_list. */ 166 167 extern const 168 struct partial_symbol *add_psymbol_to_list (const char *, int, 169 int, domain_enum, 170 enum address_class, 171 struct psymbol_allocation_list *, 172 long, CORE_ADDR, 173 enum language, struct objfile *); 174 175 extern void init_psymbol_list (struct objfile *, int); 176 177 extern struct partial_symtab *start_psymtab_common (struct objfile *, 178 struct section_offsets *, 179 const char *, CORE_ADDR, 180 struct partial_symbol **, 181 struct partial_symbol **); 182 183 extern struct partial_symtab *allocate_psymtab (const char *, 184 struct objfile *); 185 186 extern void discard_psymtab (struct partial_symtab *); 187 188 /* Traverse all psymtabs in one objfile. */ 189 190 #define ALL_OBJFILE_PSYMTABS(objfile, p) \ 191 for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next) 192 193 #endif /* PSYMPRIV_H */ 194