2002-10-25 Andrew Cagney <cagney@redhat.com>
[external/binutils.git] / gdb / stabsread.h
1 /* Include file for stabs debugging format support functions.
2    Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
3    1996, 1997, 1999, 2000 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, USA.  */
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 /* Hash table of global symbols whose values are not known yet.
35    They are chained thru the SYMBOL_VALUE_CHAIN, since we don't
36    have the correct data for that slot yet.
37
38    The use of the LOC_BLOCK code in this chain is nonstandard--
39    it refers to a FORTRAN common block rather than the usual meaning, and
40    the such LOC_BLOCK symbols use their fields in nonstandard ways.  */
41
42 EXTERN struct symbol *global_sym_chain[HASHSIZE];
43
44 extern void common_block_start (char *, struct objfile *);
45 extern void common_block_end (struct objfile *);
46
47 /* Kludge for xcoffread.c */
48
49 struct pending_stabs
50   {
51     int count;
52     int length;
53     char *stab[1];
54   };
55
56 EXTERN struct pending_stabs *global_stabs;
57
58 /* The type code that process_one_symbol saw on its previous invocation.
59    Used to detect pairs of N_SO symbols. */
60
61 EXTERN int previous_stab_code;
62 \f
63 /* Support for Sun changes to dbx symbol format */
64
65 /* For each identified header file, we have a table of types defined
66    in that header file.
67
68    header_files maps header file names to their type tables.
69    It is a vector of n_header_files elements.
70    Each element describes one header file.
71    It contains a vector of types.
72
73    Sometimes it can happen that the same header file produces
74    different results when included in different places.
75    This can result from conditionals or from different
76    things done before including the file.
77    When this happens, there are multiple entries for the file in this table,
78    one entry for each distinct set of results.
79    The entries are distinguished by the INSTANCE field.
80    The INSTANCE field appears in the N_BINCL and N_EXCL symbol table and is
81    used to match header-file references to their corresponding data.  */
82
83 struct header_file
84   {
85
86     /* Name of header file */
87
88     char *name;
89
90     /* Numeric code distinguishing instances of one header file that produced
91        different results when included.  It comes from the N_BINCL or N_EXCL. */
92
93     int instance;
94
95     /* Pointer to vector of types */
96
97     struct type **vector;
98
99     /* Allocated length (# elts) of that vector */
100
101     int length;
102
103   };
104
105 /* The table of header_files of this OBJFILE. */
106 #define HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->header_files)
107
108 /* The actual length of HEADER_FILES. */
109 #define N_HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->n_header_files)
110
111 /* The allocated lengh of HEADER_FILES. */
112 #define N_ALLOCATED_HEADER_FILES(OBJFILE) \
113   (DBX_SYMFILE_INFO (OBJFILE)->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 == 0 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 deprecated_complaint unknown_symtype_complaint;
132 extern struct deprecated_complaint unknown_symchar_complaint;
133
134 extern struct type *read_type (char **, struct objfile *);
135
136 extern void cleanup_undefined_types (void);
137
138 extern struct type **dbx_lookup_type (int[2]);
139
140 extern long read_number (char **, int);
141
142 extern void add_undefined_type (struct type *);
143
144 extern struct symbol *define_symbol (CORE_ADDR, char *, int, int,
145                                      struct objfile *);
146
147 extern void stabsread_init (void);
148
149 extern void stabsread_new_init (void);
150
151 extern void start_stabs (void);
152
153 extern void end_stabs (void);
154
155 extern void finish_global_stabs (struct objfile *objfile);
156 \f
157 #if 0 /* OBSOLETE OS9K */
158 // OBSOLETE EXTERN int os9k_stabs;
159 #endif /* OBSOLETE OS9K */
160 \f
161 /* COFF files can have multiple .stab sections, if they are linked
162    using --split-by-reloc.  This linked list is used to pass the
163    information into the functions in dbxread.c.  */
164 struct stab_section_list
165   {
166     /* Next in list.  */
167     struct stab_section_list *next;
168
169     /* Stab section.  */
170     asection *section;
171   };
172 \f
173 /* Functions exported by dbxread.c.  These are not in stabsread.c because
174    they are only used by some stabs readers.  */
175
176 extern struct partial_symtab *end_psymtab (struct partial_symtab *pst,
177                                            char **include_list,
178                                            int num_includes,
179                                            int capping_symbol_offset,
180                                            CORE_ADDR capping_text,
181                                            struct partial_symtab
182                                            **dependency_list,
183                                            int number_dependencies,
184                                            int textlow_not_set);
185
186 extern void process_one_symbol (int, int, CORE_ADDR, char *,
187                                 struct section_offsets *, struct objfile *);
188
189 extern void elfstab_build_psymtabs (struct objfile *objfile,
190                                     int mainline,
191                                     file_ptr staboff, unsigned int stabsize,
192                                     file_ptr stabstroffset,
193                                     unsigned int stabstrsize);
194
195 extern void coffstab_build_psymtabs
196   (struct objfile *objfile,
197    int mainline,
198    CORE_ADDR textaddr, unsigned int textsize,
199    struct stab_section_list *stabs,
200    file_ptr stabstroffset, unsigned int stabstrsize);
201
202 extern void stabsect_build_psymtabs
203   (struct objfile *objfile,
204    int mainline, char *stab_name, char *stabstr_name, char *text_name);
205
206 extern void elfstab_offset_sections (struct objfile *,
207                                      struct partial_symtab *);
208
209 extern void process_later
210   (struct symbol *, char *,
211    int (*f) (struct objfile *, struct symbol *, char *));
212
213 extern int symbol_reference_defined (char **);
214
215 extern void ref_add (int, struct symbol *, char *, CORE_ADDR);
216
217 extern struct symbol *ref_search (int);
218
219 extern int resolve_cfront_continuation
220   (struct objfile *objfile, struct symbol *sym, char *p);
221
222 extern void free_header_files (void);
223
224 extern void init_header_files (void);
225
226 #undef EXTERN