binutils-gdb/bfd/libbfd.h

231 lines
8.9 KiB
C
Raw Normal View History

1991-08-17 02:17:15 +02:00
/* libbfd.h -- Declarations used by bfd library *implementation*.
(This include file is not for users of the library.)
1991-11-22 17:48:27 +01:00
Copyright 1990, 1991 Free Software Foundation, Inc.
1991-08-17 02:17:15 +02:00
Written by Cygnus Support.
1991-08-17 02:17:15 +02:00
This file is part of BFD, the Binary File Descriptor library.
1991-03-21 22:11:25 +01:00
1991-08-17 02:17:15 +02:00
This program is free software; you can redistribute it and/or modify
1991-03-21 22:11:25 +01:00
it under the terms of the GNU General Public License as published by
1991-08-17 02:17:15 +02:00
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
1991-03-21 22:11:25 +01:00
1991-08-17 02:17:15 +02:00
This program is distributed in the hope that it will be useful,
1991-03-21 22:11:25 +01:00
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
1991-08-17 02:17:15 +02:00
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
1991-03-21 22:11:25 +01:00
/* 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. */
1991-11-22 17:48:27 +01:00
#define BFD_ALIGN(this, boundary) \
((( (this) + ((boundary) -1)) & (~((boundary)-1))))
1991-03-21 22:11:25 +01:00
/* 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. */
1991-03-21 22:11:25 +01:00
struct artdata {
file_ptr first_file_filepos;
/* Speed up searching the armap */
struct ar_cache *cache;
bfd *archive_head; /* Only interesting in output routines */
carsym *symdefs; /* the symdef entries */
symindex symdef_count; /* how many there are */
char *extended_names; /* clever intel extension */
};
#define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
1991-03-21 22:11:25 +01:00
/* 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. */
1991-03-21 22:11:25 +01:00
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));
1991-07-04 18:52:56 +02:00
PROTO(void, bfd_alloc_grow,(bfd *abfd, PTR thing, bfd_size_type size));
PROTO(PTR, bfd_alloc_finish,(bfd *abfd));
#define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
1991-03-21 22:11:25 +01:00
1991-07-04 18:52:56 +02:00
PROTO (bfd_size_type, bfd_read, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
Insert the incidentals and things I forgot to ci last time, same log message: Mon Sep 30 15:13:46 1991 Steve Chamberlain (steve at cygnus.com) * cpu-a29k.c, cpu-i386.c, cpu-m68k.c, cpu-mips.c, cpu-vax.c, cpu-h8300.c, cpu-i960.c, cpu-m88k.c, cpu-sparc.c: added. These files will eventually contain processor specific bits for bfd, like strange relocation information and dis/assembly. So far only the H8 has been even partially done. This work also ties in with the change in handling architectures. * amdcoff.c: (a29k_reloc) fix error message. * aout-f1.h: (choose_reloc_size) now calls bfd_get_arch to discover the architecture of the bfd. (sunos4_callback) calls the function bfd_set_arch_mach rather than stuffing stuff directly into the bfd. (sunos4_write_object_contents), changed names of accessor functions. * aoutx.h: (set_arch_mach) now calls bfd_default_set_arch_mach to setup the environment. * archive.c: (bfd_slurp_coff_armap) coff archives always have the headers in big endian format, regardless of the endianess of the host or target. * archures.c: totally changed. Now an architecture is represented with a pointer to an info structure rather than an enumerated type and a long. The old info is available as two elements in the structure. Future enhancements to architecure support will involve pointers to methods being placed into the info structure. * bfd.c: changed the definition of the bfd structure for the new architecture stuff. * bout.c: (b_out_set_arch_mach) changed to use the new architecture mechanism. * coffcode.h: (coff_set_arch_mach, coff_set_flags) changed to use the new architecture mechanism. * configure.in: added h8 stuff. * ieee.c: too many changes to note. Now ieee files written with bfd gas and ld can be read by gld and ieee only linkers and simulators. * libbfd.c, libbfd.h: changed prototype of bfd_write. * newsos3.c: (newos3_callback) now calls bfd_set_arch_mach rather than fixing the structure directly. * oasys.c: (oasys_object_p) now calls bfd_default_set_arch_mach rather than fixing the structure directly. * opncls.c: (new_bfd) makes sure that bfd_init has been called before opening a bfd. * srec.c: (srec_set_arch_mach) now calls bfd_default_set_arch_mach rather than fixing the structure directly. * targets.c: (target_vector) now by defining SELECT_VECS (perhaps in the t/hmake file) a user can select which backends they want linked with bfd without changing the source. * init.c: new, looks after initializing modules. * howto.c: for future use, will allow an application to work out what cookie to use as a handle on a relcoatio howto.
1991-10-01 04:55:40 +01:00
PROTO (bfd_size_type, bfd_write, (CONST PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
1991-03-21 22:11:25 +01:00
1991-07-04 18:52:56 +02:00
PROTO (int, bfd_seek,(bfd* abfd, file_ptr fp , int direction));
1991-03-21 22:11:25 +01:00
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));
1991-08-17 02:17:15 +02:00
PROTO (bfd_vma, _do_getb64, (unsigned char *addr));
PROTO (bfd_vma, _do_getl64, (unsigned char *addr));
PROTO (bfd_vma, _do_getb32, (unsigned char *addr));
PROTO (bfd_vma, _do_getl32, (unsigned char *addr));
PROTO (bfd_vma, _do_getb16, (unsigned char *addr));
PROTO (bfd_vma, _do_getl16, (unsigned char *addr));
PROTO (void, _do_putb64, (bfd_vma data, unsigned char *addr));
PROTO (void, _do_putl64, (bfd_vma data, unsigned char *addr));
PROTO (void, _do_putb32, (bfd_vma data, unsigned char *addr));
PROTO (void, _do_putl32, (bfd_vma data, unsigned char *addr));
PROTO (void, _do_putb16, (bfd_vma data, unsigned char *addr));
PROTO (void, _do_putl16, (bfd_vma data, unsigned char *addr));
1991-03-21 22:11:25 +01:00
PROTO (boolean, bfd_false, (bfd *ignore));
PROTO (boolean, bfd_true, (bfd *ignore));
1991-05-08 21:23:35 +02:00
PROTO (PTR, bfd_nullvoidptr, (bfd *ignore));
1991-03-21 22:11:25 +01:00
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, CONST char *filename,
char *hdr));
PROTO (void, bfd_bsd_truncate_arname, (bfd *abfd, CONST char *filename,
char *hdr));
PROTO (void, bfd_gnu_truncate_arname, (bfd *abfd, CONST char *filename,
char *hdr));
1991-03-21 22:11:25 +01:00
PROTO (boolean, bsd_write_armap, (bfd *arch, unsigned int elength,
struct orl *map, unsigned int orl_count, int stridx));
1991-03-21 22:11:25 +01:00
PROTO (boolean, coff_write_armap, (bfd *arch, unsigned int elength,
struct orl *map, unsigned int orl_count, int stridx));
1991-03-21 22:11:25 +01:00
1991-05-10 01:48:26 +02:00
PROTO (bfd *, bfd_generic_openr_next_archived_file, (bfd *archive,
bfd *last_file));
1991-03-21 22:11:25 +01:00
PROTO(int, bfd_generic_stat_arch_elt, (bfd *, struct stat *));
1991-05-10 01:48:26 +02:00
PROTO(boolean, bfd_generic_get_section_contents,
(bfd *abfd, sec_ptr section, PTR location, file_ptr offset,
bfd_size_type count));
PROTO(boolean, bfd_generic_set_section_contents,
(bfd *abfd, sec_ptr section, PTR location, file_ptr offset,
bfd_size_type count));
1991-05-10 01:48:26 +02:00
1991-03-21 22:11:25 +01:00
/* 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;
/* 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
1991-07-04 18:52:56 +02:00
1991-12-01 02:27:19 +01:00
/* And more follows */
1991-07-04 18:52:56 +02:00
1991-12-01 01:39:12 +01:00
void EXFUN(bfd_check_init, (void));
PTR EXFUN(bfd_xmalloc, ( bfd_size_type size));
void EXFUN(bfd_write_bigendian_4byte_int, (bfd *abfd, int i));
1991-12-01 01:39:12 +01:00
bfd_vma EXFUN(bfd_log2, (bfd_vma x));
1991-12-01 02:27:19 +01:00
void EXFUN(bfd_check_init, (void));
PTR EXFUN(bfd_xmalloc, ( bfd_size_type size));
void EXFUN(bfd_write_bigendian_4byte_int, (bfd *abfd, int i));
1991-12-01 02:27:19 +01:00
bfd_vma EXFUN(bfd_log2, (bfd_vma x));
1991-07-04 18:52:56 +02:00
#define BFD_CACHE_MAX_OPEN 10
extern bfd *bfd_last_cache;
1991-07-04 18:52:56 +02:00
#define bfd_cache_lookup(x) \
1991-12-01 01:39:12 +01:00
((x)==bfd_last_cache? \
(FILE*)(bfd_last_cache->iostream): \
bfd_cache_lookup_worker(x))
void EXFUN(bfd_cache_init , (bfd *));
void EXFUN(bfd_cache_close , (bfd *));
FILE* EXFUN(bfd_open_file, (bfd *));
FILE *EXFUN(bfd_cache_lookup_worker, (bfd *));
void EXFUN(bfd_constructor_entry, (bfd *abfd,
asymbol **symbol_ptr_ptr,
CONST char*type));
1991-12-01 01:39:12 +01:00
CONST struct reloc_howto_struct *EXFUN(bfd_default_reloc_type_lookup
, (CONST struct bfd_arch_info *,
bfd_reloc_code_type code));
bfd_byte *
EXFUN(bfd_generic_get_relocated_section_contents, (bfd *abfd,
struct bfd_seclet_struct *seclet)
);
extern bfd_arch_info_type bfd_default_arch_struct;
1991-12-01 01:39:12 +01:00
boolean EXFUN(bfd_default_set_arch_mach, (bfd *abfd,
enum bfd_architecture arch,
unsigned long mach));
1991-12-01 01:39:12 +01:00
void EXFUN(bfd_arch_init, (void));
void EXFUN(bfd_arch_linkin, (bfd_arch_info_type *));
CONST bfd_arch_info_type *EXFUN(bfd_default_compatible
, (CONST bfd_arch_info_type *a,
CONST bfd_arch_info_type *b));
1991-12-01 01:39:12 +01:00
boolean EXFUN(bfd_default_scan, (CONST struct bfd_arch_info *, CONST char *));