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