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