gdb/symfile.h

   1 /* Definitions for reading symbol files into GDB.
   2    Copyright (C) 1990, 1991, 1992, 1993, 1994, 1996
   3    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, Boston, MA 02111-1307, USA.  */
  20
  21 #if !defined (SYMFILE_H)
  22 #define SYMFILE_H
  23
  24 /* This file requires that you first include "bfd.h".  */
  25
  26 /* Partial symbols are stored in the psymbol_cache and pointers to them
  27    are kept in a dynamically grown array that is obtained from malloc and
  28    grown as necessary via realloc.  Each objfile typically has two of these,
  29    one for global symbols and one for static symbols.  Although this adds
  30    a level of indirection for storing or accessing the partial symbols,
  31    it allows us to throw away duplicate psymbols and set all pointers
  32    to the single saved instance. */
  33
  34 struct psymbol_allocation_list {
  35   struct partial_symbol **list; /* Pointer to first partial symbol pointer*/
  36   struct partial_symbol **next; /* Pointer to next avail storage for pointer */
  37   int size;                     /* Number of symbols */
  38 };
  39
  40 /* Structure to keep track of symbol reading functions for various
  41    object file types.  */
  42
  43 struct sym_fns {
  44
  45   /* BFD flavour that we handle, or (as a special kludge, see xcoffread.c,
  46      (enum bfd_flavour)-1 for xcoff).  */
  47
  48   enum bfd_flavour sym_flavour;
  49
  50   /* Initializes anything that is global to the entire symbol table.  It is
  51      called during symbol_file_add, when we begin debugging an entirely new
  52      program. */
  53
  54   void (*sym_new_init) PARAMS ((struct objfile *));
  55
  56   /* Reads any initial information from a symbol file, and initializes the
  57      struct sym_fns SF in preparation for sym_read().  It is called every
  58      time we read a symbol file for any reason. */
  59
  60   void (*sym_init) PARAMS ((struct objfile *));
  61
  62   /* sym_read (objfile, addr, mainline)
  63      Reads a symbol file into a psymtab (or possibly a symtab).
  64      OBJFILE is the objfile struct for the file we are reading.
  65      SECTION_OFFSETS
  66      are the offset between the file's specified section addresses and
  67      their true addresses in memory.
  68      MAINLINE is 1 if this is the
  69      main symbol table being read, and 0 if a secondary
  70      symbol file (e.g. shared library or dynamically loaded file)
  71      is being read.  */
  72
  73   void (*sym_read) PARAMS ((struct objfile *, struct section_offsets *, int));
  74
  75   /* Called when we are finished with an objfile.  Should do all cleanup
  76      that is specific to the object file format for the particular objfile. */
  77
  78   void (*sym_finish) PARAMS ((struct objfile *));
  79
  80   /* This function produces a file-dependent section_offsets structure,
  81      allocated in the objfile's storage, and based on the parameter.
  82      The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility
  83      with the higher levels of GDB.  It should probably be changed to
  84      a string, where NULL means the default, and others are parsed in a file
  85      dependent way.  The result of this function is handed in to sym_read.  */
  86
  87   struct section_offsets *(*sym_offsets) PARAMS ((struct objfile *, CORE_ADDR));
  88
  89   /* Finds the next struct sym_fns.  They are allocated and initialized
  90      in whatever module implements the functions pointed to; an
  91      initializer calls add_symtab_fns to add them to the global chain.  */
  92
  93   struct sym_fns *next;
  94
  95 };
  96
  97 extern void
  98 extend_psymbol_list PARAMS ((struct psymbol_allocation_list *,
  99                              struct objfile *));
 100
 101 /* Add any kind of symbol to a psymbol_allocation_list. */
 102
 103 #ifndef INLINE_ADD_PSYMBOL
 104 /* Default this to off for now, and probably eventually remove support for inlining via
 105    macros.  Real world tests show no performance improvements by inlining, and the macros
 106    just make debugging gdb more complicated and make gdb larger by up to 150 Kb. */
 107 #define INLINE_ADD_PSYMBOL 0
 108 #endif
 109
 110 #include "demangle.h"
 111
 112 #if !INLINE_ADD_PSYMBOL
 113
 114 /* Since one arg is a struct, we have to pass in a ptr and deref it (sigh) */
 115
 116 #define ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value, language, objfile) \
 117   add_psymbol_to_list (name, namelength, namespace, class, &list, value, language, objfile)
 118
 119 #define ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value, language, objfile) \
 120   add_psymbol_addr_to_list (name, namelength, namespace, class, &list, value, language, objfile)
 121
 122 #else   /* !INLINE_ADD_PSYMBOL */
 123
 124 #define ADD_PSYMBOL_VT_TO_LIST(NAME,NAMELENGTH,NAMESPACE,CLASS,LIST,VALUE,VT,LANGUAGE, OBJFILE) \
 125   do {                                                                  \
 126     register struct partial_symbol *psym;                               \
 127     char *buf = alloca ((NAMELENGTH) + 1);                              \
 128     struct partial_symbol psymbol;                                      \
 129     memcpy (buf, (NAME), (NAMELENGTH));                                 \
 130     buf[(NAMELENGTH)] = '\0';                                           \
 131     SYMBOL_NAME (&psymbol) = bcache (buf, (NAMELENGTH) + 1, &(OBJFILE)->psymbol_cache); \
 132     VT (&psymbol) = (VALUE);                                            \
 133     SYMBOL_SECTION (&psymbol) = 0;                                      \
 134     SYMBOL_LANGUAGE (&psymbol) = (LANGUAGE);                            \
 135     PSYMBOL_NAMESPACE (&psymbol) = (NAMESPACE);                         \
 136     PSYMBOL_CLASS (&psymbol) = (CLASS);                                 \
 137     SYMBOL_INIT_LANGUAGE_SPECIFIC (&psymbol, (LANGUAGE));               \
 138     psym = bcache (&psymbol, sizeof (struct partial_symbol), &(OBJFILE)->psymbol_cache); \
 139     if ((LIST).next >= (LIST).list + (LIST).size)                       \
 140       extend_psymbol_list (&(LIST), (OBJFILE));                         \
 141     *(LIST).next++ = psym;                                              \
 142     OBJSTAT ((OBJFILE), n_psyms++);                                     \
 143   } while (0)
 144
 145 /* Add a symbol with an integer value to a psymtab. */
 146
 147 #define ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value, language, objfile) \
 148   ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE, language, objfile)
 149
 150 /* Add a symbol with a CORE_ADDR value to a psymtab. */
 151
 152 #define ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value, language, objfile)\
 153   ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE_ADDRESS, language, objfile)
 154
 155 #endif  /* INLINE_ADD_PSYMBOL */
 156
 157 extern void init_psymbol_list PARAMS ((struct objfile *, int));
 158
 159 extern void
 160 sort_pst_symbols PARAMS ((struct partial_symtab *));
 161
 162 extern struct symtab *
 163 allocate_symtab PARAMS ((char *, struct objfile *));
 164
 165 extern int
 166 free_named_symtabs PARAMS ((char *));
 167
 168 extern void
 169 fill_in_vptr_fieldno PARAMS ((struct type *));
 170
 171 extern void
 172 add_symtab_fns PARAMS ((struct sym_fns *));
 173
 174 extern void
 175 init_entry_point_info PARAMS ((struct objfile *));
 176
 177 extern void
 178 syms_from_objfile PARAMS ((struct objfile *, CORE_ADDR, int, int));
 179
 180 extern void
 181 new_symfile_objfile PARAMS ((struct objfile *, int, int));
 182
 183 extern struct partial_symtab *
 184 start_psymtab_common PARAMS ((struct objfile *, struct section_offsets *,
 185                               char *, CORE_ADDR,
 186                               struct partial_symbol **,
 187                               struct partial_symbol **));
 188
 189 /* Sorting your symbols for fast lookup or alphabetical printing.  */
 190
 191 extern void
 192 sort_block_syms PARAMS ((struct block *));
 193
 194 extern void
 195 sort_symtab_syms PARAMS ((struct symtab *));
 196
 197 /* Make a copy of the string at PTR with SIZE characters in the symbol obstack
 198    (and add a null character at the end in the copy).
 199    Returns the address of the copy.  */
 200
 201 extern char *
 202 obsavestring PARAMS ((char *, int, struct obstack *));
 203
 204 /* Concatenate strings S1, S2 and S3; return the new string.
 205    Space is found in the symbol_obstack.  */
 206
 207 extern char *
 208 obconcat PARAMS ((struct obstack *obstackp, const char *, const char *,
 209                   const char *));
 210
 211                         /*   Variables   */
 212
 213 /* whether to auto load solibs at startup time:  0/1. */
 214
 215 extern int auto_solib_add;
 216
 217 /* From symfile.c */
 218
 219 extern struct partial_symtab *
 220 allocate_psymtab PARAMS ((char *, struct objfile *));
 221
 222 /* Remote targets may wish to use this as their load function.  */
 223 extern void generic_load PARAMS ((char *name, int from_tty));
 224
 225 /* From dwarfread.c */
 226
 227 extern void
 228 dwarf_build_psymtabs PARAMS ((struct objfile *, struct section_offsets *, int,
 229                               file_ptr, unsigned int, file_ptr, unsigned int));
 230
 231 /* From mdebugread.c */
 232
 233 /* Hack to force structures to exist before use in parameter list.  */
 234 struct ecoff_debug_hack
 235 {
 236   struct ecoff_debug_swap *a;
 237   struct ecoff_debug_info *b;
 238 };
 239 extern void
 240 mdebug_build_psymtabs PARAMS ((struct objfile *,
 241                                const struct ecoff_debug_swap *,
 242                                struct ecoff_debug_info *,
 243                                struct section_offsets *));
 244
 245 extern void
 246 elfmdebug_build_psymtabs PARAMS ((struct objfile *,
 247                                   const struct ecoff_debug_swap *,
 248                                   asection *,
 249                                   struct section_offsets *));
 250
 251 /* From demangle.c */
 252
 253 extern void
 254 set_demangling_style PARAMS ((char *));
 255
 256 #endif  /* !defined(SYMFILE_H) */