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.
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)
26 /* This module provides definitions used for creating and adding to
27 the symbol table. These routines are called from various symbol-
28 file-reading routines.
30 They originated in dbxread.c of gdb-4.2, and were split out to
31 make xcoffread.c more maintainable by sharing code.
33 Variables declared in this file can be defined by #define-ing the
34 name EXTERN to null. It is used to declare variables that are
35 normally extern, but which get defined in a single module using
44 #define HASHSIZE 127 /* Size of things hashed via
47 /* Name of source file whose symbol data we are now processing. This
48 comes from a symbol of type N_SO. */
50 EXTERN char *last_source_file;
52 /* Core address of start of text of current source file. This too
53 comes from the N_SO symbol. */
55 EXTERN CORE_ADDR last_source_start_addr;
57 /* The list of sub-source-files within the current individual
58 compilation. Each file gets its own symtab with its own linetable
59 and associated info, but they all share one blockvector. */
66 struct linetable *line_vector;
67 int line_vector_length;
68 enum language language;
71 struct symtab *symtab;
74 EXTERN struct subfile *current_subfile;
76 /* Global variable which, when set, indicates that we are processing a
77 .o file compiled with gcc */
79 EXTERN unsigned char processing_gcc_compilation;
81 /* When set, we are processing a .o file compiled by sun acc. This is
82 misnamed; it refers to all stabs-in-elf implementations which use
83 N_UNDF the way Sun does, including Solaris gcc. Hopefully all
84 stabs-in-elf implementations ever invented will choose to be
87 EXTERN unsigned char processing_acc_compilation;
89 /* Count symbols as they are processed, for error messages. */
91 EXTERN unsigned int symnum;
93 /* Record the symbols defined for each context in a list. We don't
94 create a struct block for the context until we know how long to
97 #define PENDINGSIZE 100
101 struct pending *next;
103 struct symbol *symbol[PENDINGSIZE];
106 /* Here are the three lists that symbols are put on. */
108 /* static at top level, and types */
110 EXTERN struct pending *file_symbols;
112 /* global functions and variables */
114 EXTERN struct pending *global_symbols;
116 /* everything local to lexical context */
118 EXTERN struct pending *local_symbols;
120 /* func params local to lexical context */
122 EXTERN struct pending *param_symbols;
124 /* Stack representing unclosed lexical contexts (that will become
125 blocks, eventually). */
129 /* Outer locals at the time we entered */
131 struct pending *locals;
133 /* Pending func params at the time we entered */
135 struct pending *params;
137 /* Pointer into blocklist as of entry */
139 struct pending_block *old_blocks;
141 /* Name of function, if any, defining context */
145 /* PC where this context starts */
147 CORE_ADDR start_addr;
149 /* Temp slot for exception handling. */
153 /* For error-checking matching push/pop */
159 EXTERN struct context_stack *context_stack;
161 /* Index of first unused entry in context stack. */
163 EXTERN int context_stack_depth;
165 /* Currently allocated size of context stack. */
167 EXTERN int context_stack_size;
169 /* Non-zero if the context stack is empty. */
170 #define outermost_context_p() (context_stack_depth == 0)
172 /* Nonzero if within a function (so symbols should be local, if
173 nothing says specifically). */
175 EXTERN int within_function;
177 /* List of blocks already made (lexical contexts already closed).
178 This is used at the end to make the blockvector. */
182 struct pending_block *next;
186 /* Pointer to the head of a linked list of symbol blocks which have
187 already been finalized (lexical contexts already closed) and which
188 are just waiting to be built into a blockvector when finalizing the
189 associated symtab. */
191 EXTERN struct pending_block *pending_blocks;
196 struct subfile_stack *next;
200 EXTERN struct subfile_stack *subfile_stack;
202 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
204 /* Function to invoke get the next symbol. Return the symbol name. */
206 EXTERN char *(*next_symbol_text_func) (struct objfile *);
208 /* Vector of types defined so far, indexed by their type numbers.
209 Used for both stabs and coff. (In newer sun systems, dbx uses a
210 pair of numbers in parens, as in "(SUBFILENUM,NUMWITHINSUBFILE)".
211 Then these numbers must be translated through the type_translations
212 hash table to get the index into the type vector.) */
214 EXTERN struct type **type_vector;
216 /* Number of elements allocated for type_vector currently. */
218 EXTERN int type_vector_length;
220 /* Initial size of type vector. Is realloc'd larger if needed, and
221 realloc'd down to the size actually used, when completed. */
223 #define INITIAL_TYPE_VECTOR_LENGTH 160
225 extern void add_free_pendings (struct pending *list);
227 extern void add_symbol_to_list (struct symbol *symbol,
228 struct pending **listhead);
230 extern struct symbol *find_symbol_in_list (struct pending *list,
231 char *name, int length);
233 extern void finish_block (struct symbol *symbol,
234 struct pending **listhead,
235 struct pending_block *old_blocks,
236 CORE_ADDR start, CORE_ADDR end,
237 struct objfile *objfile);
239 extern void really_free_pendings (void *dummy);
241 extern void start_subfile (char *name, char *dirname);
243 extern void patch_subfile_names (struct subfile *subfile, char *name);
245 extern void push_subfile (void);
247 extern char *pop_subfile (void);
249 extern struct symtab *end_symtab (CORE_ADDR end_addr,
250 struct objfile *objfile, int section);
252 /* Defined in stabsread.c. */
254 extern void scan_file_globals (struct objfile *objfile);
256 extern void buildsym_new_init (void);
258 extern void buildsym_init (void);
260 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
262 extern struct context_stack *pop_context (void);
264 extern void record_line (struct subfile *subfile, int line, CORE_ADDR pc);
266 extern void start_symtab (char *name, char *dirname, CORE_ADDR start_addr);
268 extern int hashname (char *name);
270 extern void free_pending_blocks (void);
272 /* FIXME: Note that this is used only in buildsym.c and dstread.c,
273 which should be fixed to not need direct access to
274 record_pending_block. */
276 extern void record_pending_block (struct objfile *objfile,
278 struct pending_block *opblock);
280 extern void record_debugformat (char *format);
282 extern void record_producer (const char *producer);
284 extern void merge_symbol_lists (struct pending **srclist,
285 struct pending **targetlist);
287 /* The macro table for the compilation unit whose symbols we're
288 currently reading. All the symtabs for this CU will point to this. */
289 EXTERN struct macro_table *pending_macros;
293 #endif /* defined (BUILDSYM_H) */