]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gdb/buildsym.h
Copyright updates for 2007.
[thirdparty/binutils-gdb.git] / gdb / buildsym.h
1 /* Build symbol tables in GDB's internal format.
2 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1995, 1996,
3 1997, 1998, 1999, 2000, 2002, 2003, 2007 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., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
21
22 #if !defined (BUILDSYM_H)
23 #define BUILDSYM_H 1
24
25 struct objfile;
26 struct symbol;
27
28 /* This module provides definitions used for creating and adding to
29 the symbol table. These routines are called from various symbol-
30 file-reading routines.
31
32 They originated in dbxread.c of gdb-4.2, and were split out to
33 make xcoffread.c more maintainable by sharing code.
34
35 Variables declared in this file can be defined by #define-ing the
36 name EXTERN to null. It is used to declare variables that are
37 normally extern, but which get defined in a single module using
38 this technique. */
39
40 struct block;
41
42 #ifndef EXTERN
43 #define EXTERN extern
44 #endif
45
46 #define HASHSIZE 127 /* Size of things hashed via
47 hashname() */
48
49 /* Name of source file whose symbol data we are now processing. This
50 comes from a symbol of type N_SO. */
51
52 EXTERN char *last_source_file;
53
54 /* Core address of start of text of current source file. This too
55 comes from the N_SO symbol. */
56
57 EXTERN CORE_ADDR last_source_start_addr;
58
59 /* The list of sub-source-files within the current individual
60 compilation. Each file gets its own symtab with its own linetable
61 and associated info, but they all share one blockvector. */
62
63 struct subfile
64 {
65 struct subfile *next;
66 char *name;
67 char *dirname;
68 struct linetable *line_vector;
69 int line_vector_length;
70 enum language language;
71 char *producer;
72 char *debugformat;
73 };
74
75 EXTERN struct subfile *subfiles;
76
77 EXTERN struct subfile *current_subfile;
78
79 /* Global variable which, when set, indicates that we are processing a
80 .o file compiled with gcc */
81
82 EXTERN unsigned char processing_gcc_compilation;
83
84 /* When set, we are processing a .o file compiled by sun acc. This is
85 misnamed; it refers to all stabs-in-elf implementations which use
86 N_UNDF the way Sun does, including Solaris gcc. Hopefully all
87 stabs-in-elf implementations ever invented will choose to be
88 compatible. */
89
90 EXTERN unsigned char processing_acc_compilation;
91
92 /* Count symbols as they are processed, for error messages. */
93
94 EXTERN unsigned int symnum;
95
96 /* Record the symbols defined for each context in a list. We don't
97 create a struct block for the context until we know how long to
98 make it. */
99
100 #define PENDINGSIZE 100
101
102 struct pending
103 {
104 struct pending *next;
105 int nsyms;
106 struct symbol *symbol[PENDINGSIZE];
107 };
108
109 /* Here are the three lists that symbols are put on. */
110
111 /* static at top level, and types */
112
113 EXTERN struct pending *file_symbols;
114
115 /* global functions and variables */
116
117 EXTERN struct pending *global_symbols;
118
119 /* everything local to lexical context */
120
121 EXTERN struct pending *local_symbols;
122
123 /* func params local to lexical context */
124
125 EXTERN struct pending *param_symbols;
126
127 /* Stack representing unclosed lexical contexts (that will become
128 blocks, eventually). */
129
130 struct context_stack
131 {
132 /* Outer locals at the time we entered */
133
134 struct pending *locals;
135
136 /* Pending func params at the time we entered */
137
138 struct pending *params;
139
140 /* Pointer into blocklist as of entry */
141
142 struct pending_block *old_blocks;
143
144 /* Name of function, if any, defining context */
145
146 struct symbol *name;
147
148 /* PC where this context starts */
149
150 CORE_ADDR start_addr;
151
152 /* Temp slot for exception handling. */
153
154 CORE_ADDR end_addr;
155
156 /* For error-checking matching push/pop */
157
158 int depth;
159
160 };
161
162 EXTERN struct context_stack *context_stack;
163
164 /* Index of first unused entry in context stack. */
165
166 EXTERN int context_stack_depth;
167
168 /* Currently allocated size of context stack. */
169
170 EXTERN int context_stack_size;
171
172 /* Non-zero if the context stack is empty. */
173 #define outermost_context_p() (context_stack_depth == 0)
174
175 /* Nonzero if within a function (so symbols should be local, if
176 nothing says specifically). */
177
178 EXTERN int within_function;
179
180 /* List of blocks already made (lexical contexts already closed).
181 This is used at the end to make the blockvector. */
182
183 struct pending_block
184 {
185 struct pending_block *next;
186 struct block *block;
187 };
188
189 /* Pointer to the head of a linked list of symbol blocks which have
190 already been finalized (lexical contexts already closed) and which
191 are just waiting to be built into a blockvector when finalizing the
192 associated symtab. */
193
194 EXTERN struct pending_block *pending_blocks;
195 \f
196
197 struct subfile_stack
198 {
199 struct subfile_stack *next;
200 char *name;
201 };
202
203 EXTERN struct subfile_stack *subfile_stack;
204
205 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
206
207 /* Function to invoke get the next symbol. Return the symbol name. */
208
209 EXTERN char *(*next_symbol_text_func) (struct objfile *);
210
211 /* Vector of types defined so far, indexed by their type numbers.
212 Used for both stabs and coff. (In newer sun systems, dbx uses a
213 pair of numbers in parens, as in "(SUBFILENUM,NUMWITHINSUBFILE)".
214 Then these numbers must be translated through the type_translations
215 hash table to get the index into the type vector.) */
216
217 EXTERN struct type **type_vector;
218
219 /* Number of elements allocated for type_vector currently. */
220
221 EXTERN int type_vector_length;
222
223 /* Initial size of type vector. Is realloc'd larger if needed, and
224 realloc'd down to the size actually used, when completed. */
225
226 #define INITIAL_TYPE_VECTOR_LENGTH 160
227
228 extern void add_free_pendings (struct pending *list);
229
230 extern void add_symbol_to_list (struct symbol *symbol,
231 struct pending **listhead);
232
233 extern struct symbol *find_symbol_in_list (struct pending *list,
234 char *name, int length);
235
236 extern void finish_block (struct symbol *symbol,
237 struct pending **listhead,
238 struct pending_block *old_blocks,
239 CORE_ADDR start, CORE_ADDR end,
240 struct objfile *objfile);
241
242 extern void really_free_pendings (void *dummy);
243
244 extern void start_subfile (char *name, char *dirname);
245
246 extern void patch_subfile_names (struct subfile *subfile, char *name);
247
248 extern void push_subfile (void);
249
250 extern char *pop_subfile (void);
251
252 extern struct symtab *end_symtab (CORE_ADDR end_addr,
253 struct objfile *objfile, int section);
254
255 /* Defined in stabsread.c. */
256
257 extern void scan_file_globals (struct objfile *objfile);
258
259 extern void buildsym_new_init (void);
260
261 extern void buildsym_init (void);
262
263 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
264
265 extern struct context_stack *pop_context (void);
266
267 extern void record_line (struct subfile *subfile, int line, CORE_ADDR pc);
268
269 extern void start_symtab (char *name, char *dirname, CORE_ADDR start_addr);
270
271 extern int hashname (char *name);
272
273 extern void free_pending_blocks (void);
274
275 /* FIXME: Note that this is used only in buildsym.c and dstread.c,
276 which should be fixed to not need direct access to
277 record_pending_block. */
278
279 extern void record_pending_block (struct objfile *objfile,
280 struct block *block,
281 struct pending_block *opblock);
282
283 extern void record_debugformat (char *format);
284
285 extern void record_producer (const char *producer);
286
287 extern void merge_symbol_lists (struct pending **srclist,
288 struct pending **targetlist);
289
290 /* The macro table for the compilation unit whose symbols we're
291 currently reading. All the symtabs for this CU will point to this. */
292 EXTERN struct macro_table *pending_macros;
293
294 #undef EXTERN
295
296 #endif /* defined (BUILDSYM_H) */