1 /* Build symbol tables in GDB's internal format.
2 Copyright (C) 1986-2018 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #if !defined (BUILDSYM_H)
25 struct compunit_symtab;
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.
32 They originated in dbxread.c of gdb-4.2, and were split out to
33 make xcoffread.c more maintainable by sharing code.
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
49 #define HASHSIZE 127 /* Size of things hashed via
52 /* The list of sub-source-files within the current individual
53 compilation. Each file gets its own symtab with its own linetable
54 and associated info, but they all share one blockvector. */
59 /* Space for this is malloc'd. */
61 /* Space for this is malloc'd. */
62 struct linetable *line_vector;
63 int line_vector_length;
64 /* The "containing" compunit. */
65 struct buildsym_compunit *buildsym_compunit;
66 enum language language;
67 struct symtab *symtab;
70 EXTERN struct subfile *current_subfile;
72 /* Global variable which, when set, indicates that we are processing a
73 .o file compiled with gcc */
75 EXTERN unsigned char processing_gcc_compilation;
77 /* When set, we are processing a .o file compiled by sun acc. This is
78 misnamed; it refers to all stabs-in-elf implementations which use
79 N_UNDF the way Sun does, including Solaris gcc. Hopefully all
80 stabs-in-elf implementations ever invented will choose to be
83 EXTERN unsigned char processing_acc_compilation;
85 /* Count symbols as they are processed, for error messages. */
87 EXTERN unsigned int symnum;
89 /* Record the symbols defined for each context in a list. We don't
90 create a struct block for the context until we know how long to
93 #define PENDINGSIZE 100
99 struct symbol *symbol[PENDINGSIZE];
102 /* Here are the three lists that symbols are put on. */
104 /* static at top level, and types */
106 EXTERN struct pending *file_symbols;
108 /* global functions and variables */
110 EXTERN struct pending *global_symbols;
112 /* everything local to lexical context */
114 EXTERN struct pending *local_symbols;
116 /* "using" directives local to lexical context. */
118 EXTERN struct using_direct *local_using_directives;
120 /* global "using" directives. */
122 EXTERN struct using_direct *global_using_directives;
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 using directives at the time we entered. */
135 struct using_direct *local_using_directives;
137 /* Pointer into blocklist as of entry */
139 struct pending_block *old_blocks;
141 /* Name of function, if any, defining context */
145 /* Expression that computes the frame base of the lexically enclosing
146 function, if any. NULL otherwise. */
148 struct dynamic_prop *static_link;
150 /* PC where this context starts */
152 CORE_ADDR start_addr;
154 /* Temp slot for exception handling. */
158 /* For error-checking matching push/pop */
164 EXTERN struct context_stack *context_stack;
166 /* Index of first unused entry in context stack. */
168 EXTERN int context_stack_depth;
170 /* Currently allocated size of context stack. */
172 EXTERN int context_stack_size;
174 /* Non-zero if the context stack is empty. */
175 #define outermost_context_p() (context_stack_depth == 0)
177 /* Nonzero if within a function (so symbols should be local, if
178 nothing says specifically). */
180 EXTERN int within_function;
182 /* The type of the record_line function. */
183 typedef void (record_line_ftype) (struct subfile *subfile, int line,
188 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
190 /* Function to invoke get the next symbol. Return the symbol name. */
192 EXTERN const char *(*next_symbol_text_func) (struct objfile *);
194 extern void add_symbol_to_list (struct symbol *symbol,
195 struct pending **listhead);
197 extern struct symbol *find_symbol_in_list (struct pending *list,
198 char *name, int length);
200 extern struct block *finish_block (struct symbol *symbol,
201 struct pending **listhead,
202 struct pending_block *old_blocks,
203 const struct dynamic_prop *static_link,
207 extern void record_block_range (struct block *,
208 CORE_ADDR start, CORE_ADDR end_inclusive);
210 class scoped_free_pendings
214 scoped_free_pendings () = default;
215 ~scoped_free_pendings ();
217 DISABLE_COPY_AND_ASSIGN (scoped_free_pendings);
220 extern void start_subfile (const char *name);
222 extern void patch_subfile_names (struct subfile *subfile, const char *name);
224 extern void push_subfile (void);
226 extern char *pop_subfile (void);
228 extern struct block *end_symtab_get_static_block (CORE_ADDR end_addr,
232 extern struct compunit_symtab *
233 end_symtab_from_static_block (struct block *static_block,
234 int section, int expandable);
236 extern struct compunit_symtab *end_symtab (CORE_ADDR end_addr, int section);
238 extern struct compunit_symtab *end_expandable_symtab (CORE_ADDR end_addr,
241 extern void augment_type_symtab (void);
243 /* Defined in stabsread.c. */
245 extern void scan_file_globals (struct objfile *objfile);
247 extern void buildsym_new_init (void);
249 extern void buildsym_init (void);
251 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
253 extern struct context_stack *pop_context (void);
255 extern record_line_ftype record_line;
257 extern struct compunit_symtab *start_symtab (struct objfile *objfile,
259 const char *comp_dir,
260 CORE_ADDR start_addr,
261 enum language language);
263 extern void restart_symtab (struct compunit_symtab *cust,
264 const char *name, CORE_ADDR start_addr);
266 extern int hashname (const char *name);
268 extern void free_pending_blocks (void);
270 /* Record the name of the debug format in the current pending symbol
271 table. FORMAT must be a string with a lifetime at least as long as
272 the symtab's objfile. */
274 extern void record_debugformat (const char *format);
276 /* Record the name of the debuginfo producer (usually the compiler) in
277 the current pending symbol table. PRODUCER must be a string with a
278 lifetime at least as long as the symtab's objfile. */
280 extern void record_producer (const char *producer);
282 extern void merge_symbol_lists (struct pending **srclist,
283 struct pending **targetlist);
285 /* Set the name of the last source file. NAME is copied by this
288 extern void set_last_source_file (const char *name);
290 /* Fetch the name of the last source file. */
292 extern const char *get_last_source_file (void);
294 /* Return the compunit symtab object.
295 It is only valid to call this between calls to start_symtab and the
296 end_symtab* functions. */
298 extern struct compunit_symtab *buildsym_compunit_symtab (void);
300 /* Return the macro table.
301 Initialize it if this is the first use.
302 It is only valid to call this between calls to start_symtab and the
303 end_symtab* functions. */
305 extern struct macro_table *get_macro_table (void);
307 /* Set the last source start address. Can only be used between
308 start_symtab and end_symtab* calls. */
310 extern void set_last_source_start_addr (CORE_ADDR addr);
312 /* Get the last source start address. Can only be used between
313 start_symtab and end_symtab* calls. */
315 extern CORE_ADDR get_last_source_start_addr ();
319 #endif /* defined (BUILDSYM_H) */