gdb/buildsym.h

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