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