/* Build symbol tables in GDB's internal format.
- Copyright (C) 1986-1991 Free Software Foundation, Inc.
+ Copyright (C) 1986-2017 Free Software Foundation, Inc.
-This file is part of GDB.
+ This file is part of GDB.
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
+
+#if !defined (BUILDSYM_H)
+#define BUILDSYM_H 1
+
+struct objfile;
+struct symbol;
+struct addrmap;
+struct compunit_symtab;
/* This module provides definitions used for creating and adding to
the symbol table. These routines are called from various symbol-
- file-reading routines.
+ file-reading routines.
They originated in dbxread.c of gdb-4.2, and were split out to
make xcoffread.c more maintainable by sharing code.
- Variables declared in this file can be defined by #define-ing
- the name EXTERN to null. It is used to declare variables that
- are normally extern, but which get defined in a single module
- using this technique. */
+ Variables declared in this file can be defined by #define-ing the
+ name EXTERN to null. It is used to declare variables that are
+ normally extern, but which get defined in a single module using
+ this technique. */
-#ifndef EXTERN
-#define EXTERN extern
-#endif
+struct block;
+struct pending_block;
+
+struct dynamic_prop;
-extern void add_symbol_to_list ();
-struct symbol *find_symbol_in_list ();
-extern void read_type_number ();
-extern struct type *read_type ();
-extern struct type *read_range_type ();
-extern struct type *read_enum_type ();
-extern struct type *read_struct_type ();
-extern struct type *read_array_type ();
-extern struct type **read_args ();
-extern struct type **dbx_lookup_type ();
-extern long read_number ();
-extern void finish_block ();
-extern struct blockvector *make_blockvector ();
-extern void add_undefined_type ();
-extern void really_free_pendings ();
-extern void start_subfile ();
-extern void push_subfile ();
-extern char *pop_subfile ();
-extern struct symtab *end_symtab ();
-extern void scan_file_globals ();
-extern void buildsym_new_init ();
-extern void buildsym_init ();
-extern struct context_stack *push_context ();
-extern void record_line ();
-extern void start_symtab ();
-extern struct symbol *define_symbol ();
-extern struct partial_symtab *start_psymtab ();
-extern void end_psymtab();
-
-
-/* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
-
-#ifndef STAB_REG_TO_REGNUM
-#define STAB_REG_TO_REGNUM(VALUE) (VALUE)
+#ifndef EXTERN
+#define EXTERN extern
#endif
-\f
-/* Name of source file whose symbol data we are now processing.
- This comes from a symbol of type N_SO. */
-EXTERN char *last_source_file;
+#define HASHSIZE 127 /* Size of things hashed via
+ hashname(). */
-/* Core address of start of text of current source file.
- This too comes from the N_SO symbol. */
+/* Core address of start of text of current source file. This too
+ comes from the N_SO symbol. For Dwarf it typically comes from the
+ DW_AT_low_pc attribute of a DW_TAG_compile_unit DIE. */
EXTERN CORE_ADDR last_source_start_addr;
-/* The list of sub-source-files within the current individual compilation.
- Each file gets its own symtab with its own linetable and associated info,
- but they all share one blockvector. */
+/* The list of sub-source-files within the current individual
+ compilation. Each file gets its own symtab with its own linetable
+ and associated info, but they all share one blockvector. */
struct subfile
{
struct subfile *next;
+ /* Space for this is malloc'd. */
char *name;
- char *dirname;
+ /* Space for this is malloc'd. */
struct linetable *line_vector;
int line_vector_length;
+ /* The "containing" compunit. */
+ struct buildsym_compunit *buildsym_compunit;
+ enum language language;
+ struct symtab *symtab;
};
-EXTERN struct subfile *subfiles;
-
EXTERN struct subfile *current_subfile;
/* Global variable which, when set, indicates that we are processing a
EXTERN unsigned char processing_gcc_compilation;
+/* When set, we are processing a .o file compiled by sun acc. This is
+ misnamed; it refers to all stabs-in-elf implementations which use
+ N_UNDF the way Sun does, including Solaris gcc. Hopefully all
+ stabs-in-elf implementations ever invented will choose to be
+ compatible. */
+
+EXTERN unsigned char processing_acc_compilation;
+
/* Count symbols as they are processed, for error messages. */
EXTERN unsigned int symnum;
-/* Vector of types defined so far, indexed by their dbx type numbers.
- (In newer sun systems, dbx uses a pair of numbers in parens,
- as in "(SUBFILENUM,NUMWITHINSUBFILE)". Then these numbers must be
- translated through the type_translations hash table to get
- the index into the type vector.) */
+/* Record the symbols defined for each context in a list. We don't
+ create a struct block for the context until we know how long to
+ make it. */
-EXTERN struct type **type_vector;
+#define PENDINGSIZE 100
-/* Number of elements allocated for type_vector currently. */
+struct pending
+ {
+ struct pending *next;
+ int nsyms;
+ struct symbol *symbol[PENDINGSIZE];
+ };
-EXTERN int type_vector_length;
+/* Here are the three lists that symbols are put on. */
-/* Hash table of global symbols whose values are not known yet.
- They are chained thru the SYMBOL_VALUE_CHAIN, since we don't
- have the correct data for that slot yet. */
-/* The use of the LOC_BLOCK code in this chain is nonstandard--
- it refers to a FORTRAN common block rather than the usual meaning. */
+/* static at top level, and types */
-#define HASHSIZE 127
-EXTERN struct symbol *global_sym_chain[HASHSIZE];
+EXTERN struct pending *file_symbols;
-/* Record the symbols defined for each context in a list.
- We don't create a struct block for the context until we
- know how long to make it. */
+/* global functions and variables */
-#define PENDINGSIZE 100
+EXTERN struct pending *global_symbols;
-struct pending
-{
- struct pending *next;
- int nsyms;
- struct symbol *symbol[PENDINGSIZE];
-};
+/* everything local to lexical context */
-/* List of free `struct pending' structures for reuse. */
-EXTERN struct pending *free_pendings;
+EXTERN struct pending *local_symbols;
-/* Here are the three lists that symbols are put on. */
+/* "using" directives local to lexical context. */
-EXTERN struct pending *file_symbols; /* static at top level, and types */
+EXTERN struct using_direct *local_using_directives;
-EXTERN struct pending *global_symbols; /* global functions and variables */
+/* global "using" directives. */
-EXTERN struct pending *local_symbols; /* everything local to lexic context */
+EXTERN struct using_direct *global_using_directives;
-/* Kludge for xcoffread.c */
-struct pending_stabs {
- int count, length;
- char *stab[1];
-};
+/* Stack representing unclosed lexical contexts (that will become
+ blocks, eventually). */
-EXTERN struct pending_stabs *global_stabs;
-EXTERN struct pending_stabs *file_stabs;
+struct context_stack
+ {
+ /* Outer locals at the time we entered */
-/* List of symbols declared since the last BCOMM. This list is a tail
- of local_symbols. When ECOMM is seen, the symbols on the list
- are noted so their proper addresses can be filled in later,
- using the common block base address gotten from the assembler
- stabs. */
+ struct pending *locals;
-EXTERN struct pending *common_block;
-EXTERN int common_block_i;
+ /* Pending using directives at the time we entered. */
-/* Stack representing unclosed lexical contexts
- (that will become blocks, eventually). */
+ struct using_direct *local_using_directives;
-struct context_stack
-{
- struct pending *locals; /* Outer locals at the time we entered */
- struct pending_block *old_blocks; /* Pointer into blocklist as of entry */
- struct symbol *name; /* Name of function, if any, defining context*/
- CORE_ADDR start_addr; /* PC where this context starts */
- CORE_ADDR end_addr; /* Temp slot for exception handling. */
- int depth; /* For error-checking matching push/pop */
-};
+ /* Pointer into blocklist as of entry */
+
+ struct pending_block *old_blocks;
+
+ /* Name of function, if any, defining context */
+
+ struct symbol *name;
+
+ /* Expression that computes the frame base of the lexically enclosing
+ function, if any. NULL otherwise. */
+
+ struct dynamic_prop *static_link;
+
+ /* PC where this context starts */
+
+ CORE_ADDR start_addr;
+
+ /* Temp slot for exception handling. */
+
+ CORE_ADDR end_addr;
+
+ /* For error-checking matching push/pop */
+
+ int depth;
+
+ };
EXTERN struct context_stack *context_stack;
/* Index of first unused entry in context stack. */
+
EXTERN int context_stack_depth;
/* Currently allocated size of context stack. */
EXTERN int context_stack_size;
-/* Macro "function" for popping contexts from the stack. Pushing is done
- by a real function, push_context. This returns a pointer to a struct
- context_stack. */
-
-#define pop_context() \
- (&context_stack[--context_stack_depth]);
+/* Non-zero if the context stack is empty. */
+#define outermost_context_p() (context_stack_depth == 0)
-/* Nonzero if within a function (so symbols should be local,
- if nothing says specifically). */
+/* Nonzero if within a function (so symbols should be local, if
+ nothing says specifically). */
EXTERN int within_function;
-/* List of blocks already made (lexical contexts already closed).
- This is used at the end to make the blockvector. */
+/* The type of the record_line function. */
+typedef void (record_line_ftype) (struct subfile *subfile, int line,
+ CORE_ADDR pc);
-struct pending_block
-{
- struct pending_block *next;
- struct block *block;
-};
+\f
-EXTERN struct pending_block *pending_blocks;
+#define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
-extern CORE_ADDR startup_file_start; /* From blockframe.c */
-extern CORE_ADDR startup_file_end; /* From blockframe.c */
+/* Function to invoke get the next symbol. Return the symbol name. */
-/* Global variable which, when set, indicates that we are processing a
- .o file compiled with gcc */
+EXTERN const char *(*next_symbol_text_func) (struct objfile *);
-EXTERN unsigned char processing_gcc_compilation;
+extern void add_symbol_to_list (struct symbol *symbol,
+ struct pending **listhead);
-/* The type code that process_one_symbol saw on its previous invocation.
- Used to detect pairs of N_SO symbols. */
+extern struct symbol *find_symbol_in_list (struct pending *list,
+ char *name, int length);
-EXTERN int previous_stab_code;
+extern struct block *finish_block (struct symbol *symbol,
+ struct pending **listhead,
+ struct pending_block *old_blocks,
+ const struct dynamic_prop *static_link,
+ CORE_ADDR start,
+ CORE_ADDR end);
-/* Setup a define to deal cleanly with the underscore problem */
+extern void record_block_range (struct block *,
+ CORE_ADDR start, CORE_ADDR end_inclusive);
-#ifdef NAMES_HAVE_UNDERSCORE
-#define HASH_OFFSET 1
-#else
-#define HASH_OFFSET 0
-#endif
-\f
-/* Support for Sun changes to dbx symbol format */
-
-/* For each identified header file, we have a table of types defined
- in that header file.
-
- header_files maps header file names to their type tables.
- It is a vector of n_header_files elements.
- Each element describes one header file.
- It contains a vector of types.
-
- Sometimes it can happen that the same header file produces
- different results when included in different places.
- This can result from conditionals or from different
- things done before including the file.
- When this happens, there are multiple entries for the file in this table,
- one entry for each distinct set of results.
- The entries are distinguished by the INSTANCE field.
- The INSTANCE field appears in the N_BINCL and N_EXCL symbol table and is
- used to match header-file references to their corresponding data. */
-
-struct header_file
-{
- char *name; /* Name of header file */
- int instance; /* Numeric code distinguishing instances
- of one header file that produced
- different results when included.
- It comes from the N_BINCL or N_EXCL. */
- struct type **vector; /* Pointer to vector of types */
- int length; /* Allocated length (# elts) of that vector */
-};
+extern void really_free_pendings (void *dummy);
-EXTERN struct header_file *header_files;
+extern void start_subfile (const char *name);
-EXTERN int n_header_files;
+extern void patch_subfile_names (struct subfile *subfile, const char *name);
-EXTERN int n_allocated_header_files;
+extern void push_subfile (void);
-/* Within each object file, various header files are assigned numbers.
- A type is defined or referred to with a pair of numbers
- (FILENUM,TYPENUM) where FILENUM is the number of the header file
- and TYPENUM is the number within that header file.
- TYPENUM is the index within the vector of types for that header file.
+extern char *pop_subfile (void);
- FILENUM == 1 is special; it refers to the main source of the object file,
- and not to any header file. FILENUM != 1 is interpreted by looking it up
- in the following table, which contains indices in header_files. */
+extern struct block *end_symtab_get_static_block (CORE_ADDR end_addr,
+ int expandable,
+ int required);
-EXTERN int *this_object_header_files;
+extern struct compunit_symtab *
+ end_symtab_from_static_block (struct block *static_block,
+ int section, int expandable);
-EXTERN int n_this_object_header_files;
+extern struct compunit_symtab *end_symtab (CORE_ADDR end_addr, int section);
-EXTERN int n_allocated_this_object_header_files;
+extern struct compunit_symtab *end_expandable_symtab (CORE_ADDR end_addr,
+ int section);
-/* When a header file is getting special overriding definitions
- for one source file, record here the header_files index
- of its normal definition vector.
- At other times, this is -1. */
+extern void augment_type_symtab (void);
-EXTERN int header_file_prev_index;
+/* Defined in stabsread.c. */
-struct subfile_stack
-{
- struct subfile_stack *next;
- char *name;
- int prev_index;
-};
+extern void scan_file_globals (struct objfile *objfile);
+
+extern void buildsym_new_init (void);
+
+extern void buildsym_init (void);
+
+extern struct context_stack *push_context (int desc, CORE_ADDR valu);
+
+extern struct context_stack *pop_context (void);
+
+extern record_line_ftype record_line;
+
+extern struct compunit_symtab *start_symtab (struct objfile *objfile,
+ const char *name,
+ const char *comp_dir,
+ CORE_ADDR start_addr);
+
+extern void restart_symtab (struct compunit_symtab *cust,
+ const char *name, CORE_ADDR start_addr);
+
+extern int hashname (const char *name);
+
+extern void free_pending_blocks (void);
+
+/* Record the name of the debug format in the current pending symbol
+ table. FORMAT must be a string with a lifetime at least as long as
+ the symtab's objfile. */
+
+extern void record_debugformat (const char *format);
+
+/* Record the name of the debuginfo producer (usually the compiler) in
+ the current pending symbol table. PRODUCER must be a string with a
+ lifetime at least as long as the symtab's objfile. */
+
+extern void record_producer (const char *producer);
+
+extern void merge_symbol_lists (struct pending **srclist,
+ struct pending **targetlist);
+
+/* Set the name of the last source file. NAME is copied by this
+ function. */
+
+extern void set_last_source_file (const char *name);
+
+/* Fetch the name of the last source file. */
+
+extern const char *get_last_source_file (void);
+
+/* Return the compunit symtab object.
+ It is only valid to call this between calls to start_symtab and the
+ end_symtab* functions. */
-EXTERN struct subfile_stack *subfile_stack;
+extern struct compunit_symtab *buildsym_compunit_symtab (void);
-extern struct complaint unknown_symtype_complaint;
+/* Return the macro table.
+ Initialize it if this is the first use.
+ It is only valid to call this between calls to start_symtab and the
+ end_symtab* functions. */
-#define next_symbol_text() (*next_symbol_text_func)()
+extern struct macro_table *get_macro_table (void);
-/* Function to invoke get the next symbol. Return the symbol name. */
+#undef EXTERN
-EXTERN char * (*next_symbol_text_func)();
+#endif /* defined (BUILDSYM_H) */