* bcache.c, bcache.h: New files to implement a byte cache.
[deliverable/binutils-gdb.git] / gdb / symfile.h
index 6dbd2d7a08d1d05db71eff926fb915ad22754890..3c968f64bae3e690ddc5e6dd8c355e60171113c2 100644 (file)
@@ -1,5 +1,6 @@
 /* Definitions for reading symbol files into GDB.
-   Copyright (C) 1990, 1991, 1992  Free Software Foundation, Inc.
+   Copyright (C) 1990, 1991, 1992, 1993, 1994, 1996
+   Free Software Foundation, Inc.
 
 This file is part of GDB.
 
@@ -15,180 +16,77 @@ 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.  */
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
 
 #if !defined (SYMFILE_H)
 #define SYMFILE_H
 
 /* This file requires that you first include "bfd.h".  */
 
-struct psymbol_allocation_list {
-  struct partial_symbol *list;
-  struct partial_symbol *next;
-  int size;
-};
-
-/* Master structure for keeping track of each input file from which
-   gdb reads symbols.  One of these is allocated for each such file we
-   access, e.g. the exec_file, symbol_file, and any shared library object
-   files. */
-
-struct objfile
-{
-
-  /* All struct objfile's are chained together by their next pointers.
-     The global variable "object_files" points to the first link in this
-     chain. */
-
-  struct objfile *next;
-
-  /* The object file's name.  Malloc'd; free it if you free this struct.  */
-
-  char *name;
-
-  /* Some flag bits for this objfile. */
-
-  unsigned short flags;
-
-  /* Each objfile points to a linked list of symtabs derived from this file,
-     one symtab structure for each compilation unit (source file).  Each link
-     in the symtab list contains a backpointer to this objfile. */
-
-  struct symtab *symtabs;
-
-  /* Each objfile points to a linked list of partial symtabs derived from
-     this file, one partial symtab structure for each compilation unit
-     (source file). */
-
-  struct partial_symtab *psymtabs;
-
-  /* List of freed partial symtabs, available for re-use */
-
-  struct partial_symtab *free_psymtabs;
-
-  /* The object file's BFD.  Can be null, in which case bfd_open (name) and
-     put the result here.  */
-
-  bfd *obfd;
-
-  /* The modification timestamp of the object file, as of the last time
-     we read its symbols.  */
-
-  long mtime;
-
-  /* Obstacks to hold objects that should be freed when we load a new symbol
-     table from this object file. */
-
-  struct obstack psymbol_obstack;      /* Partial symbols */
-  struct obstack symbol_obstack;       /* Full symbols */
-  struct obstack type_obstack;         /* Types */
-
-  /* Vectors of all partial symbols read in from file.  The actual data
-     is stored in the psymbol_obstack. */
-
-  struct psymbol_allocation_list global_psymbols;
-  struct psymbol_allocation_list static_psymbols;
-
-  /* Each file contains a pointer to an array of minimal symbols for all
-     global symbols that are defined within the file.  The array is terminated
-     by a "null symbol", one that has a NULL pointer for the name and a zero
-     value for the address.  This makes it easy to walk through the array
-     when passed a pointer to somewhere in the middle of it.  There is also
-     a count of the number of symbols, which does include the terminating
-     null symbol.  The array itself, as well as all the data that it points
-     to, should be allocated on the symbol_obstack for this file. */
-
-  struct minimal_symbol *msymbols;
-  int minimal_symbol_count;
-
-  /* For object file formats which don't specify fundamental types, gdb
-     can create such types.  For now, it maintains a vector of pointers
-     to these internally created fundamental types on a per objfile basis,
-     however it really should ultimately keep them on a per-compilation-unit
-     basis, to account for linkage-units that consist of a number of
-     compilation units that may have different fundamental types, such as
-     linking C modules with ADA modules, or linking C modules that are
-     compiled with 32-bit ints with C modules that are compiled with 64-bit
-     ints (not inherently evil with a smarter linker). */
-
-  struct type **fundamental_types;
-
-  /* The mmalloc() malloc-descriptor for this objfile if we are using
-     the memory mapped malloc() package to manage storage for this objfile's
-     data.  NULL if we are not. */
-
-  void *md;
+/* Partial symbols are stored in the psymbol_cache and pointers to them
+   are kept in a dynamically grown array that is obtained from malloc and
+   grown as necessary via realloc.  Each objfile typically has two of these,
+   one for global symbols and one for static symbols.  Although this adds
+   a level of indirection for storing or accessing the partial symbols,
+   it allows us to throw away duplicate psymbols and set all pointers
+   to the single saved instance. */
 
+struct psymbol_allocation_list {
+  struct partial_symbol **list;        /* Pointer to first partial symbol pointer*/
+  struct partial_symbol **next;        /* Pointer to next avail storage for pointer */
+  int size;                    /* Number of symbols */
 };
 
-/* Defines for the objfile flag word. */
-
-/* Gdb can arrange to allocate storage for all objects related to a
-   particular objfile in a designated section of it's address space,
-   managed at a low level by mmap() and using a special version of
-   malloc that handles malloc/free/realloc on top of the mmap() interface.
-   This allows the "internal gdb state" for a particular objfile to be
-   dumped to a gdb state file and subsequently reloaded at a later time. */
-
-#define OBJF_MAPPED    (1 << 0)        /* Objfile data is mmap'd */
-
-
 /* Structure to keep track of symbol reading functions for various
    object file types.  */
 
 struct sym_fns {
 
-  /* is the name, or name prefix, of the BFD "target type" that this
-     set of functions handles.  E.g. "a.out" or "sunOs" or "coff" or "elf".  */
+  /* BFD flavour that we handle, or (as a special kludge, see xcoffread.c,
+     (enum bfd_flavour)-1 for xcoff).  */
 
-  char *sym_name;
+  enum bfd_flavour sym_flavour;
 
-  /* counts how many bytes of sym_name should be checked against the
-     BFD target type of the file being read.  If an exact match is
-     desired, specify the number of characters in sym_name plus 1 for the
-     NUL.  If a prefix match is desired, specify the number of characters in
-     sym_name.  */
+  /* Initializes anything that is global to the entire symbol table.  It is
+     called during symbol_file_add, when we begin debugging an entirely new
+     program. */
 
-  int sym_namelen;
+  void (*sym_new_init) PARAMS ((struct objfile *));
 
-  /* initializes anything that is global to the entire
-     symbol table.  It is called during symbol_file_add, when
-     we begin debugging an entirely new program.  */
+  /* Reads any initial information from a symbol file, and initializes the
+     struct sym_fns SF in preparation for sym_read().  It is called every
+     time we read a symbol file for any reason. */
 
-  void (*sym_new_init) PARAMS ((void));
+  void (*sym_init) PARAMS ((struct objfile *));
 
-  /* sym_init (sf)
-     reads any initial information from a symbol file, and
-     initializes the struct sym_fns SF in preparation for sym_read().
-     It is called every time we read a symbol file for any reason.  */
-
-  void (*sym_init) PARAMS ((struct sym_fns *));
-
-  /* sym_read (sf, addr, mainline)
-     reads a symbol file into a psymtab (or possibly a symtab).
-     SF is the struct sym_fns that sym_init initialized.  ADDR
-     is the offset between the file's specified start address and
-     its true address in memory.  MAINLINE is 1 if this is the
+  /* sym_read (objfile, addr, mainline)
+     Reads a symbol file into a psymtab (or possibly a symtab).
+     OBJFILE is the objfile struct for the file we are reading.
+     SECTION_OFFSETS
+     are the offset between the file's specified section addresses and
+     their true addresses in memory.
+     MAINLINE is 1 if this is the
      main symbol table being read, and 0 if a secondary
      symbol file (e.g. shared library or dynamically loaded file)
      is being read.  */
 
-  void (*sym_read) PARAMS ((struct sym_fns *, CORE_ADDR, int));
-
-  /* is the accessor for the symbol file being read.  */
+  void (*sym_read) PARAMS ((struct objfile *, struct section_offsets *, int));
 
-  bfd *sym_bfd;
+  /* Called when we are finished with an objfile.  Should do all cleanup
+     that is specific to the object file format for the particular objfile. */
+  void (*sym_finish) PARAMS ((struct objfile *));
 
-  /* is where information can be shared among sym_init and sym_read.
-     It is typically a pointer to malloc'd memory.  */
+  /* This function produces a file-dependent section_offsets structure,
+     allocated in the objfile's storage, and based on the parameter.
+     The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility
+     with the higher levels of GDB.  It should probably be changed to
+     a string, where NULL means the default, and others are parsed in a file
+     dependent way.  The result of this function is handed in to sym_read.  */
 
-  char *sym_private;                   /* Should be void * */
+  struct section_offsets *(*sym_offsets) PARAMS ((struct objfile *, CORE_ADDR));
 
-  /* is the "struct objfile" for the object file being read.  */
-
-  struct objfile *objfile;
-
-  /* finds the next struct sym_fns.  They are allocated and initialized
+  /* Finds the next struct sym_fns.  They are allocated and initialized
      in whatever module implements the functions pointed to; an 
      initializer calls add_symtab_fns to add them to the global chain.  */
 
@@ -202,47 +100,61 @@ extend_psymbol_list PARAMS ((struct psymbol_allocation_list *,
 
 /* Add any kind of symbol to a psymbol_allocation_list. */
 
-#define        ADD_PSYMBOL_VT_TO_LIST(NAME,NAMELENGTH,NAMESPACE,CLASS,LIST,VALUE,VT) \
-  do {                                                                 \
-    register struct partial_symbol *psym;                              \
-    if ((LIST).next >= (LIST).list + (LIST).size)                      \
-          extend_psymbol_list (&(LIST),objfile);                               \
-    psym = (LIST).next++;                                              \
-                                                                       \
-    SYMBOL_NAME (psym) = (char *) obstack_alloc (&objfile->psymbol_obstack,    \
-                                                (NAMELENGTH) + 1);     \
-    memcpy (SYMBOL_NAME (psym), (NAME), (NAMELENGTH));                 \
-    SYMBOL_NAME (psym)[(NAMELENGTH)] = '\0';                           \
-    SYMBOL_NAMESPACE (psym) = (NAMESPACE);                             \
-    SYMBOL_CLASS (psym) = (CLASS);                                     \
-    VT (psym) = (VALUE);                                               \
-  } while (0);
-
-#ifdef DEBUG
+#ifndef INLINE_ADD_PSYMBOL
+/* Default this to off for now, and probably eventually remove support for inlining via
+   macros.  Real world tests show no performance improvements by inlining, and the macros
+   just make debugging gdb more complicated and make gdb larger by up to 150 Kb. */
+#define INLINE_ADD_PSYMBOL 0
+#endif
+
+#include "demangle.h"
+
+#if !INLINE_ADD_PSYMBOL
 
 /* Since one arg is a struct, we have to pass in a ptr and deref it (sigh) */
 
-#define        ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value) \
-  add_psymbol_to_list (name, namelength, namespace, class, &list, value)
+#define        ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value, language, objfile) \
+  add_psymbol_to_list (name, namelength, namespace, class, &list, value, language, objfile)
 
-#define        ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value) \
-  add_psymbol_addr_to_list (name, namelength, namespace, class, &list, value)
+#define        ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value, language, objfile) \
+  add_psymbol_addr_to_list (name, namelength, namespace, class, &list, value, language, objfile)
 
-#else  /* !DEBUG */
+#else  /* !INLINE_ADD_PSYMBOL */
+
+#define        ADD_PSYMBOL_VT_TO_LIST(NAME,NAMELENGTH,NAMESPACE,CLASS,LIST,VALUE,VT,LANGUAGE, OBJFILE) \
+  do {                                                                 \
+    register struct partial_symbol *psym;                              \
+    char *buf = alloca ((NAMELENGTH) + 1);                             \
+    struct partial_symbol psymbol;                                     \
+    memcpy (buf, (NAME), (NAMELENGTH));                                        \
+    buf[(NAMELENGTH)] = '\0';                                          \
+    SYMBOL_NAME (&psymbol) = bcache (buf, (NAMELENGTH) + 1, &(OBJFILE)->psymbol_cache); \
+    VT (&psymbol) = (VALUE);                                           \
+    SYMBOL_SECTION (&psymbol) = 0;                                     \
+    SYMBOL_LANGUAGE (&psymbol) = (LANGUAGE);                           \
+    PSYMBOL_NAMESPACE (&psymbol) = (NAMESPACE);                                \
+    PSYMBOL_CLASS (&psymbol) = (CLASS);                                        \
+    SYMBOL_INIT_LANGUAGE_SPECIFIC (&psymbol, (LANGUAGE));              \
+    psym = bcache (&psymbol, sizeof (struct partial_symbol), &(OBJFILE)->psymbol_cache); \
+    if ((LIST).next >= (LIST).list + (LIST).size)                      \
+      extend_psymbol_list (&(LIST), (OBJFILE));                                \
+    *(LIST).next++ = psym;                                             \
+    OBJSTAT ((OBJFILE), n_psyms++);                                    \
+  } while (0)
 
 /* Add a symbol with an integer value to a psymtab. */
 
-#define ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value) \
-  ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE)
+#define ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value, language, objfile) \
+  ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE, language, objfile)
 
 /* Add a symbol with a CORE_ADDR value to a psymtab. */
 
-#define        ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value)\
-  ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE_ADDRESS)
+#define        ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value, language, objfile)\
+  ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE_ADDRESS, language, objfile)
 
