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 /* Record the symbols defined for each context in a list. We don't
68 create a struct block for the context until we know how long to
71 #define PENDINGSIZE 100
77 struct symbol
*symbol
[PENDINGSIZE
];
80 /* Here are the three lists that symbols are put on. */
82 /* static at top level, and types */
84 EXTERN
struct pending
*file_symbols
;
86 /* global functions and variables */
88 EXTERN
struct pending
*global_symbols
;
90 /* everything local to lexical context */
92 EXTERN
struct pending
*local_symbols
;
94 /* Stack representing unclosed lexical contexts (that will become
95 blocks, eventually). */
99 /* Outer locals at the time we entered */
101 struct pending
*locals
;
103 /* Pending using directives at the time we entered. */
105 struct using_direct
*local_using_directives
;
107 /* Pointer into blocklist as of entry */
109 struct pending_block
*old_blocks
;
111 /* Name of function, if any, defining context */
115 /* Expression that computes the frame base of the lexically enclosing
116 function, if any. NULL otherwise. */
118 struct dynamic_prop
*static_link
;
120 /* PC where this context starts */
122 CORE_ADDR start_addr
;
124 /* Temp slot for exception handling. */
128 /* For error-checking matching push/pop */
134 /* The type of the record_line function. */
135 typedef void (record_line_ftype
) (struct subfile
*subfile
, int line
,
140 extern void add_symbol_to_list (struct symbol
*symbol
,
141 struct pending
**listhead
);
143 extern struct symbol
*find_symbol_in_list (struct pending
*list
,
144 char *name
, int length
);
146 extern struct block
*finish_block (struct symbol
*symbol
,
147 struct pending_block
*old_blocks
,
148 const struct dynamic_prop
*static_link
,
152 extern void record_block_range (struct block
*,
153 CORE_ADDR start
, CORE_ADDR end_inclusive
);
155 class scoped_free_pendings
159 scoped_free_pendings () = default;
160 ~scoped_free_pendings ();
162 DISABLE_COPY_AND_ASSIGN (scoped_free_pendings
);
165 extern void start_subfile (const char *name
);
167 extern void patch_subfile_names (struct subfile
*subfile
, const char *name
);
169 extern void push_subfile ();
171 extern const char *pop_subfile ();
173 extern struct block
*end_symtab_get_static_block (CORE_ADDR end_addr
,
177 extern struct compunit_symtab
*
178 end_symtab_from_static_block (struct block
*static_block
,
179 int section
, int expandable
);
181 extern struct compunit_symtab
*end_symtab (CORE_ADDR end_addr
, int section
);
183 extern struct compunit_symtab
*end_expandable_symtab (CORE_ADDR end_addr
,
186 extern void augment_type_symtab (void);
188 extern void buildsym_init ();
190 extern struct context_stack
*push_context (int desc
, CORE_ADDR valu
);
192 extern struct context_stack
pop_context ();
194 extern record_line_ftype record_line
;
196 extern struct compunit_symtab
*start_symtab (struct objfile
*objfile
,
198 const char *comp_dir
,
199 CORE_ADDR start_addr
,
200 enum language language
);
202 extern void restart_symtab (struct compunit_symtab
*cust
,
203 const char *name
, CORE_ADDR start_addr
);
205 /* Record the name of the debug format in the current pending symbol
206 table. FORMAT must be a string with a lifetime at least as long as
207 the symtab's objfile. */
209 extern void record_debugformat (const char *format
);
211 /* Record the name of the debuginfo producer (usually the compiler) in
212 the current pending symbol table. PRODUCER must be a string with a
213 lifetime at least as long as the symtab's objfile. */
215 extern void record_producer (const char *producer
);
217 /* Set the name of the last source file. NAME is copied by this
220 extern void set_last_source_file (const char *name
);
222 /* Fetch the name of the last source file. */
224 extern const char *get_last_source_file (void);
226 /* Return the compunit symtab object.
227 It is only valid to call this between calls to start_symtab and the
228 end_symtab* functions. */
230 extern struct compunit_symtab
*buildsym_compunit_symtab (void);
232 /* Return the macro table.
233 Initialize it if this is the first use.
234 It is only valid to call this between calls to start_symtab and the
235 end_symtab* functions. */
237 extern struct macro_table
*get_macro_table (void);
239 /* Set the last source start address. Can only be used between
240 start_symtab and end_symtab* calls. */
242 extern void set_last_source_start_addr (CORE_ADDR addr
);
244 /* Get the last source start address. Can only be used between
245 start_symtab and end_symtab* calls. */
247 extern CORE_ADDR
get_last_source_start_addr ();
249 /* Return the local using directives. */
251 extern struct using_direct
**get_local_using_directives ();
253 /* Set the list of local using directives. */
255 extern void set_local_using_directives (struct using_direct
*new_local
);
257 /* Return the global using directives. */
259 extern struct using_direct
**get_global_using_directives ();
261 /* True if the context stack is empty. */
263 extern bool outermost_context_p ();
265 /* Return the top of the context stack, or nullptr if there is an
268 extern struct context_stack
*get_current_context_stack ();
270 /* Return the context stack depth. */
272 extern int get_context_stack_depth ();
274 /* Return the current subfile. */
276 extern struct subfile
*get_current_subfile ();
280 #endif /* defined (BUILDSYM_H) */