[binutils.git] / bfd / libelf.h

/* BFD back-end data structures for ELF files.
   Copyright (C) 1992, 1993 Free Software Foundation, Inc.
   Written by Cygnus Support.

This file is part of BFD, the Binary File Descriptor library.

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

#ifndef _LIBELF_H_
#define _LIBELF_H_ 1

#include "elf/common.h"
#include "elf/internal.h"
#include "elf/external.h"

/* This CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
   The problem is, "32_" is not a valid preprocessing token, and we don't
   want extra underscores (e.g., "elf_32_").  The XCAT2 macro will cause the
   inner CAT macros to be evaluated first, producing still-valid pp-tokens.
   Then the final concatenation can be done.  (Sigh.)  */
#ifdef SABER
#define CAT4(a,b,c,d)	a##b##c##d
#else
#ifdef __STDC__
#define XCAT2(a,b)	CAT(a,b)
#define CAT4(a,b,c,d)	XCAT2(CAT(a,b),CAT(c,d))
#else
#define CAT4(a,b,c,d)	a/**/b/**/c/**/d
#endif
#endif

/* If size isn't specified as 64 or 32, NAME macro should fail.  */
#ifndef NAME
#if ARCH_SIZE==64
#define NAME(x,y) CAT4(x,64,_,y)
#endif
#if ARCH_SIZE==32
#define NAME(x,y) CAT4(x,32,_,y)
#endif
#endif

#define ElfNAME(X)	NAME(Elf,X)
#define elfNAME(X)	NAME(elf,X)

typedef struct
{
  asymbol symbol;
  Elf_Internal_Sym internal_elf_sym;
  /* these are used for the generation of .stabX symbols (?) */
  short desc;
  unsigned char type;
  char other;
  union
    {
      unsigned int hppa_arg_reloc;
      PTR any;
    }
  tc_data;
  Elf32_External_Sym native_elf_sym;
} elf32_symbol_type;

typedef struct
{
  asymbol symbol;
  Elf_Internal_Sym internal_elf_sym;
  /* these are used for the generation of .stabX symbols (?) */
  short desc;
  unsigned char type;
  char other;
  union
    {
      unsigned int hppa_arg_reloc;
      PTR any;
    }
  tc_data;
  Elf64_External_Sym native_elf_sym;
} elf64_symbol_type;

/* Lacking nested functions and nested types, set up for mapping over
   BFD sections to produce ELF sections.  */
typedef struct
{
  Elf_Internal_Ehdr * i_ehdr;
  Elf_Internal_Shdr * i_shdrp;
  struct strtab *shstrtab;
  int symtab_section;
}
elf_sect_thunk;

struct elf_backend_data
{
  int use_rela_p;
  int elf_64_p;
  enum bfd_architecture arch;
  void (*elf_info_to_howto) PARAMS ((bfd *, arelent *,
				     Elf_Internal_Rela *));
  void (*elf_info_to_howto_rel) PARAMS ((bfd *, arelent *,
					 Elf_Internal_Rel *));

  /* @@ I really don't think this should be here.  I don't know what
     global_sym is supposed to be used for, but I doubt it's something
     that would be considered global, e.g., if you've got a program
     reading and writing many BFDs.  My hunch is that it's specific to
     the output BFD.  If not, put a comment here explaining why.  */
  /* @@ Was pointer to elfNAME(symbol_type).  This makes it size-
     independent.  */
  PTR global_sym;
};

extern boolean elf_get_sect_thunk PARAMS ((bfd *, elf_sect_thunk *));
extern unsigned long elf_hash PARAMS ((CONST unsigned char *));

extern bfd_target *bfd_elf32_object_p PARAMS ((bfd *));
extern bfd_target *bfd_elf32_core_file_p PARAMS ((bfd *));
extern boolean bfd_elf_mkobject PARAMS ((bfd *));
extern boolean bfd_elf32_write_object_contents PARAMS ((bfd *));
extern char *bfd_elf32_core_file_failing_command PARAMS ((bfd *));
extern int bfd_elf32_core_file_failing_signal PARAMS ((bfd *));
extern boolean bfd_elf32_core_file_matches_executable_p PARAMS ((bfd *,
								 bfd *));
