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