Initial creation of sourceware repository
[external/binutils.git] / gdb / stabsread.h
1 /* Include file for stabs debugging format support functions.
2    Copyright 1986-1991, 1992, 1993 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 2 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, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
19
20 /* Definitions, prototypes, etc for stabs debugging format support
21    functions.
22
23    Variables declared in this file can be defined by #define-ing
24    the name EXTERN to null.  It is used to declare variables that
25    are normally extern, but which get defined in a single module
26    using this technique.  */
27
28 #ifndef EXTERN
29 #define EXTERN extern
30 #endif
31
32 /* Convert stab register number (from `r' declaration) to a gdb REGNUM.  */
33
34 #ifndef STAB_REG_TO_REGNUM
35 #define STAB_REG_TO_REGNUM(VALUE) (VALUE)
36 #endif
37
38 /* Hash table of global symbols whose values are not known yet.
39    They are chained thru the SYMBOL_VALUE_CHAIN, since we don't
40    have the correct data for that slot yet.
41
42    The use of the LOC_BLOCK code in this chain is nonstandard--
43    it refers to a FORTRAN common block rather than the usual meaning, and
44    the such LOC_BLOCK symbols use their fields in nonstandard ways.  */
45
46 EXTERN struct symbol *global_sym_chain[HASHSIZE];
47
48 extern void common_block_start PARAMS ((char *, struct objfile *));
49 extern void common_block_end PARAMS ((struct objfile *));
50
51 /* Kludge for xcoffread.c */
52
53 struct pending_stabs
54 {
55   int count;
56   int length;
57   char *stab[1];
58 };
59
60 EXTERN struct pending_stabs *global_stabs;
61
62 /* The type code that process_one_symbol saw on its previous invocation.
63    Used to detect pairs of N_SO symbols. */
64
65 EXTERN int previous_stab_code;
66 \f
67 /* Support for Sun changes to dbx symbol format */
68
69 /* For each identified header file, we have a table of types defined
70    in that header file.
71
72    header_files maps header file names to their type tables.
73    It is a vector of n_header_files elements.
74    Each element describes one header file.
75    It contains a vector of types.
76
77    Sometimes it can happen that the same header file produces
78    different results when included in different places.
79    This can result from conditionals or from different
80    things done before including the file.
81    When this happens, there are multiple entries for the file in this table,
82    one entry for each distinct set of results.
83    The entries are distinguished by the INSTANCE field.
84    The INSTANCE field appears in the N_BINCL and N_EXCL symbol table and is
85    used to match header-file references to their corresponding data.  */
86
87 struct header_file
88 {
89
90   /* Name of header file */
91   
92   char *name;
93
94   /* Numeric code distinguishing instances of one header file that produced
95      different results when included.  It comes from the N_BINCL or N_EXCL. */
96
97   int instance;
98
99   /* Pointer to vector of types */
100
101   struct type **vector;
102
103   /* Allocated length (# elts) of that vector */
104
105   int length;
106
107 };
108
109 /* The table of header_files of this OBJFILE. */
110 #define HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->header_files)
111
112 /* The actual length of HEADER_FILES. */
113 #define N_HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->n_header_files)
114
115 /* The allocated lengh of HEADER_FILES. */
116 #define N_ALLOCATED_HEADER_FILES(OBJFILE) \
117   (DBX_SYMFILE_INFO (OBJFILE)->n_allocated_header_files)
118
119 /* Within each object file, various header files are assigned numbers.
120    A type is defined or referred to with a pair of numbers
121    (FILENUM,TYPENUM) where FILENUM is the number of the header file
122    and TYPENUM is the number within that header file.
123    TYPENUM is the index within the vector of types for that header file.
124
125    FILENUM == 0 is special; it refers to the main source of the object file,
126    and not to any header file.  FILENUM != 1 is interpreted by looking it up
127    in the following table, which contains indices in header_files.  */
128
129 EXTERN int *this_object_header_files;
130
131 EXTERN int n_this_object_header_files;
132
133 EXTERN int n_allocated_this_object_header_files;
134
135 extern struct complaint unknown_symtype_complaint;
136 extern struct complaint unknown_symchar_complaint;
137
138 extern struct type *
139 read_type PARAMS ((char **, struct objfile *));
140
141 extern void
142 cleanup_undefined_types PARAMS ((void));
143
144 extern struct type **
145 dbx_lookup_type PARAMS ((int [2]));
146
147 extern long
148 read_number PARAMS ((char **, int));
149
150 extern void
151 add_undefined_type PARAMS ((struct type *));
152
153 extern struct symbol *
154 define_symbol PARAMS ((CORE_ADDR, char *, int, int, struct objfile *));
155
156 extern void
157 stabsread_init PARAMS ((void));
158
159 extern void
160 stabsread_new_init PARAMS ((void));
161
162 extern void
163 start_stabs PARAMS ((void));
164
165 extern void
166 end_stabs PARAMS ((void));
167
168 extern void
169 finish_global_stabs PARAMS ((struct objfile *objfile));
170
171 \f
172 EXTERN int os9k_stabs;
173 \f
174 /* COFF files can have multiple .stab sections, if they are linked
175    using --split-by-reloc.  This linked list is used to pass the
176    information into the functions in dbxread.c.  */
177 struct stab_section_list
178 {
179   /* Next in list.  */
180   struct stab_section_list *next;
181
182   /* Stab section.  */
183   asection *section;
184 };
185 \f
186 /* Functions exported by dbxread.c.  These are not in stabsread.c because
187    they are only used by some stabs readers.  */
188
189 extern struct partial_symtab *
190 start_psymtab PARAMS ((struct objfile *, struct section_offsets *, char *,
191                        CORE_ADDR, int, struct partial_symbol **,
192                        struct partial_symbol **));
193
194 extern struct partial_symtab *
195 end_psymtab PARAMS ((struct partial_symtab *pst,
196                      char **include_list,
197                      int num_includes,
198                      int capping_symbol_offset,
199                      CORE_ADDR capping_text,
200                      struct partial_symtab **dependency_list,
201                      int number_dependencies,
202                      int textlow_not_set));
203
204 extern void
205 process_one_symbol PARAMS ((int, int, CORE_ADDR, char *,
206                             struct section_offsets *, struct objfile *));
207
208 extern void elfstab_build_psymtabs
209   PARAMS ((struct objfile *objfile,
210            struct section_offsets *section_offsets,
211            int mainline,
212            file_ptr staboff, unsigned int stabsize,
213            file_ptr stabstroffset,
214            unsigned int stabstrsize));
215
216 extern void coffstab_build_psymtabs
217   PARAMS ((struct objfile *objfile,
218            struct section_offsets *section_offsets,
219            int mainline,
220            CORE_ADDR textaddr, unsigned int textsize,
221            struct stab_section_list *stabs,
222            file_ptr stabstroffset,
223            unsigned int stabstrsize));
224
225 extern void stabsect_build_psymtabs
226   PARAMS ((struct objfile *objfile,
227            struct section_offsets *section_offsets,
228            int mainline,
229            char *stab_name,
230            char *stabstr_name,
231            char *text_name));
232
233 extern void elfstab_offset_sections PARAMS ((struct objfile *,
234                                              struct partial_symtab *));
235
236 extern void process_later 
237   PARAMS ((struct symbol *, char *, 
238            int (*f) PARAMS ((struct objfile *, struct symbol *, char *))));
239
240 extern int symbol_reference_defined PARAMS ((char **));
241
242 extern void ref_add PARAMS ((int, struct symbol *, char *, CORE_ADDR));
243
244 extern struct symbol * ref_search PARAMS ((int));
245
246 extern int resolve_cfront_continuation 
247   PARAMS ((struct objfile * objfile, struct symbol * sym, char * p));
248
249 #undef EXTERN