extern boolean bfd_elf32_set_section_contents PARAMS ((bfd *, sec_ptr, PTR,
						       file_ptr,
						       bfd_size_type));

extern unsigned int bfd_elf32_get_symtab_upper_bound PARAMS ((bfd *));
extern unsigned int bfd_elf32_get_symtab PARAMS ((bfd *, asymbol **));
extern unsigned int bfd_elf32_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
extern unsigned int bfd_elf32_canonicalize_reloc PARAMS ((bfd *, sec_ptr,
							  arelent **,
							  asymbol **));
extern asymbol *bfd_elf32_make_empty_symbol PARAMS ((bfd *));
extern void bfd_elf32_print_symbol PARAMS ((bfd *, PTR, asymbol *,
					    bfd_print_symbol_type));
extern void bfd_elf32_get_symbol_info PARAMS ((bfd *, asymbol *,
					       symbol_info *));
extern alent *bfd_elf32_get_lineno PARAMS ((bfd *, asymbol *));
extern boolean bfd_elf32_set_arch_mach PARAMS ((bfd *, enum bfd_architecture,
						unsigned long));
extern boolean bfd_elf32_find_nearest_line PARAMS ((bfd *, asection *,
						    asymbol **,
						    bfd_vma, CONST char **,
						    CONST char **,
						    unsigned int *));
extern int bfd_elf32_sizeof_headers PARAMS ((bfd *, boolean));
extern boolean bfd_elf32_new_section_hook PARAMS ((bfd *, asection *));

/* If the target doesn't have reloc handling written yet:  */
extern void bfd_elf32_no_info_to_howto PARAMS ((bfd *, arelent *,
						Elf32_Internal_Rela *));

extern bfd_target *bfd_elf64_object_p PARAMS ((bfd *));
extern bfd_target *bfd_elf64_core_file_p PARAMS ((bfd *));
extern boolean bfd_elf64_write_object_contents PARAMS ((bfd *));
extern char *bfd_elf64_core_file_failing_command PARAMS ((bfd *));
extern int bfd_elf64_core_file_failing_signal PARAMS ((bfd *));
extern boolean bfd_elf64_core_file_matches_executable_p PARAMS ((bfd *,
								 bfd *));
extern boolean bfd_elf64_set_section_contents PARAMS ((bfd *, sec_ptr, PTR,
						       file_ptr,
						       bfd_size_type));

extern unsigned int bfd_elf64_get_symtab_upper_bound PARAMS ((bfd *));
extern unsigned int bfd_elf64_get_symtab PARAMS ((bfd *, asymbol **));
extern unsigned int bfd_elf64_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
extern unsigned int bfd_elf64_canonicalize_reloc PARAMS ((bfd *, sec_ptr,
							  arelent **,
							  asymbol **));
extern asymbol *bfd_elf64_make_empty_symbol PARAMS ((bfd *));
extern void bfd_elf64_print_symbol PARAMS ((bfd *, PTR, asymbol *,
					    bfd_print_symbol_type));
extern void bfd_elf64_get_symbol_info PARAMS ((bfd *, asymbol *,
					       symbol_info *));
extern alent *bfd_elf64_get_lineno PARAMS ((bfd *, asymbol *));
extern boolean bfd_elf64_set_arch_mach PARAMS ((bfd *, enum bfd_architecture,
						unsigned long));
extern boolean bfd_elf64_find_nearest_line PARAMS ((bfd *, asection *,
						    asymbol **,
						    bfd_vma, CONST char **,
						    CONST char **,
						    unsigned int *));
extern int bfd_elf64_sizeof_headers PARAMS ((bfd *, boolean));
extern boolean bfd_elf64_new_section_hook PARAMS ((bfd *, asection *));

