include/
[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 Free Software Foundation, Inc.
5
6 Contributed by Cygnus Support.
7
8 This file is part of BFD, the Binary File Descriptor library.
9
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
23
24 #ifndef __BFD_H_SEEN__
25 #define __BFD_H_SEEN__
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 #include "ansidecl.h"
32 #include "symcat.h"
33 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
34 #ifndef SABER
35 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
36 The problem is, "32_" is not a valid preprocessing token, and we don't
37 want extra underscores (e.g., "nlm_32_"). The XCONCAT2 macro will
38 cause the inner CONCAT2 macros to be evaluated first, producing
39 still-valid pp-tokens. Then the final concatenation can be done. */
40 #undef CONCAT4
41 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
42 #endif
43 #endif
44
45 /* The word size used by BFD on the host. This may be 64 with a 32
46 bit target if the host is 64 bit, or if other 64 bit targets have
47 been selected with --enable-targets, or if --enable-64-bit-bfd. */
48 #define BFD_ARCH_SIZE @wordsize@
49
50 /* The word size of the default bfd target. */
51 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
52
53 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
54 #define BFD_HOST_LONG_LONG @BFD_HOST_LONG_LONG@
55 #if @BFD_HOST_64_BIT_DEFINED@
56 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
57 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
58 typedef BFD_HOST_64_BIT bfd_int64_t;
59 typedef BFD_HOST_U_64_BIT bfd_uint64_t;
60 #endif
61
62 #if BFD_ARCH_SIZE >= 64
63 #define BFD64
64 #endif
65
66 #ifndef INLINE
67 #if __GNUC__ >= 2
68 #define INLINE __inline__
69 #else
70 #define INLINE
71 #endif
72 #endif
73
74 /* Forward declaration. */
75 typedef struct bfd bfd;
76
77 /* Boolean type used in bfd. Too many systems define their own
78 versions of "boolean" for us to safely typedef a "boolean" of
79 our own. Using an enum for "bfd_boolean" has its own set of
80 problems, with strange looking casts required to avoid warnings
81 on some older compilers. Thus we just use an int.
82
83 General rule: Functions which are bfd_boolean return TRUE on
84 success and FALSE on failure (unless they're a predicate). */
85
86 typedef int bfd_boolean;
87 #undef FALSE
88 #undef TRUE
89 #define FALSE 0
90 #define TRUE 1
91
92 #ifdef BFD64
93
94 #ifndef BFD_HOST_64_BIT
95 #error No 64 bit integer type available
96 #endif /* ! defined (BFD_HOST_64_BIT) */
97
98 typedef BFD_HOST_U_64_BIT bfd_vma;
99 typedef BFD_HOST_64_BIT bfd_signed_vma;
100 typedef BFD_HOST_U_64_BIT bfd_size_type;
101 typedef BFD_HOST_U_64_BIT symvalue;
102
103 #ifndef fprintf_vma
104 #if BFD_HOST_64BIT_LONG
105 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
106 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
107 #else
108 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
109 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
110 #define fprintf_vma(s,x) \
111 fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
112 #define sprintf_vma(s,x) \
113 sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
114 #endif
115 #endif
116
117 #else /* not BFD64 */
118
119 /* Represent a target address. Also used as a generic unsigned type
120 which is guaranteed to be big enough to hold any arithmetic types
121 we need to deal with. */
122 typedef unsigned long bfd_vma;
123
124 /* A generic signed type which is guaranteed to be big enough to hold any
125 arithmetic types we need to deal with. Can be assumed to be compatible
126 with bfd_vma in the same way that signed and unsigned ints are compatible
127 (as parameters, in assignment, etc). */
128 typedef long bfd_signed_vma;
129
130 typedef unsigned long symvalue;
131 typedef unsigned long bfd_size_type;
132
133 /* Print a bfd_vma x on stream s. */
134 #define fprintf_vma(s,x) fprintf (s, "%08lx", x)
135 #define sprintf_vma(s,x) sprintf (s, "%08lx", x)
136
137 #endif /* not BFD64 */
138
139 #ifndef BFD_HOST_64_BIT
140 /* Fall back on a 32 bit type. The idea is to make these types always
141 available for function return types, but in the case that
142 BFD_HOST_64_BIT is undefined such a function should abort or
143 otherwise signal an error. */
144 typedef bfd_signed_vma bfd_int64_t;
145 typedef bfd_vma bfd_uint64_t;
146 #endif
147
148 /* An offset into a file. BFD always uses the largest possible offset
149 based on the build time availability of fseek, fseeko, or fseeko64. */
150 typedef @bfd_file_ptr@ file_ptr;
151 typedef unsigned @bfd_file_ptr@ ufile_ptr;
152
153 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
154 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
155
156 #define printf_vma(x) fprintf_vma(stdout,x)
157 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
158
159 typedef unsigned int flagword; /* 32 bits of flags */
160 typedef unsigned char bfd_byte;
161 \f
162 /* File formats. */
163
164 typedef enum bfd_format
165 {
166 bfd_unknown = 0, /* File format is unknown. */
167 bfd_object, /* Linker/assembler/compiler output. */
168 bfd_archive, /* Object archive file. */
169 bfd_core, /* Core dump. */
170 bfd_type_end /* Marks the end; don't use it! */
171 }
172 bfd_format;
173
174 /* Values that may appear in the flags field of a BFD. These also
175 appear in the object_flags field of the bfd_target structure, where
176 they indicate the set of flags used by that backend (not all flags
177 are meaningful for all object file formats) (FIXME: at the moment,
178 the object_flags values have mostly just been copied from backend
179 to another, and are not necessarily correct). */
180
181 /* No flags. */
182 #define BFD_NO_FLAGS 0x00
183
184 /* BFD contains relocation entries. */
185 #define HAS_RELOC 0x01
186
187 /* BFD is directly executable. */
188 #define EXEC_P 0x02
189
190 /* BFD has line number information (basically used for F_LNNO in a
191 COFF header). */
192 #define HAS_LINENO 0x04
193
194 /* BFD has debugging information. */
195 #define HAS_DEBUG 0x08
196
197 /* BFD has symbols. */
198 #define HAS_SYMS 0x10
199
200 /* BFD has local symbols (basically used for F_LSYMS in a COFF
201 header). */
202 #define HAS_LOCALS 0x20
203
204 /* BFD is a dynamic object. */
205 #define DYNAMIC 0x40
206
207 /* Text section is write protected (if D_PAGED is not set, this is
208 like an a.out NMAGIC file) (the linker sets this by default, but
209 clears it for -r or -N). */
210 #define WP_TEXT 0x80
211
212 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
213 linker sets this by default, but clears it for -r or -n or -N). */
214 #define D_PAGED 0x100
215
216 /* BFD is relaxable (this means that bfd_relax_section may be able to
217 do something) (sometimes bfd_relax_section can do something even if
218 this is not set). */
219 #define BFD_IS_RELAXABLE 0x200
220
221 /* This may be set before writing out a BFD to request using a
222 traditional format. For example, this is used to request that when
223 writing out an a.out object the symbols not be hashed to eliminate
224 duplicates. */
225 #define BFD_TRADITIONAL_FORMAT 0x400
226
227 /* This flag indicates that the BFD contents are actually cached in
228 memory. If this is set, iostream points to a bfd_in_memory struct. */
229 #define BFD_IN_MEMORY 0x800
230
231 /* The sections in this BFD specify a memory page. */
232 #define HAS_LOAD_PAGE 0x1000
233
234 /* This BFD has been created by the linker and doesn't correspond
235 to any input file. */
236 #define BFD_LINKER_CREATED 0x2000
237 \f
238 /* Symbols and relocation. */
239
240 /* A count of carsyms (canonical archive symbols). */
241 typedef unsigned long symindex;
242
243 /* How to perform a relocation. */
244 typedef const struct reloc_howto_struct reloc_howto_type;
245
246 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
247
248 /* General purpose part of a symbol X;
249 target specific parts are in libcoff.h, libaout.h, etc. */
250
251 #define bfd_get_section(x) ((x)->section)
252 #define bfd_get_output_section(x) ((x)->section->output_section)
253 #define bfd_set_section(x,y) ((x)->section) = (y)
254 #define bfd_asymbol_base(x) ((x)->section->vma)
255 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
256 #define bfd_asymbol_name(x) ((x)->name)
257 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
258 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
259 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
260
261 /* A canonical archive symbol. */
262 /* This is a type pun with struct ranlib on purpose! */
263 typedef struct carsym
264 {
265 char *name;
266 file_ptr file_offset; /* Look here to find the file. */
267 }
268 carsym; /* To make these you call a carsymogen. */
269
270 /* Used in generating armaps (archive tables of contents).
271 Perhaps just a forward definition would do? */
272 struct orl /* Output ranlib. */
273 {
274 char **name; /* Symbol name. */
275 union
276 {
277 file_ptr pos;
278 bfd *abfd;
279 } u; /* bfd* or file position. */
280 int namidx; /* Index into string table. */
281 };
282 \f
283 /* Linenumber stuff. */
284 typedef struct lineno_cache_entry
285 {
286 unsigned int line_number; /* Linenumber from start of function. */
287 union
288 {
289 struct bfd_symbol *sym; /* Function name. */
290 bfd_vma offset; /* Offset into section. */
291 } u;
292 }
293 alent;
294 \f
295 /* Object and core file sections. */
296
297 #define align_power(addr, align) \
298 (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align)))
299
300 typedef struct bfd_section *sec_ptr;
301
302 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
303 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
304 #define bfd_get_section_lma(bfd, ptr) ((ptr)->lma + 0)
305 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
306 #define bfd_section_name(bfd, ptr) ((ptr)->name)
307 #define bfd_section_size(bfd, ptr) ((ptr)->size)
308 #define bfd_get_section_size(ptr) ((ptr)->size)
309 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
310 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
311 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
312 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
313 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
314
315 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
316
317 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma = (val)), ((ptr)->user_set_vma = TRUE), TRUE)
318 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),TRUE)
319 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),TRUE)
320 /* Find the address one past the end of SEC. */
321 #define bfd_get_section_limit(bfd, sec) \
322 (((sec)->rawsize ? (sec)->rawsize : (sec)->size) \
323 / bfd_octets_per_byte (bfd))
324
325 typedef struct stat stat_type;
326 \f
327 typedef enum bfd_print_symbol
328 {
329 bfd_print_symbol_name,
330 bfd_print_symbol_more,
331 bfd_print_symbol_all
332 } bfd_print_symbol_type;
333
334 /* Information about a symbol that nm needs. */
335
336 typedef struct _symbol_info
337 {
338 symvalue value;
339 char type;
340 const char *name; /* Symbol name. */
341 unsigned char stab_type; /* Stab type. */
342 char stab_other; /* Stab other. */
343 short stab_desc; /* Stab desc. */
344 const char *stab_name; /* String for stab type. */
345 } symbol_info;
346
347 /* Get the name of a stabs type code. */
348
349 extern const char *bfd_get_stab_name (int);
350 \f
351 /* Hash table routines. There is no way to free up a hash table. */
352
353 /* An element in the hash table. Most uses will actually use a larger
354 structure, and an instance of this will be the first field. */
355
356 struct bfd_hash_entry
357 {
358 /* Next entry for this hash code. */
359 struct bfd_hash_entry *next;
360 /* String being hashed. */
361 const char *string;
362 /* Hash code. This is the full hash code, not the index into the
363 table. */
364 unsigned long hash;
365 };
366
367 /* A hash table. */
368
369 struct bfd_hash_table
370 {
371 /* The hash array. */
372 struct bfd_hash_entry **table;
373 /* The number of slots in the hash table. */
374 unsigned int size;
375 /* A function used to create new elements in the hash table. The
376 first entry is itself a pointer to an element. When this
377 function is first invoked, this pointer will be NULL. However,
378 having the pointer permits a hierarchy of method functions to be
379 built each of which calls the function in the superclass. Thus
380 each function should be written to allocate a new block of memory
381 only if the argument is NULL. */
382 struct bfd_hash_entry *(*newfunc)
383 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
384 /* An objalloc for this hash table. This is a struct objalloc *,
385 but we use void * to avoid requiring the inclusion of objalloc.h. */
386 void *memory;
387 };
388
389 /* Initialize a hash table. */
390 extern bfd_boolean bfd_hash_table_init
391 (struct bfd_hash_table *,
392 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
393 struct bfd_hash_table *,
394 const char *));
395
396 /* Initialize a hash table specifying a size. */
397 extern bfd_boolean bfd_hash_table_init_n
398 (struct bfd_hash_table *,
399 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
400 struct bfd_hash_table *,
401 const char *),
402 unsigned int size);
403
404 /* Free up a hash table. */
405 extern void bfd_hash_table_free
406 (struct bfd_hash_table *);
407
408 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
409 will be created for this string if one does not already exist. The
410 COPY argument must be TRUE if this routine should copy the string
411 into newly allocated memory when adding an entry. */
412 extern struct bfd_hash_entry *bfd_hash_lookup
413 (struct bfd_hash_table *, const char *, bfd_boolean create,
414 bfd_boolean copy);
415
416 /* Replace an entry in a hash table. */
417 extern void bfd_hash_replace
418 (struct bfd_hash_table *, struct bfd_hash_entry *old,
419 struct bfd_hash_entry *nw);
420
421 /* Base method for creating a hash table entry. */
422 extern struct bfd_hash_entry *bfd_hash_newfunc
423 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
424
425 /* Grab some space for a hash table entry. */
426 extern void *bfd_hash_allocate
427 (struct bfd_hash_table *, unsigned int);
428
429 /* Traverse a hash table in a random order, calling a function on each
430 element. If the function returns FALSE, the traversal stops. The
431 INFO argument is passed to the function. */
432 extern void bfd_hash_traverse
433 (struct bfd_hash_table *,
434 bfd_boolean (*) (struct bfd_hash_entry *, void *),
435 void *info);
436
437 /* Allows the default size of a hash table to be configured. New hash
438 tables allocated using bfd_hash_table_init will be created with
439 this size. */
440 extern void bfd_hash_set_default_size (bfd_size_type);
441
442 /* This structure is used to keep track of stabs in sections
443 information while linking. */
444
445 struct stab_info
446 {
447 /* A hash table used to hold stabs strings. */
448 struct bfd_strtab_hash *strings;
449 /* The header file hash table. */
450 struct bfd_hash_table includes;
451 /* The first .stabstr section. */
452 struct bfd_section *stabstr;
453 };
454
455 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
456
457 /* User program access to BFD facilities. */
458
459 /* Direct I/O routines, for programs which know more about the object
460 file than BFD does. Use higher level routines if possible. */
461
462 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
463 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
464 extern int bfd_seek (bfd *, file_ptr, int);
465 extern file_ptr bfd_tell (bfd *);
466 extern int bfd_flush (bfd *);
467 extern int bfd_stat (bfd *, struct stat *);
468
469 /* Deprecated old routines. */
470 #if __GNUC__
471 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
472 (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
473 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
474 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
475 (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
476 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
477 #else
478 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
479 (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
480 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
481 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
482 (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
483 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
484 #endif
485 extern void warn_deprecated (const char *, const char *, int, const char *);
486
487 /* Cast from const char * to char * so that caller can assign to
488 a char * without a warning. */
489 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
490 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
491 #define bfd_get_format(abfd) ((abfd)->format)
492 #define bfd_get_target(abfd) ((abfd)->xvec->name)
493 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
494 #define bfd_family_coff(abfd) \
495 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
496 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
497 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
498 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
499 #define bfd_header_big_endian(abfd) \
500 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
501 #define bfd_header_little_endian(abfd) \
502 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
503 #define bfd_get_file_flags(abfd) ((abfd)->flags)
504 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
505 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
506 #define bfd_my_archive(abfd) ((abfd)->my_archive)
507 #define bfd_has_map(abfd) ((abfd)->has_armap)
508
509 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
510 #define bfd_usrdata(abfd) ((abfd)->usrdata)
511
512 #define bfd_get_start_address(abfd) ((abfd)->start_address)
513 #define bfd_get_symcount(abfd) ((abfd)->symcount)
514 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
515 #define bfd_count_sections(abfd) ((abfd)->section_count)
516
517 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
518
519 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
520
521 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = bool), TRUE)
522
523 extern bfd_boolean bfd_cache_close
524 (bfd *abfd);
525 /* NB: This declaration should match the autogenerated one in libbfd.h. */
526
527 extern bfd_boolean bfd_cache_close_all (void);
528
529 extern bfd_boolean bfd_record_phdr
530 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
531 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
532
533 /* Byte swapping routines. */
534
535 bfd_uint64_t bfd_getb64 (const void *);
536 bfd_uint64_t bfd_getl64 (const void *);
537 bfd_int64_t bfd_getb_signed_64 (const void *);
538 bfd_int64_t bfd_getl_signed_64 (const void *);
539 bfd_vma bfd_getb32 (const void *);
540 bfd_vma bfd_getl32 (const void *);
541 bfd_signed_vma bfd_getb_signed_32 (const void *);
542 bfd_signed_vma bfd_getl_signed_32 (const void *);
543 bfd_vma bfd_getb16 (const void *);
544 bfd_vma bfd_getl16 (const void *);
545 bfd_signed_vma bfd_getb_signed_16 (const void *);
546 bfd_signed_vma bfd_getl_signed_16 (const void *);
547 void bfd_putb64 (bfd_uint64_t, void *);
548 void bfd_putl64 (bfd_uint64_t, void *);
549 void bfd_putb32 (bfd_vma, void *);
550 void bfd_putl32 (bfd_vma, void *);
551 void bfd_putb16 (bfd_vma, void *);
552 void bfd_putl16 (bfd_vma, void *);
553
554 /* Byte swapping routines which take size and endiannes as arguments. */
555
556 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
557 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
558
559 extern bfd_boolean bfd_section_already_linked_table_init (void);
560 extern void bfd_section_already_linked_table_free (void);
561 \f
562 /* Externally visible ECOFF routines. */
563
564 #if defined(__STDC__) || defined(ALMOST_STDC)
565 struct ecoff_debug_info;
566 struct ecoff_debug_swap;
567 struct ecoff_extr;
568 struct bfd_symbol;
569 struct bfd_link_info;
570 struct bfd_link_hash_entry;
571 struct bfd_elf_version_tree;
572 #endif
573 extern bfd_vma bfd_ecoff_get_gp_value
574 (bfd * abfd);
575 extern bfd_boolean bfd_ecoff_set_gp_value
576 (bfd *abfd, bfd_vma gp_value);
577 extern bfd_boolean bfd_ecoff_set_regmasks
578 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
579 unsigned long *cprmask);
580 extern void *bfd_ecoff_debug_init
581 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
582 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
583 extern void bfd_ecoff_debug_free
584 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
585 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
586 extern bfd_boolean bfd_ecoff_debug_accumulate
587 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
588 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
589 struct ecoff_debug_info *input_debug,
590 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
591 extern bfd_boolean bfd_ecoff_debug_accumulate_other
592 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
593 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
594 struct bfd_link_info *);
595 extern bfd_boolean bfd_ecoff_debug_externals
596 (bfd *abfd, struct ecoff_debug_info *debug,
597 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
598 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
599 void (*set_index) (struct bfd_symbol *, bfd_size_type));
600 extern bfd_boolean bfd_ecoff_debug_one_external
601 (bfd *abfd, struct ecoff_debug_info *debug,
602 const struct ecoff_debug_swap *swap, const char *name,
603 struct ecoff_extr *esym);
604 extern bfd_size_type bfd_ecoff_debug_size
605 (bfd *abfd, struct ecoff_debug_info *debug,
606 const struct ecoff_debug_swap *swap);
607 extern bfd_boolean bfd_ecoff_write_debug
608 (bfd *abfd, struct ecoff_debug_info *debug,
609 const struct ecoff_debug_swap *swap, file_ptr where);
610 extern bfd_boolean bfd_ecoff_write_accumulated_debug
611 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
612 const struct ecoff_debug_swap *swap,
613 struct bfd_link_info *info, file_ptr where);
614
615 /* Externally visible ELF routines. */
616
617 struct bfd_link_needed_list
618 {
619 struct bfd_link_needed_list *next;
620 bfd *by;
621 const char *name;
622 };
623
624 enum dynamic_lib_link_class {
625 DYN_NORMAL = 0,
626 DYN_AS_NEEDED = 1,
627 DYN_DT_NEEDED = 2,
628 DYN_NO_ADD_NEEDED = 4,
629 DYN_NO_NEEDED = 8
630 };
631
632 extern bfd_boolean bfd_elf_record_link_assignment
633 (bfd *, struct bfd_link_info *, const char *, bfd_boolean);
634 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
635 (bfd *, struct bfd_link_info *);
636 extern bfd_boolean bfd_elf_get_bfd_needed_list
637 (bfd *, struct bfd_link_needed_list **);
638 extern bfd_boolean bfd_elf_size_dynamic_sections
639 (bfd *, const char *, const char *, const char *, const char * const *,
640 struct bfd_link_info *, struct bfd_section **, struct bfd_elf_version_tree *);
641 extern void bfd_elf_set_dt_needed_name
642 (bfd *, const char *);
643 extern const char *bfd_elf_get_dt_soname
644 (bfd *);
645 extern void bfd_elf_set_dyn_lib_class
646 (bfd *, int);
647 extern int bfd_elf_get_dyn_lib_class
648 (bfd *);
649 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
650 (bfd *, struct bfd_link_info *);
651 extern bfd_boolean bfd_elf_discard_info
652 (bfd *, struct bfd_link_info *);
653
654 /* Return an upper bound on the number of bytes required to store a
655 copy of ABFD's program header table entries. Return -1 if an error
656 occurs; bfd_get_error will return an appropriate code. */
657 extern long bfd_get_elf_phdr_upper_bound
658 (bfd *abfd);
659
660 /* Copy ABFD's program header table entries to *PHDRS. The entries
661 will be stored as an array of Elf_Internal_Phdr structures, as
662 defined in include/elf/internal.h. To find out how large the
663 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
664
665 Return the number of program header table entries read, or -1 if an
666 error occurs; bfd_get_error will return an appropriate code. */
667 extern int bfd_get_elf_phdrs
668 (bfd *abfd, void *phdrs);
669
670 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
671 reconstruct an ELF file by reading the segments out of remote memory
672 based on the ELF file header at EHDR_VMA and the ELF program headers it
673 points to. If not null, *LOADBASEP is filled in with the difference
674 between the VMAs from which the segments were read, and the VMAs the
675 file headers (and hence BFD's idea of each section's VMA) put them at.
676
677 The function TARGET_READ_MEMORY is called to copy LEN bytes from the
678 remote memory at target address VMA into the local buffer at MYADDR; it
679 should return zero on success or an `errno' code on failure. TEMPL must
680 be a BFD for an ELF target with the word size and byte order found in
681 the remote memory. */
682 extern bfd *bfd_elf_bfd_from_remote_memory
683 (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
684 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, int len));
685
686 /* Return the arch_size field of an elf bfd, or -1 if not elf. */
687 extern int bfd_get_arch_size
688 (bfd *);
689
690 /* Return TRUE if address "naturally" sign extends, or -1 if not elf. */
691 extern int bfd_get_sign_extend_vma
692 (bfd *);
693
694 extern struct bfd_section *_bfd_elf_tls_setup
695 (bfd *, struct bfd_link_info *);
696
697 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
698 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
699
700 /* SunOS shared library support routines for the linker. */
701
702 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
703 (bfd *, struct bfd_link_info *);
704 extern bfd_boolean bfd_sunos_record_link_assignment
705 (bfd *, struct bfd_link_info *, const char *);
706 extern bfd_boolean bfd_sunos_size_dynamic_sections
707 (bfd *, struct bfd_link_info *, struct bfd_section **, struct bfd_section **, struct bfd_section **);
708
709 /* Linux shared library support routines for the linker. */
710
711 extern bfd_boolean bfd_i386linux_size_dynamic_sections
712 (bfd *, struct bfd_link_info *);
713 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
714 (bfd *, struct bfd_link_info *);
715 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
716 (bfd *, struct bfd_link_info *);
717
718 /* mmap hacks */
719
720 struct _bfd_window_internal;
721 typedef struct _bfd_window_internal bfd_window_internal;
722
723 typedef struct _bfd_window
724 {
725 /* What the user asked for. */
726 void *data;
727 bfd_size_type size;
728 /* The actual window used by BFD. Small user-requested read-only
729 regions sharing a page may share a single window into the object
730 file. Read-write versions shouldn't until I've fixed things to
731 keep track of which portions have been claimed by the
732 application; don't want to give the same region back when the
733 application wants two writable copies! */
734 struct _bfd_window_internal *i;
735 }
736 bfd_window;
737
738 extern void bfd_init_window
739 (bfd_window *);
740 extern void bfd_free_window
741 (bfd_window *);
742 extern bfd_boolean bfd_get_file_window
743 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
744
745 /* XCOFF support routines for the linker. */
746
747 extern bfd_boolean bfd_xcoff_link_record_set
748 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
749 extern bfd_boolean bfd_xcoff_import_symbol
750 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
751 const char *, const char *, const char *, unsigned int);
752 extern bfd_boolean bfd_xcoff_export_symbol
753 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
754 extern bfd_boolean bfd_xcoff_link_count_reloc
755 (bfd *, struct bfd_link_info *, const char *);
756 extern bfd_boolean bfd_xcoff_record_link_assignment
757 (bfd *, struct bfd_link_info *, const char *);
758 extern bfd_boolean bfd_xcoff_size_dynamic_sections
759 (bfd *, struct bfd_link_info *, const char *, const char *,
760 unsigned long, unsigned long, unsigned long, bfd_boolean,
761 int, bfd_boolean, bfd_boolean, struct bfd_section **, bfd_boolean);
762 extern bfd_boolean bfd_xcoff_link_generate_rtinit
763 (bfd *, const char *, const char *, bfd_boolean);
764
765 /* XCOFF support routines for ar. */
766 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
767 (bfd *, char *);
768
769 /* Externally visible COFF routines. */
770
771 #if defined(__STDC__) || defined(ALMOST_STDC)
772 struct internal_syment;
773 union internal_auxent;
774 #endif
775
776 extern bfd_boolean bfd_coff_get_syment
777 (bfd *, struct bfd_symbol *, struct internal_syment *);
778
779 extern bfd_boolean bfd_coff_get_auxent
780 (bfd *, struct bfd_symbol *, int, union internal_auxent *);
781
782 extern bfd_boolean bfd_coff_set_symbol_class
783 (bfd *, struct bfd_symbol *, unsigned int);
784
785 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
786 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
787
788 /* ARM Interworking support. Called from linker. */
789 extern bfd_boolean bfd_arm_allocate_interworking_sections
790 (struct bfd_link_info *);
791
792 extern bfd_boolean bfd_arm_process_before_allocation
793 (bfd *, struct bfd_link_info *, int);
794
795 extern bfd_boolean bfd_arm_get_bfd_for_interworking
796 (bfd *, struct bfd_link_info *);
797
798 /* PE ARM Interworking support. Called from linker. */
799 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
800 (struct bfd_link_info *);
801
802 extern bfd_boolean bfd_arm_pe_process_before_allocation
803 (bfd *, struct bfd_link_info *, int);
804
805 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
806 (bfd *, struct bfd_link_info *);
807
808 /* ELF ARM Interworking support. Called from linker. */
809 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
810 (struct bfd_link_info *);
811
812 extern bfd_boolean bfd_elf32_arm_process_before_allocation
813 (bfd *, struct bfd_link_info *, int);
814
815 void bfd_elf32_arm_set_target_relocs
816 (struct bfd_link_info *, int, char *, int);
817
818 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
819 (bfd *, struct bfd_link_info *);
820
821 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
822 (bfd *, struct bfd_link_info *);
823
824 /* ARM Note section processing. */
825 extern bfd_boolean bfd_arm_merge_machines
826 (bfd *, bfd *);
827
828 extern bfd_boolean bfd_arm_update_notes
829 (bfd *, const char *);
830
831 extern unsigned int bfd_arm_get_mach_from_notes
832 (bfd *, const char *);
833
834 /* TI COFF load page support. */
835 extern void bfd_ticoff_set_section_load_page
836 (struct bfd_section *, int);
837
838 extern int bfd_ticoff_get_section_load_page
839 (struct bfd_section *);
840
841 /* H8/300 functions. */
842 extern bfd_vma bfd_h8300_pad_address
843 (bfd *, bfd_vma);
844
845 /* IA64 Itanium code generation. Called from linker. */
846 extern void bfd_elf32_ia64_after_parse
847 (int);
848
849 extern void bfd_elf64_ia64_after_parse
850 (int);
851
852 /* This structure is used for a comdat section, as in PE. A comdat
853 section is associated with a particular symbol. When the linker
854 sees a comdat section, it keeps only one of the sections with a
855 given name and associated with a given symbol. */
856
857 struct coff_comdat_info
858 {
859 /* The name of the symbol associated with a comdat section. */
860 const char *name;
861
862 /* The local symbol table index of the symbol associated with a
863 comdat section. This is only meaningful to the object file format
864 specific code; it is not an index into the list returned by
865 bfd_canonicalize_symtab. */
866 long symbol;
867 };
868
869 extern struct coff_comdat_info *bfd_coff_get_comdat_section
870 (bfd *, struct bfd_section *);
871
This page took 0.048858 seconds and 4 git commands to generate.