2 /* libbfd.h -- Declarations used by bfd library *implementation*.
3 (This include file is not for users of the library.)
4 Copyright (C) 1990-1991 Free Software Foundation, Inc.
5 Written by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
24 /* Align an address upward to a boundary, expressed as a number of bytes.
25 E.g. align to an 8-byte boundary with argument of 8. */
26 #define ALIGN(this, boundary) \
27 ((( (this) + ((boundary) -1)) & (~((boundary)-1))))
29 /* If you want to read and write large blocks, you might want to do it
30 in quanta of this amount */
31 #define DEFAULT_BUFFERSIZE 8192
33 /* Set a tdata field. Can't use the other macros for this, since they
34 do casts, and casting to the left of assignment isn't portable. */
35 #define set_tdata(bfd, v) ((bfd)->tdata = (PTR) (v))
37 /* tdata for an archive. For an input archive, cache
38 needs to be free()'d. For an output archive, symdefs do. */
41 file_ptr first_file_filepos
;
42 /* Speed up searching the armap */
43 struct ar_cache
*cache
;
44 bfd
*archive_head
; /* Only interesting in output routines */
45 carsym
*symdefs
; /* the symdef entries */
46 symindex symdef_count
; /* how many there are */
47 char *extended_names
; /* clever intel extension */
50 #define bfd_ardata(bfd) ((struct artdata *) ((bfd)->tdata))
52 /* Goes in bfd's arelt_data slot */
54 char * arch_header
; /* it's actually a string */
55 unsigned int parsed_size
; /* octets of filesize not including ar_hdr */
56 char *filename
; /* null-terminated */
59 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
61 /* FIXME -- a lot of my code allocates a large block and subdivides it.
62 This can't always work, because of alignment restrictions. We should change
63 it before it becomes a problem -- Gumby */
65 PROTO (char *, zalloc
, (bfd_size_type size
));
67 /* These routines allocate and free things on the BFD's obstack. Note
68 that realloc can never occur in place. */
70 PROTO(PTR
, bfd_alloc
, (bfd
*abfd
, bfd_size_type size
));
71 PROTO(PTR
, bfd_zalloc
,(bfd
*abfd
, bfd_size_type size
));
72 PROTO(PTR
, bfd_realloc
,(bfd
*abfd
, PTR orig
, bfd_size_type
new));
73 PROTO(void, bfd_alloc_grow
,(bfd
*abfd
, PTR thing
, bfd_size_type size
));
74 PROTO(PTR
, bfd_alloc_finish
,(bfd
*abfd
));
76 #define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
79 PROTO (bfd_size_type
, bfd_read
, (PTR ptr
, bfd_size_type size
, bfd_size_type nitems
, bfd
*abfd
));
80 PROTO (bfd_size_type
, bfd_write
, (CONST PTR ptr
, bfd_size_type size
, bfd_size_type nitems
, bfd
*abfd
));
84 PROTO (int, bfd_seek
,(bfd
* abfd
, file_ptr fp
, int direction
));
85 PROTO (long, bfd_tell
, (bfd
*abfd
));
86 PROTO (bfd
*, _bfd_create_empty_archive_element_shell
, (bfd
*obfd
));
87 PROTO (bfd
*, look_for_bfd_in_cache
, (bfd
*arch_bfd
, file_ptr index
));
88 PROTO (boolean
, _bfd_generic_mkarchive
, (bfd
*abfd
));
89 PROTO (struct areltdata
*, snarf_ar_hdr
, (bfd
*abfd
));
90 PROTO (bfd_target
*, bfd_generic_archive_p
, (bfd
*abfd
));
91 PROTO (boolean
, bfd_slurp_bsd_armap
, (bfd
*abfd
));
92 PROTO (boolean
, bfd_slurp_coff_armap
, (bfd
*abfd
));
93 PROTO (boolean
, _bfd_slurp_extended_name_table
, (bfd
*abfd
));
94 PROTO (boolean
, _bfd_write_archive_contents
, (bfd
*abfd
));
95 PROTO (bfd
*, new_bfd
, ());
97 #define DEFAULT_STRING_SPACE_SIZE 0x2000
98 PROTO (boolean
, bfd_add_to_string_table
, (char **table
, char *new_string
,
99 unsigned int *table_length
,
101 PROTO (bfd_vma
, _do_getb64
, (unsigned char *addr
));
102 PROTO (bfd_vma
, _do_getl64
, (unsigned char *addr
));
103 PROTO (bfd_vma
, _do_getb32
, (unsigned char *addr
));
104 PROTO (bfd_vma
, _do_getl32
, (unsigned char *addr
));
105 PROTO (bfd_vma
, _do_getb16
, (unsigned char *addr
));
106 PROTO (bfd_vma
, _do_getl16
, (unsigned char *addr
));
107 PROTO (void, _do_putb64
, (bfd_vma data
, unsigned char *addr
));
108 PROTO (void, _do_putl64
, (bfd_vma data
, unsigned char *addr
));
109 PROTO (void, _do_putb32
, (bfd_vma data
, unsigned char *addr
));
110 PROTO (void, _do_putl32
, (bfd_vma data
, unsigned char *addr
));
111 PROTO (void, _do_putb16
, (bfd_vma data
, unsigned char *addr
));
112 PROTO (void, _do_putl16
, (bfd_vma data
, unsigned char *addr
));
114 PROTO (boolean
, bfd_false
, (bfd
*ignore
));
115 PROTO (boolean
, bfd_true
, (bfd
*ignore
));
116 PROTO (PTR
, bfd_nullvoidptr
, (bfd
*ignore
));
117 PROTO (int, bfd_0
, (bfd
*ignore
));
118 PROTO (unsigned int, bfd_0u
, (bfd
*ignore
));
119 PROTO (void, bfd_void
, (bfd
*ignore
));
121 PROTO (bfd
*,new_bfd_contained_in
,(bfd
*));
122 PROTO (boolean
, _bfd_dummy_new_section_hook
, (bfd
*ignore
, asection
*newsect
));
123 PROTO (char *, _bfd_dummy_core_file_failing_command
, (bfd
*abfd
));
124 PROTO (int, _bfd_dummy_core_file_failing_signal
, (bfd
*abfd
));
125 PROTO (boolean
, _bfd_dummy_core_file_matches_executable_p
, (bfd
*core_bfd
,
127 PROTO (bfd_target
*, _bfd_dummy_target
, (bfd
*abfd
));
129 PROTO (void, bfd_dont_truncate_arname
, (bfd
*abfd
, CONST
char *filename
,
131 PROTO (void, bfd_bsd_truncate_arname
, (bfd
*abfd
, CONST
char *filename
,
133 PROTO (void, bfd_gnu_truncate_arname
, (bfd
*abfd
, CONST
char *filename
,
136 PROTO (boolean
, bsd_write_armap
, (bfd
*arch
, unsigned int elength
,
137 struct orl
*map
, unsigned int orl_count
, int stridx
));
139 PROTO (boolean
, coff_write_armap
, (bfd
*arch
, unsigned int elength
,
140 struct orl
*map
, unsigned int orl_count
, int stridx
));
142 PROTO (bfd
*, bfd_generic_openr_next_archived_file
, (bfd
*archive
,
145 PROTO(int, bfd_generic_stat_arch_elt
, (bfd
*, struct stat
*));
147 PROTO(boolean
, bfd_generic_get_section_contents
,
148 (bfd
*abfd
, sec_ptr section
, PTR location
, file_ptr offset
,
149 bfd_size_type count
));
151 PROTO(boolean
, bfd_generic_set_section_contents
,
152 (bfd
*abfd
, sec_ptr section
, PTR location
, file_ptr offset
,
153 bfd_size_type count
));
155 /* Macros to tell if bfds are read or write enabled.
157 Note that bfds open for read may be scribbled into if the fd passed
158 to bfd_fdopenr is actually open both for read and write
159 simultaneously. However an output bfd will never be open for
160 read. Therefore sometimes you want to check bfd_read_p or
161 !bfd_read_p, and only sometimes bfd_write_p.
164 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
165 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
167 PROTO (void, bfd_assert
,(char*,int));
168 #define BFD_ASSERT(x) \
169 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
172 { bfd_assert(__FILE__,__LINE__); }
174 PROTO (FILE *, bfd_cache_lookup_worker
, (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 /* THE FOLLOWING IS EXTRACTED FROM THE SOURCE*/
195 This routine is called before any other bfd function using initialized
196 data is used to ensure that the structures have been initialized.
197 Soon this function will go away, and the bfd library will assume that
198 bfd_init has been called.
201 void EXFUN(bfd_check_init
,(void));
207 /* bfd_write_bigendian_4byte_int
210 PROTO(void, bfd_write_bigendian_4byte_int
,( bfd
*abfd
, int i
));
215 Return the log base 2 of the value supplied, rounded up. eg an arg
216 of 1025 would return 11.
218 PROTO(bfd_vma
, bfd_log2
,(bfd_vma x
));
224 /* BFD_CACHE_MAX_OPEN
225 The maxiumum number of files which the cache will keep open at one
228 #define BFD_CACHE_MAX_OPEN 10
233 Zero, or a pointer to the topmost BFD on the chain. This is used by
234 the @code{bfd_cache_lookup} macro in @file{libbfd.h} to determine when
235 it can avoid a function call.
237 extern bfd
*bfd_last_cache
;
242 Checks to see if the required BFD is the same as the last one looked
243 up. If so then it can use the iostream in the BFD with impunity, since
244 it can't have changed since the last lookup, otherwise it has to
245 perform the complicated lookup function
247 #define bfd_cache_lookup(x) \
248 ((x)==bfd_last_cache? \
249 (FILE*)(bfd_last_cache->iostream): \
250 bfd_cache_lookup_worker(x))
255 Initialize a BFD by putting it on the cache LRU.
257 PROTO(void, bfd_cache_init
, (bfd
*));
262 Remove the BFD from the cache. If the attached file is open, then close it too.
264 PROTO(void, bfd_cache_close
, (bfd
*));
269 Call the OS to open a file for this BFD. Returns the FILE *
270 (possibly null) that results from this operation. Sets up the
271 BFD so that future accesses know the file is open. If the FILE *
272 returned is null, then there is won't have been put in the cache, so
273 it won't have to be removed from it.
275 PROTO(FILE *, bfd_open_file
, (bfd
*));
279 *i bfd_cache_lookup_worker
280 Called when the macro @code{bfd_cache_lookup} fails to find a quick
281 answer. Finds a file descriptor for this BFD. If necessary, it open it.
282 If there are already more than BFD_CACHE_MAX_OPEN files open, it trys to close
283 one first, to avoid running out of file descriptors.
285 PROTO(FILE *, bfd_cache_lookup_worker
, (bfd
*));
300 /* bfd_default_arch_struct
302 What bfds are seeded with
305 extern bfd_arch_info_type bfd_default_arch_struct
;
308 bfd_default_set_arch_mach
310 Set the architecture and machine type in a bfd. This finds the correct
311 pointer to structure and inserts it into the arch_info pointer.
314 boolean
EXFUN(bfd_default_set_arch_mach
,(bfd
*abfd
,
315 enum bfd_architecture arch
,
316 unsigned long mach
));
320 This routine initializes the architecture dispatch table by calling
321 all installed architecture packages and getting them to poke around.
324 PROTO(void, bfd_arch_init
,(void));
330 Link the provided arch info structure into the list
333 void EXFUN(bfd_arch_linkin
,(bfd_arch_info_type
*));
337 bfd_default_compatible
339 The default function for testing for compatibility
342 CONST bfd_arch_info_type
*EXFUN(bfd_default_compatible
,
343 (CONST bfd_arch_info_type
*a
,
344 CONST bfd_arch_info_type
*b
));
349 The default function for working out whether this is an architecture
350 hit and a machine hit
353 boolean
EXFUN(bfd_default_scan
,(CONST
struct bfd_arch_info
*, CONST
char *));