[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, 1994 Free Software Foundation, Inc.
   Written by Cygnus Support.

** NOTE: libbfd.h is a GENERATED file.  Don't change it; instead,
** change libbfd-in.h or the other BFD source files processed to
** generate this file.

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 size));
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 *	_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));
const 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 *));
const 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)

/* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
   have dynamic symbols or relocs.  Use BFD_JUMP_TABLE_DYNAMIC
   (_bfd_nodynamic).  */

#define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_n1
#define _bfd_nodynamic_canonicalize_dynamic_symtab \
  ((long (*) PARAMS ((bfd *, asymbol **))) _bfd_n1)
#define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_n1
#define _bfd_nodynamic_canonicalize_dynamic_reloc \
  ((long (*) PARAMS ((bfd *, arelent **, asymbol **))) _bfd_n1)
\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 *));

/* Create a string table.  */
extern struct bfd_strtab_hash *_bfd_stringtab_init PARAMS ((void));

/* Free a string table.  */
extern void _bfd_stringtab_free PARAMS ((struct bfd_strtab_hash *));

/* Get the size of a string table.  */
extern bfd_size_type _bfd_stringtab_size PARAMS ((struct bfd_strtab_hash *));

/* Add a string to a string table.  */
extern bfd_size_type _bfd_stringtab_add
  PARAMS ((struct bfd_strtab_hash *, const char *, boolean hash,
	   boolean copy));

/* Write out a string table.  */
extern boolean _bfd_stringtab_emit PARAMS ((bfd *, struct bfd_strtab_hash *));
\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 const bfd_target * const bfd_target_vector[];
extern const bfd_target * const bfd_default_vector[];

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