/* If the target doesn't have reloc handling written yet:  */
extern void bfd_elf64_no_info_to_howto PARAMS ((bfd *, arelent *,
						Elf64_Internal_Rela *));

#define get_elf_backend_data(abfd) \
  ((struct elf_backend_data *) (abfd)->xvec->backend_data)

struct strtab
{
  char *tab;
  int nentries;
  int length;
};

/* Some private data is stashed away for future use using the tdata pointer
   in the bfd structure.  */

struct elf_obj_tdata
{
  Elf_Internal_Ehdr elf_header[1];	/* Actual data, but ref like ptr */
  Elf_Internal_Shdr *elf_sect_ptr;
  struct strtab *strtab_ptr;
  int symtab_section;
  int num_locals;
  int num_globals;
  int *symtab_map;
  void *prstatus;		/* The raw /proc prstatus structure */
  void *prpsinfo;		/* The raw /proc prpsinfo structure */
  PTR raw_syms;			/* Elf_External_Sym* */
  Elf_Internal_Sym *internal_syms;
  PTR symbols;			/* elf_symbol_type */
  elf_sect_thunk thunk;
};

#define elf_tdata(bfd)		((bfd) -> tdata.elf_obj_data)
#define elf_elfheader(bfd)	(elf_tdata(bfd) -> elf_header)
#define elf_elfsections(bfd)	(elf_tdata(bfd) -> elf_sect_ptr)
#define elf_shstrtab(bfd)	(elf_tdata(bfd) -> strtab_ptr)
#define elf_onesymtab(bfd)	(elf_tdata(bfd) -> symtab_section)
#define elf_num_locals(bfd)	(elf_tdata(bfd) -> num_locals)
#define elf_num_globals(bfd)	(elf_tdata(bfd) -> num_globals)
#define elf_symtab_map(bfd)	(elf_tdata(bfd) -> symtab_map)
#define core_prpsinfo(bfd)	(elf_tdata(bfd) -> prpsinfo)
#define core_prstatus(bfd)	(elf_tdata(bfd) -> prstatus)
#define obj_symbols(bfd)	((elf_symbol_type*)(elf_tdata(bfd) -> symbols))
#define obj_raw_syms(bfd)	((Elf_External_Sym*)(elf_tdata(bfd) -> raw_syms))
#define obj_internal_syms(bfd)	(elf_tdata(bfd) -> internal_syms)

extern char * elf_string_from_elf_section PARAMS ((bfd *, unsigned, unsigned));
extern char * elf_get_str_section PARAMS ((bfd *, unsigned));

#define bfd_elf32_mkobject	bfd_elf_mkobject
#define bfd_elf64_mkobject	bfd_elf_mkobject
#define elf_mkobject		bfd_elf_mkobject

#endif /* _LIBELF_H_ */
Commit	Line	Data
db232882 KR	1	/* BFD back-end data structures for ELF files.
	2	Copyright (C) 1992, 1993 Free Software Foundation, Inc.
	3	Written by Cygnus Support.
	4
	5	This file is part of BFD, the Binary File Descriptor library.
	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., 675 Mass Ave, Cambridge, MA 02139, USA. */
	20
	21	#ifndef _LIBELF_H_
	22	#define _LIBELF_H_ 1
	23
81187b54 KR	24	#include "elf/common.h"
	25	#include "elf/internal.h"
	26	#include "elf/external.h"
	27
638616ca KR	28	/* This CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
	29	The problem is, "32_" is not a valid preprocessing token, and we don't
	30	want extra underscores (e.g., "elf_32_"). The XCAT2 macro will cause the
	31	inner CAT macros to be evaluated first, producing still-valid pp-tokens.
	32	Then the final concatenation can be done. (Sigh.) */
7d9bb6da KR	33	#ifdef SABER
	34	#define CAT4(a,b,c,d) a##b##c##d
	35	#else
