1 /* Private partial symbol table definitions.
3 Copyright (C) 2009, 2010, 2011 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
25 struct psymbol_allocation_list;
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. */
34 /* This structure is space critical. See space comments at the top of
40 /* The general symbol info required for all types of symbols. */
42 struct general_symbol_info ginfo;
44 /* Name space code. */
46 ENUM_BITFIELD(domain_enum_tag) domain : 6;
48 /* Address class (for info_symbols) */
50 ENUM_BITFIELD(address_class) aclass : 6;
54 #define PSYMBOL_DOMAIN(psymbol) (psymbol)->domain
55 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
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.
63 Even after the source file has been read into a symtab, the
64 partial_symtab remains around. They are allocated on an obstack,
70 /* Chain of all existing partial symtabs. */
72 struct partial_symtab *next;
74 /* Name of the source file which this partial_symtab defines */
78 /* Full path of the source file. NULL if not known. */
82 /* Directory in which it was compiled, or NULL if we don't know. */
86 /* Information about the object file from which symbols should be read. */
88 struct objfile *objfile;
90 /* Set of relocation offsets to apply to each section. */
92 struct section_offsets *section_offsets;
94 /* Range of text addresses covered by this file; texthigh is the
95 beginning of the next section. */
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. */
109 struct partial_symtab **dependencies;
111 int number_of_dependencies;
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[]. */
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[]. */
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. */
136 unsigned char readin;
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. */
141 struct symtab *symtab;
143 /* Pointer to function which will read in the symtab corresponding to
146 void (*read_symtab) (struct partial_symtab *);
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. */
153 void *read_symtab_private;
156 extern void sort_pst_symbols (struct partial_symtab *);
158 /* Add any kind of symbol to a psymbol_allocation_list. */
161 struct partial_symbol *add_psymbol_to_list (const char *, int,
164 struct psymbol_allocation_list *,
166 enum language, struct objfile *);
168 extern void init_psymbol_list (struct objfile *, int);
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 **);
176 extern struct partial_symtab *allocate_psymtab (const char *,
179 extern void discard_psymtab (struct partial_symtab *);
181 /* Traverse all psymtabs in one objfile. */
183 #define ALL_OBJFILE_PSYMTABS(objfile, p) \
184 for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next)
186 /* Traverse all psymtabs in all objfiles. */
188 #define ALL_PSYMTABS(objfile, p) \
189 ALL_OBJFILES (objfile) \
190 ALL_OBJFILE_PSYMTABS (objfile, p)
192 #endif /* PSYMPRIV_H */