gdb/symfile.h

   1 /* Definitions for reading symbol files into GDB.
   2    Copyright (C) 1990, 1991, 1992  Free Software Foundation, Inc.
   3
   4 This file is part of GDB.
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #if !defined (SYMFILE_H)
  21 #define SYMFILE_H
  22
  23 /* This file requires that you first include "bfd.h".  */
  24
  25 struct psymbol_allocation_list {
  26   struct partial_symbol *list;
  27   struct partial_symbol *next;
  28   int size;
  29 };
  30
  31 /* Structure to keep track of symbol reading functions for various
  32    object file types.  */
  33
  34 struct sym_fns {
  35
  36   /* is the name, or name prefix, of the BFD "target type" that this
  37      set of functions handles.  E.g. "a.out" or "sunOs" or "coff" or "elf".  */
  38
  39   char *sym_name;
  40
  41   /* counts how many bytes of sym_name should be checked against the
  42      BFD target type of the file being read.  If an exact match is
  43      desired, specify the number of characters in sym_name plus 1 for the
  44      NUL.  If a prefix match is desired, specify the number of characters in
  45      sym_name.  */
  46
  47   int sym_namelen;
  48
  49   /* Initializes anything that is global to the entire symbol table.  It is
  50      called during symbol_file_add, when we begin debugging an entirely new
  51      program. */
  52
  53   void (*sym_new_init) PARAMS ((struct objfile *));
  54
  55   /* Reads any initial information from a symbol file, and initializes the
  56      struct sym_fns SF in preparation for sym_read().  It is called every
  57      time we read a symbol file for any reason. */
  58
  59   void (*sym_init) PARAMS ((struct objfile *));
  60
  61   /* sym_read (objfile, addr, mainline)
  62      Reads a symbol file into a psymtab (or possibly a symtab).
  63      OBJFILE is the objfile struct for the file we are reading.
  64      SECTION_OFFSETS
  65      are the offset between the file's specified section addresses and
  66      their true addresses in memory.
  67      MAINLINE is 1 if this is the
  68      main symbol table being read, and 0 if a secondary
  69      symbol file (e.g. shared library or dynamically loaded file)
  70      is being read.  */
  71
  72   void (*sym_read) PARAMS ((struct objfile *, struct section_offsets *, int));
  73
  74   /* Called when we are finished with an objfile.  Should do all cleanup
  75      that is specific to the object file format for the particular objfile. */
  76
  77   void (*sym_finish) PARAMS ((struct objfile *));
  78
  79   /* This function produces a file-dependent section_offsets structure,
  80      allocated in the objfile's storage, and based on the parameter.
  81      The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility
  82      with the higher levels of GDB.  It should probably be changed to
  83      a string, where NULL means the default, and others are parsed in a file
  84      dependent way.  The result of this function is handed in to sym_read.  */
  85
  86   struct section_offsets *(*sym_offsets) PARAMS ((struct objfile *, CORE_ADDR));
  87
  88   /* Finds the next struct sym_fns.  They are allocated and initialized
  89      in whatever module implements the functions pointed to; an
  90      initializer calls add_symtab_fns to add them to the global chain.  */
  91
  92   struct sym_fns *next;
  93
  94 };
  95
  96 extern void
  97 extend_psymbol_list PARAMS ((struct psymbol_allocation_list *,
  98                              struct objfile *));
  99
 100 /* Add any kind of symbol to a psymbol_allocation_list. */
 101
 102 #define ADD_PSYMBOL_VT_TO_LIST(NAME,NAMELENGTH,NAMESPACE,CLASS,LIST,VALUE,VT) \
 103   do {                                                                  \
 104     register struct partial_symbol *psym;                               \
 105     if ((LIST).next >= (LIST).list + (LIST).size)                       \
 106            extend_psymbol_list (&(LIST),objfile);                               \
 107     psym = (LIST).next++;                                               \
 108                                                                         \
 109     SYMBOL_NAME (psym) = (char *) obstack_alloc (&objfile->psymbol_obstack,     \
 110                                                  (NAMELENGTH) + 1);     \
 111     memcpy (SYMBOL_NAME (psym), (NAME), (NAMELENGTH));                  \
 112     SYMBOL_NAME (psym)[(NAMELENGTH)] = '\0';                            \
 113     SYMBOL_NAMESPACE (psym) = (NAMESPACE);                              \
 114     SYMBOL_CLASS (psym) = (CLASS);                                      \
 115     VT (psym) = (VALUE);                                                \
 116   } while (0);
 117
 118 #ifdef DEBUG
 119
 120 /* Since one arg is a struct, we have to pass in a ptr and deref it (sigh) */
 121
 122 #define ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value) \
 123   add_psymbol_to_list (name, namelength, namespace, class, &list, value)
 124
 125 #define ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value) \
 126   add_psymbol_addr_to_list (name, namelength, namespace, class, &list, value)
 127
 128 #else   /* !DEBUG */
 129
 130 /* Add a symbol with an integer value to a psymtab. */
 131
 132 #define ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value) \
 133   ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE)
 134
 135 /* Add a symbol with a CORE_ADDR value to a psymtab. */
 136
 137 #define ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value)\
 138   ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE_ADDRESS)
 139
 140 #endif  /* DEBUG */
 141
 142                         /*   Functions   */
 143
 144 extern void
 145 sort_pst_symbols PARAMS ((struct partial_symtab *));
 146
 147 extern struct symtab *
 148 allocate_symtab PARAMS ((char *, struct objfile *));
 149
 150 extern int
 151 free_named_symtabs PARAMS ((char *));
 152
 153 extern void
 154 fill_in_vptr_fieldno PARAMS ((struct type *));
 155
 156 extern void
 157 add_symtab_fns PARAMS ((struct sym_fns *));
 158
 159 extern void
 160 init_entry_point_info PARAMS ((struct objfile *));
 161
 162 extern void
 163 syms_from_objfile PARAMS ((struct objfile *, CORE_ADDR, int, int));
 164
 165 extern void
 166 new_symfile_objfile PARAMS ((struct objfile *, int, int));
 167
 168 extern struct partial_symtab *
 169 start_psymtab_common PARAMS ((struct objfile *, struct section_offsets *,
 170                               char *, CORE_ADDR,
 171                               struct partial_symbol *,
 172                               struct partial_symbol *));
 173
 174 /* Sorting your symbols for fast lookup or alphabetical printing.  */
 175
 176 extern void
 177 sort_block_syms PARAMS ((struct block *));
 178
 179 extern void
 180 sort_symtab_syms PARAMS ((struct symtab *));
 181
 182 extern void
 183 sort_all_symtab_syms PARAMS ((void));
 184
 185 /* Make a copy of the string at PTR with SIZE characters in the symbol obstack
 186    (and add a null character at the end in the copy).
 187    Returns the address of the copy.  */
 188
 189 extern char *
 190 obsavestring PARAMS ((char *, int, struct obstack *));
 191
 192 /* Concatenate strings S1, S2 and S3; return the new string.
 193    Space is found in the symbol_obstack.  */
 194
 195 extern char *
 196 obconcat PARAMS ((struct obstack *obstackp, const char *, const char *,
 197                   const char *));
 198
 199                         /*   Variables   */
 200
 201 /* From symfile.c */
 202
 203 extern struct partial_symtab *
 204 allocate_psymtab PARAMS ((char *, struct objfile *));
 205
 206 /* From dwarfread.c */
 207
 208 extern void
 209 dwarf_build_psymtabs PARAMS ((struct objfile *, struct section_offsets *, int,
 210                               file_ptr, unsigned int, file_ptr, unsigned int));
 211
 212 /* From dbxread.c */
 213
 214 extern void
 215 elfstab_build_psymtabs PARAMS ((struct objfile *objfile,
 216         struct section_offsets *section_offsets,
 217         int mainline,
 218         file_ptr staboff, unsigned int stabsize,
 219         file_ptr stabstroffset, unsigned int stabstrsize));
 220
 221 /* From demangle.c */
 222
 223 extern void
 224 set_demangling_style PARAMS ((char *));
 225
 226 #endif  /* !defined(SYMFILE_H) */