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 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 #ifndef EXTERN
  38 #define EXTERN extern
  39 #endif
  40
  41 #define HASHSIZE 127            /* Size of things hashed via
  42                                    hashname() */
  43
  44 /* Name of source file whose symbol data we are now processing.  This
  45    comes from a symbol of type N_SO. */
  46
  47 EXTERN char *last_source_file;
  48
  49 /* Core address of start of text of current source file.  This too
  50    comes from the N_SO symbol. */
  51
  52 EXTERN CORE_ADDR last_source_start_addr;
  53
  54 /* The list of sub-source-files within the current individual
  55    compilation.  Each file gets its own symtab with its own linetable
  56    and associated info, but they all share one blockvector.  */
  57
  58 struct subfile
  59   {
  60     struct subfile *next;
  61     char *name;
  62     char *dirname;
  63     struct linetable *line_vector;
  64     int line_vector_length;
  65     enum language language;
  66     char *debugformat;
  67   };
  68
  69 EXTERN struct subfile *subfiles;
  70
  71 EXTERN struct subfile *current_subfile;
  72
  73 /* Global variable which, when set, indicates that we are processing a
  74    .o file compiled with gcc */
  75
  76 EXTERN unsigned char processing_gcc_compilation;
  77
  78 /* When set, we are processing a .o file compiled by sun acc.  This is
  79    misnamed; it refers to all stabs-in-elf implementations which use
  80    N_UNDF the way Sun does, including Solaris gcc.  Hopefully all
  81    stabs-in-elf implementations ever invented will choose to be
  82    compatible.  */
  83
  84 EXTERN unsigned char processing_acc_compilation;
  85
  86 /* elz: added this flag to know when a block is compiled with HP
  87    compilers (cc, aCC). This is necessary because of the macro
  88    COERCE_FLOAT_TO_DOUBLE defined in tm_hppa.h, which causes a
  89    coercion of float to double to always occur in parameter passing
  90    for a function called by gdb (see the function value_arg_coerce in
  91    valops.c). This is necessary only if the target was compiled with
  92    gcc, not with HP compilers or with g++ */
  93
  94 EXTERN unsigned char processing_hp_compilation;
  95
  96 /* Count symbols as they are processed, for error messages.  */
  97
  98 EXTERN unsigned int symnum;
  99
 100 /* Record the symbols defined for each context in a list.  We don't
 101    create a struct block for the context until we know how long to
 102    make it.  */
 103
 104 #define PENDINGSIZE 100
 105
 106 struct pending
 107   {
 108     struct pending *next;
 109     int nsyms;
 110     struct symbol *symbol[PENDINGSIZE];
 111   };
 112
 113 /* Here are the three lists that symbols are put on.  */
 114
 115 /* static at top level, and types */
 116
 117 EXTERN struct pending *file_symbols;
 118
 119 /* global functions and variables */
 120
 121 EXTERN struct pending *global_symbols;
 122
 123 /* everything local to lexical context */
 124
 125 EXTERN struct pending *local_symbols;
 126
 127 /* func params local to lexical  context */
 128
 129 EXTERN struct pending *param_symbols;
 130
 131 /* Stack representing unclosed lexical contexts (that will become
 132    blocks, eventually).  */
 133
 134 struct context_stack
 135   {
 136     /* Outer locals at the time we entered */
 137
 138     struct pending *locals;
 139
 140     /* Pending func params at the time we entered */
 141
 142     struct pending *params;
 143
 144     /* Pointer into blocklist as of entry */
 145
 146     struct pending_block *old_blocks;
 147
 148     /* Name of function, if any, defining context */
 149
 150     struct symbol *name;
 151
 152     /* PC where this context starts */
 153
 154     CORE_ADDR start_addr;
 155
 156     /* Temp slot for exception handling. */
 157
 158     CORE_ADDR end_addr;
 159
 160     /* For error-checking matching push/pop */
 161
 162     int depth;
 163
 164   };
 165
 166 EXTERN struct context_stack *context_stack;
 167
 168 /* Index of first unused entry in context stack.  */
 169
 170 EXTERN int context_stack_depth;
 171
 172 /* Currently allocated size of context stack.  */
 173
 174 EXTERN int context_stack_size;
 175
 176 /* Macro "function" for popping contexts from the stack.  Pushing is
 177    done by a real function, push_context.  This returns a pointer to a
 178    struct context_stack.  */
 179
 180 #define pop_context() (&context_stack[--context_stack_depth]);
 181
 182 /* Non-zero if the context stack is empty.  */
 183 #define outermost_context_p() (context_stack_depth == 0)
 184
 185 /* Nonzero if within a function (so symbols should be local, if
 186    nothing says specifically).  */
 187
 188 EXTERN int within_function;
 189
 190 /* List of blocks already made (lexical contexts already closed).
 191    This is used at the end to make the blockvector.  */
 192
 193 struct pending_block
 194   {
 195     struct pending_block *next;
 196     struct block *block;
 197   };
 198
 199 /* Pointer to the head of a linked list of symbol blocks which have
 200    already been finalized (lexical contexts already closed) and which
 201    are just waiting to be built into a blockvector when finalizing the
 202    associated symtab. */
 203
 204 EXTERN struct pending_block *pending_blocks;
 205 \f
 206
 207 struct subfile_stack
 208   {
 209     struct subfile_stack *next;
 210     char *name;
 211   };
 212
 213 EXTERN struct subfile_stack *subfile_stack;
 214
 215 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
 216
 217 /* Function to invoke get the next symbol.  Return the symbol name. */
 218
 219 EXTERN char *(*next_symbol_text_func) (struct objfile *);
 220
 221 /* Vector of types defined so far, indexed by their type numbers.
 222    Used for both stabs and coff.  (In newer sun systems, dbx uses a
 223    pair of numbers in parens, as in "(SUBFILENUM,NUMWITHINSUBFILE)".
 224    Then these numbers must be translated through the type_translations
 225    hash table to get the index into the type vector.)  */
 226
 227 EXTERN struct type **type_vector;
 228
 229 /* Number of elements allocated for type_vector currently.  */
 230
 231 EXTERN int type_vector_length;
 232
 233 /* Initial size of type vector.  Is realloc'd larger if needed, and
 234    realloc'd down to the size actually used, when completed.  */
 235
 236 #define INITIAL_TYPE_VECTOR_LENGTH      160
 237
 238 extern void add_free_pendings (struct pending *list);
 239
 240 extern void add_symbol_to_list (struct symbol *symbol,
 241                                 struct pending **listhead);
 242
 243 extern struct symbol *find_symbol_in_list (struct pending *list,
 244                                            char *name, int length);
 245
 246 extern void finish_block (struct symbol *symbol,
 247                           struct pending **listhead,
 248                           struct pending_block *old_blocks,
 249                           CORE_ADDR start, CORE_ADDR end,
 250                           struct objfile *objfile);
 251
 252 extern void really_free_pendings (PTR dummy);
 253
 254 extern void start_subfile (char *name, char *dirname);
 255
 256 extern void patch_subfile_names (struct subfile *subfile, char *name);
 257
 258 extern void push_subfile (void);
 259
 260 extern char *pop_subfile (void);
 261
 262 extern struct symtab *end_symtab (CORE_ADDR end_addr,
 263                                   struct objfile *objfile, int section);
 264
 265 /* Defined in stabsread.c.  */
 266
 267 extern void scan_file_globals (struct objfile *objfile);
 268
 269 extern void buildsym_new_init (void);
 270
 271 extern void buildsym_init (void);
 272
 273 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
 274
 275 extern void record_line (struct subfile *subfile, int line, CORE_ADDR pc);
 276
 277 extern void start_symtab (char *name, char *dirname, CORE_ADDR start_addr);
 278
 279 extern int hashname (char *name);
 280
 281 extern void free_pending_blocks (void);
 282
 283 /* OBSOLETE FIXME: Note that this is used only in buildsym.c and dstread.c, */
 284 /* OBSOLETE which should be fixed to not need direct access to */
 285 /* OBSOLETE make_blockvector. */
 286
 287 /* OBSOLETE extern struct blockvector *make_blockvector (struct objfile *objfile); */
 288
 289 /* FIXME: Note that this is used only in buildsym.c and dstread.c,
 290    which should be fixed to not need direct access to
 291    record_pending_block. */
 292
 293 extern void record_pending_block (struct objfile *objfile,
 294                                   struct block *block,
 295                                   struct pending_block *opblock);
 296
 297 extern void record_debugformat (char *format);
 298
 299 extern void merge_symbol_lists (struct pending **srclist,
 300                                 struct pending **targetlist);
 301
 302 /* The macro table for the compilation unit whose symbols we're
 303    currently reading.  All the symtabs for this CU will point to this.  */
 304 EXTERN struct macro_table *pending_macros;
 305
 306 #undef EXTERN
 307
 308 #endif /* defined (BUILDSYM_H) */