[deliverable/binutils-gdb.git] / bfd / libbfd-in.h

/* libbfd.h -- Declarations used by bfd library *implementation*.
   (This include file is not for users of the library.)
   Copyright 1990, 1991, 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.  */


/* Align an address upward to a boundary, expressed as a number of bytes.
   E.g. align to an 8-byte boundary with argument of 8.  */
#define BFD_ALIGN(this, boundary) \
  ((( (this) + ((boundary) -1)) & (~((boundary)-1))))

/* If you want to read and write large blocks, you might want to do it
   in quanta of this amount */
#define DEFAULT_BUFFERSIZE 8192

/* Set a tdata field.  Can't use the other macros for this, since they
   do casts, and casting to the left of assignment isn't portable.  */
#define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))

/* tdata for an archive.  For an input archive, cache
   needs to be free()'d.  For an output archive, symdefs do.  */

struct artdata {
  file_ptr first_file_filepos;
  /* Speed up searching the armap */
  struct ar_cache *cache;
  bfd *archive_head;            /* Only interesting in output routines */
  carsym *symdefs;		/* the symdef entries */
  symindex symdef_count;             /* how many there are */
  char *extended_names;		/* clever intel extension */
};

#define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)

/* Goes in bfd's arelt_data slot */
struct areltdata {
  char * arch_header;			     /* it's actually a string */
  unsigned int parsed_size;     /* octets of filesize not including ar_hdr */
  char *filename;			     /* null-terminated */
};

#define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)

char *zalloc PARAMS ((bfd_size_type size));

/* These routines allocate and free things on the BFD's obstack.  Note
   that realloc can never occur in place.  */

PTR	bfd_alloc PARAMS ((bfd *abfd, bfd_size_type size));
PTR	bfd_zalloc PARAMS ((bfd *abfd, bfd_size_type size));
PTR	bfd_realloc PARAMS ((bfd *abfd, PTR orig, bfd_size_type new));
void	bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, bfd_size_type size));
PTR	bfd_alloc_finish PARAMS ((bfd *abfd));
PTR	bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));

#define	bfd_release(x,y) (void) obstack_free(&(x->memory),y)


bfd_size_type	bfd_read  PARAMS ((PTR ptr, bfd_size_type size,
				   bfd_size_type nitems, bfd *abfd));
bfd_size_type	bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size,
				   bfd_size_type nitems, bfd *abfd));
int		bfd_seek  PARAMS ((bfd* CONST abfd, CONST file_ptr fp,
				   CONST int direction));
long		bfd_tell  PARAMS ((bfd *abfd));

bfd *	_bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
bfd *	look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
boolean	_bfd_generic_mkarchive PARAMS ((bfd *abfd));
struct areltdata *	snarf_ar_hdr PARAMS ((bfd *abfd));
bfd_target *		bfd_generic_archive_p PARAMS ((bfd *abfd));
boolean	bfd_slurp_armap PARAMS ((bfd *abfd));
#define bfd_slurp_bsd_armap bfd_slurp_armap
#define bfd_slurp_coff_armap bfd_slurp_armap
boolean	_bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
boolean	_bfd_write_archive_contents PARAMS ((bfd *abfd));
bfd *	new_bfd PARAMS (());

#define DEFAULT_STRING_SPACE_SIZE 0x2000
boolean	bfd_add_to_string_table PARAMS ((char **table, char *new_string,
					 unsigned int *table_length,
					 char **free_ptr));
bfd_vma _do_getb64 PARAMS ((unsigned char *addr));     
bfd_vma _do_getl64 PARAMS ((unsigned char *addr));     
bfd_signed_vma _do_getb_signed_64 PARAMS ((unsigned char *addr));     
bfd_signed_vma _do_getl_signed_64 PARAMS ((unsigned char *addr));     
bfd_vma _do_getb32 PARAMS ((unsigned char *addr));
bfd_vma _do_getl32 PARAMS ((unsigned char *addr));
bfd_signed_vma _do_getb_signed_32 PARAMS ((unsigned char *addr));
bfd_signed_vma _do_getl_signed_32 PARAMS ((unsigned char *addr));
bfd_vma _do_getb16 PARAMS ((unsigned char *addr));
bfd_vma _do_getl16 PARAMS ((unsigned char *addr));
bfd_signed_vma _do_getb_signed_16 PARAMS ((unsigned char *addr));
bfd_signed_vma _do_getl_signed_16 PARAMS ((unsigned char *addr));
void    _do_putb64 PARAMS ((bfd_vma data, unsigned char *addr));
void    _do_putl64 PARAMS ((bfd_vma data, unsigned char *addr));
void    _do_putb32 PARAMS ((bfd_vma data, unsigned char *addr));
void    _do_putl32 PARAMS ((bfd_vma data, unsigned char *addr));
void    _do_putb16 PARAMS ((bfd_vma data, unsigned char *addr));
void    _do_putl16 PARAMS ((bfd_vma data, unsigned char *addr));

