Commit | Line | Data |
---|---|---|
00539ee3 | 1 | /* Main header file for the bfd library -- portable access to object files. |
7d6d10f9 NC |
2 | Copyright 1990, 91, 92, 93, 94, 95, 96, 97, 1998 |
3 | Free Software Foundation, Inc. | |
63ffe5ef SC |
4 | Contributed by Cygnus Support. |
5 | ||
1fa5371e KR |
6 | ** NOTE: bfd.h and bfd-in2.h are GENERATED files. Don't change them; |
7 | ** instead, change bfd-in.h or the other BFD source files processed to | |
8 | ** generate these files. | |
9 | ||
63ffe5ef 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 | |
815179af | 24 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ |
63ffe5ef SC |
25 | |
26 | /* bfd.h -- The only header file required by users of the bfd library | |
27 | ||
00539ee3 JG |
28 | The bfd.h file is generated from bfd-in.h and various .c files; if you |
29 | change it, your changes will probably be lost. | |
63ffe5ef SC |
30 | |
31 | All the prototypes and definitions following the comment "THE FOLLOWING | |
32 | IS EXTRACTED FROM THE SOURCE" are extracted from the source files for | |
33 | BFD. If you change it, someone oneday will extract it from the source | |
34 | again, and your changes will be lost. To save yourself from this bind, | |
35 | change the definitions in the source in the bfd directory. Type "make | |
36 | docs" and then "make headers" in that directory, and magically this file | |
37 | will change to reflect your changes. | |
38 | ||
39 | If you don't have the tools to perform the extraction, then you are | |
40 | safe from someone on your system trampling over your header files. | |
41 | You should still maintain the equivalence between the source and this | |
42 | file though; every change you make to the .c file should be reflected | |
43 | here. */ | |
44 | ||
45 | #ifndef __BFD_H_SEEN__ | |
46 | #define __BFD_H_SEEN__ | |
47 | ||
815179af ILT |
48 | #ifdef __cplusplus |
49 | extern "C" { | |
50 | #endif | |
51 | ||
63ffe5ef | 52 | #include "ansidecl.h" |
63ffe5ef | 53 | |
9deaaaf1 | 54 | /* These two lines get substitutions done by commands in Makefile.in. */ |
b7577823 | 55 | #define BFD_VERSION "@VERSION@" |
f4e14cb9 | 56 | #define BFD_ARCH_SIZE @wordsize@ |
b7577823 | 57 | #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@ |
f4e14cb9 ILT |
58 | #if @BFD_HOST_64_BIT_DEFINED@ |
59 | #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@ | |
60 | #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@ | |
61 | #endif | |
034a8a56 KR |
62 | |
63 | #if BFD_ARCH_SIZE >= 64 | |
64 | #define BFD64 | |
65 | #endif | |
66 | ||
1fa5371e KR |
67 | #ifndef INLINE |
68 | #if __GNUC__ >= 2 | |
69 | #define INLINE __inline__ | |
70 | #else | |
71 | #define INLINE | |
72 | #endif | |
73 | #endif | |
74 | ||
63ffe5ef SC |
75 | /* forward declaration */ |
76 | typedef struct _bfd bfd; | |
77 | ||
034a8a56 KR |
78 | /* To squelch erroneous compiler warnings ("illegal pointer |
79 | combination") from the SVR3 compiler, we would like to typedef | |
80 | boolean to int (it doesn't like functions which return boolean. | |
81 | Making sure they are never implicitly declared to return int | |
82 | doesn't seem to help). But this file is not configured based on | |
83 | the host. */ | |
63ffe5ef SC |
84 | /* General rules: functions which are boolean return true on success |
85 | and false on failure (unless they're a predicate). -- bfd.doc */ | |
86 | /* I'm sure this is going to break something and someone is going to | |
87 | force me to change it. */ | |
f004165e JG |
88 | /* typedef enum boolean {false, true} boolean; */ |
89 | /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h> -fnf */ | |
442da995 | 90 | /* It gets worse if the host also defines a true/false enum... -sts */ |
3b1f83ad JL |
91 | /* And even worse if your compiler has built-in boolean types... -law */ |
92 | #if defined (__GNUG__) && (__GNUC_MINOR__ > 5) | |
93 | #define TRUE_FALSE_ALREADY_DEFINED | |
94 | #endif | |
54406786 ILT |
95 | #ifdef MPW |
96 | /* Pre-emptive strike - get the file with the enum. */ | |
97 | #include <Types.h> | |
98 | #define TRUE_FALSE_ALREADY_DEFINED | |
99 | #endif /* MPW */ | |
442da995 | 100 | #ifndef TRUE_FALSE_ALREADY_DEFINED |
f004165e | 101 | typedef enum bfd_boolean {false, true} boolean; |
442da995 SS |
102 | #define BFD_TRUE_FALSE |
103 | #else | |
e0151f38 SS |
104 | /* Use enum names that will appear nowhere else. */ |
105 | typedef enum bfd_boolean {bfd_fffalse, bfd_tttrue} boolean; | |
442da995 | 106 | #endif |
63ffe5ef | 107 | |
00539ee3 JG |
108 | /* A pointer to a position in a file. */ |
109 | /* FIXME: This should be using off_t from <sys/types.h>. | |
110 | For now, try to avoid breaking stuff by not including <sys/types.h> here. | |
111 | This will break on systems with 64-bit file offsets (e.g. 4.4BSD). | |
112 | Probably the best long-term answer is to avoid using file_ptr AND off_t | |
113 | in this header file, and to handle this in the BFD implementation | |
114 | rather than in its interface. */ | |
115 | /* typedef off_t file_ptr; */ | |
116 | typedef long int file_ptr; | |
63ffe5ef | 117 | |
3b1f83ad | 118 | /* Support for different sizes of target format ints and addresses. |
b7577823 ILT |
119 | If the type `long' is at least 64 bits, BFD_HOST_64BIT_LONG will be |
120 | set to 1 above. Otherwise, if gcc is being used, this code will | |
f4e14cb9 ILT |
121 | use gcc's "long long" type. Otherwise, BFD_HOST_64_BIT must be |
122 | defined above. */ | |
034a8a56 | 123 | |
b7577823 | 124 | #ifdef BFD64 |
034a8a56 | 125 | |
b7577823 ILT |
126 | #ifndef BFD_HOST_64_BIT |
127 | #if BFD_HOST_64BIT_LONG | |
128 | #define BFD_HOST_64_BIT long | |
f4e14cb9 | 129 | #define BFD_HOST_U_64_BIT unsigned long |
b7577823 ILT |
130 | #else |
131 | #ifdef __GNUC__ | |
9deaaaf1 | 132 | #define BFD_HOST_64_BIT long long |
f4e14cb9 ILT |
133 | #define BFD_HOST_U_64_BIT unsigned long long |
134 | #else /* ! defined (__GNUC__) */ | |
135 | #error No 64 bit integer type available | |
136 | #endif /* ! defined (__GNUC__) */ | |
b7577823 ILT |
137 | #endif /* ! BFD_HOST_64BIT_LONG */ |
138 | #endif /* ! defined (BFD_HOST_64_BIT) */ | |
1fa5371e | 139 | |
f4e14cb9 | 140 | typedef BFD_HOST_U_64_BIT bfd_vma; |
9deaaaf1 | 141 | typedef BFD_HOST_64_BIT bfd_signed_vma; |
f4e14cb9 ILT |
142 | typedef BFD_HOST_U_64_BIT bfd_size_type; |
143 | typedef BFD_HOST_U_64_BIT symvalue; | |
b7577823 | 144 | |
d110544c | 145 | #ifndef fprintf_vma |
b7577823 ILT |
146 | #if BFD_HOST_64BIT_LONG |
147 | #define sprintf_vma(s,x) sprintf (s, "%016lx", x) | |
148 | #define fprintf_vma(f,x) fprintf (f, "%016lx", x) | |
149 | #else | |
150 | #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff))) | |
151 | #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff)) | |
63ffe5ef | 152 | #define fprintf_vma(s,x) \ |
b7577823 | 153 | fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x)) |
1fa5371e | 154 | #define sprintf_vma(s,x) \ |
b7577823 | 155 | sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x)) |
d110544c | 156 | #endif |
b7577823 ILT |
157 | #endif |
158 | ||
034a8a56 | 159 | #else /* not BFD64 */ |
14e3c2e4 JK |
160 | |
161 | /* Represent a target address. Also used as a generic unsigned type | |
162 | which is guaranteed to be big enough to hold any arithmetic types | |
163 | we need to deal with. */ | |
63ffe5ef | 164 | typedef unsigned long bfd_vma; |
14e3c2e4 JK |
165 | |
166 | /* A generic signed type which is guaranteed to be big enough to hold any | |
167 | arithmetic types we need to deal with. Can be assumed to be compatible | |
168 | with bfd_vma in the same way that signed and unsigned ints are compatible | |
169 | (as parameters, in assignment, etc). */ | |
170 | typedef long bfd_signed_vma; | |
171 | ||
63ffe5ef SC |
172 | typedef unsigned long symvalue; |
173 | typedef unsigned long bfd_size_type; | |
14e3c2e4 JK |
174 | |
175 | /* Print a bfd_vma x on stream s. */ | |
63ffe5ef | 176 | #define fprintf_vma(s,x) fprintf(s, "%08lx", x) |
1fa5371e | 177 | #define sprintf_vma(s,x) sprintf(s, "%08lx", x) |
034a8a56 | 178 | #endif /* not BFD64 */ |
e98e6ec1 | 179 | #define printf_vma(x) fprintf_vma(stdout,x) |
63ffe5ef SC |
180 | |
181 | typedef unsigned int flagword; /* 32 bits of flags */ | |
3b1f83ad | 182 | typedef unsigned char bfd_byte; |
63ffe5ef SC |
183 | \f |
184 | /** File formats */ | |
185 | ||
186 | typedef enum bfd_format { | |
187 | bfd_unknown = 0, /* file format is unknown */ | |
188 | bfd_object, /* linker/assember/compiler output */ | |
189 | bfd_archive, /* object archive file */ | |
190 | bfd_core, /* core dump */ | |
191 | bfd_type_end} /* marks the end; don't use it! */ | |
192 | bfd_format; | |
193 | ||
8d12f138 ILT |
194 | /* Values that may appear in the flags field of a BFD. These also |
195 | appear in the object_flags field of the bfd_target structure, where | |
196 | they indicate the set of flags used by that backend (not all flags | |
197 | are meaningful for all object file formats) (FIXME: at the moment, | |
198 | the object_flags values have mostly just been copied from backend | |
199 | to another, and are not necessarily correct). */ | |
200 | ||
201 | /* No flags. */ | |
148437ec | 202 | #define BFD_NO_FLAGS 0x00 |
8d12f138 ILT |
203 | |
204 | /* BFD contains relocation entries. */ | |
294eaca4 | 205 | #define HAS_RELOC 0x01 |
8d12f138 ILT |
206 | |
207 | /* BFD is directly executable. */ | |
294eaca4 | 208 | #define EXEC_P 0x02 |
8d12f138 ILT |
209 | |
210 | /* BFD has line number information (basically used for F_LNNO in a | |
211 | COFF header). */ | |
294eaca4 | 212 | #define HAS_LINENO 0x04 |
8d12f138 ILT |
213 | |
214 | /* BFD has debugging information. */ | |
294eaca4 | 215 | #define HAS_DEBUG 0x08 |
8d12f138 ILT |
216 | |
217 | /* BFD has symbols. */ | |
294eaca4 | 218 | #define HAS_SYMS 0x10 |
8d12f138 ILT |
219 | |
220 | /* BFD has local symbols (basically used for F_LSYMS in a COFF | |
221 | header). */ | |
294eaca4 | 222 | #define HAS_LOCALS 0x20 |
8d12f138 ILT |
223 | |
224 | /* BFD is a dynamic object. */ | |
294eaca4 | 225 | #define DYNAMIC 0x40 |
8d12f138 ILT |
226 | |
227 | /* Text section is write protected (if D_PAGED is not set, this is | |
228 | like an a.out NMAGIC file) (the linker sets this by default, but | |
229 | clears it for -r or -N). */ | |
294eaca4 | 230 | #define WP_TEXT 0x80 |
8d12f138 ILT |
231 | |
232 | /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the | |
233 | linker sets this by default, but clears it for -r or -n or -N). */ | |
294eaca4 | 234 | #define D_PAGED 0x100 |
8d12f138 ILT |
235 | |
236 | /* BFD is relaxable (this means that bfd_relax_section may be able to | |
3b1f83ad JL |
237 | do something) (sometimes bfd_relax_section can do something even if |
238 | this is not set). */ | |
294eaca4 | 239 | #define BFD_IS_RELAXABLE 0x200 |
a7ff9b80 ILT |
240 | |
241 | /* This may be set before writing out a BFD to request using a | |
242 | traditional format. For example, this is used to request that when | |
243 | writing out an a.out object the symbols not be hashed to eliminate | |
244 | duplicates. */ | |
245 | #define BFD_TRADITIONAL_FORMAT 0x400 | |
64d5f5d0 ILT |
246 | |
247 | /* This flag indicates that the BFD contents are actually cached in | |
248 | memory. If this is set, iostream points to a bfd_in_memory struct. */ | |
249 | #define BFD_IN_MEMORY 0x800 | |
63ffe5ef SC |
250 | \f |
251 | /* symbols and relocation */ | |
252 | ||
0f8f509c | 253 | /* A count of carsyms (canonical archive symbols). */ |
63ffe5ef SC |
254 | typedef unsigned long symindex; |
255 | ||
3b1f83ad JL |
256 | /* How to perform a relocation. */ |
257 | typedef const struct reloc_howto_struct reloc_howto_type; | |
258 | ||
63ffe5ef SC |
259 | #define BFD_NO_MORE_SYMBOLS ((symindex) ~0) |
260 | ||
0f8f509c DM |
261 | /* General purpose part of a symbol X; |
262 | target specific parts are in libcoff.h, libaout.h, etc. */ | |
63ffe5ef SC |
263 | |
264 | #define bfd_get_section(x) ((x)->section) | |
265 | #define bfd_get_output_section(x) ((x)->section->output_section) | |
266 | #define bfd_set_section(x,y) ((x)->section) = (y) | |
0c2fae09 | 267 | #define bfd_asymbol_base(x) ((x)->section->vma) |
ec30dfba | 268 | #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value) |
63ffe5ef | 269 | #define bfd_asymbol_name(x) ((x)->name) |
0c2fae09 ILT |
270 | /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/ |
271 | #define bfd_asymbol_bfd(x) ((x)->the_bfd) | |
272 | #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour) | |
63ffe5ef | 273 | |
0f8f509c | 274 | /* A canonical archive symbol. */ |
63ffe5ef SC |
275 | /* This is a type pun with struct ranlib on purpose! */ |
276 | typedef struct carsym { | |
277 | char *name; | |
278 | file_ptr file_offset; /* look here to find the file */ | |
279 | } carsym; /* to make these you call a carsymogen */ | |
280 | ||
281 | ||
0f8f509c DM |
282 | /* Used in generating armaps (archive tables of contents). |
283 | Perhaps just a forward definition would do? */ | |
63ffe5ef SC |
284 | struct orl { /* output ranlib */ |
285 | char **name; /* symbol name */ | |
286 | file_ptr pos; /* bfd* or file position */ | |
287 | int namidx; /* index into string table */ | |
288 | }; | |
63ffe5ef SC |
289 | \f |
290 | ||
291 | /* Linenumber stuff */ | |
292 | typedef struct lineno_cache_entry { | |
293 | unsigned int line_number; /* Linenumber from start of function*/ | |
294 | union { | |
0f8f509c | 295 | struct symbol_cache_entry *sym; /* Function name */ |
63ffe5ef SC |
296 | unsigned long offset; /* Offset into section */ |
297 | } u; | |
298 | } alent; | |
299 | \f | |
300 | /* object and core file sections */ | |
301 | ||
63ffe5ef SC |
302 | #define align_power(addr, align) \ |
303 | ( ((addr) + ((1<<(align))-1)) & (-1 << (align))) | |
304 | ||
305 | typedef struct sec *sec_ptr; | |
306 | ||
294eaca4 SC |
307 | #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0) |
308 | #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0) | |
309 | #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0) | |
63ffe5ef | 310 | #define bfd_section_name(bfd, ptr) ((ptr)->name) |
e98e6ec1 | 311 | #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr)) |
63ffe5ef | 312 | #define bfd_section_vma(bfd, ptr) ((ptr)->vma) |
7d6d10f9 | 313 | #define bfd_section_lma(bfd, ptr) ((ptr)->lma) |
63ffe5ef | 314 | #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power) |
294eaca4 | 315 | #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0) |
63ffe5ef SC |
316 | #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata) |
317 | ||
ec30dfba JG |
318 | #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0) |
319 | ||
e0151f38 | 320 | #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = (boolean)true), true) |
6167a840 JL |
321 | #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true) |
322 | #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true) | |
63ffe5ef SC |
323 | |
324 | typedef struct stat stat_type; | |
325 | \f | |
63ffe5ef SC |
326 | typedef enum bfd_print_symbol |
327 | { | |
cbdc7909 JG |
328 | bfd_print_symbol_name, |
329 | bfd_print_symbol_more, | |
034a8a56 | 330 | bfd_print_symbol_all |
cbdc7909 | 331 | } bfd_print_symbol_type; |
63ffe5ef | 332 | |
034a8a56 KR |
333 | /* Information about a symbol that nm needs. */ |
334 | ||
335 | typedef struct _symbol_info | |
336 | { | |
337 | symvalue value; | |
0f8f509c | 338 | char type; |
034a8a56 | 339 | CONST char *name; /* Symbol name. */ |
64d5f5d0 ILT |
340 | unsigned char stab_type; /* Stab type. */ |
341 | char stab_other; /* Stab other. */ | |
342 | short stab_desc; /* Stab desc. */ | |
343 | CONST char *stab_name; /* String for stab type. */ | |
034a8a56 | 344 | } symbol_info; |
f4e14cb9 ILT |
345 | |
346 | /* Get the name of a stabs type code. */ | |
347 | ||
348 | extern const char *bfd_get_stab_name PARAMS ((int)); | |
63ffe5ef | 349 | \f |
4c3721d5 ILT |
350 | /* Hash table routines. There is no way to free up a hash table. */ |
351 | ||
352 | /* An element in the hash table. Most uses will actually use a larger | |
353 | structure, and an instance of this will be the first field. */ | |
354 | ||
355 | struct bfd_hash_entry | |
356 | { | |
357 | /* Next entry for this hash code. */ | |
358 | struct bfd_hash_entry *next; | |
359 | /* String being hashed. */ | |
360 | const char *string; | |
361 | /* Hash code. This is the full hash code, not the index into the | |
362 | table. */ | |
363 | unsigned long hash; | |
364 | }; | |
365 | ||
366 | /* A hash table. */ | |
367 | ||
368 | struct bfd_hash_table | |
369 | { | |
370 | /* The hash array. */ | |
371 | struct bfd_hash_entry **table; | |
372 | /* The number of slots in the hash table. */ | |
373 | unsigned int size; | |
374 | /* A function used to create new elements in the hash table. The | |
375 | first entry is itself a pointer to an element. When this | |
376 | function is first invoked, this pointer will be NULL. However, | |
377 | having the pointer permits a hierarchy of method functions to be | |
378 | built each of which calls the function in the superclass. Thus | |
379 | each function should be written to allocate a new block of memory | |
380 | only if the argument is NULL. */ | |
381 | struct bfd_hash_entry *(*newfunc) PARAMS ((struct bfd_hash_entry *, | |
382 | struct bfd_hash_table *, | |
383 | const char *)); | |
7d6d10f9 NC |
384 | /* An objalloc for this hash table. This is a struct objalloc *, |
385 | but we use PTR to avoid requiring the inclusion of objalloc.h. */ | |
386 | PTR memory; | |
4c3721d5 ILT |
387 | }; |
388 | ||
389 | /* Initialize a hash table. */ | |
390 | extern boolean bfd_hash_table_init | |
391 | PARAMS ((struct bfd_hash_table *, | |
392 | struct bfd_hash_entry *(*) (struct bfd_hash_entry *, | |
393 | struct bfd_hash_table *, | |
394 | const char *))); | |
395 | ||
396 | /* Initialize a hash table specifying a size. */ | |
397 | extern boolean bfd_hash_table_init_n | |
398 | PARAMS ((struct bfd_hash_table *, | |
399 | struct bfd_hash_entry *(*) (struct bfd_hash_entry *, | |
400 | struct bfd_hash_table *, | |
401 | const char *), | |
402 | unsigned int size)); | |
403 | ||
404 | /* Free up a hash table. */ | |
405 | extern void bfd_hash_table_free PARAMS ((struct bfd_hash_table *)); | |
406 | ||
407 | /* Look up a string in a hash table. If CREATE is true, a new entry | |
408 | will be created for this string if one does not already exist. The | |
409 | COPY argument must be true if this routine should copy the string | |
410 | into newly allocated memory when adding an entry. */ | |
411 | extern struct bfd_hash_entry *bfd_hash_lookup | |
412 | PARAMS ((struct bfd_hash_table *, const char *, boolean create, | |
413 | boolean copy)); | |
414 | ||
b7577823 ILT |
415 | /* Replace an entry in a hash table. */ |
416 | extern void bfd_hash_replace | |
417 | PARAMS ((struct bfd_hash_table *, struct bfd_hash_entry *old, | |
418 | struct bfd_hash_entry *nw)); | |
419 | ||
4c3721d5 ILT |
420 | /* Base method for creating a hash table entry. */ |
421 | extern struct bfd_hash_entry *bfd_hash_newfunc | |
422 | PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, | |
423 | const char *)); | |
424 | ||
425 | /* Grab some space for a hash table entry. */ | |
966e0a16 ILT |
426 | extern PTR bfd_hash_allocate PARAMS ((struct bfd_hash_table *, |
427 | unsigned int)); | |
4c3721d5 ILT |
428 | |
429 | /* Traverse a hash table in a random order, calling a function on each | |
430 | element. If the function returns false, the traversal stops. The | |
431 | INFO argument is passed to the function. */ | |
432 | extern void bfd_hash_traverse PARAMS ((struct bfd_hash_table *, | |
433 | boolean (*) (struct bfd_hash_entry *, | |
434 | PTR), | |
435 | PTR info)); | |
436 | \f | |
1fa5371e KR |
437 | /* Semi-portable string concatenation in cpp. |
438 | The CAT4 hack is to avoid a problem with some strict ANSI C preprocessors. | |
439 | The problem is, "32_" is not a valid preprocessing token, and we don't | |
440 | want extra underscores (e.g., "nlm_32_"). The XCAT2 macro will cause the | |
441 | inner CAT macros to be evaluated first, producing still-valid pp-tokens. | |
442 | Then the final concatenation can be done. (Sigh.) */ | |
63ffe5ef | 443 | #ifndef CAT |
1fa5371e KR |
444 | #ifdef SABER |
445 | #define CAT(a,b) a##b | |
446 | #define CAT3(a,b,c) a##b##c | |
447 | #define CAT4(a,b,c,d) a##b##c##d | |
448 | #else | |
442da995 | 449 | #if defined(__STDC__) || defined(ALMOST_STDC) |
63ffe5ef | 450 | #define CAT(a,b) a##b |
034a8a56 | 451 | #define CAT3(a,b,c) a##b##c |
1fa5371e KR |
452 | #define XCAT2(a,b) CAT(a,b) |
453 | #define CAT4(a,b,c,d) XCAT2(CAT(a,b),CAT(c,d)) | |
63ffe5ef SC |
454 | #else |
455 | #define CAT(a,b) a/**/b | |
034a8a56 | 456 | #define CAT3(a,b,c) a/**/b/**/c |
1fa5371e KR |
457 | #define CAT4(a,b,c,d) a/**/b/**/c/**/d |
458 | #endif | |
63ffe5ef SC |
459 | #endif |
460 | #endif | |
461 | ||
0c2fae09 | 462 | #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table |
63ffe5ef SC |
463 | \f |
464 | /* User program access to BFD facilities */ | |
465 | ||
3b1f83ad JL |
466 | /* Direct I/O routines, for programs which know more about the object |
467 | file than BFD does. Use higher level routines if possible. */ | |
468 | ||
469 | extern bfd_size_type bfd_read | |
470 | PARAMS ((PTR, bfd_size_type size, bfd_size_type nitems, bfd *abfd)); | |
471 | extern bfd_size_type bfd_write | |
472 | PARAMS ((const PTR, bfd_size_type size, bfd_size_type nitems, bfd *abfd)); | |
473 | extern int bfd_seek PARAMS ((bfd *abfd, file_ptr fp, int direction)); | |
474 | extern long bfd_tell PARAMS ((bfd *abfd)); | |
475 | extern int bfd_flush PARAMS ((bfd *abfd)); | |
476 | extern int bfd_stat PARAMS ((bfd *abfd, struct stat *)); | |
477 | ||
b176e1e9 | 478 | |
63ffe5ef SC |
479 | /* Cast from const char * to char * so that caller can assign to |
480 | a char * without a warning. */ | |
481 | #define bfd_get_filename(abfd) ((char *) (abfd)->filename) | |
8d12f138 | 482 | #define bfd_get_cacheable(abfd) ((abfd)->cacheable) |
63ffe5ef SC |
483 | #define bfd_get_format(abfd) ((abfd)->format) |
484 | #define bfd_get_target(abfd) ((abfd)->xvec->name) | |
8d12f138 | 485 | #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour) |
64d5f5d0 ILT |
486 | #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG) |
487 | #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE) | |
488 | #define bfd_header_big_endian(abfd) \ | |
489 | ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG) | |
490 | #define bfd_header_little_endian(abfd) \ | |
491 | ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE) | |
63ffe5ef SC |
492 | #define bfd_get_file_flags(abfd) ((abfd)->flags) |
493 | #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags) | |
494 | #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags) | |
e98e6ec1 | 495 | #define bfd_my_archive(abfd) ((abfd)->my_archive) |
63ffe5ef | 496 | #define bfd_has_map(abfd) ((abfd)->has_armap) |
63ffe5ef SC |
497 | |
498 | #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types) | |
499 | #define bfd_usrdata(abfd) ((abfd)->usrdata) | |
500 | ||
501 | #define bfd_get_start_address(abfd) ((abfd)->start_address) | |
502 | #define bfd_get_symcount(abfd) ((abfd)->symcount) | |
503 | #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols) | |
504 | #define bfd_count_sections(abfd) ((abfd)->section_count) | |
63ffe5ef | 505 | |
294eaca4 | 506 | #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char) |
63ffe5ef | 507 | |
e0151f38 | 508 | #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (boolean)(bool)), true) |
8d12f138 | 509 | |
ae0a6bea ILT |
510 | extern boolean bfd_record_phdr |
511 | PARAMS ((bfd *, unsigned long, boolean, flagword, boolean, bfd_vma, | |
512 | boolean, boolean, unsigned int, struct sec **)); | |
513 | ||
8d12f138 ILT |
514 | /* Byte swapping routines. */ |
515 | ||
1a973af1 ILT |
516 | bfd_vma bfd_getb64 PARAMS ((const unsigned char *)); |
517 | bfd_vma bfd_getl64 PARAMS ((const unsigned char *)); | |
518 | bfd_signed_vma bfd_getb_signed_64 PARAMS ((const unsigned char *)); | |
519 | bfd_signed_vma bfd_getl_signed_64 PARAMS ((const unsigned char *)); | |
520 | bfd_vma bfd_getb32 PARAMS ((const unsigned char *)); | |
521 | bfd_vma bfd_getl32 PARAMS ((const unsigned char *)); | |
522 | bfd_signed_vma bfd_getb_signed_32 PARAMS ((const unsigned char *)); | |
523 | bfd_signed_vma bfd_getl_signed_32 PARAMS ((const unsigned char *)); | |
524 | bfd_vma bfd_getb16 PARAMS ((const unsigned char *)); | |
525 | bfd_vma bfd_getl16 PARAMS ((const unsigned char *)); | |
526 | bfd_signed_vma bfd_getb_signed_16 PARAMS ((const unsigned char *)); | |
527 | bfd_signed_vma bfd_getl_signed_16 PARAMS ((const unsigned char *)); | |
8d12f138 ILT |
528 | void bfd_putb64 PARAMS ((bfd_vma, unsigned char *)); |
529 | void bfd_putl64 PARAMS ((bfd_vma, unsigned char *)); | |
530 | void bfd_putb32 PARAMS ((bfd_vma, unsigned char *)); | |
531 | void bfd_putl32 PARAMS ((bfd_vma, unsigned char *)); | |
532 | void bfd_putb16 PARAMS ((bfd_vma, unsigned char *)); | |
533 | void bfd_putl16 PARAMS ((bfd_vma, unsigned char *)); | |
013dec1a ILT |
534 | \f |
535 | /* Externally visible ECOFF routines. */ | |
8d12f138 | 536 | |
442da995 | 537 | #if defined(__STDC__) || defined(ALMOST_STDC) |
8d12f138 ILT |
538 | struct ecoff_debug_info; |
539 | struct ecoff_debug_swap; | |
540 | struct ecoff_extr; | |
541 | struct symbol_cache_entry; | |
d110544c | 542 | struct bfd_link_info; |
28a0c103 | 543 | struct bfd_link_hash_entry; |
7d6d10f9 | 544 | struct bfd_elf_version_tree; |
8d12f138 | 545 | #endif |
013dec1a ILT |
546 | extern bfd_vma bfd_ecoff_get_gp_value PARAMS ((bfd * abfd)); |
547 | extern boolean bfd_ecoff_set_gp_value PARAMS ((bfd *abfd, bfd_vma gp_value)); | |
548 | extern boolean bfd_ecoff_set_regmasks | |
549 | PARAMS ((bfd *abfd, unsigned long gprmask, unsigned long fprmask, | |
550 | unsigned long *cprmask)); | |
d110544c | 551 | extern PTR bfd_ecoff_debug_init |
8d12f138 | 552 | PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug, |
d110544c KR |
553 | const struct ecoff_debug_swap *output_swap, |
554 | struct bfd_link_info *)); | |
555 | extern void bfd_ecoff_debug_free | |
556 | PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug, | |
557 | const struct ecoff_debug_swap *output_swap, | |
558 | struct bfd_link_info *)); | |
559 | extern boolean bfd_ecoff_debug_accumulate | |
560 | PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug, | |
8d12f138 ILT |
561 | const struct ecoff_debug_swap *output_swap, |
562 | bfd *input_bfd, struct ecoff_debug_info *input_debug, | |
563 | const struct ecoff_debug_swap *input_swap, | |
d110544c KR |
564 | struct bfd_link_info *)); |
565 | extern boolean bfd_ecoff_debug_accumulate_other | |
566 | PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug, | |
567 | const struct ecoff_debug_swap *output_swap, bfd *input_bfd, | |
568 | struct bfd_link_info *)); | |
8d12f138 ILT |
569 | extern boolean bfd_ecoff_debug_externals |
570 | PARAMS ((bfd *abfd, struct ecoff_debug_info *debug, | |
571 | const struct ecoff_debug_swap *swap, | |
572 | boolean relocateable, | |
573 | boolean (*get_extr) (struct symbol_cache_entry *, | |
574 | struct ecoff_extr *), | |
575 | void (*set_index) (struct symbol_cache_entry *, | |
576 | bfd_size_type))); | |
966e0a16 ILT |
577 | extern boolean bfd_ecoff_debug_one_external |
578 | PARAMS ((bfd *abfd, struct ecoff_debug_info *debug, | |
579 | const struct ecoff_debug_swap *swap, | |
580 | const char *name, struct ecoff_extr *esym)); | |
8d12f138 ILT |
581 | extern bfd_size_type bfd_ecoff_debug_size |
582 | PARAMS ((bfd *abfd, struct ecoff_debug_info *debug, | |
583 | const struct ecoff_debug_swap *swap)); | |
584 | extern boolean bfd_ecoff_write_debug | |
585 | PARAMS ((bfd *abfd, struct ecoff_debug_info *debug, | |
586 | const struct ecoff_debug_swap *swap, file_ptr where)); | |
d110544c KR |
587 | extern boolean bfd_ecoff_write_accumulated_debug |
588 | PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug, | |
589 | const struct ecoff_debug_swap *swap, | |
590 | struct bfd_link_info *info, file_ptr where)); | |
3b1f83ad JL |
591 | extern boolean bfd_mips_ecoff_create_embedded_relocs |
592 | PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *, | |
593 | char **)); | |
63ffe5ef | 594 | |
013dec1a ILT |
595 | /* Externally visible ELF routines. */ |
596 | ||
54406786 | 597 | struct bfd_link_needed_list |
b176e1e9 | 598 | { |
54406786 | 599 | struct bfd_link_needed_list *next; |
b176e1e9 ILT |
600 | bfd *by; |
601 | const char *name; | |
602 | }; | |
54406786 ILT |
603 | |
604 | extern boolean bfd_elf32_record_link_assignment | |
605 | PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean)); | |
606 | extern boolean bfd_elf64_record_link_assignment | |
607 | PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean)); | |
608 | extern struct bfd_link_needed_list *bfd_elf_get_needed_list | |
b176e1e9 | 609 | PARAMS ((bfd *, struct bfd_link_info *)); |
7c511326 NC |
610 | extern boolean bfd_elf_get_bfd_needed_list |
611 | PARAMS ((bfd *, struct bfd_link_needed_list **)); | |
013dec1a | 612 | extern boolean bfd_elf32_size_dynamic_sections |
148437ec | 613 | PARAMS ((bfd *, const char *, const char *, boolean, const char *, |
7d6d10f9 NC |
614 | const char * const *, struct bfd_link_info *, struct sec **, |
615 | struct bfd_elf_version_tree *)); | |
013dec1a | 616 | extern boolean bfd_elf64_size_dynamic_sections |
148437ec | 617 | PARAMS ((bfd *, const char *, const char *, boolean, const char *, |
7d6d10f9 NC |
618 | const char * const *, struct bfd_link_info *, struct sec **, |
619 | struct bfd_elf_version_tree *)); | |
c1f84521 | 620 | extern void bfd_elf_set_dt_needed_name PARAMS ((bfd *, const char *)); |
f4e14cb9 | 621 | extern const char *bfd_elf_get_dt_soname PARAMS ((bfd *)); |
013dec1a | 622 | |
a7ff9b80 ILT |
623 | /* SunOS shared library support routines for the linker. */ |
624 | ||
28a0c103 ILT |
625 | extern struct bfd_link_needed_list *bfd_sunos_get_needed_list |
626 | PARAMS ((bfd *, struct bfd_link_info *)); | |
a7ff9b80 ILT |
627 | extern boolean bfd_sunos_record_link_assignment |
628 | PARAMS ((bfd *, struct bfd_link_info *, const char *)); | |
629 | extern boolean bfd_sunos_size_dynamic_sections | |
630 | PARAMS ((bfd *, struct bfd_link_info *, struct sec **, struct sec **, | |
631 | struct sec **)); | |
632 | ||
3b1f83ad JL |
633 | /* Linux shared library support routines for the linker. */ |
634 | ||
f4e14cb9 ILT |
635 | extern boolean bfd_i386linux_size_dynamic_sections |
636 | PARAMS ((bfd *, struct bfd_link_info *)); | |
637 | extern boolean bfd_m68klinux_size_dynamic_sections | |
3b1f83ad | 638 | PARAMS ((bfd *, struct bfd_link_info *)); |
7d6d10f9 NC |
639 | extern boolean bfd_sparclinux_size_dynamic_sections |
640 | PARAMS ((bfd *, struct bfd_link_info *)); | |
3b1f83ad | 641 | |
4fe6d901 KR |
642 | /* mmap hacks */ |
643 | ||
644 | struct _bfd_window_internal; | |
645 | typedef struct _bfd_window_internal bfd_window_internal; | |
646 | ||
647 | typedef struct _bfd_window { | |
648 | /* What the user asked for. */ | |
649 | PTR data; | |
650 | bfd_size_type size; | |
651 | /* The actual window used by BFD. Small user-requested read-only | |
652 | regions sharing a page may share a single window into the object | |
653 | file. Read-write versions shouldn't until I've fixed things to | |
654 | keep track of which portions have been claimed by the | |
655 | application; don't want to give the same region back when the | |
656 | application wants two writable copies! */ | |
657 | struct _bfd_window_internal *i; | |
658 | } bfd_window; | |
659 | ||
092abcdf ILT |
660 | extern void bfd_init_window PARAMS ((bfd_window *)); |
661 | extern void bfd_free_window PARAMS ((bfd_window *)); | |
662 | extern boolean bfd_get_file_window | |
0bb8ff19 | 663 | PARAMS ((bfd *, file_ptr, bfd_size_type, bfd_window *, boolean)); |
4fe6d901 | 664 | |
28a0c103 ILT |
665 | /* XCOFF support routines for the linker. */ |
666 | ||
2d7de17d ILT |
667 | extern boolean bfd_xcoff_link_record_set |
668 | PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, | |
669 | bfd_size_type)); | |
28a0c103 ILT |
670 | extern boolean bfd_xcoff_import_symbol |
671 | PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, | |
672 | bfd_vma, const char *, const char *, const char *)); | |
673 | extern boolean bfd_xcoff_export_symbol | |
674 | PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, | |
675 | boolean)); | |
2d7de17d ILT |
676 | extern boolean bfd_xcoff_link_count_reloc |
677 | PARAMS ((bfd *, struct bfd_link_info *, const char *)); | |
678 | extern boolean bfd_xcoff_record_link_assignment | |
679 | PARAMS ((bfd *, struct bfd_link_info *, const char *)); | |
28a0c103 ILT |
680 | extern boolean bfd_xcoff_size_dynamic_sections |
681 | PARAMS ((bfd *, struct bfd_link_info *, const char *, const char *, | |
682 | unsigned long, unsigned long, unsigned long, boolean, | |
4a4a66bd | 683 | int, boolean, boolean, struct sec **)); |
28a0c103 | 684 | |
f4e14cb9 ILT |
685 | /* Externally visible COFF routines. */ |
686 | ||
687 | #if defined(__STDC__) || defined(ALMOST_STDC) | |
688 | struct internal_syment; | |
689 | union internal_auxent; | |
690 | #endif | |
691 | ||
692 | extern boolean bfd_coff_get_syment | |
693 | PARAMS ((bfd *, struct symbol_cache_entry *, struct internal_syment *)); | |
7c511326 | 694 | |
f4e14cb9 ILT |
695 | extern boolean bfd_coff_get_auxent |
696 | PARAMS ((bfd *, struct symbol_cache_entry *, int, union internal_auxent *)); | |
697 | ||
7c511326 NC |
698 | extern boolean bfd_arm_set_symbol_class |
699 | PARAMS ((bfd *, struct symbol_cache_entry *, unsigned char)); | |
700 | ||
7d6d10f9 NC |
701 | /* ARM Interworking support. Called from linker. */ |
702 | extern boolean bfd_arm_allocate_interworking_sections | |
703 | PARAMS ((struct bfd_link_info *)); | |
704 | ||
705 | extern boolean bfd_arm_process_before_allocation | |
7c511326 | 706 | PARAMS ((bfd *, struct bfd_link_info *, int)); |
7d6d10f9 NC |
707 | |
708 | extern boolean bfd_arm_get_bfd_for_interworking | |
709 | PARAMS ((bfd *, struct bfd_link_info *)); | |
710 | ||
294eaca4 | 711 | /* And more from the source. */ |