Per-language symbol name hashing algorithm
[external/binutils.git] / gdb / stabsread.h
1 /* Include file for stabs debugging format support functions.
2    Copyright (C) 1986-2017 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 struct objfile;
20 enum language;
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 (const 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
91        produced different results when included.  It comes from the
92        N_BINCL or N_EXCL.  */
93
94     int instance;
95
96     /* Pointer to vector of types */
97
98     struct type **vector;
99
100     /* Allocated length (# elts) of that vector */
101
102     int length;
103
104   };
105
106 /* The table of header_files of this OBJFILE.  */
107 #define HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->header_files)
108
109 /* The actual length of HEADER_FILES.  */
110 #define N_HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->n_header_files)
111
112 /* The allocated lengh of HEADER_FILES.  */
113 #define N_ALLOCATED_HEADER_FILES(OBJFILE) \
114   (DBX_SYMFILE_INFO (OBJFILE)->n_allocated_header_files)
115
116 /* Within each object file, various header files are assigned numbers.
117    A type is defined or referred to with a pair of numbers
118    (FILENUM,TYPENUM) where FILENUM is the number of the header file
119    and TYPENUM is the number within that header file.
120    TYPENUM is the index within the vector of types for that header file.
121
122    FILENUM == 0 is special; it refers to the main source of the object file,
123    and not to any header file.  FILENUM != 1 is interpreted by looking it up
124    in the following table, which contains indices in header_files.  */
125
126 EXTERN int *this_object_header_files;
127
128 EXTERN int n_this_object_header_files;
129
130 EXTERN int n_allocated_this_object_header_files;
131
132 extern void cleanup_undefined_stabs_types (struct objfile *);
133
134 extern long read_number (char **, int);
135
136 extern struct symbol *define_symbol (CORE_ADDR, const char *, int, int,
137                                      struct objfile *);
138
139 extern void stabsread_init (void);
140
141 extern void stabsread_new_init (void);
142
143 extern void start_stabs (void);
144
145 extern void end_stabs (void);
146
147 extern void finish_global_stabs (struct objfile *objfile);
148 \f
149 /* COFF files can have multiple .stab sections, if they are linked
150    using --split-by-reloc.  This linked list is used to pass the
151    information into the functions in dbxread.c.  */
152 struct stab_section_list
153   {
154     /* Next in list.  */
155     struct stab_section_list *next;
156
157     /* Stab section.  */
158     asection *section;
159   };
160 \f
161 /* Functions exported by dbxread.c.  These are not in stabsread.c because
162    they are only used by some stabs readers.  */
163
164 extern struct partial_symtab *dbx_end_psymtab
165   (struct objfile *objfile, struct partial_symtab *pst,
166    const char **include_list, int num_includes,
167    int capping_symbol_offset, CORE_ADDR capping_text,
168    struct partial_symtab **dependency_list, int number_dependencies,
169    int textlow_not_set);
170
171 extern void process_one_symbol (int, int, CORE_ADDR, const char *,
172                                 const struct section_offsets *,
173                                 struct objfile *, enum language);
174
175 extern void elfstab_build_psymtabs (struct objfile *objfile,
176                                     asection *stabsect,
177                                     file_ptr stabstroffset,
178                                     unsigned int stabstrsize);
179
180 extern void coffstab_build_psymtabs
181   (struct objfile *objfile,
182    CORE_ADDR textaddr, unsigned int textsize,
183    struct stab_section_list *stabs,
184    file_ptr stabstroffset, unsigned int stabstrsize);
185
186 extern void stabsect_build_psymtabs (struct objfile *objfile, char *stab_name,
187                                      char *stabstr_name, char *text_name);
188
189 extern int symbol_reference_defined (const char **);
190
191 extern void ref_add (int, struct symbol *, const char *, CORE_ADDR);
192
193 extern struct symbol *ref_search (int);
194
195 extern void free_header_files (void);
196
197 extern void init_header_files (void);
198
199 #undef EXTERN