gdb/buildsym.h

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