daily update
[binutils.git] / bfd / bfd-in.h
blobbe5c2e59fa7e279e1e1d334b536476b68ea60e8e
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, 2007
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 3 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. */
50 #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)
51 /* Unfortunately it is not possible to use the STRING_COMMA_LEN macro
52 to create the arguments to another macro, since the preprocessor
53 will mis-count the number of arguments to the outer macro (by not
54 evaluating STRING_COMMA_LEN and so missing the comma). This is a
55 problem for example when trying to use STRING_COMMA_LEN to build
56 the arguments to the strncmp() macro. Hence this alternative
57 definition of strncmp is provided here.
59 Note - these macros do NOT work if STR2 is not a constant string. */
60 #define CONST_STRNEQ(STR1,STR2) (strncmp ((STR1), (STR2), sizeof (STR2) - 1) == 0)
61 /* strcpy() can have a similar problem, but since we know we are
62 copying a constant string, we can use memcpy which will be faster
63 since there is no need to check for a NUL byte inside STR. We
64 can also save time if we do not need to copy the terminating NUL. */
65 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1)
66 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2))
69 /* The word size used by BFD on the host. This may be 64 with a 32
70 bit target if the host is 64 bit, or if other 64 bit targets have
71 been selected with --enable-targets, or if --enable-64-bit-bfd. */
72 #define BFD_ARCH_SIZE @wordsize@
74 /* The word size of the default bfd target. */
75 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
77 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
78 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_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 /* Declaring a type wide enough to hold a host long and a host pointer. */
100 #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@
101 typedef BFD_HOSTPTR_T bfd_hostptr_t;
103 /* Forward declaration. */
104 typedef struct bfd bfd;
106 /* Boolean type used in bfd. Too many systems define their own
107 versions of "boolean" for us to safely typedef a "boolean" of
108 our own. Using an enum for "bfd_boolean" has its own set of
109 problems, with strange looking casts required to avoid warnings
110 on some older compilers. Thus we just use an int.
112 General rule: Functions which are bfd_boolean return TRUE on
113 success and FALSE on failure (unless they're a predicate). */
115 typedef int bfd_boolean;
116 #undef FALSE
117 #undef TRUE
118 #define FALSE 0
119 #define TRUE 1
121 #ifdef BFD64
123 #ifndef BFD_HOST_64_BIT
124 #error No 64 bit integer type available
125 #endif /* ! defined (BFD_HOST_64_BIT) */
127 typedef BFD_HOST_U_64_BIT bfd_vma;
128 typedef BFD_HOST_64_BIT bfd_signed_vma;
129 typedef BFD_HOST_U_64_BIT bfd_size_type;
130 typedef BFD_HOST_U_64_BIT symvalue;
132 #ifndef fprintf_vma
133 #if BFD_HOST_64BIT_LONG
134 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
135 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
136 #elif BFD_HOST_64BIT_LONG_LONG
137 #define sprintf_vma(s,x) sprintf (s, "%016llx", x)
138 #define fprintf_vma(f,x) fprintf (f, "%016llx", x)
139 #else
140 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
141 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
142 #define fprintf_vma(s,x) \
143 fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
144 #define sprintf_vma(s,x) \
145 sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
146 #endif
147 #endif
149 #else /* not BFD64 */
151 /* Represent a target address. Also used as a generic unsigned type
152 which is guaranteed to be big enough to hold any arithmetic types
153 we need to deal with. */
154 typedef unsigned long bfd_vma;
156 /* A generic signed type which is guaranteed to be big enough to hold any
157 arithmetic types we need to deal with. Can be assumed to be compatible
158 with bfd_vma in the same way that signed and unsigned ints are compatible
159 (as parameters, in assignment, etc). */
160 typedef long bfd_signed_vma;
162 typedef unsigned long symvalue;
163 typedef unsigned long bfd_size_type;
165 /* Print a bfd_vma x on stream s. */
166 #define fprintf_vma(s,x) fprintf (s, "%08lx", x)
167 #define sprintf_vma(s,x) sprintf (s, "%08lx", x)
169 #endif /* not BFD64 */
171 #define HALF_BFD_SIZE_TYPE \
172 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
174 #ifndef BFD_HOST_64_BIT
175 /* Fall back on a 32 bit type. The idea is to make these types always
176 available for function return types, but in the case that
177 BFD_HOST_64_BIT is undefined such a function should abort or
178 otherwise signal an error. */
179 typedef bfd_signed_vma bfd_int64_t;
180 typedef bfd_vma bfd_uint64_t;
181 #endif
183 /* An offset into a file. BFD always uses the largest possible offset
184 based on the build time availability of fseek, fseeko, or fseeko64. */
185 typedef @bfd_file_ptr@ file_ptr;
186 typedef unsigned @bfd_file_ptr@ ufile_ptr;
188 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
189 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
191 #define printf_vma(x) fprintf_vma(stdout,x)
192 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
194 typedef unsigned int flagword; /* 32 bits of flags */
195 typedef unsigned char bfd_byte;
197 /* File formats. */
199 typedef enum bfd_format
201 bfd_unknown = 0, /* File format is unknown. */
202 bfd_object, /* Linker/assembler/compiler output. */
203 bfd_archive, /* Object archive file. */
204 bfd_core, /* Core dump. */
205 bfd_type_end /* Marks the end; don't use it! */
207 bfd_format;
209 /* Values that may appear in the flags field of a BFD. These also
210 appear in the object_flags field of the bfd_target structure, where
211 they indicate the set of flags used by that backend (not all flags
212 are meaningful for all object file formats) (FIXME: at the moment,
213 the object_flags values have mostly just been copied from backend
214 to another, and are not necessarily correct). */
216 /* No flags. */
217 #define BFD_NO_FLAGS 0x00
219 /* BFD contains relocation entries. */
220 #define HAS_RELOC 0x01
222 /* BFD is directly executable. */
223 #define EXEC_P 0x02
225 /* BFD has line number information (basically used for F_LNNO in a
226 COFF header). */
227 #define HAS_LINENO 0x04
229 /* BFD has debugging information. */
230 #define HAS_DEBUG 0x08
232 /* BFD has symbols. */
233 #define HAS_SYMS 0x10
235 /* BFD has local symbols (basically used for F_LSYMS in a COFF
236 header). */
237 #define HAS_LOCALS 0x20
239 /* BFD is a dynamic object. */
240 #define DYNAMIC 0x40
242 /* Text section is write protected (if D_PAGED is not set, this is
243 like an a.out NMAGIC file) (the linker sets this by default, but
244 clears it for -r or -N). */
245 #define WP_TEXT 0x80
247 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
248 linker sets this by default, but clears it for -r or -n or -N). */
249 #define D_PAGED 0x100
251 /* BFD is relaxable (this means that bfd_relax_section may be able to
252 do something) (sometimes bfd_relax_section can do something even if
253 this is not set). */
254 #define BFD_IS_RELAXABLE 0x200
256 /* This may be set before writing out a BFD to request using a
257 traditional format. For example, this is used to request that when
258 writing out an a.out object the symbols not be hashed to eliminate
259 duplicates. */
260 #define BFD_TRADITIONAL_FORMAT 0x400
262 /* This flag indicates that the BFD contents are actually cached in
263 memory. If this is set, iostream points to a bfd_in_memory struct. */
264 #define BFD_IN_MEMORY 0x800
266 /* The sections in this BFD specify a memory page. */
267 #define HAS_LOAD_PAGE 0x1000
269 /* This BFD has been created by the linker and doesn't correspond
270 to any input file. */
271 #define BFD_LINKER_CREATED 0x2000
273 /* Symbols and relocation. */
275 /* A count of carsyms (canonical archive symbols). */
276 typedef unsigned long symindex;
278 /* How to perform a relocation. */
279 typedef const struct reloc_howto_struct reloc_howto_type;
281 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
283 /* General purpose part of a symbol X;
284 target specific parts are in libcoff.h, libaout.h, etc. */
286 #define bfd_get_section(x) ((x)->section)
287 #define bfd_get_output_section(x) ((x)->section->output_section)
288 #define bfd_set_section(x,y) ((x)->section) = (y)
289 #define bfd_asymbol_base(x) ((x)->section->vma)
290 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
291 #define bfd_asymbol_name(x) ((x)->name)
292 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
293 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
294 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
296 /* A canonical archive symbol. */
297 /* This is a type pun with struct ranlib on purpose! */
298 typedef struct carsym
300 char *name;
301 file_ptr file_offset; /* Look here to find the file. */
303 carsym; /* To make these you call a carsymogen. */
305 /* Used in generating armaps (archive tables of contents).
306 Perhaps just a forward definition would do? */
307 struct orl /* Output ranlib. */
309 char **name; /* Symbol name. */
310 union
312 file_ptr pos;
313 bfd *abfd;
314 } u; /* bfd* or file position. */
315 int namidx; /* Index into string table. */
318 /* Linenumber stuff. */
319 typedef struct lineno_cache_entry
321 unsigned int line_number; /* Linenumber from start of function. */
322 union
324 struct bfd_symbol *sym; /* Function name. */
325 bfd_vma offset; /* Offset into section. */
326 } u;
328 alent;
330 /* Object and core file sections. */
332 #define align_power(addr, align) \
333 (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align)))
335 typedef struct bfd_section *sec_ptr;
337 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
338 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
339 #define bfd_get_section_lma(bfd, ptr) ((ptr)->lma + 0)
340 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
341 #define bfd_section_name(bfd, ptr) ((ptr)->name)
342 #define bfd_section_size(bfd, ptr) ((ptr)->size)
343 #define bfd_get_section_size(ptr) ((ptr)->size)
344 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
345 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
346 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
347 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
348 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
350 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
352 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma = (val)), ((ptr)->user_set_vma = TRUE), TRUE)
353 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),TRUE)
354 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),TRUE)
355 /* Find the address one past the end of SEC. */
356 #define bfd_get_section_limit(bfd, sec) \
357 (((sec)->rawsize ? (sec)->rawsize : (sec)->size) \
358 / bfd_octets_per_byte (bfd))
360 /* Return TRUE if section has been discarded. */
361 #define elf_discarded_section(sec) \
362 (!bfd_is_abs_section (sec) \
363 && bfd_is_abs_section ((sec)->output_section) \
364 && (sec)->sec_info_type != ELF_INFO_TYPE_MERGE \
365 && (sec)->sec_info_type != ELF_INFO_TYPE_JUST_SYMS)
367 /* Forward define. */
368 struct stat;
370 typedef enum bfd_print_symbol
372 bfd_print_symbol_name,
373 bfd_print_symbol_more,
374 bfd_print_symbol_all
375 } bfd_print_symbol_type;
377 /* Information about a symbol that nm needs. */
379 typedef struct _symbol_info
381 symvalue value;
382 char type;
383 const char *name; /* Symbol name. */
384 unsigned char stab_type; /* Stab type. */
385 char stab_other; /* Stab other. */
386 short stab_desc; /* Stab desc. */
387 const char *stab_name; /* String for stab type. */
388 } symbol_info;
390 /* Get the name of a stabs type code. */
392 extern const char *bfd_get_stab_name (int);
394 /* Hash table routines. There is no way to free up a hash table. */
396 /* An element in the hash table. Most uses will actually use a larger
397 structure, and an instance of this will be the first field. */
399 struct bfd_hash_entry
401 /* Next entry for this hash code. */
402 struct bfd_hash_entry *next;
403 /* String being hashed. */
404 const char *string;
405 /* Hash code. This is the full hash code, not the index into the
406 table. */
407 unsigned long hash;
410 /* A hash table. */
412 struct bfd_hash_table
414 /* The hash array. */
415 struct bfd_hash_entry **table;
416 /* A function used to create new elements in the hash table. The
417 first entry is itself a pointer to an element. When this
418 function is first invoked, this pointer will be NULL. However,
419 having the pointer permits a hierarchy of method functions to be
420 built each of which calls the function in the superclass. Thus
421 each function should be written to allocate a new block of memory
422 only if the argument is NULL. */
423 struct bfd_hash_entry *(*newfunc)
424 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
425 /* An objalloc for this hash table. This is a struct objalloc *,
426 but we use void * to avoid requiring the inclusion of objalloc.h. */
427 void *memory;
428 /* The number of slots in the hash table. */
429 unsigned int size;
430 /* The number of entries in the hash table. */
431 unsigned int count;
432 /* The size of elements. */
433 unsigned int entsize;
434 /* If non-zero, don't grow the hash table. */
435 unsigned int frozen:1;
438 /* Initialize a hash table. */
439 extern bfd_boolean bfd_hash_table_init
440 (struct bfd_hash_table *,
441 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
442 struct bfd_hash_table *,
443 const char *),
444 unsigned int);
446 /* Initialize a hash table specifying a size. */
447 extern bfd_boolean bfd_hash_table_init_n
448 (struct bfd_hash_table *,
449 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
450 struct bfd_hash_table *,
451 const char *),
452 unsigned int, unsigned int);
454 /* Free up a hash table. */
455 extern void bfd_hash_table_free
456 (struct bfd_hash_table *);
458 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
459 will be created for this string if one does not already exist. The
460 COPY argument must be TRUE if this routine should copy the string
461 into newly allocated memory when adding an entry. */
462 extern struct bfd_hash_entry *bfd_hash_lookup
463 (struct bfd_hash_table *, const char *, bfd_boolean create,
464 bfd_boolean copy);
466 /* Insert an entry in a hash table. */
467 extern struct bfd_hash_entry *bfd_hash_insert
468 (struct bfd_hash_table *, const char *, unsigned long);
470 /* Replace an entry in a hash table. */
471 extern void bfd_hash_replace
472 (struct bfd_hash_table *, struct bfd_hash_entry *old,
473 struct bfd_hash_entry *nw);
475 /* Base method for creating a hash table entry. */
476 extern struct bfd_hash_entry *bfd_hash_newfunc
477 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
479 /* Grab some space for a hash table entry. */
480 extern void *bfd_hash_allocate
481 (struct bfd_hash_table *, unsigned int);
483 /* Traverse a hash table in a random order, calling a function on each
484 element. If the function returns FALSE, the traversal stops. The
485 INFO argument is passed to the function. */
486 extern void bfd_hash_traverse
487 (struct bfd_hash_table *,
488 bfd_boolean (*) (struct bfd_hash_entry *, void *),
489 void *info);
491 /* Allows the default size of a hash table to be configured. New hash
492 tables allocated using bfd_hash_table_init will be created with
493 this size. */
494 extern void bfd_hash_set_default_size (bfd_size_type);
496 /* This structure is used to keep track of stabs in sections
497 information while linking. */
499 struct stab_info
501 /* A hash table used to hold stabs strings. */
502 struct bfd_strtab_hash *strings;
503 /* The header file hash table. */
504 struct bfd_hash_table includes;
505 /* The first .stabstr section. */
506 struct bfd_section *stabstr;
509 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
511 /* User program access to BFD facilities. */
513 /* Direct I/O routines, for programs which know more about the object
514 file than BFD does. Use higher level routines if possible. */
516 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
517 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
518 extern int bfd_seek (bfd *, file_ptr, int);
519 extern file_ptr bfd_tell (bfd *);
520 extern int bfd_flush (bfd *);
521 extern int bfd_stat (bfd *, struct stat *);
523 /* Deprecated old routines. */
524 #if __GNUC__
525 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
526 (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
527 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
528 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
529 (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
530 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
531 #else
532 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
533 (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
534 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
535 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
536 (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
537 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
538 #endif
539 extern void warn_deprecated (const char *, const char *, int, const char *);
541 /* Cast from const char * to char * so that caller can assign to
542 a char * without a warning. */
543 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
544 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
545 #define bfd_get_format(abfd) ((abfd)->format)
546 #define bfd_get_target(abfd) ((abfd)->xvec->name)
547 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
548 #define bfd_family_coff(abfd) \
549 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
550 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
551 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
552 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
553 #define bfd_header_big_endian(abfd) \
554 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
555 #define bfd_header_little_endian(abfd) \
556 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
557 #define bfd_get_file_flags(abfd) ((abfd)->flags)
558 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
559 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
560 #define bfd_my_archive(abfd) ((abfd)->my_archive)
561 #define bfd_has_map(abfd) ((abfd)->has_armap)
563 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
564 #define bfd_usrdata(abfd) ((abfd)->usrdata)
566 #define bfd_get_start_address(abfd) ((abfd)->start_address)
567 #define bfd_get_symcount(abfd) ((abfd)->symcount)
568 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
569 #define bfd_count_sections(abfd) ((abfd)->section_count)
571 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
573 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
575 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = bool), TRUE)
577 extern bfd_boolean bfd_cache_close
578 (bfd *abfd);
579 /* NB: This declaration should match the autogenerated one in libbfd.h. */
581 extern bfd_boolean bfd_cache_close_all (void);
583 extern bfd_boolean bfd_record_phdr
584 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
585 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
587 /* Byte swapping routines. */
589 bfd_uint64_t bfd_getb64 (const void *);
590 bfd_uint64_t bfd_getl64 (const void *);
591 bfd_int64_t bfd_getb_signed_64 (const void *);
592 bfd_int64_t bfd_getl_signed_64 (const void *);
593 bfd_vma bfd_getb32 (const void *);
594 bfd_vma bfd_getl32 (const void *);
595 bfd_signed_vma bfd_getb_signed_32 (const void *);
596 bfd_signed_vma bfd_getl_signed_32 (const void *);
597 bfd_vma bfd_getb16 (const void *);
598 bfd_vma bfd_getl16 (const void *);
599 bfd_signed_vma bfd_getb_signed_16 (const void *);
600 bfd_signed_vma bfd_getl_signed_16 (const void *);
601 void bfd_putb64 (bfd_uint64_t, void *);
602 void bfd_putl64 (bfd_uint64_t, void *);
603 void bfd_putb32 (bfd_vma, void *);
604 void bfd_putl32 (bfd_vma, void *);
605 void bfd_putb16 (bfd_vma, void *);
606 void bfd_putl16 (bfd_vma, void *);
608 /* Byte swapping routines which take size and endiannes as arguments. */
610 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
611 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
613 extern bfd_boolean bfd_section_already_linked_table_init (void);
614 extern void bfd_section_already_linked_table_free (void);
616 /* Externally visible ECOFF routines. */
618 #if defined(__STDC__) || defined(ALMOST_STDC)
619 struct ecoff_debug_info;
620 struct ecoff_debug_swap;
621 struct ecoff_extr;
622 struct bfd_symbol;
623 struct bfd_link_info;
624 struct bfd_link_hash_entry;
625 struct bfd_elf_version_tree;
626 #endif
627 extern bfd_vma bfd_ecoff_get_gp_value
628 (bfd * abfd);
629 extern bfd_boolean bfd_ecoff_set_gp_value
630 (bfd *abfd, bfd_vma gp_value);
631 extern bfd_boolean bfd_ecoff_set_regmasks
632 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
633 unsigned long *cprmask);
634 extern void *bfd_ecoff_debug_init
635 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
636 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
637 extern void bfd_ecoff_debug_free
638 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
639 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
640 extern bfd_boolean bfd_ecoff_debug_accumulate
641 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
642 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
643 struct ecoff_debug_info *input_debug,
644 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
645 extern bfd_boolean bfd_ecoff_debug_accumulate_other
646 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
647 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
648 struct bfd_link_info *);
649 extern bfd_boolean bfd_ecoff_debug_externals
650 (bfd *abfd, struct ecoff_debug_info *debug,
651 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
652 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
653 void (*set_index) (struct bfd_symbol *, bfd_size_type));
654 extern bfd_boolean bfd_ecoff_debug_one_external
655 (bfd *abfd, struct ecoff_debug_info *debug,
656 const struct ecoff_debug_swap *swap, const char *name,
657 struct ecoff_extr *esym);
658 extern bfd_size_type bfd_ecoff_debug_size
659 (bfd *abfd, struct ecoff_debug_info *debug,
660 const struct ecoff_debug_swap *swap);
661 extern bfd_boolean bfd_ecoff_write_debug
662 (bfd *abfd, struct ecoff_debug_info *debug,
663 const struct ecoff_debug_swap *swap, file_ptr where);
664 extern bfd_boolean bfd_ecoff_write_accumulated_debug
665 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
666 const struct ecoff_debug_swap *swap,
667 struct bfd_link_info *info, file_ptr where);
669 /* Externally visible ELF routines. */
671 struct bfd_link_needed_list
673 struct bfd_link_needed_list *next;
674 bfd *by;
675 const char *name;
678 enum dynamic_lib_link_class {
679 DYN_NORMAL = 0,
680 DYN_AS_NEEDED = 1,
681 DYN_DT_NEEDED = 2,
682 DYN_NO_ADD_NEEDED = 4,
683 DYN_NO_NEEDED = 8
686 enum notice_asneeded_action {
687 notice_as_needed,
688 notice_not_needed,
689 notice_needed
692 extern bfd_boolean bfd_elf_record_link_assignment
693 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
694 bfd_boolean);
695 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
696 (bfd *, struct bfd_link_info *);
697 extern bfd_boolean bfd_elf_get_bfd_needed_list
698 (bfd *, struct bfd_link_needed_list **);
699 extern bfd_boolean bfd_elf_size_dynamic_sections
700 (bfd *, const char *, const char *, const char *, const char * const *,
701 struct bfd_link_info *, struct bfd_section **,
702 struct bfd_elf_version_tree *);
703 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
704 (bfd *, struct bfd_link_info *);
705 extern void bfd_elf_set_dt_needed_name
706 (bfd *, const char *);
707 extern const char *bfd_elf_get_dt_soname
708 (bfd *);
709 extern void bfd_elf_set_dyn_lib_class
710 (bfd *, enum dynamic_lib_link_class);
711 extern int bfd_elf_get_dyn_lib_class
712 (bfd *);
713 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
714 (bfd *, struct bfd_link_info *);
715 extern bfd_boolean bfd_elf_discard_info
716 (bfd *, struct bfd_link_info *);
717 extern unsigned int _bfd_elf_default_action_discarded
718 (struct bfd_section *);
720 /* Return an upper bound on the number of bytes required to store a
721 copy of ABFD's program header table entries. Return -1 if an error
722 occurs; bfd_get_error will return an appropriate code. */
723 extern long bfd_get_elf_phdr_upper_bound
724 (bfd *abfd);
726 /* Copy ABFD's program header table entries to *PHDRS. The entries
727 will be stored as an array of Elf_Internal_Phdr structures, as
728 defined in include/elf/internal.h. To find out how large the
729 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
731 Return the number of program header table entries read, or -1 if an
732 error occurs; bfd_get_error will return an appropriate code. */
733 extern int bfd_get_elf_phdrs
734 (bfd *abfd, void *phdrs);
736 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
737 reconstruct an ELF file by reading the segments out of remote memory
738 based on the ELF file header at EHDR_VMA and the ELF program headers it
739 points to. If not null, *LOADBASEP is filled in with the difference
740 between the VMAs from which the segments were read, and the VMAs the
741 file headers (and hence BFD's idea of each section's VMA) put them at.
743 The function TARGET_READ_MEMORY is called to copy LEN bytes from the
744 remote memory at target address VMA into the local buffer at MYADDR; it
745 should return zero on success or an `errno' code on failure. TEMPL must
746 be a BFD for an ELF target with the word size and byte order found in
747 the remote memory. */
748 extern bfd *bfd_elf_bfd_from_remote_memory
749 (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
750 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, int len));
752 /* Return the arch_size field of an elf bfd, or -1 if not elf. */
753 extern int bfd_get_arch_size
754 (bfd *);
756 /* Return TRUE if address "naturally" sign extends, or -1 if not elf. */
757 extern int bfd_get_sign_extend_vma
758 (bfd *);
760 extern struct bfd_section *_bfd_elf_tls_setup
761 (bfd *, struct bfd_link_info *);
763 extern void _bfd_fix_excluded_sec_syms
764 (bfd *, struct bfd_link_info *);
766 extern unsigned bfd_m68k_mach_to_features (int);
768 extern int bfd_m68k_features_to_mach (unsigned);
770 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
771 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
772 char **);
774 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
775 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
776 char **);
778 /* SunOS shared library support routines for the linker. */
780 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
781 (bfd *, struct bfd_link_info *);
782 extern bfd_boolean bfd_sunos_record_link_assignment
783 (bfd *, struct bfd_link_info *, const char *);
784 extern bfd_boolean bfd_sunos_size_dynamic_sections
785 (bfd *, struct bfd_link_info *, struct bfd_section **,
786 struct bfd_section **, struct bfd_section **);
788 /* Linux shared library support routines for the linker. */
790 extern bfd_boolean bfd_i386linux_size_dynamic_sections
791 (bfd *, struct bfd_link_info *);
792 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
793 (bfd *, struct bfd_link_info *);
794 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
795 (bfd *, struct bfd_link_info *);
797 /* mmap hacks */
799 struct _bfd_window_internal;
800 typedef struct _bfd_window_internal bfd_window_internal;
802 typedef struct _bfd_window
804 /* What the user asked for. */
805 void *data;
806 bfd_size_type size;
807 /* The actual window used by BFD. Small user-requested read-only
808 regions sharing a page may share a single window into the object
809 file. Read-write versions shouldn't until I've fixed things to
810 keep track of which portions have been claimed by the
811 application; don't want to give the same region back when the
812 application wants two writable copies! */
813 struct _bfd_window_internal *i;
815 bfd_window;
817 extern void bfd_init_window
818 (bfd_window *);
819 extern void bfd_free_window
820 (bfd_window *);
821 extern bfd_boolean bfd_get_file_window
822 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
824 /* XCOFF support routines for the linker. */
826 extern bfd_boolean bfd_xcoff_link_record_set
827 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
828 extern bfd_boolean bfd_xcoff_import_symbol
829 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
830 const char *, const char *, const char *, unsigned int);
831 extern bfd_boolean bfd_xcoff_export_symbol
832 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
833 extern bfd_boolean bfd_xcoff_link_count_reloc
834 (bfd *, struct bfd_link_info *, const char *);
835 extern bfd_boolean bfd_xcoff_record_link_assignment
836 (bfd *, struct bfd_link_info *, const char *);
837 extern bfd_boolean bfd_xcoff_size_dynamic_sections
838 (bfd *, struct bfd_link_info *, const char *, const char *,
839 unsigned long, unsigned long, unsigned long, bfd_boolean,
840 int, bfd_boolean, bfd_boolean, struct bfd_section **, bfd_boolean);
841 extern bfd_boolean bfd_xcoff_link_generate_rtinit
842 (bfd *, const char *, const char *, bfd_boolean);
844 /* XCOFF support routines for ar. */
845 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
846 (bfd *, char *);
848 /* Externally visible COFF routines. */
850 #if defined(__STDC__) || defined(ALMOST_STDC)
851 struct internal_syment;
852 union internal_auxent;
853 #endif
855 extern bfd_boolean bfd_coff_get_syment
856 (bfd *, struct bfd_symbol *, struct internal_syment *);
858 extern bfd_boolean bfd_coff_get_auxent
859 (bfd *, struct bfd_symbol *, int, union internal_auxent *);
861 extern bfd_boolean bfd_coff_set_symbol_class
862 (bfd *, struct bfd_symbol *, unsigned int);
864 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
865 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
867 /* ARM VFP11 erratum workaround support. */
868 typedef enum
870 BFD_ARM_VFP11_FIX_DEFAULT,
871 BFD_ARM_VFP11_FIX_NONE,
872 BFD_ARM_VFP11_FIX_SCALAR,
873 BFD_ARM_VFP11_FIX_VECTOR
874 } bfd_arm_vfp11_fix;
876 extern void bfd_elf32_arm_init_maps
877 (bfd *);
879 extern void bfd_elf32_arm_set_vfp11_fix
880 (bfd *, struct bfd_link_info *);
882 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
883 (bfd *, struct bfd_link_info *);
885 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
886 (bfd *, struct bfd_link_info *);
888 /* ARM Interworking support. Called from linker. */
889 extern bfd_boolean bfd_arm_allocate_interworking_sections
890 (struct bfd_link_info *);
892 extern bfd_boolean bfd_arm_process_before_allocation
893 (bfd *, struct bfd_link_info *, int);
895 extern bfd_boolean bfd_arm_get_bfd_for_interworking
896 (bfd *, struct bfd_link_info *);
898 /* PE ARM Interworking support. Called from linker. */
899 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
900 (struct bfd_link_info *);
902 extern bfd_boolean bfd_arm_pe_process_before_allocation
903 (bfd *, struct bfd_link_info *, int);
905 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
906 (bfd *, struct bfd_link_info *);
908 /* ELF ARM Interworking support. Called from linker. */
909 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
910 (struct bfd_link_info *);
912 extern bfd_boolean bfd_elf32_arm_process_before_allocation
913 (bfd *, struct bfd_link_info *);
915 void bfd_elf32_arm_set_target_relocs
916 (bfd *, struct bfd_link_info *, int, char *, int, int, bfd_arm_vfp11_fix,
917 int, int);
919 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
920 (bfd *, struct bfd_link_info *);
922 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
923 (bfd *, struct bfd_link_info *);
925 /* ELF ARM mapping symbol support */
926 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
927 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
928 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
929 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
930 extern bfd_boolean bfd_is_arm_special_symbol_name
931 (const char * name, int type);
933 extern void bfd_elf32_arm_set_byteswap_code (struct bfd_link_info *, int);
935 /* ARM Note section processing. */
936 extern bfd_boolean bfd_arm_merge_machines
937 (bfd *, bfd *);
939 extern bfd_boolean bfd_arm_update_notes
940 (bfd *, const char *);
942 extern unsigned int bfd_arm_get_mach_from_notes
943 (bfd *, const char *);
945 /* TI COFF load page support. */
946 extern void bfd_ticoff_set_section_load_page
947 (struct bfd_section *, int);
949 extern int bfd_ticoff_get_section_load_page
950 (struct bfd_section *);
952 /* H8/300 functions. */
953 extern bfd_vma bfd_h8300_pad_address
954 (bfd *, bfd_vma);
956 /* IA64 Itanium code generation. Called from linker. */
957 extern void bfd_elf32_ia64_after_parse
958 (int);
960 extern void bfd_elf64_ia64_after_parse
961 (int);
963 /* This structure is used for a comdat section, as in PE. A comdat
964 section is associated with a particular symbol. When the linker
965 sees a comdat section, it keeps only one of the sections with a
966 given name and associated with a given symbol. */
968 struct coff_comdat_info
970 /* The name of the symbol associated with a comdat section. */
971 const char *name;
973 /* The local symbol table index of the symbol associated with a
974 comdat section. This is only meaningful to the object file format
975 specific code; it is not an index into the list returned by
976 bfd_canonicalize_symtab. */
977 long symbol;
980 extern struct coff_comdat_info *bfd_coff_get_comdat_section
981 (bfd *, struct bfd_section *);