638616ca KR	36	#ifdef __STDC__
	37	#define XCAT2(a,b) CAT(a,b)
	38	#define CAT4(a,b,c,d) XCAT2(CAT(a,b),CAT(c,d))
	39	#else
	40	#define CAT4(a,b,c,d) a//b//c/**/d
	41	#endif
7d9bb6da	42	#endif
638616ca	43
998ce1e0	44	/* If size isn't specified as 64 or 32, NAME macro should fail. */
9942e684	45	#ifndef NAME
7050286d	46	#if ARCH_SIZE==64
638616ca	47	#define NAME(x,y) CAT4(x,64,_,y)
998ce1e0 KR	48	#endif
998ce1e0 KR	49	#if ARCH_SIZE==32
638616ca	50	#define NAME(x,y) CAT4(x,32,_,y)
9942e684 KR	51	#endif
	52	#endif
	53
638616ca KR	54	#define ElfNAME(X) NAME(Elf,X)
	55	#define elfNAME(X) NAME(elf,X)
	56
db232882 KR	57	typedef struct
	58	{
	59	asymbol symbol;
268f94ac	60	Elf_Internal_Sym internal_elf_sym;
db232882 KR	61	/* these are used for the generation of .stabX symbols (?) */
	62	short desc;
	63	unsigned char type;
	64	char other;
7050286d KR	65	union
	66	{
	67	unsigned int hppa_arg_reloc;
	68	PTR any;
	69	}
	70	tc_data;
998ce1e0 KR	71	Elf32_External_Sym native_elf_sym;
998ce1e0 KR	72	} elf32_symbol_type;
db232882	73
998ce1e0 KR	74	typedef struct
	75	{
	76	asymbol symbol;
	77	Elf_Internal_Sym internal_elf_sym;
	78	/* these are used for the generation of .stabX symbols (?) */
	79	short desc;
	80	unsigned char type;
	81	char other;
	82	union
	83	{
	84	unsigned int hppa_arg_reloc;
	85	PTR any;
	86	}
	87	tc_data;
	88	Elf64_External_Sym native_elf_sym;
	89	} elf64_symbol_type;
7050286d KR	90
	91	/* Lacking nested functions and nested types, set up for mapping over
	92	BFD sections to produce ELF sections. */
	93	typedef struct
	94	{
268f94ac KR	95	Elf_Internal_Ehdr * i_ehdr;
268f94ac KR	96	Elf_Internal_Shdr * i_shdrp;
7050286d KR	97	struct strtab *shstrtab;
	98	int symtab_section;
	99	}
7050286d KR	100	elf_sect_thunk;
7050286d KR	101
268f94ac	102	struct elf_backend_data
7050286d KR	103	{
	104	int use_rela_p;
	105	int elf_64_p;
81187b54	106	enum bfd_architecture arch;
7050286d	107	void (elf_info_to_howto) PARAMS ((bfd , arelent *,
268f94ac	108	Elf_Internal_Rela *));
7050286d	109	void (elf_info_to_howto_rel) PARAMS ((bfd , arelent *,
268f94ac	110	Elf_Internal_Rel *));
db232882	111
8e40bcd8 KR	112	/* @@ I really don't think this should be here. I don't know what
	113	global_sym is supposed to be used for, but I doubt it's something
	114	that would be considered global, e.g., if you've got a program
	115	reading and writing many BFDs. My hunch is that it's specific to
	116	the output BFD. If not, put a comment here explaining why. */
998ce1e0 KR	117	/* @@ Was pointer to elfNAME(symbol_type). This makes it size-
	118	independent. */
	119	PTR global_sym;
81187b54 KR	120	};
81187b54 KR	121
7e37f9ff KR	122	extern boolean elf_get_sect_thunk PARAMS ((bfd , elf_sect_thunk ));
	123	extern unsigned long elf_hash PARAMS ((CONST unsigned char *));
	124
