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

/* libbfd.h -- Declarations used by bfd library implementation.
   This include file is not for users of the library */

/* Copyright (C) 1990, 1991 Free Software Foundation, Inc.

This file is part of BFD, the Binary File Diddler.

BFD 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 1, or (at your option)
any later version.

BFD 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 BFD; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */

/* $Id$ */

/* 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 = (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) ((struct artdata *) ((bfd)->tdata))

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

/* FIXME -- a lot of my code allocates a large block and subdivides it.
   This can't always work, because of alignment restrictions.  We should change
   it before it becomes a problem -- Gumby */

PROTO (char *, zalloc, (bfd_size_type size));

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

PROTO(PTR, bfd_alloc, (bfd *abfd, bfd_size_type size));
PROTO(PTR, bfd_zalloc,(bfd *abfd, bfd_size_type size));
PROTO(PTR, bfd_realloc,(bfd *abfd, PTR orig, bfd_size_type new));
#define bfd_release(x,y) (void) obstack_free(&(x->memory),y)

PROTO (bfd_target *, bfd_find_target, (CONST char *target_name));
PROTO (bfd_size_type, bfd_read, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
PROTO (bfd_size_type, bfd_write, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));

PROTO (FILE *, bfd_cache_lookup, (bfd *));
PROTO (void, bfd_cache_close, (bfd *));
PROTO (int, bfd_seek,(bfd* abfd, file_ptr fp , int direction));
PROTO (long, bfd_tell, (bfd *abfd));
PROTO (bfd *, _bfd_create_empty_archive_element_shell, (bfd *obfd));
PROTO (bfd *, look_for_bfd_in_cache, (bfd *arch_bfd, file_ptr index));
PROTO (boolean, _bfd_generic_mkarchive, (bfd *abfd));
PROTO (struct areltdata *, snarf_ar_hdr, (bfd *abfd));
PROTO (bfd_target *, bfd_generic_archive_p, (bfd *abfd));
PROTO (boolean, bfd_slurp_bsd_armap, (bfd *abfd));
PROTO (boolean, bfd_slurp_coff_armap, (bfd *abfd));
PROTO (boolean, _bfd_slurp_extended_name_table, (bfd *abfd));
PROTO (boolean, _bfd_write_archive_contents, (bfd *abfd));
PROTO (bfd *, new_bfd, ());

#define DEFAULT_STRING_SPACE_SIZE 0x2000
PROTO (boolean, bfd_add_to_string_table, (char **table, char *new_string,
					  unsigned int *table_length,
					  char **free_ptr));
     
PROTO (long, _do_getblong, (unsigned char *addr));
PROTO (long, _do_getllong, (unsigned char *addr));
PROTO (short, _do_getbshort, (unsigned char *addr));
PROTO (short, _do_getlshort, (unsigned char *addr));
PROTO (void, _do_putblong, (unsigned long data, unsigned char *addr));
PROTO (void, _do_putllong, (unsigned long data, unsigned char *addr));
PROTO (void, _do_putbshort, (int data, unsigned char *addr));
PROTO (void, _do_putlshort, (int data, unsigned char *addr));

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

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

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

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

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

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

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

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

PROTO (void, bfd_assert,(char*,int));
#define BFD_ASSERT(x) \
{ if (!(x)) bfd_assert(__FILE__,__LINE__); }

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

PROTO (FILE *, bfd_cache_lookup_worker, (bfd *));

extern bfd *bfd_last_cache;
#define bfd_cache_lookup(x) \
     (x==bfd_last_cache?(FILE*)(bfd_last_cache->iostream):bfd_cache_lookup_worker(x))
    
/* 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
Commit	Line	Data
fc723380 JG	1	/* libbfd.h -- Declarations used by bfd library implementation.
	2	This include file is not for users of the library */
	3
4a81b561 DHW	4	/* Copyright (C) 1990, 1991 Free Software Foundation, Inc.
	5
	6	This file is part of BFD, the Binary File Diddler.
	7
	8	BFD 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 1, or (at your option)
	11	any later version.
	12
	13	BFD 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 BFD; see the file COPYING. If not, write to
	20	the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
	21
	22	/* $Id$ */
	23