-#endif /* DEBUG */
+#endif /* INLINE_ADD_PSYMBOL */
 
-                       /*   Functions   */
+extern void init_psymbol_list PARAMS ((struct objfile *, int));
 
 extern void
 sort_pst_symbols PARAMS ((struct partial_symtab *));
@@ -250,15 +162,6 @@ sort_pst_symbols PARAMS ((struct partial_symtab *));
 extern struct symtab *
 allocate_symtab PARAMS ((char *, struct objfile *));
 
-extern struct objfile *
-allocate_objfile PARAMS ((bfd *, int));
-
-extern void
-free_objfile PARAMS ((struct objfile *));
-
-extern void
-free_all_objfiles PARAMS ((void));
-
 extern int
 free_named_symtabs PARAMS ((char *));
 
@@ -268,13 +171,20 @@ fill_in_vptr_fieldno PARAMS ((struct type *));
 extern void
 add_symtab_fns PARAMS ((struct sym_fns *));
 
+extern void
+init_entry_point_info PARAMS ((struct objfile *));
+
 extern void
 syms_from_objfile PARAMS ((struct objfile *, CORE_ADDR, int, int));
 
+extern void
+new_symfile_objfile PARAMS ((struct objfile *, int, int));
+
 extern struct partial_symtab *
-start_psymtab_common PARAMS ((struct objfile *, CORE_ADDR, char *, CORE_ADDR,
-                             struct partial_symbol *,
-                             struct partial_symbol *));
+start_psymtab_common PARAMS ((struct objfile *, struct section_offsets *,
+                             char *, CORE_ADDR,
+                             struct partial_symbol **,
+                             struct partial_symbol **));
 
 /* Sorting your symbols for fast lookup or alphabetical printing.  */
 
