[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 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 */
  /* when more compilers are standard C, this can be a time_t */
  long  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.  */
  PTR tdata;			/* Backend specific information.  */
};

#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 *bfd_zmalloc 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));

int		bfd_flush PARAMS ((bfd *abfd));
int		bfd_stat  PARAMS ((bfd *abfd, struct stat *));

bfd *	_bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
bfd *	_bfd_look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
boolean _bfd_add_bfd_to_archive_cache PARAMS ((bfd *, file_ptr, bfd *));
boolean	_bfd_generic_mkarchive PARAMS ((bfd *abfd));
struct areltdata *	_bfd_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 *_bfd_get_elt_at_filepos PARAMS ((bfd *archive, file_ptr filepos));
bfd * _bfd_new_bfd PARAMS ((void));

#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));
long	bfd_0l PARAMS ((bfd *ignore));
long	_bfd_n1 PARAMS ((bfd *ignore));
void	bfd_void PARAMS ((bfd *ignore));

bfd *	_bfd_new_bfd_contained_in PARAMS ((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 *));

\f
/* Generic routines to use for BFD_JUMP_TABLE_GENERIC.  Use
   BFD_JUMP_TABLE_GENERIC (_bfd_generic).  */

#define _bfd_generic_close_and_cleanup bfd_true
#define _bfd_generic_bfd_free_cached_info bfd_true
#define _bfd_generic_new_section_hook \
  ((boolean (*) PARAMS ((bfd *, asection *))) bfd_true)
extern boolean _bfd_generic_get_section_contents
  PARAMS ((bfd *, asection *, PTR location, file_ptr offset,
	   bfd_size_type count));

/* Generic routines to use for BFD_JUMP_TABLE_COPY.  Use
   BFD_JUMP_TABLE_COPY (_bfd_generic).  */

#define _bfd_generic_bfd_copy_private_bfd_data \
  ((boolean (*) PARAMS ((bfd *, bfd *))) bfd_true)
#define _bfd_generic_bfd_copy_private_section_data \
  ((boolean (*) PARAMS ((bfd *, asection *, bfd *, asection *))) bfd_true)

/* Routines to use for BFD_JUMP_TABLE_CORE when there is no core file
   support.  Use BFD_JUMP_TABLE_CORE (_bfd_nocore).  */

extern char *_bfd_nocore_core_file_failing_command PARAMS ((bfd *));
extern int _bfd_nocore_core_file_failing_signal PARAMS ((bfd *));
extern boolean _bfd_nocore_core_file_matches_executable_p
  PARAMS ((bfd *, bfd *));

/* Routines to use for BFD_JUMP_TABLE_ARCHIVE when there is no archive
   file support.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive).  */

#define _bfd_noarchive_slurp_armap bfd_false
#define _bfd_noarchive_slurp_extended_name_table bfd_false
#define _bfd_noarchive_truncate_arname \
  ((void (*) PARAMS ((bfd *, const char *, char *))) bfd_void)
#define _bfd_noarchive_write_armap \
  ((boolean (*) \
    PARAMS ((bfd *, unsigned int, struct orl *, unsigned int, int))) \
   bfd_false)
#define _bfd_noarchive_openr_next_archived_file \
  ((bfd *(*) PARAMS ((bfd *, bfd *))) bfd_nullvoidptr)
#define _bfd_noarchive_generic_stat_arch_elt bfd_generic_stat_arch_elt

/* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD style
   archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd).  */

#define _bfd_archive_bsd_slurp_armap bfd_slurp_bsd_armap
#define _bfd_archive_bsd_slurp_extended_name_table \
  _bfd_slurp_extended_name_table
#define _bfd_archive_bsd_truncate_arname bfd_bsd_truncate_arname
#define _bfd_archive_bsd_write_armap bsd_write_armap
#define _bfd_archive_bsd_openr_next_archived_file \
  bfd_generic_openr_next_archived_file
#define _bfd_archive_bsd_generic_stat_arch_elt \
  bfd_generic_stat_arch_elt

/* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get COFF style
   archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff).  */

#define _bfd_archive_coff_slurp_armap bfd_slurp_coff_armap
#define _bfd_archive_coff_slurp_extended_name_table \
  _bfd_slurp_extended_name_table
#define _bfd_archive_coff_truncate_arname bfd_dont_truncate_arname
#define _bfd_archive_coff_write_armap coff_write_armap
#define _bfd_archive_coff_openr_next_archived_file \
  bfd_generic_openr_next_archived_file
#define _bfd_archive_coff_generic_stat_arch_elt \
  bfd_generic_stat_arch_elt

/* Routines to use for BFD_JUMP_TABLE_SYMBOLS where there is no symbol
   support.  Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols).  */

