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