1 /* libbfd.h -- Declarations used by bfd library *implementation*.
2 (This include file is not for users of the library.)
3 Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
4 Written by Cygnus Support.
6 This file is part of BFD, the Binary File Descriptor library.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
23 /* Align an address upward to a boundary, expressed as a number of bytes.
24 E.g. align to an 8-byte boundary with argument of 8. */
25 #define BFD_ALIGN(this, boundary) \
26 ((( (this) + ((boundary) -1)) & (~((boundary)-1))))
28 /* If you want to read and write large blocks, you might want to do it
29 in quanta of this amount */
30 #define DEFAULT_BUFFERSIZE 8192
32 /* Set a tdata field. Can't use the other macros for this, since they
33 do casts, and casting to the left of assignment isn't portable. */
34 #define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
36 /* tdata for an archive. For an input archive, cache
37 needs to be free()'d. For an output archive, symdefs do. */
40 file_ptr first_file_filepos
;
41 /* Speed up searching the armap */
42 struct ar_cache
*cache
;
43 bfd
*archive_head
; /* Only interesting in output routines */
44 carsym
*symdefs
; /* the symdef entries */
45 symindex symdef_count
; /* how many there are */
46 char *extended_names
; /* clever intel extension */
47 /* when more compilers are standard C, this can be a time_t */
48 long armap_timestamp
; /* Timestamp value written into armap.
49 This is used for BSD archives to check
50 that the timestamp is recent enough
51 for the BSD linker to not complain,
52 just before we finish writing an
54 file_ptr armap_datepos
; /* Position within archive to seek to
55 rewrite the date field. */
58 #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
60 /* Goes in bfd's arelt_data slot */
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 */
67 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
69 char *zalloc
PARAMS ((bfd_size_type size
));
71 /* These routines allocate and free things on the BFD's obstack. Note
72 that realloc can never occur in place. */
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
));
78 PTR bfd_alloc_finish
PARAMS ((bfd
*abfd
));
79 PTR bfd_alloc_by_size_t
PARAMS ((bfd
*abfd
, size_t wanted
));
81 #define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
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
));
92 int bfd_flush
PARAMS ((bfd
*abfd
));
93 int bfd_stat
PARAMS ((bfd
*abfd
, struct stat
*));
95 bfd
* _bfd_create_empty_archive_element_shell
PARAMS ((bfd
*obfd
));
96 bfd
* look_for_bfd_in_cache
PARAMS ((bfd
*arch_bfd
, file_ptr index
));
97 boolean _bfd_generic_mkarchive
PARAMS ((bfd
*abfd
));
98 struct areltdata
* snarf_ar_hdr
PARAMS ((bfd
*abfd
));
99 bfd_target
* bfd_generic_archive_p
PARAMS ((bfd
*abfd
));
100 boolean bfd_slurp_armap
PARAMS ((bfd
*abfd
));
101 boolean bfd_slurp_bsd_armap_f2
PARAMS ((bfd
*abfd
));
102 #define bfd_slurp_bsd_armap bfd_slurp_armap
103 #define bfd_slurp_coff_armap bfd_slurp_armap
104 boolean _bfd_slurp_extended_name_table
PARAMS ((bfd
*abfd
));
105 boolean _bfd_write_archive_contents
PARAMS ((bfd
*abfd
));
106 bfd
* new_bfd
PARAMS (());
108 #define DEFAULT_STRING_SPACE_SIZE 0x2000
109 boolean bfd_add_to_string_table
PARAMS ((char **table
, char *new_string
,
110 unsigned int *table_length
,
113 boolean bfd_false
PARAMS ((bfd
*ignore
));
114 boolean bfd_true
PARAMS ((bfd
*ignore
));
115 PTR bfd_nullvoidptr
PARAMS ((bfd
*ignore
));
116 int bfd_0
PARAMS ((bfd
*ignore
));
117 unsigned int bfd_0u
PARAMS ((bfd
*ignore
));
118 void bfd_void
PARAMS ((bfd
*ignore
));
120 bfd
* new_bfd_contained_in
PARAMS ((bfd
*));
121 boolean _bfd_dummy_new_section_hook
PARAMS ((bfd
*ignore
, asection
*newsect
));
122 char * _bfd_dummy_core_file_failing_command
PARAMS ((bfd
*abfd
));
123 int _bfd_dummy_core_file_failing_signal
PARAMS ((bfd
*abfd
));
124 boolean _bfd_dummy_core_file_matches_executable_p
PARAMS ((bfd
*core_bfd
,
126 bfd_target
* _bfd_dummy_target
PARAMS ((bfd
*abfd
));
128 void bfd_dont_truncate_arname
PARAMS ((bfd
*abfd
, CONST
char *filename
,
130 void bfd_bsd_truncate_arname
PARAMS ((bfd
*abfd
, CONST
char *filename
,
132 void bfd_gnu_truncate_arname
PARAMS ((bfd
*abfd
, CONST
char *filename
,
135 boolean bsd_write_armap
PARAMS ((bfd
*arch
, unsigned int elength
,
136 struct orl
*map
, unsigned int orl_count
, int stridx
));
138 boolean coff_write_armap
PARAMS ((bfd
*arch
, unsigned int elength
,
139 struct orl
*map
, unsigned int orl_count
, int stridx
));
141 bfd
* bfd_generic_openr_next_archived_file
PARAMS ((bfd
*archive
,
144 int bfd_generic_stat_arch_elt
PARAMS ((bfd
*, struct stat
*));
146 boolean bfd_generic_get_section_contents
PARAMS ((bfd
*abfd
, sec_ptr section
,
147 PTR location
, file_ptr offset
,
148 bfd_size_type count
));
150 boolean bfd_generic_set_section_contents
PARAMS ((bfd
*abfd
, sec_ptr section
,
151 PTR location
, file_ptr offset
,
152 bfd_size_type count
));
154 /* Macros to tell if bfds are read or write enabled.
156 Note that bfds open for read may be scribbled into if the fd passed
157 to bfd_fdopenr is actually open both for read and write
158 simultaneously. However an output bfd will never be open for
159 read. Therefore sometimes you want to check bfd_read_p or
160 !bfd_read_p, and only sometimes bfd_write_p.
163 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
164 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
166 void bfd_assert
PARAMS ((char*,int));
168 #define BFD_ASSERT(x) \
169 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
172 { bfd_assert(__FILE__,__LINE__); }
174 FILE * bfd_cache_lookup_worker
PARAMS ((bfd
*));
176 extern bfd
*bfd_last_cache
;
178 /* Now Steve, what's the story here? */
183 #define itos(x) ((char*)(x))
184 #define stoi(x) ((int)(x))
187 /* Generic routine for close_and_cleanup is really just bfd_true. */
188 #define bfd_generic_close_and_cleanup bfd_true
190 /* And more follows */
193 bfd_check_init
PARAMS ((void));
196 bfd_xmalloc
PARAMS (( bfd_size_type size
));
199 bfd_xmalloc_by_size_t
PARAMS (( size_t size
));
202 bfd_write_bigendian_4byte_int
PARAMS ((bfd
*abfd
, int i
));
205 bfd_log2
PARAMS ((bfd_vma x
));
207 #define BFD_CACHE_MAX_OPEN 10
208 extern bfd
*bfd_last_cache
;
210 #define bfd_cache_lookup(x) \
211 ((x)==bfd_last_cache? \
212 (FILE*)(bfd_last_cache->iostream): \
213 bfd_cache_lookup_worker(x))
215 bfd_cache_close
PARAMS ((bfd
*abfd
));
218 bfd_open_file
PARAMS ((bfd
*abfd
));
221 bfd_cache_lookup_worker
PARAMS ((bfd
*abfd
));
224 bfd_constructor_entry
PARAMS ((bfd
*abfd
,
225 asymbol
**symbol_ptr_ptr
,
228 CONST
struct reloc_howto_struct
*
229 bfd_default_reloc_type_lookup
230 PARAMS ((bfd
*abfd AND
231 bfd_reloc_code_real_type code
));
234 bfd_generic_relax_section
241 bfd_generic_get_relocated_section_contents
PARAMS ((bfd
*abfd
,
242 struct bfd_seclet
*seclet
,
244 boolean relocateable
));
247 bfd_generic_seclet_link
250 boolean relocateable
));
252 extern bfd_arch_info_type bfd_default_arch_struct
;
254 bfd_default_set_arch_mach
PARAMS ((bfd
*abfd
,
255 enum bfd_architecture arch
,
256 unsigned long mach
));
259 bfd_arch_init
PARAMS ((void));
262 bfd_arch_linkin
PARAMS ((bfd_arch_info_type
*ptr
));
264 CONST bfd_arch_info_type
*
265 bfd_default_compatible
266 PARAMS ((CONST bfd_arch_info_type
*a
,
267 CONST bfd_arch_info_type
*b
));
270 bfd_default_scan
PARAMS ((CONST
struct bfd_arch_info
*info
, CONST
char *string
));
272 struct elf_internal_shdr
*
273 bfd_elf_find_section
PARAMS ((bfd
*abfd
, char *name
));