xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/buildsym.h (revision 7863ba460b0a05b553c754e5dbc29247dddec322)
1 /* Build symbol tables in GDB's internal format.
2    Copyright (C) 1986-2016 Free Software Foundation, Inc.
3 
4    This file is part of GDB.
5 
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.
10 
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.
15 
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/>.  */
18 
19 #if !defined (BUILDSYM_H)
20 #define BUILDSYM_H 1
21 
22 struct objfile;
23 struct symbol;
24 struct addrmap;
25 struct compunit_symtab;
26 
27 /* This module provides definitions used for creating and adding to
28    the symbol table.  These routines are called from various symbol-
29    file-reading routines.
30 
31    They originated in dbxread.c of gdb-4.2, and were split out to
32    make xcoffread.c more maintainable by sharing code.
33 
34    Variables declared in this file can be defined by #define-ing the
35    name EXTERN to null.  It is used to declare variables that are
36    normally extern, but which get defined in a single module using
37    this technique.  */
38 
39 struct block;
40 struct pending_block;
41 
42 struct dynamic_prop;
43 
44 #ifndef EXTERN
45 #define	EXTERN extern
46 #endif
47 
48 #define HASHSIZE 127		/* Size of things hashed via
49 				   hashname().  */
50 
51 /* Core address of start of text of current source file.  This too
52    comes from the N_SO symbol.  For Dwarf it typically comes from the
53    DW_AT_low_pc attribute of a DW_TAG_compile_unit DIE.  */
54 
55 EXTERN CORE_ADDR last_source_start_addr;
56 
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.  */
60 
61 struct subfile
62 {
63   struct subfile *next;
64   /* Space for this is malloc'd.  */
65   char *name;
66   /* Space for this is malloc'd.  */
67   struct linetable *line_vector;
68   int line_vector_length;
69   /* The "containing" compunit.  */
70   struct buildsym_compunit *buildsym_compunit;
71   enum language language;
72   struct symtab *symtab;
73 };
74 
75 EXTERN struct subfile *current_subfile;
76 
77 /* Global variable which, when set, indicates that we are processing a
78    .o file compiled with gcc */
79 
80 EXTERN unsigned char processing_gcc_compilation;
81 
82 /* When set, we are processing a .o file compiled by sun acc.  This is
83    misnamed; it refers to all stabs-in-elf implementations which use
84    N_UNDF the way Sun does, including Solaris gcc.  Hopefully all
85    stabs-in-elf implementations ever invented will choose to be
86    compatible.  */
87 
88 EXTERN unsigned char processing_acc_compilation;
89 
90 /* Count symbols as they are processed, for error messages.  */
91 
92 EXTERN unsigned int symnum;
93 
94 /* Record the symbols defined for each context in a list.  We don't
95    create a struct block for the context until we know how long to
96    make it.  */
97 
98 #define PENDINGSIZE 100
99 
100 struct pending
101   {
102     struct pending *next;
103     int nsyms;
104     struct symbol *symbol[PENDINGSIZE];
105   };
106 
107 /* Here are the three lists that symbols are put on.  */
108 
109 /* static at top level, and types */
110 
111 EXTERN struct pending *file_symbols;
112 
113 /* global functions and variables */
114 
115 EXTERN struct pending *global_symbols;
116 
117 /* everything local to lexical context */
118 
119 EXTERN struct pending *local_symbols;
120 
121 /* "using" directives local to lexical context.  */
122 
123 EXTERN struct using_direct *local_using_directives;
124 
125 /* global "using" directives.  */
126 
127 EXTERN struct using_direct *global_using_directives;
128 
129 /* Stack representing unclosed lexical contexts (that will become
130    blocks, eventually).  */
131 
132 struct context_stack
133   {
134     /* Outer locals at the time we entered */
135 
136     struct pending *locals;
137 
138     /* Pending using directives at the time we entered.  */
139 
140     struct using_direct *local_using_directives;
141 
142     /* Pointer into blocklist as of entry */
143 
144     struct pending_block *old_blocks;
145 
146     /* Name of function, if any, defining context */
147 
148     struct symbol *name;
149 
150     /* Expression that computes the frame base of the lexically enclosing
151        function, if any.  NULL otherwise.  */
152 
153     struct dynamic_prop *static_link;
154 
155     /* PC where this context starts */
156 
157     CORE_ADDR start_addr;
158 
159     /* Temp slot for exception handling.  */
160 
161     CORE_ADDR end_addr;
162 
163     /* For error-checking matching push/pop */
164 
165     int depth;
166 
167   };
168 
169 EXTERN struct context_stack *context_stack;
170 
171 /* Index of first unused entry in context stack.  */
172 
173 EXTERN int context_stack_depth;
174 
175 /* Currently allocated size of context stack.  */
176 
177 EXTERN int context_stack_size;
178 
179 /* Non-zero if the context stack is empty.  */
180 #define outermost_context_p() (context_stack_depth == 0)
181 
182 /* Nonzero if within a function (so symbols should be local, if
183    nothing says specifically).  */
184 
185 EXTERN int within_function;
186 
187 /* The type of the record_line function.  */
188 typedef void (record_line_ftype) (struct subfile *subfile, int line,
189 				  CORE_ADDR pc);
190 
191 
192 
193 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
194 
195 /* Function to invoke get the next symbol.  Return the symbol name.  */
196 
197 EXTERN char *(*next_symbol_text_func) (struct objfile *);
198 
199 extern void add_symbol_to_list (struct symbol *symbol,
200 				struct pending **listhead);
201 
202 extern struct symbol *find_symbol_in_list (struct pending *list,
203 					   char *name, int length);
204 
205 extern struct block *finish_block (struct symbol *symbol,
206 				   struct pending **listhead,
207 				   struct pending_block *old_blocks,
208 				   const struct dynamic_prop *static_link,
209 				   CORE_ADDR start,
210 				   CORE_ADDR end);
211 
212 extern void record_block_range (struct block *,
213                                 CORE_ADDR start, CORE_ADDR end_inclusive);
214 
215 extern void really_free_pendings (void *dummy);
216 
217 extern void start_subfile (const char *name);
218 
219 extern void patch_subfile_names (struct subfile *subfile, char *name);
220 
221 extern void push_subfile (void);
222 
223 extern char *pop_subfile (void);
224 
225 extern struct block *end_symtab_get_static_block (CORE_ADDR end_addr,
226 						  int expandable,
227 						  int required);
228 
229 extern struct compunit_symtab *
230   end_symtab_from_static_block (struct block *static_block,
231 				int section, int expandable);
232 
233 extern struct compunit_symtab *end_symtab (CORE_ADDR end_addr, int section);
234 
235 extern struct compunit_symtab *end_expandable_symtab (CORE_ADDR end_addr,
236 						      int section);
237 
238 extern void augment_type_symtab (void);
239 
240 /* Defined in stabsread.c.  */
241 
242 extern void scan_file_globals (struct objfile *objfile);
243 
244 extern void buildsym_new_init (void);
245 
246 extern void buildsym_init (void);
247 
248 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
249 
250 extern struct context_stack *pop_context (void);
251 
252 extern record_line_ftype record_line;
253 
254 extern struct compunit_symtab *start_symtab (struct objfile *objfile,
255 					     const char *name,
256 					     const char *comp_dir,
257 					     CORE_ADDR start_addr);
258 
259 extern void restart_symtab (struct compunit_symtab *cust,
260 			    const char *name, CORE_ADDR start_addr);
261 
262 extern int hashname (const char *name);
263 
264 extern void free_pending_blocks (void);
265 
266 /* Record the name of the debug format in the current pending symbol
267    table.  FORMAT must be a string with a lifetime at least as long as
268    the symtab's objfile.  */
269 
270 extern void record_debugformat (const char *format);
271 
272 /* Record the name of the debuginfo producer (usually the compiler) in
273    the current pending symbol table.  PRODUCER must be a string with a
274    lifetime at least as long as the symtab's objfile.  */
275 
276 extern void record_producer (const char *producer);
277 
278 extern void merge_symbol_lists (struct pending **srclist,
279 				struct pending **targetlist);
280 
281 /* Set the name of the last source file.  NAME is copied by this
282    function.  */
283 
284 extern void set_last_source_file (const char *name);
285 
286 /* Fetch the name of the last source file.  */
287 
288 extern const char *get_last_source_file (void);
289 
290 /* Return the compunit symtab object.
291    It is only valid to call this between calls to start_symtab and the
292    end_symtab* functions.  */
293 
294 extern struct compunit_symtab *buildsym_compunit_symtab (void);
295 
296 /* Return the macro table.
297    Initialize it if this is the first use.
298    It is only valid to call this between calls to start_symtab and the
299    end_symtab* functions.  */
300 
301 extern struct macro_table *get_macro_table (void);
302 
303 #undef EXTERN
304 
305 #endif /* defined (BUILDSYM_H) */
306