9942e684 KR	125	extern bfd_target bfd_elf32_object_p PARAMS ((bfd ));
9942e684 KR	126	extern bfd_target bfd_elf32_core_file_p PARAMS ((bfd ));
998ce1e0	127	extern boolean bfd_elf_mkobject PARAMS ((bfd *));
9942e684 KR	128	extern boolean bfd_elf32_write_object_contents PARAMS ((bfd *));
	129	extern char bfd_elf32_core_file_failing_command PARAMS ((bfd ));
	130	extern int bfd_elf32_core_file_failing_signal PARAMS ((bfd *));
	131	extern boolean bfd_elf32_core_file_matches_executable_p PARAMS ((bfd *,
	132	bfd *));
	133	extern boolean bfd_elf32_set_section_contents PARAMS ((bfd *, sec_ptr, PTR,
	134	file_ptr,
	135	bfd_size_type));
7050286d	136
9942e684 KR	137	extern unsigned int bfd_elf32_get_symtab_upper_bound PARAMS ((bfd *));
	138	extern unsigned int bfd_elf32_get_symtab PARAMS ((bfd , asymbol *));
	139	extern unsigned int bfd_elf32_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
	140	extern unsigned int bfd_elf32_canonicalize_reloc PARAMS ((bfd *, sec_ptr,
	141	arelent **,
	142	asymbol **));
	143	extern asymbol bfd_elf32_make_empty_symbol PARAMS ((bfd ));
	144	extern void bfd_elf32_print_symbol PARAMS ((bfd , PTR, asymbol ,
	145	bfd_print_symbol_type));
	146	extern void bfd_elf32_get_symbol_info PARAMS ((bfd , asymbol ,
7050286d	147	symbol_info *));
9942e684 KR	148	extern alent bfd_elf32_get_lineno PARAMS ((bfd , asymbol *));
	149	extern boolean bfd_elf32_set_arch_mach PARAMS ((bfd *, enum bfd_architecture,
	150	unsigned long));
	151	extern boolean bfd_elf32_find_nearest_line PARAMS ((bfd , asection ,
	152	asymbol **,
	153	bfd_vma, CONST char **,
	154	CONST char **,
	155	unsigned int *));
	156	extern int bfd_elf32_sizeof_headers PARAMS ((bfd *, boolean));
e6858d1b	157	extern boolean bfd_elf32_new_section_hook PARAMS ((bfd , asection ));
81187b54 KR	158
81187b54 KR	159	/* If the target doesn't have reloc handling written yet: */
9942e684 KR	160	extern void bfd_elf32_no_info_to_howto PARAMS ((bfd , arelent ,
9942e684 KR	161	Elf32_Internal_Rela *));
db232882	162
7d9bb6da KR	163	extern bfd_target bfd_elf64_object_p PARAMS ((bfd ));
	164	extern bfd_target bfd_elf64_core_file_p PARAMS ((bfd ));
	165	extern boolean bfd_elf64_write_object_contents PARAMS ((bfd *));
	166	extern char bfd_elf64_core_file_failing_command PARAMS ((bfd ));
	167	extern int bfd_elf64_core_file_failing_signal PARAMS ((bfd *));
	168	extern boolean bfd_elf64_core_file_matches_executable_p PARAMS ((bfd *,
	169	bfd *));
	170	extern boolean bfd_elf64_set_section_contents PARAMS ((bfd *, sec_ptr, PTR,
	171	file_ptr,
	172	bfd_size_type));
	173
	174	extern unsigned int bfd_elf64_get_symtab_upper_bound PARAMS ((bfd *));
	175	extern unsigned int bfd_elf64_get_symtab PARAMS ((bfd , asymbol *));
	176	extern unsigned int bfd_elf64_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
	177	extern unsigned int bfd_elf64_canonicalize_reloc PARAMS ((bfd *, sec_ptr,
	178	arelent **,
	179	asymbol **));
	180	extern asymbol bfd_elf64_make_empty_symbol PARAMS ((bfd ));
	181	extern void bfd_elf64_print_symbol PARAMS ((bfd , PTR, asymbol ,
	182	bfd_print_symbol_type));
	183	extern void bfd_elf64_get_symbol_info PARAMS ((bfd , asymbol ,
	184	symbol_info *));
	185	extern alent bfd_elf64_get_lineno PARAMS ((bfd , asymbol *));
	186	extern boolean bfd_elf64_set_arch_mach PARAMS ((bfd *, enum bfd_architecture,
	187	unsigned long));
	188	extern boolean bfd_elf64_find_nearest_line PARAMS ((bfd , asection ,
	189	asymbol **,
	190	bfd_vma, CONST char **,
	191	CONST char **,
	192	unsigned int *));
	193	extern int bfd_elf64_sizeof_headers PARAMS ((bfd *, boolean));
	194	extern boolean bfd_elf64_new_section_hook PARAMS ((bfd , asection ));
	195
	196	/* If the target doesn't have reloc handling written yet: */
	197	extern void bfd_elf64_no_info_to_howto PARAMS ((bfd , arelent ,
	198	Elf64_Internal_Rela *));
	199
