Upgrade GDB from 7.4.1 to 7.6.1 on the vendor branch
[dragonfly.git] / contrib / gdb-7 / gdb / psympriv.h
CommitLineData
cf7f2e2d
JM
1/* Private partial symbol table definitions.
2
ef5ccd6c 3 Copyright (C) 2009-2013 Free Software Foundation, Inc.
cf7f2e2d
JM
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
c50c785c
JM
25struct psymbol_allocation_list;
26
cf7f2e2d
JM
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
c50c785c 35 symtab.h. */
cf7f2e2d
JM
36
37struct partial_symbol
38{
39
c50c785c 40 /* The general symbol info required for all types of symbols. */
cf7f2e2d
JM
41
42 struct general_symbol_info ginfo;
43
44 /* Name space code. */
45
46 ENUM_BITFIELD(domain_enum_tag) domain : 6;
47
c50c785c 48 /* Address class (for info_symbols). */
cf7f2e2d
JM
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
ef5ccd6c
JM
57/* A convenience enum to give names to some constants used when
58 searching psymtabs. This is internal to psymtab and should not be
59 used elsewhere. */
60
61enum psymtab_search_status
62 {
63 PST_NOT_SEARCHED,
64 PST_SEARCHED_AND_FOUND,
65 PST_SEARCHED_AND_NOT_FOUND
66 };
67
cf7f2e2d
JM
68/* Each source file that has not been fully read in is represented by
69 a partial_symtab. This contains the information on where in the
70 executable the debugging symbols for a specific file are, and a
71 list of names of global symbols which are located in this file.
72 They are all chained on partial symtab lists.
73
74 Even after the source file has been read into a symtab, the
75 partial_symtab remains around. They are allocated on an obstack,
76 objfile_obstack. */
77
78struct partial_symtab
79{
80
81 /* Chain of all existing partial symtabs. */
82
83 struct partial_symtab *next;
84
ef5ccd6c
JM
85 /* Name of the source file which this partial_symtab defines,
86 or if the psymtab is anonymous then a descriptive name for
87 debugging purposes, or "". It must not be NULL. */
cf7f2e2d 88
c50c785c 89 const char *filename;
cf7f2e2d
JM
90
91 /* Full path of the source file. NULL if not known. */
92
93 char *fullname;
94
95 /* Directory in which it was compiled, or NULL if we don't know. */
96
c50c785c 97 const char *dirname;
cf7f2e2d 98
cf7f2e2d
JM
99 /* Set of relocation offsets to apply to each section. */
100
101 struct section_offsets *section_offsets;
102
103 /* Range of text addresses covered by this file; texthigh is the
a45ae5f8
JM
104 beginning of the next section. Do not use if PSYMTABS_ADDRMAP_SUPPORTED
105 is set. */
cf7f2e2d
JM
106
107 CORE_ADDR textlow;
108 CORE_ADDR texthigh;
109
110 /* Array of pointers to all of the partial_symtab's which this one
111 depends on. Since this array can only be set to previous or
112 the current (?) psymtab, this dependency tree is guaranteed not
113 to have any loops. "depends on" means that symbols must be read
114 for the dependencies before being read for this psymtab; this is
115 for type references in stabs, where if foo.c includes foo.h, declarations
116 in foo.h may use type numbers defined in foo.c. For other debugging
117 formats there may be no need to use dependencies. */
118
119 struct partial_symtab **dependencies;
120
121 int number_of_dependencies;
122
ef5ccd6c
JM
123 /* If NULL, this is an ordinary partial symbol table.
124
125 If non-NULL, this holds a single includer of this partial symbol
126 table, and this partial symbol table is a shared one.
127
128 A shared psymtab is one that is referenced by multiple other
129 psymtabs, and which conceptually has its contents directly
130 included in those.
131
132 Shared psymtabs have special semantics. When a search finds a
133 symbol in a shared table, we instead return one of the non-shared
134 tables that include this one.
135
136 A shared psymtabs can be referred to by other shared ones.
137
138 The psymtabs that refer to a shared psymtab will list the shared
139 psymtab in their 'dependencies' array.
140
141 In DWARF terms, a shared psymtab is a DW_TAG_partial_unit; but
142 of course using a name based on that would be too confusing, so
143 "shared" was chosen instead.
144
145 Only a single user is needed because, when expanding a shared
146 psymtab, we only need to expand its "canonical" non-shared user.
147 The choice of which one should be canonical is left to the
148 debuginfo reader; it can be arbitrary. */
149
150 struct partial_symtab *user;
151
cf7f2e2d
JM
152 /* Global symbol list. This list will be sorted after readin to
153 improve access. Binary search will be the usual method of
c50c785c 154 finding a symbol within it. globals_offset is an integer offset
cf7f2e2d
JM
155 within global_psymbols[]. */
156
157 int globals_offset;
158 int n_global_syms;
159
160 /* Static symbol list. This list will *not* be sorted after readin;
161 to find a symbol in it, exhaustive search must be used. This is
162 reasonable because searches through this list will eventually
163 lead to either the read in of a files symbols for real (assumed
164 to take a *lot* of time; check) or an error (and we don't care
165 how long errors take). This is an offset and size within
166 static_psymbols[]. */
167
168 int statics_offset;
169 int n_static_syms;
170
c50c785c
JM
171 /* Non-zero if the symtab corresponding to this psymtab has been
172 readin. This is located here so that this structure packs better
173 on 64-bit systems. */
174
175 unsigned char readin;
176
a45ae5f8
JM
177 /* True iff objfile->psymtabs_addrmap is properly populated for this
178 partial_symtab. For discontiguous overlapping psymtabs is the only usable
179 info in PSYMTABS_ADDRMAP. */
180
181 unsigned char psymtabs_addrmap_supported;
182
ef5ccd6c
JM
183 /* True if the name of this partial symtab is not a source file name. */
184
185 unsigned char anonymous;
186
187 /* A flag that is temporarily used when searching psymtabs. */
188
189 ENUM_BITFIELD (psymtab_search_status) searched_flag : 2;
190
cf7f2e2d
JM
191 /* Pointer to symtab eventually allocated for this source file, 0 if
192 !readin or if we haven't looked for the symtab after it was readin. */
193
194 struct symtab *symtab;
195
196 /* Pointer to function which will read in the symtab corresponding to
197 this psymtab. */
198
ef5ccd6c 199 void (*read_symtab) (struct partial_symtab *, struct objfile *);
cf7f2e2d
JM
200
201 /* Information that lets read_symtab() locate the part of the symbol table
202 that this psymtab corresponds to. This information is private to the
203 format-dependent symbol reading routines. For further detail examine
204 the various symbol reading modules. */
205
206 void *read_symtab_private;
cf7f2e2d
JM
207};
208
ef5ccd6c 209extern void sort_pst_symbols (struct objfile *, struct partial_symtab *);
cf7f2e2d 210
c50c785c
JM
211/* Add any kind of symbol to a psymbol_allocation_list. */
212
ef5ccd6c
JM
213extern void add_psymbol_to_list (const char *, int,
214 int, domain_enum,
215 enum address_class,
216 struct psymbol_allocation_list *,
217 long, CORE_ADDR,
218 enum language, struct objfile *);
c50c785c
JM
219
220extern void init_psymbol_list (struct objfile *, int);
221
222extern struct partial_symtab *start_psymtab_common (struct objfile *,
223 struct section_offsets *,
224 const char *, CORE_ADDR,
225 struct partial_symbol **,
226 struct partial_symbol **);
227
228extern struct partial_symtab *allocate_psymtab (const char *,
ef5ccd6c
JM
229 struct objfile *)
230 ATTRIBUTE_NONNULL (1);
231
232extern void discard_psymtab (struct objfile *, struct partial_symtab *);
c50c785c 233
ef5ccd6c 234extern struct cleanup *make_cleanup_discard_psymtabs (struct objfile *);
c50c785c 235
cf7f2e2d
JM
236/* Traverse all psymtabs in one objfile. */
237
238#define ALL_OBJFILE_PSYMTABS(objfile, p) \
239 for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next)
240
cf7f2e2d 241#endif /* PSYMPRIV_H */