@@ -284,9 +194,6 @@ sort_block_syms PARAMS ((struct block *));
 extern void
 sort_symtab_syms PARAMS ((struct symtab *));
 
-extern void
-sort_all_symtab_syms PARAMS ((void));
-
 /* Make a copy of the string at PTR with SIZE characters in the symbol obstack
    (and add a null character at the end in the copy).
    Returns the address of the copy.  */
@@ -303,105 +210,47 @@ obconcat PARAMS ((struct obstack *obstackp, const char *, const char *,
 
                        /*   Variables   */
 
-/* The object file that the main symbol table was loaded from (e.g. the
-   argument to the "symbol-file" or "file" command).  */
-
-extern struct objfile *symfile_objfile;
-
-/* Where execution starts in symfile */
-
-extern CORE_ADDR entry_point;
-
-/* Root of object file struct chain.  */
-
-extern struct objfile *object_files;
-
-/* Traverse all object files.  ALL_OBJFILES_SAFE works even if you delete
-   the objfile during the traversal.  */
-
-#define        ALL_OBJFILES(obj) \
-   for (obj = object_files; 0 != obj; obj = obj->next)
-
-#define        ALL_OBJFILES_SAFE(obj,nxt) \
-   for (obj = object_files; obj? (nxt=obj->next, 1): 0; obj = nxt)
-
-/* Support for complaining about things in the symbol file that aren't
-   catastrophic.
+/* whether to auto load solibs at startup time:  0/1. */
 
-   Each such thing gets a counter.  The first time we have the problem,
-   during a symbol read, we report it.  At the end of symbol reading,
-   if verbose, we report how many of each problem we had.  */
-
-struct complaint {
-  char *message;
-  unsigned counter;
-  struct complaint *next;
-};
-
-/* Root of the chain of complaints that have at some point been issued. 
-   This is used to reset the counters, and/or report the total counts.  */
-
-extern struct complaint complaint_root[1];
-
-/* Externally visible variables defined in symfile.c */
-
-/* The object file that the main symbol table was loaded from (e.g. the
-   argument to the "symbol-file" or "file" command).  */
-
-extern struct objfile *symfile_objfile;
-
-/* Where execution starts in symfile */
-
-extern CORE_ADDR entry_point;
-
-/* Root of object file struct chain.  */
-
-extern struct objfile *object_files;
-
-/* Functions that handle complaints.  (in symfile.c)  */
-
-extern void
-complain PARAMS ((struct complaint *, char *));
-
-extern void
-clear_complaints PARAMS ((int sym_reading, int noisy));
+extern int auto_solib_add;
 
 /* From symfile.c */
 
 extern struct partial_symtab *
 allocate_psymtab PARAMS ((char *, struct objfile *));
 
-/* From minsyms.c */
+/* Remote targets may wish to use this as their load function.  */
+extern void generic_load PARAMS ((char *name, int from_tty));
 
-extern PTR
-iterate_over_msymbols PARAMS ((PTR (*func) (struct objfile *,
-                                           struct minimal_symbol *,
-                                           PTR arg1, PTR arg2, PTR arg3),
-                              PTR arg1, PTR arg2, PTR arg3));
+/* From dwarfread.c */
 
-/* From objfiles.c */
+extern void
+dwarf_build_psymtabs PARAMS ((struct objfile *, struct section_offsets *, int,
+                             file_ptr, unsigned int, file_ptr, unsigned int));
 
-extern PTR
-iterate_over_objfiles PARAMS ((PTR (*func) (struct objfile *,
-                                           PTR arg1, PTR arg2, PTR arg3),
-                              PTR arg1, PTR arg2, PTR arg3));
+/* From mdebugread.c */
 
-extern PTR
-iterate_over_symtabs PARAMS ((PTR (*func) (struct objfile *, struct symtab *,
-                                          PTR arg1, PTR arg2, PTR arg3),
-                             PTR arg1, PTR arg2, PTR arg3));
+/* Hack to force structures to exist before use in parameter list.  */
+struct ecoff_debug_hack
+{
+  struct ecoff_debug_swap *a;
+  struct ecoff_debug_info *b;
+};
+extern void
+mdebug_build_psymtabs PARAMS ((struct objfile *,
+                              const struct ecoff_debug_swap *,
+                              struct ecoff_debug_info *,
+                              struct section_offsets *));
 
-extern PTR 
-iterate_over_psymtabs PARAMS ((PTR (*func) (struct objfile *,
-                                           struct partial_symtab *,
-                                           PTR arg1, PTR arg2, PTR arg3),
-                              PTR arg1, PTR arg2, PTR arg3));
+extern void
+elfmdebug_build_psymtabs PARAMS ((struct objfile *,
+                                 const struct ecoff_debug_swap *,
+                                 asection *,
+                                 struct section_offsets *));
 
-/* From dwarfread.c */
+/* From demangle.c */
 
 extern void
-dwarf_build_psymtabs PARAMS ((int, char *, CORE_ADDR, int, unsigned int,
-                             unsigned int, unsigned int, unsigned int,
-                             struct objfile *));
+set_demangling_style PARAMS ((char *));
 
 #endif /* !defined(SYMFILE_H) */
This page took 0.037431 seconds and 4 git commands to generate.