PR 3532
[deliverable/binutils-gdb.git] / bfd / bfd-in.h
1 /* Main header file for the bfd library -- portable access to object files.
2
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.
6
7 Contributed by Cygnus Support.
8
9 This file is part of BFD, the Binary File Descriptor library.
10
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.
15
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.
20
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. */
24
25 #ifndef __BFD_H_SEEN__
26 #define __BFD_H_SEEN__
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
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
45
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.
59
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))
68
69
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@
74
75 /* The word size of the default bfd target. */
76 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
77
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
86
87 #if BFD_ARCH_SIZE >= 64
88 #define BFD64
89 #endif
90
91 #ifndef INLINE
92 #if __GNUC__ >= 2
93 #define INLINE __inline__
94 #else
95 #define INLINE
96 #endif
97 #endif
98
99 /* Forward declaration. */
100 typedef struct bfd bfd;
101
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.
107
108 General rule: Functions which are bfd_boolean return TRUE on
109 success and FALSE on failure (unless they're a predicate). */
110
111 typedef int bfd_boolean;
112 #undef FALSE
113 #undef TRUE
114 #define FALSE 0
115 #define TRUE 1
116
117 #ifdef BFD64
118
119 #ifndef BFD_HOST_64_BIT
120 #error No 64 bit integer type available
121 #endif /* ! defined (BFD_HOST_64_BIT) */
122
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;
127
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
141
142 #else /* not BFD64 */
143
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;
148
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;
154
155 typedef unsigned long symvalue;
156 typedef unsigned long bfd_size_type;
157
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)
161
162 #endif /* not BFD64 */
163
164 #define HALF_BFD_SIZE_TYPE \
165 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
166
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
175
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;
180
181 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
182 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
183
184 #define printf_vma(x) fprintf_vma(stdout,x)
185 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
186
187 typedef unsigned int flagword; /* 32 bits of flags */
188 typedef unsigned char bfd_byte;
189 \f
190 /* File formats. */
191
192 typedef enum bfd_format
193 {
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! */
199 }
200 bfd_format;
201
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). */
208
209 /* No flags. */
210 #define BFD_NO_FLAGS 0x00
211
212 /* BFD contains relocation entries. */
213 #define HAS_RELOC 0x01
214
215 /* BFD is directly executable. */
216 #define EXEC_P 0x02
217
218 /* BFD has line number information (basically used for F_LNNO in a
219 COFF header). */
220 #define HAS_LINENO 0x04
221
222 /* BFD has debugging information. */
223 #define HAS_DEBUG 0x08
224
225 /* BFD has symbols. */
226 #define HAS_SYMS 0x10
227
228 /* BFD has local symbols (basically used for F_LSYMS in a COFF
229 header). */
230 #define HAS_LOCALS 0x20
231
232 /* BFD is a dynamic object. */
233 #define DYNAMIC 0x40
234
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
239
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
243
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
248
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
254
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
258
259 /* The sections in this BFD specify a memory page. */
260 #define HAS_LOAD_PAGE 0x1000
261
262 /* This BFD has been created by the linker and doesn't correspond
263 to any input file. */
264 #define BFD_LINKER_CREATED 0x2000
265 \f
266 /* Symbols and relocation. */
267
268 /* A count of carsyms (canonical archive symbols). */
269 typedef unsigned long symindex;
270
271 /* How to perform a relocation. */
272 typedef const struct reloc_howto_struct reloc_howto_type;
273
274 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
275
276 /* General purpose part of a symbol X;
277 target specific parts are in libcoff.h, libaout.h, etc. */
278
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)
288
289 /* A canonical archive symbol. */
290 /* This is a type pun with struct ranlib on purpose! */
291 typedef struct carsym
292 {
293 char *name;
294 file_ptr file_offset; /* Look here to find the file. */
295 }
296 carsym; /* To make these you call a carsymogen. */
297
298 /* Used in generating armaps (archive tables of contents).
299 Perhaps just a forward definition would do? */
300 struct orl /* Output ranlib. */
301 {
302 char **name; /* Symbol name. */
303 union
304 {
305 file_ptr pos;
306 bfd *abfd;
307 } u; /* bfd* or file position. */
308 int namidx; /* Index into string table. */
309 };
310 \f
311 /* Linenumber stuff. */
312 typedef struct lineno_cache_entry
313 {
314 unsigned int line_number; /* Linenumber from start of function. */
315 union
316 {
317 struct bfd_symbol *sym; /* Function name. */
318 bfd_vma offset; /* Offset into section. */
319 } u;
320 }
321 alent;
322 \f
323 /* Object and core file sections. */
324
325 #define align_power(addr, align) \
326 (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align)))
327
328 typedef struct bfd_section *sec_ptr;
329
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)
342
343 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
344
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))
352
353 typedef struct stat stat_type;
354 \f
355 typedef enum bfd_print_symbol
356 {
357 bfd_print_symbol_name,
358 bfd_print_symbol_more,
359 bfd_print_symbol_all
360 } bfd_print_symbol_type;
361
362 /* Information about a symbol that nm needs. */
363
364 typedef struct _symbol_info
365 {
366 symvalue value;
367 char type;
368 const char *name; /* Symbol name. */
369 unsigned char stab_type; /* Stab type. */
370 char stab_other; /* Stab other. */
371 short stab_desc; /* Stab desc. */
372 const char *stab_name; /* String for stab type. */
373 } symbol_info;
374
375 /* Get the name of a stabs type code. */
376
377 extern const char *bfd_get_stab_name (int);
378 \f
379 /* Hash table routines. There is no way to free up a hash table. */
380
381 /* An element in the hash table. Most uses will actually use a larger
382 structure, and an instance of this will be the first field. */
383
384 struct bfd_hash_entry
385 {
386 /* Next entry for this hash code. */
387 struct bfd_hash_entry *next;
388 /* String being hashed. */
389 const char *string;
390 /* Hash code. This is the full hash code, not the index into the
391 table. */
392 unsigned long hash;
393 };
394
395 /* A hash table. */
396
397 struct bfd_hash_table
398 {
399 /* The hash array. */
400 struct bfd_hash_entry **table;
401 /* A function used to create new elements in the hash table. The
402 first entry is itself a pointer to an element. When this
403 function is first invoked, this pointer will be NULL. However,
404 having the pointer permits a hierarchy of method functions to be
405 built each of which calls the function in the superclass. Thus
406 each function should be written to allocate a new block of memory
407 only if the argument is NULL. */
408 struct bfd_hash_entry *(*newfunc)
409 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
410 /* An objalloc for this hash table. This is a struct objalloc *,
411 but we use void * to avoid requiring the inclusion of objalloc.h. */
412 void *memory;
413 /* The number of slots in the hash table. */
414 unsigned int size;
415 /* The number of entries in the hash table. */
416 unsigned int count;
417 /* The size of elements. */
418 unsigned int entsize;
419 /* If non-zero, don't grow the hash table. */
420 unsigned int frozen:1;
421 };
422
423 /* Initialize a hash table. */
424 extern bfd_boolean bfd_hash_table_init
425 (struct bfd_hash_table *,
426 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
427 struct bfd_hash_table *,
428 const char *),
429 unsigned int);
430
431 /* Initialize a hash table specifying a size. */
432 extern bfd_boolean bfd_hash_table_init_n
433 (struct bfd_hash_table *,
434 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
435 struct bfd_hash_table *,
436 const char *),
437 unsigned int, unsigned int);
438
439 /* Free up a hash table. */
440 extern void bfd_hash_table_free
441 (struct bfd_hash_table *);
442
443 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
444 will be created for this string if one does not already exist. The
445 COPY argument must be TRUE if this routine should copy the string
446 into newly allocated memory when adding an entry. */
447 extern struct bfd_hash_entry *bfd_hash_lookup
448 (struct bfd_hash_table *, const char *, bfd_boolean create,
449 bfd_boolean copy);
450
451 /* Replace an entry in a hash table. */
452 extern void bfd_hash_replace
453 (struct bfd_hash_table *, struct bfd_hash_entry *old,
454 struct bfd_hash_entry *nw);
455
456 /* Base method for creating a hash table entry. */
457 extern struct bfd_hash_entry *bfd_hash_newfunc
458 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
459
460 /* Grab some space for a hash table entry. */
461 extern void *bfd_hash_allocate
462 (struct bfd_hash_table *, unsigned int);
463
464 /* Traverse a hash table in a random order, calling a function on each
465 element. If the function returns FALSE, the traversal stops. The
466 INFO argument is passed to the function. */
467 extern void bfd_hash_traverse
468 (struct bfd_hash_table *,
469 bfd_boolean (*) (struct bfd_hash_entry *, void *),
470 void *info);
471
472 /* Allows the default size of a hash table to be configured. New hash
473 tables allocated using bfd_hash_table_init will be created with
474 this size. */
475 extern void bfd_hash_set_default_size (bfd_size_type);
476
477 /* This structure is used to keep track of stabs in sections
478 information while linking. */
479
480 struct stab_info
481 {
482 /* A hash table used to hold stabs strings. */
483 struct bfd_strtab_hash *strings;
484 /* The header file hash table. */
485 struct bfd_hash_table includes;
486 /* The first .stabstr section. */
487 struct bfd_section *stabstr;
488 };
489
490 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
491
492 /* User program access to BFD facilities. */
493
494 /* Direct I/O routines, for programs which know more about the object
495 file than BFD does. Use higher level routines if possible. */
496
497 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
498 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
499 extern int bfd_seek (bfd *, file_ptr, int);
500 extern file_ptr bfd_tell (bfd *);
501 extern int bfd_flush (bfd *);
502 extern int bfd_stat (bfd *, struct stat *);
503
504 /* Deprecated old routines. */
505 #if __GNUC__
506 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
507 (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
508 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
509 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
510 (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
511 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
512 #else
513 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
514 (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
515 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
516 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
517 (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
518 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
519 #endif
520 extern void warn_deprecated (const char *, const char *, int, const char *);
521
522 /* Cast from const char * to char * so that caller can assign to
523 a char * without a warning. */
524 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
525 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
526 #define bfd_get_format(abfd) ((abfd)->format)
527 #define bfd_get_target(abfd) ((abfd)->xvec->name)
528 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
529 #define bfd_family_coff(abfd) \
530 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
531 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
532 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
533 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
534 #define bfd_header_big_endian(abfd) \
535 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
536 #define bfd_header_little_endian(abfd) \
537 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
538 #define bfd_get_file_flags(abfd) ((abfd)->flags)
539 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
540 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
541 #define bfd_my_archive(abfd) ((abfd)->my_archive)
542 #define bfd_has_map(abfd) ((abfd)->has_armap)
543
544 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
545 #define bfd_usrdata(abfd) ((abfd)->usrdata)
546
547 #define bfd_get_start_address(abfd) ((abfd)->start_address)
548 #define bfd_get_symcount(abfd) ((abfd)->symcount)
549 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
550 #define bfd_count_sections(abfd) ((abfd)->section_count)
551
552 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
553
554 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
555
556 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = bool), TRUE)
557
558 extern bfd_boolean bfd_cache_close
559 (bfd *abfd);
560 /* NB: This declaration should match the autogenerated one in libbfd.h. */
561
562 extern bfd_boolean bfd_cache_close_all (void);
563
564 extern bfd_boolean bfd_record_phdr
565 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
566 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
567
568 /* Byte swapping routines. */
569
570 bfd_uint64_t bfd_getb64 (const void *);
571 bfd_uint64_t bfd_getl64 (const void *);
572 bfd_int64_t bfd_getb_signed_64 (const void *);
573 bfd_int64_t bfd_getl_signed_64 (const void *);
574 bfd_vma bfd_getb32 (const void *);
575 bfd_vma bfd_getl32 (const void *);
576 bfd_signed_vma bfd_getb_signed_32 (const void *);
577 bfd_signed_vma bfd_getl_signed_32 (const void *);
578 bfd_vma bfd_getb16 (const void *);
579 bfd_vma bfd_getl16 (const void *);
580 bfd_signed_vma bfd_getb_signed_16 (const void *);
581 bfd_signed_vma bfd_getl_signed_16 (const void *);
582 void bfd_putb64 (bfd_uint64_t, void *);
583 void bfd_putl64 (bfd_uint64_t, void *);
584 void bfd_putb32 (bfd_vma, void *);
585 void bfd_putl32 (bfd_vma, void *);
586 void bfd_putb16 (bfd_vma, void *);
587 void bfd_putl16 (bfd_vma, void *);
588
589 /* Byte swapping routines which take size and endiannes as arguments. */
590
591 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
592 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
593
594 extern bfd_boolean bfd_section_already_linked_table_init (void);
595 extern void bfd_section_already_linked_table_free (void);
596 \f
597 /* Externally visible ECOFF routines. */
598
599 #if defined(__STDC__) || defined(ALMOST_STDC)
600 struct ecoff_debug_info;
601 struct ecoff_debug_swap;
602 struct ecoff_extr;
603 struct bfd_symbol;
604 struct bfd_link_info;
605 struct bfd_link_hash_entry;
606 struct bfd_elf_version_tree;
607 #endif
608 extern bfd_vma bfd_ecoff_get_gp_value
609 (bfd * abfd);
610 extern bfd_boolean bfd_ecoff_set_gp_value
611 (bfd *abfd, bfd_vma gp_value);
612 extern bfd_boolean bfd_ecoff_set_regmasks
613 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
614 unsigned long *cprmask);
615 extern void *bfd_ecoff_debug_init
616 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
617 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
618 extern void bfd_ecoff_debug_free
619 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
620 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
621 extern bfd_boolean bfd_ecoff_debug_accumulate
622 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
623 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
624 struct ecoff_debug_info *input_debug,
625 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
626 extern bfd_boolean bfd_ecoff_debug_accumulate_other
627 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
628 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
629 struct bfd_link_info *);
630 extern bfd_boolean bfd_ecoff_debug_externals
631 (bfd *abfd, struct ecoff_debug_info *debug,
632 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
633 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
634 void (*set_index) (struct bfd_symbol *, bfd_size_type));
635 extern bfd_boolean bfd_ecoff_debug_one_external
636 (bfd *abfd, struct ecoff_debug_info *debug,
637 const struct ecoff_debug_swap *swap, const char *name,
638 struct ecoff_extr *esym);
639 extern bfd_size_type bfd_ecoff_debug_size
640 (bfd *abfd, struct ecoff_debug_info *debug,
641 const struct ecoff_debug_swap *swap);
642 extern bfd_boolean bfd_ecoff_write_debug
643 (bfd *abfd, struct ecoff_debug_info *debug,
644 const struct ecoff_debug_swap *swap, file_ptr where);
645 extern bfd_boolean bfd_ecoff_write_accumulated_debug
646 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
647 const struct ecoff_debug_swap *swap,
648 struct bfd_link_info *info, file_ptr where);
649
650 /* Externally visible ELF routines. */
651
652 struct bfd_link_needed_list
653 {
654 struct bfd_link_needed_list *next;
655 bfd *by;
656 const char *name;
657 };
658
659 enum dynamic_lib_link_class {
660 DYN_NORMAL = 0,
661 DYN_AS_NEEDED = 1,
662 DYN_DT_NEEDED = 2,
663 DYN_NO_ADD_NEEDED = 4,
664 DYN_NO_NEEDED = 8
665 };
666
667 enum notice_asneeded_action {
668 notice_as_needed,
669 notice_not_needed,
670 notice_needed
671 };
672
673 extern bfd_boolean bfd_elf_record_link_assignment
674 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
675 bfd_boolean);
676 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
677 (bfd *, struct bfd_link_info *);
678 extern bfd_boolean bfd_elf_get_bfd_needed_list
679 (bfd *, struct bfd_link_needed_list **);
680 extern bfd_boolean bfd_elf_size_dynamic_sections
681 (bfd *, const char *, const char *, const char *, const char * const *,
682 struct bfd_link_info *, struct bfd_section **,
683 struct bfd_elf_version_tree *);
684 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
685 (bfd *, struct bfd_link_info *);
686 extern void bfd_elf_set_dt_needed_name
687 (bfd *, const char *);
688 extern const char *bfd_elf_get_dt_soname
689 (bfd *);
690 extern void bfd_elf_set_dyn_lib_class
691 (bfd *, enum dynamic_lib_link_class);
692 extern int bfd_elf_get_dyn_lib_class
693 (bfd *);
694 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
695 (bfd *, struct bfd_link_info *);
696 extern bfd_boolean bfd_elf_discard_info
697 (bfd *, struct bfd_link_info *);
698 extern unsigned int _bfd_elf_default_action_discarded
699 (struct bfd_section *);
700
701 /* Return an upper bound on the number of bytes required to store a
702 copy of ABFD's program header table entries. Return -1 if an error
703 occurs; bfd_get_error will return an appropriate code. */
704 extern long bfd_get_elf_phdr_upper_bound
705 (bfd *abfd);
706
707 /* Copy ABFD's program header table entries to *PHDRS. The entries
708 will be stored as an array of Elf_Internal_Phdr structures, as
709 defined in include/elf/internal.h. To find out how large the
710 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
711
712 Return the number of program header table entries read, or -1 if an
713 error occurs; bfd_get_error will return an appropriate code. */
714 extern int bfd_get_elf_phdrs
715 (bfd *abfd, void *phdrs);
716
717 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
718 reconstruct an ELF file by reading the segments out of remote memory
719 based on the ELF file header at EHDR_VMA and the ELF program headers it
720 points to. If not null, *LOADBASEP is filled in with the difference
721 between the VMAs from which the segments were read, and the VMAs the
722 file headers (and hence BFD's idea of each section's VMA) put them at.
723
724 The function TARGET_READ_MEMORY is called to copy LEN bytes from the
725 remote memory at target address VMA into the local buffer at MYADDR; it
726 should return zero on success or an `errno' code on failure. TEMPL must
727 be a BFD for an ELF target with the word size and byte order found in
728 the remote memory. */
729 extern bfd *bfd_elf_bfd_from_remote_memory
730 (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
731 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, int len));
732
733 /* Return the arch_size field of an elf bfd, or -1 if not elf. */
734 extern int bfd_get_arch_size
735 (bfd *);
736
737 /* Return TRUE if address "naturally" sign extends, or -1 if not elf. */
738 extern int bfd_get_sign_extend_vma
739 (bfd *);
740
741 extern struct bfd_section *_bfd_elf_tls_setup
742 (bfd *, struct bfd_link_info *);
743
744 extern void _bfd_fix_excluded_sec_syms
745 (bfd *, struct bfd_link_info *);
746
747 extern unsigned bfd_m68k_mach_to_features (int);
748
749 extern int bfd_m68k_features_to_mach (unsigned);
750
751 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
752 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
753 char **);
754
755 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
756 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
757 char **);
758
759 /* SunOS shared library support routines for the linker. */
760
761 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
762 (bfd *, struct bfd_link_info *);
763 extern bfd_boolean bfd_sunos_record_link_assignment
764 (bfd *, struct bfd_link_info *, const char *);
765 extern bfd_boolean bfd_sunos_size_dynamic_sections
766 (bfd *, struct bfd_link_info *, struct bfd_section **,
767 struct bfd_section **, struct bfd_section **);
768
769 /* Linux shared library support routines for the linker. */
770
771 extern bfd_boolean bfd_i386linux_size_dynamic_sections
772 (bfd *, struct bfd_link_info *);
773 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
774 (bfd *, struct bfd_link_info *);
775 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
776 (bfd *, struct bfd_link_info *);
777
778 /* mmap hacks */
779
780 struct _bfd_window_internal;
781 typedef struct _bfd_window_internal bfd_window_internal;
782
783 typedef struct _bfd_window
784 {
785 /* What the user asked for. */
786 void *data;
787 bfd_size_type size;
788 /* The actual window used by BFD. Small user-requested read-only
789 regions sharing a page may share a single window into the object
790 file. Read-write versions shouldn't until I've fixed things to
791 keep track of which portions have been claimed by the
792 application; don't want to give the same region back when the
793 application wants two writable copies! */
794 struct _bfd_window_internal *i;
795 }
796 bfd_window;
797
798 extern void bfd_init_window
799 (bfd_window *);
800 extern void bfd_free_window
801 (bfd_window *);
802 extern bfd_boolean bfd_get_file_window
803 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
804
805 /* XCOFF support routines for the linker. */
806
807 extern bfd_boolean bfd_xcoff_link_record_set
808 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
809 extern bfd_boolean bfd_xcoff_import_symbol
810 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
811 const char *, const char *, const char *, unsigned int);
812 extern bfd_boolean bfd_xcoff_export_symbol
813 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
814 extern bfd_boolean bfd_xcoff_link_count_reloc
815 (bfd *, struct bfd_link_info *, const char *);
816 extern bfd_boolean bfd_xcoff_record_link_assignment
817 (bfd *, struct bfd_link_info *, const char *);
818 extern bfd_boolean bfd_xcoff_size_dynamic_sections
819 (bfd *, struct bfd_link_info *, const char *, const char *,
820 unsigned long, unsigned long, unsigned long, bfd_boolean,
821 int, bfd_boolean, bfd_boolean, struct bfd_section **, bfd_boolean);
822 extern bfd_boolean bfd_xcoff_link_generate_rtinit
823 (bfd *, const char *, const char *, bfd_boolean);
824
825 /* XCOFF support routines for ar. */
826 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
827 (bfd *, char *);
828
829 /* Externally visible COFF routines. */
830
831 #if defined(__STDC__) || defined(ALMOST_STDC)
832 struct internal_syment;
833 union internal_auxent;
834 #endif
835
836 extern bfd_boolean bfd_coff_get_syment
837 (bfd *, struct bfd_symbol *, struct internal_syment *);
838
839 extern bfd_boolean bfd_coff_get_auxent
840 (bfd *, struct bfd_symbol *, int, union internal_auxent *);
841
842 extern bfd_boolean bfd_coff_set_symbol_class
843 (bfd *, struct bfd_symbol *, unsigned int);
844
845 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
846 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
847
848 /* ARM Interworking support. Called from linker. */
849 extern bfd_boolean bfd_arm_allocate_interworking_sections
850 (struct bfd_link_info *);
851
852 extern bfd_boolean bfd_arm_process_before_allocation
853 (bfd *, struct bfd_link_info *, int);
854
855 extern bfd_boolean bfd_arm_get_bfd_for_interworking
856 (bfd *, struct bfd_link_info *);
857
858 /* PE ARM Interworking support. Called from linker. */
859 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
860 (struct bfd_link_info *);
861
862 extern bfd_boolean bfd_arm_pe_process_before_allocation
863 (bfd *, struct bfd_link_info *, int);
864
865 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
866 (bfd *, struct bfd_link_info *);
867
868 /* ELF ARM Interworking support. Called from linker. */
869 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
870 (struct bfd_link_info *);
871
872 extern bfd_boolean bfd_elf32_arm_process_before_allocation
873 (bfd *, struct bfd_link_info *);
874
875 void bfd_elf32_arm_set_target_relocs
876 (struct bfd_link_info *, int, char *, int, int);
877
878 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
879 (bfd *, struct bfd_link_info *);
880
881 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
882 (bfd *, struct bfd_link_info *);
883
884 /* ELF ARM mapping symbol support */
885 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
886 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
887 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
888 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
889 extern bfd_boolean bfd_is_arm_special_symbol_name
890 (const char * name, int type);
891
892 extern void bfd_elf32_arm_set_byteswap_code (struct bfd_link_info *, int);
893
894 /* ARM Note section processing. */
895 extern bfd_boolean bfd_arm_merge_machines
896 (bfd *, bfd *);
897
898 extern bfd_boolean bfd_arm_update_notes
899 (bfd *, const char *);
900
901 extern unsigned int bfd_arm_get_mach_from_notes
902 (bfd *, const char *);
903
904 /* TI COFF load page support. */
905 extern void bfd_ticoff_set_section_load_page
906 (struct bfd_section *, int);
907
908 extern int bfd_ticoff_get_section_load_page
909 (struct bfd_section *);
910
911 /* H8/300 functions. */
912 extern bfd_vma bfd_h8300_pad_address
913 (bfd *, bfd_vma);
914
915 /* IA64 Itanium code generation. Called from linker. */
916 extern void bfd_elf32_ia64_after_parse
917 (int);
918
919 extern void bfd_elf64_ia64_after_parse
920 (int);
921
922 /* This structure is used for a comdat section, as in PE. A comdat
923 section is associated with a particular symbol. When the linker
924 sees a comdat section, it keeps only one of the sections with a
925 given name and associated with a given symbol. */
926
927 struct coff_comdat_info
928 {
929 /* The name of the symbol associated with a comdat section. */
930 const char *name;
931
932 /* The local symbol table index of the symbol associated with a
933 comdat section. This is only meaningful to the object file format
934 specific code; it is not an index into the list returned by
935 bfd_canonicalize_symtab. */
936 long symbol;
937 };
938
939 extern struct coff_comdat_info *bfd_coff_get_comdat_section
940 (bfd *, struct bfd_section *);
941
This page took 0.048866 seconds and 4 git commands to generate.