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