[binutils.git] / gdb / symfile.h

/* Definitions for reading symbol files into GDB.
   Copyright (C) 1990, 1991, 1992  Free Software Foundation, Inc.

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 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.  */

#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;
};

/* 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".  */

  char *sym_name;

  /* 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 NULL.  If a prefix match is desired, specify the number of
     characters in sym_name.  */

  int sym_namelen;

  /* 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. */

  void (*sym_new_init) PARAMS ((struct objfile *));

  /* 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 objfile *));

  /* 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 objfile *, struct section_offsets *, int));

  /* 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 *));

  /* 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.  */

  struct section_offsets *(*sym_offsets) PARAMS ((struct objfile *, CORE_ADDR));

  /* 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.  */

  struct sym_fns *next;

};

extern void
extend_psymbol_list PARAMS ((struct psymbol_allocation_list *,
			     struct objfile *));

/* Add any kind of symbol to a psymbol_allocation_list. */

#ifndef INLINE_ADD_PSYMBOL
#define INLINE_ADD_PSYMBOL 1
#endif

#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, 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, language, objfile) \
  add_psymbol_addr_to_list (name, namelength, namespace, class, &list, value, language, objfile)

#else	/* !INLINE_ADD_PSYMBOL */

#include "demangle.h"

#define	ADD_PSYMBOL_VT_TO_LIST(NAME,NAMELENGTH,NAMESPACE,CLASS,LIST,VALUE,VT,LANGUAGE, OBJFILE) \
  do {		        						\
    register struct partial_symbol *psym;				\
    register char *demangled_name;					\
    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);				\
    PSYMBOL_CLASS (psym) = (CLASS);					\
    VT (psym) = (VALUE); 						\
    SYMBOL_LANGUAGE (psym) = (LANGUAGE);				\
    SYMBOL_INIT_DEMANGLED_NAME (psym, &objfile->psymbol_obstack);	\
  } while (0);

/* Add a symbol with an integer value to a psymtab. */

#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, language, objfile)\
  ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE_ADDRESS, language, objfile)

#endif	/* INLINE_ADD_PSYMBOL */

			/*   Functions   */

extern void
sort_pst_symbols PARAMS ((struct partial_symtab *));

extern struct symtab *
allocate_symtab PARAMS ((char *, struct objfile *));

extern int
free_named_symtabs PARAMS ((char *));

extern void
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 *, struct section_offsets *,
			      char *, CORE_ADDR,
			      struct partial_symbol *,
			      struct partial_symbol *));

/* Sorting your symbols for fast lookup or alphabetical printing.  */

extern void
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.  */

extern char *
obsavestring PARAMS ((char *, int, struct obstack *));

/* Concatenate strings S1, S2 and S3; return the new string.
   Space is found in the symbol_obstack.  */

extern char *
obconcat PARAMS ((struct obstack *obstackp, const char *, const char *,
		  const char *));

			/*   Variables   */

/* From symfile.c */

extern struct partial_symtab *
allocate_psymtab PARAMS ((char *, struct objfile *));

/* From dwarfread.c */

extern void
dwarf_build_psymtabs PARAMS ((struct objfile *, struct section_offsets *, int,
			      file_ptr, unsigned int, file_ptr, unsigned int));

/* From dbxread.c */

extern void
elfstab_build_psymtabs PARAMS ((struct objfile *objfile,
	struct section_offsets *section_offsets,
	int mainline,
	file_ptr staboff, unsigned int stabsize,
	file_ptr stabstroffset, unsigned int stabstrsize));

/* From demangle.c */

extern void
set_demangling_style PARAMS ((char *));

