gdb/buildsym.h

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