boolean	bfd_false PARAMS ((bfd *ignore));
boolean	bfd_true PARAMS ((bfd *ignore));
PTR	bfd_nullvoidptr PARAMS ((bfd *ignore));
int	bfd_0 PARAMS ((bfd *ignore));
unsigned int	bfd_0u PARAMS ((bfd *ignore));
void	bfd_void PARAMS ((bfd *ignore));

bfd *	new_bfd_contained_in PARAMS ((bfd *));
boolean	 _bfd_dummy_new_section_hook PARAMS ((bfd *ignore, asection *newsect));
char *	 _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
int	 _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
boolean	 _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
							    bfd *exec_bfd));
bfd_target *	_bfd_dummy_target PARAMS ((bfd *abfd));

void	bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
					char *hdr));
void	bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
					char *hdr));
void	bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
					char *hdr));

boolean	bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
				  struct orl *map, unsigned int orl_count, int stridx));

boolean	coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
				   struct orl *map, unsigned int orl_count, int stridx));

bfd *	bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
						     bfd *last_file));

int	bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));

boolean	bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
 						  PTR location, file_ptr offset,
						  bfd_size_type count));

boolean	bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
						  PTR location, file_ptr offset,
						  bfd_size_type count));

/* Macros to tell if bfds are read or write enabled.

   Note that bfds open for read may be scribbled into if the fd passed
   to bfd_fdopenr is actually open both for read and write
   simultaneously.  However an output bfd will never be open for
   read.  Therefore sometimes you want to check bfd_read_p or
   !bfd_read_p, and only sometimes bfd_write_p.
*/

#define	bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
#define	bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)

void	bfd_assert PARAMS ((char*,int));

#define BFD_ASSERT(x) \
{ if (!(x)) bfd_assert(__FILE__,__LINE__); }

#define BFD_FAIL() \
{ bfd_assert(__FILE__,__LINE__); }

FILE *	bfd_cache_lookup_worker PARAMS ((bfd *));

extern bfd *bfd_last_cache;
    
/* Now Steve, what's the story here? */
#ifdef lint
#define itos(x) "l"
#define stoi(x) 1
#else
#define itos(x) ((char*)(x))
#define stoi(x) ((int)(x))
#endif

/* Generic routine for close_and_cleanup is really just bfd_true.  */
#define	bfd_generic_close_and_cleanup	bfd_true

/* And more follows */
Commit	Line	Data
4e6f9223 SC	1	/* libbfd.h -- Declarations used by bfd library implementation.
4e6f9223 SC	2	(This include file is not for users of the library.)
14e3c2e4	3	Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
4e6f9223 SC	4	Written by Cygnus Support.
	5
	6	This file is part of BFD, the Binary File Descriptor library.
	7
	8	This program is free software; you can redistribute it and/or modify
	9	it under the terms of the GNU General Public License as published by
	10	the Free Software Foundation; either version 2 of the License, or
	11	(at your option) any later version.
	12
	13	This program is distributed in the hope that it will be useful,
	14	but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	GNU General Public License for more details.
	17
	18	You should have received a copy of the GNU General Public License
	19	along with this program; if not, write to the Free Software
	20	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
	21
4e6f9223	22
01dd1b2b SC	23	/* Align an address upward to a boundary, expressed as a number of bytes.
01dd1b2b SC	24	E.g. align to an 8-byte boundary with argument of 8. */
8c4a1ace	25	#define BFD_ALIGN(this, boundary) \
01dd1b2b SC	26	((( (this) + ((boundary) -1)) & (~((boundary)-1))))
01dd1b2b SC	27
4e6f9223 SC	28	/* If you want to read and write large blocks, you might want to do it
	29	in quanta of this amount */
	30	#define DEFAULT_BUFFERSIZE 8192
	31
	32	/* Set a tdata field. Can't use the other macros for this, since they
	33	do casts, and casting to the left of assignment isn't portable. */
