* solist.h (target_so_ops.find_and_open_solib): Clarify usage of
[external/binutils.git] / gdb / stabsread.h
1 /* Include file for stabs debugging format support functions.
2    Copyright (C) 1986-2013 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
21 /* Definitions, prototypes, etc for stabs debugging format support
22    functions.
23
24    Variables declared in this file can be defined by #define-ing
25    the name EXTERN to null.  It is used to declare variables that
26    are normally extern, but which get defined in a single module
27    using this technique.  */
28
29 #ifndef EXTERN
30 #define EXTERN extern
31 #endif
32
33 /* Hash table of global symbols whose values are not known yet.
34    They are chained thru the SYMBOL_VALUE_CHAIN, since we don't
35    have the correct data for that slot yet.
36
37    The use of the LOC_BLOCK code in this chain is nonstandard--
38    it refers to a FORTRAN common block rather than the usual meaning, and
39    the such LOC_BLOCK symbols use their fields in nonstandard ways.  */
40
41 EXTERN struct symbol *global_sym_chain[HASHSIZE];
42
43 extern void common_block_start (char *, struct objfile *);
44 extern void common_block_end (struct objfile *);
45
46 /* Kludge for xcoffread.c */
47
48 struct pending_stabs
49   {
50     int count;
51     int length;
52     char *stab[1];
53   };
54
55 EXTERN struct pending_stabs *global_stabs;
56
57 /* The type code that process_one_symbol saw on its previous invocation.
58    Used to detect pairs of N_SO symbols.  */
59
60 EXTERN int previous_stab_code;
61 \f
62 /* Support for Sun changes to dbx symbol format.  */
63
64 /* For each identified header file, we have a table of types defined
65    in that header file.
66
67    header_files maps header file names to their type tables.
68    It is a vector of n_header_files elements.
69    Each element describes one header file.
70    It contains a vector of types.
71
72    Sometimes it can happen that the same header file produces
73    different results when included in different places.
74    This can result from conditionals or from different
75    things done before including the file.
76    When this happens, there are multiple entries for the file in this table,
77    one entry for each distinct set of results.
78    The entries are distinguished by the INSTANCE field.
79    The INSTANCE field appears in the N_BINCL and N_EXCL symbol table and is
80    used to match header-file references to their corresponding data.  */
81
82 struct header_file
83   {
84
85     /* Name of header file */
86
87     char *name;
88
89     /* Numeric code distinguishing instances of one header file that
90        produced different results when included.  It comes from the
91        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 void cleanup_undefined_stabs_types (struct objfile *);
132
133 extern long read_number (char **, int);
134
135 extern struct symbol *define_symbol (CORE_ADDR, char *, int, int,
136                                      struct objfile *);
137
138 extern void stabsread_init (void);
139
140 extern void stabsread_new_init (void);
141
142 extern void start_stabs (void);
143
144 extern void end_stabs (void);
145
146 extern void finish_global_stabs (struct objfile *objfile);
147 \f
148 /* COFF files can have multiple .stab sections, if they are linked
149    using --split-by-reloc.  This linked list is used to pass the
150    information into the functions in dbxread.c.  */
151 struct stab_section_list
152   {
153     /* Next in list.  */
154     struct stab_section_list *next;
155
156     /* Stab section.  */
157     asection *section;
158   };
159 \f
160 /* Functions exported by dbxread.c.  These are not in stabsread.c because
161    they are only used by some stabs readers.  */
162
163 extern struct partial_symtab *end_psymtab (struct objfile *objfile,
164                                            struct partial_symtab *pst,
165                                            const char **include_list,
166                                            int num_includes,
167                                            int capping_symbol_offset,
168                                            CORE_ADDR capping_text,
169                                            struct partial_symtab
170                                            **dependency_list,
171                                            int number_dependencies,
172                                            int textlow_not_set);
173
174 extern void process_one_symbol (int, int, CORE_ADDR, char *,
175                                 const struct section_offsets *,
176                                 struct objfile *);
177
178 extern void elfstab_build_psymtabs (struct objfile *objfile,
179                                     asection *stabsect,
180                                     file_ptr stabstroffset,
181                                     unsigned int stabstrsize);
182
183 extern void coffstab_build_psymtabs
184   (struct objfile *objfile,
185    CORE_ADDR textaddr, unsigned int textsize,
186    struct stab_section_list *stabs,
187    file_ptr stabstroffset, unsigned int stabstrsize);
188
189 extern void stabsect_build_psymtabs (struct objfile *objfile, char *stab_name,
190                                      char *stabstr_name, char *text_name);
191
192 extern void elfstab_offset_sections (struct objfile *,
193                                      struct partial_symtab *);
194 extern int symbol_reference_defined (char **);
195
196 extern void ref_add (int, struct symbol *, char *, CORE_ADDR);
197
198 extern struct symbol *ref_search (int);
199
200 extern void free_header_files (void);
201
202 extern void init_header_files (void);
203
204 #undef EXTERN