#define _bfd_nosymbols_get_symtab_upper_bound _bfd_n1
#define _bfd_nosymbols_get_symtab \
  ((long (*) PARAMS ((bfd *, asymbol **))) _bfd_n1)
#define _bfd_nosymbols_make_empty_symbol \
  ((asymbol *(*) PARAMS ((bfd *))) bfd_nullvoidptr)
#define _bfd_nosymbols_print_symbol \
  ((void (*) PARAMS ((bfd *, PTR, asymbol *, bfd_print_symbol_type))) bfd_void)
#define _bfd_nosymbols_get_symbol_info \
  ((void (*) PARAMS ((bfd *, asymbol *, symbol_info *))) bfd_void)
#define _bfd_nosymbols_bfd_is_local_label \
  ((boolean (*) PARAMS ((bfd *, asymbol *))) bfd_false)
#define _bfd_nosymbols_get_lineno \
  ((alent *(*) PARAMS ((bfd *, asymbol *))) bfd_nullvoidptr)
#define _bfd_nosymbols_find_nearest_line \
  ((boolean (*) \
    PARAMS ((bfd *, asection *, asymbol **, bfd_vma, const char **, \
	     const char **, unsigned int *))) \
   bfd_false)
#define _bfd_nosymbols_bfd_make_debug_symbol \
  ((asymbol *(*) PARAMS ((bfd *, PTR, unsigned long))) bfd_nullvoidptr)

/* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
   support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */

#define _bfd_norelocs_get_reloc_upper_bound \
  ((long (*) PARAMS ((bfd *, asection *))) _bfd_n1)
#define _bfd_norelocs_canonicalize_reloc \
  ((long (*) PARAMS ((bfd *, asection *, arelent **, asymbol **))) _bfd_n1)
#define _bfd_norelocs_bfd_reloc_type_lookup \
  ((const reloc_howto_type *(*) PARAMS ((bfd *, bfd_reloc_code_real_type))) \
   bfd_nullvoidptr)

/* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
   be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */

#define _bfd_nowrite_set_arch_mach \
  ((boolean (*) PARAMS ((bfd *, enum bfd_architecture, unsigned long))) \
   bfd_false)
#define _bfd_nowrite_set_section_contents \
  ((boolean (*) PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type))) \
   bfd_false)

/* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
   BFD_JUMP_TABLE_WRITE (_bfd_generic).  */

#define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
extern boolean _bfd_generic_set_section_contents
  PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type));

/* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
   support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */

#define _bfd_nolink_sizeof_headers ((int (*) PARAMS ((bfd *, boolean))) bfd_0)
#define _bfd_nolink_bfd_get_relocated_section_contents \
  ((bfd_byte *(*) \
    PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *, \
	     bfd_byte *, boolean, asymbol **))) \
   bfd_nullvoidptr)
#define _bfd_nolink_bfd_relax_section \
  ((boolean (*) \
    PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *))) \
   bfd_false)
#define _bfd_nolink_bfd_link_hash_table_create \
  ((struct bfd_link_hash_table *(*) PARAMS ((bfd *))) bfd_nullvoidptr)
#define _bfd_nolink_bfd_link_add_symbols \
  ((boolean (*) PARAMS ((bfd *, struct bfd_link_info *))) bfd_false)
#define _bfd_nolink_bfd_final_link \
  ((boolean (*) PARAMS ((bfd *, struct bfd_link_info *))) bfd_false)
\f
/* Generic routine to determine of the given symbol is a local
   label.  */
extern boolean bfd_generic_is_local_label PARAMS ((bfd *, asymbol *));

/* A routine to create entries for a bfd_link_hash_table.  */
extern struct bfd_hash_entry *_bfd_link_hash_newfunc
  PARAMS ((struct bfd_hash_entry *entry,
	   struct bfd_hash_table *table,
	   const char *string));

/* Initialize a bfd_link_hash_table.  */
extern boolean _bfd_link_hash_table_init
  PARAMS ((struct bfd_link_hash_table *, bfd *,
	   struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
				       struct bfd_hash_table *,
				       const char *)));

/* Generic link hash table creation routine.  */
extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
  PARAMS ((bfd *));

/* Generic add symbol routine.  */
extern boolean _bfd_generic_link_add_symbols
  PARAMS ((bfd *, struct bfd_link_info *));

/* Generic add symbol routine.  This version is used by targets for
   which the linker must collect constructors and destructors by name,
   as the collect2 program does.  */
extern boolean _bfd_generic_link_add_symbols_collect
  PARAMS ((bfd *, struct bfd_link_info *));

/* Generic archive add symbol routine.  */
extern boolean _bfd_generic_link_add_archive_symbols
  PARAMS ((bfd *, struct bfd_link_info *,
	   boolean (*checkfn) (bfd *, struct bfd_link_info *, boolean *)));

