bfd macro conversion to inline functions, asymbol
[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 /* A canonical archive symbol. */
241 /* This is a type pun with struct ranlib on purpose! */
242 typedef struct carsym
243 {
244 const char *name;
245 file_ptr file_offset; /* Look here to find the file. */
246 }
247 carsym; /* To make these you call a carsymogen. */
248
249 /* Used in generating armaps (archive tables of contents).
250 Perhaps just a forward definition would do? */
251 struct orl /* Output ranlib. */
252 {
253 char **name; /* Symbol name. */
254 union
255 {
256 file_ptr pos;
257 bfd *abfd;
258 } u; /* bfd* or file position. */
259 int namidx; /* Index into string table. */
260 };
261
262 /* Linenumber stuff. */
263 typedef struct lineno_cache_entry
264 {
265 unsigned int line_number; /* Linenumber from start of function. */
266 union
267 {
268 struct bfd_symbol *sym; /* Function name. */
269 bfd_vma offset; /* Offset into section. */
270 } u;
271 }
272 alent;
273 \f
274 /* Object and core file sections. */
275 typedef struct bfd_section *sec_ptr;
276
277 #define align_power(addr, align) \
278 (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
279
280 /* Align an address upward to a boundary, expressed as a number of bytes.
281 E.g. align to an 8-byte boundary with argument of 8. Take care never
282 to wrap around if the address is within boundary-1 of the end of the
283 address space. */
284 #define BFD_ALIGN(this, boundary) \
285 ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this)) \
286 ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
287 : ~ (bfd_vma) 0)
288
289 #define bfd_section_name(sec) ((sec)->name)
290 #define bfd_section_size(sec) ((sec)->size)
291 #define bfd_section_vma(sec) ((sec)->vma)
292 #define bfd_section_lma(sec) ((sec)->lma)
293 #define bfd_section_alignment(sec) ((sec)->alignment_power)
294 #define bfd_section_flags(sec) ((sec)->flags)
295 #define bfd_section_userdata(sec) ((sec)->userdata)
296
297 #define bfd_is_com_section(sec) (((sec)->flags & SEC_IS_COMMON) != 0)
298
299 #define bfd_get_section_limit_octets(bfd, sec) \
300 ((bfd)->direction != write_direction && (sec)->rawsize != 0 \
301 ? (sec)->rawsize : (sec)->size)
302
303 /* Find the address one past the end of SEC. */
304 #define bfd_get_section_limit(bfd, sec) \
305 (bfd_get_section_limit_octets(bfd, sec) / bfd_octets_per_byte (bfd))
306
307 /* Return TRUE if input section SEC has been discarded. */
308 #define discarded_section(sec) \
309 (!bfd_is_abs_section (sec) \
310 && bfd_is_abs_section ((sec)->output_section) \
311 && (sec)->sec_info_type != SEC_INFO_TYPE_MERGE \
312 && (sec)->sec_info_type != SEC_INFO_TYPE_JUST_SYMS)
313 \f
314 typedef enum bfd_print_symbol
315 {
316 bfd_print_symbol_name,
317 bfd_print_symbol_more,
318 bfd_print_symbol_all
319 } bfd_print_symbol_type;
320
321 /* Information about a symbol that nm needs. */
322
323 typedef struct _symbol_info
324 {
325 symvalue value;
326 char type;
327 const char *name; /* Symbol name. */
328 unsigned char stab_type; /* Stab type. */
329 char stab_other; /* Stab other. */
330 short stab_desc; /* Stab desc. */
331 const char *stab_name; /* String for stab type. */
332 } symbol_info;
333
334 /* Get the name of a stabs type code. */
335
336 extern const char *bfd_get_stab_name (int);
337 \f
338 /* Hash table routines. There is no way to free up a hash table. */
339
340 /* An element in the hash table. Most uses will actually use a larger
341 structure, and an instance of this will be the first field. */
342
343 struct bfd_hash_entry
344 {
345 /* Next entry for this hash code. */
346 struct bfd_hash_entry *next;
347 /* String being hashed. */
348 const char *string;
349 /* Hash code. This is the full hash code, not the index into the
350 table. */
351 unsigned long hash;
352 };
353
354 /* A hash table. */
355
356 struct bfd_hash_table
357 {
358 /* The hash array. */
359 struct bfd_hash_entry **table;
360 /* A function used to create new elements in the hash table. The
361 first entry is itself a pointer to an element. When this
362 function is first invoked, this pointer will be NULL. However,
363 having the pointer permits a hierarchy of method functions to be
364 built each of which calls the function in the superclass. Thus
365 each function should be written to allocate a new block of memory
366 only if the argument is NULL. */
367 struct bfd_hash_entry *(*newfunc)
368 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
369 /* An objalloc for this hash table. This is a struct objalloc *,
370 but we use void * to avoid requiring the inclusion of objalloc.h. */
371 void *memory;
372 /* The number of slots in the hash table. */
373 unsigned int size;
374 /* The number of entries in the hash table. */
375 unsigned int count;
376 /* The size of elements. */
377 unsigned int entsize;
378 /* If non-zero, don't grow the hash table. */
379 unsigned int frozen:1;
380 };
381
382 /* Initialize a hash table. */
383 extern bfd_boolean bfd_hash_table_init
384 (struct bfd_hash_table *,
385 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
386 struct bfd_hash_table *,
387 const char *),
388 unsigned int);
389
390 /* Initialize a hash table specifying a size. */
391 extern bfd_boolean bfd_hash_table_init_n
392 (struct bfd_hash_table *,
393 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
394 struct bfd_hash_table *,
395 const char *),
396 unsigned int, unsigned int);
397
398 /* Free up a hash table. */
399 extern void bfd_hash_table_free
400 (struct bfd_hash_table *);
401
402 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
403 will be created for this string if one does not already exist. The
404 COPY argument must be TRUE if this routine should copy the string
405 into newly allocated memory when adding an entry. */
406 extern struct bfd_hash_entry *bfd_hash_lookup
407 (struct bfd_hash_table *, const char *, bfd_boolean create,
408 bfd_boolean copy);
409
410 /* Insert an entry in a hash table. */
411 extern struct bfd_hash_entry *bfd_hash_insert
412 (struct bfd_hash_table *, const char *, unsigned long);
413
414 /* Rename an entry in a hash table. */
415 extern void bfd_hash_rename
416 (struct bfd_hash_table *, const char *, struct bfd_hash_entry *);
417
418 /* Replace an entry in a hash table. */
419 extern void bfd_hash_replace
420 (struct bfd_hash_table *, struct bfd_hash_entry *old,
421 struct bfd_hash_entry *nw);
422
423 /* Base method for creating a hash table entry. */
424 extern struct bfd_hash_entry *bfd_hash_newfunc
425 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
426
427 /* Grab some space for a hash table entry. */
428 extern void *bfd_hash_allocate
429 (struct bfd_hash_table *, unsigned int);
430
431 /* Traverse a hash table in a random order, calling a function on each
432 element. If the function returns FALSE, the traversal stops. The
433 INFO argument is passed to the function. */
434 extern void bfd_hash_traverse
435 (struct bfd_hash_table *,
436 bfd_boolean (*) (struct bfd_hash_entry *, void *),
437 void *info);
438
439 /* Allows the default size of a hash table to be configured. New hash
440 tables allocated using bfd_hash_table_init will be created with
441 this size. */
442 extern unsigned long bfd_hash_set_default_size (unsigned long);
443
444 /* Types of compressed DWARF debug sections. We currently support
445 zlib. */
446 enum compressed_debug_section_type
447 {
448 COMPRESS_DEBUG_NONE = 0,
449 COMPRESS_DEBUG = 1 << 0,
450 COMPRESS_DEBUG_GNU_ZLIB = COMPRESS_DEBUG | 1 << 1,
451 COMPRESS_DEBUG_GABI_ZLIB = COMPRESS_DEBUG | 1 << 2
452 };
453
454 /* This structure is used to keep track of stabs in sections
455 information while linking. */
456
457 struct stab_info
458 {
459 /* A hash table used to hold stabs strings. */
460 struct bfd_strtab_hash *strings;
461 /* The header file hash table. */
462 struct bfd_hash_table includes;
463 /* The first .stabstr section. */
464 struct bfd_section *stabstr;
465 };
466
467 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
468
469 /* User program access to BFD facilities. */
470
471 /* Direct I/O routines, for programs which know more about the object
472 file than BFD does. Use higher level routines if possible. */
473
474 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
475 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
476 extern int bfd_seek (bfd *, file_ptr, int);
477 extern file_ptr bfd_tell (bfd *);
478 extern int bfd_flush (bfd *);
479 extern int bfd_stat (bfd *, struct stat *);
480
481 /* Deprecated old routines. */
482 #if __GNUC__
483 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
484 (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
485 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
486 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
487 (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
488 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
489 #else
490 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
491 (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
492 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
493 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
494 (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
495 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
496 #endif
497 extern void _bfd_warn_deprecated (const char *, const char *, int, const char *);
498
499 extern bfd_boolean bfd_cache_close
500 (bfd *abfd);
501 /* NB: This declaration should match the autogenerated one in libbfd.h. */
502
503 extern bfd_boolean bfd_cache_close_all (void);
504
505 extern bfd_boolean bfd_record_phdr
506 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
507 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
508
509 /* Byte swapping routines. */
510
511 bfd_uint64_t bfd_getb64 (const void *);
512 bfd_uint64_t bfd_getl64 (const void *);
513 bfd_int64_t bfd_getb_signed_64 (const void *);
514 bfd_int64_t bfd_getl_signed_64 (const void *);
515 bfd_vma bfd_getb32 (const void *);
516 bfd_vma bfd_getl32 (const void *);
517 bfd_signed_vma bfd_getb_signed_32 (const void *);
518 bfd_signed_vma bfd_getl_signed_32 (const void *);
519 bfd_vma bfd_getb16 (const void *);
520 bfd_vma bfd_getl16 (const void *);
521 bfd_signed_vma bfd_getb_signed_16 (const void *);
522 bfd_signed_vma bfd_getl_signed_16 (const void *);
523 void bfd_putb64 (bfd_uint64_t, void *);
524 void bfd_putl64 (bfd_uint64_t, void *);
525 void bfd_putb32 (bfd_vma, void *);
526 void bfd_putl32 (bfd_vma, void *);
527 void bfd_putb24 (bfd_vma, void *);
528 void bfd_putl24 (bfd_vma, void *);
529 void bfd_putb16 (bfd_vma, void *);
530 void bfd_putl16 (bfd_vma, void *);
531
532 /* Byte swapping routines which take size and endiannes as arguments. */
533
534 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
535 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
536
537 #if defined(__STDC__) || defined(ALMOST_STDC)
538 struct ecoff_debug_info;
539 struct ecoff_debug_swap;
540 struct ecoff_extr;
541 struct bfd_symbol;
542 struct bfd_link_info;
543 struct bfd_link_hash_entry;
544 struct bfd_section_already_linked;
545 struct bfd_elf_version_tree;
546 #endif
547
548 extern bfd_boolean bfd_section_already_linked_table_init (void);
549 extern void bfd_section_already_linked_table_free (void);
550 extern bfd_boolean _bfd_handle_already_linked
551 (struct bfd_section *, struct bfd_section_already_linked *,
552 struct bfd_link_info *);
553 \f
554 /* Externally visible ECOFF routines. */
555
556 extern bfd_boolean bfd_ecoff_set_gp_value
557 (bfd *abfd, bfd_vma gp_value);
558 extern bfd_boolean bfd_ecoff_set_regmasks
559 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
560 unsigned long *cprmask);
561 extern void *bfd_ecoff_debug_init
562 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
563 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
564 extern void bfd_ecoff_debug_free
565 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
566 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
567 extern bfd_boolean bfd_ecoff_debug_accumulate
568 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
569 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
570 struct ecoff_debug_info *input_debug,
571 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
572 extern bfd_boolean bfd_ecoff_debug_accumulate_other
573 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
574 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
575 struct bfd_link_info *);
576 extern bfd_boolean bfd_ecoff_debug_externals
577 (bfd *abfd, struct ecoff_debug_info *debug,
578 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
579 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
580 void (*set_index) (struct bfd_symbol *, bfd_size_type));
581 extern bfd_boolean bfd_ecoff_debug_one_external
582 (bfd *abfd, struct ecoff_debug_info *debug,
583 const struct ecoff_debug_swap *swap, const char *name,
584 struct ecoff_extr *esym);
585 extern bfd_size_type bfd_ecoff_debug_size
586 (bfd *abfd, struct ecoff_debug_info *debug,
587 const struct ecoff_debug_swap *swap);
588 extern bfd_boolean bfd_ecoff_write_debug
589 (bfd *abfd, struct ecoff_debug_info *debug,
590 const struct ecoff_debug_swap *swap, file_ptr where);
591 extern bfd_boolean bfd_ecoff_write_accumulated_debug
592 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
593 const struct ecoff_debug_swap *swap,
594 struct bfd_link_info *info, file_ptr where);
595
596 /* Externally visible ELF routines. */
597
598 struct bfd_link_needed_list
599 {
600 struct bfd_link_needed_list *next;
601 bfd *by;
602 const char *name;
603 };
604
605 enum dynamic_lib_link_class {
606 DYN_NORMAL = 0,
607 DYN_AS_NEEDED = 1,
608 DYN_DT_NEEDED = 2,
609 DYN_NO_ADD_NEEDED = 4,
610 DYN_NO_NEEDED = 8
611 };
612
613 enum notice_asneeded_action {
614 notice_as_needed,
615 notice_not_needed,
616 notice_needed
617 };
618
619 extern bfd_boolean bfd_elf_record_link_assignment
620 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
621 bfd_boolean);
622 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
623 (bfd *, struct bfd_link_info *);
624 extern bfd_boolean bfd_elf_get_bfd_needed_list
625 (bfd *, struct bfd_link_needed_list **);
626 extern bfd_boolean bfd_elf_stack_segment_size (bfd *, struct bfd_link_info *,
627 const char *, bfd_vma);
628 extern bfd_boolean bfd_elf_size_dynamic_sections
629 (bfd *, const char *, const char *, const char *, const char *, const char *,
630 const char * const *, struct bfd_link_info *, struct bfd_section **);
631 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
632 (bfd *, struct bfd_link_info *);
633 extern void bfd_elf_set_dt_needed_name
634 (bfd *, const char *);
635 extern const char *bfd_elf_get_dt_soname
636 (bfd *);
637 extern void bfd_elf_set_dyn_lib_class
638 (bfd *, enum dynamic_lib_link_class);
639 extern int bfd_elf_get_dyn_lib_class
640 (bfd *);
641 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
642 (bfd *, struct bfd_link_info *);
643 extern int bfd_elf_discard_info
644 (bfd *, struct bfd_link_info *);
645 extern unsigned int _bfd_elf_default_action_discarded
646 (struct bfd_section *);
647
648 /* Return an upper bound on the number of bytes required to store a
649 copy of ABFD's program header table entries. Return -1 if an error
650 occurs; bfd_get_error will return an appropriate code. */
651 extern long bfd_get_elf_phdr_upper_bound
652 (bfd *abfd);
653
654 /* Copy ABFD's program header table entries to *PHDRS. The entries
655 will be stored as an array of Elf_Internal_Phdr structures, as
656 defined in include/elf/internal.h. To find out how large the
657 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
658
659 Return the number of program header table entries read, or -1 if an
660 error occurs; bfd_get_error will return an appropriate code. */
661 extern int bfd_get_elf_phdrs
662 (bfd *abfd, void *phdrs);
663
664 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
665 reconstruct an ELF file by reading the segments out of remote
666 memory based on the ELF file header at EHDR_VMA and the ELF program
667 headers it points to. If non-zero, SIZE is the known extent of the
668 object. If not null, *LOADBASEP is filled in with the difference
669 between the VMAs from which the segments were read, and the VMAs
670 the file headers (and hence BFD's idea of each section's VMA) put
671 them at.
672
673 The function TARGET_READ_MEMORY is called to copy LEN bytes from
674 the remote memory at target address VMA into the local buffer at
675 MYADDR; it should return zero on success or an `errno' code on
676 failure. TEMPL must be a BFD for a target with the word size and
677 byte order found in the remote memory. */
678 extern bfd *bfd_elf_bfd_from_remote_memory
679 (bfd *templ, bfd_vma ehdr_vma, bfd_size_type size, bfd_vma *loadbasep,
680 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr,
681 bfd_size_type len));
682
683 extern struct bfd_section *_bfd_elf_tls_setup
684 (bfd *, struct bfd_link_info *);
685
686 extern struct bfd_section *
687 _bfd_nearby_section (bfd *, struct bfd_section *, bfd_vma);
688
689 extern void _bfd_fix_excluded_sec_syms
690 (bfd *, struct bfd_link_info *);
691
692 extern unsigned bfd_m68k_mach_to_features (int);
693
694 extern int bfd_m68k_features_to_mach (unsigned);
695
696 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
697 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
698 char **);
699
700 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info *, int);
701
702 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
703 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
704 char **);
705
706 extern bfd_boolean bfd_cr16_elf32_create_embedded_relocs
707 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
708 char **);
709
710 /* SunOS shared library support routines for the linker. */
711
712 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
713 (bfd *, struct bfd_link_info *);
714 extern bfd_boolean bfd_sunos_record_link_assignment
715 (bfd *, struct bfd_link_info *, const char *);
716 extern bfd_boolean bfd_sunos_size_dynamic_sections
717 (bfd *, struct bfd_link_info *, struct bfd_section **,
718 struct bfd_section **, struct bfd_section **);
719
720 /* Linux shared library support routines for the linker. */
721
722 extern bfd_boolean bfd_i386linux_size_dynamic_sections
723 (bfd *, struct bfd_link_info *);
724 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
725 (bfd *, struct bfd_link_info *);
726
727 /* mmap hacks */
728
729 struct _bfd_window_internal;
730 typedef struct _bfd_window_internal bfd_window_internal;
731
732 typedef struct _bfd_window
733 {
734 /* What the user asked for. */
735 void *data;
736 bfd_size_type size;
737 /* The actual window used by BFD. Small user-requested read-only
738 regions sharing a page may share a single window into the object
739 file. Read-write versions shouldn't until I've fixed things to
740 keep track of which portions have been claimed by the
741 application; don't want to give the same region back when the
742 application wants two writable copies! */
743 struct _bfd_window_internal *i;
744 }
745 bfd_window;
746
747 extern void bfd_init_window
748 (bfd_window *);
749 extern void bfd_free_window
750 (bfd_window *);
751 extern bfd_boolean bfd_get_file_window
752 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
753
754 /* XCOFF support routines for the linker. */
755
756 extern bfd_boolean bfd_xcoff_split_import_path
757 (bfd *, const char *, const char **, const char **);
758 extern bfd_boolean bfd_xcoff_set_archive_import_path
759 (struct bfd_link_info *, bfd *, const char *);
760 extern bfd_boolean bfd_xcoff_link_record_set
761 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
762 extern bfd_boolean bfd_xcoff_import_symbol
763 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
764 const char *, const char *, const char *, unsigned int);
765 extern bfd_boolean bfd_xcoff_export_symbol
766 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
767 extern bfd_boolean bfd_xcoff_link_count_reloc
768 (bfd *, struct bfd_link_info *, const char *);
769 extern bfd_boolean bfd_xcoff_record_link_assignment
770 (bfd *, struct bfd_link_info *, const char *);
771 extern bfd_boolean bfd_xcoff_size_dynamic_sections
772 (bfd *, struct bfd_link_info *, const char *, const char *,
773 unsigned long, unsigned long, unsigned long, bfd_boolean,
774 int, bfd_boolean, unsigned int, struct bfd_section **, bfd_boolean);
775 extern bfd_boolean bfd_xcoff_link_generate_rtinit
776 (bfd *, const char *, const char *, bfd_boolean);
777
778 /* XCOFF support routines for ar. */
779 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
780 (bfd *, char *);
781
782 /* Externally visible COFF routines. */
783
784 #if defined(__STDC__) || defined(ALMOST_STDC)
785 struct internal_syment;
786 union internal_auxent;
787 #endif
788
789 extern bfd_boolean bfd_coff_set_symbol_class
790 (bfd *, struct bfd_symbol *, unsigned int);
791
792 /* ARM VFP11 erratum workaround support. */
793 typedef enum
794 {
795 BFD_ARM_VFP11_FIX_DEFAULT,
796 BFD_ARM_VFP11_FIX_NONE,
797 BFD_ARM_VFP11_FIX_SCALAR,
798 BFD_ARM_VFP11_FIX_VECTOR
799 } bfd_arm_vfp11_fix;
800
801 extern void bfd_elf32_arm_init_maps
802 (bfd *);
803
804 extern void bfd_elf32_arm_set_vfp11_fix
805 (bfd *, struct bfd_link_info *);
806
807 extern void bfd_elf32_arm_set_cortex_a8_fix
808 (bfd *, struct bfd_link_info *);
809
810 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
811 (bfd *, struct bfd_link_info *);
812
813 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
814 (bfd *, struct bfd_link_info *);
815
816 /* ARM STM STM32L4XX erratum workaround support. */
817 typedef enum
818 {
819 BFD_ARM_STM32L4XX_FIX_NONE,
820 BFD_ARM_STM32L4XX_FIX_DEFAULT,
821 BFD_ARM_STM32L4XX_FIX_ALL
822 } bfd_arm_stm32l4xx_fix;
823
824 extern void bfd_elf32_arm_set_stm32l4xx_fix
825 (bfd *, struct bfd_link_info *);
826
827 extern bfd_boolean bfd_elf32_arm_stm32l4xx_erratum_scan
828 (bfd *, struct bfd_link_info *);
829
830 extern void bfd_elf32_arm_stm32l4xx_fix_veneer_locations
831 (bfd *, struct bfd_link_info *);
832
833 /* ARM Interworking support. Called from linker. */
834 extern bfd_boolean bfd_arm_allocate_interworking_sections
835 (struct bfd_link_info *);
836
837 extern bfd_boolean bfd_arm_process_before_allocation
838 (bfd *, struct bfd_link_info *, int);
839
840 extern bfd_boolean bfd_arm_get_bfd_for_interworking
841 (bfd *, struct bfd_link_info *);
842
843 /* PE ARM Interworking support. Called from linker. */
844 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
845 (struct bfd_link_info *);
846
847 extern bfd_boolean bfd_arm_pe_process_before_allocation
848 (bfd *, struct bfd_link_info *, int);
849
850 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
851 (bfd *, struct bfd_link_info *);
852
853 /* ELF ARM Interworking support. Called from linker. */
854 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
855 (struct bfd_link_info *);
856
857 extern bfd_boolean bfd_elf32_arm_process_before_allocation
858 (bfd *, struct bfd_link_info *);
859
860 struct elf32_arm_params {
861 char *thumb_entry_symbol;
862 int byteswap_code;
863 int target1_is_rel;
864 char * target2_type;
865 int fix_v4bx;
866 int use_blx;
867 bfd_arm_vfp11_fix vfp11_denorm_fix;
868 bfd_arm_stm32l4xx_fix stm32l4xx_fix;
869 int no_enum_size_warning;
870 int no_wchar_size_warning;
871 int pic_veneer;
872 int fix_cortex_a8;
873 int fix_arm1176;
874 int merge_exidx_entries;
875 int cmse_implib;
876 bfd *in_implib_bfd;
877 };
878
879 void bfd_elf32_arm_set_target_params
880 (bfd *, struct bfd_link_info *, struct elf32_arm_params *);
881
882 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
883 (bfd *, struct bfd_link_info *);
884
885 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
886 (bfd *, struct bfd_link_info *);
887
888 extern void bfd_elf32_arm_keep_private_stub_output_sections
889 (struct bfd_link_info *);
890
891 /* ELF ARM mapping symbol support. */
892 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
893 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
894 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
895 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
896
897 extern bfd_boolean bfd_is_arm_special_symbol_name
898 (const char *, int);
899
900 extern void bfd_elf32_arm_set_byteswap_code
901 (struct bfd_link_info *, int);
902
903 extern void bfd_elf32_arm_use_long_plt (void);
904
905 /* ARM Note section processing. */
906 extern bfd_boolean bfd_arm_merge_machines
907 (bfd *, bfd *);
908
909 extern bfd_boolean bfd_arm_update_notes
910 (bfd *, const char *);
911
912 extern unsigned int bfd_arm_get_mach_from_notes
913 (bfd *, const char *);
914
915 /* ARM stub generation support. Called from the linker. */
916 extern int elf32_arm_setup_section_lists
917 (bfd *, struct bfd_link_info *);
918 extern void elf32_arm_next_input_section
919 (struct bfd_link_info *, struct bfd_section *);
920 extern bfd_boolean elf32_arm_size_stubs
921 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
922 struct bfd_section * (*) (const char *, struct bfd_section *,
923 struct bfd_section *, unsigned int),
924 void (*) (void));
925 extern bfd_boolean elf32_arm_build_stubs
926 (struct bfd_link_info *);
927
928 /* ARM unwind section editing support. */
929 extern bfd_boolean elf32_arm_fix_exidx_coverage
930 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
931
932 /* C6x unwind section editing support. */
933 extern bfd_boolean elf32_tic6x_fix_exidx_coverage
934 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
935
936 extern void bfd_elf64_aarch64_init_maps
937 (bfd *);
938
939 extern void bfd_elf32_aarch64_init_maps
940 (bfd *);
941
942 /* Types of PLTs based on the level of security. This would be a
943 bit-mask to denote which of the combinations of security features
944 are enabled:
945 - No security feature PLTs
946 - PLTs with BTI instruction
947 - PLTs with PAC instruction
948 */
949 typedef enum
950 {
951 PLT_NORMAL = 0x0, /* Normal plts. */
952 PLT_BTI = 0x1, /* plts with bti. */
953 PLT_PAC = 0x2, /* plts with pointer authentication. */
954 PLT_BTI_PAC = PLT_BTI | PLT_PAC
955 } aarch64_plt_type;
956
957 /* To indicate if BTI is enabled with/without warning. */
958 typedef enum
959 {
960 BTI_NONE = 0, /* BTI is not enabled. */
961 BTI_WARN = 1, /* BTI is enabled with -z force-bti. */
962 } aarch64_enable_bti_type;
963
964 /* A structure to encompass all information coming from BTI or PAC
965 related command line options. This involves the "PLT_TYPE" to determine
966 which version of PLTs to pick and "BTI_TYPE" to determine if
967 BTI should be turned on with any warnings. */
968 typedef struct
969 {
970 aarch64_plt_type plt_type;
971 aarch64_enable_bti_type bti_type;
972 } aarch64_bti_pac_info;
973
974 /* An enum to define what kind of erratum fixes we should apply. This gives the
975 user a bit more control over the sequences we generate. */
976 typedef enum
977 {
978 ERRAT_NONE = (1 << 0), /* No erratum workarounds allowed. */
979 ERRAT_ADR = (1 << 1), /* Erratum workarounds using ADR allowed. */
980 ERRAT_ADRP = (1 << 2), /* Erratum workarounds using ADRP are allowed. */
981 } erratum_84319_opts;
982
983 extern void bfd_elf64_aarch64_set_options
984 (bfd *, struct bfd_link_info *, int, int, int, int, erratum_84319_opts, int,
985 aarch64_bti_pac_info);
986
987 extern void bfd_elf32_aarch64_set_options
988 (bfd *, struct bfd_link_info *, int, int, int, int, erratum_84319_opts, int,
989 aarch64_bti_pac_info);
990
991 /* ELF AArch64 mapping symbol support. */
992 #define BFD_AARCH64_SPECIAL_SYM_TYPE_MAP (1 << 0)
993 #define BFD_AARCH64_SPECIAL_SYM_TYPE_TAG (1 << 1)
994 #define BFD_AARCH64_SPECIAL_SYM_TYPE_OTHER (1 << 2)
995 #define BFD_AARCH64_SPECIAL_SYM_TYPE_ANY (~0)
996 extern bfd_boolean bfd_is_aarch64_special_symbol_name
997 (const char * name, int type);
998
999 /* AArch64 stub generation support for ELF64. Called from the linker. */
1000 extern int elf64_aarch64_setup_section_lists
1001 (bfd *, struct bfd_link_info *);
1002 extern void elf64_aarch64_next_input_section
1003 (struct bfd_link_info *, struct bfd_section *);
1004 extern bfd_boolean elf64_aarch64_size_stubs
1005 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
1006 struct bfd_section * (*) (const char *, struct bfd_section *),
1007 void (*) (void));
1008 extern bfd_boolean elf64_aarch64_build_stubs
1009 (struct bfd_link_info *);
1010 /* AArch64 stub generation support for ELF32. Called from the linker. */
1011 extern int elf32_aarch64_setup_section_lists
1012 (bfd *, struct bfd_link_info *);
1013 extern void elf32_aarch64_next_input_section
1014 (struct bfd_link_info *, struct bfd_section *);
1015 extern bfd_boolean elf32_aarch64_size_stubs
1016 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
1017 struct bfd_section * (*) (const char *, struct bfd_section *),
1018 void (*) (void));
1019 extern bfd_boolean elf32_aarch64_build_stubs
1020 (struct bfd_link_info *);
1021
1022
1023 /* TI COFF load page support. */
1024 extern void bfd_ticoff_set_section_load_page
1025 (struct bfd_section *, int);
1026
1027 extern int bfd_ticoff_get_section_load_page
1028 (struct bfd_section *);
1029
1030 /* H8/300 functions. */
1031 extern bfd_vma bfd_h8300_pad_address
1032 (bfd *, bfd_vma);
1033
1034 /* IA64 Itanium code generation. Called from linker. */
1035 extern void bfd_elf32_ia64_after_parse
1036 (int);
1037
1038 extern void bfd_elf64_ia64_after_parse
1039 (int);
1040
1041 /* V850 Note manipulation routines. */
1042 extern bfd_boolean v850_elf_create_sections
1043 (struct bfd_link_info *);
1044
1045 extern bfd_boolean v850_elf_set_note
1046 (bfd *, unsigned int, unsigned int);
1047
1048 /* MIPS ABI flags data access. For the disassembler. */
1049 struct elf_internal_abiflags_v0;
1050 extern struct elf_internal_abiflags_v0 *bfd_mips_elf_get_abiflags (bfd *);
1051
1052 /* C-SKY functions. */
1053 extern bfd_boolean elf32_csky_build_stubs
1054 (struct bfd_link_info *);
1055 extern bfd_boolean elf32_csky_size_stubs
1056 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
1057 struct bfd_section *(*) (const char*, struct bfd_section*),
1058 void (*) (void));
1059 extern void elf32_csky_next_input_section
1060 (struct bfd_link_info *, struct bfd_section *);
1061 extern int elf32_csky_setup_section_lists
1062 (bfd *, struct bfd_link_info *);
This page took 0.049721 seconds and 5 git commands to generate.