14e3c2e4	34	#define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
4e6f9223 SC	35
	36	/* tdata for an archive. For an input archive, cache
	37	needs to be free()'d. For an output archive, symdefs do. */
	38
	39	struct artdata {
	40	file_ptr first_file_filepos;
	41	/* Speed up searching the armap */
	42	struct ar_cache *cache;
	43	bfd archive_head; / Only interesting in output routines */
	44	carsym symdefs; / the symdef entries */
	45	symindex symdef_count; /* how many there are */
	46	char extended_names; / clever intel extension */
	47	};
	48
14e3c2e4	49	#define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
4e6f9223 SC	50
	51	/* Goes in bfd's arelt_data slot */
	52	struct areltdata {
	53	char * arch_header; /* it's actually a string */
	54	unsigned int parsed_size; /* octets of filesize not including ar_hdr */
	55	char filename; / null-terminated */
	56	};
	57
	58	#define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
	59
14e3c2e4	60	char *zalloc PARAMS ((bfd_size_type size));
4e6f9223 SC	61
	62	/* These routines allocate and free things on the BFD's obstack. Note
	63	that realloc can never occur in place. */
	64
14e3c2e4 JK	65	PTR bfd_alloc PARAMS ((bfd *abfd, bfd_size_type size));
	66	PTR bfd_zalloc PARAMS ((bfd *abfd, bfd_size_type size));
	67	PTR bfd_realloc PARAMS ((bfd *abfd, PTR orig, bfd_size_type new));
	68	void bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, bfd_size_type size));
	69	PTR bfd_alloc_finish PARAMS ((bfd *abfd));
	70	PTR bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));
	71
	72	#define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
	73
	74
	75	bfd_size_type bfd_read PARAMS ((PTR ptr, bfd_size_type size,
	76	bfd_size_type nitems, bfd *abfd));
	77	bfd_size_type bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size,
	78	bfd_size_type nitems, bfd *abfd));
	79	int bfd_seek PARAMS ((bfd* CONST abfd, CONST file_ptr fp,
	80	CONST int direction));
	81	long bfd_tell PARAMS ((bfd *abfd));
	82
	83	bfd * _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
	84	bfd * look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
	85	boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
	86	struct areltdata * snarf_ar_hdr PARAMS ((bfd *abfd));
	87	bfd_target * bfd_generic_archive_p PARAMS ((bfd *abfd));
	88	boolean bfd_slurp_armap PARAMS ((bfd *abfd));
	89	#define bfd_slurp_bsd_armap bfd_slurp_armap
	90	#define bfd_slurp_coff_armap bfd_slurp_armap
	91	boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
	92	boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
	93	bfd * new_bfd PARAMS (());
4e6f9223 SC	94
4e6f9223 SC	95	#define DEFAULT_STRING_SPACE_SIZE 0x2000
14e3c2e4 JK	96	boolean bfd_add_to_string_table PARAMS ((char *table, char new_string,
	97	unsigned int *table_length,
	98	char **free_ptr));
	99	bfd_vma _do_getb64 PARAMS ((unsigned char *addr));
	100	bfd_vma _do_getl64 PARAMS ((unsigned char *addr));
	101	bfd_signed_vma _do_getb_signed_64 PARAMS ((unsigned char *addr));
	102	bfd_signed_vma _do_getl_signed_64 PARAMS ((unsigned char *addr));
	103	bfd_vma _do_getb32 PARAMS ((unsigned char *addr));
	104	bfd_vma _do_getl32 PARAMS ((unsigned char *addr));
	105	bfd_signed_vma _do_getb_signed_32 PARAMS ((unsigned char *addr));
	106	bfd_signed_vma _do_getl_signed_32 PARAMS ((unsigned char *addr));
	107	bfd_vma _do_getb16 PARAMS ((unsigned char *addr));
	108	bfd_vma _do_getl16 PARAMS ((unsigned char *addr));
	109	bfd_signed_vma _do_getb_signed_16 PARAMS ((unsigned char *addr));
	110	bfd_signed_vma _do_getl_signed_16 PARAMS ((unsigned char *addr));
	111	void _do_putb64 PARAMS ((bfd_vma data, unsigned char *addr));
	112	void _do_putl64 PARAMS ((bfd_vma data, unsigned char *addr));
	113	void _do_putb32 PARAMS ((bfd_vma data, unsigned char *addr));
	114	void _do_putl32 PARAMS ((bfd_vma data, unsigned char *addr));
	115	void _do_putb16 PARAMS ((bfd_vma data, unsigned char *addr));
	116	void _do_putl16 PARAMS ((bfd_vma data, unsigned char *addr));
	117
	118	boolean bfd_false PARAMS ((bfd *ignore));
	119	boolean bfd_true PARAMS ((bfd *ignore));
	120	PTR bfd_nullvoidptr PARAMS ((bfd *ignore));
	121	int bfd_0 PARAMS ((bfd *ignore));
	122	unsigned int bfd_0u PARAMS ((bfd *ignore));
	123	void bfd_void PARAMS ((bfd *ignore));
	124
	125	bfd * new_bfd_contained_in PARAMS ((bfd *));
	126	boolean _bfd_dummy_new_section_hook PARAMS ((bfd ignore, asection newsect));
	127	char * _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
	128	int _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
	129	boolean _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
