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