xref: /dragonfly/contrib/gdb-7/gdb/buildsym.h (revision e65bc1c3)
1 /* Build symbol tables in GDB's internal format.
2    Copyright (C) 1986-1993, 1995-2000, 2002-2003, 2007-2012 Free
3    Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16 
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19 
20 #if !defined (BUILDSYM_H)
21 #define BUILDSYM_H 1
22 
23 struct objfile;
24 struct symbol;
25 struct addrmap;
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 
41 #ifndef EXTERN
42 #define	EXTERN extern
43 #endif
44 
45 #define HASHSIZE 127		/* Size of things hashed via
46 				   hashname().  */
47 
48 /* Name of source file whose symbol data we are now processing.  This
49    comes from a symbol of type N_SO for stabs.  For Dwarf it comes
50    from the DW_AT_name attribute of a DW_TAG_compile_unit DIE.  */
51 
52 EXTERN char *last_source_file;
53 
54 /* Core address of start of text of current source file.  This too
55    comes from the N_SO symbol.  For Dwarf it typically comes from the
56    DW_AT_low_pc attribute of a DW_TAG_compile_unit DIE.  */
57 
58 EXTERN CORE_ADDR last_source_start_addr;
59 
60 /* The list of sub-source-files within the current individual
61    compilation.  Each file gets its own symtab with its own linetable
62    and associated info, but they all share one blockvector.  */
63 
64 struct subfile
65   {
66     struct subfile *next;
67     char *name;
68     char *dirname;
69     struct linetable *line_vector;
70     int line_vector_length;
71     enum language language;
72     const char *producer;
73     const char *debugformat;
74     struct symtab *symtab;
75   };
76 
77 EXTERN struct subfile *current_subfile;
78 
79 /* Global variable which, when set, indicates that we are processing a
80    .o file compiled with gcc */
81 
82 EXTERN unsigned char processing_gcc_compilation;
83 
84 /* When set, we are processing a .o file compiled by sun acc.  This is
85    misnamed; it refers to all stabs-in-elf implementations which use
86    N_UNDF the way Sun does, including Solaris gcc.  Hopefully all
87    stabs-in-elf implementations ever invented will choose to be
88    compatible.  */
89 
90 EXTERN unsigned char processing_acc_compilation;
91 
92 /* Count symbols as they are processed, for error messages.  */
93 
94 EXTERN unsigned int symnum;
95 
96 /* Record the symbols defined for each context in a list.  We don't
97    create a struct block for the context until we know how long to
98    make it.  */
99 
100 #define PENDINGSIZE 100
101 
102 struct pending
103   {
104     struct pending *next;
105     int nsyms;
106     struct symbol *symbol[PENDINGSIZE];
107   };
108 
109 /* Here are the three lists that symbols are put on.  */
110 
111 /* static at top level, and types */
112 
113 EXTERN struct pending *file_symbols;
114 
115 /* global functions and variables */
116 
117 EXTERN struct pending *global_symbols;
118 
119 /* everything local to lexical context */
120 
121 EXTERN struct pending *local_symbols;
122 
123 /* func params local to lexical  context */
124 
125 EXTERN struct pending *param_symbols;
126 
127 /* "using" directives local to lexical context.  */
128 
129 EXTERN struct using_direct *using_directives;
130 
131 /* Stack representing unclosed lexical contexts (that will become
132    blocks, eventually).  */
133 
134 struct context_stack
135   {
136     /* Outer locals at the time we entered */
137 
138     struct pending *locals;
139 
140     /* Pending func params at the time we entered */
141 
142     struct pending *params;
143 
144     /* Pending using directives at the time we entered.  */
145 
146     struct using_direct *using_directives;
147 
148     /* Pointer into blocklist as of entry */
149 
150     struct pending_block *old_blocks;
151 
152     /* Name of function, if any, defining context */
153 
154     struct symbol *name;
155 
156     /* PC where this context starts */
157 
158     CORE_ADDR start_addr;
159 
160     /* Temp slot for exception handling.  */
161 
162     CORE_ADDR end_addr;
163 
164     /* For error-checking matching push/pop */
165 
166     int depth;
167 
168   };
169 
170 EXTERN struct context_stack *context_stack;
171 
172 /* Index of first unused entry in context stack.  */
173 
174 EXTERN int context_stack_depth;
175 
176 /* Currently allocated size of context stack.  */
177 
178 EXTERN int context_stack_size;
179 
180 /* Non-zero if the context stack is empty.  */
181 #define outermost_context_p() (context_stack_depth == 0)
182 
183 /* Nonzero if within a function (so symbols should be local, if
184    nothing says specifically).  */
185 
186 EXTERN int within_function;
187 
188 /* List of blocks already made (lexical contexts already closed).
189    This is used at the end to make the blockvector.  */
190 
191 struct pending_block
192   {
193     struct pending_block *next;
194     struct block *block;
195   };
196 
197 /* Pointer to the head of a linked list of symbol blocks which have
198    already been finalized (lexical contexts already closed) and which
199    are just waiting to be built into a blockvector when finalizing the
200    associated symtab.  */
201 
202 EXTERN struct pending_block *pending_blocks;
203 
204 
205 struct subfile_stack
206   {
207     struct subfile_stack *next;
208     char *name;
209   };
210 
211 EXTERN struct subfile_stack *subfile_stack;
212 
213 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
214 
215 /* Function to invoke get the next symbol.  Return the symbol name.  */
216 
217 EXTERN char *(*next_symbol_text_func) (struct objfile *);
218 
219 /* Vector of types defined so far, indexed by their type numbers.
220    Used for both stabs and coff.  (In newer sun systems, dbx uses a
221    pair of numbers in parens, as in "(SUBFILENUM,NUMWITHINSUBFILE)".
222    Then these numbers must be translated through the type_translations
223    hash table to get the index into the type vector.)  */
224 
225 EXTERN struct type **type_vector;
226 
227 /* Number of elements allocated for type_vector currently.  */
228 
229 EXTERN int type_vector_length;
230 
231 /* Initial size of type vector.  Is realloc'd larger if needed, and
232    realloc'd down to the size actually used, when completed.  */
233 
234 #define	INITIAL_TYPE_VECTOR_LENGTH	160
235 
236 extern void add_free_pendings (struct pending *list);
237 
238 extern void add_symbol_to_list (struct symbol *symbol,
239 				struct pending **listhead);
240 
241 extern struct symbol *find_symbol_in_list (struct pending *list,
242 					   char *name, int length);
243 
244 extern struct block *finish_block (struct symbol *symbol,
245                                    struct pending **listhead,
246                                    struct pending_block *old_blocks,
247                                    CORE_ADDR start, CORE_ADDR end,
248                                    struct objfile *objfile);
249 
250 extern void record_block_range (struct block *,
251                                 CORE_ADDR start, CORE_ADDR end_inclusive);
252 
253 extern void really_free_pendings (void *dummy);
254 
255 extern void start_subfile (const char *name, const char *dirname);
256 
257 extern void patch_subfile_names (struct subfile *subfile, char *name);
258 
259 extern void push_subfile (void);
260 
261 extern char *pop_subfile (void);
262 
263 extern struct symtab *end_symtab (CORE_ADDR end_addr,
264 				  struct objfile *objfile, int section);
265 
266 /* Defined in stabsread.c.  */
267 
268 extern void scan_file_globals (struct objfile *objfile);
269 
270 extern void buildsym_new_init (void);
271 
272 extern void buildsym_init (void);
273 
274 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
275 
276 extern struct context_stack *pop_context (void);
277 
278 extern void record_line (struct subfile *subfile, int line, CORE_ADDR pc);
279 
280 extern void start_symtab (char *name, char *dirname, CORE_ADDR start_addr);
281 
282 extern int hashname (char *name);
283 
284 extern void free_pending_blocks (void);
285 
286 /* FIXME: Note that this is used only in buildsym.c and dstread.c,
287    which should be fixed to not need direct access to
288    record_pending_block.  */
289 
290 extern void record_pending_block (struct objfile *objfile,
291 				  struct block *block,
292 				  struct pending_block *opblock);
293 
294 /* Record the name of the debug format in the current pending symbol
295    table.  FORMAT must be a string with a lifetime at least as long as
296    the symtab's objfile.  */
297 
298 extern void record_debugformat (const char *format);
299 
300 /* Record the name of the debuginfo producer (usually the compiler) in
301    the current pending symbol table.  PRODUCER must be a string with a
302    lifetime at least as long as the symtab's objfile.  */
303 
304 extern void record_producer (const char *producer);
305 
306 extern void merge_symbol_lists (struct pending **srclist,
307 				struct pending **targetlist);
308 
309 /* The macro table for the compilation unit whose symbols we're
310    currently reading.  All the symtabs for this CU will point to
311    this.  */
312 EXTERN struct macro_table *pending_macros;
313 
314 #undef EXTERN
315 
316 #endif /* defined (BUILDSYM_H) */
317