#endif	/* !defined(SYMFILE_H) */
Commit	Line	Data
bd5635a1	1	/* Definitions for reading symbol files into GDB.
318bf84f	2	Copyright (C) 1990, 1991, 1992 Free Software Foundation, Inc.
bd5635a1 RP	3
	4	This file is part of GDB.
	5
2f068b0d	6	This program is free software; you can redistribute it and/or modify
bd5635a1	7	it under the terms of the GNU General Public License as published by
2f068b0d FF	8	the Free Software Foundation; either version 2 of the License, or
2f068b0d FF	9	(at your option) any later version.
bd5635a1	10
2f068b0d	11	This program is distributed in the hope that it will be useful,
bd5635a1 RP	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
2f068b0d FF	17	along with this program; if not, write to the Free Software
2f068b0d FF	18	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
bd5635a1	19
318bf84f FF	20	#if !defined (SYMFILE_H)
	21	#define SYMFILE_H
	22
bd5635a1 RP	23	/* This file requires that you first include "bfd.h". */
bd5635a1 RP	24
318bf84f FF	25	struct psymbol_allocation_list {
	26	struct partial_symbol *list;
	27	struct partial_symbol *next;
	28	int size;
	29	};
	30
80d68b1d FF	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
73d0fc78 RP	43	desired, specify the number of characters in sym_name plus 1 for
	44	the NULL. If a prefix match is desired, specify the number of
	45	characters in sym_name. */
80d68b1d FF	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).
51b80b00 FF	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
80d68b1d FF	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
51b80b00	72	void (sym_read) PARAMS ((struct objfile , struct section_offsets *, int));
80d68b1d FF	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
51b80b00 FF	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
80d68b1d FF	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
318bf84f FF	96	extern void
	97	extend_psymbol_list PARAMS ((struct psymbol_allocation_list *,
	98	struct objfile *));
7e258d18 PB	99
	100	/* Add any kind of symbol to a psymbol_allocation_list. */
	101
2e4964ad FF	102	#ifndef INLINE_ADD_PSYMBOL
	103	#define INLINE_ADD_PSYMBOL 1
	104	#endif
	105
	106	#if !INLINE_ADD_PSYMBOL
	107
	108	/* Since one arg is a struct, we have to pass in a ptr and deref it (sigh) */
	109
	110	#define ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value, language, objfile) \
	111	add_psymbol_to_list (name, namelength, namespace, class, &list, value, language, objfile)
	112
	113	#define ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value, language, objfile) \
	114	add_psymbol_addr_to_list (name, namelength, namespace, class, &list, value, language, objfile)
	115
	116	#else /* !INLINE_ADD_PSYMBOL */
	117
	118	#include "demangle.h"
	119
	120	#define ADD_PSYMBOL_VT_TO_LIST(NAME,NAMELENGTH,NAMESPACE,CLASS,LIST,VALUE,VT,LANGUAGE, OBJFILE) \
7e258d18 PB	121	do { \
7e258d18 PB	122	register struct partial_symbol *psym; \
2e4964ad	123	register char *demangled_name; \
7e258d18	124	if ((LIST).next >= (LIST).list + (LIST).size) \
2e4964ad	125	extend_psymbol_list (&(LIST),(OBJFILE)); \
7e258d18	126	psym = (LIST).next++; \
2e4964ad FF	127	SYMBOL_NAME (psym) = \
	128	(char *) obstack_alloc (&objfile->psymbol_obstack, \
	129	(NAMELENGTH) + 1); \
318bf84f	130	memcpy (SYMBOL_NAME (psym), (NAME), (NAMELENGTH)); \
7e258d18 PB	131	SYMBOL_NAME (psym)[(NAMELENGTH)] = '\0'; \
7e258d18 PB	132	SYMBOL_NAMESPACE (psym) = (NAMESPACE); \
2e4964ad	133	PSYMBOL_CLASS (psym) = (CLASS); \
7e258d18	134	VT (psym) = (VALUE); \
2e4964ad	135	SYMBOL_LANGUAGE (psym) = (LANGUAGE); \
73d0fc78	136	SYMBOL_INIT_DEMANGLED_NAME (psym, &objfile->psymbol_obstack); \
7e258d18 PB	137	} while (0);
7e258d18 PB	138
318bf84f FF	139	/* Add a symbol with an integer value to a psymtab. */
318bf84f FF	140
2e4964ad FF	141	#define ADD_PSYMBOL_TO_LIST(name, namelength, namespace, class, list, value, language, objfile) \
2e4964ad FF	142	ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE, language, objfile)
318bf84f FF	143
	144	/* Add a symbol with a CORE_ADDR value to a psymtab. */
	145