7050286d	200	#define get_elf_backend_data(abfd) \
268f94ac	201	((struct elf_backend_data *) (abfd)->xvec->backend_data)
7050286d KR	202
	203	struct strtab
	204	{
	205	char *tab;
	206	int nentries;
	207	int length;
	208	};
	209
998ce1e0 KR	210	/* Some private data is stashed away for future use using the tdata pointer
	211	in the bfd structure. */
	212
	213	struct elf_obj_tdata
	214	{
	215	Elf_Internal_Ehdr elf_header[1]; /* Actual data, but ref like ptr */
	216	Elf_Internal_Shdr *elf_sect_ptr;
	217	struct strtab *strtab_ptr;
	218	int symtab_section;
	219	int num_locals;
	220	int num_globals;
	221	int *symtab_map;
	222	void prstatus; / The raw /proc prstatus structure */
	223	void prpsinfo; / The raw /proc prpsinfo structure */
	224	PTR raw_syms; /* Elf_External_Sym* */
	225	Elf_Internal_Sym *internal_syms;
	226	PTR symbols; /* elf_symbol_type */
cb6d724f	227	elf_sect_thunk thunk;
998ce1e0 KR	228	};
	229
	230	#define elf_tdata(bfd) ((bfd) -> tdata.elf_obj_data)
	231	#define elf_elfheader(bfd) (elf_tdata(bfd) -> elf_header)
	232	#define elf_elfsections(bfd) (elf_tdata(bfd) -> elf_sect_ptr)
	233	#define elf_shstrtab(bfd) (elf_tdata(bfd) -> strtab_ptr)
	234	#define elf_onesymtab(bfd) (elf_tdata(bfd) -> symtab_section)
	235	#define elf_num_locals(bfd) (elf_tdata(bfd) -> num_locals)
	236	#define elf_num_globals(bfd) (elf_tdata(bfd) -> num_globals)
	237	#define elf_symtab_map(bfd) (elf_tdata(bfd) -> symtab_map)
	238	#define core_prpsinfo(bfd) (elf_tdata(bfd) -> prpsinfo)
	239	#define core_prstatus(bfd) (elf_tdata(bfd) -> prstatus)
	240	#define obj_symbols(bfd) ((elf_symbol_type*)(elf_tdata(bfd) -> symbols))
	241	#define obj_raw_syms(bfd) ((Elf_External_Sym*)(elf_tdata(bfd) -> raw_syms))
	242	#define obj_internal_syms(bfd) (elf_tdata(bfd) -> internal_syms)
	243
7e37f9ff KR	244	extern char * elf_string_from_elf_section PARAMS ((bfd *, unsigned, unsigned));
7e37f9ff KR	245	extern char * elf_get_str_section PARAMS ((bfd *, unsigned));
998ce1e0 KR	246
	247	#define bfd_elf32_mkobject bfd_elf_mkobject
	248	#define bfd_elf64_mkobject bfd_elf_mkobject
	249	#define elf_mkobject bfd_elf_mkobject
	250
db232882	251	#endif /* _LIBELF_H_ */