/* Forward declaration to avoid prototype errors.  */
typedef struct bfd_link_hash_entry _bfd_link_hash_entry;

/* Generic routine to add a single symbol.  */
extern boolean _bfd_generic_link_add_one_symbol
  PARAMS ((struct bfd_link_info *, bfd *, const char *name, flagword,
	   asection *, bfd_vma, const char *, boolean copy,
	   boolean constructor, struct bfd_link_hash_entry **));

/* Generic link routine.  */
extern boolean _bfd_generic_final_link
  PARAMS ((bfd *, struct bfd_link_info *));

/* Generic reloc_link_order processing routine.  */
extern boolean _bfd_generic_reloc_link_order
  PARAMS ((bfd *, struct bfd_link_info *, asection *,
	   struct bfd_link_order *));

/* Default link order processing routine.  */
extern boolean _bfd_default_link_order
  PARAMS ((bfd *, struct bfd_link_info *, asection *,
	   struct bfd_link_order *));

/* Count the number of reloc entries in a link order list.  */
extern unsigned int _bfd_count_link_order_relocs
  PARAMS ((struct bfd_link_order *));

/* Final link relocation routine.  */
extern bfd_reloc_status_type _bfd_final_link_relocate
  PARAMS ((const reloc_howto_type *, bfd *, asection *, bfd_byte *,
	   bfd_vma address, bfd_vma value, bfd_vma addend));

/* Relocate a particular location by a howto and a value.  */
extern bfd_reloc_status_type _bfd_relocate_contents
  PARAMS ((const reloc_howto_type *, bfd *, bfd_vma, bfd_byte *));
\f
/* 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

/* List of supported target vectors, and the default vector (if
   bfd_default_vector[0] is NULL, there is no default).  */
extern bfd_target *bfd_target_vector[];
extern bfd_target *bfd_default_vector[];

/* And more follows */

void 
bfd_check_init PARAMS ((void));

void 
bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd,  int i));

unsigned int 
bfd_log2 PARAMS ((bfd_vma x));

#define BFD_CACHE_MAX_OPEN 10
extern bfd *bfd_last_cache;

#define bfd_cache_lookup(x) \
    ((x)==bfd_last_cache? \
      (FILE*)(bfd_last_cache->iostream): \
       bfd_cache_lookup_worker(x))
boolean 
bfd_cache_close  PARAMS ((bfd *abfd));

FILE* 
bfd_open_file PARAMS ((bfd *abfd));

FILE *
bfd_cache_lookup_worker PARAMS ((bfd *abfd));

boolean 
bfd_constructor_entry PARAMS ((bfd *abfd, 
    asymbol **symbol_ptr_ptr,
    CONST char*type));

const struct reloc_howto_struct *
bfd_default_reloc_type_lookup
 PARAMS ((bfd *abfd, bfd_reloc_code_real_type  code));

boolean 
bfd_generic_relax_section
 PARAMS ((bfd *abfd,
    asection *section,
    struct bfd_link_info *,
    boolean *));

bfd_byte *

bfd_generic_get_relocated_section_contents  PARAMS ((bfd *abfd,
    struct bfd_link_info *link_info,
    struct bfd_link_order *link_order,
    bfd_byte *data,
    boolean relocateable,
    asymbol **symbols));

extern bfd_arch_info_type bfd_default_arch_struct;
boolean 
bfd_default_set_arch_mach PARAMS ((bfd *abfd,
    enum bfd_architecture arch,
    unsigned long mach));

void 
bfd_arch_init PARAMS ((void));

void 
bfd_arch_linkin PARAMS ((bfd_arch_info_type *ptr));

CONST bfd_arch_info_type *
bfd_default_compatible
 PARAMS ((CONST bfd_arch_info_type *a,
    CONST bfd_arch_info_type *b));

boolean 
bfd_default_scan PARAMS ((CONST struct bfd_arch_info *info, CONST char *string));

struct elf_internal_shdr *
bfd_elf_find_section  PARAMS ((bfd *abfd, char *name));
Commit	Line	Data
c618de01 SC	1	/* libbfd.h -- Declarations used by bfd library implementation.
c618de01 SC	2	(This include file is not for users of the library.)
14e3c2e4	3	Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
c618de01	4	Written by Cygnus Support.
fc723380	5
c618de01	6	This file is part of BFD, the Binary File Descriptor library.
4a81b561	7
c618de01	8	This program is free software; you can redistribute it and/or modify
4a81b561	9	it under the terms of the GNU General Public License as published by
c618de01 SC	10	the Free Software Foundation; either version 2 of the License, or
c618de01 SC	11	(at your option) any later version.
4a81b561	12
c618de01	13	This program is distributed in the hope that it will be useful,
4a81b561 DHW	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
c618de01 SC	19	along with this program; if not, write to the Free Software
c618de01 SC	20	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
4a81b561	21
01dd1b2b SC	22	/* Align an address upward to a boundary, expressed as a number of bytes.
01dd1b2b SC	23	E.g. align to an 8-byte boundary with argument of 8. */
de0da6ce	24	#define BFD_ALIGN(this, boundary) \
01dd1b2b SC	25	((( (this) + ((boundary) -1)) & (~((boundary)-1))))
01dd1b2b SC	26
4a81b561 DHW	27	/* If you want to read and write large blocks, you might want to do it
	28	in quanta of this amount */
	29	#define DEFAULT_BUFFERSIZE 8192
	30
