]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blobdiff - gdb/buildsym.h
Switch the license of all .c files to GPLv3.
[thirdparty/binutils-gdb.git] / gdb / buildsym.h
index 8183cfc1c31c8534e190ce54f65fd21ef155318b..cb16be19c3071416a349df76bb6418518768cd4a 100644 (file)
@@ -1,69 +1,75 @@
 /* Build symbol tables in GDB's internal format.
-   Copyright (C) 1986-1991 Free Software Foundation, Inc.
+   Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1995, 1996,
+   1997, 1998, 1999, 2000, 2002, 2003, 2007 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;
+
 /* 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.  */
+
+struct block;
 
 #ifndef EXTERN
-#define        EXTERN  extern
+#define        EXTERN extern
 #endif
 
-/* Convert stab register number (from `r' declaration) to a gdb REGNUM.  */
+#define HASHSIZE 127           /* Size of things hashed via
+                                  hashname() */
 
-#ifndef STAB_REG_TO_REGNUM
-#define STAB_REG_TO_REGNUM(VALUE) (VALUE)
-#endif
-\f
-/* Name of source file whose symbol data we are now processing.
-   This comes from a symbol of type N_SO.  */
+/* 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;
 
-/* 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. */
 
 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;
-  char *name;
-  char *dirname;
-  struct linetable *line_vector;
-  int line_vector_length;
-};
+  {
+    struct subfile *next;
+    char *name;
+    char *dirname;
+    struct linetable *line_vector;
+    int line_vector_length;
+    enum language language;
+    char *producer;
+    char *debugformat;
+    struct symtab *symtab;
+  };
 
 EXTERN struct subfile *subfiles;
 
@@ -74,103 +80,99 @@ EXTERN struct subfile *current_subfile;
 
 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.  */
+/* func params local to lexical  context */
 
-EXTERN struct pending *file_symbols;   /* static at top level, and types */
+EXTERN struct pending *param_symbols;
 
-EXTERN struct pending *global_symbols; /* global functions and variables */
+/* Stack representing unclosed lexical contexts (that will become
+   blocks, eventually).  */
 
-EXTERN struct pending *local_symbols;  /* everything local to lexic context */
+struct context_stack
+  {
+    /* Outer locals at the time we entered */
 
-/* Kludge for xcoffread.c */
-struct pending_stabs {
-  int  count, length;
-  char *stab[1];
-};
+    struct pending *locals;
 
-EXTERN struct pending_stabs *global_stabs;
+    /* Pending func params 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 *params;
 
-EXTERN struct pending *common_block;
-EXTERN int common_block_i;
+    /* Pointer into blocklist as of entry */
 
-/* Stack representing unclosed lexical contexts
-   (that will become blocks, eventually).  */
+    struct pending_block *old_blocks;
 
-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 */
-};
+    /* Name of function, if any, defining context */
+
+    struct symbol *name;
+
+    /* 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.  */
+/* Non-zero if the context stack is empty.  */
+#define outermost_context_p() (context_stack_depth == 0)
 
-#define        pop_context()   \
-      (&context_stack[--context_stack_depth]);
-
-/* 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;
 
@@ -178,175 +180,116 @@ EXTERN int within_function;
    This is used at the end to make the blockvector.  */
 
 struct pending_block
-{
-  struct pending_block *next;
-  struct block *block;
-};
-
-EXTERN struct pending_block *pending_blocks;
+  {
+    struct pending_block *next;
+    struct block *block;
+  };
 
-/* Global variable which, when set, indicates that we are processing a
-   .o file compiled with gcc */
-
-EXTERN unsigned char processing_gcc_compilation;
+/* Pointer to the head of a linked list of symbol blocks which have
+   already been finalized (lexical contexts already closed) and which
+   are just waiting to be built into a blockvector when finalizing the
+   associated symtab. */
 
-/* The type code that process_one_symbol saw on its previous invocation.
-   Used to detect pairs of N_SO symbols. */
-
-EXTERN int previous_stab_code;
-
-/* Setup a define to deal cleanly with the underscore problem */
-
-#ifdef NAMES_HAVE_UNDERSCORE
-#define HASH_OFFSET 1
-#else
-#define HASH_OFFSET 0
-#endif
+EXTERN struct pending_block *pending_blocks;
 \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 struct header_file *header_files;
+struct subfile_stack
+  {
+    struct subfile_stack *next;
+    char *name;
+  };
 
-EXTERN int n_header_files;
+EXTERN struct subfile_stack *subfile_stack;
 
-EXTERN int n_allocated_header_files;
+#define next_symbol_text(objfile) (*next_symbol_text_func)(objfile)
 
-/* 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.
+/* Function to invoke get the next symbol.  Return the symbol name. */
 
-   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 char *(*next_symbol_text_func) (struct objfile *);
 
-EXTERN int *this_object_header_files;
+/* Vector of types defined so far, indexed by their type numbers.
+   Used for both stabs and coff.  (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.)  */
 
-EXTERN int n_this_object_header_files;
+EXTERN struct type **type_vector;
 
