gdb/buildsym.h

   1 /* Build symbol tables in GDB's internal format.
   2    Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1995, 1996,
   3    1997, 1998, 1999, 2000, 2002, 2003 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22 #if !defined (BUILDSYM_H)
  23 #define BUILDSYM_H 1
  24
  25 /* This module provides definitions used for creating and adding to
  26    the symbol table.  These routines are called from various symbol-
  27    file-reading routines.
  28
  29    They originated in dbxread.c of gdb-4.2, and were split out to
  30    make xcoffread.c more maintainable by sharing code.
  31
  32    Variables declared in this file can be defined by #define-ing the
  33    name EXTERN to null.  It is used to declare variables that are
  34    normally extern, but which get defined in a single module using
  35    this technique.  */
  36
  37 struct block;
  38
  39 #ifndef EXTERN
  40 #define EXTERN extern
  41 #endif
  42
  43 #define HASHSIZE 127            /* Size of things hashed via
  44                                    hashname() */
  45
  46 /* Name of source file whose symbol data we are now processing.  This
  47    comes from a symbol of type N_SO. */
  48
  49 EXTERN char *last_source_file;
  50
  51 /* Core address of start of text of current source file.  This too
  52    comes from the N_SO symbol. */
  53
  54 EXTERN CORE_ADDR last_source_start_addr;
  55
  56 /* The list of sub-source-files within the current individual
  57    compilation.  Each file gets its own symtab with its own linetable
  58    and associated info, but they all share one blockvector.  */
  59
  60 struct subfile
  61   {
  62     struct subfile *next;
  63     char *name;
  64     char *dirname;
  65     struct linetable *line_vector;
  66     int line_vector_length;
  67     enum language language;
  68     char *debugformat;
  69   };
  70
  71 EXTERN struct subfile *subfiles;
  72
  73 EXTERN struct subfile *current_subfile;
  74
  75 /* Global variable which, when set, indicates that we are processing a
  76    .o file compiled with gcc */
  77
  78 EXTERN unsigned char processing_gcc_compilation;
  79
  80 /* When set, we are processing a .o file compiled by sun acc.  This is
  81    misnamed; it refers to all stabs-in-elf implementations which use
  82    N_UNDF the way Sun does, including Solaris gcc.  Hopefully all
  83    stabs-in-elf implementations ever invented will choose to be
  84    compatible.  */
  85
  86 EXTERN unsigned char processing_acc_compilation;
  87
  88 /* Count symbols as they are processed, for error messages.  */
  89
  90 EXTERN unsigned int symnum;
  91
  92 /* Record the symbols defined for each context in a list.  We don't
  93    create a struct block for the context until we know how long to
  94    make it.  */
  95
  96 #define PENDINGSIZE 100
  97
  98 struct pending
  99   {
 100     struct pending *next;
 101     int nsyms;
 102     struct symbol *symbol[PENDINGSIZE];
 103   };
 104
 105 /* Here are the three lists that symbols are put on.  */
 106
 107 /* static at top level, and types */
 108
 109 EXTERN struct pending *file_symbols;
 110
 111 /* global functions and variables */
 112
 113 EXTERN struct pending *global_symbols;
 114
 115 /* everything local to lexical context */
 116
 117 EXTERN struct pending *local_symbols;
 118
 119 /* func params local to lexical  context */
 120
 121 EXTERN struct pending *param_symbols;
 122
 123 /* Stack representing unclosed lexical contexts (that will become
 124    blocks, eventually).  */
 125
 126 struct context_stack
 127   {
 128     /* Outer locals at the time we entered */
 129
 130     struct pending *locals;
 131
 132     /* Pending func params at the time we entered */
 133
 134     struct pending *params;
 135
 136     /* Pointer into blocklist as of entry */
 137
 138     struct pending_block *old_blocks;
 139
 140     /* Name of function, if any, defining context */
 141
 142     struct symbol *name;
 143
 144     /* PC where this context starts */
 145
 146     CORE_ADDR start_addr;
 147
 148     /* Temp slot for exception handling. */
 149
 150     CORE_ADDR end_addr;
 151
 152     /* For error-checking matching push/pop */
 153
 154     int depth;
 155
 156   };
 157
 158 EXTERN struct context_stack *context_stack;
 159
 160 /* Index of first unused entry in context stack.  */
 161
 162 EXTERN int context_stack_depth;
 163
 164 /* Currently allocated size of context stack.  */
 165
 166 EXTERN int context_stack_size;
 167
 168 /* Non-zero if the context stack is empty.  */
 169 #define outermost_context_p() (context_stack_depth == 0)
 170
 171 /* Nonzero if within a function (so symbols should be local, if
 172    nothing says specifically).  */
 173
 174 EXTERN int within_function;
 175
 176 /* List of blocks already made (lexical contexts already closed).
 177    This is used at the end to make the blockvector.  */
 178
 179 struct pending_block
 180   {
 181     struct pending_block *next;
 182     struct block *block;
 183   };
 184
 185 /* Pointer to the head of a linked list of symbol blocks which have
 186    already been finalized (lexical contexts already closed) and which
 187    are just waiting to be built into a blockvector when finalizing the
 188    associated symtab. */
 189
 190 EXTERN struct pending_block *pending_blocks;
 191 \f
 192
 193 struct subfile_stack
 194   {
 195     struct subfile_stack *next;
 196     char *name;
 197   };
 198
 199 EXTERN struct subfile_stack *subfile_stack;
 200
 201 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
 202
 203 /* Function to invoke get the next symbol.  Return the symbol name. */
 204
 205 EXTERN char *(*next_symbol_text_func) (struct objfile *);
 206
 207 /* Vector of types defined so far, indexed by their type numbers.
 208    Used for both stabs and coff.  (In newer sun systems, dbx uses a
 209    pair of numbers in parens, as in "(SUBFILENUM,NUMWITHINSUBFILE)".
 210    Then these numbers must be translated through the type_translations
 211    hash table to get the index into the type vector.)  */
 212
 213 EXTERN struct type **type_vector;
 214
 215 /* Number of elements allocated for type_vector currently.  */
 216
 217 EXTERN int type_vector_length;
 218
 219 /* Initial size of type vector.  Is realloc'd larger if needed, and
 220    realloc'd down to the size actually used, when completed.  */
 221
 222 #define INITIAL_TYPE_VECTOR_LENGTH      160
 223
 224 extern void add_free_pendings (struct pending *list);
 225
 226 extern void add_symbol_to_list (struct symbol *symbol,
 227                                 struct pending **listhead);
 228
 229 extern struct symbol *find_symbol_in_list (struct pending *list,
 230                                            char *name, int length);
 231
 232 extern void finish_block (struct symbol *symbol,
 233                           struct pending **listhead,
 234                           struct pending_block *old_blocks,
 235                           CORE_ADDR start, CORE_ADDR end,
 236                           struct objfile *objfile);
 237
 238 extern void really_free_pendings (void *dummy);
 239
 240 extern void start_subfile (char *name, char *dirname);
 241
 242 extern void patch_subfile_names (struct subfile *subfile, char *name);
 243
 244 extern void push_subfile (void);
 245
 246 extern char *pop_subfile (void);
 247
 248 extern struct symtab *end_symtab (CORE_ADDR end_addr,
 249                                   struct objfile *objfile, int section);
 250
 251 /* Defined in stabsread.c.  */
 252
 253 extern void scan_file_globals (struct objfile *objfile);
 254
 255 extern void buildsym_new_init (void);
 256
 257 extern void buildsym_init (void);
 258
 259 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
 260
 261 extern struct context_stack *pop_context (void);
 262
 263 extern void record_line (struct subfile *subfile, int line, CORE_ADDR pc);
 264
 265 extern void start_symtab (char *name, char *dirname, CORE_ADDR start_addr);
 266
 267 extern int hashname (char *name);
 268
 269 extern void free_pending_blocks (void);
 270
 271 /* FIXME: Note that this is used only in buildsym.c and dstread.c,
 272    which should be fixed to not need direct access to
 273    record_pending_block. */
 274
 275 extern void record_pending_block (struct objfile *objfile,
 276                                   struct block *block,
 277                                   struct pending_block *opblock);
 278
 279 extern void record_debugformat (char *format);
 280
 281 extern void merge_symbol_lists (struct pending **srclist,
 282                                 struct pending **targetlist);
 283
 284 /* The macro table for the compilation unit whose symbols we're
 285    currently reading.  All the symtabs for this CU will point to this.  */
 286 EXTERN struct macro_table *pending_macros;
 287
 288 #undef EXTERN
 289
 290 #endif /* defined (BUILDSYM_H) */