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