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