| 1 | /* Private partial symbol table definitions. |
| 2 | |
| 3 | Copyright (C) 2009, 2010, 2011 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. */ |
| 96 | |
| 97 | CORE_ADDR textlow; |
| 98 | CORE_ADDR texthigh; |
| 99 | |
| 100 | /* Array of pointers to all of the partial_symtab's which this one |
| 101 | depends on. Since this array can only be set to previous or |
| 102 | the current (?) psymtab, this dependency tree is guaranteed not |
| 103 | to have any loops. "depends on" means that symbols must be read |
| 104 | for the dependencies before being read for this psymtab; this is |
| 105 | for type references in stabs, where if foo.c includes foo.h, declarations |
| 106 | in foo.h may use type numbers defined in foo.c. For other debugging |
| 107 | formats there may be no need to use dependencies. */ |
| 108 | |
| 109 | struct partial_symtab **dependencies; |
| 110 | |
| 111 | int number_of_dependencies; |
| 112 | |
| 113 | /* Global symbol list. This list will be sorted after readin to |
| 114 | improve access. Binary search will be the usual method of |
| 115 | finding a symbol within it. globals_offset is an integer offset |
| 116 | within global_psymbols[]. */ |
| 117 | |
| 118 | int globals_offset; |
| 119 | int n_global_syms; |
| 120 | |
| 121 | /* Static symbol list. This list will *not* be sorted after readin; |
| 122 | to find a symbol in it, exhaustive search must be used. This is |
| 123 | reasonable because searches through this list will eventually |
| 124 | lead to either the read in of a files symbols for real (assumed |
| 125 | to take a *lot* of time; check) or an error (and we don't care |
| 126 | how long errors take). This is an offset and size within |
| 127 | static_psymbols[]. */ |
| 128 | |
| 129 | int statics_offset; |
| 130 | int n_static_syms; |
| 131 | |
| 132 | /* Non-zero if the symtab corresponding to this psymtab has been |
| 133 | readin. This is located here so that this structure packs better |
| 134 | on 64-bit systems. */ |
| 135 | |
| 136 | unsigned char readin; |
| 137 | |
| 138 | /* Pointer to symtab eventually allocated for this source file, 0 if |
| 139 | !readin or if we haven't looked for the symtab after it was readin. */ |
| 140 | |
| 141 | struct symtab *symtab; |
| 142 | |
| 143 | /* Pointer to function which will read in the symtab corresponding to |
| 144 | this psymtab. */ |
| 145 | |
| 146 | void (*read_symtab) (struct partial_symtab *); |
| 147 | |
| 148 | /* Information that lets read_symtab() locate the part of the symbol table |
| 149 | that this psymtab corresponds to. This information is private to the |
| 150 | format-dependent symbol reading routines. For further detail examine |
| 151 | the various symbol reading modules. */ |
| 152 | |
| 153 | void *read_symtab_private; |
| 154 | }; |
| 155 | |
| 156 | extern void sort_pst_symbols (struct partial_symtab *); |
| 157 | |
| 158 | /* Add any kind of symbol to a psymbol_allocation_list. */ |
| 159 | |
| 160 | extern const |
| 161 | struct partial_symbol *add_psymbol_to_list (const char *, int, |
| 162 | int, domain_enum, |
| 163 | enum address_class, |
| 164 | struct psymbol_allocation_list *, |
| 165 | long, CORE_ADDR, |
| 166 | enum language, struct objfile *); |
| 167 | |
| 168 | extern void init_psymbol_list (struct objfile *, int); |
| 169 | |
| 170 | extern struct partial_symtab *start_psymtab_common (struct objfile *, |
| 171 | struct section_offsets *, |
| 172 | const char *, CORE_ADDR, |
| 173 | struct partial_symbol **, |
| 174 | struct partial_symbol **); |
| 175 | |
| 176 | extern struct partial_symtab *allocate_psymtab (const char *, |
| 177 | struct objfile *); |
| 178 | |
| 179 | extern void discard_psymtab (struct partial_symtab *); |
| 180 | |
| 181 | /* Traverse all psymtabs in one objfile. */ |
| 182 | |
| 183 | #define ALL_OBJFILE_PSYMTABS(objfile, p) \ |
| 184 | for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next) |
| 185 | |
| 186 | #endif /* PSYMPRIV_H */ |