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