fc723380 JG	31	/* Set a tdata field. Can't use the other macros for this, since they
fc723380 JG	32	do casts, and casting to the left of assignment isn't portable. */
d5cd3c0e	33	#define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
fc723380 JG	34
	35	/* tdata for an archive. For an input archive, cache
	36	needs to be free()'d. For an output archive, symdefs do. */
4a81b561 DHW	37
	38	struct artdata {
	39	file_ptr first_file_filepos;
	40	/* Speed up searching the armap */
	41	struct ar_cache *cache;
	42	bfd archive_head; / Only interesting in output routines */
	43	carsym symdefs; / the symdef entries */
	44	symindex symdef_count; /* how many there are */
	45	char extended_names; / clever intel extension */
c188b0be DM	46	/* when more compilers are standard C, this can be a time_t */
c188b0be DM	47	long armap_timestamp; /* Timestamp value written into armap.
b5b4294e JG	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. */
b59f0276	55	PTR tdata; /* Backend specific information. */
4a81b561 DHW	56	};
4a81b561 DHW	57
e98e6ec1	58	#define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
4a81b561 DHW	59
	60	/* Goes in bfd's arelt_data slot */
	61	struct areltdata {
	62	char * arch_header; /* it's actually a string */
	63	unsigned int parsed_size; /* octets of filesize not including ar_hdr */
	64	char filename; / null-terminated */
	65	};
	66
	67	#define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
	68
f4bd7a8f	69	char *bfd_zmalloc PARAMS ((bfd_size_type size));
9846338e	70
fc723380 JG	71	/* These routines allocate and free things on the BFD's obstack. Note
fc723380 JG	72	that realloc can never occur in place. */
4a81b561	73
6affd66a KR	74	PTR bfd_alloc PARAMS ((bfd *abfd, size_t size));
	75	PTR bfd_zalloc PARAMS ((bfd *abfd, size_t size));
	76	PTR bfd_realloc PARAMS ((bfd *abfd, PTR orig, size_t new));
	77	void bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, size_t size));
287c221d PB	78	PTR bfd_alloc_finish PARAMS ((bfd *abfd));
	79	PTR bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));
	80
	81	#define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
	82
	83
	84	bfd_size_type bfd_read PARAMS ((PTR ptr, bfd_size_type size,
	85	bfd_size_type nitems, bfd *abfd));
	86	bfd_size_type bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size,
	87	bfd_size_type nitems, bfd *abfd));
	88	int bfd_seek PARAMS ((bfd* CONST abfd, CONST file_ptr fp,
	89	CONST int direction));
	90	long bfd_tell PARAMS ((bfd *abfd));
	91
b5b4294e JG	92	int bfd_flush PARAMS ((bfd *abfd));
	93	int bfd_stat PARAMS ((bfd abfd, struct stat ));
	94
287c221d	95	bfd * _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
f4bd7a8f	96	bfd * _bfd_look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
b59f0276	97	boolean _bfd_add_bfd_to_archive_cache PARAMS ((bfd , file_ptr, bfd ));
287c221d	98	boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
b59f0276	99	struct areltdata * _bfd_snarf_ar_hdr PARAMS ((bfd *abfd));
287c221d PB	100	bfd_target * bfd_generic_archive_p PARAMS ((bfd *abfd));
287c221d PB	101	boolean bfd_slurp_armap PARAMS ((bfd *abfd));
898728d4	102	boolean bfd_slurp_bsd_armap_f2 PARAMS ((bfd *abfd));
287c221d PB	103	#define bfd_slurp_bsd_armap bfd_slurp_armap
	104	#define bfd_slurp_coff_armap bfd_slurp_armap
	105	boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
	106	boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
f4bd7a8f DM	107	bfd _bfd_get_elt_at_filepos PARAMS ((bfd archive, file_ptr filepos));
f4bd7a8f DM	108	bfd * _bfd_new_bfd PARAMS ((void));
4a81b561 DHW	109
4a81b561 DHW	110	#define DEFAULT_STRING_SPACE_SIZE 0x2000
287c221d PB	111	boolean bfd_add_to_string_table PARAMS ((char *table, char new_string,
	112	unsigned int *table_length,
	113	char **free_ptr));