4a81b561 DHW	24	/* If you want to read and write large blocks, you might want to do it
	25	in quanta of this amount */
	26	#define DEFAULT_BUFFERSIZE 8192
	27
fc723380 JG	28	/* Set a tdata field. Can't use the other macros for this, since they
	29	do casts, and casting to the left of assignment isn't portable. */
	30	#define set_tdata(bfd, v) ((bfd)->tdata = (PTR) (v))
	31
	32	/* tdata for an archive. For an input archive, cache
	33	needs to be free()'d. For an output archive, symdefs do. */
4a81b561 DHW	34
	35	struct artdata {
	36	file_ptr first_file_filepos;
	37	/* Speed up searching the armap */
	38	struct ar_cache *cache;
	39	bfd archive_head; / Only interesting in output routines */
	40	carsym symdefs; / the symdef entries */
	41	symindex symdef_count; /* how many there are */
	42	char extended_names; / clever intel extension */
	43	};
	44
	45	#define bfd_ardata(bfd) ((struct artdata *) ((bfd)->tdata))
4a81b561 DHW	46
	47	/* Goes in bfd's arelt_data slot */
	48	struct areltdata {
	49	char * arch_header; /* it's actually a string */
	50	unsigned int parsed_size; /* octets of filesize not including ar_hdr */
	51	char filename; / null-terminated */
	52	};
	53
	54	#define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
	55
	56	/* FIXME -- a lot of my code allocates a large block and subdivides it.
	57	This can't always work, because of alignment restrictions. We should change
	58	it before it becomes a problem -- Gumby */
	59
fc723380	60	PROTO (char *, zalloc, (bfd_size_type size));
9846338e	61
fc723380 JG	62	/* These routines allocate and free things on the BFD's obstack. Note
fc723380 JG	63	that realloc can never occur in place. */
4a81b561	64
fc723380 JG	65	PROTO(PTR, bfd_alloc, (bfd *abfd, bfd_size_type size));
	66	PROTO(PTR, bfd_zalloc,(bfd *abfd, bfd_size_type size));
	67	PROTO(PTR, bfd_realloc,(bfd *abfd, PTR orig, bfd_size_type new));
	68	#define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
