Remove fake operand handling for extended mnemonics.
[binutils-gdb.git] / bfd / bfd-in.h
blob481587e458f1ce8f1d5164f114a5a22009ac295d
1 /* Main header file for the bfd library -- portable access to object files.
3 Copyright (C) 1990-2018 Free Software Foundation, Inc.
5 Contributed 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 3 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., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
23 #ifndef __BFD_H_SEEN__
24 #define __BFD_H_SEEN__
26 /* PR 14072: Ensure that config.h is included first. */
27 #if !defined PACKAGE && !defined PACKAGE_VERSION
28 #error config.h must be included before this header
29 #endif
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
35 #include "ansidecl.h"
36 #include "symcat.h"
37 #include <stdarg.h>
38 #include <sys/stat.h>
40 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
41 #ifndef SABER
42 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
43 The problem is, "32_" is not a valid preprocessing token, and we don't
44 want extra underscores (e.g., "nlm_32_"). The XCONCAT2 macro will
45 cause the inner CONCAT2 macros to be evaluated first, producing
46 still-valid pp-tokens. Then the final concatenation can be done. */
47 #undef CONCAT4
48 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
49 #endif
50 #endif
52 /* This is a utility macro to handle the situation where the code
53 wants to place a constant string into the code, followed by a
54 comma and then the length of the string. Doing this by hand
55 is error prone, so using this macro is safer. */
56 #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)
57 /* Unfortunately it is not possible to use the STRING_COMMA_LEN macro
58 to create the arguments to another macro, since the preprocessor
59 will mis-count the number of arguments to the outer macro (by not
60 evaluating STRING_COMMA_LEN and so missing the comma). This is a
61 problem for example when trying to use STRING_COMMA_LEN to build
62 the arguments to the strncmp() macro. Hence this alternative
63 definition of strncmp is provided here.
65 Note - these macros do NOT work if STR2 is not a constant string. */
66 #define CONST_STRNEQ(STR1,STR2) (strncmp ((STR1), (STR2), sizeof (STR2) - 1) == 0)
67 /* strcpy() can have a similar problem, but since we know we are
68 copying a constant string, we can use memcpy which will be faster
69 since there is no need to check for a NUL byte inside STR. We
70 can also save time if we do not need to copy the terminating NUL. */
71 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1)
72 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2))
75 #define BFD_SUPPORTS_PLUGINS @supports_plugins@
77 /* The word size used by BFD on the host. This may be 64 with a 32
78 bit target if the host is 64 bit, or if other 64 bit targets have
79 been selected with --enable-targets, or if --enable-64-bit-bfd. */
80 #define BFD_ARCH_SIZE @wordsize@
82 /* The word size of the default bfd target. */
83 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
85 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
86 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@
87 #if @BFD_HOST_64_BIT_DEFINED@
88 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
89 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
90 typedef BFD_HOST_64_BIT bfd_int64_t;
91 typedef BFD_HOST_U_64_BIT bfd_uint64_t;
92 #endif
94 #ifdef HAVE_INTTYPES_H
95 # include <inttypes.h>
96 #else
97 # if BFD_HOST_64BIT_LONG
98 # define BFD_PRI64 "l"
99 # elif defined (__MSVCRT__)
100 # define BFD_PRI64 "I64"
101 # else
102 # define BFD_PRI64 "ll"
103 # endif
104 # undef PRId64
105 # define PRId64 BFD_PRI64 "d"
106 # undef PRIu64
107 # define PRIu64 BFD_PRI64 "u"
108 # undef PRIx64
109 # define PRIx64 BFD_PRI64 "x"
110 #endif
112 #if BFD_ARCH_SIZE >= 64
113 #define BFD64
114 #endif
116 #ifndef INLINE
117 #if __GNUC__ >= 2
118 #define INLINE __inline__
119 #else
120 #define INLINE
121 #endif
122 #endif
124 /* Declaring a type wide enough to hold a host long and a host pointer. */
125 #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@
126 typedef BFD_HOSTPTR_T bfd_hostptr_t;
128 /* Forward declaration. */
129 typedef struct bfd bfd;
131 /* Boolean type used in bfd. Too many systems define their own
132 versions of "boolean" for us to safely typedef a "boolean" of
133 our own. Using an enum for "bfd_boolean" has its own set of
134 problems, with strange looking casts required to avoid warnings
135 on some older compilers. Thus we just use an int.
137 General rule: Functions which are bfd_boolean return TRUE on
138 success and FALSE on failure (unless they're a predicate). */
140 typedef int bfd_boolean;
141 #undef FALSE
142 #undef TRUE
143 #define FALSE 0
144 #define TRUE 1
146 #ifdef BFD64
148 #ifndef BFD_HOST_64_BIT
149 #error No 64 bit integer type available
150 #endif /* ! defined (BFD_HOST_64_BIT) */
152 typedef BFD_HOST_U_64_BIT bfd_vma;
153 typedef BFD_HOST_64_BIT bfd_signed_vma;
154 typedef BFD_HOST_U_64_BIT bfd_size_type;
155 typedef BFD_HOST_U_64_BIT symvalue;
157 #if BFD_HOST_64BIT_LONG
158 #define BFD_VMA_FMT "l"
159 #elif defined (__MSVCRT__)
160 #define BFD_VMA_FMT "I64"
161 #else
162 #define BFD_VMA_FMT "ll"
163 #endif
165 #ifndef fprintf_vma
166 #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x)
167 #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x)
168 #endif
170 #else /* not BFD64 */
172 /* Represent a target address. Also used as a generic unsigned type
173 which is guaranteed to be big enough to hold any arithmetic types
174 we need to deal with. */
175 typedef unsigned long bfd_vma;
177 /* A generic signed type which is guaranteed to be big enough to hold any
178 arithmetic types we need to deal with. Can be assumed to be compatible
179 with bfd_vma in the same way that signed and unsigned ints are compatible
180 (as parameters, in assignment, etc). */
181 typedef long bfd_signed_vma;
183 typedef unsigned long symvalue;
184 typedef unsigned long bfd_size_type;
186 /* Print a bfd_vma x on stream s. */
187 #define BFD_VMA_FMT "l"
188 #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x)
189 #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", x)
191 #endif /* not BFD64 */
193 #define HALF_BFD_SIZE_TYPE \
194 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
196 #ifndef BFD_HOST_64_BIT
197 /* Fall back on a 32 bit type. The idea is to make these types always
198 available for function return types, but in the case that
199 BFD_HOST_64_BIT is undefined such a function should abort or
200 otherwise signal an error. */
201 typedef bfd_signed_vma bfd_int64_t;
202 typedef bfd_vma bfd_uint64_t;
203 #endif
205 /* An offset into a file. BFD always uses the largest possible offset
206 based on the build time availability of fseek, fseeko, or fseeko64. */
207 typedef @bfd_file_ptr@ file_ptr;
208 typedef unsigned @bfd_file_ptr@ ufile_ptr;
210 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
211 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
213 #define printf_vma(x) fprintf_vma(stdout,x)
214 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
216 typedef unsigned int flagword; /* 32 bits of flags */
217 typedef unsigned char bfd_byte;
219 /* File formats. */
221 typedef enum bfd_format
223 bfd_unknown = 0, /* File format is unknown. */
224 bfd_object, /* Linker/assembler/compiler output. */
225 bfd_archive, /* Object archive file. */
226 bfd_core, /* Core dump. */
227 bfd_type_end /* Marks the end; don't use it! */
229 bfd_format;
231 /* Symbols and relocation. */
233 /* A count of carsyms (canonical archive symbols). */
234 typedef unsigned long symindex;
236 /* How to perform a relocation. */
237 typedef const struct reloc_howto_struct reloc_howto_type;
239 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
241 /* General purpose part of a symbol X;
242 target specific parts are in libcoff.h, libaout.h, etc. */
244 #define bfd_get_section(x) ((x)->section)
245 #define bfd_get_output_section(x) ((x)->section->output_section)
246 #define bfd_set_section(x,y) ((x)->section) = (y)
247 #define bfd_asymbol_base(x) ((x)->section->vma)
248 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
249 #define bfd_asymbol_name(x) ((x)->name)
250 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
251 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
252 #define bfd_asymbol_flavour(x) \
253 (((x)->flags & BSF_SYNTHETIC) != 0 \
254 ? bfd_target_unknown_flavour \
255 : bfd_asymbol_bfd (x)->xvec->flavour)
257 /* A canonical archive symbol. */
258 /* This is a type pun with struct ranlib on purpose! */
259 typedef struct carsym
261 char *name;
262 file_ptr file_offset; /* Look here to find the file. */
264 carsym; /* To make these you call a carsymogen. */
266 /* Used in generating armaps (archive tables of contents).
267 Perhaps just a forward definition would do? */
268 struct orl /* Output ranlib. */
270 char **name; /* Symbol name. */
271 union
273 file_ptr pos;
274 bfd *abfd;
275 } u; /* bfd* or file position. */
276 int namidx; /* Index into string table. */
279 /* Linenumber stuff. */
280 typedef struct lineno_cache_entry
282 unsigned int line_number; /* Linenumber from start of function. */
283 union
285 struct bfd_symbol *sym; /* Function name. */
286 bfd_vma offset; /* Offset into section. */
287 } u;
289 alent;
291 /* Object and core file sections. */
292 typedef struct bfd_section *sec_ptr;
294 #define align_power(addr, align) \
295 (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
297 /* Align an address upward to a boundary, expressed as a number of bytes.
298 E.g. align to an 8-byte boundary with argument of 8. Take care never
299 to wrap around if the address is within boundary-1 of the end of the
300 address space. */
301 #define BFD_ALIGN(this, boundary) \
302 ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this)) \
303 ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
304 : ~ (bfd_vma) 0)
306 #define bfd_get_section_name(bfd, ptr) ((void) bfd, (ptr)->name)
307 #define bfd_get_section_vma(bfd, ptr) ((void) bfd, (ptr)->vma)
308 #define bfd_get_section_lma(bfd, ptr) ((void) bfd, (ptr)->lma)
309 #define bfd_get_section_alignment(bfd, ptr) ((void) bfd, \
310 (ptr)->alignment_power)
311 #define bfd_section_name(bfd, ptr) ((ptr)->name)
312 #define bfd_section_size(bfd, ptr) ((ptr)->size)
313 #define bfd_get_section_size(ptr) ((ptr)->size)
314 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
315 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
316 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
317 #define bfd_get_section_flags(bfd, ptr) ((void) bfd, (ptr)->flags)
318 #define bfd_get_section_userdata(bfd, ptr) ((void) bfd, (ptr)->userdata)
320 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
322 #define bfd_get_section_limit_octets(bfd, sec) \
323 ((bfd)->direction != write_direction && (sec)->rawsize != 0 \
324 ? (sec)->rawsize : (sec)->size)
326 /* Find the address one past the end of SEC. */
327 #define bfd_get_section_limit(bfd, sec) \
328 (bfd_get_section_limit_octets(bfd, sec) / bfd_octets_per_byte (bfd))
330 /* Return TRUE if input section SEC has been discarded. */
331 #define discarded_section(sec) \
332 (!bfd_is_abs_section (sec) \
333 && bfd_is_abs_section ((sec)->output_section) \
334 && (sec)->sec_info_type != SEC_INFO_TYPE_MERGE \
335 && (sec)->sec_info_type != SEC_INFO_TYPE_JUST_SYMS)
337 typedef enum bfd_print_symbol
339 bfd_print_symbol_name,
340 bfd_print_symbol_more,
341 bfd_print_symbol_all
342 } bfd_print_symbol_type;
344 /* Information about a symbol that nm needs. */
346 typedef struct _symbol_info
348 symvalue value;
349 char type;
350 const char *name; /* Symbol name. */
351 unsigned char stab_type; /* Stab type. */
352 char stab_other; /* Stab other. */
353 short stab_desc; /* Stab desc. */
354 const char *stab_name; /* String for stab type. */
355 } symbol_info;
357 /* Get the name of a stabs type code. */
359 extern const char *bfd_get_stab_name (int);
361 /* Hash table routines. There is no way to free up a hash table. */
363 /* An element in the hash table. Most uses will actually use a larger
364 structure, and an instance of this will be the first field. */
366 struct bfd_hash_entry
368 /* Next entry for this hash code. */
369 struct bfd_hash_entry *next;
370 /* String being hashed. */
371 const char *string;
372 /* Hash code. This is the full hash code, not the index into the
373 table. */
374 unsigned long hash;
377 /* A hash table. */
379 struct bfd_hash_table
381 /* The hash array. */
382 struct bfd_hash_entry **table;
383 /* A function used to create new elements in the hash table. The
384 first entry is itself a pointer to an element. When this
385 function is first invoked, this pointer will be NULL. However,
386 having the pointer permits a hierarchy of method functions to be
387 built each of which calls the function in the superclass. Thus
388 each function should be written to allocate a new block of memory
389 only if the argument is NULL. */
390 struct bfd_hash_entry *(*newfunc)
391 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
392 /* An objalloc for this hash table. This is a struct objalloc *,
393 but we use void * to avoid requiring the inclusion of objalloc.h. */
394 void *memory;
395 /* The number of slots in the hash table. */
396 unsigned int size;
397 /* The number of entries in the hash table. */
398 unsigned int count;
399 /* The size of elements. */
400 unsigned int entsize;
401 /* If non-zero, don't grow the hash table. */
402 unsigned int frozen:1;
405 /* Initialize a hash table. */
406 extern bfd_boolean bfd_hash_table_init
407 (struct bfd_hash_table *,
408 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
409 struct bfd_hash_table *,
410 const char *),
411 unsigned int);
413 /* Initialize a hash table specifying a size. */
414 extern bfd_boolean bfd_hash_table_init_n
415 (struct bfd_hash_table *,
416 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
417 struct bfd_hash_table *,
418 const char *),
419 unsigned int, unsigned int);
421 /* Free up a hash table. */
422 extern void bfd_hash_table_free
423 (struct bfd_hash_table *);
425 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
426 will be created for this string if one does not already exist. The
427 COPY argument must be TRUE if this routine should copy the string
428 into newly allocated memory when adding an entry. */
429 extern struct bfd_hash_entry *bfd_hash_lookup
430 (struct bfd_hash_table *, const char *, bfd_boolean create,
431 bfd_boolean copy);
433 /* Insert an entry in a hash table. */
434 extern struct bfd_hash_entry *bfd_hash_insert
435 (struct bfd_hash_table *, const char *, unsigned long);
437 /* Rename an entry in a hash table. */
438 extern void bfd_hash_rename
439 (struct bfd_hash_table *, const char *, struct bfd_hash_entry *);
441 /* Replace an entry in a hash table. */
442 extern void bfd_hash_replace
443 (struct bfd_hash_table *, struct bfd_hash_entry *old,
444 struct bfd_hash_entry *nw);
446 /* Base method for creating a hash table entry. */
447 extern struct bfd_hash_entry *bfd_hash_newfunc
448 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
450 /* Grab some space for a hash table entry. */
451 extern void *bfd_hash_allocate
452 (struct bfd_hash_table *, unsigned int);
454 /* Traverse a hash table in a random order, calling a function on each
455 element. If the function returns FALSE, the traversal stops. The
456 INFO argument is passed to the function. */
457 extern void bfd_hash_traverse
458 (struct bfd_hash_table *,
459 bfd_boolean (*) (struct bfd_hash_entry *, void *),
460 void *info);
462 /* Allows the default size of a hash table to be configured. New hash
463 tables allocated using bfd_hash_table_init will be created with
464 this size. */
465 extern unsigned long bfd_hash_set_default_size (unsigned long);
467 /* Types of compressed DWARF debug sections. We currently support
468 zlib. */
469 enum compressed_debug_section_type
471 COMPRESS_DEBUG_NONE = 0,
472 COMPRESS_DEBUG = 1 << 0,
473 COMPRESS_DEBUG_GNU_ZLIB = COMPRESS_DEBUG | 1 << 1,
474 COMPRESS_DEBUG_GABI_ZLIB = COMPRESS_DEBUG | 1 << 2
477 /* This structure is used to keep track of stabs in sections
478 information while linking. */
480 struct stab_info
482 /* A hash table used to hold stabs strings. */
483 struct bfd_strtab_hash *strings;
484 /* The header file hash table. */
485 struct bfd_hash_table includes;
486 /* The first .stabstr section. */
487 struct bfd_section *stabstr;
490 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
492 /* User program access to BFD facilities. */
494 /* Direct I/O routines, for programs which know more about the object
495 file than BFD does. Use higher level routines if possible. */
497 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
498 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
499 extern int bfd_seek (bfd *, file_ptr, int);
500 extern file_ptr bfd_tell (bfd *);
501 extern int bfd_flush (bfd *);
502 extern int bfd_stat (bfd *, struct stat *);
504 /* Deprecated old routines. */
505 #if __GNUC__
506 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
507 (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
508 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
509 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
510 (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
511 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
512 #else
513 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
514 (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
515 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
516 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
517 (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
518 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
519 #endif
520 extern void _bfd_warn_deprecated (const char *, const char *, int, const char *);
522 /* Cast from const char * to char * so that caller can assign to
523 a char * without a warning. */
524 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
525 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
526 #define bfd_get_format(abfd) ((abfd)->format)
527 #define bfd_get_target(abfd) ((abfd)->xvec->name)
528 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
529 #define bfd_family_coff(abfd) \
530 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
531 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
532 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
533 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
534 #define bfd_header_big_endian(abfd) \
535 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
536 #define bfd_header_little_endian(abfd) \
537 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
538 #define bfd_get_file_flags(abfd) ((abfd)->flags)
539 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
540 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
541 #define bfd_has_map(abfd) ((abfd)->has_armap)
542 #define bfd_is_thin_archive(abfd) ((abfd)->is_thin_archive)
544 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
545 #define bfd_usrdata(abfd) ((abfd)->usrdata)
547 #define bfd_get_start_address(abfd) ((abfd)->start_address)
548 #define bfd_get_symcount(abfd) ((abfd)->symcount)
549 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
550 #define bfd_count_sections(abfd) ((abfd)->section_count)
552 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
554 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
556 extern bfd_boolean bfd_cache_close
557 (bfd *abfd);
558 /* NB: This declaration should match the autogenerated one in libbfd.h. */
560 extern bfd_boolean bfd_cache_close_all (void);
562 extern bfd_boolean bfd_record_phdr
563 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
564 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
566 /* Byte swapping routines. */
568 bfd_uint64_t bfd_getb64 (const void *);
569 bfd_uint64_t bfd_getl64 (const void *);
570 bfd_int64_t bfd_getb_signed_64 (const void *);
571 bfd_int64_t bfd_getl_signed_64 (const void *);
572 bfd_vma bfd_getb32 (const void *);
573 bfd_vma bfd_getl32 (const void *);
574 bfd_signed_vma bfd_getb_signed_32 (const void *);
575 bfd_signed_vma bfd_getl_signed_32 (const void *);
576 bfd_vma bfd_getb16 (const void *);
577 bfd_vma bfd_getl16 (const void *);
578 bfd_signed_vma bfd_getb_signed_16 (const void *);
579 bfd_signed_vma bfd_getl_signed_16 (const void *);
580 void bfd_putb64 (bfd_uint64_t, void *);
581 void bfd_putl64 (bfd_uint64_t, void *);
582 void bfd_putb32 (bfd_vma, void *);
583 void bfd_putl32 (bfd_vma, void *);
584 void bfd_putb24 (bfd_vma, void *);
585 void bfd_putl24 (bfd_vma, void *);
586 void bfd_putb16 (bfd_vma, void *);
587 void bfd_putl16 (bfd_vma, void *);
589 /* Byte swapping routines which take size and endiannes as arguments. */
591 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
592 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
594 #if defined(__STDC__) || defined(ALMOST_STDC)
595 struct ecoff_debug_info;
596 struct ecoff_debug_swap;
597 struct ecoff_extr;
598 struct bfd_symbol;
599 struct bfd_link_info;
600 struct bfd_link_hash_entry;
601 struct bfd_section_already_linked;
602 struct bfd_elf_version_tree;
603 #endif
605 extern bfd_boolean bfd_section_already_linked_table_init (void);
606 extern void bfd_section_already_linked_table_free (void);
607 extern bfd_boolean _bfd_handle_already_linked
608 (struct bfd_section *, struct bfd_section_already_linked *,
609 struct bfd_link_info *);
611 /* Externally visible ECOFF routines. */
613 extern bfd_boolean bfd_ecoff_set_gp_value
614 (bfd *abfd, bfd_vma gp_value);
615 extern bfd_boolean bfd_ecoff_set_regmasks
616 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
617 unsigned long *cprmask);
618 extern void *bfd_ecoff_debug_init
619 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
620 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
621 extern void bfd_ecoff_debug_free
622 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
623 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
624 extern bfd_boolean bfd_ecoff_debug_accumulate
625 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
626 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
627 struct ecoff_debug_info *input_debug,
628 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
629 extern bfd_boolean bfd_ecoff_debug_accumulate_other
630 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
631 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
632 struct bfd_link_info *);
633 extern bfd_boolean bfd_ecoff_debug_externals
634 (bfd *abfd, struct ecoff_debug_info *debug,
635 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
636 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
637 void (*set_index) (struct bfd_symbol *, bfd_size_type));
638 extern bfd_boolean bfd_ecoff_debug_one_external
639 (bfd *abfd, struct ecoff_debug_info *debug,
640 const struct ecoff_debug_swap *swap, const char *name,
641 struct ecoff_extr *esym);
642 extern bfd_size_type bfd_ecoff_debug_size
643 (bfd *abfd, struct ecoff_debug_info *debug,
644 const struct ecoff_debug_swap *swap);
645 extern bfd_boolean bfd_ecoff_write_debug
646 (bfd *abfd, struct ecoff_debug_info *debug,
647 const struct ecoff_debug_swap *swap, file_ptr where);
648 extern bfd_boolean bfd_ecoff_write_accumulated_debug
649 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
650 const struct ecoff_debug_swap *swap,
651 struct bfd_link_info *info, file_ptr where);
653 /* Externally visible ELF routines. */
655 struct bfd_link_needed_list
657 struct bfd_link_needed_list *next;
658 bfd *by;
659 const char *name;
662 enum dynamic_lib_link_class {
663 DYN_NORMAL = 0,
664 DYN_AS_NEEDED = 1,
665 DYN_DT_NEEDED = 2,
666 DYN_NO_ADD_NEEDED = 4,
667 DYN_NO_NEEDED = 8
670 enum notice_asneeded_action {
671 notice_as_needed,
672 notice_not_needed,
673 notice_needed
676 extern bfd_boolean bfd_elf_record_link_assignment
677 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
678 bfd_boolean);
679 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
680 (bfd *, struct bfd_link_info *);
681 extern bfd_boolean bfd_elf_get_bfd_needed_list
682 (bfd *, struct bfd_link_needed_list **);
683 extern bfd_boolean bfd_elf_stack_segment_size (bfd *, struct bfd_link_info *,
684 const char *, bfd_vma);
685 extern bfd_boolean bfd_elf_size_dynamic_sections
686 (bfd *, const char *, const char *, const char *, const char *, const char *,
687 const char * const *, struct bfd_link_info *, struct bfd_section **);
688 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
689 (bfd *, struct bfd_link_info *);
690 extern void bfd_elf_set_dt_needed_name
691 (bfd *, const char *);
692 extern const char *bfd_elf_get_dt_soname
693 (bfd *);
694 extern void bfd_elf_set_dyn_lib_class
695 (bfd *, enum dynamic_lib_link_class);
696 extern int bfd_elf_get_dyn_lib_class
697 (bfd *);
698 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
699 (bfd *, struct bfd_link_info *);
700 extern int bfd_elf_discard_info
701 (bfd *, struct bfd_link_info *);
702 extern unsigned int _bfd_elf_default_action_discarded
703 (struct bfd_section *);
705 /* Return an upper bound on the number of bytes required to store a
706 copy of ABFD's program header table entries. Return -1 if an error
707 occurs; bfd_get_error will return an appropriate code. */
708 extern long bfd_get_elf_phdr_upper_bound
709 (bfd *abfd);
711 /* Copy ABFD's program header table entries to *PHDRS. The entries
712 will be stored as an array of Elf_Internal_Phdr structures, as
713 defined in include/elf/internal.h. To find out how large the
714 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
716 Return the number of program header table entries read, or -1 if an
717 error occurs; bfd_get_error will return an appropriate code. */
718 extern int bfd_get_elf_phdrs
719 (bfd *abfd, void *phdrs);
721 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
722 reconstruct an ELF file by reading the segments out of remote
723 memory based on the ELF file header at EHDR_VMA and the ELF program
724 headers it points to. If non-zero, SIZE is the known extent of the
725 object. If not null, *LOADBASEP is filled in with the difference
726 between the VMAs from which the segments were read, and the VMAs
727 the file headers (and hence BFD's idea of each section's VMA) put
728 them at.
730 The function TARGET_READ_MEMORY is called to copy LEN bytes from
731 the remote memory at target address VMA into the local buffer at
732 MYADDR; it should return zero on success or an `errno' code on
733 failure. TEMPL must be a BFD for a target with the word size and
734 byte order found in the remote memory. */
735 extern bfd *bfd_elf_bfd_from_remote_memory
736 (bfd *templ, bfd_vma ehdr_vma, bfd_size_type size, bfd_vma *loadbasep,
737 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr,
738 bfd_size_type len));
740 extern struct bfd_section *_bfd_elf_tls_setup
741 (bfd *, struct bfd_link_info *);
743 extern struct bfd_section *
744 _bfd_nearby_section (bfd *, struct bfd_section *, bfd_vma);
746 extern void _bfd_fix_excluded_sec_syms
747 (bfd *, struct bfd_link_info *);
749 extern unsigned bfd_m68k_mach_to_features (int);
751 extern int bfd_m68k_features_to_mach (unsigned);
753 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
754 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
755 char **);
757 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info *, int);
759 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
760 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
761 char **);
763 extern bfd_boolean bfd_cr16_elf32_create_embedded_relocs
764 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
765 char **);
767 /* SunOS shared library support routines for the linker. */
769 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
770 (bfd *, struct bfd_link_info *);
771 extern bfd_boolean bfd_sunos_record_link_assignment
772 (bfd *, struct bfd_link_info *, const char *);
773 extern bfd_boolean bfd_sunos_size_dynamic_sections
774 (bfd *, struct bfd_link_info *, struct bfd_section **,
775 struct bfd_section **, struct bfd_section **);
777 /* Linux shared library support routines for the linker. */
779 extern bfd_boolean bfd_i386linux_size_dynamic_sections
780 (bfd *, struct bfd_link_info *);
781 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
782 (bfd *, struct bfd_link_info *);
784 /* mmap hacks */
786 struct _bfd_window_internal;
787 typedef struct _bfd_window_internal bfd_window_internal;
789 typedef struct _bfd_window
791 /* What the user asked for. */
792 void *data;
793 bfd_size_type size;
794 /* The actual window used by BFD. Small user-requested read-only
795 regions sharing a page may share a single window into the object
796 file. Read-write versions shouldn't until I've fixed things to
797 keep track of which portions have been claimed by the
798 application; don't want to give the same region back when the
799 application wants two writable copies! */
800 struct _bfd_window_internal *i;
802 bfd_window;
804 extern void bfd_init_window
805 (bfd_window *);
806 extern void bfd_free_window
807 (bfd_window *);
808 extern bfd_boolean bfd_get_file_window
809 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
811 /* XCOFF support routines for the linker. */
813 extern bfd_boolean bfd_xcoff_split_import_path
814 (bfd *, const char *, const char **, const char **);
815 extern bfd_boolean bfd_xcoff_set_archive_import_path
816 (struct bfd_link_info *, bfd *, const char *);
817 extern bfd_boolean bfd_xcoff_link_record_set
818 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
819 extern bfd_boolean bfd_xcoff_import_symbol
820 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
821 const char *, const char *, const char *, unsigned int);
822 extern bfd_boolean bfd_xcoff_export_symbol
823 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
824 extern bfd_boolean bfd_xcoff_link_count_reloc
825 (bfd *, struct bfd_link_info *, const char *);
826 extern bfd_boolean bfd_xcoff_record_link_assignment
827 (bfd *, struct bfd_link_info *, const char *);
828 extern bfd_boolean bfd_xcoff_size_dynamic_sections
829 (bfd *, struct bfd_link_info *, const char *, const char *,
830 unsigned long, unsigned long, unsigned long, bfd_boolean,
831 int, bfd_boolean, unsigned int, struct bfd_section **, bfd_boolean);
832 extern bfd_boolean bfd_xcoff_link_generate_rtinit
833 (bfd *, const char *, const char *, bfd_boolean);
835 /* XCOFF support routines for ar. */
836 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
837 (bfd *, char *);
839 /* Externally visible COFF routines. */
841 #if defined(__STDC__) || defined(ALMOST_STDC)
842 struct internal_syment;
843 union internal_auxent;
844 #endif
846 extern bfd_boolean bfd_coff_set_symbol_class
847 (bfd *, struct bfd_symbol *, unsigned int);
849 /* ARM VFP11 erratum workaround support. */
850 typedef enum
852 BFD_ARM_VFP11_FIX_DEFAULT,
853 BFD_ARM_VFP11_FIX_NONE,
854 BFD_ARM_VFP11_FIX_SCALAR,
855 BFD_ARM_VFP11_FIX_VECTOR
856 } bfd_arm_vfp11_fix;
858 extern void bfd_elf32_arm_init_maps
859 (bfd *);
861 extern void bfd_elf32_arm_set_vfp11_fix
862 (bfd *, struct bfd_link_info *);
864 extern void bfd_elf32_arm_set_cortex_a8_fix
865 (bfd *, struct bfd_link_info *);
867 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
868 (bfd *, struct bfd_link_info *);
870 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
871 (bfd *, struct bfd_link_info *);
873 /* ARM STM STM32L4XX erratum workaround support. */
874 typedef enum
876 BFD_ARM_STM32L4XX_FIX_NONE,
877 BFD_ARM_STM32L4XX_FIX_DEFAULT,
878 BFD_ARM_STM32L4XX_FIX_ALL
879 } bfd_arm_stm32l4xx_fix;
881 extern void bfd_elf32_arm_set_stm32l4xx_fix
882 (bfd *, struct bfd_link_info *);
884 extern bfd_boolean bfd_elf32_arm_stm32l4xx_erratum_scan
885 (bfd *, struct bfd_link_info *);
887 extern void bfd_elf32_arm_stm32l4xx_fix_veneer_locations
888 (bfd *, struct bfd_link_info *);
890 /* ARM Interworking support. Called from linker. */
891 extern bfd_boolean bfd_arm_allocate_interworking_sections
892 (struct bfd_link_info *);
894 extern bfd_boolean bfd_arm_process_before_allocation
895 (bfd *, struct bfd_link_info *, int);
897 extern bfd_boolean bfd_arm_get_bfd_for_interworking
898 (bfd *, struct bfd_link_info *);
900 /* PE ARM Interworking support. Called from linker. */
901 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
902 (struct bfd_link_info *);
904 extern bfd_boolean bfd_arm_pe_process_before_allocation
905 (bfd *, struct bfd_link_info *, int);
907 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
908 (bfd *, struct bfd_link_info *);
910 /* ELF ARM Interworking support. Called from linker. */
911 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
912 (struct bfd_link_info *);
914 extern bfd_boolean bfd_elf32_arm_process_before_allocation
915 (bfd *, struct bfd_link_info *);
917 struct elf32_arm_params {
918 char *thumb_entry_symbol;
919 int byteswap_code;
920 int target1_is_rel;
921 char * target2_type;
922 int fix_v4bx;
923 int use_blx;
924 bfd_arm_vfp11_fix vfp11_denorm_fix;
925 bfd_arm_stm32l4xx_fix stm32l4xx_fix;
926 int no_enum_size_warning;
927 int no_wchar_size_warning;
928 int pic_veneer;
929 int fix_cortex_a8;
930 int fix_arm1176;
931 int merge_exidx_entries;
932 int cmse_implib;
933 bfd *in_implib_bfd;
936 void bfd_elf32_arm_set_target_params
937 (bfd *, struct bfd_link_info *, struct elf32_arm_params *);
939 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
940 (bfd *, struct bfd_link_info *);
942 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
943 (bfd *, struct bfd_link_info *);
945 extern void bfd_elf32_arm_keep_private_stub_output_sections
946 (struct bfd_link_info *);
948 /* ELF ARM mapping symbol support. */
949 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
950 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
951 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
952 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
954 extern bfd_boolean bfd_is_arm_special_symbol_name
955 (const char *, int);
957 extern void bfd_elf32_arm_set_byteswap_code
958 (struct bfd_link_info *, int);
960 extern void bfd_elf32_arm_use_long_plt (void);
962 /* ARM Note section processing. */
963 extern bfd_boolean bfd_arm_merge_machines
964 (bfd *, bfd *);
966 extern bfd_boolean bfd_arm_update_notes
967 (bfd *, const char *);
969 extern unsigned int bfd_arm_get_mach_from_notes
970 (bfd *, const char *);
972 /* ARM stub generation support. Called from the linker. */
973 extern int elf32_arm_setup_section_lists
974 (bfd *, struct bfd_link_info *);
975 extern void elf32_arm_next_input_section
976 (struct bfd_link_info *, struct bfd_section *);
977 extern bfd_boolean elf32_arm_size_stubs
978 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
979 struct bfd_section * (*) (const char *, struct bfd_section *,
980 struct bfd_section *, unsigned int),
981 void (*) (void));
982 extern bfd_boolean elf32_arm_build_stubs
983 (struct bfd_link_info *);
985 /* ARM unwind section editing support. */
986 extern bfd_boolean elf32_arm_fix_exidx_coverage
987 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
989 /* C6x unwind section editing support. */
990 extern bfd_boolean elf32_tic6x_fix_exidx_coverage
991 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
993 extern void bfd_elf64_aarch64_init_maps
994 (bfd *);
996 extern void bfd_elf32_aarch64_init_maps
997 (bfd *);
999 extern void bfd_elf64_aarch64_set_options
1000 (bfd *, struct bfd_link_info *, int, int, int, int, int, int);
1002 extern void bfd_elf32_aarch64_set_options
1003 (bfd *, struct bfd_link_info *, int, int, int, int, int, int);
1005 /* ELF AArch64 mapping symbol support. */
1006 #define BFD_AARCH64_SPECIAL_SYM_TYPE_MAP (1 << 0)
1007 #define BFD_AARCH64_SPECIAL_SYM_TYPE_TAG (1 << 1)
1008 #define BFD_AARCH64_SPECIAL_SYM_TYPE_OTHER (1 << 2)
1009 #define BFD_AARCH64_SPECIAL_SYM_TYPE_ANY (~0)
1010 extern bfd_boolean bfd_is_aarch64_special_symbol_name
1011 (const char * name, int type);
1013 /* AArch64 stub generation support for ELF64. Called from the linker. */
1014 extern int elf64_aarch64_setup_section_lists
1015 (bfd *, struct bfd_link_info *);
1016 extern void elf64_aarch64_next_input_section
1017 (struct bfd_link_info *, struct bfd_section *);
1018 extern bfd_boolean elf64_aarch64_size_stubs
1019 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
1020 struct bfd_section * (*) (const char *, struct bfd_section *),
1021 void (*) (void));
1022 extern bfd_boolean elf64_aarch64_build_stubs
1023 (struct bfd_link_info *);
1024 /* AArch64 stub generation support for ELF32. Called from the linker. */
1025 extern int elf32_aarch64_setup_section_lists
1026 (bfd *, struct bfd_link_info *);
1027 extern void elf32_aarch64_next_input_section
1028 (struct bfd_link_info *, struct bfd_section *);
1029 extern bfd_boolean elf32_aarch64_size_stubs
1030 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
1031 struct bfd_section * (*) (const char *, struct bfd_section *),
1032 void (*) (void));
1033 extern bfd_boolean elf32_aarch64_build_stubs
1034 (struct bfd_link_info *);
1037 /* TI COFF load page support. */
1038 extern void bfd_ticoff_set_section_load_page
1039 (struct bfd_section *, int);
1041 extern int bfd_ticoff_get_section_load_page
1042 (struct bfd_section *);
1044 /* H8/300 functions. */
1045 extern bfd_vma bfd_h8300_pad_address
1046 (bfd *, bfd_vma);
1048 /* IA64 Itanium code generation. Called from linker. */
1049 extern void bfd_elf32_ia64_after_parse
1050 (int);
1052 extern void bfd_elf64_ia64_after_parse
1053 (int);
1055 /* V850 Note manipulation routines. */
1056 extern bfd_boolean v850_elf_create_sections
1057 (struct bfd_link_info *);
1059 extern bfd_boolean v850_elf_set_note
1060 (bfd *, unsigned int, unsigned int);
1062 /* MIPS ABI flags data access. For the disassembler. */
1063 struct elf_internal_abiflags_v0;
1064 extern struct elf_internal_abiflags_v0 *bfd_mips_elf_get_abiflags (bfd *);