898728d4	114
287c221d PB	115	boolean bfd_false PARAMS ((bfd *ignore));
	116	boolean bfd_true PARAMS ((bfd *ignore));
	117	PTR bfd_nullvoidptr PARAMS ((bfd *ignore));
	118	int bfd_0 PARAMS ((bfd *ignore));
	119	unsigned int bfd_0u PARAMS ((bfd *ignore));
326e32d7	120	long bfd_0l PARAMS ((bfd *ignore));
6812b607	121	long _bfd_n1 PARAMS ((bfd *ignore));
287c221d PB	122	void bfd_void PARAMS ((bfd *ignore));
287c221d PB	123
f4bd7a8f	124	bfd * _bfd_new_bfd_contained_in PARAMS ((bfd *));
287c221d	125	bfd_target * _bfd_dummy_target PARAMS ((bfd *abfd));
4a81b561	126
287c221d	127	void bfd_dont_truncate_arname PARAMS ((bfd abfd, CONST char filename,
69ebee86	128	char *hdr));
287c221d	129	void bfd_bsd_truncate_arname PARAMS ((bfd abfd, CONST char filename,
69ebee86	130	char *hdr));
287c221d	131	void bfd_gnu_truncate_arname PARAMS ((bfd abfd, CONST char filename,
69ebee86	132	char *hdr));
4a81b561	133
287c221d	134	boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b	135	struct orl *map, unsigned int orl_count, int stridx));
4a81b561	136
287c221d	137	boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b	138	struct orl *map, unsigned int orl_count, int stridx));
4a81b561	139
287c221d	140	bfd * bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
2203f786	141	bfd *last_file));
4a81b561	142
287c221d	143	int bfd_generic_stat_arch_elt PARAMS ((bfd , struct stat ));
fc723380	144
6812b607 ILT	145	\f
	146	/* Generic routines to use for BFD_JUMP_TABLE_GENERIC. Use
	147	BFD_JUMP_TABLE_GENERIC (_bfd_generic). */
	148
	149	#define _bfd_generic_close_and_cleanup bfd_true
	150	#define _bfd_generic_bfd_free_cached_info bfd_true
	151	#define _bfd_generic_new_section_hook \
	152	((boolean () PARAMS ((bfd , asection *))) bfd_true)
	153	extern boolean _bfd_generic_get_section_contents
	154	PARAMS ((bfd , asection , PTR location, file_ptr offset,
	155	bfd_size_type count));
	156
	157	/* Generic routines to use for BFD_JUMP_TABLE_COPY. Use
	158	BFD_JUMP_TABLE_COPY (_bfd_generic). */
	159
	160	#define _bfd_generic_bfd_copy_private_bfd_data \
	161	((boolean () PARAMS ((bfd , bfd *))) bfd_true)
	162	#define _bfd_generic_bfd_copy_private_section_data \
	163	((boolean () PARAMS ((bfd , asection , bfd , asection *))) bfd_true)
	164
	165	/* Routines to use for BFD_JUMP_TABLE_CORE when there is no core file
	166	support. Use BFD_JUMP_TABLE_CORE (_bfd_nocore). */
	167
	168	extern char _bfd_nocore_core_file_failing_command PARAMS ((bfd ));
	169	extern int _bfd_nocore_core_file_failing_signal PARAMS ((bfd *));
	170	extern boolean _bfd_nocore_core_file_matches_executable_p
	171	PARAMS ((bfd , bfd ));
	172
	173	/* Routines to use for BFD_JUMP_TABLE_ARCHIVE when there is no archive
	174	file support. Use BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive). */
	175
	176	#define _bfd_noarchive_slurp_armap bfd_false
	177	#define _bfd_noarchive_slurp_extended_name_table bfd_false
	178	#define _bfd_noarchive_truncate_arname \
	179	((void () PARAMS ((bfd , const char , char ))) bfd_void)
	180	#define _bfd_noarchive_write_armap \
	181	((boolean (*) \
	182	PARAMS ((bfd , unsigned int, struct orl , unsigned int, int))) \
	183	bfd_false)
	184	#define _bfd_noarchive_openr_next_archived_file \
	185	((bfd () PARAMS ((bfd , bfd ))) bfd_nullvoidptr)
	186	#define _bfd_noarchive_generic_stat_arch_elt bfd_generic_stat_arch_elt
	187
	188	/* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD style
	189	archives. Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd). */
	190
	191	#define _bfd_archive_bsd_slurp_armap bfd_slurp_bsd_armap
	192	#define _bfd_archive_bsd_slurp_extended_name_table \
	193	_bfd_slurp_extended_name_table
	194	#define _bfd_archive_bsd_truncate_arname bfd_bsd_truncate_arname
	195	#define _bfd_archive_bsd_write_armap bsd_write_armap
	196	#define _bfd_archive_bsd_openr_next_archived_file \
	197	bfd_generic_openr_next_archived_file
	198	#define _bfd_archive_bsd_generic_stat_arch_elt \
	199	bfd_generic_stat_arch_elt
	200
	201	/* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get COFF style
	202	archives. Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff). */
	203
	204	#define _bfd_archive_coff_slurp_armap bfd_slurp_coff_armap
	205	#define _bfd_archive_coff_slurp_extended_name_table \
	206	_bfd_slurp_extended_name_table
	207	#define _bfd_archive_coff_truncate_arname bfd_dont_truncate_arname
	208	#define _bfd_archive_coff_write_armap coff_write_armap
