* ld-elf/header.d: Allow arbitrary lines between "Program Header"
[binutils.git] / bfd / bfd-in.h
blob342c6c1c29fdc7f553c8f5c6ddc3c1969d5326b3
1 /* Main header file for the bfd library -- portable access to object files.
3 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006
5 Free Software Foundation, Inc.
7 Contributed by Cygnus Support.
9 This file is part of BFD, the Binary File Descriptor library.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
25 #ifndef __BFD_H_SEEN__
26 #define __BFD_H_SEEN__
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
32 #include "ansidecl.h"
33 #include "symcat.h"
34 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
35 #ifndef SABER
36 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
37 The problem is, "32_" is not a valid preprocessing token, and we don't
38 want extra underscores (e.g., "nlm_32_"). The XCONCAT2 macro will
39 cause the inner CONCAT2 macros to be evaluated first, producing
40 still-valid pp-tokens. Then the final concatenation can be done. */
41 #undef CONCAT4
42 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
43 #endif
44 #endif
46 /* This is a utility macro to handle the situation where the code
47 wants to place a constant string into the code, followed by a
48 comma and then the length of the string. Doing this by hand
49 is error prone, so using this macro is safer. The macro will
50 also safely handle the case where a NULL is passed as the arg. */
51 #define STRING_COMMA_LEN(STR) (STR), ((STR) ? sizeof (STR) - 1 : 0)
52 /* Unfortunately it is not possible to use the STRING_COMMA_LEN macro
53 to create the arguments to another macro, since the preprocessor
54 will mis-count the number of arguments to the outer macro (by not
55 evaluating STRING_COMMA_LEN and so missing the comma). This is a
56 problem for example when trying to use STRING_COMMA_LEN to build
57 the arguments to the strncmp() macro. Hence this alternative
58 definition of strncmp is provided here.
60 Note - these macros do NOT work if STR2 is not a constant string. */
61 #define CONST_STRNEQ(STR1,STR2) (strncmp ((STR1), (STR2), sizeof (STR2) - 1) == 0)
62 /* strcpy() can have a similar problem, but since we know we are
63 copying a constant string, we can use memcpy which will be faster
64 since there is no need to check for a NUL byte inside STR. We
65 can also save time if we do not need to copy the terminating NUL. */
66 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1)
67 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2))
70 /* The word size used by BFD on the host. This may be 64 with a 32
71 bit target if the host is 64 bit, or if other 64 bit targets have
72 been selected with --enable-targets, or if --enable-64-bit-bfd. */
73 #define BFD_ARCH_SIZE @wordsize@
75 /* The word size of the default bfd target. */
76 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
78 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
79 #define BFD_HOST_LONG_LONG @BFD_HOST_LONG_LONG@
80 #if @BFD_HOST_64_BIT_DEFINED@
81 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
82 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
83 typedef BFD_HOST_64_BIT bfd_int64_t;
84 typedef BFD_HOST_U_64_BIT bfd_uint64_t;
85 #endif
87 #if BFD_ARCH_SIZE >= 64
88 #define BFD64
89 #endif
91 #ifndef INLINE
92 #if __GNUC__ >= 2
93 #define INLINE __inline__
94 #else
95 #define INLINE
96 #endif
97 #endif
99 /* Forward declaration. */
100 typedef struct bfd bfd;
102 /* Boolean type used in bfd. Too many systems define their own
103 versions of "boolean" for us to safely typedef a "boolean" of
104 our own. Using an enum for "bfd_boolean" has its own set of
105 problems, with strange looking casts required to avoid warnings
106 on some older compilers. Thus we just use an int.
108 General rule: Functions which are bfd_boolean return TRUE on
109 success and FALSE on failure (unless they're a predicate). */
111 typedef int bfd_boolean;
112 #undef FALSE
113 #undef TRUE
114 #define FALSE 0
115 #define TRUE 1
117 #ifdef BFD64
119 #ifndef BFD_HOST_64_BIT
120 #error No 64 bit integer type available
121 #endif /* ! defined (BFD_HOST_64_BIT) */
123 typedef BFD_HOST_U_64_BIT bfd_vma;
124 typedef BFD_HOST_64_BIT bfd_signed_vma;
125 typedef BFD_HOST_U_64_BIT bfd_size_type;
126 typedef BFD_HOST_U_64_BIT symvalue;
128 #ifndef fprintf_vma
129 #if BFD_HOST_64BIT_LONG
130 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
131 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
132 #else
133 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
134 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
135 #define fprintf_vma(s,x) \
136 fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
137 #define sprintf_vma(s,x) \
138 sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
139 #endif
140 #endif
142 #else /* not BFD64 */
144 /* Represent a target address. Also used as a generic unsigned type
145 which is guaranteed to be big enough to hold any arithmetic types
146 we need to deal with. */
147 typedef unsigned long bfd_vma;
149 /* A generic signed type which is guaranteed to be big enough to hold any
150 arithmetic types we need to deal with. Can be assumed to be compatible
151 with bfd_vma in the same way that signed and unsigned ints are compatible
152 (as parameters, in assignment, etc). */
153 typedef long bfd_signed_vma;
155 typedef unsigned long symvalue;
156 typedef unsigned long bfd_size_type;
158 /* Print a bfd_vma x on stream s. */
159 #define fprintf_vma(s,x) fprintf (s, "%08lx", x)
160 #define sprintf_vma(s,x) sprintf (s, "%08lx", x)
162 #endif /* not BFD64 */
164 #define HALF_BFD_SIZE_TYPE \
165 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
167 #ifndef BFD_HOST_64_BIT
168 /* Fall back on a 32 bit type. The idea is to make these types always
169 available for function return types, but in the case that
170 BFD_HOST_64_BIT is undefined such a function should abort or
171 otherwise signal an error. */
172 typedef bfd_signed_vma bfd_int64_t;
173 typedef bfd_vma bfd_uint64_t;
174 #endif
176 /* An offset into a file. BFD always uses the largest possible offset
177 based on the build time availability of fseek, fseeko, or fseeko64. */
178 typedef @bfd_file_ptr@ file_ptr;
179 typedef unsigned @bfd_file_ptr@ ufile_ptr;
181 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
182 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
184 #define printf_vma(x) fprintf_vma(stdout,x)
185 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
187 typedef unsigned int flagword; /* 32 bits of flags */
188 typedef unsigned char bfd_byte;
190 /* File formats. */
192 typedef enum bfd_format
194 bfd_unknown = 0, /* File format is unknown. */
195 bfd_object, /* Linker/assembler/compiler output. */
196 bfd_archive, /* Object archive file. */
197 bfd_core, /* Core dump. */
198 bfd_type_end /* Marks the end; don't use it! */
200 bfd_format;
202 /* Values that may appear in the flags field of a BFD. These also
203 appear in the object_flags field of the bfd_target structure, where
204 they indicate the set of flags used by that backend (not all flags
205 are meaningful for all object file formats) (FIXME: at the moment,
206 the object_flags values have mostly just been copied from backend
207 to another, and are not necessarily correct). */
209 /* No flags. */
210 #define BFD_NO_FLAGS 0x00
212 /* BFD contains relocation entries. */
213 #define HAS_RELOC 0x01
215 /* BFD is directly executable. */
216 #define EXEC_P 0x02
218 /* BFD has line number information (basically used for F_LNNO in a
219 COFF header). */
220 #define HAS_LINENO 0x04
222 /* BFD has debugging information. */
223 #define HAS_DEBUG 0x08
225 /* BFD has symbols. */
226 #define HAS_SYMS 0x10
228 /* BFD has local symbols (basically used for F_LSYMS in a COFF
229 header). */
230 #define HAS_LOCALS 0x20
232 /* BFD is a dynamic object. */
233 #define DYNAMIC 0x40
235 /* Text section is write protected (if D_PAGED is not set, this is
236 like an a.out NMAGIC file) (the linker sets this by default, but
237 clears it for -r or -N). */
238 #define WP_TEXT 0x80
240 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
241 linker sets this by default, but clears it for -r or -n or -N). */
242 #define D_PAGED 0x100
244 /* BFD is relaxable (this means that bfd_relax_section may be able to
245 do something) (sometimes bfd_relax_section can do something even if
246 this is not set). */
247 #define BFD_IS_RELAXABLE 0x200
249 /* This may be set before writing out a BFD to request using a
250 traditional format. For example, this is used to request that when
251 writing out an a.out object the symbols not be hashed to eliminate
252 duplicates. */
253 #define BFD_TRADITIONAL_FORMAT 0x400
255 /* This flag indicates that the BFD contents are actually cached in
256 memory. If this is set, iostream points to a bfd_in_memory struct. */
257 #define BFD_IN_MEMORY 0x800
259 /* The sections in this BFD specify a memory page. */
260 #define HAS_LOAD_PAGE 0x1000
262 /* This BFD has been created by the linker and doesn't correspond
263 to any input file. */
264 #define BFD_LINKER_CREATED 0x2000
266 /* Symbols and relocation. */
268 /* A count of carsyms (canonical archive symbols). */
269 typedef unsigned long symindex;
271 /* How to perform a relocation. */
272 typedef const struct reloc_howto_struct reloc_howto_type;
274 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
276 /* General purpose part of a symbol X;
277 target specific parts are in libcoff.h, libaout.h, etc. */
279 #define bfd_get_section(x) ((x)->section)
280 #define bfd_get_output_section(x) ((x)->section->output_section)
281 #define bfd_set_section(x,y) ((x)->section) = (y)
282 #define bfd_asymbol_base(x) ((x)->section->vma)
283 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
284 #define bfd_asymbol_name(x) ((x)->name)
285 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
286 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
287 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
289 /* A canonical archive symbol. */
290 /* This is a type pun with struct ranlib on purpose! */
291 typedef struct carsym
293 char *name;
294 file_ptr file_offset; /* Look here to find the file. */
296 carsym; /* To make these you call a carsymogen. */
298 /* Used in generating armaps (archive tables of contents).
299 Perhaps just a forward definition would do? */
300 struct orl /* Output ranlib. */
302 char **name; /* Symbol name. */
303 union
305 file_ptr pos;
306 bfd *abfd;
307 } u; /* bfd* or file position. */
308 int namidx; /* Index into string table. */
311 /* Linenumber stuff. */
312 typedef struct lineno_cache_entry
314 unsigned int line_number; /* Linenumber from start of function. */
315 union
317 struct bfd_symbol *sym; /* Function name. */
318 bfd_vma offset; /* Offset into section. */
319 } u;
321 alent;
323 /* Object and core file sections. */
325 #define align_power(addr, align) \
326 (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align)))
328 typedef struct bfd_section *sec_ptr;
330 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
331 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
332 #define bfd_get_section_lma(bfd, ptr) ((ptr)->lma + 0)
333 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
334 #define bfd_section_name(bfd, ptr) ((ptr)->name)
335 #define bfd_section_size(bfd, ptr) ((ptr)->size)
336 #define bfd_get_section_size(ptr) ((ptr)->size)
337 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
338 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
339 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
340 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
341 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
343 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
345 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma = (val)), ((ptr)->user_set_vma = TRUE), TRUE)
346 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),TRUE)
347 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),TRUE)
348 /* Find the address one past the end of SEC. */
349 #define bfd_get_section_limit(bfd, sec) \
350 (((sec)->rawsize ? (sec)->rawsize : (sec)->size) \
351 / bfd_octets_per_byte (bfd))
353 /* Forward define. */
354 struct stat;
356 typedef enum bfd_print_symbol
358 bfd_print_symbol_name,
359 bfd_print_symbol_more,
360 bfd_print_symbol_all
361 } bfd_print_symbol_type;
363 /* Information about a symbol that nm needs. */
365 typedef struct _symbol_info
367 symvalue value;
368 char type;
369 const char *name; /* Symbol name. */
370 unsigned char stab_type; /* Stab type. */
371 char stab_other; /* Stab other. */
372 short stab_desc; /* Stab desc. */
373 const char *stab_name; /* String for stab type. */
374 } symbol_info;
376 /* Get the name of a stabs type code. */
378 extern const char *bfd_get_stab_name (int);
380 /* Hash table routines. There is no way to free up a hash table. */
382 /* An element in the hash table. Most uses will actually use a larger
383 structure, and an instance of this will be the first field. */
385 struct bfd_hash_entry
387 /* Next entry for this hash code. */
388 struct bfd_hash_entry *next;
389 /* String being hashed. */
390 const char *string;
391 /* Hash code. This is the full hash code, not the index into the
392 table. */
393 unsigned long hash;
396 /* A hash table. */
398 struct bfd_hash_table
400 /* The hash array. */
401 struct bfd_hash_entry **table;
402 /* A function used to create new elements in the hash table. The
403 first entry is itself a pointer to an element. When this
404 function is first invoked, this pointer will be NULL. However,
405 having the pointer permits a hierarchy of method functions to be
406 built each of which calls the function in the superclass. Thus
407 each function should be written to allocate a new block of memory
408 only if the argument is NULL. */
409 struct bfd_hash_entry *(*newfunc)
410 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
411 /* An objalloc for this hash table. This is a struct objalloc *,
412 but we use void * to avoid requiring the inclusion of objalloc.h. */
413 void *memory;
414 /* The number of slots in the hash table. */
415 unsigned int size;
416 /* The number of entries in the hash table. */
417 unsigned int count;
418 /* The size of elements. */
419 unsigned int entsize;
420 /* If non-zero, don't grow the hash table. */
421 unsigned int frozen:1;
424 /* Initialize a hash table. */
425 extern bfd_boolean bfd_hash_table_init
426 (struct bfd_hash_table *,
427 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
428 struct bfd_hash_table *,
429 const char *),
430 unsigned int);
432 /* Initialize a hash table specifying a size. */
433 extern bfd_boolean bfd_hash_table_init_n
434 (struct bfd_hash_table *,
435 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
436 struct bfd_hash_table *,
437 const char *),
438 unsigned int, unsigned int);
440 /* Free up a hash table. */
441 extern void bfd_hash_table_free
442 (struct bfd_hash_table *);
444 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
445 will be created for this string if one does not already exist. The
446 COPY argument must be TRUE if this routine should copy the string
447 into newly allocated memory when adding an entry. */
448 extern struct bfd_hash_entry *bfd_hash_lookup
449 (struct bfd_hash_table *, const char *, bfd_boolean create,
450 bfd_boolean copy);
452 /* Replace an entry in a hash table. */
453 extern void bfd_hash_replace
454 (struct bfd_hash_table *, struct bfd_hash_entry *old,
455 struct bfd_hash_entry *nw);
457 /* Base method for creating a hash table entry. */
458 extern struct bfd_hash_entry *bfd_hash_newfunc
459 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
461 /* Grab some space for a hash table entry. */
462 extern void *bfd_hash_allocate
463 (struct bfd_hash_table *, unsigned int);
465 /* Traverse a hash table in a random order, calling a function on each
466 element. If the function returns FALSE, the traversal stops. The
467 INFO argument is passed to the function. */
468 extern void bfd_hash_traverse
469 (struct bfd_hash_table *,
470 bfd_boolean (*) (struct bfd_hash_entry *, void *),
471 void *info);
473 /* Allows the default size of a hash table to be configured. New hash
474 tables allocated using bfd_hash_table_init will be created with
475 this size. */
476 extern void bfd_hash_set_default_size (bfd_size_type);
478 /* This structure is used to keep track of stabs in sections
479 information while linking. */
481 struct stab_info
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;
491 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
493 /* User program access to BFD facilities. */
495 /* Direct I/O routines, for programs which know more about the object
496 file than BFD does. Use higher level routines if possible. */
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 *);
505 /* Deprecated old routines. */
506 #if __GNUC__
507 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
508 (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
509 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
510 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
511 (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 (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 (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
519 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
520 #endif
521 extern void warn_deprecated (const char *, const char *, int, const char *);
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_my_archive(abfd) ((abfd)->my_archive)
543 #define bfd_has_map(abfd) ((abfd)->has_armap)
545 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
546 #define bfd_usrdata(abfd) ((abfd)->usrdata)
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)
553 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
555 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
557 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = bool), TRUE)
559 extern bfd_boolean bfd_cache_close
560 (bfd *abfd);
561 /* NB: This declaration should match the autogenerated one in libbfd.h. */
563 extern bfd_boolean bfd_cache_close_all (void);
565 extern bfd_boolean bfd_record_phdr
566 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
567 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
569 /* Byte swapping routines. */
571 bfd_uint64_t bfd_getb64 (const void *);
572 bfd_uint64_t bfd_getl64 (const void *);
573 bfd_int64_t bfd_getb_signed_64 (const void *);
574 bfd_int64_t bfd_getl_signed_64 (const void *);
575 bfd_vma bfd_getb32 (const void *);
576 bfd_vma bfd_getl32 (const void *);
577 bfd_signed_vma bfd_getb_signed_32 (const void *);
578 bfd_signed_vma bfd_getl_signed_32 (const void *);
579 bfd_vma bfd_getb16 (const void *);
580 bfd_vma bfd_getl16 (const void *);
581 bfd_signed_vma bfd_getb_signed_16 (const void *);
582 bfd_signed_vma bfd_getl_signed_16 (const void *);
583 void bfd_putb64 (bfd_uint64_t, void *);
584 void bfd_putl64 (bfd_uint64_t, void *);
585 void bfd_putb32 (bfd_vma, void *);
586 void bfd_putl32 (bfd_vma, void *);
587 void bfd_putb16 (bfd_vma, void *);
588 void bfd_putl16 (bfd_vma, void *);
590 /* Byte swapping routines which take size and endiannes as arguments. */
592 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
593 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
595 extern bfd_boolean bfd_section_already_linked_table_init (void);
596 extern void bfd_section_already_linked_table_free (void);
598 /* Externally visible ECOFF routines. */
600 #if defined(__STDC__) || defined(ALMOST_STDC)
601 struct ecoff_debug_info;
602 struct ecoff_debug_swap;
603 struct ecoff_extr;
604 struct bfd_symbol;
605 struct bfd_link_info;
606 struct bfd_link_hash_entry;
607 struct bfd_elf_version_tree;
608 #endif
609 extern bfd_vma bfd_ecoff_get_gp_value
610 (bfd * abfd);
611 extern bfd_boolean bfd_ecoff_set_gp_value
612 (bfd *abfd, bfd_vma gp_value);
613 extern bfd_boolean bfd_ecoff_set_regmasks
614 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
615 unsigned long *cprmask);
616 extern void *bfd_ecoff_debug_init
617 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
618 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
619 extern void bfd_ecoff_debug_free
620 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
621 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
622 extern bfd_boolean bfd_ecoff_debug_accumulate
623 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
624 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
625 struct ecoff_debug_info *input_debug,
626 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
627 extern bfd_boolean bfd_ecoff_debug_accumulate_other
628 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
629 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
630 struct bfd_link_info *);
631 extern bfd_boolean bfd_ecoff_debug_externals
632 (bfd *abfd, struct ecoff_debug_info *debug,
633 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
634 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
635 void (*set_index) (struct bfd_symbol *, bfd_size_type));
636 extern bfd_boolean bfd_ecoff_debug_one_external
637 (bfd *abfd, struct ecoff_debug_info *debug,
638 const struct ecoff_debug_swap *swap, const char *name,
639 struct ecoff_extr *esym);
640 extern bfd_size_type bfd_ecoff_debug_size
641 (bfd *abfd, struct ecoff_debug_info *debug,
642 const struct ecoff_debug_swap *swap);
643 extern bfd_boolean bfd_ecoff_write_debug
644 (bfd *abfd, struct ecoff_debug_info *debug,
645 const struct ecoff_debug_swap *swap, file_ptr where);
646 extern bfd_boolean bfd_ecoff_write_accumulated_debug
647 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
648 const struct ecoff_debug_swap *swap,
649 struct bfd_link_info *info, file_ptr where);
651 /* Externally visible ELF routines. */
653 struct bfd_link_needed_list
655 struct bfd_link_needed_list *next;
656 bfd *by;
657 const char *name;
660 enum dynamic_lib_link_class {
661 DYN_NORMAL = 0,
662 DYN_AS_NEEDED = 1,
663 DYN_DT_NEEDED = 2,
664 DYN_NO_ADD_NEEDED = 4,
665 DYN_NO_NEEDED = 8
668 enum notice_asneeded_action {
669 notice_as_needed,
670 notice_not_needed,
671 notice_needed
674 extern bfd_boolean bfd_elf_record_link_assignment
675 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
676 bfd_boolean);
677 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
678 (bfd *, struct bfd_link_info *);
679 extern bfd_boolean bfd_elf_get_bfd_needed_list
680 (bfd *, struct bfd_link_needed_list **);
681 extern bfd_boolean bfd_elf_size_dynamic_sections
682 (bfd *, const char *, const char *, const char *, const char * const *,
683 struct bfd_link_info *, struct bfd_section **,
684 struct bfd_elf_version_tree *);
685 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
686 (bfd *, struct bfd_link_info *);
687 extern void bfd_elf_set_dt_needed_name
688 (bfd *, const char *);
689 extern const char *bfd_elf_get_dt_soname
690 (bfd *);
691 extern void bfd_elf_set_dyn_lib_class
692 (bfd *, enum dynamic_lib_link_class);
693 extern int bfd_elf_get_dyn_lib_class
694 (bfd *);
695 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
696 (bfd *, struct bfd_link_info *);
697 extern bfd_boolean bfd_elf_discard_info
698 (bfd *, struct bfd_link_info *);
699 extern unsigned int _bfd_elf_default_action_discarded
700 (struct bfd_section *);
702 /* Return an upper bound on the number of bytes required to store a
703 copy of ABFD's program header table entries. Return -1 if an error
704 occurs; bfd_get_error will return an appropriate code. */
705 extern long bfd_get_elf_phdr_upper_bound
706 (bfd *abfd);
708 /* Copy ABFD's program header table entries to *PHDRS. The entries
709 will be stored as an array of Elf_Internal_Phdr structures, as
710 defined in include/elf/internal.h. To find out how large the
711 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
713 Return the number of program header table entries read, or -1 if an
714 error occurs; bfd_get_error will return an appropriate code. */
715 extern int bfd_get_elf_phdrs
716 (bfd *abfd, void *phdrs);
718 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
719 reconstruct an ELF file by reading the segments out of remote memory
720 based on the ELF file header at EHDR_VMA and the ELF program headers it
721 points to. If not null, *LOADBASEP is filled in with the difference
722 between the VMAs from which the segments were read, and the VMAs the
723 file headers (and hence BFD's idea of each section's VMA) put them at.
725 The function TARGET_READ_MEMORY is called to copy LEN bytes from the
726 remote memory at target address VMA into the local buffer at MYADDR; it
727 should return zero on success or an `errno' code on failure. TEMPL must
728 be a BFD for an ELF target with the word size and byte order found in
729 the remote memory. */
730 extern bfd *bfd_elf_bfd_from_remote_memory
731 (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
732 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, int len));
734 /* Return the arch_size field of an elf bfd, or -1 if not elf. */
735 extern int bfd_get_arch_size
736 (bfd *);
738 /* Return TRUE if address "naturally" sign extends, or -1 if not elf. */
739 extern int bfd_get_sign_extend_vma
740 (bfd *);
742 extern struct bfd_section *_bfd_elf_tls_setup
743 (bfd *, struct bfd_link_info *);
745 extern void _bfd_fix_excluded_sec_syms
746 (bfd *, struct bfd_link_info *);
748 extern unsigned bfd_m68k_mach_to_features (int);
750 extern int bfd_m68k_features_to_mach (unsigned);
752 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
753 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
754 char **);
756 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
757 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
758 char **);
760 /* SunOS shared library support routines for the linker. */
762 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
763 (bfd *, struct bfd_link_info *);
764 extern bfd_boolean bfd_sunos_record_link_assignment
765 (bfd *, struct bfd_link_info *, const char *);
766 extern bfd_boolean bfd_sunos_size_dynamic_sections
767 (bfd *, struct bfd_link_info *, struct bfd_section **,
768 struct bfd_section **, struct bfd_section **);
770 /* Linux shared library support routines for the linker. */
772 extern bfd_boolean bfd_i386linux_size_dynamic_sections
773 (bfd *, struct bfd_link_info *);
774 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
775 (bfd *, struct bfd_link_info *);
776 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
777 (bfd *, struct bfd_link_info *);
779 /* mmap hacks */
781 struct _bfd_window_internal;
782 typedef struct _bfd_window_internal bfd_window_internal;
784 typedef struct _bfd_window
786 /* What the user asked for. */
787 void *data;
788 bfd_size_type size;
789 /* The actual window used by BFD. Small user-requested read-only
790 regions sharing a page may share a single window into the object
791 file. Read-write versions shouldn't until I've fixed things to
792 keep track of which portions have been claimed by the
793 application; don't want to give the same region back when the
794 application wants two writable copies! */
795 struct _bfd_window_internal *i;
797 bfd_window;
799 extern void bfd_init_window
800 (bfd_window *);
801 extern void bfd_free_window
802 (bfd_window *);
803 extern bfd_boolean bfd_get_file_window
804 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
806 /* XCOFF support routines for the linker. */
808 extern bfd_boolean bfd_xcoff_link_record_set
809 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
810 extern bfd_boolean bfd_xcoff_import_symbol
811 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
812 const char *, const char *, const char *, unsigned int);
813 extern bfd_boolean bfd_xcoff_export_symbol
814 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
815 extern bfd_boolean bfd_xcoff_link_count_reloc
816 (bfd *, struct bfd_link_info *, const char *);
817 extern bfd_boolean bfd_xcoff_record_link_assignment
818 (bfd *, struct bfd_link_info *, const char *);
819 extern bfd_boolean bfd_xcoff_size_dynamic_sections
820 (bfd *, struct bfd_link_info *, const char *, const char *,
821 unsigned long, unsigned long, unsigned long, bfd_boolean,
822 int, bfd_boolean, bfd_boolean, struct bfd_section **, bfd_boolean);
823 extern bfd_boolean bfd_xcoff_link_generate_rtinit
824 (bfd *, const char *, const char *, bfd_boolean);
826 /* XCOFF support routines for ar. */
827 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
828 (bfd *, char *);
830 /* Externally visible COFF routines. */
832 #if defined(__STDC__) || defined(ALMOST_STDC)
833 struct internal_syment;
834 union internal_auxent;
835 #endif
837 extern bfd_boolean bfd_coff_get_syment
838 (bfd *, struct bfd_symbol *, struct internal_syment *);
840 extern bfd_boolean bfd_coff_get_auxent
841 (bfd *, struct bfd_symbol *, int, union internal_auxent *);
843 extern bfd_boolean bfd_coff_set_symbol_class
844 (bfd *, struct bfd_symbol *, unsigned int);
846 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
847 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
849 /* ARM Interworking support. Called from linker. */
850 extern bfd_boolean bfd_arm_allocate_interworking_sections
851 (struct bfd_link_info *);
853 extern bfd_boolean bfd_arm_process_before_allocation
854 (bfd *, struct bfd_link_info *, int);
856 extern bfd_boolean bfd_arm_get_bfd_for_interworking
857 (bfd *, struct bfd_link_info *);
859 /* PE ARM Interworking support. Called from linker. */
860 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
861 (struct bfd_link_info *);
863 extern bfd_boolean bfd_arm_pe_process_before_allocation
864 (bfd *, struct bfd_link_info *, int);
866 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
867 (bfd *, struct bfd_link_info *);
869 /* ELF ARM Interworking support. Called from linker. */
870 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
871 (struct bfd_link_info *);
873 extern bfd_boolean bfd_elf32_arm_process_before_allocation
874 (bfd *, struct bfd_link_info *);
876 void bfd_elf32_arm_set_target_relocs
877 (struct bfd_link_info *, int, char *, int, int);
879 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
880 (bfd *, struct bfd_link_info *);
882 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
883 (bfd *, struct bfd_link_info *);
885 /* ELF ARM mapping symbol support */
886 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
887 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
888 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
889 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
890 extern bfd_boolean bfd_is_arm_special_symbol_name
891 (const char * name, int type);
893 extern void bfd_elf32_arm_set_byteswap_code (struct bfd_link_info *, int);
895 /* ARM Note section processing. */
896 extern bfd_boolean bfd_arm_merge_machines
897 (bfd *, bfd *);
899 extern bfd_boolean bfd_arm_update_notes
900 (bfd *, const char *);
902 extern unsigned int bfd_arm_get_mach_from_notes
903 (bfd *, const char *);
905 /* TI COFF load page support. */
906 extern void bfd_ticoff_set_section_load_page
907 (struct bfd_section *, int);
909 extern int bfd_ticoff_get_section_load_page
910 (struct bfd_section *);
912 /* H8/300 functions. */
913 extern bfd_vma bfd_h8300_pad_address
914 (bfd *, bfd_vma);
916 /* IA64 Itanium code generation. Called from linker. */
917 extern void bfd_elf32_ia64_after_parse
918 (int);
920 extern void bfd_elf64_ia64_after_parse
921 (int);
923 /* This structure is used for a comdat section, as in PE. A comdat
924 section is associated with a particular symbol. When the linker
925 sees a comdat section, it keeps only one of the sections with a
926 given name and associated with a given symbol. */
928 struct coff_comdat_info
930 /* The name of the symbol associated with a comdat section. */
931 const char *name;
933 /* The local symbol table index of the symbol associated with a
934 comdat section. This is only meaningful to the object file format
935 specific code; it is not an index into the list returned by
936 bfd_canonicalize_symtab. */
937 long symbol;
940 extern struct coff_comdat_info *bfd_coff_get_comdat_section
941 (bfd *, struct bfd_section *);