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 /* The list of sub-source-files within the current individual
50 compilation. Each file gets its own symtab with its own linetable
51 and associated info, but they all share one blockvector. */
56 /* Space for this is malloc'd. */
58 /* Space for this is malloc'd. */
59 struct linetable
*line_vector
;
60 int line_vector_length
;
61 /* The "containing" compunit. */
62 struct buildsym_compunit
*buildsym_compunit
;
63 enum language language
;
64 struct symtab
*symtab
;
67 EXTERN
struct subfile
*current_subfile
;
69 /* Record the symbols defined for each context in a list. We don't
70 create a struct block for the context until we know how long to
73 #define PENDINGSIZE 100
79 struct symbol
*symbol
[PENDINGSIZE
];
82 /* Here are the three lists that symbols are put on. */
84 /* static at top level, and types */
86 EXTERN
struct pending
*file_symbols
;
88 /* global functions and variables */
90 EXTERN
struct pending
*global_symbols
;
92 /* everything local to lexical context */
94 EXTERN
struct pending
*local_symbols
;
96 /* "using" directives local to lexical context. */
98 EXTERN
struct using_direct
*local_using_directives
;
100 /* global "using" directives. */
102 EXTERN
struct using_direct
*global_using_directives
;
104 /* Stack representing unclosed lexical contexts (that will become
105 blocks, eventually). */
109 /* Outer locals at the time we entered */
111 struct pending
*locals
;
113 /* Pending using directives at the time we entered. */
115 struct using_direct
*local_using_directives
;
117 /* Pointer into blocklist as of entry */
119 struct pending_block
*old_blocks
;
121 /* Name of function, if any, defining context */
125 /* Expression that computes the frame base of the lexically enclosing
126 function, if any. NULL otherwise. */
128 struct dynamic_prop
*static_link
;
130 /* PC where this context starts */
132 CORE_ADDR start_addr
;
134 /* Temp slot for exception handling. */
138 /* For error-checking matching push/pop */
144 EXTERN
struct context_stack
*context_stack
;
146 /* Index of first unused entry in context stack. */
148 EXTERN
int context_stack_depth
;
150 /* Non-zero if the context stack is empty. */
151 #define outermost_context_p() (context_stack_depth == 0)
153 /* The type of the record_line function. */
154 typedef void (record_line_ftype
) (struct subfile
*subfile
, int line
,
159 extern void add_symbol_to_list (struct symbol
*symbol
,
160 struct pending
**listhead
);
162 extern struct symbol
*find_symbol_in_list (struct pending
*list
,
163 char *name
, int length
);
165 extern struct block
*finish_block (struct symbol
*symbol
,
166 struct pending
**listhead
,
167 struct pending_block
*old_blocks
,
168 const struct dynamic_prop
*static_link
,
172 extern void record_block_range (struct block
*,
173 CORE_ADDR start
, CORE_ADDR end_inclusive
);
175 class scoped_free_pendings
179 scoped_free_pendings () = default;
180 ~scoped_free_pendings ();
182 DISABLE_COPY_AND_ASSIGN (scoped_free_pendings
);
185 extern void start_subfile (const char *name
);
187 extern void patch_subfile_names (struct subfile
*subfile
, const char *name
);
189 extern void push_subfile (void);
191 extern char *pop_subfile (void);
193 extern struct block
*end_symtab_get_static_block (CORE_ADDR end_addr
,
197 extern struct compunit_symtab
*
198 end_symtab_from_static_block (struct block
*static_block
,
199 int section
, int expandable
);
201 extern struct compunit_symtab
*end_symtab (CORE_ADDR end_addr
, int section
);
203 extern struct compunit_symtab
*end_expandable_symtab (CORE_ADDR end_addr
,
206 extern void augment_type_symtab (void);
208 extern void buildsym_init ();
210 extern struct context_stack
*push_context (int desc
, CORE_ADDR valu
);
212 extern struct context_stack
*pop_context (void);
214 extern record_line_ftype record_line
;
216 extern struct compunit_symtab
*start_symtab (struct objfile
*objfile
,
218 const char *comp_dir
,
219 CORE_ADDR start_addr
,
220 enum language language
);
222 extern void restart_symtab (struct compunit_symtab
*cust
,
223 const char *name
, CORE_ADDR start_addr
);
225 extern void free_pending_blocks (void);
227 /* Record the name of the debug format in the current pending symbol
228 table. FORMAT must be a string with a lifetime at least as long as
229 the symtab's objfile. */
231 extern void record_debugformat (const char *format
);
233 /* Record the name of the debuginfo producer (usually the compiler) in
234 the current pending symbol table. PRODUCER must be a string with a
235 lifetime at least as long as the symtab's objfile. */
237 extern void record_producer (const char *producer
);
239 extern void merge_symbol_lists (struct pending
**srclist
,
240 struct pending
**targetlist
);
242 /* Set the name of the last source file. NAME is copied by this
245 extern void set_last_source_file (const char *name
);
247 /* Fetch the name of the last source file. */
249 extern const char *get_last_source_file (void);
251 /* Return the compunit symtab object.
252 It is only valid to call this between calls to start_symtab and the
253 end_symtab* functions. */
255 extern struct compunit_symtab
*buildsym_compunit_symtab (void);
257 /* Return the macro table.
258 Initialize it if this is the first use.
259 It is only valid to call this between calls to start_symtab and the
260 end_symtab* functions. */
262 extern struct macro_table
*get_macro_table (void);
264 /* Set the last source start address. Can only be used between
265 start_symtab and end_symtab* calls. */
267 extern void set_last_source_start_addr (CORE_ADDR addr
);
269 /* Get the last source start address. Can only be used between
270 start_symtab and end_symtab* calls. */
272 extern CORE_ADDR
get_last_source_start_addr ();
276 #endif /* defined (BUILDSYM_H) */