[binutils.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 */
  time_t armap_timestamp;	/* Timestamp value written into armap.
				   This is used for BSD archives to check
				   that the timestamp is recent enough
				   for the BSD linker to not complain,
				   just before we finish writing an
				   archive.  */
  file_ptr armap_datepos;	/* Position within archive to seek to
				   rewrite the date field.  */
};

#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, size_t size));
PTR	bfd_zalloc PARAMS ((bfd *abfd, size_t size));
PTR	bfd_realloc PARAMS ((bfd *abfd, PTR orig, size_t new));
void	bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, size_t 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));
boolean bfd_slurp_bsd_armap_f2 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));

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 */
a6f5fcd8 SC	47	time_t armap_timestamp; /* Timestamp value written into armap.
	48	This is used for BSD archives to check
	49	that the timestamp is recent enough
	50	for the BSD linker to not complain,
	51	just before we finish writing an
	52	archive. */
	53	file_ptr armap_datepos; /* Position within archive to seek to
	54	rewrite the date field. */
4e6f9223 SC	55	};
4e6f9223 SC	56
14e3c2e4	57	#define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
4e6f9223 SC	58
	59	/* Goes in bfd's arelt_data slot */
	60	struct areltdata {
	61	char * arch_header; /* it's actually a string */
	62	unsigned int parsed_size; /* octets of filesize not including ar_hdr */
	63	char filename; / null-terminated */
	64	};
	65
	66	#define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
	67
14e3c2e4	68	char *zalloc PARAMS ((bfd_size_type size));
4e6f9223 SC	69
	70	/* These routines allocate and free things on the BFD's obstack. Note
	71	that realloc can never occur in place. */
	72
6affd66a KR	73	PTR bfd_alloc PARAMS ((bfd *abfd, size_t size));
	74	PTR bfd_zalloc PARAMS ((bfd *abfd, size_t size));
	75	PTR bfd_realloc PARAMS ((bfd *abfd, PTR orig, size_t new));
	76	void bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, size_t size));
14e3c2e4 JK	77	PTR bfd_alloc_finish PARAMS ((bfd *abfd));
	78	PTR bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));
	79
	80	#define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
	81
	82
	83	bfd_size_type bfd_read PARAMS ((PTR ptr, bfd_size_type size,
	84	bfd_size_type nitems, bfd *abfd));
	85	bfd_size_type bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size,
	86	bfd_size_type nitems, bfd *abfd));
	87	int bfd_seek PARAMS ((bfd* CONST abfd, CONST file_ptr fp,
	88	CONST int direction));
	89	long bfd_tell PARAMS ((bfd *abfd));
	90
	91	bfd * _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
	92	bfd * look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
	93	boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
	94	struct areltdata * snarf_ar_hdr PARAMS ((bfd *abfd));
	95	bfd_target * bfd_generic_archive_p PARAMS ((bfd *abfd));
	96	boolean bfd_slurp_armap PARAMS ((bfd *abfd));
6affd66a	97	boolean bfd_slurp_bsd_armap_f2 PARAMS ((bfd *abfd));
14e3c2e4 JK	98	#define bfd_slurp_bsd_armap bfd_slurp_armap
	99	#define bfd_slurp_coff_armap bfd_slurp_armap
	100	boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
	101	boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
	102	bfd * new_bfd PARAMS (());
4e6f9223 SC	103
4e6f9223 SC	104	#define DEFAULT_STRING_SPACE_SIZE 0x2000
14e3c2e4 JK	105	boolean bfd_add_to_string_table PARAMS ((char *table, char new_string,
	106	unsigned int *table_length,
	107	char **free_ptr));
6affd66a	108
14e3c2e4 JK	109	boolean bfd_false PARAMS ((bfd *ignore));
	110	boolean bfd_true PARAMS ((bfd *ignore));
	111	PTR bfd_nullvoidptr PARAMS ((bfd *ignore));
	112	int bfd_0 PARAMS ((bfd *ignore));
	113	unsigned int bfd_0u PARAMS ((bfd *ignore));
	114	void bfd_void PARAMS ((bfd *ignore));
	115
	116	bfd * new_bfd_contained_in PARAMS ((bfd *));
	117	boolean _bfd_dummy_new_section_hook PARAMS ((bfd ignore, asection newsect));
	118	char * _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
	119	int _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
	120	boolean _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
4e6f9223	121	bfd *exec_bfd));
14e3c2e4	122	bfd_target * _bfd_dummy_target PARAMS ((bfd *abfd));
4e6f9223	123
14e3c2e4	124	void bfd_dont_truncate_arname PARAMS ((bfd abfd, CONST char filename,
4e6f9223	125	char *hdr));
14e3c2e4	126	void bfd_bsd_truncate_arname PARAMS ((bfd abfd, CONST char filename,
4e6f9223	127	char *hdr));
14e3c2e4	128	void bfd_gnu_truncate_arname PARAMS ((bfd abfd, CONST char filename,
4e6f9223 SC	129	char *hdr));
4e6f9223 SC	130
14e3c2e4	131	boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b	132	struct orl *map, unsigned int orl_count, int stridx));
4e6f9223	133
14e3c2e4	134	boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b	135	struct orl *map, unsigned int orl_count, int stridx));
4e6f9223	136
14e3c2e4	137	bfd * bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
4e6f9223 SC	138	bfd *last_file));
4e6f9223 SC	139
14e3c2e4	140	int bfd_generic_stat_arch_elt PARAMS ((bfd , struct stat ));
4e6f9223	141
14e3c2e4 JK	142	boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
	143	PTR location, file_ptr offset,
	144	bfd_size_type count));
01dd1b2b	145
14e3c2e4 JK	146	boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
	147	PTR location, file_ptr offset,
	148	bfd_size_type count));
4e6f9223 SC	149
	150	/* Macros to tell if bfds are read or write enabled.
	151
	152	Note that bfds open for read may be scribbled into if the fd passed
	153	to bfd_fdopenr is actually open both for read and write
	154	simultaneously. However an output bfd will never be open for
	155	read. Therefore sometimes you want to check bfd_read_p or
	156	!bfd_read_p, and only sometimes bfd_write_p.
	157	*/
	158
14e3c2e4 JK	159	#define bfd_read_p(abfd) ((abfd)->direction == read_direction \|\| (abfd)->direction == both_direction)
	160	#define bfd_write_p(abfd) ((abfd)->direction == write_direction \|\| (abfd)->direction == both_direction)
	161
	162	void bfd_assert PARAMS ((char*,int));
4e6f9223	163
4e6f9223 SC	164	#define BFD_ASSERT(x) \
	165	{ if (!(x)) bfd_assert(__FILE__,__LINE__); }
	166
	167	#define BFD_FAIL() \
	168	{ bfd_assert(__FILE__,__LINE__); }
	169
14e3c2e4	170	FILE * bfd_cache_lookup_worker PARAMS ((bfd *));
4e6f9223 SC	171
	172	extern bfd *bfd_last_cache;
	173
	174	/* Now Steve, what's the story here? */
	175	#ifdef lint
	176	#define itos(x) "l"
	177	#define stoi(x) 1
	178	#else
	179	#define itos(x) ((char*)(x))
	180	#define stoi(x) ((int)(x))
	181	#endif
	182
	183	/* Generic routine for close_and_cleanup is really just bfd_true. */
	184	#define bfd_generic_close_and_cleanup bfd_true
	185
14e3c2e4	186	/* And more follows */
4e6f9223	187