2e4964ad FF	146	#define ADD_PSYMBOL_ADDR_TO_LIST(name, namelength, namespace, class, list, value, language, objfile)\
2e4964ad FF	147	ADD_PSYMBOL_VT_TO_LIST (name, namelength, namespace, class, list, value, SYMBOL_VALUE_ADDRESS, language, objfile)
318bf84f	148
2e4964ad	149	#endif /* INLINE_ADD_PSYMBOL */
318bf84f	150
bd5635a1 RP	151	/* Functions */
bd5635a1 RP	152
318bf84f FF	153	extern void
	154	sort_pst_symbols PARAMS ((struct partial_symtab *));
	155
	156	extern struct symtab *
	157	allocate_symtab PARAMS ((char , struct objfile ));
	158
318bf84f FF	159	extern int
318bf84f FF	160	free_named_symtabs PARAMS ((char *));
bd5635a1	161
318bf84f FF	162	extern void
318bf84f FF	163	fill_in_vptr_fieldno PARAMS ((struct type *));
bd5635a1	164
318bf84f FF	165	extern void
	166	add_symtab_fns PARAMS ((struct sym_fns *));
	167
51b80b00 FF	168	extern void
	169	init_entry_point_info PARAMS ((struct objfile *));
	170
318bf84f FF	171	extern void
	172	syms_from_objfile PARAMS ((struct objfile *, CORE_ADDR, int, int));
	173
51b80b00 FF	174	extern void
	175	new_symfile_objfile PARAMS ((struct objfile *, int, int));
	176
318bf84f	177	extern struct partial_symtab *
51b80b00 FF	178	start_psymtab_common PARAMS ((struct objfile , struct section_offsets ,
51b80b00 FF	179	char *, CORE_ADDR,
318bf84f FF	180	struct partial_symbol *,
318bf84f FF	181	struct partial_symbol *));
bd5635a1 RP	182
	183	/* Sorting your symbols for fast lookup or alphabetical printing. */
	184
318bf84f FF	185	extern void
	186	sort_block_syms PARAMS ((struct block *));
	187
	188	extern void
	189	sort_symtab_syms PARAMS ((struct symtab *));
	190
	191	extern void
	192	sort_all_symtab_syms PARAMS ((void));
bd5635a1 RP	193
	194	/* Make a copy of the string at PTR with SIZE characters in the symbol obstack
	195	(and add a null character at the end in the copy).
	196	Returns the address of the copy. */
	197
318bf84f FF	198	extern char *
318bf84f FF	199	obsavestring PARAMS ((char , int, struct obstack ));
bd5635a1 RP	200
	201	/* Concatenate strings S1, S2 and S3; return the new string.
	202	Space is found in the symbol_obstack. */
	203
318bf84f FF	204	extern char *
	205	obconcat PARAMS ((struct obstack obstackp, const char , const char *,
	206	const char *));
bd5635a1 RP	207
	208	/* Variables */
	209
318bf84f FF	210	/* From symfile.c */
	211
	212	extern struct partial_symtab *
	213	allocate_psymtab PARAMS ((char , struct objfile ));
	214
51b80b00	215	/* From dwarfread.c */
318bf84f	216
51b80b00 FF	217	extern void
	218	dwarf_build_psymtabs PARAMS ((struct objfile , struct section_offsets , int,
	219	file_ptr, unsigned int, file_ptr, unsigned int));
318bf84f	220
51b80b00	221	/* From dbxread.c */
318bf84f	222
51b80b00 FF	223	extern void
	224	elfstab_build_psymtabs PARAMS ((struct objfile *objfile,
	225	struct section_offsets *section_offsets,
	226	int mainline,
	227	file_ptr staboff, unsigned int stabsize,
	228	file_ptr stabstroffset, unsigned int stabstrsize));
318bf84f	229
51b80b00	230	/* From demangle.c */
318bf84f FF	231
318bf84f FF	232	extern void
51b80b00	233	set_demangling_style PARAMS ((char *));
318bf84f FF	234
318bf84f FF	235	#endif /* !defined(SYMFILE_H) */