2000-11-08 Kazu Hirata <kazu@hxi.com>
[external/binutils.git] / bfd / bfd-in.h
1 /* Main header file for the bfd library -- portable access to object files.
2    Copyright 1990, 91, 92, 93, 94, 95, 96, 97, 98, 99, 2000
3    Free Software Foundation, Inc.
4    Contributed by Cygnus Support.
5
6 ** NOTE: bfd.h and bfd-in2.h are GENERATED files.  Don't change them;
7 ** instead, change bfd-in.h or the other BFD source files processed to
8 ** generate these files.
9
10 This file is part of BFD, the Binary File Descriptor library.
11
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2 of the License, or
15 (at your option) any later version.
16
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 GNU General Public License for more details.
21
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
25
26 /* bfd.h -- The only header file required by users of the bfd library
27
28 The bfd.h file is generated from bfd-in.h and various .c files; if you
29 change it, your changes will probably be lost.
30
31 All the prototypes and definitions following the comment "THE FOLLOWING
32 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
33 BFD.  If you change it, someone oneday will extract it from the source
34 again, and your changes will be lost.  To save yourself from this bind,
35 change the definitions in the source in the bfd directory.  Type "make
36 docs" and then "make headers" in that directory, and magically this file
37 will change to reflect your changes.
38
39 If you don't have the tools to perform the extraction, then you are
40 safe from someone on your system trampling over your header files.
41 You should still maintain the equivalence between the source and this
42 file though; every change you make to the .c file should be reflected
43 here.  */
44
45 #ifndef __BFD_H_SEEN__
46 #define __BFD_H_SEEN__
47
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51
52 #include "ansidecl.h"
53
54 /* These two lines get substitutions done by commands in Makefile.in.  */
55 #define BFD_VERSION  "@VERSION@"
56 #define BFD_ARCH_SIZE @wordsize@
57 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
58 #if @BFD_HOST_64_BIT_DEFINED@
59 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
60 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
61 #endif
62
63 #if BFD_ARCH_SIZE >= 64
64 #define BFD64
65 #endif
66
67 #ifndef INLINE
68 #if __GNUC__ >= 2
69 #define INLINE __inline__
70 #else
71 #define INLINE
72 #endif
73 #endif
74
75 /* forward declaration */
76 typedef struct _bfd bfd;
77
78 /* To squelch erroneous compiler warnings ("illegal pointer
79    combination") from the SVR3 compiler, we would like to typedef
80    boolean to int (it doesn't like functions which return boolean.
81    Making sure they are never implicitly declared to return int
82    doesn't seem to help).  But this file is not configured based on
83    the host.  */
84 /* General rules: functions which are boolean return true on success
85    and false on failure (unless they're a predicate).   -- bfd.doc */
86 /* I'm sure this is going to break something and someone is going to
87    force me to change it.  */
88 /* typedef enum boolean {false, true} boolean; */
89 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
90 /* It gets worse if the host also defines a true/false enum... -sts */
91 /* And even worse if your compiler has built-in boolean types... -law */
92 #if defined (__GNUG__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))
93 #define TRUE_FALSE_ALREADY_DEFINED
94 #endif
95 #ifdef MPW
96 /* Pre-emptive strike - get the file with the enum.  */
97 #include <Types.h>
98 #define TRUE_FALSE_ALREADY_DEFINED
99 #endif /* MPW */
100 #ifndef TRUE_FALSE_ALREADY_DEFINED
101 typedef enum bfd_boolean {false, true} boolean;
102 #define BFD_TRUE_FALSE
103 #else
104 /* Use enum names that will appear nowhere else.  */
105 typedef enum bfd_boolean {bfd_fffalse, bfd_tttrue} boolean;
106 #endif
107
108 /* A pointer to a position in a file.  */
109 /* FIXME:  This should be using off_t from <sys/types.h>.
110    For now, try to avoid breaking stuff by not including <sys/types.h> here.
111    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
112    Probably the best long-term answer is to avoid using file_ptr AND off_t
113    in this header file, and to handle this in the BFD implementation
114    rather than in its interface.  */
115 /* typedef off_t        file_ptr; */
116 typedef long int file_ptr;
117
118 /* Support for different sizes of target format ints and addresses.
119    If the type `long' is at least 64 bits, BFD_HOST_64BIT_LONG will be
120    set to 1 above.  Otherwise, if gcc is being used, this code will
121    use gcc's "long long" type.  Otherwise, BFD_HOST_64_BIT must be
122    defined above.  */
123
124 #ifndef BFD_HOST_64_BIT
125 # if BFD_HOST_64BIT_LONG
126 #  define BFD_HOST_64_BIT long
127 #  define BFD_HOST_U_64_BIT unsigned long
128 # else
129 #  ifdef __GNUC__
130 #   if __GNUC__ >= 2
131 #    define BFD_HOST_64_BIT long long
132 #    define BFD_HOST_U_64_BIT unsigned long long
133 #   endif /* __GNUC__ >= 2 */
134 #  endif /* ! defined (__GNUC__) */
135 # endif /* ! BFD_HOST_64BIT_LONG */
136 #endif /* ! defined (BFD_HOST_64_BIT) */
137
138 #ifdef BFD64
139
140 #ifndef BFD_HOST_64_BIT
141  #error No 64 bit integer type available
142 #endif /* ! defined (BFD_HOST_64_BIT) */
143
144 typedef BFD_HOST_U_64_BIT bfd_vma;
145 typedef BFD_HOST_64_BIT bfd_signed_vma;
146 typedef BFD_HOST_U_64_BIT bfd_size_type;
147 typedef BFD_HOST_U_64_BIT symvalue;
148
149 #ifndef fprintf_vma
150 #if BFD_HOST_64BIT_LONG
151 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
152 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
153 #else
154 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
155 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
156 #define fprintf_vma(s,x) \
157   fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
158 #define sprintf_vma(s,x) \
159   sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
160 #endif
161 #endif
162
163 #else /* not BFD64  */
164
165 /* Represent a target address.  Also used as a generic unsigned type
166    which is guaranteed to be big enough to hold any arithmetic types
167    we need to deal with.  */
168 typedef unsigned long bfd_vma;
169
170 /* A generic signed type which is guaranteed to be big enough to hold any
171    arithmetic types we need to deal with.  Can be assumed to be compatible
172    with bfd_vma in the same way that signed and unsigned ints are compatible
173    (as parameters, in assignment, etc).  */
174 typedef long bfd_signed_vma;
175
176 typedef unsigned long symvalue;
177 typedef unsigned long bfd_size_type;
178
179 /* Print a bfd_vma x on stream s.  */
180 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
181 #define sprintf_vma(s,x) sprintf(s, "%08lx", x)
182
183 #endif /* not BFD64  */
184
185 #define printf_vma(x) fprintf_vma(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               bfd_unknown = 0,  /* file format is unknown */
194               bfd_object,       /* linker/assember/compiler output */
195               bfd_archive,      /* object archive file */
196               bfd_core,         /* core dump */
197               bfd_type_end}     /* marks the end; don't use it! */
198          bfd_format;
199
200 /* Values that may appear in the flags field of a BFD.  These also
201    appear in the object_flags field of the bfd_target structure, where
202    they indicate the set of flags used by that backend (not all flags
203    are meaningful for all object file formats) (FIXME: at the moment,
204    the object_flags values have mostly just been copied from backend
205    to another, and are not necessarily correct).  */
206
207 /* No flags.  */
208 #define BFD_NO_FLAGS    0x00
209
210 /* BFD contains relocation entries.  */
211 #define HAS_RELOC       0x01
212
213 /* BFD is directly executable.  */
214 #define EXEC_P          0x02
215
216 /* BFD has line number information (basically used for F_LNNO in a
217    COFF header).  */
218 #define HAS_LINENO      0x04
219
220 /* BFD has debugging information.  */
221 #define HAS_DEBUG       0x08
222
223 /* BFD has symbols.  */
224 #define HAS_SYMS        0x10
225
226 /* BFD has local symbols (basically used for F_LSYMS in a COFF
227    header).  */
228 #define HAS_LOCALS      0x20
229
230 /* BFD is a dynamic object.  */
231 #define DYNAMIC         0x40
232
233 /* Text section is write protected (if D_PAGED is not set, this is
234    like an a.out NMAGIC file) (the linker sets this by default, but
235    clears it for -r or -N).  */
236 #define WP_TEXT         0x80
237
238 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
239    linker sets this by default, but clears it for -r or -n or -N).  */
240 #define D_PAGED         0x100
241
242 /* BFD is relaxable (this means that bfd_relax_section may be able to
243    do something) (sometimes bfd_relax_section can do something even if
244    this is not set).  */
245 #define BFD_IS_RELAXABLE 0x200
246
247 /* This may be set before writing out a BFD to request using a
248    traditional format.  For example, this is used to request that when
249    writing out an a.out object the symbols not be hashed to eliminate
250    duplicates.  */
251 #define BFD_TRADITIONAL_FORMAT 0x400
252
253 /* This flag indicates that the BFD contents are actually cached in
254    memory.  If this is set, iostream points to a bfd_in_memory struct.  */
255 #define BFD_IN_MEMORY 0x800
256 \f
257 /* symbols and relocation */
258
259 /* A count of carsyms (canonical archive symbols).  */
260 typedef unsigned long symindex;
261
262 /* How to perform a relocation.  */
263 typedef const struct reloc_howto_struct reloc_howto_type;
264
265 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
266
267 /* General purpose part of a symbol X;
268    target specific parts are in libcoff.h, libaout.h, etc.  */
269
270 #define bfd_get_section(x) ((x)->section)
271 #define bfd_get_output_section(x) ((x)->section->output_section)
272 #define bfd_set_section(x,y) ((x)->section) = (y)
273 #define bfd_asymbol_base(x) ((x)->section->vma)
274 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
275 #define bfd_asymbol_name(x) ((x)->name)
276 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
277 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
278 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
279
280 /* A canonical archive symbol.  */
281 /* This is a type pun with struct ranlib on purpose! */
282 typedef struct carsym {
283   char *name;
284   file_ptr file_offset;         /* look here to find the file */
285 } carsym;                       /* to make these you call a carsymogen */
286
287 /* Used in generating armaps (archive tables of contents).
288    Perhaps just a forward definition would do? */
289 struct orl {                    /* output ranlib */
290   char **name;                  /* symbol name */
291   file_ptr pos;                 /* bfd* or file position */
292   int namidx;                   /* index into string table */
293 };
294 \f
295
296 /* Linenumber stuff */
297 typedef struct lineno_cache_entry {
298   unsigned int line_number;     /* Linenumber from start of function*/
299   union {
300     struct symbol_cache_entry *sym; /* Function name */
301     unsigned long offset;       /* Offset into section */
302   } u;
303 } alent;
304 \f
305 /* object and core file sections */
306
307 #define align_power(addr, align)        \
308         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
309
310 typedef struct sec *sec_ptr;
311
312 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
313 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
314 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
315 #define bfd_section_name(bfd, ptr) ((ptr)->name)
316 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
317 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
318 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
319 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
320 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
321 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
322
323 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
324
325 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = (boolean)true), true)
326 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
327 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
328
329 typedef struct stat stat_type;
330 \f
331 typedef enum bfd_print_symbol
332 {
333   bfd_print_symbol_name,
334   bfd_print_symbol_more,
335   bfd_print_symbol_all
336 } bfd_print_symbol_type;
337
338 /* Information about a symbol that nm needs.  */
339
340 typedef struct _symbol_info
341 {
342   symvalue value;
343   char type;
344   CONST char *name;            /* Symbol name.  */
345   unsigned char stab_type;     /* Stab type.  */
346   char stab_other;             /* Stab other.  */
347   short stab_desc;             /* Stab desc.  */
348   CONST char *stab_name;       /* String for stab type.  */
349 } symbol_info;
350
351 /* Get the name of a stabs type code.  */
352
353 extern const char *bfd_get_stab_name PARAMS ((int));
354 \f
355 /* Hash table routines.  There is no way to free up a hash table.  */
356
357 /* An element in the hash table.  Most uses will actually use a larger
358    structure, and an instance of this will be the first field.  */
359
360 struct bfd_hash_entry
361 {
362   /* Next entry for this hash code.  */
363   struct bfd_hash_entry *next;
364   /* String being hashed.  */
365   const char *string;
366   /* Hash code.  This is the full hash code, not the index into the
367      table.  */
368   unsigned long hash;
369 };
370
371 /* A hash table.  */
372
373 struct bfd_hash_table
374 {
375   /* The hash array.  */
376   struct bfd_hash_entry **table;
377   /* The number of slots in the hash table.  */
378   unsigned int size;
379   /* A function used to create new elements in the hash table.  The
380      first entry is itself a pointer to an element.  When this
381      function is first invoked, this pointer will be NULL.  However,
382      having the pointer permits a hierarchy of method functions to be
383      built each of which calls the function in the superclass.  Thus
384      each function should be written to allocate a new block of memory
385      only if the argument is NULL.  */
386   struct bfd_hash_entry *(*newfunc) PARAMS ((struct bfd_hash_entry *,
387                                              struct bfd_hash_table *,
388                                              const char *));
389    /* An objalloc for this hash table.  This is a struct objalloc *,
390      but we use PTR to avoid requiring the inclusion of objalloc.h.  */
391   PTR memory;
392 };
393
394 /* Initialize a hash table.  */
395 extern boolean bfd_hash_table_init
396   PARAMS ((struct bfd_hash_table *,
397            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
398                                        struct bfd_hash_table *,
399                                        const char *)));
400
401 /* Initialize a hash table specifying a size.  */
402 extern boolean bfd_hash_table_init_n
403   PARAMS ((struct bfd_hash_table *,
404            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
405                                        struct bfd_hash_table *,
406                                        const char *),
407            unsigned int size));
408
409 /* Free up a hash table.  */
410 extern void bfd_hash_table_free PARAMS ((struct bfd_hash_table *));
411
412 /* Look up a string in a hash table.  If CREATE is true, a new entry
413    will be created for this string if one does not already exist.  The
414    COPY argument must be true if this routine should copy the string
415    into newly allocated memory when adding an entry.  */
416 extern struct bfd_hash_entry *bfd_hash_lookup
417   PARAMS ((struct bfd_hash_table *, const char *, boolean create,
418            boolean copy));
419
420 /* Replace an entry in a hash table.  */
421 extern void bfd_hash_replace
422   PARAMS ((struct bfd_hash_table *, struct bfd_hash_entry *old,
423            struct bfd_hash_entry *nw));
424
425 /* Base method for creating a hash table entry.  */
426 extern struct bfd_hash_entry *bfd_hash_newfunc
427   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *,
428            const char *));
429
430 /* Grab some space for a hash table entry.  */
431 extern PTR bfd_hash_allocate PARAMS ((struct bfd_hash_table *,
432                                       unsigned int));
433
434 /* Traverse a hash table in a random order, calling a function on each
435    element.  If the function returns false, the traversal stops.  The
436    INFO argument is passed to the function.  */
437 extern void bfd_hash_traverse PARAMS ((struct bfd_hash_table *,
438                                        boolean (*) (struct bfd_hash_entry *,
439                                                     PTR),
440                                        PTR info));
441 \f
442 /* Semi-portable string concatenation in cpp.
443    The CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
444    The problem is, "32_" is not a valid preprocessing token, and we don't
445    want extra underscores (e.g., "nlm_32_").  The XCAT2 macro will cause the
446    inner CAT macros to be evaluated first, producing still-valid pp-tokens.
447    Then the final concatenation can be done.  (Sigh.)  */
448 #ifndef CAT
449 #ifdef SABER
450 #define CAT(a,b)        a##b
451 #define CAT3(a,b,c)     a##b##c
452 #define CAT4(a,b,c,d)   a##b##c##d
453 #else
454 #if defined(__STDC__) || defined(ALMOST_STDC)
455 #define CAT(a,b) a##b
456 #define CAT3(a,b,c) a##b##c
457 #define XCAT2(a,b)      CAT(a,b)
458 #define CAT4(a,b,c,d)   XCAT2(CAT(a,b),CAT(c,d))
459 #else
460 #define CAT(a,b) a/**/b
461 #define CAT3(a,b,c) a/**/b/**/c
462 #define CAT4(a,b,c,d)   a/**/b/**/c/**/d
463 #endif
464 #endif
465 #endif
466
467 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
468 \f
469 /* User program access to BFD facilities */
470
471 /* Direct I/O routines, for programs which know more about the object
472    file than BFD does.  Use higher level routines if possible.  */
473
474 extern bfd_size_type bfd_read
475   PARAMS ((PTR, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
476 extern bfd_size_type bfd_write
477   PARAMS ((const PTR, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
478 extern int bfd_seek PARAMS ((bfd *abfd, file_ptr fp, int direction));
479 extern long bfd_tell PARAMS ((bfd *abfd));
480 extern int bfd_flush PARAMS ((bfd *abfd));
481 extern int bfd_stat PARAMS ((bfd *abfd, struct stat *));
482
483 /* Cast from const char * to char * so that caller can assign to
484    a char * without a warning.  */
485 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
486 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
487 #define bfd_get_format(abfd) ((abfd)->format)
488 #define bfd_get_target(abfd) ((abfd)->xvec->name)
489 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
490 #define bfd_family_coff(abfd) \
491   (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
492    bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
493 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
494 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
495 #define bfd_header_big_endian(abfd) \
496   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
497 #define bfd_header_little_endian(abfd) \
498   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
499 #define bfd_get_file_flags(abfd) ((abfd)->flags)
500 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
501 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
502 #define bfd_my_archive(abfd) ((abfd)->my_archive)
503 #define bfd_has_map(abfd) ((abfd)->has_armap)
504
505 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
506 #define bfd_usrdata(abfd) ((abfd)->usrdata)
507
508 #define bfd_get_start_address(abfd) ((abfd)->start_address)
509 #define bfd_get_symcount(abfd) ((abfd)->symcount)
510 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
511 #define bfd_count_sections(abfd) ((abfd)->section_count)
512
513 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
514
515 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (boolean)(bool)), true)
516
517 extern boolean bfd_record_phdr
518   PARAMS ((bfd *, unsigned long, boolean, flagword, boolean, bfd_vma,
519            boolean, boolean, unsigned int, struct sec **));
520
521 /* Byte swapping routines.  */
522
523 bfd_vma         bfd_getb64         PARAMS ((const unsigned char *));
524 bfd_vma         bfd_getl64         PARAMS ((const unsigned char *));
525 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((const unsigned char *));
526 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((const unsigned char *));
527 bfd_vma         bfd_getb32         PARAMS ((const unsigned char *));
528 bfd_vma         bfd_getl32         PARAMS ((const unsigned char *));
529 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((const unsigned char *));
530 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((const unsigned char *));
531 bfd_vma         bfd_getb16         PARAMS ((const unsigned char *));
532 bfd_vma         bfd_getl16         PARAMS ((const unsigned char *));
533 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((const unsigned char *));
534 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((const unsigned char *));
535 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
536 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
537 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
538 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
539 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
540 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
541 \f
542 /* Externally visible ECOFF routines.  */
543
544 #if defined(__STDC__) || defined(ALMOST_STDC)
545 struct ecoff_debug_info;
546 struct ecoff_debug_swap;
547 struct ecoff_extr;
548 struct symbol_cache_entry;
549 struct bfd_link_info;
550 struct bfd_link_hash_entry;
551 struct bfd_elf_version_tree;
552 #endif
553 extern bfd_vma bfd_ecoff_get_gp_value PARAMS ((bfd * abfd));
554 extern boolean bfd_ecoff_set_gp_value PARAMS ((bfd *abfd, bfd_vma gp_value));
555 extern boolean bfd_ecoff_set_regmasks
556   PARAMS ((bfd *abfd, unsigned long gprmask, unsigned long fprmask,
557            unsigned long *cprmask));
558 extern PTR bfd_ecoff_debug_init
559   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
560            const struct ecoff_debug_swap *output_swap,
561            struct bfd_link_info *));
562 extern void bfd_ecoff_debug_free
563   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
564            const struct ecoff_debug_swap *output_swap,
565            struct bfd_link_info *));
566 extern boolean bfd_ecoff_debug_accumulate
567   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
568            const struct ecoff_debug_swap *output_swap,
569            bfd *input_bfd, struct ecoff_debug_info *input_debug,
570            const struct ecoff_debug_swap *input_swap,
571            struct bfd_link_info *));
572 extern boolean bfd_ecoff_debug_accumulate_other
573   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
574            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
575            struct bfd_link_info *));
576 extern boolean bfd_ecoff_debug_externals
577   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
578            const struct ecoff_debug_swap *swap,
579            boolean relocateable,
580            boolean (*get_extr) (struct symbol_cache_entry *,
581                                 struct ecoff_extr *),
582            void (*set_index) (struct symbol_cache_entry *,
583                               bfd_size_type)));
584 extern boolean bfd_ecoff_debug_one_external
585   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
586            const struct ecoff_debug_swap *swap,
587            const char *name, struct ecoff_extr *esym));
588 extern bfd_size_type bfd_ecoff_debug_size
589   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
590            const struct ecoff_debug_swap *swap));
591 extern boolean bfd_ecoff_write_debug
592   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
593            const struct ecoff_debug_swap *swap, file_ptr where));
594 extern boolean bfd_ecoff_write_accumulated_debug
595   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
596            const struct ecoff_debug_swap *swap,
597            struct bfd_link_info *info, file_ptr where));
598 extern boolean bfd_mips_ecoff_create_embedded_relocs
599   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
600            char **));
601
602 /* Externally visible ELF routines.  */
603
604 struct bfd_link_needed_list
605 {
606   struct bfd_link_needed_list *next;
607   bfd *by;
608   const char *name;
609 };
610
611 extern boolean bfd_elf32_record_link_assignment
612   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
613 extern boolean bfd_elf64_record_link_assignment
614   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
615 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
616   PARAMS ((bfd *, struct bfd_link_info *));
617 extern boolean bfd_elf_get_bfd_needed_list
618   PARAMS ((bfd *, struct bfd_link_needed_list **));
619 extern boolean bfd_elf32_size_dynamic_sections
620   PARAMS ((bfd *, const char *, const char *, boolean, const char *,
621            const char * const *, struct bfd_link_info *, struct sec **,
622            struct bfd_elf_version_tree *));
623 extern boolean bfd_elf64_size_dynamic_sections
624   PARAMS ((bfd *, const char *, const char *, boolean, const char *,
625            const char * const *, struct bfd_link_info *, struct sec **,
626            struct bfd_elf_version_tree *));
627 extern void bfd_elf_set_dt_needed_name PARAMS ((bfd *, const char *));
628 extern void bfd_elf_set_dt_needed_soname PARAMS ((bfd *, const char *));
629 extern const char *bfd_elf_get_dt_soname PARAMS ((bfd *));
630 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
631   PARAMS ((bfd *, struct bfd_link_info *));
632
633 /* Return an upper bound on the number of bytes required to store a
634    copy of ABFD's program header table entries.  Return -1 if an error
635    occurs; bfd_get_error will return an appropriate code.  */
636 extern long bfd_get_elf_phdr_upper_bound PARAMS ((bfd *abfd));
637
638 /* Copy ABFD's program header table entries to *PHDRS.  The entries
639    will be stored as an array of Elf_Internal_Phdr structures, as
640    defined in include/elf/internal.h.  To find out how large the
641    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
642
643    Return the number of program header table entries read, or -1 if an
644    error occurs; bfd_get_error will return an appropriate code.  */
645 extern int bfd_get_elf_phdrs PARAMS ((bfd *abfd, void *phdrs));
646
647 /* Return the arch_size field of an elf bfd, or -1 if not elf.  */
648 extern int bfd_get_arch_size PARAMS ((bfd *));
649
650 /* Return true if address "naturally" sign extends, or -1 if not elf.  */
651 extern int bfd_get_sign_extend_vma PARAMS ((bfd *));
652
653 extern boolean bfd_m68k_elf32_create_embedded_relocs
654   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
655            char **));
656
657 /* SunOS shared library support routines for the linker.  */
658
659 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
660   PARAMS ((bfd *, struct bfd_link_info *));
661 extern boolean bfd_sunos_record_link_assignment
662   PARAMS ((bfd *, struct bfd_link_info *, const char *));
663 extern boolean bfd_sunos_size_dynamic_sections
664   PARAMS ((bfd *, struct bfd_link_info *, struct sec **, struct sec **,
665            struct sec **));
666
667 /* Linux shared library support routines for the linker.  */
668
669 extern boolean bfd_i386linux_size_dynamic_sections
670   PARAMS ((bfd *, struct bfd_link_info *));
671 extern boolean bfd_m68klinux_size_dynamic_sections
672   PARAMS ((bfd *, struct bfd_link_info *));
673 extern boolean bfd_sparclinux_size_dynamic_sections
674   PARAMS ((bfd *, struct bfd_link_info *));
675
676 /* mmap hacks */
677
678 struct _bfd_window_internal;
679 typedef struct _bfd_window_internal bfd_window_internal;
680
681 typedef struct _bfd_window {
682   /* What the user asked for.  */
683   PTR data;
684   bfd_size_type size;
685   /* The actual window used by BFD.  Small user-requested read-only
686      regions sharing a page may share a single window into the object
687      file.  Read-write versions shouldn't until I've fixed things to
688      keep track of which portions have been claimed by the
689      application; don't want to give the same region back when the
690      application wants two writable copies!  */
691   struct _bfd_window_internal *i;
692 } bfd_window;
693
694 extern void bfd_init_window PARAMS ((bfd_window *));
695 extern void bfd_free_window PARAMS ((bfd_window *));
696 extern boolean bfd_get_file_window
697   PARAMS ((bfd *, file_ptr, bfd_size_type, bfd_window *, boolean));
698
699 /* XCOFF support routines for the linker.  */
700
701 extern boolean bfd_xcoff_link_record_set
702   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
703            bfd_size_type));
704 extern boolean bfd_xcoff_import_symbol
705   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
706            bfd_vma, const char *, const char *, const char *));
707 extern boolean bfd_xcoff_export_symbol
708   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
709            boolean));
710 extern boolean bfd_xcoff_link_count_reloc
711   PARAMS ((bfd *, struct bfd_link_info *, const char *));
712 extern boolean bfd_xcoff_record_link_assignment
713   PARAMS ((bfd *, struct bfd_link_info *, const char *));
714 extern boolean bfd_xcoff_size_dynamic_sections
715   PARAMS ((bfd *, struct bfd_link_info *, const char *, const char *,
716            unsigned long, unsigned long, unsigned long, boolean,
717            int, boolean, boolean, struct sec **));
718
719 /* Externally visible COFF routines.  */
720
721 #if defined(__STDC__) || defined(ALMOST_STDC)
722 struct internal_syment;
723 union internal_auxent;
724 #endif
725
726 extern boolean bfd_coff_get_syment
727   PARAMS ((bfd *, struct symbol_cache_entry *, struct internal_syment *));
728
729 extern boolean bfd_coff_get_auxent
730   PARAMS ((bfd *, struct symbol_cache_entry *, int, union internal_auxent *));
731
732 extern boolean bfd_coff_set_symbol_class
733   PARAMS ((bfd *, struct symbol_cache_entry *, unsigned int));
734
735 extern boolean bfd_m68k_coff_create_embedded_relocs
736   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
737            char **));
738
739 /* ARM Interworking support.  Called from linker.  */
740 extern boolean bfd_arm_allocate_interworking_sections
741   PARAMS ((struct bfd_link_info *));
742
743 extern boolean bfd_arm_process_before_allocation
744   PARAMS ((bfd *, struct bfd_link_info *, int));
745
746 extern boolean bfd_arm_get_bfd_for_interworking
747   PARAMS ((bfd *, struct bfd_link_info *));
748
749 /* PE ARM Interworking support.  Called from linker.  */
750 extern boolean bfd_arm_pe_allocate_interworking_sections
751   PARAMS ((struct bfd_link_info *));
752
753 extern boolean bfd_arm_pe_process_before_allocation
754   PARAMS ((bfd *, struct bfd_link_info *, int));
755
756 extern boolean bfd_arm_pe_get_bfd_for_interworking
757   PARAMS ((bfd *, struct bfd_link_info *));
758
759 /* ELF ARM Interworking support.  Called from linker.  */
760 extern boolean bfd_elf32_arm_allocate_interworking_sections
761   PARAMS ((struct bfd_link_info *));
762
763 extern boolean bfd_elf32_arm_process_before_allocation
764   PARAMS ((bfd *, struct bfd_link_info *, int));
765
766 extern boolean bfd_elf32_arm_get_bfd_for_interworking
767   PARAMS ((bfd *, struct bfd_link_info *));
768
769 /* TI COFF load page support.  */
770 extern void bfd_ticoff_set_section_load_page
771   PARAMS ((struct sec *, int));
772
773 extern int bfd_ticoff_get_section_load_page
774   PARAMS ((struct sec *));
775
776 /* And more from the source.  */