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