gdb/buildsym.h

   1 /* Build symbol tables in GDB's internal format.
   2    Copyright (C) 1986-1991 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., 675 Mass Ave, Cambridge, MA 02139, 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 /* Convert stab register number (from `r' declaration) to a gdb REGNUM.  */
  40
  41 #ifndef STAB_REG_TO_REGNUM
  42 #define STAB_REG_TO_REGNUM(VALUE) (VALUE)
  43 #endif
  44 \f
  45 /* Name of source file whose symbol data we are now processing.
  46    This comes from a symbol of type N_SO.  */
  47
  48 EXTERN char *last_source_file;
  49
  50 /* Core address of start of text of current source file.
  51    This too comes from the N_SO symbol.  */
  52
  53 EXTERN CORE_ADDR last_source_start_addr;
  54
  55 /* The list of sub-source-files within the current individual compilation.
  56    Each file gets its own symtab with its own linetable and associated info,
  57    but they all share one blockvector.  */
  58
  59 struct subfile
  60 {
  61   struct subfile *next;
  62   char *name;
  63   char *dirname;
  64   struct linetable *line_vector;
  65   int line_vector_length;
  66 };
  67
  68 EXTERN struct subfile *subfiles;
  69
  70 EXTERN struct subfile *current_subfile;
  71
  72 /* Global variable which, when set, indicates that we are processing a
  73    .o file compiled with gcc */
  74
  75 EXTERN unsigned char processing_gcc_compilation;
  76
  77 /* Count symbols as they are processed, for error messages.  */
  78
  79 EXTERN unsigned int symnum;
  80
  81 /* Vector of types defined so far, indexed by their dbx type numbers.
  82    (In newer sun systems, dbx uses a pair of numbers in parens,
  83     as in "(SUBFILENUM,NUMWITHINSUBFILE)".  Then these numbers must be
  84     translated through the type_translations hash table to get
  85     the index into the type vector.)  */
  86
  87 EXTERN struct type **type_vector;
  88
  89 /* Number of elements allocated for type_vector currently.  */
  90
  91 EXTERN int type_vector_length;
  92
  93 /* Hash table of global symbols whose values are not known yet.
  94    They are chained thru the SYMBOL_VALUE_CHAIN, since we don't
  95    have the correct data for that slot yet.  */
  96 /* The use of the LOC_BLOCK code in this chain is nonstandard--
  97    it refers to a FORTRAN common block rather than the usual meaning.  */
  98
  99 #define HASHSIZE 127
 100 EXTERN struct symbol *global_sym_chain[HASHSIZE];
 101
 102 /* Record the symbols defined for each context in a list.
 103    We don't create a struct block for the context until we
 104    know how long to make it.  */
 105
 106 #define PENDINGSIZE 100
 107
 108 struct pending
 109 {
 110   struct pending *next;
 111   int nsyms;
 112   struct symbol *symbol[PENDINGSIZE];
 113 };
 114
 115 /* List of free `struct pending' structures for reuse.  */
 116 EXTERN struct pending *free_pendings;
 117
 118 /* Here are the three lists that symbols are put on.  */
 119
 120 EXTERN struct pending *file_symbols;    /* static at top level, and types */
 121
 122 EXTERN struct pending *global_symbols;  /* global functions and variables */
 123
 124 EXTERN struct pending *local_symbols;   /* everything local to lexic context */
 125
 126 /* Kludge for xcoffread.c */
 127 struct pending_stabs {
 128   int   count, length;
 129   char  *stab[1];
 130 };
 131
 132 EXTERN struct pending_stabs *global_stabs;
 133
 134 /* List of symbols declared since the last BCOMM.  This list is a tail
 135    of local_symbols.  When ECOMM is seen, the symbols on the list
 136    are noted so their proper addresses can be filled in later,
 137    using the common block base address gotten from the assembler
 138    stabs.  */
 139
 140 EXTERN struct pending *common_block;
 141 EXTERN int common_block_i;
 142
 143 /* Stack representing unclosed lexical contexts
 144    (that will become blocks, eventually).  */
 145
 146 struct context_stack
 147 {
 148   struct pending *locals;       /* Outer locals at the time we entered */
 149   struct pending_block *old_blocks; /* Pointer into blocklist as of entry */
 150   struct symbol *name;          /* Name of function, if any, defining context*/
 151   CORE_ADDR start_addr;         /* PC where this context starts */
 152   CORE_ADDR end_addr;           /* Temp slot for exception handling. */
 153   int depth;                    /* For error-checking matching push/pop */
 154 };
 155
 156 EXTERN struct context_stack *context_stack;
 157
 158 /* Index of first unused entry in context stack.  */
 159 EXTERN int context_stack_depth;
 160
 161 /* Currently allocated size of context stack.  */
 162
 163 EXTERN int context_stack_size;
 164
 165 /* Macro "function" for popping contexts from the stack.  Pushing is done
 166    by a real function, push_context.  This returns a pointer to a struct
 167    context_stack.  */
 168
 169 #define pop_context()   \
 170       (&context_stack[--context_stack_depth]);
 171
 172 /* Nonzero if within a function (so symbols should be local,
 173    if nothing says specifically).  */
 174
 175 EXTERN int within_function;
 176
 177 /* List of blocks already made (lexical contexts already closed).
 178    This is used at the end to make the blockvector.  */
 179
 180 struct pending_block
 181 {
 182   struct pending_block *next;
 183   struct block *block;
 184 };
 185
 186 EXTERN struct pending_block *pending_blocks;
 187
 188 extern CORE_ADDR startup_file_start;    /* From blockframe.c */
 189 extern CORE_ADDR startup_file_end;      /* From blockframe.c */
 190
 191 /* Global variable which, when set, indicates that we are processing a
 192    .o file compiled with gcc */
 193
 194 EXTERN unsigned char processing_gcc_compilation;
 195
 196 /* The type code that process_one_symbol saw on its previous invocation.
 197    Used to detect pairs of N_SO symbols. */
 198
 199 EXTERN int previous_stab_code;
 200
 201 /* Setup a define to deal cleanly with the underscore problem */
 202
 203 #ifdef NAMES_HAVE_UNDERSCORE
 204 #define HASH_OFFSET 1
 205 #else
 206 #define HASH_OFFSET 0
 207 #endif
 208 \f
 209 /* Support for Sun changes to dbx symbol format */
 210
 211 /* For each identified header file, we have a table of types defined
 212    in that header file.
 213
 214    header_files maps header file names to their type tables.
 215    It is a vector of n_header_files elements.
 216    Each element describes one header file.
 217    It contains a vector of types.
 218
 219    Sometimes it can happen that the same header file produces
 220    different results when included in different places.
 221    This can result from conditionals or from different
 222    things done before including the file.
 223    When this happens, there are multiple entries for the file in this table,
 224    one entry for each distinct set of results.
 225    The entries are distinguished by the INSTANCE field.
 226    The INSTANCE field appears in the N_BINCL and N_EXCL symbol table and is
 227    used to match header-file references to their corresponding data.  */
 228
 229 struct header_file
 230 {
 231   char *name;                   /* Name of header file */
 232   int instance;                 /* Numeric code distinguishing instances
 233                                    of one header file that produced
 234                                    different results when included.
 235                                    It comes from the N_BINCL or N_EXCL.  */
 236   struct type **vector;         /* Pointer to vector of types */
 237   int length;                   /* Allocated length (# elts) of that vector */
 238 };
 239
 240 EXTERN struct header_file *header_files;
 241
 242 EXTERN int n_header_files;
 243
 244 EXTERN int n_allocated_header_files;
 245
 246 /* Within each object file, various header files are assigned numbers.
 247    A type is defined or referred to with a pair of numbers
 248    (FILENUM,TYPENUM) where FILENUM is the number of the header file
 249    and TYPENUM is the number within that header file.
 250    TYPENUM is the index within the vector of types for that header file.
 251
 252    FILENUM == 1 is special; it refers to the main source of the object file,
 253    and not to any header file.  FILENUM != 1 is interpreted by looking it up
 254    in the following table, which contains indices in header_files.  */
 255
 256 EXTERN int *this_object_header_files;
 257
 258 EXTERN int n_this_object_header_files;
 259
 260 EXTERN int n_allocated_this_object_header_files;
 261
 262 /* When a header file is getting special overriding definitions
 263    for one source file, record here the header_files index
 264    of its normal definition vector.
 265    At other times, this is -1.  */
 266
 267 EXTERN int header_file_prev_index;
 268
 269 struct subfile_stack
 270 {
 271   struct subfile_stack *next;
 272   char *name;
 273   int prev_index;
 274 };
 275
 276 EXTERN struct subfile_stack *subfile_stack;
 277
 278 extern struct complaint unknown_symtype_complaint;
 279
 280 #define next_symbol_text() (*next_symbol_text_func)()
 281
 282 /* Function to invoke get the next symbol.  Return the symbol name. */
 283
 284 EXTERN char *(*next_symbol_text_func) PARAMS ((void));
 285
 286 extern void
 287 add_symbol_to_list PARAMS ((struct symbol *, struct pending **));
 288
 289 extern struct symbol *
 290 find_symbol_in_list PARAMS ((struct pending *, char *, int));
 291
 292 extern void
 293 read_type_number PARAMS ((char **, int *));
 294
 295 extern struct type *
 296 read_type PARAMS ((char **, struct objfile *));
 297
 298 extern struct type **
 299 dbx_lookup_type PARAMS ((int [2]));
 300
 301 extern long
 302 read_number PARAMS ((char **, int));
 303
 304 extern void
 305 finish_block PARAMS ((struct symbol *, struct pending **,
 306                       struct pending_block *, CORE_ADDR, CORE_ADDR,
 307                       struct objfile *));
 308
 309 extern void
 310 add_undefined_type PARAMS ((struct type *));
 311
 312 extern void
 313 really_free_pendings PARAMS ((int foo));
 314
 315 extern void
 316 start_subfile PARAMS ((char *, char *));
 317
 318 extern void
 319 push_subfile PARAMS ((void));
 320
 321 extern char *
 322 pop_subfile PARAMS ((void));
 323
 324 extern struct symtab *
 325 end_symtab PARAMS ((CORE_ADDR, int, int,struct objfile *));
 326
 327 extern void
 328 scan_file_globals PARAMS ((struct objfile *));
 329
 330 extern void
 331 buildsym_new_init PARAMS ((void));
 332
 333 extern void
 334 buildsym_init PARAMS ((void));
 335
 336 extern struct context_stack *
 337 push_context PARAMS ((int, CORE_ADDR));
 338
 339 extern void
 340 record_line PARAMS ((struct subfile *, int, CORE_ADDR));
 341
 342 extern void
 343 start_symtab PARAMS ((char *, char *, CORE_ADDR));
 344
 345 extern struct symbol *
 346 define_symbol PARAMS ((unsigned int, char *, int, int, struct objfile *));
 347
 348 extern struct partial_symtab *
 349 start_psymtab PARAMS ((struct objfile *, CORE_ADDR, char *, CORE_ADDR, int,
 350                        struct partial_symbol *, struct partial_symbol *));
 351
 352 extern void
 353 end_psymtab PARAMS ((struct partial_symtab *, char **, int, int, CORE_ADDR,
 354                      struct partial_symtab **, int));
 355
 356 extern void
 357 process_one_symbol PARAMS ((int, int, CORE_ADDR, char *, int));
 358
 359 extern int
 360 hashname PARAMS ((char *));
 361
 362 #endif  /* defined (BUILDSYM_H) */