gdb/stabsread.h

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