209	#define _bfd_archive_coff_openr_next_archived_file \
210	bfd_generic_openr_next_archived_file
211	#define _bfd_archive_coff_generic_stat_arch_elt \
212	bfd_generic_stat_arch_elt
213
214	/* Routines to use for BFD_JUMP_TABLE_SYMBOLS where there is no symbol
215	support. Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols). */
216
217	#define _bfd_nosymbols_get_symtab_upper_bound _bfd_n1
218	#define _bfd_nosymbols_get_symtab \
219	((long () PARAMS ((bfd , asymbol **))) _bfd_n1)
220	#define _bfd_nosymbols_make_empty_symbol \
221	((asymbol () PARAMS ((bfd *))) bfd_nullvoidptr)
222	#define _bfd_nosymbols_print_symbol \
223	((void () PARAMS ((bfd , PTR, asymbol *, bfd_print_symbol_type))) bfd_void)
224	#define _bfd_nosymbols_get_symbol_info \
225	((void () PARAMS ((bfd , asymbol , symbol_info ))) bfd_void)
226	#define _bfd_nosymbols_bfd_is_local_label \
227	((boolean () PARAMS ((bfd , asymbol *))) bfd_false)
228	#define _bfd_nosymbols_get_lineno \
229	((alent () PARAMS ((bfd , asymbol ))) bfd_nullvoidptr)
230	#define _bfd_nosymbols_find_nearest_line \
231	((boolean (*) \
232	PARAMS ((bfd , asection , asymbol , bfd_vma, const char , \
233	const char *, unsigned int ))) \
234	bfd_false)
235	#define _bfd_nosymbols_bfd_make_debug_symbol \
236	((asymbol () PARAMS ((bfd *, PTR, unsigned long))) bfd_nullvoidptr)
237
238	/* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
239	support. Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs). */
240
241	#define _bfd_norelocs_get_reloc_upper_bound \
242	((long () PARAMS ((bfd , asection *))) _bfd_n1)
243	#define _bfd_norelocs_canonicalize_reloc \
244	((long () PARAMS ((bfd , asection , arelent , asymbol *))) _bfd_n1)
245	#define _bfd_norelocs_bfd_reloc_type_lookup \
246	((const reloc_howto_type () PARAMS ((bfd *, bfd_reloc_code_real_type))) \
247	bfd_nullvoidptr)
248
249	/* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
250	be written. Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite). */
251
252	#define _bfd_nowrite_set_arch_mach \
253	((boolean () PARAMS ((bfd , enum bfd_architecture, unsigned long))) \
254	bfd_false)
255	#define _bfd_nowrite_set_section_contents \
256	((boolean () PARAMS ((bfd , asection *, PTR, file_ptr, bfd_size_type))) \
257	bfd_false)
258
259	/* Generic routines to use for BFD_JUMP_TABLE_WRITE. Use
260	BFD_JUMP_TABLE_WRITE (_bfd_generic). */
261
262	#define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
263	extern boolean _bfd_generic_set_section_contents
264	PARAMS ((bfd , asection , PTR, file_ptr, bfd_size_type));
265
266	/* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
267	support linking. Use BFD_JUMP_TABLE_LINK (_bfd_nolink). */
268
269	#define _bfd_nolink_sizeof_headers ((int () PARAMS ((bfd , boolean))) bfd_0)
270	#define _bfd_nolink_bfd_get_relocated_section_contents \
271	((bfd_byte () \
272	PARAMS ((bfd , struct bfd_link_info , struct bfd_link_order *, \
273	bfd_byte , boolean, asymbol *))) \
274	bfd_nullvoidptr)
275	#define _bfd_nolink_bfd_relax_section \
276	((boolean (*) \
277	PARAMS ((bfd , asection , struct bfd_link_info , boolean ))) \
278	bfd_false)
279	#define _bfd_nolink_bfd_link_hash_table_create \
280	((struct bfd_link_hash_table () PARAMS ((bfd *))) bfd_nullvoidptr)
281	#define _bfd_nolink_bfd_link_add_symbols \
282	((boolean () PARAMS ((bfd , struct bfd_link_info *))) bfd_false)
283	#define _bfd_nolink_bfd_final_link \
284	((boolean () PARAMS ((bfd , struct bfd_link_info *))) bfd_false)
4c3721d5	285	\f
f1cca647 ILT	286	/* Generic routine to determine of the given symbol is a local
	287	label. */
	288	extern boolean bfd_generic_is_local_label PARAMS ((bfd , asymbol ));
	289
