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 /* The list of sub-source-files within the current individual
  50    compilation.  Each file gets its own symtab with its own linetable
  51    and associated info, but they all share one blockvector.  */
  52
  53 struct subfile
  54 {
  55   struct subfile *next;
  56   /* Space for this is malloc'd.  */
  57   char *name;
  58   /* Space for this is malloc'd.  */
  59   struct linetable *line_vector;
  60   int line_vector_length;
  61   /* The "containing" compunit.  */
  62   struct buildsym_compunit *buildsym_compunit;
  63   enum language language;
  64   struct symtab *symtab;
  65 };
  66
  67 EXTERN struct subfile *current_subfile;
  68
  69 /* Record the symbols defined for each context in a list.  We don't
  70    create a struct block for the context until we know how long to
  71    make it.  */
  72
  73 #define PENDINGSIZE 100
  74
  75 struct pending
  76   {
  77     struct pending *next;
  78     int nsyms;
  79     struct symbol *symbol[PENDINGSIZE];
  80   };
  81
  82 /* Here are the three lists that symbols are put on.  */
  83
  84 /* static at top level, and types */
  85
  86 EXTERN struct pending *file_symbols;
  87
  88 /* global functions and variables */
  89
  90 EXTERN struct pending *global_symbols;
  91
  92 /* everything local to lexical context */
  93
  94 EXTERN struct pending *local_symbols;
  95
  96 /* "using" directives local to lexical context.  */
  97
  98 EXTERN struct using_direct *local_using_directives;
  99
 100 /* global "using" directives.  */
 101
 102 EXTERN struct using_direct *global_using_directives;
 103
 104 /* Stack representing unclosed lexical contexts (that will become
 105    blocks, eventually).  */
 106
 107 struct context_stack
 108   {
 109     /* Outer locals at the time we entered */
 110
 111     struct pending *locals;
 112
 113     /* Pending using directives at the time we entered.  */
 114
 115     struct using_direct *local_using_directives;
 116
 117     /* Pointer into blocklist as of entry */
 118
 119     struct pending_block *old_blocks;
 120
 121     /* Name of function, if any, defining context */
 122
 123     struct symbol *name;
 124
 125     /* Expression that computes the frame base of the lexically enclosing
 126        function, if any.  NULL otherwise.  */
 127
 128     struct dynamic_prop *static_link;
 129
 130     /* PC where this context starts */
 131
 132     CORE_ADDR start_addr;
 133
 134     /* Temp slot for exception handling.  */
 135
 136     CORE_ADDR end_addr;
 137
 138     /* For error-checking matching push/pop */
 139
 140     int depth;
 141
 142   };
 143
 144 EXTERN struct context_stack *context_stack;
 145
 146 /* Index of first unused entry in context stack.  */
 147
 148 EXTERN int context_stack_depth;
 149
 150 /* Non-zero if the context stack is empty.  */
 151 #define outermost_context_p() (context_stack_depth == 0)
 152
 153 /* Nonzero if within a function (so symbols should be local, if
 154    nothing says specifically).  */
 155
 156 EXTERN int within_function;
 157
 158 /* The type of the record_line function.  */
 159 typedef void (record_line_ftype) (struct subfile *subfile, int line,
 160                                   CORE_ADDR pc);
 161
 162 \f
 163
 164 extern void add_symbol_to_list (struct symbol *symbol,
 165                                 struct pending **listhead);
 166
 167 extern struct symbol *find_symbol_in_list (struct pending *list,
 168                                            char *name, int length);
 169
 170 extern struct block *finish_block (struct symbol *symbol,
 171                                    struct pending **listhead,
 172                                    struct pending_block *old_blocks,
 173                                    const struct dynamic_prop *static_link,
 174                                    CORE_ADDR start,
 175                                    CORE_ADDR end);
 176
 177 extern void record_block_range (struct block *,
 178                                 CORE_ADDR start, CORE_ADDR end_inclusive);
 179
 180 class scoped_free_pendings
 181 {
 182 public:
 183
 184   scoped_free_pendings () = default;
 185   ~scoped_free_pendings ();
 186
 187   DISABLE_COPY_AND_ASSIGN (scoped_free_pendings);
 188 };
 189
 190 extern void start_subfile (const char *name);
 191
 192 extern void patch_subfile_names (struct subfile *subfile, const char *name);
 193
 194 extern void push_subfile (void);
 195
 196 extern char *pop_subfile (void);
 197
 198 extern struct block *end_symtab_get_static_block (CORE_ADDR end_addr,
 199                                                   int expandable,
 200                                                   int required);
 201
 202 extern struct compunit_symtab *
 203   end_symtab_from_static_block (struct block *static_block,
 204                                 int section, int expandable);
 205
 206 extern struct compunit_symtab *end_symtab (CORE_ADDR end_addr, int section);
 207
 208 extern struct compunit_symtab *end_expandable_symtab (CORE_ADDR end_addr,
 209                                                       int section);
 210
 211 extern void augment_type_symtab (void);
 212
 213 /* Defined in stabsread.c.  */
 214
 215 extern void scan_file_globals (struct objfile *objfile);
 216
 217 extern void buildsym_new_init (void);
 218
 219 extern void buildsym_init (void);
 220
 221 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
 222
 223 extern struct context_stack *pop_context (void);
 224
 225 extern record_line_ftype record_line;
 226
 227 extern struct compunit_symtab *start_symtab (struct objfile *objfile,
 228                                              const char *name,
 229                                              const char *comp_dir,
 230                                              CORE_ADDR start_addr,
 231                                              enum language language);
 232
 233 extern void restart_symtab (struct compunit_symtab *cust,
 234                             const char *name, CORE_ADDR start_addr);
 235
 236 extern void free_pending_blocks (void);
 237
 238 /* Record the name of the debug format in the current pending symbol
 239    table.  FORMAT must be a string with a lifetime at least as long as
 240    the symtab's objfile.  */
 241
 242 extern void record_debugformat (const char *format);
 243
 244 /* Record the name of the debuginfo producer (usually the compiler) in
 245    the current pending symbol table.  PRODUCER must be a string with a
 246    lifetime at least as long as the symtab's objfile.  */
 247
 248 extern void record_producer (const char *producer);
 249
 250 extern void merge_symbol_lists (struct pending **srclist,
 251                                 struct pending **targetlist);
 252
 253 /* Set the name of the last source file.  NAME is copied by this
 254    function.  */
 255
 256 extern void set_last_source_file (const char *name);
 257
 258 /* Fetch the name of the last source file.  */
 259
 260 extern const char *get_last_source_file (void);
 261
 262 /* Return the compunit symtab object.
 263    It is only valid to call this between calls to start_symtab and the
 264    end_symtab* functions.  */
 265
 266 extern struct compunit_symtab *buildsym_compunit_symtab (void);
 267
 268 /* Return the macro table.
 269    Initialize it if this is the first use.
 270    It is only valid to call this between calls to start_symtab and the
 271    end_symtab* functions.  */
 272
 273 extern struct macro_table *get_macro_table (void);
 274
 275 /* Set the last source start address.  Can only be used between
 276    start_symtab and end_symtab* calls.  */
 277
 278 extern void set_last_source_start_addr (CORE_ADDR addr);
 279
 280 /* Get the last source start address.  Can only be used between
 281    start_symtab and end_symtab* calls.  */
 282
 283 extern CORE_ADDR get_last_source_start_addr ();
 284
 285 #undef EXTERN
 286
 287 #endif /* defined (BUILDSYM_H) */