-EXTERN int n_allocated_this_object_header_files;
+/* Number of elements allocated for type_vector currently.  */
 
-struct subfile_stack
-{
-  struct subfile_stack *next;
-  char *name;
-};
+EXTERN int type_vector_length;
 
-EXTERN struct subfile_stack *subfile_stack;
+/* Initial size of type vector.  Is realloc'd larger if needed, and
+   realloc'd down to the size actually used, when completed.  */
 
-extern struct complaint unknown_symtype_complaint;
+#define        INITIAL_TYPE_VECTOR_LENGTH      160
 
-#define next_symbol_text() (*next_symbol_text_func)()
+extern void add_free_pendings (struct pending *list);
 
-/* Function to invoke get the next symbol.  Return the symbol name. */
+extern void add_symbol_to_list (struct symbol *symbol,
+                               struct pending **listhead);
 
-EXTERN char *(*next_symbol_text_func) PARAMS ((void));
+extern struct symbol *find_symbol_in_list (struct pending *list,
+                                          char *name, int length);
 
-extern void
-add_symbol_to_list PARAMS ((struct symbol *, struct pending **));
+extern void finish_block (struct symbol *symbol,
+                         struct pending **listhead,
+                         struct pending_block *old_blocks,
+                         CORE_ADDR start, CORE_ADDR end,
+                         struct objfile *objfile);
 
-extern struct symbol *
-find_symbol_in_list PARAMS ((struct pending *, char *, int));
+extern void really_free_pendings (void *dummy);
 
-extern void
-read_type_number PARAMS ((char **, int *));
+extern void start_subfile (char *name, char *dirname);
 
-extern struct type *
-read_type PARAMS ((char **, struct objfile *));
+extern void patch_subfile_names (struct subfile *subfile, char *name);
 
-extern struct type **
-dbx_lookup_type PARAMS ((int [2]));
+extern void push_subfile (void);
 
-extern long
-read_number PARAMS ((char **, int));
+extern char *pop_subfile (void);
 
-extern void
-finish_block PARAMS ((struct symbol *, struct pending **,
-                     struct pending_block *, CORE_ADDR, CORE_ADDR,
-                     struct objfile *));
+extern struct symtab *end_symtab (CORE_ADDR end_addr,
+                                 struct objfile *objfile, int section);
 
-extern void
-add_undefined_type PARAMS ((struct type *));
+/* Defined in stabsread.c.  */
 
-extern void
-really_free_pendings PARAMS ((int foo));
+extern void scan_file_globals (struct objfile *objfile);
 
-extern void
-start_subfile PARAMS ((char *, char *));
+extern void buildsym_new_init (void);
 
-extern void
-push_subfile PARAMS ((void));
+extern void buildsym_init (void);
 
-extern char *
-pop_subfile PARAMS ((void));
+extern struct context_stack *push_context (int desc, CORE_ADDR valu);
 
-extern struct symtab *
-end_symtab PARAMS ((CORE_ADDR, int, int,struct objfile *));
+extern struct context_stack *pop_context (void);
 
-extern void
-scan_file_globals PARAMS ((struct objfile *));
+extern void record_line (struct subfile *subfile, int line, CORE_ADDR pc);
 
-extern void
-buildsym_new_init PARAMS ((void));
+extern void start_symtab (char *name, char *dirname, CORE_ADDR start_addr);
 
-extern void
-buildsym_init PARAMS ((void));
+extern int hashname (char *name);
 
-extern struct context_stack *
-push_context PARAMS ((int, CORE_ADDR));
+extern void free_pending_blocks (void);
 
-extern void
-record_line PARAMS ((struct subfile *, int, CORE_ADDR));
+/* FIXME: Note that this is used only in buildsym.c and dstread.c,
+   which should be fixed to not need direct access to
+   record_pending_block. */
 
-extern void
-start_symtab PARAMS ((char *, char *, CORE_ADDR));
+extern void record_pending_block (struct objfile *objfile,
+                                 struct block *block,
+                                 struct pending_block *opblock);
 
-extern struct symbol *
-define_symbol PARAMS ((unsigned int, char *, int, int, struct objfile *));
+extern void record_debugformat (char *format);
 
-extern struct partial_symtab *
-start_psymtab PARAMS ((struct objfile *, CORE_ADDR, char *, CORE_ADDR, int,
-                      struct partial_symbol *, struct partial_symbol *));
+extern void record_producer (const char *producer);
 
-extern void
-end_psymtab PARAMS ((struct partial_symtab *, char **, int, int, CORE_ADDR,
-                    struct partial_symtab **, int));
+extern void merge_symbol_lists (struct pending **srclist,
+                               struct pending **targetlist);
 
-extern void
-process_one_symbol PARAMS ((int, int, CORE_ADDR, char *, int,
-                           struct objfile *));
+/* The macro table for the compilation unit whose symbols we're
+   currently reading.  All the symtabs for this CU will point to this.  */
+EXTERN struct macro_table *pending_macros;
 
-extern int
-hashname PARAMS ((char *));
+#undef EXTERN
 
-#endif /* defined (BUILDSYM_H) */
+#endif /* defined (BUILDSYM_H) */