4a81b561	69
fc723380 JG	70	PROTO (bfd_target , bfd_find_target, (CONST char target_name));
	71	PROTO (bfd_size_type, bfd_read, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
	72	PROTO (bfd_size_type, bfd_write, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
4a81b561 DHW	73
	74	PROTO (FILE , bfd_cache_lookup, (bfd ));
	75	PROTO (void, bfd_cache_close, (bfd *));
9846338e	76	PROTO (int, bfd_seek,(bfd* abfd, file_ptr fp , int direction));
4a81b561 DHW	77	PROTO (long, bfd_tell, (bfd *abfd));
	78	PROTO (bfd , _bfd_create_empty_archive_element_shell, (bfd obfd));
	79	PROTO (bfd , look_for_bfd_in_cache, (bfd arch_bfd, file_ptr index));
	80	PROTO (boolean, _bfd_generic_mkarchive, (bfd *abfd));
	81	PROTO (struct areltdata , snarf_ar_hdr, (bfd abfd));
	82	PROTO (bfd_target , bfd_generic_archive_p, (bfd abfd));
	83	PROTO (boolean, bfd_slurp_bsd_armap, (bfd *abfd));
	84	PROTO (boolean, bfd_slurp_coff_armap, (bfd *abfd));
	85	PROTO (boolean, _bfd_slurp_extended_name_table, (bfd *abfd));
	86	PROTO (boolean, _bfd_write_archive_contents, (bfd *abfd));
	87	PROTO (bfd *, new_bfd, ());
	88
	89	#define DEFAULT_STRING_SPACE_SIZE 0x2000
	90	PROTO (boolean, bfd_add_to_string_table, (char *table, char new_string,
	91	unsigned int *table_length,
	92	char **free_ptr));
	93
	94	PROTO (long, _do_getblong, (unsigned char *addr));
	95	PROTO (long, _do_getllong, (unsigned char *addr));
	96	PROTO (short, _do_getbshort, (unsigned char *addr));
	97	PROTO (short, _do_getlshort, (unsigned char *addr));
	98	PROTO (void, _do_putblong, (unsigned long data, unsigned char *addr));
	99	PROTO (void, _do_putllong, (unsigned long data, unsigned char *addr));
	100	PROTO (void, _do_putbshort, (int data, unsigned char *addr));
	101	PROTO (void, _do_putlshort, (int data, unsigned char *addr));
	102
	103	PROTO (boolean, bfd_false, (bfd *ignore));
	104	PROTO (boolean, bfd_true, (bfd *ignore));
	105	PROTO (void , bfd_nullvoidptr, (bfd ignore));
	106	PROTO (int, bfd_0, (bfd *ignore));
	107	PROTO (unsigned int, bfd_0u, (bfd *ignore));
	108	PROTO (void, bfd_void, (bfd *ignore));
	109
4a81b561 DHW	110	PROTO (bfd ,new_bfd_contained_in,(bfd ));
	111	PROTO (boolean, _bfd_dummy_new_section_hook, (bfd ignore, asection newsect));
	112	PROTO (char , _bfd_dummy_core_file_failing_command, (bfd abfd));
	113	PROTO (int, _bfd_dummy_core_file_failing_signal, (bfd *abfd));
	114	PROTO (boolean, _bfd_dummy_core_file_matches_executable_p, (bfd *core_bfd,
	115	bfd *exec_bfd));
	116	PROTO (bfd_target , _bfd_dummy_target, (bfd abfd));
	117
	118	PROTO (void, bfd_dont_truncate_arname, (bfd abfd, char filename, char *hdr));
	119	PROTO (void, bfd_bsd_truncate_arname, (bfd abfd, char filename, char *hdr));
	120	PROTO (void, bfd_gnu_truncate_arname, (bfd abfd, char filename, char *hdr));
	121
	122	PROTO (boolean, bsd_write_armap, (bfd *arch, unsigned int elength,
	123	struct orl *map, int orl_count, int stridx));
	124
	125	PROTO (boolean, coff_write_armap, (bfd *arch, unsigned int elength,
	126	struct orl *map, int orl_count, int stridx));
	127
	128	PROTO ( bfd ,bfd_generic_openr_next_archived_file, (bfd archive, bfd *last_file));
	129
	130	PROTO(int, bfd_generic_stat_arch_elt, (bfd , struct stat ));
fc723380	131
4a81b561 DHW	132	/* Macros to tell if bfds are read or write enabled.
	133
	134	Note that bfds open for read may be scribbled into if the fd passed
	135	to bfd_fdopenr is actually open both for read and write
	136	simultaneously. However an output bfd will never be open for
	137	read. Therefore sometimes you want to check bfd_read_p or
	138	!bfd_read_p, and only sometimes bfd_write_p.
	139	*/
	140
	141	#define bfd_read_p(abfd) ((abfd)->direction == read_direction \|\| (abfd)->direction == both_direction)
	142	#define bfd_write_p(abfd) ((abfd)->direction == write_direction \|\| (abfd)->direction == both_direction)
	143
	144	PROTO (void, bfd_assert,(char*,int));
	145	#define BFD_ASSERT(x) \
	146	{ if (!(x)) bfd_assert(__FILE__,__LINE__); }
	147
	148	#define BFD_FAIL() \
	149	{ bfd_assert(__FILE__,__LINE__); }
	150
	151	PROTO (FILE , bfd_cache_lookup_worker, (bfd ));
	152
	153	extern bfd *bfd_last_cache;
	154	#define bfd_cache_lookup(x) \
	155	(x==bfd_last_cache?(FILE*)(bfd_last_cache->iostream):bfd_cache_lookup_worker(x))
	156
	157	/* Now Steve, what's the story here? */
	158	#ifdef lint
	159	#define itos(x) "l"
	160	#define stoi(x) 1
	161	#else
	162	#define itos(x) ((char*)(x))
	163	#define stoi(x) ((int)(x))
	164	#endif