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