gdb/buildsym.h

   1 /* Build symbol tables in GDB's internal format.
   2    Copyright (C) 1986-2018 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 enum language;
  27
  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.
  31
  32    They originated in dbxread.c of gdb-4.2, and were split out to
  33    make xcoffread.c more maintainable by sharing code.
  34
  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
  38    this technique.  */
  39
  40 struct block;
  41 struct pending_block;
  42
  43 struct dynamic_prop;
  44
  45 #ifndef EXTERN
  46 #define EXTERN extern
  47 #endif
  48
  49 #define HASHSIZE 127            /* Size of things hashed via
  50                                    hashname().  */
  51
  52 /* Core address of start of text of current source file.  This too
  53    comes from the N_SO symbol.  For Dwarf it typically comes from the
  54    DW_AT_low_pc attribute of a DW_TAG_compile_unit DIE.  */
  55
  56 EXTERN CORE_ADDR last_source_start_addr;
  57
  58 /* The list of sub-source-files within the current individual
  59    compilation.  Each file gets its own symtab with its own linetable
  60    and associated info, but they all share one blockvector.  */
  61
  62 struct subfile
  63 {
  64   struct subfile *next;
  65   /* Space for this is malloc'd.  */
  66   char *name;
  67   /* Space for this is malloc'd.  */
  68   struct linetable *line_vector;
  69   int line_vector_length;
  70   /* The "containing" compunit.  */
  71   struct buildsym_compunit *buildsym_compunit;
  72   enum language language;
  73   struct symtab *symtab;
  74 };
  75
  76 EXTERN struct subfile *current_subfile;
  77
  78 /* Global variable which, when set, indicates that we are processing a
  79    .o file compiled with gcc */
  80
  81 EXTERN unsigned char processing_gcc_compilation;
  82
  83 /* When set, we are processing a .o file compiled by sun acc.  This is
  84    misnamed; it refers to all stabs-in-elf implementations which use
  85    N_UNDF the way Sun does, including Solaris gcc.  Hopefully all
  86    stabs-in-elf implementations ever invented will choose to be
  87    compatible.  */
  88
  89 EXTERN unsigned char processing_acc_compilation;
  90
  91 /* Count symbols as they are processed, for error messages.  */
  92
  93 EXTERN unsigned int symnum;
  94
  95 /* Record the symbols defined for each context in a list.  We don't
  96    create a struct block for the context until we know how long to
  97    make it.  */
  98
  99 #define PENDINGSIZE 100
 100
 101 struct pending
 102   {
 103     struct pending *next;
 104     int nsyms;
 105     struct symbol *symbol[PENDINGSIZE];
 106   };
 107
 108 /* Here are the three lists that symbols are put on.  */
 109
 110 /* static at top level, and types */
 111
 112 EXTERN struct pending *file_symbols;
 113
 114 /* global functions and variables */
 115
 116 EXTERN struct pending *global_symbols;
 117
 118 /* everything local to lexical context */
 119
 120 EXTERN struct pending *local_symbols;
 121
 122 /* "using" directives local to lexical context.  */
 123
 124 EXTERN struct using_direct *local_using_directives;
 125
 126 /* global "using" directives.  */
 127
 128 EXTERN struct using_direct *global_using_directives;
 129
 130 /* Stack representing unclosed lexical contexts (that will become
 131    blocks, eventually).  */
 132
 133 struct context_stack
 134   {
 135     /* Outer locals at the time we entered */
 136
 137     struct pending *locals;
 138
 139     /* Pending using directives at the time we entered.  */
 140
 141     struct using_direct *local_using_directives;
 142
 143     /* Pointer into blocklist as of entry */
 144
 145     struct pending_block *old_blocks;
 146
 147     /* Name of function, if any, defining context */
 148
 149     struct symbol *name;
 150
 151     /* Expression that computes the frame base of the lexically enclosing
 152        function, if any.  NULL otherwise.  */
 153
 154     struct dynamic_prop *static_link;
 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 /* The type of the record_line function.  */
 189 typedef void (record_line_ftype) (struct subfile *subfile, int line,
 190                                   CORE_ADDR pc);
 191
 192 \f
 193
 194 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
 195
 196 /* Function to invoke get the next symbol.  Return the symbol name.  */
 197
 198 EXTERN const char *(*next_symbol_text_func) (struct objfile *);
 199
 200 extern void add_symbol_to_list (struct symbol *symbol,
 201                                 struct pending **listhead);
 202
 203 extern struct symbol *find_symbol_in_list (struct pending *list,
 204                                            char *name, int length);
 205
 206 extern struct block *finish_block (struct symbol *symbol,
 207                                    struct pending **listhead,
 208                                    struct pending_block *old_blocks,
 209                                    const struct dynamic_prop *static_link,
 210                                    CORE_ADDR start,
 211                                    CORE_ADDR end);
 212
 213 extern void record_block_range (struct block *,
 214                                 CORE_ADDR start, CORE_ADDR end_inclusive);
 215
 216 class scoped_free_pendings
 217 {
 218 public:
 219
 220   scoped_free_pendings () = default;
 221   ~scoped_free_pendings ();
 222
 223   DISABLE_COPY_AND_ASSIGN (scoped_free_pendings);
 224 };
 225
 226 extern void start_subfile (const char *name);
 227
 228 extern void patch_subfile_names (struct subfile *subfile, const char *name);
 229
 230 extern void push_subfile (void);
 231
 232 extern char *pop_subfile (void);
 233
 234 extern struct block *end_symtab_get_static_block (CORE_ADDR end_addr,
 235                                                   int expandable,
 236                                                   int required);
 237
 238 extern struct compunit_symtab *
 239   end_symtab_from_static_block (struct block *static_block,
 240                                 int section, int expandable);
 241
 242 extern struct compunit_symtab *end_symtab (CORE_ADDR end_addr, int section);
 243
 244 extern struct compunit_symtab *end_expandable_symtab (CORE_ADDR end_addr,
 245                                                       int section);
 246
 247 extern void augment_type_symtab (void);
 248
 249 /* Defined in stabsread.c.  */
 250
 251 extern void scan_file_globals (struct objfile *objfile);
 252
 253 extern void buildsym_new_init (void);
 254
 255 extern void buildsym_init (void);
 256
 257 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
 258
 259 extern struct context_stack *pop_context (void);
 260
 261 extern record_line_ftype record_line;
 262
 263 extern struct compunit_symtab *start_symtab (struct objfile *objfile,
 264                                              const char *name,
 265                                              const char *comp_dir,
 266                                              CORE_ADDR start_addr,
 267                                              enum language language);
 268
 269 extern void restart_symtab (struct compunit_symtab *cust,
 270                             const char *name, CORE_ADDR start_addr);
 271
 272 extern int hashname (const char *name);
 273
 274 extern void free_pending_blocks (void);
 275
 276 /* Record the name of the debug format in the current pending symbol
 277    table.  FORMAT must be a string with a lifetime at least as long as
 278    the symtab's objfile.  */
 279
 280 extern void record_debugformat (const char *format);
 281
 282 /* Record the name of the debuginfo producer (usually the compiler) in
 283    the current pending symbol table.  PRODUCER must be a string with a
 284    lifetime at least as long as the symtab's objfile.  */
 285
 286 extern void record_producer (const char *producer);
 287
 288 extern void merge_symbol_lists (struct pending **srclist,
 289                                 struct pending **targetlist);
 290
 291 /* Set the name of the last source file.  NAME is copied by this
 292    function.  */
 293
 294 extern void set_last_source_file (const char *name);
 295
 296 /* Fetch the name of the last source file.  */
 297
 298 extern const char *get_last_source_file (void);
 299
 300 /* Return the compunit symtab object.
 301    It is only valid to call this between calls to start_symtab and the
 302    end_symtab* functions.  */
 303
 304 extern struct compunit_symtab *buildsym_compunit_symtab (void);
 305
 306 /* Return the macro table.
 307    Initialize it if this is the first use.
 308    It is only valid to call this between calls to start_symtab and the
 309    end_symtab* functions.  */
 310
 311 extern struct macro_table *get_macro_table (void);
 312
 313 #undef EXTERN
 314
 315 #endif /* defined (BUILDSYM_H) */