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