4c3721d5 ILT	290	/* A routine to create entries for a bfd_link_hash_table. */
	291	extern struct bfd_hash_entry *_bfd_link_hash_newfunc
	292	PARAMS ((struct bfd_hash_entry *entry,
	293	struct bfd_hash_table *table,
	294	const char *string));
	295
	296	/* Initialize a bfd_link_hash_table. */
	297	extern boolean _bfd_link_hash_table_init
	298	PARAMS ((struct bfd_link_hash_table , bfd ,
	299	struct bfd_hash_entry () (struct bfd_hash_entry *,
	300	struct bfd_hash_table *,
	301	const char *)));
	302
	303	/* Generic link hash table creation routine. */
	304	extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
	305	PARAMS ((bfd *));
	306
	307	/* Generic add symbol routine. */
	308	extern boolean _bfd_generic_link_add_symbols
	309	PARAMS ((bfd , struct bfd_link_info ));
	310
4335ce64 ILT	311	/* Generic add symbol routine. This version is used by targets for
	312	which the linker must collect constructors and destructors by name,
	313	as the collect2 program does. */
	314	extern boolean _bfd_generic_link_add_symbols_collect
	315	PARAMS ((bfd , struct bfd_link_info ));
	316
4c3721d5 ILT	317	/* Generic archive add symbol routine. */
	318	extern boolean _bfd_generic_link_add_archive_symbols
	319	PARAMS ((bfd , struct bfd_link_info ,
	320	boolean (checkfn) (bfd , struct bfd_link_info , boolean )));
	321
	322	/* Forward declaration to avoid prototype errors. */
	323	typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
	324
	325	/* Generic routine to add a single symbol. */
	326	extern boolean _bfd_generic_link_add_one_symbol
	327	PARAMS ((struct bfd_link_info , bfd , const char *name, flagword,
	328	asection , bfd_vma, const char , boolean copy,
f1cca647	329	boolean constructor, struct bfd_link_hash_entry **));
4c3721d5 ILT	330
	331	/* Generic link routine. */
	332	extern boolean _bfd_generic_final_link
	333	PARAMS ((bfd , struct bfd_link_info ));
	334
f1cca647 ILT	335	/* Generic reloc_link_order processing routine. */
	336	extern boolean _bfd_generic_reloc_link_order
	337	PARAMS ((bfd , struct bfd_link_info , asection *,
	338	struct bfd_link_order *));
	339
4c3721d5 ILT	340	/* Default link order processing routine. */
	341	extern boolean _bfd_default_link_order
	342	PARAMS ((bfd , struct bfd_link_info , asection *,
	343	struct bfd_link_order *));
	344
f1cca647 ILT	345	/* Count the number of reloc entries in a link order list. */
	346	extern unsigned int _bfd_count_link_order_relocs
	347	PARAMS ((struct bfd_link_order *));
	348
4c3721d5 ILT	349	/* Final link relocation routine. */
	350	extern bfd_reloc_status_type _bfd_final_link_relocate
	351	PARAMS ((const reloc_howto_type , bfd , asection , bfd_byte ,
	352	bfd_vma address, bfd_vma value, bfd_vma addend));
	353
	354	/* Relocate a particular location by a howto and a value. */
	355	extern bfd_reloc_status_type _bfd_relocate_contents
	356	PARAMS ((const reloc_howto_type , bfd , bfd_vma, bfd_byte *));
	357	\f
4a81b561 DHW	358	/* Macros to tell if bfds are read or write enabled.
	359
	360	Note that bfds open for read may be scribbled into if the fd passed
	361	to bfd_fdopenr is actually open both for read and write
	362	simultaneously. However an output bfd will never be open for
	363	read. Therefore sometimes you want to check bfd_read_p or
	364	!bfd_read_p, and only sometimes bfd_write_p.
	365	*/
	366
287c221d PB	367	#define bfd_read_p(abfd) ((abfd)->direction == read_direction \|\| (abfd)->direction == both_direction)
	368	#define bfd_write_p(abfd) ((abfd)->direction == write_direction \|\| (abfd)->direction == both_direction)
	369
	370	void bfd_assert PARAMS ((char*,int));
