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, 2001, 2002, 2003 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
22struct objfile;
23
24/* Definitions, prototypes, etc for stabs debugging format support
25   functions.
26
27   Variables declared in this file can be defined by #define-ing
28   the name EXTERN to null.  It is used to declare variables that
29   are normally extern, but which get defined in a single module
30   using this technique.  */
31
32#ifndef EXTERN
33#define	EXTERN extern
34#endif
35
36/* Hash table of global symbols whose values are not known yet.
37   They are chained thru the SYMBOL_VALUE_CHAIN, since we don't
38   have the correct data for that slot yet.
39
40   The use of the LOC_BLOCK code in this chain is nonstandard--
41   it refers to a FORTRAN common block rather than the usual meaning, and
42   the such LOC_BLOCK symbols use their fields in nonstandard ways.  */
43
44EXTERN struct symbol *global_sym_chain[HASHSIZE];
45
46extern void common_block_start (char *, struct objfile *);
47extern void common_block_end (struct objfile *);
48
49/* Kludge for xcoffread.c */
50
51struct pending_stabs
52  {
53    int count;
54    int length;
55    char *stab[1];
56  };
57
58EXTERN struct pending_stabs *global_stabs;
59
60/* The type code that process_one_symbol saw on its previous invocation.
61   Used to detect pairs of N_SO symbols. */
62
63EXTERN int previous_stab_code;
64
65/* Support for Sun changes to dbx symbol format */
66
67/* For each identified header file, we have a table of types defined
68   in that header file.
69
70   header_files maps header file names to their type tables.
71   It is a vector of n_header_files elements.
72   Each element describes one header file.
73   It contains a vector of types.
74
75   Sometimes it can happen that the same header file produces
76   different results when included in different places.
77   This can result from conditionals or from different
78   things done before including the file.
79   When this happens, there are multiple entries for the file in this table,
80   one entry for each distinct set of results.
81   The entries are distinguished by the INSTANCE field.
82   The INSTANCE field appears in the N_BINCL and N_EXCL symbol table and is
83   used to match header-file references to their corresponding data.  */
84
85struct header_file
86  {
87
88    /* Name of header file */
89
90    char *name;
91
92    /* Numeric code distinguishing instances of one header file that produced
93       different results when included.  It comes from the N_BINCL or N_EXCL. */
94
95    int instance;
96
97    /* Pointer to vector of types */
98
99    struct type **vector;
100
101    /* Allocated length (# elts) of that vector */
102
103    int length;
104
105  };
106
107/* The table of header_files of this OBJFILE. */
108#define HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->header_files)
109
110/* The actual length of HEADER_FILES. */
111#define N_HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->n_header_files)
112
113/* The allocated lengh of HEADER_FILES. */
114#define N_ALLOCATED_HEADER_FILES(OBJFILE) \
115  (DBX_SYMFILE_INFO (OBJFILE)->n_allocated_header_files)
116
117/* Within each object file, various header files are assigned numbers.
118   A type is defined or referred to with a pair of numbers
119   (FILENUM,TYPENUM) where FILENUM is the number of the header file
120   and TYPENUM is the number within that header file.
121   TYPENUM is the index within the vector of types for that header file.
122
123   FILENUM == 0 is special; it refers to the main source of the object file,
124   and not to any header file.  FILENUM != 1 is interpreted by looking it up
125   in the following table, which contains indices in header_files.  */
126
127EXTERN int *this_object_header_files;
128
129EXTERN int n_this_object_header_files;
130
131EXTERN int n_allocated_this_object_header_files;
132
133extern void cleanup_undefined_types (void);
134
135extern long read_number (char **, int);
136
137extern struct symbol *define_symbol (CORE_ADDR, char *, int, int,
138				     struct objfile *);
139
140extern void stabsread_init (void);
141
142extern void stabsread_new_init (void);
143
144extern void start_stabs (void);
145
146extern void end_stabs (void);
147
148extern void finish_global_stabs (struct objfile *objfile);
149
150/* COFF files can have multiple .stab sections, if they are linked
151   using --split-by-reloc.  This linked list is used to pass the
152   information into the functions in dbxread.c.  */
153struct stab_section_list
154  {
155    /* Next in list.  */
156    struct stab_section_list *next;
157
158    /* Stab section.  */
159    asection *section;
160  };
161
162/* Functions exported by dbxread.c.  These are not in stabsread.c because
163   they are only used by some stabs readers.  */
164
165extern struct partial_symtab *end_psymtab (struct partial_symtab *pst,
166					   char **include_list,
167					   int num_includes,
168					   int capping_symbol_offset,
169					   CORE_ADDR capping_text,
170					   struct partial_symtab
171					   **dependency_list,
172					   int number_dependencies,
173					   int textlow_not_set);
174
175extern void process_one_symbol (int, int, CORE_ADDR, char *,
176				struct section_offsets *, struct objfile *);
177
178extern void elfstab_build_psymtabs (struct objfile *objfile,
179				    int mainline,
180				    asection *stabsect,
181				    file_ptr stabstroffset,
182				    unsigned int stabstrsize);
183
184extern void coffstab_build_psymtabs
185  (struct objfile *objfile,
186   int mainline,
187   CORE_ADDR textaddr, unsigned int textsize,
188   struct stab_section_list *stabs,
189   file_ptr stabstroffset, unsigned int stabstrsize);
190
191extern void stabsect_build_psymtabs
192  (struct objfile *objfile,
193   int mainline, char *stab_name, char *stabstr_name, char *text_name);
194
195extern void elfstab_offset_sections (struct objfile *,
196				     struct partial_symtab *);
197extern int symbol_reference_defined (char **);
198
199extern void ref_add (int, struct symbol *, char *, CORE_ADDR);
200
201extern struct symbol *ref_search (int);
202
203extern void free_header_files (void);
204
205extern void init_header_files (void);
206
207#undef EXTERN
208