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 /* Count symbols as they are processed, for error messages. */
79 EXTERN
unsigned int symnum
;
81 /* Record the symbols defined for each context in a list. We don't
82 create a struct block for the context until we know how long to
85 #define PENDINGSIZE 100
91 struct symbol
*symbol
[PENDINGSIZE
];
94 /* Here are the three lists that symbols are put on. */
96 /* static at top level, and types */
98 EXTERN
struct pending
*file_symbols
;
100 /* global functions and variables */
102 EXTERN
struct pending
*global_symbols
;
104 /* everything local to lexical context */
106 EXTERN
struct pending
*local_symbols
;
108 /* "using" directives local to lexical context. */
110 EXTERN
struct using_direct
*local_using_directives
;
112 /* global "using" directives. */
114 EXTERN
struct using_direct
*global_using_directives
;
116 /* Stack representing unclosed lexical contexts (that will become
117 blocks, eventually). */
121 /* Outer locals at the time we entered */
123 struct pending
*locals
;
125 /* Pending using directives at the time we entered. */
127 struct using_direct
*local_using_directives
;
129 /* Pointer into blocklist as of entry */
131 struct pending_block
*old_blocks
;
133 /* Name of function, if any, defining context */
137 /* Expression that computes the frame base of the lexically enclosing
138 function, if any. NULL otherwise. */
140 struct dynamic_prop
*static_link
;
142 /* PC where this context starts */
144 CORE_ADDR start_addr
;
146 /* Temp slot for exception handling. */
150 /* For error-checking matching push/pop */
156 EXTERN
struct context_stack
*context_stack
;
158 /* Index of first unused entry in context stack. */
160 EXTERN
int context_stack_depth
;
162 /* Non-zero if the context stack is empty. */
163 #define outermost_context_p() (context_stack_depth == 0)
165 /* Nonzero if within a function (so symbols should be local, if
166 nothing says specifically). */
168 EXTERN
int within_function
;
170 /* The type of the record_line function. */
171 typedef void (record_line_ftype
) (struct subfile
*subfile
, int line
,
176 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
178 /* Function to invoke get the next symbol. Return the symbol name. */
180 EXTERN
const char *(*next_symbol_text_func
) (struct objfile
*);
182 extern void add_symbol_to_list (struct symbol
*symbol
,
183 struct pending
**listhead
);
185 extern struct symbol
*find_symbol_in_list (struct pending
*list
,
186 char *name
, int length
);
188 extern struct block
*finish_block (struct symbol
*symbol
,
189 struct pending
**listhead
,
190 struct pending_block
*old_blocks
,
191 const struct dynamic_prop
*static_link
,
195 extern void record_block_range (struct block
*,
196 CORE_ADDR start
, CORE_ADDR end_inclusive
);
198 class scoped_free_pendings
202 scoped_free_pendings () = default;
203 ~scoped_free_pendings ();
205 DISABLE_COPY_AND_ASSIGN (scoped_free_pendings
);
208 extern void start_subfile (const char *name
);
210 extern void patch_subfile_names (struct subfile
*subfile
, const char *name
);
212 extern void push_subfile (void);
214 extern char *pop_subfile (void);
216 extern struct block
*end_symtab_get_static_block (CORE_ADDR end_addr
,
220 extern struct compunit_symtab
*
221 end_symtab_from_static_block (struct block
*static_block
,
222 int section
, int expandable
);
224 extern struct compunit_symtab
*end_symtab (CORE_ADDR end_addr
, int section
);
226 extern struct compunit_symtab
*end_expandable_symtab (CORE_ADDR end_addr
,
229 extern void augment_type_symtab (void);
231 /* Defined in stabsread.c. */
233 extern void scan_file_globals (struct objfile
*objfile
);
235 extern void buildsym_new_init (void);
237 extern void buildsym_init (void);
239 extern struct context_stack
*push_context (int desc
, CORE_ADDR valu
);
241 extern struct context_stack
*pop_context (void);
243 extern record_line_ftype record_line
;
245 extern struct compunit_symtab
*start_symtab (struct objfile
*objfile
,
247 const char *comp_dir
,
248 CORE_ADDR start_addr
,
249 enum language language
);
251 extern void restart_symtab (struct compunit_symtab
*cust
,
252 const char *name
, CORE_ADDR start_addr
);
254 extern int hashname (const char *name
);
256 extern void free_pending_blocks (void);
258 /* Record the name of the debug format in the current pending symbol
259 table. FORMAT must be a string with a lifetime at least as long as
260 the symtab's objfile. */
262 extern void record_debugformat (const char *format
);
264 /* Record the name of the debuginfo producer (usually the compiler) in
265 the current pending symbol table. PRODUCER must be a string with a
266 lifetime at least as long as the symtab's objfile. */
268 extern void record_producer (const char *producer
);
270 extern void merge_symbol_lists (struct pending
**srclist
,
271 struct pending
**targetlist
);
273 /* Set the name of the last source file. NAME is copied by this
276 extern void set_last_source_file (const char *name
);
278 /* Fetch the name of the last source file. */
280 extern const char *get_last_source_file (void);
282 /* Return the compunit symtab object.
283 It is only valid to call this between calls to start_symtab and the
284 end_symtab* functions. */
286 extern struct compunit_symtab
*buildsym_compunit_symtab (void);
288 /* Return the macro table.
289 Initialize it if this is the first use.
290 It is only valid to call this between calls to start_symtab and the
291 end_symtab* functions. */
293 extern struct macro_table
*get_macro_table (void);
295 /* Set the last source start address. Can only be used between
296 start_symtab and end_symtab* calls. */
298 extern void set_last_source_start_addr (CORE_ADDR addr
);
300 /* Get the last source start address. Can only be used between
301 start_symtab and end_symtab* calls. */
303 extern CORE_ADDR
get_last_source_start_addr ();
307 #endif /* defined (BUILDSYM_H) */