4a81b561	371
4a81b561 DHW	372	#define BFD_ASSERT(x) \
	373	{ if (!(x)) bfd_assert(__FILE__,__LINE__); }
	374
	375	#define BFD_FAIL() \
	376	{ bfd_assert(__FILE__,__LINE__); }
	377
287c221d	378	FILE * bfd_cache_lookup_worker PARAMS ((bfd *));
4a81b561 DHW	379
4a81b561 DHW	380	extern bfd *bfd_last_cache;
4a81b561 DHW	381
	382	/* Now Steve, what's the story here? */
	383	#ifdef lint
	384	#define itos(x) "l"
	385	#define stoi(x) 1
	386	#else
	387	#define itos(x) ((char*)(x))
	388	#define stoi(x) ((int)(x))
	389	#endif
69ebee86	390
4c3721d5	391	/* List of supported target vectors, and the default vector (if
f4bd7a8f DM	392	bfd_default_vector[0] is NULL, there is no default). */
	393	extern bfd_target *bfd_target_vector[];
	394	extern bfd_target *bfd_default_vector[];
4c3721d5	395
b8d69097	396	/* And more follows */
6f715d66	397
fefb4b30 JG	398	void
	399	bfd_check_init PARAMS ((void));
	400
fefb4b30 JG	401	void
	402	bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd, int i));
	403
3ceaa255	404	unsigned int
fefb4b30 JG	405	bfd_log2 PARAMS ((bfd_vma x));
fefb4b30 JG	406
6f715d66	407	#define BFD_CACHE_MAX_OPEN 10
6f715d66	408	extern bfd *bfd_last_cache;
e98e6ec1	409
6f715d66	410	#define bfd_cache_lookup(x) \
0cda46cf SC	411	((x)==bfd_last_cache? \
	412	(FILE*)(bfd_last_cache->iostream): \
	413	bfd_cache_lookup_worker(x))
fefb4b30	414	boolean
c188b0be	415	bfd_cache_close PARAMS ((bfd *abfd));
fefb4b30 JG	416
fefb4b30 JG	417	FILE*
c188b0be	418	bfd_open_file PARAMS ((bfd *abfd));
fefb4b30 JG	419
fefb4b30 JG	420	FILE *
c188b0be	421	bfd_cache_lookup_worker PARAMS ((bfd *abfd));
fefb4b30	422
80425e6c	423	boolean
fefb4b30	424	bfd_constructor_entry PARAMS ((bfd *abfd,
e98e6ec1 SC	425	asymbol **symbol_ptr_ptr,
e98e6ec1 SC	426	CONST char*type));
fefb4b30	427
e2756048	428	const struct reloc_howto_struct *
fefb4b30	429	bfd_default_reloc_type_lookup
57a1867e	430	PARAMS ((bfd *abfd, bfd_reloc_code_real_type code));
fefb4b30 JG	431
	432	boolean
	433	bfd_generic_relax_section
	434	PARAMS ((bfd *abfd,
d58b7049	435	asection *section,
4c3721d5	436	struct bfd_link_info *,
326e32d7	437	boolean *));
fefb4b30	438
e98e6ec1	439	bfd_byte *
fefb4b30	440
287c221d	441	bfd_generic_get_relocated_section_contents PARAMS ((bfd *abfd,
4c3721d5 ILT	442	struct bfd_link_info *link_info,
4c3721d5 ILT	443	struct bfd_link_order *link_order,
14e3c2e4	444	bfd_byte *data,
4c3721d5 ILT	445	boolean relocateable,
4c3721d5 ILT	446	asymbol **symbols));
14e3c2e4	447
e98e6ec1	448	extern bfd_arch_info_type bfd_default_arch_struct;
fefb4b30 JG	449	boolean
fefb4b30 JG	450	bfd_default_set_arch_mach PARAMS ((bfd *abfd,
e98e6ec1 SC	451	enum bfd_architecture arch,
e98e6ec1 SC	452	unsigned long mach));
fefb4b30	453
c188b0be	454	void
fefb4b30 JG	455	bfd_arch_init PARAMS ((void));
	456
	457	void
c188b0be	458	bfd_arch_linkin PARAMS ((bfd_arch_info_type *ptr));
fefb4b30 JG	459
	460	CONST bfd_arch_info_type *
	461	bfd_default_compatible
	462	PARAMS ((CONST bfd_arch_info_type *a,
e98e6ec1	463	CONST bfd_arch_info_type *b));
fefb4b30 JG	464
fefb4b30 JG	465	boolean
c188b0be	466	bfd_default_scan PARAMS ((CONST struct bfd_arch_info info, CONST char string));
fefb4b30	467
3ceaa255	468	struct elf_internal_shdr *
6affd66a	469	bfd_elf_find_section PARAMS ((bfd abfd, char name));
fefb4b30	470