See gdb ChangeLog entry with header:
[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 EXTERN struct header_file *header_files;
110
111 EXTERN int n_header_files;
112
113 EXTERN int n_allocated_header_files;
114
115 /* Within each object file, various header files are assigned numbers.
116    A type is defined or referred to with a pair of numbers
117    (FILENUM,TYPENUM) where FILENUM is the number of the header file
118    and TYPENUM is the number within that header file.
119    TYPENUM is the index within the vector of types for that header file.
120
121    FILENUM == 1 is special; it refers to the main source of the object file,
122    and not to any header file.  FILENUM != 1 is interpreted by looking it up
123    in the following table, which contains indices in header_files.  */
124
125 EXTERN int *this_object_header_files;
126
127 EXTERN int n_this_object_header_files;
128
129 EXTERN int n_allocated_this_object_header_files;
130
131 extern struct complaint unknown_symtype_complaint;
132 extern struct complaint unknown_symchar_complaint;
133
134 extern struct type *
135 read_type PARAMS ((char **, struct objfile *));
136
137 extern void
138 cleanup_undefined_types PARAMS ((void));
139
140 extern struct type **
141 dbx_lookup_type PARAMS ((int [2]));
142
143 extern long
144 read_number PARAMS ((char **, int));
145
146 extern void
147 add_undefined_type PARAMS ((struct type *));
148
149 extern struct symbol *
150 define_symbol PARAMS ((CORE_ADDR, char *, int, int, struct objfile *));
151
152 extern void
153 stabsread_init PARAMS ((void));
154
155 extern void
156 stabsread_new_init PARAMS ((void));
157
158 extern void
159 start_stabs PARAMS ((void));
160
161 extern void
162 end_stabs PARAMS ((void));
163
164 extern void
165 finish_global_stabs PARAMS ((struct objfile *objfile));
166
167 extern void 
168 resolve_cfront_continuation PARAMS((struct objfile * objfile, 
169                 struct symbol * sym, char * p));
170 \f
171 EXTERN int os9k_stabs;
172 \f
173 /* COFF files can have multiple .stab sections, if they are linked
174    using --split-by-reloc.  This linked list is used to pass the
175    information into the functions in dbxread.c.  */
176 struct stab_section_list
177 {
178   /* Next in list.  */
179   struct stab_section_list *next;
180
181   /* Stab section.  */
182   asection *section;
183 };
184 \f
185 /* Functions exported by dbxread.c.  These are not in stabsread.c because
186    they are only used by some stabs readers.  */
187
188 extern struct partial_symtab *
189 start_psymtab PARAMS ((struct objfile *, struct section_offsets *, char *,
190                        CORE_ADDR, int, struct partial_symbol **,
191                        struct partial_symbol **));
192
193 extern struct partial_symtab *
194 end_psymtab PARAMS ((struct partial_symtab *pst,
195                      char **include_list,
196                      int num_includes,
197                      int capping_symbol_offset,
198                      CORE_ADDR capping_text,
199                      struct partial_symtab **dependency_list,
200                      int number_dependencies,
201                      int textlow_not_set));
202
203 extern void
204 process_one_symbol PARAMS ((int, int, CORE_ADDR, char *,
205                             struct section_offsets *, struct objfile *));
206
207 extern void elfstab_build_psymtabs
208   PARAMS ((struct objfile *objfile,
209            struct section_offsets *section_offsets,
210            int mainline,
211            file_ptr staboff, unsigned int stabsize,
212            file_ptr stabstroffset,
213            unsigned int stabstrsize));
214
215 extern void coffstab_build_psymtabs
216   PARAMS ((struct objfile *objfile,
217            struct section_offsets *section_offsets,
218            int mainline,
219            CORE_ADDR textaddr, unsigned int textsize,
220            struct stab_section_list *stabs,
221            file_ptr stabstroffset,
222            unsigned int stabstrsize));
223
224 extern void stabsect_build_psymtabs
225   PARAMS ((struct objfile *objfile,
226            struct section_offsets *section_offsets,
227            int mainline,
228            char *stab_name,
229            char *stabstr_name,
230            char *text_name));
231
232 extern void elfstab_offset_sections PARAMS ((struct objfile *,
233                                              struct partial_symtab *));
234
235 extern void process_later PARAMS ((struct symbol *, char *));
236
237 #undef EXTERN