gdb/stabsread.h

   1 /* Include file for stabs debugging format support functions.
   2    Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
   3    1996, 1997, 1999, 2000, 2001, 2002, 2003, 2007, 2008, 2009, 2010, 2011
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 struct objfile;
  22
  23 /* Definitions, prototypes, etc for stabs debugging format support
  24    functions.
  25
  26    Variables declared in this file can be defined by #define-ing
  27    the name EXTERN to null.  It is used to declare variables that
  28    are normally extern, but which get defined in a single module
  29    using this technique.  */
  30
  31 #ifndef EXTERN
  32 #define EXTERN extern
  33 #endif
  34
  35 /* Hash table of global symbols whose values are not known yet.
  36    They are chained thru the SYMBOL_VALUE_CHAIN, since we don't
  37    have the correct data for that slot yet.
  38
  39    The use of the LOC_BLOCK code in this chain is nonstandard--
  40    it refers to a FORTRAN common block rather than the usual meaning, and
  41    the such LOC_BLOCK symbols use their fields in nonstandard ways.  */
  42
  43 EXTERN struct symbol *global_sym_chain[HASHSIZE];
  44
  45 extern void common_block_start (char *, struct objfile *);
  46 extern void common_block_end (struct objfile *);
  47
  48 /* Kludge for xcoffread.c */
  49
  50 struct pending_stabs
  51   {
  52     int count;
  53     int length;
  54     char *stab[1];
  55   };
  56
  57 EXTERN struct pending_stabs *global_stabs;
  58
  59 /* The type code that process_one_symbol saw on its previous invocation.
  60    Used to detect pairs of N_SO symbols.  */
  61
  62 EXTERN int previous_stab_code;
  63 \f
  64 /* Support for Sun changes to dbx symbol format.  */
  65
  66 /* For each identified header file, we have a table of types defined
  67    in that header file.
  68
  69    header_files maps header file names to their type tables.
  70    It is a vector of n_header_files elements.
  71    Each element describes one header file.
  72    It contains a vector of types.
  73
  74    Sometimes it can happen that the same header file produces
  75    different results when included in different places.
  76    This can result from conditionals or from different
  77    things done before including the file.
  78    When this happens, there are multiple entries for the file in this table,
  79    one entry for each distinct set of results.
  80    The entries are distinguished by the INSTANCE field.
  81    The INSTANCE field appears in the N_BINCL and N_EXCL symbol table and is
  82    used to match header-file references to their corresponding data.  */
  83
  84 struct header_file
  85   {
  86
  87     /* Name of header file */
  88
  89     char *name;
  90
  91     /* Numeric code distinguishing instances of one header file that
  92        produced different results when included.  It comes from the
  93        N_BINCL or N_EXCL.  */
  94
  95     int instance;
  96
  97     /* Pointer to vector of types */
  98
  99     struct type **vector;
 100
 101     /* Allocated length (# elts) of that vector */
 102
 103     int length;
 104
 105   };
 106
 107 /* The table of header_files of this OBJFILE.  */
 108 #define HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->header_files)
 109
 110 /* The actual length of HEADER_FILES.  */
 111 #define N_HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->n_header_files)
 112
 113 /* The allocated lengh of HEADER_FILES.  */
 114 #define N_ALLOCATED_HEADER_FILES(OBJFILE) \
 115   (DBX_SYMFILE_INFO (OBJFILE)->n_allocated_header_files)
 116
 117 /* Within each object file, various header files are assigned numbers.
 118    A type is defined or referred to with a pair of numbers
 119    (FILENUM,TYPENUM) where FILENUM is the number of the header file
 120    and TYPENUM is the number within that header file.
 121    TYPENUM is the index within the vector of types for that header file.
 122
 123    FILENUM == 0 is special; it refers to the main source of the object file,
 124    and not to any header file.  FILENUM != 1 is interpreted by looking it up
 125    in the following table, which contains indices in header_files.  */
 126
 127 EXTERN int *this_object_header_files;
 128
 129 EXTERN int n_this_object_header_files;
 130
 131 EXTERN int n_allocated_this_object_header_files;
 132
 133 extern void cleanup_undefined_types (struct objfile *);
 134
 135 extern long read_number (char **, int);
 136
 137 extern struct symbol *define_symbol (CORE_ADDR, char *, int, int,
 138                                      struct objfile *);
 139
 140 extern void stabsread_init (void);
 141
 142 extern void stabsread_new_init (void);
 143
 144 extern void start_stabs (void);
 145
 146 extern void end_stabs (void);
 147
 148 extern void finish_global_stabs (struct objfile *objfile);
 149 \f
 150 /* COFF files can have multiple .stab sections, if they are linked
 151    using --split-by-reloc.  This linked list is used to pass the
 152    information into the functions in dbxread.c.  */
 153 struct stab_section_list
 154   {
 155     /* Next in list.  */
 156     struct stab_section_list *next;
 157
 158     /* Stab section.  */
 159     asection *section;
 160   };
 161 \f
 162 /* Functions exported by dbxread.c.  These are not in stabsread.c because
 163    they are only used by some stabs readers.  */
 164
 165 extern struct partial_symtab *end_psymtab (struct partial_symtab *pst,
 166                                            char **include_list,
 167                                            int num_includes,
 168                                            int capping_symbol_offset,
 169                                            CORE_ADDR capping_text,
 170                                            struct partial_symtab
 171                                            **dependency_list,
 172                                            int number_dependencies,
 173                                            int textlow_not_set);
 174
 175 extern void process_one_symbol (int, int, CORE_ADDR, char *,
 176                                 struct section_offsets *, struct objfile *);
 177
 178 extern void elfstab_build_psymtabs (struct objfile *objfile,
 179                                     asection *stabsect,
 180                                     file_ptr stabstroffset,
 181                                     unsigned int stabstrsize);
 182
 183 extern void coffstab_build_psymtabs
 184   (struct objfile *objfile,
 185    CORE_ADDR textaddr, unsigned int textsize,
 186    struct stab_section_list *stabs,
 187    file_ptr stabstroffset, unsigned int stabstrsize);
 188
 189 extern void stabsect_build_psymtabs (struct objfile *objfile, char *stab_name,
 190                                      char *stabstr_name, char *text_name);
 191
 192 extern void elfstab_offset_sections (struct objfile *,
 193                                      struct partial_symtab *);
 194 extern int symbol_reference_defined (char **);
 195
 196 extern void ref_add (int, struct symbol *, char *, CORE_ADDR);
 197
 198 extern struct symbol *ref_search (int);
 199
 200 extern void free_header_files (void);
 201
 202 extern void init_header_files (void);
 203
 204 #undef EXTERN