gdb/stabsread.h

   1 /* Include file for stabs debugging format support functions.
   2    Copyright (C) 1986-2018 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 3 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, see <http://www.gnu.org/licenses/>.  */
  18
  19 struct objfile;
  20 enum language;
  21
  22 /* Definitions, prototypes, etc for stabs debugging format support
  23    functions.
  24
  25    Variables declared in this file can be defined by #define-ing
  26    the name EXTERN to null.  It is used to declare variables that
  27    are normally extern, but which get defined in a single module
  28    using this technique.  */
  29
  30 #ifndef EXTERN
  31 #define EXTERN extern
  32 #endif
  33
  34 #define HASHSIZE 127            /* Size of things hashed via
  35                                    hashname().  */
  36
  37 /* Compute a small integer hash code for the given name.  */
  38
  39 extern int hashname (const char *name);
  40
  41 /* Count symbols as they are processed, for error messages.  */
  42
  43 EXTERN unsigned int symnum;
  44
  45 #define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
  46
  47 /* Function to invoke get the next symbol.  Return the symbol name.  */
  48
  49 EXTERN const char *(*next_symbol_text_func) (struct objfile *);
  50
  51 /* Global variable which, when set, indicates that we are processing a
  52    .o file compiled with gcc */
  53
  54 EXTERN unsigned char processing_gcc_compilation;
  55
  56 /* Nonzero if within a function (so symbols should be local, if
  57    nothing says specifically).  */
  58
  59 EXTERN int within_function;
  60
  61 /* Hash table of global symbols whose values are not known yet.
  62    They are chained thru the SYMBOL_VALUE_CHAIN, since we don't
  63    have the correct data for that slot yet.
  64
  65    The use of the LOC_BLOCK code in this chain is nonstandard--
  66    it refers to a FORTRAN common block rather than the usual meaning, and
  67    the such LOC_BLOCK symbols use their fields in nonstandard ways.  */
  68
  69 EXTERN struct symbol *global_sym_chain[HASHSIZE];
  70
  71 extern void common_block_start (const char *, struct objfile *);
  72 extern void common_block_end (struct objfile *);
  73
  74 /* Kludge for xcoffread.c */
  75
  76 struct pending_stabs
  77   {
  78     int count;
  79     int length;
  80     char *stab[1];
  81   };
  82
  83 EXTERN struct pending_stabs *global_stabs;
  84
  85 /* The type code that process_one_symbol saw on its previous invocation.
  86    Used to detect pairs of N_SO symbols.  */
  87
  88 EXTERN int previous_stab_code;
  89 \f
  90 /* Support for Sun changes to dbx symbol format.  */
  91
  92 /* For each identified header file, we have a table of types defined
  93    in that header file.
  94
  95    header_files maps header file names to their type tables.
  96    It is a vector of n_header_files elements.
  97    Each element describes one header file.
  98    It contains a vector of types.
  99
 100    Sometimes it can happen that the same header file produces
 101    different results when included in different places.
 102    This can result from conditionals or from different
 103    things done before including the file.
 104    When this happens, there are multiple entries for the file in this table,
 105    one entry for each distinct set of results.
 106    The entries are distinguished by the INSTANCE field.
 107    The INSTANCE field appears in the N_BINCL and N_EXCL symbol table and is
 108    used to match header-file references to their corresponding data.  */
 109
 110 struct header_file
 111   {
 112
 113     /* Name of header file */
 114
 115     char *name;
 116
 117     /* Numeric code distinguishing instances of one header file that
 118        produced different results when included.  It comes from the
 119        N_BINCL or N_EXCL.  */
 120
 121     int instance;
 122
 123     /* Pointer to vector of types */
 124
 125     struct type **vector;
 126
 127     /* Allocated length (# elts) of that vector */
 128
 129     int length;
 130
 131   };
 132
 133 /* The table of header_files of this OBJFILE.  */
 134 #define HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->header_files)
 135
 136 /* The actual length of HEADER_FILES.  */
 137 #define N_HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->n_header_files)
 138
 139 /* The allocated lengh of HEADER_FILES.  */
 140 #define N_ALLOCATED_HEADER_FILES(OBJFILE) \
 141   (DBX_SYMFILE_INFO (OBJFILE)->n_allocated_header_files)
 142
 143 /* Within each object file, various header files are assigned numbers.
 144    A type is defined or referred to with a pair of numbers
 145    (FILENUM,TYPENUM) where FILENUM is the number of the header file
 146    and TYPENUM is the number within that header file.
 147    TYPENUM is the index within the vector of types for that header file.
 148
 149    FILENUM == 0 is special; it refers to the main source of the object file,
 150    and not to any header file.  FILENUM != 1 is interpreted by looking it up
 151    in the following table, which contains indices in header_files.  */
 152
 153 EXTERN int *this_object_header_files;
 154
 155 EXTERN int n_this_object_header_files;
 156
 157 EXTERN int n_allocated_this_object_header_files;
 158
 159 extern void cleanup_undefined_stabs_types (struct objfile *);
 160
 161 extern long read_number (char **, int);
 162
 163 extern struct symbol *define_symbol (CORE_ADDR, const char *, int, int,
 164                                      struct objfile *);
 165
 166 extern void stabsread_init (void);
 167
 168 extern void stabsread_new_init (void);
 169
 170 extern void start_stabs (void);
 171
 172 extern void end_stabs (void);
 173
 174 extern void finish_global_stabs (struct objfile *objfile);
 175 \f
 176 /* COFF files can have multiple .stab sections, if they are linked
 177    using --split-by-reloc.  This linked list is used to pass the
 178    information into the functions in dbxread.c.  */
 179 struct stab_section_list
 180   {
 181     /* Next in list.  */
 182     struct stab_section_list *next;
 183
 184     /* Stab section.  */
 185     asection *section;
 186   };
 187 \f
 188 /* Functions exported by dbxread.c.  These are not in stabsread.c because
 189    they are only used by some stabs readers.  */
 190
 191 extern struct partial_symtab *dbx_end_psymtab
 192   (struct objfile *objfile, struct partial_symtab *pst,
 193    const char **include_list, int num_includes,
 194    int capping_symbol_offset, CORE_ADDR capping_text,
 195    struct partial_symtab **dependency_list, int number_dependencies,
 196    int textlow_not_set);
 197
 198 extern void process_one_symbol (int, int, CORE_ADDR, const char *,
 199                                 const struct section_offsets *,
 200                                 struct objfile *, enum language);
 201
 202 extern void elfstab_build_psymtabs (struct objfile *objfile,
 203                                     asection *stabsect,
 204                                     file_ptr stabstroffset,
 205                                     unsigned int stabstrsize);
 206
 207 extern void coffstab_build_psymtabs
 208   (struct objfile *objfile,
 209    CORE_ADDR textaddr, unsigned int textsize,
 210    struct stab_section_list *stabs,
 211    file_ptr stabstroffset, unsigned int stabstrsize);
 212
 213 extern void stabsect_build_psymtabs (struct objfile *objfile, char *stab_name,
 214                                      char *stabstr_name, char *text_name);
 215
 216 extern int symbol_reference_defined (const char **);
 217
 218 extern void ref_add (int, struct symbol *, const char *, CORE_ADDR);
 219
 220 extern struct symbol *ref_search (int);
 221
 222 extern void free_header_files (void);
 223
 224 extern void init_header_files (void);
 225
 226 /* Scan through all of the global symbols defined in the object file,
 227    assigning values to the debugging symbols that need to be assigned
 228    to.  Get these symbols from the minimal symbol table.  */
 229
 230 extern void scan_file_globals (struct objfile *objfile);
 231
 232 #undef EXTERN