1 /* Build symbol tables in GDB's internal format.
2 Copyright (C) 1986-1993, 1995-2000, 2002-2003, 2007-2012 Free
3 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/>. */
20 #if !defined (BUILDSYM_H)
27 /* This module provides definitions used for creating and adding to
28 the symbol table. These routines are called from various symbol-
29 file-reading routines.
31 They originated in dbxread.c of gdb-4.2, and were split out to
32 make xcoffread.c more maintainable by sharing code.
34 Variables declared in this file can be defined by #define-ing the
35 name EXTERN to null. It is used to declare variables that are
36 normally extern, but which get defined in a single module using
45 #define HASHSIZE 127 /* Size of things hashed via
48 /* Name of source file whose symbol data we are now processing. This
49 comes from a symbol of type N_SO for stabs. For Dwarf it comes
50 from the DW_AT_name attribute of a DW_TAG_compile_unit DIE. */
52 EXTERN char *last_source_file;
54 /* Core address of start of text of current source file. This too
55 comes from the N_SO symbol. For Dwarf it typically comes from the
56 DW_AT_low_pc attribute of a DW_TAG_compile_unit DIE. */
58 EXTERN CORE_ADDR last_source_start_addr;
60 /* The list of sub-source-files within the current individual
61 compilation. Each file gets its own symtab with its own linetable
62 and associated info, but they all share one blockvector. */
69 struct linetable *line_vector;
70 int line_vector_length;
71 enum language language;
73 const char *debugformat;
74 struct symtab *symtab;
77 EXTERN struct subfile *current_subfile;
79 /* Global variable which, when set, indicates that we are processing a
80 .o file compiled with gcc */
82 EXTERN unsigned char processing_gcc_compilation;
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
90 EXTERN unsigned char processing_acc_compilation;
92 /* Count symbols as they are processed, for error messages. */
94 EXTERN unsigned int symnum;
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
100 #define PENDINGSIZE 100
104 struct pending *next;
106 struct symbol *symbol[PENDINGSIZE];
109 /* Here are the three lists that symbols are put on. */
111 /* static at top level, and types */
113 EXTERN struct pending *file_symbols;
115 /* global functions and variables */
117 EXTERN struct pending *global_symbols;
119 /* everything local to lexical context */
121 EXTERN struct pending *local_symbols;
123 /* func params local to lexical context */
125 EXTERN struct pending *param_symbols;
127 /* "using" directives local to lexical context. */
129 EXTERN struct using_direct *using_directives;
131 /* Stack representing unclosed lexical contexts (that will become
132 blocks, eventually). */
136 /* Outer locals at the time we entered */
138 struct pending *locals;
140 /* Pending func params at the time we entered */
142 struct pending *params;
144 /* Pending using directives at the time we entered. */
146 struct using_direct *using_directives;
148 /* Pointer into blocklist as of entry */
150 struct pending_block *old_blocks;
152 /* Name of function, if any, defining context */
156 /* PC where this context starts */
158 CORE_ADDR start_addr;
160 /* Temp slot for exception handling. */
164 /* For error-checking matching push/pop */
170 EXTERN struct context_stack *context_stack;
172 /* Index of first unused entry in context stack. */
174 EXTERN int context_stack_depth;
176 /* Currently allocated size of context stack. */
178 EXTERN int context_stack_size;
180 /* Non-zero if the context stack is empty. */
181 #define outermost_context_p() (context_stack_depth == 0)
183 /* Nonzero if within a function (so symbols should be local, if
184 nothing says specifically). */
186 EXTERN int within_function;
188 /* List of blocks already made (lexical contexts already closed).
189 This is used at the end to make the blockvector. */
193 struct pending_block *next;
197 /* Pointer to the head of a linked list of symbol blocks which have
198 already been finalized (lexical contexts already closed) and which
199 are just waiting to be built into a blockvector when finalizing the
200 associated symtab. */
202 EXTERN struct pending_block *pending_blocks;
207 struct subfile_stack *next;
211 EXTERN struct subfile_stack *subfile_stack;
213 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
215 /* Function to invoke get the next symbol. Return the symbol name. */
217 EXTERN char *(*next_symbol_text_func) (struct objfile *);
219 /* Vector of types defined so far, indexed by their type numbers.
220 Used for both stabs and coff. (In newer sun systems, dbx uses a
221 pair of numbers in parens, as in "(SUBFILENUM,NUMWITHINSUBFILE)".
222 Then these numbers must be translated through the type_translations
223 hash table to get the index into the type vector.) */
225 EXTERN struct type **type_vector;
227 /* Number of elements allocated for type_vector currently. */
229 EXTERN int type_vector_length;
231 /* Initial size of type vector. Is realloc'd larger if needed, and
232 realloc'd down to the size actually used, when completed. */
234 #define INITIAL_TYPE_VECTOR_LENGTH 160
236 extern void add_symbol_to_list (struct symbol *symbol,
237 struct pending **listhead);
239 extern struct symbol *find_symbol_in_list (struct pending *list,
240 char *name, int length);
242 extern struct block *finish_block (struct symbol *symbol,
243 struct pending **listhead,
244 struct pending_block *old_blocks,
245 CORE_ADDR start, CORE_ADDR end,
246 struct objfile *objfile);
248 extern void record_block_range (struct block *,
249 CORE_ADDR start, CORE_ADDR end_inclusive);
251 extern void really_free_pendings (void *dummy);
253 extern void start_subfile (const char *name, const char *dirname);
255 extern void patch_subfile_names (struct subfile *subfile, char *name);
257 extern void push_subfile (void);
259 extern char *pop_subfile (void);
261 extern struct block *end_symtab_get_static_block (CORE_ADDR end_addr,
262 struct objfile *objfile,
265 extern struct symtab *end_symtab_from_static_block (struct block *static_block,
266 struct objfile *objfile,
270 extern struct symtab *end_symtab (CORE_ADDR end_addr,
271 struct objfile *objfile, int section);
273 extern struct symtab *end_expandable_symtab (CORE_ADDR end_addr,
274 struct objfile *objfile,
277 extern void augment_type_symtab (struct objfile *objfile,
278 struct symtab *primary_symtab);
280 /* Defined in stabsread.c. */
282 extern void scan_file_globals (struct objfile *objfile);
284 extern void buildsym_new_init (void);
286 extern void buildsym_init (void);
288 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
290 extern struct context_stack *pop_context (void);
292 extern void record_line (struct subfile *subfile, int line, CORE_ADDR pc);
294 extern void start_symtab (char *name, char *dirname, CORE_ADDR start_addr);
296 extern void restart_symtab (CORE_ADDR start_addr);
298 extern int hashname (const char *name);
300 extern void free_pending_blocks (void);
302 /* Record the name of the debug format in the current pending symbol
303 table. FORMAT must be a string with a lifetime at least as long as
304 the symtab's objfile. */
306 extern void record_debugformat (const char *format);
308 /* Record the name of the debuginfo producer (usually the compiler) in
309 the current pending symbol table. PRODUCER must be a string with a
310 lifetime at least as long as the symtab's objfile. */
312 extern void record_producer (const char *producer);
314 extern void merge_symbol_lists (struct pending **srclist,
315 struct pending **targetlist);
317 /* The macro table for the compilation unit whose symbols we're
318 currently reading. All the symtabs for this CU will point to
320 EXTERN struct macro_table *pending_macros;
324 #endif /* defined (BUILDSYM_H) */