4e6f9223	130	bfd *exec_bfd));
14e3c2e4	131	bfd_target * _bfd_dummy_target PARAMS ((bfd *abfd));
4e6f9223	132
14e3c2e4	133	void bfd_dont_truncate_arname PARAMS ((bfd abfd, CONST char filename,
4e6f9223	134	char *hdr));
14e3c2e4	135	void bfd_bsd_truncate_arname PARAMS ((bfd abfd, CONST char filename,
4e6f9223	136	char *hdr));
14e3c2e4	137	void bfd_gnu_truncate_arname PARAMS ((bfd abfd, CONST char filename,
4e6f9223 SC	138	char *hdr));
4e6f9223 SC	139
14e3c2e4	140	boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b	141	struct orl *map, unsigned int orl_count, int stridx));
4e6f9223	142
14e3c2e4	143	boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b	144	struct orl *map, unsigned int orl_count, int stridx));
4e6f9223	145
14e3c2e4	146	bfd * bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
4e6f9223 SC	147	bfd *last_file));
4e6f9223 SC	148
14e3c2e4	149	int bfd_generic_stat_arch_elt PARAMS ((bfd , struct stat ));
4e6f9223	150
14e3c2e4 JK	151	boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
	152	PTR location, file_ptr offset,
	153	bfd_size_type count));
01dd1b2b	154
14e3c2e4 JK	155	boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
	156	PTR location, file_ptr offset,
	157	bfd_size_type count));
4e6f9223 SC	158
	159	/* Macros to tell if bfds are read or write enabled.
	160
	161	Note that bfds open for read may be scribbled into if the fd passed
	162	to bfd_fdopenr is actually open both for read and write
	163	simultaneously. However an output bfd will never be open for
	164	read. Therefore sometimes you want to check bfd_read_p or
	165	!bfd_read_p, and only sometimes bfd_write_p.
	166	*/
	167
14e3c2e4 JK	168	#define bfd_read_p(abfd) ((abfd)->direction == read_direction \|\| (abfd)->direction == both_direction)
	169	#define bfd_write_p(abfd) ((abfd)->direction == write_direction \|\| (abfd)->direction == both_direction)
	170
	171	void bfd_assert PARAMS ((char*,int));
4e6f9223	172
4e6f9223 SC	173	#define BFD_ASSERT(x) \
	174	{ if (!(x)) bfd_assert(__FILE__,__LINE__); }
	175
	176	#define BFD_FAIL() \
	177	{ bfd_assert(__FILE__,__LINE__); }
	178
14e3c2e4	179	FILE * bfd_cache_lookup_worker PARAMS ((bfd *));
4e6f9223 SC	180
	181	extern bfd *bfd_last_cache;
	182
	183	/* Now Steve, what's the story here? */
	184	#ifdef lint
	185	#define itos(x) "l"
	186	#define stoi(x) 1
	187	#else
	188	#define itos(x) ((char*)(x))
	189	#define stoi(x) ((int)(x))
	190	#endif
	191
	192	/* Generic routine for close_and_cleanup is really just bfd_true. */
	193	#define bfd_generic_close_and_cleanup bfd_true
	194
14e3c2e4	195	/* And more follows */
4e6f9223	196