e4711b39b2148be0d4a9b325c20606bf246cf5e5
[external/binutils.git] / bfd / bfd-in2.h
1 /* Main header file for the bfd library -- portable access to object files.
2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3    2000, 2001
4    Free Software Foundation, Inc.
5    Contributed by Cygnus Support.
6
7 ** NOTE: bfd.h and bfd-in2.h are GENERATED files.  Don't change them;
8 ** instead, change bfd-in.h or the other BFD source files processed to
9 ** generate these files.
10
11 This file is part of BFD, the Binary File Descriptor library.
12
13 This program is free software; you can redistribute it and/or modify
14 it under the terms of the GNU General Public License as published by
15 the Free Software Foundation; either version 2 of the License, or
16 (at your option) any later version.
17
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 GNU General Public License for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, write to the Free Software
25 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
26
27 /* bfd.h -- The only header file required by users of the bfd library
28
29 The bfd.h file is generated from bfd-in.h and various .c files; if you
30 change it, your changes will probably be lost.
31
32 All the prototypes and definitions following the comment "THE FOLLOWING
33 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
34 BFD.  If you change it, someone oneday will extract it from the source
35 again, and your changes will be lost.  To save yourself from this bind,
36 change the definitions in the source in the bfd directory.  Type "make
37 docs" and then "make headers" in that directory, and magically this file
38 will change to reflect your changes.
39
40 If you don't have the tools to perform the extraction, then you are
41 safe from someone on your system trampling over your header files.
42 You should still maintain the equivalence between the source and this
43 file though; every change you make to the .c file should be reflected
44 here.  */
45
46 #ifndef __BFD_H_SEEN__
47 #define __BFD_H_SEEN__
48
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52
53 #include "ansidecl.h"
54
55 /* These two lines get substitutions done by commands in Makefile.in.  */
56 #define BFD_VERSION  "@VERSION@"
57 #define BFD_ARCH_SIZE @wordsize@
58 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
59 #if @BFD_HOST_64_BIT_DEFINED@
60 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
61 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
62 #endif
63
64 #if BFD_ARCH_SIZE >= 64
65 #define BFD64
66 #endif
67
68 #ifndef INLINE
69 #if __GNUC__ >= 2
70 #define INLINE __inline__
71 #else
72 #define INLINE
73 #endif
74 #endif
75
76 /* forward declaration */
77 typedef struct _bfd bfd;
78
79 /* To squelch erroneous compiler warnings ("illegal pointer
80    combination") from the SVR3 compiler, we would like to typedef
81    boolean to int (it doesn't like functions which return boolean.
82    Making sure they are never implicitly declared to return int
83    doesn't seem to help).  But this file is not configured based on
84    the host.  */
85 /* General rules: functions which are boolean return true on success
86    and false on failure (unless they're a predicate).   -- bfd.doc */
87 /* I'm sure this is going to break something and someone is going to
88    force me to change it.  */
89 /* typedef enum boolean {false, true} boolean; */
90 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
91 /* It gets worse if the host also defines a true/false enum... -sts */
92 /* And even worse if your compiler has built-in boolean types... -law */
93 #if defined (__GNUG__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))
94 #define TRUE_FALSE_ALREADY_DEFINED
95 #endif
96 #ifdef MPW
97 /* Pre-emptive strike - get the file with the enum.  */
98 #include <Types.h>
99 #define TRUE_FALSE_ALREADY_DEFINED
100 #endif /* MPW */
101 #ifndef TRUE_FALSE_ALREADY_DEFINED
102 typedef enum bfd_boolean {false, true} boolean;
103 #define BFD_TRUE_FALSE
104 #else
105 /* Use enum names that will appear nowhere else.  */
106 typedef enum bfd_boolean {bfd_fffalse, bfd_tttrue} boolean;
107 #endif
108
109 /* A pointer to a position in a file.  */
110 /* FIXME:  This should be using off_t from <sys/types.h>.
111    For now, try to avoid breaking stuff by not including <sys/types.h> here.
112    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
113    Probably the best long-term answer is to avoid using file_ptr AND off_t
114    in this header file, and to handle this in the BFD implementation
115    rather than in its interface.  */
116 /* typedef off_t        file_ptr; */
117 typedef long int file_ptr;
118
119 /* Support for different sizes of target format ints and addresses.
120    If the type `long' is at least 64 bits, BFD_HOST_64BIT_LONG will be
121    set to 1 above.  Otherwise, if gcc is being used, this code will
122    use gcc's "long long" type.  Otherwise, BFD_HOST_64_BIT must be
123    defined above.  */
124
125 #ifndef BFD_HOST_64_BIT
126 # if BFD_HOST_64BIT_LONG
127 #  define BFD_HOST_64_BIT long
128 #  define BFD_HOST_U_64_BIT unsigned long
129 # else
130 #  ifdef __GNUC__
131 #   if __GNUC__ >= 2
132 #    define BFD_HOST_64_BIT long long
133 #    define BFD_HOST_U_64_BIT unsigned long long
134 #   endif /* __GNUC__ >= 2 */
135 #  endif /* ! defined (__GNUC__) */
136 # endif /* ! BFD_HOST_64BIT_LONG */
137 #endif /* ! defined (BFD_HOST_64_BIT) */
138
139 #ifdef BFD64
140
141 #ifndef BFD_HOST_64_BIT
142  #error No 64 bit integer type available
143 #endif /* ! defined (BFD_HOST_64_BIT) */
144
145 typedef BFD_HOST_U_64_BIT bfd_vma;
146 typedef BFD_HOST_64_BIT bfd_signed_vma;
147 typedef BFD_HOST_U_64_BIT bfd_size_type;
148 typedef BFD_HOST_U_64_BIT symvalue;
149
150 #ifndef fprintf_vma
151 #if BFD_HOST_64BIT_LONG
152 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
153 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
154 #else
155 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
156 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
157 #define fprintf_vma(s,x) \
158   fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
159 #define sprintf_vma(s,x) \
160   sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
161 #endif
162 #endif
163
164 #else /* not BFD64  */
165
166 /* Represent a target address.  Also used as a generic unsigned type
167    which is guaranteed to be big enough to hold any arithmetic types
168    we need to deal with.  */
169 typedef unsigned long bfd_vma;
170
171 /* A generic signed type which is guaranteed to be big enough to hold any
172    arithmetic types we need to deal with.  Can be assumed to be compatible
173    with bfd_vma in the same way that signed and unsigned ints are compatible
174    (as parameters, in assignment, etc).  */
175 typedef long bfd_signed_vma;
176
177 typedef unsigned long symvalue;
178 typedef unsigned long bfd_size_type;
179
180 /* Print a bfd_vma x on stream s.  */
181 #define fprintf_vma(s,x) fprintf (s, "%08lx", x)
182 #define sprintf_vma(s,x) sprintf (s, "%08lx", x)
183
184 #endif /* not BFD64  */
185
186 #define printf_vma(x) fprintf_vma(stdout,x)
187
188 typedef unsigned int flagword;  /* 32 bits of flags */
189 typedef unsigned char bfd_byte;
190 \f
191 /** File formats */
192
193 typedef enum bfd_format {
194               bfd_unknown = 0,  /* file format is unknown */
195               bfd_object,       /* linker/assember/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          bfd_format;
200
201 /* Values that may appear in the flags field of a BFD.  These also
202    appear in the object_flags field of the bfd_target structure, where
203    they indicate the set of flags used by that backend (not all flags
204    are meaningful for all object file formats) (FIXME: at the moment,
205    the object_flags values have mostly just been copied from backend
206    to another, and are not necessarily correct).  */
207
208 /* No flags.  */
209 #define BFD_NO_FLAGS    0x00
210
211 /* BFD contains relocation entries.  */
212 #define HAS_RELOC       0x01
213
214 /* BFD is directly executable.  */
215 #define EXEC_P          0x02
216
217 /* BFD has line number information (basically used for F_LNNO in a
218    COFF header).  */
219 #define HAS_LINENO      0x04
220
221 /* BFD has debugging information.  */
222 #define HAS_DEBUG       0x08
223
224 /* BFD has symbols.  */
225 #define HAS_SYMS        0x10
226
227 /* BFD has local symbols (basically used for F_LSYMS in a COFF
228    header).  */
229 #define HAS_LOCALS      0x20
230
231 /* BFD is a dynamic object.  */
232 #define DYNAMIC         0x40
233
234 /* Text section is write protected (if D_PAGED is not set, this is
235    like an a.out NMAGIC file) (the linker sets this by default, but
236    clears it for -r or -N).  */
237 #define WP_TEXT         0x80
238
239 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
240    linker sets this by default, but clears it for -r or -n or -N).  */
241 #define D_PAGED         0x100
242
243 /* BFD is relaxable (this means that bfd_relax_section may be able to
244    do something) (sometimes bfd_relax_section can do something even if
245    this is not set).  */
246 #define BFD_IS_RELAXABLE 0x200
247
248 /* This may be set before writing out a BFD to request using a
249    traditional format.  For example, this is used to request that when
250    writing out an a.out object the symbols not be hashed to eliminate
251    duplicates.  */
252 #define BFD_TRADITIONAL_FORMAT 0x400
253
254 /* This flag indicates that the BFD contents are actually cached in
255    memory.  If this is set, iostream points to a bfd_in_memory struct.  */
256 #define BFD_IN_MEMORY 0x800
257 \f
258 /* symbols and relocation */
259
260 /* A count of carsyms (canonical archive symbols).  */
261 typedef unsigned long symindex;
262
263 /* How to perform a relocation.  */
264 typedef const struct reloc_howto_struct reloc_howto_type;
265
266 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
267
268 /* General purpose part of a symbol X;
269    target specific parts are in libcoff.h, libaout.h, etc.  */
270
271 #define bfd_get_section(x) ((x)->section)
272 #define bfd_get_output_section(x) ((x)->section->output_section)
273 #define bfd_set_section(x,y) ((x)->section) = (y)
274 #define bfd_asymbol_base(x) ((x)->section->vma)
275 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
276 #define bfd_asymbol_name(x) ((x)->name)
277 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
278 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
279 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
280
281 /* A canonical archive symbol.  */
282 /* This is a type pun with struct ranlib on purpose! */
283 typedef struct carsym {
284   char *name;
285   file_ptr file_offset;         /* look here to find the file */
286 } carsym;                       /* to make these you call a carsymogen */
287
288 /* Used in generating armaps (archive tables of contents).
289    Perhaps just a forward definition would do? */
290 struct orl {                    /* output ranlib */
291   char **name;                  /* symbol name */
292   file_ptr pos;                 /* bfd* or file position */
293   int namidx;                   /* index into string table */
294 };
295 \f
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
542 /* Byte swapping routines which take size and endiannes as arguments.  */
543
544 bfd_vma         bfd_get_bits       PARAMS ((bfd_byte *, int, boolean));
545 void            bfd_put_bits       PARAMS ((bfd_vma, bfd_byte *, int, boolean));
546 \f
547 /* Externally visible ECOFF routines.  */
548
549 #if defined(__STDC__) || defined(ALMOST_STDC)
550 struct ecoff_debug_info;
551 struct ecoff_debug_swap;
552 struct ecoff_extr;
553 struct symbol_cache_entry;
554 struct bfd_link_info;
555 struct bfd_link_hash_entry;
556 struct bfd_elf_version_tree;
557 #endif
558 extern bfd_vma bfd_ecoff_get_gp_value PARAMS ((bfd * abfd));
559 extern boolean bfd_ecoff_set_gp_value PARAMS ((bfd *abfd, bfd_vma gp_value));
560 extern boolean bfd_ecoff_set_regmasks
561   PARAMS ((bfd *abfd, unsigned long gprmask, unsigned long fprmask,
562            unsigned long *cprmask));
563 extern PTR bfd_ecoff_debug_init
564   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
565            const struct ecoff_debug_swap *output_swap,
566            struct bfd_link_info *));
567 extern void bfd_ecoff_debug_free
568   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
569            const struct ecoff_debug_swap *output_swap,
570            struct bfd_link_info *));
571 extern boolean bfd_ecoff_debug_accumulate
572   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
573            const struct ecoff_debug_swap *output_swap,
574            bfd *input_bfd, struct ecoff_debug_info *input_debug,
575            const struct ecoff_debug_swap *input_swap,
576            struct bfd_link_info *));
577 extern boolean bfd_ecoff_debug_accumulate_other
578   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
579            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
580            struct bfd_link_info *));
581 extern boolean bfd_ecoff_debug_externals
582   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
583            const struct ecoff_debug_swap *swap,
584            boolean relocateable,
585            boolean (*get_extr) (struct symbol_cache_entry *,
586                                 struct ecoff_extr *),
587            void (*set_index) (struct symbol_cache_entry *,
588                               bfd_size_type)));
589 extern boolean bfd_ecoff_debug_one_external
590   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
591            const struct ecoff_debug_swap *swap,
592            const char *name, struct ecoff_extr *esym));
593 extern bfd_size_type bfd_ecoff_debug_size
594   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
595            const struct ecoff_debug_swap *swap));
596 extern boolean bfd_ecoff_write_debug
597   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
598            const struct ecoff_debug_swap *swap, file_ptr where));
599 extern boolean bfd_ecoff_write_accumulated_debug
600   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
601            const struct ecoff_debug_swap *swap,
602            struct bfd_link_info *info, file_ptr where));
603 extern boolean bfd_mips_ecoff_create_embedded_relocs
604   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
605            char **));
606
607 /* Externally visible ELF routines.  */
608
609 struct bfd_link_needed_list
610 {
611   struct bfd_link_needed_list *next;
612   bfd *by;
613   const char *name;
614 };
615
616 extern boolean bfd_elf32_record_link_assignment
617   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
618 extern boolean bfd_elf64_record_link_assignment
619   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
620 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
621   PARAMS ((bfd *, struct bfd_link_info *));
622 extern boolean bfd_elf_get_bfd_needed_list
623   PARAMS ((bfd *, struct bfd_link_needed_list **));
624 extern boolean bfd_elf32_size_dynamic_sections
625   PARAMS ((bfd *, const char *, const char *, boolean, const char *,
626            const char * const *, struct bfd_link_info *, struct sec **,
627            struct bfd_elf_version_tree *));
628 extern boolean bfd_elf64_size_dynamic_sections
629   PARAMS ((bfd *, const char *, const char *, boolean, const char *,
630            const char * const *, struct bfd_link_info *, struct sec **,
631            struct bfd_elf_version_tree *));
632 extern void bfd_elf_set_dt_needed_name PARAMS ((bfd *, const char *));
633 extern void bfd_elf_set_dt_needed_soname PARAMS ((bfd *, const char *));
634 extern const char *bfd_elf_get_dt_soname PARAMS ((bfd *));
635 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
636   PARAMS ((bfd *, struct bfd_link_info *));
637
638 /* Return an upper bound on the number of bytes required to store a
639    copy of ABFD's program header table entries.  Return -1 if an error
640    occurs; bfd_get_error will return an appropriate code.  */
641 extern long bfd_get_elf_phdr_upper_bound PARAMS ((bfd *abfd));
642
643 /* Copy ABFD's program header table entries to *PHDRS.  The entries
644    will be stored as an array of Elf_Internal_Phdr structures, as
645    defined in include/elf/internal.h.  To find out how large the
646    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
647
648    Return the number of program header table entries read, or -1 if an
649    error occurs; bfd_get_error will return an appropriate code.  */
650 extern int bfd_get_elf_phdrs PARAMS ((bfd *abfd, void *phdrs));
651
652 /* Return the arch_size field of an elf bfd, or -1 if not elf.  */
653 extern int bfd_get_arch_size PARAMS ((bfd *));
654
655 /* Return true if address "naturally" sign extends, or -1 if not elf.  */
656 extern int bfd_get_sign_extend_vma PARAMS ((bfd *));
657
658 extern boolean bfd_m68k_elf32_create_embedded_relocs
659   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
660            char **));
661
662 /* SunOS shared library support routines for the linker.  */
663
664 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
665   PARAMS ((bfd *, struct bfd_link_info *));
666 extern boolean bfd_sunos_record_link_assignment
667   PARAMS ((bfd *, struct bfd_link_info *, const char *));
668 extern boolean bfd_sunos_size_dynamic_sections
669   PARAMS ((bfd *, struct bfd_link_info *, struct sec **, struct sec **,
670            struct sec **));
671
672 /* Linux shared library support routines for the linker.  */
673
674 extern boolean bfd_i386linux_size_dynamic_sections
675   PARAMS ((bfd *, struct bfd_link_info *));
676 extern boolean bfd_m68klinux_size_dynamic_sections
677   PARAMS ((bfd *, struct bfd_link_info *));
678 extern boolean bfd_sparclinux_size_dynamic_sections
679   PARAMS ((bfd *, struct bfd_link_info *));
680
681 /* mmap hacks */
682
683 struct _bfd_window_internal;
684 typedef struct _bfd_window_internal bfd_window_internal;
685
686 typedef struct _bfd_window {
687   /* What the user asked for.  */
688   PTR data;
689   bfd_size_type size;
690   /* The actual window used by BFD.  Small user-requested read-only
691      regions sharing a page may share a single window into the object
692      file.  Read-write versions shouldn't until I've fixed things to
693      keep track of which portions have been claimed by the
694      application; don't want to give the same region back when the
695      application wants two writable copies!  */
696   struct _bfd_window_internal *i;
697 } bfd_window;
698
699 extern void bfd_init_window PARAMS ((bfd_window *));
700 extern void bfd_free_window PARAMS ((bfd_window *));
701 extern boolean bfd_get_file_window
702   PARAMS ((bfd *, file_ptr, bfd_size_type, bfd_window *, boolean));
703
704 /* XCOFF support routines for the linker.  */
705
706 extern boolean bfd_xcoff_link_record_set
707   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
708            bfd_size_type));
709 extern boolean bfd_xcoff_import_symbol
710   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
711            bfd_vma, const char *, const char *, const char *));
712 extern boolean bfd_xcoff_export_symbol
713   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
714            boolean));
715 extern boolean bfd_xcoff_link_count_reloc
716   PARAMS ((bfd *, struct bfd_link_info *, const char *));
717 extern boolean bfd_xcoff_record_link_assignment
718   PARAMS ((bfd *, struct bfd_link_info *, const char *));
719 extern boolean bfd_xcoff_size_dynamic_sections
720   PARAMS ((bfd *, struct bfd_link_info *, const char *, const char *,
721            unsigned long, unsigned long, unsigned long, boolean,
722            int, boolean, boolean, struct sec **));
723
724 /* Externally visible COFF routines.  */
725
726 #if defined(__STDC__) || defined(ALMOST_STDC)
727 struct internal_syment;
728 union internal_auxent;
729 #endif
730
731 extern boolean bfd_coff_get_syment
732   PARAMS ((bfd *, struct symbol_cache_entry *, struct internal_syment *));
733
734 extern boolean bfd_coff_get_auxent
735   PARAMS ((bfd *, struct symbol_cache_entry *, int, union internal_auxent *));
736
737 extern boolean bfd_coff_set_symbol_class
738   PARAMS ((bfd *, struct symbol_cache_entry *, unsigned int));
739
740 extern boolean bfd_m68k_coff_create_embedded_relocs
741   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
742            char **));
743
744 /* ARM Interworking support.  Called from linker.  */
745 extern boolean bfd_arm_allocate_interworking_sections
746   PARAMS ((struct bfd_link_info *));
747
748 extern boolean bfd_arm_process_before_allocation
749   PARAMS ((bfd *, struct bfd_link_info *, int));
750
751 extern boolean bfd_arm_get_bfd_for_interworking
752   PARAMS ((bfd *, struct bfd_link_info *));
753
754 /* PE ARM Interworking support.  Called from linker.  */
755 extern boolean bfd_arm_pe_allocate_interworking_sections
756   PARAMS ((struct bfd_link_info *));
757
758 extern boolean bfd_arm_pe_process_before_allocation
759   PARAMS ((bfd *, struct bfd_link_info *, int));
760
761 extern boolean bfd_arm_pe_get_bfd_for_interworking
762   PARAMS ((bfd *, struct bfd_link_info *));
763
764 /* ELF ARM Interworking support.  Called from linker.  */
765 extern boolean bfd_elf32_arm_allocate_interworking_sections
766   PARAMS ((struct bfd_link_info *));
767
768 extern boolean bfd_elf32_arm_process_before_allocation
769   PARAMS ((bfd *, struct bfd_link_info *, int));
770
771 extern boolean bfd_elf32_arm_get_bfd_for_interworking
772   PARAMS ((bfd *, struct bfd_link_info *));
773
774 /* TI COFF load page support.  */
775 extern void bfd_ticoff_set_section_load_page
776   PARAMS ((struct sec *, int));
777
778 extern int bfd_ticoff_get_section_load_page
779   PARAMS ((struct sec *));
780
781 /* And more from the source.  */
782 void
783 bfd_init PARAMS ((void));
784
785 bfd *
786 bfd_openr PARAMS ((CONST char *filename, CONST char *target));
787
788 bfd *
789 bfd_fdopenr PARAMS ((CONST char *filename, CONST char *target, int fd));
790
791 bfd *
792 bfd_openstreamr PARAMS ((const char *, const char *, PTR));
793
794 bfd *
795 bfd_openw PARAMS ((CONST char *filename, CONST char *target));
796
797 boolean
798 bfd_close PARAMS ((bfd *abfd));
799
800 boolean
801 bfd_close_all_done PARAMS ((bfd *));
802
803 bfd *
804 bfd_create PARAMS ((CONST char *filename, bfd *templ));
805
806 boolean
807 bfd_make_writable PARAMS ((bfd *abfd));
808
809 boolean
810 bfd_make_readable PARAMS ((bfd *abfd));
811
812
813 /* Byte swapping macros for user section data.  */
814
815 #define bfd_put_8(abfd, val, ptr) \
816                 ((void) (*((unsigned char *) (ptr)) = (unsigned char) (val)))
817 #define bfd_put_signed_8 \
818                bfd_put_8
819 #define bfd_get_8(abfd, ptr) \
820                 (*(unsigned char *) (ptr))
821 #define bfd_get_signed_8(abfd, ptr) \
822                ((*(unsigned char *) (ptr) ^ 0x80) - 0x80)
823
824 #define bfd_put_16(abfd, val, ptr) \
825                 BFD_SEND(abfd, bfd_putx16, ((val),(ptr)))
826 #define bfd_put_signed_16 \
827                 bfd_put_16
828 #define bfd_get_16(abfd, ptr) \
829                 BFD_SEND(abfd, bfd_getx16, (ptr))
830 #define bfd_get_signed_16(abfd, ptr) \
831                 BFD_SEND (abfd, bfd_getx_signed_16, (ptr))
832
833 #define bfd_put_32(abfd, val, ptr) \
834                 BFD_SEND(abfd, bfd_putx32, ((val),(ptr)))
835 #define bfd_put_signed_32 \
836                 bfd_put_32
837 #define bfd_get_32(abfd, ptr) \
838                 BFD_SEND(abfd, bfd_getx32, (ptr))
839 #define bfd_get_signed_32(abfd, ptr) \
840                 BFD_SEND(abfd, bfd_getx_signed_32, (ptr))
841
842 #define bfd_put_64(abfd, val, ptr) \
843                 BFD_SEND(abfd, bfd_putx64, ((val), (ptr)))
844 #define bfd_put_signed_64 \
845                 bfd_put_64
846 #define bfd_get_64(abfd, ptr) \
847                 BFD_SEND(abfd, bfd_getx64, (ptr))
848 #define bfd_get_signed_64(abfd, ptr) \
849                 BFD_SEND(abfd, bfd_getx_signed_64, (ptr))
850
851 #define bfd_get(bits, abfd, ptr)                               \
852                 ((bits) == 8 ? bfd_get_8 (abfd, ptr)           \
853                 : (bits) == 16 ? bfd_get_16 (abfd, ptr)        \
854                 : (bits) == 32 ? bfd_get_32 (abfd, ptr)        \
855                 : (bits) == 64 ? bfd_get_64 (abfd, ptr)        \
856                 : (abort (), (bfd_vma) - 1))
857
858 #define bfd_put(bits, abfd, val, ptr)                          \
859                 ((bits) == 8 ? bfd_put_8 (abfd, val, ptr)      \
860                 : (bits) == 16 ? bfd_put_16 (abfd, val, ptr)   \
861                 : (bits) == 32 ? bfd_put_32 (abfd, val, ptr)   \
862                 : (bits) == 64 ? bfd_put_64 (abfd, val, ptr)   \
863                 : (abort (), (void) 0))
864
865
866 /* Byte swapping macros for file header data.  */
867
868 #define bfd_h_put_8(abfd, val, ptr) \
869                bfd_put_8 (abfd, val, ptr)
870 #define bfd_h_put_signed_8(abfd, val, ptr) \
871                bfd_put_8 (abfd, val, ptr)
872 #define bfd_h_get_8(abfd, ptr) \
873                bfd_get_8 (abfd, ptr)
874 #define bfd_h_get_signed_8(abfd, ptr) \
875                bfd_get_signed_8 (abfd, ptr)
876
877 #define bfd_h_put_16(abfd, val, ptr) \
878                 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
879 #define bfd_h_put_signed_16 \
880                 bfd_h_put_16
881 #define bfd_h_get_16(abfd, ptr) \
882                 BFD_SEND(abfd, bfd_h_getx16,(ptr))
883 #define bfd_h_get_signed_16(abfd, ptr) \
884                 BFD_SEND(abfd, bfd_h_getx_signed_16, (ptr))
885
886 #define bfd_h_put_32(abfd, val, ptr) \
887                 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
888 #define bfd_h_put_signed_32 \
889                 bfd_h_put_32
890 #define bfd_h_get_32(abfd, ptr) \
891                 BFD_SEND(abfd, bfd_h_getx32,(ptr))
892 #define bfd_h_get_signed_32(abfd, ptr) \
893                 BFD_SEND(abfd, bfd_h_getx_signed_32, (ptr))
894
895 #define bfd_h_put_64(abfd, val, ptr) \
896                 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
897 #define bfd_h_put_signed_64 \
898                 bfd_h_put_64
899 #define bfd_h_get_64(abfd, ptr) \
900                 BFD_SEND(abfd, bfd_h_getx64,(ptr))
901 #define bfd_h_get_signed_64(abfd, ptr) \
902                 BFD_SEND(abfd, bfd_h_getx_signed_64, (ptr))
903
904 /* This structure is used for a comdat section, as in PE.  A comdat
905    section is associated with a particular symbol.  When the linker
906    sees a comdat section, it keeps only one of the sections with a
907    given name and associated with a given symbol.  */
908
909 struct bfd_comdat_info
910 {
911   /* The name of the symbol associated with a comdat section.  */
912   const char *name;
913
914   /* The local symbol table index of the symbol associated with a
915      comdat section.  This is only meaningful to the object file format
916      specific code; it is not an index into the list returned by
917      bfd_canonicalize_symtab.  */
918   long symbol;
919 };
920
921 typedef struct sec
922 {
923   /* The name of the section; the name isn't a copy, the pointer is
924      the same as that passed to bfd_make_section.  */
925
926   const char *name;
927
928   /* A unique sequence number.  */
929
930   int id;
931
932   /* Which section is it; 0..nth.  */
933
934   int index;
935
936   /* The next section in the list belonging to the BFD, or NULL.  */
937
938   struct sec *next;
939
940   /* The field flags contains attributes of the section. Some
941      flags are read in from the object file, and some are
942      synthesized from other information.  */
943
944   flagword flags;
945
946 #define SEC_NO_FLAGS   0x000
947
948   /* Tells the OS to allocate space for this section when loading.
949      This is clear for a section containing debug information only.  */
950 #define SEC_ALLOC      0x001
951
952   /* Tells the OS to load the section from the file when loading.
953      This is clear for a .bss section.  */
954 #define SEC_LOAD       0x002
955
956   /* The section contains data still to be relocated, so there is
957      some relocation information too.  */
958 #define SEC_RELOC      0x004
959
960 #if 0   /* Obsolete ? */
961 #define SEC_BALIGN     0x008
962 #endif
963
964   /* A signal to the OS that the section contains read only data.  */
965 #define SEC_READONLY   0x010
966
967   /* The section contains code only.  */
968 #define SEC_CODE       0x020
969
970   /* The section contains data only.  */
971 #define SEC_DATA       0x040
972
973   /* The section will reside in ROM.  */
974 #define SEC_ROM        0x080
975
976   /* The section contains constructor information. This section
977      type is used by the linker to create lists of constructors and
978      destructors used by <<g++>>. When a back end sees a symbol
979      which should be used in a constructor list, it creates a new
980      section for the type of name (e.g., <<__CTOR_LIST__>>), attaches
981      the symbol to it, and builds a relocation. To build the lists
982      of constructors, all the linker has to do is catenate all the
983      sections called <<__CTOR_LIST__>> and relocate the data
984      contained within - exactly the operations it would peform on
985      standard data.  */
986 #define SEC_CONSTRUCTOR 0x100
987
988   /* The section is a constructor, and should be placed at the
989      end of the text, data, or bss section(?).  */
990 #define SEC_CONSTRUCTOR_TEXT 0x1100
991 #define SEC_CONSTRUCTOR_DATA 0x2100
992 #define SEC_CONSTRUCTOR_BSS  0x3100
993
994   /* The section has contents - a data section could be
995      <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>; a debug section could be
996      <<SEC_HAS_CONTENTS>>  */
997 #define SEC_HAS_CONTENTS 0x200
998
999   /* An instruction to the linker to not output the section
1000      even if it has information which would normally be written.  */
1001 #define SEC_NEVER_LOAD 0x400
1002
1003   /* The section is a COFF shared library section.  This flag is
1004      only for the linker.  If this type of section appears in
1005      the input file, the linker must copy it to the output file
1006      without changing the vma or size.  FIXME: Although this
1007      was originally intended to be general, it really is COFF
1008      specific (and the flag was renamed to indicate this).  It
1009      might be cleaner to have some more general mechanism to
1010      allow the back end to control what the linker does with
1011      sections.  */
1012 #define SEC_COFF_SHARED_LIBRARY 0x800
1013
1014   /* The section has GOT references.  This flag is only for the
1015      linker, and is currently only used by the elf32-hppa back end.
1016      It will be set if global offset table references were detected
1017      in this section, which indicate to the linker that the section
1018      contains PIC code, and must be handled specially when doing a
1019      static link.  */
1020 #define SEC_HAS_GOT_REF 0x4000
1021
1022   /* The section contains common symbols (symbols may be defined
1023      multiple times, the value of a symbol is the amount of
1024      space it requires, and the largest symbol value is the one
1025      used).  Most targets have exactly one of these (which we
1026      translate to bfd_com_section_ptr), but ECOFF has two.  */
1027 #define SEC_IS_COMMON 0x8000
1028
1029   /* The section contains only debugging information.  For
1030      example, this is set for ELF .debug and .stab sections.
1031      strip tests this flag to see if a section can be
1032      discarded.  */
1033 #define SEC_DEBUGGING 0x10000
1034
1035   /* The contents of this section are held in memory pointed to
1036      by the contents field.  This is checked by bfd_get_section_contents,
1037      and the data is retrieved from memory if appropriate.  */
1038 #define SEC_IN_MEMORY 0x20000
1039
1040   /* The contents of this section are to be excluded by the
1041      linker for executable and shared objects unless those
1042      objects are to be further relocated.  */
1043 #define SEC_EXCLUDE 0x40000
1044
1045   /* The contents of this section are to be sorted by the
1046      based on the address specified in the associated symbol
1047      table.  */
1048 #define SEC_SORT_ENTRIES 0x80000
1049
1050   /* When linking, duplicate sections of the same name should be
1051      discarded, rather than being combined into a single section as
1052      is usually done.  This is similar to how common symbols are
1053      handled.  See SEC_LINK_DUPLICATES below.  */
1054 #define SEC_LINK_ONCE 0x100000
1055
1056   /* If SEC_LINK_ONCE is set, this bitfield describes how the linker
1057      should handle duplicate sections.  */
1058 #define SEC_LINK_DUPLICATES 0x600000
1059
1060   /* This value for SEC_LINK_DUPLICATES means that duplicate
1061      sections with the same name should simply be discarded.  */
1062 #define SEC_LINK_DUPLICATES_DISCARD 0x0
1063
1064   /* This value for SEC_LINK_DUPLICATES means that the linker
1065      should warn if there are any duplicate sections, although
1066      it should still only link one copy.  */
1067 #define SEC_LINK_DUPLICATES_ONE_ONLY 0x200000
1068
1069   /* This value for SEC_LINK_DUPLICATES means that the linker
1070      should warn if any duplicate sections are a different size.  */
1071 #define SEC_LINK_DUPLICATES_SAME_SIZE 0x400000
1072
1073   /* This value for SEC_LINK_DUPLICATES means that the linker
1074      should warn if any duplicate sections contain different
1075      contents.  */
1076 #define SEC_LINK_DUPLICATES_SAME_CONTENTS 0x600000
1077
1078   /* This section was created by the linker as part of dynamic
1079      relocation or other arcane processing.  It is skipped when
1080      going through the first-pass output, trusting that someone
1081      else up the line will take care of it later.  */
1082 #define SEC_LINKER_CREATED 0x800000
1083
1084   /* This section should not be subject to garbage collection.  */
1085 #define SEC_KEEP 0x1000000
1086
1087   /* This section contains "short" data, and should be placed
1088      "near" the GP.  */
1089 #define SEC_SMALL_DATA 0x2000000
1090
1091   /* This section contains data which may be shared with other
1092      executables or shared objects.  */
1093 #define SEC_SHARED 0x4000000
1094
1095   /* When a section with this flag is being linked, then if the size of
1096      the input section is less than a page, it should not cross a page
1097      boundary.  If the size of the input section is one page or more, it
1098      should be aligned on a page boundary.  */
1099 #define SEC_BLOCK 0x8000000
1100
1101   /* Conditionally link this section; do not link if there are no
1102      references found to any symbol in the section.  */
1103 #define SEC_CLINK 0x10000000
1104
1105   /* Attempt to merge identical entities in the section.
1106      Entity size is given in the entsize field.  */
1107 #define SEC_MERGE 0x20000000
1108
1109   /* If given with SEC_MERGE, entities to merge are zero terminated
1110      strings where entsize specifies character size instead of fixed
1111      size entries.  */
1112 #define SEC_STRINGS 0x40000000
1113
1114   /*  End of section flags.  */
1115
1116   /* Some internal packed boolean fields.  */
1117
1118   /* See the vma field.  */
1119   unsigned int user_set_vma : 1;
1120
1121   /* Whether relocations have been processed.  */
1122   unsigned int reloc_done : 1;
1123
1124   /* A mark flag used by some of the linker backends.  */
1125   unsigned int linker_mark : 1;
1126
1127   /* A mark flag used by some linker backends for garbage collection.  */
1128   unsigned int gc_mark : 1;
1129
1130   /* Used by the ELF code to mark sections which have been allocated to segments.  */
1131   unsigned int segment_mark : 1;
1132
1133   /* End of internal packed boolean fields.  */
1134
1135   /*  The virtual memory address of the section - where it will be
1136       at run time.  The symbols are relocated against this.  The
1137       user_set_vma flag is maintained by bfd; if it's not set, the
1138       backend can assign addresses (for example, in <<a.out>>, where
1139       the default address for <<.data>> is dependent on the specific
1140       target and various flags).  */
1141
1142   bfd_vma vma;
1143
1144   /*  The load address of the section - where it would be in a
1145       rom image; really only used for writing section header
1146       information. */
1147
1148   bfd_vma lma;
1149
1150   /* The size of the section in octets, as it will be output.
1151      Contains a value even if the section has no contents (e.g., the
1152      size of <<.bss>>).  This will be filled in after relocation.  */
1153
1154   bfd_size_type _cooked_size;
1155
1156   /* The original size on disk of the section, in octets.  Normally this
1157      value is the same as the size, but if some relaxing has
1158      been done, then this value will be bigger.  */
1159
1160   bfd_size_type _raw_size;
1161
1162   /* If this section is going to be output, then this value is the
1163      offset in *bytes* into the output section of the first byte in the
1164      input section (byte ==> smallest addressable unit on the
1165      target).  In most cases, if this was going to start at the
1166      100th octet (8-bit quantity) in the output section, this value
1167      would be 100.  However, if the target byte size is 16 bits
1168      (bfd_octets_per_byte is "2"), this value would be 50.  */
1169
1170   bfd_vma output_offset;
1171
1172   /* The output section through which to map on output.  */
1173
1174   struct sec *output_section;
1175
1176   /* The alignment requirement of the section, as an exponent of 2 -
1177      e.g., 3 aligns to 2^3 (or 8).  */
1178
1179   unsigned int alignment_power;
1180
1181   /* If an input section, a pointer to a vector of relocation
1182      records for the data in this section.  */
1183
1184   struct reloc_cache_entry *relocation;
1185
1186   /* If an output section, a pointer to a vector of pointers to
1187      relocation records for the data in this section.  */
1188
1189   struct reloc_cache_entry **orelocation;
1190
1191   /* The number of relocation records in one of the above  */
1192
1193   unsigned reloc_count;
1194
1195   /* Information below is back end specific - and not always used
1196      or updated.  */
1197
1198   /* File position of section data.  */
1199
1200   file_ptr filepos;
1201
1202   /* File position of relocation info.  */
1203
1204   file_ptr rel_filepos;
1205
1206   /* File position of line data.  */
1207
1208   file_ptr line_filepos;
1209
1210   /* Pointer to data for applications.  */
1211
1212   PTR userdata;
1213
1214   /* If the SEC_IN_MEMORY flag is set, this points to the actual
1215      contents.  */
1216   unsigned char *contents;
1217
1218   /* Attached line number information.  */
1219
1220   alent *lineno;
1221
1222   /* Number of line number records.  */
1223
1224   unsigned int lineno_count;
1225
1226   /* Entity size for merging purposes.  */
1227
1228   unsigned int entsize;
1229
1230   /* Optional information about a COMDAT entry; NULL if not COMDAT.  */
1231
1232   struct bfd_comdat_info *comdat;
1233
1234   /* Points to the kept section if this section is a link-once section,
1235      and is discarded.  */
1236   struct sec *kept_section;
1237
1238   /* When a section is being output, this value changes as more
1239      linenumbers are written out.  */
1240
1241   file_ptr moving_line_filepos;
1242
1243   /* What the section number is in the target world.  */
1244
1245   int target_index;
1246
1247   PTR used_by_bfd;
1248
1249   /* If this is a constructor section then here is a list of the
1250      relocations created to relocate items within it.  */
1251
1252   struct relent_chain *constructor_chain;
1253
1254   /* The BFD which owns the section.  */
1255
1256   bfd *owner;
1257
1258   /* A symbol which points at this section only */
1259   struct symbol_cache_entry *symbol;
1260   struct symbol_cache_entry **symbol_ptr_ptr;
1261
1262   struct bfd_link_order *link_order_head;
1263   struct bfd_link_order *link_order_tail;
1264 } asection ;
1265
1266 /* These sections are global, and are managed by BFD.  The application
1267    and target back end are not permitted to change the values in
1268    these sections.  New code should use the section_ptr macros rather
1269    than referring directly to the const sections.  The const sections
1270    may eventually vanish.  */
1271 #define BFD_ABS_SECTION_NAME "*ABS*"
1272 #define BFD_UND_SECTION_NAME "*UND*"
1273 #define BFD_COM_SECTION_NAME "*COM*"
1274 #define BFD_IND_SECTION_NAME "*IND*"
1275
1276 /* the absolute section */
1277 extern const asection bfd_abs_section;
1278 #define bfd_abs_section_ptr ((asection *) &bfd_abs_section)
1279 #define bfd_is_abs_section(sec) ((sec) == bfd_abs_section_ptr)
1280 /* Pointer to the undefined section */
1281 extern const asection bfd_und_section;
1282 #define bfd_und_section_ptr ((asection *) &bfd_und_section)
1283 #define bfd_is_und_section(sec) ((sec) == bfd_und_section_ptr)
1284 /* Pointer to the common section */
1285 extern const asection bfd_com_section;
1286 #define bfd_com_section_ptr ((asection *) &bfd_com_section)
1287 /* Pointer to the indirect section */
1288 extern const asection bfd_ind_section;
1289 #define bfd_ind_section_ptr ((asection *) &bfd_ind_section)
1290 #define bfd_is_ind_section(sec) ((sec) == bfd_ind_section_ptr)
1291
1292 extern const struct symbol_cache_entry * const bfd_abs_symbol;
1293 extern const struct symbol_cache_entry * const bfd_com_symbol;
1294 extern const struct symbol_cache_entry * const bfd_und_symbol;
1295 extern const struct symbol_cache_entry * const bfd_ind_symbol;
1296 #define bfd_get_section_size_before_reloc(section) \
1297      ((section)->reloc_done ? (abort (), (bfd_size_type) 1) \
1298                             : (section)->_raw_size)
1299 #define bfd_get_section_size_after_reloc(section) \
1300      ((section)->reloc_done ? (section)->_cooked_size \
1301                             : (abort (), (bfd_size_type) 1))
1302 asection *
1303 bfd_get_section_by_name PARAMS ((bfd *abfd, const char *name));
1304
1305 char *
1306 bfd_get_unique_section_name PARAMS ((bfd *abfd,
1307     const char *templat,
1308     int *count));
1309
1310 asection *
1311 bfd_make_section_old_way PARAMS ((bfd *abfd, const char *name));
1312
1313 asection *
1314 bfd_make_section_anyway PARAMS ((bfd *abfd, const char *name));
1315
1316 asection *
1317 bfd_make_section PARAMS ((bfd *, const char *name));
1318
1319 boolean
1320 bfd_set_section_flags PARAMS ((bfd *abfd, asection *sec, flagword flags));
1321
1322 void
1323 bfd_map_over_sections PARAMS ((bfd *abfd,
1324     void (*func) (bfd *abfd,
1325     asection *sect,
1326     PTR obj),
1327     PTR obj));
1328
1329 boolean
1330 bfd_set_section_size PARAMS ((bfd *abfd, asection *sec, bfd_size_type val));
1331
1332 boolean
1333 bfd_set_section_contents PARAMS ((bfd *abfd,
1334     asection *section,
1335     PTR data,
1336     file_ptr offset,
1337     bfd_size_type count));
1338
1339 boolean
1340 bfd_get_section_contents PARAMS ((bfd *abfd, asection *section, PTR location,
1341     file_ptr offset, bfd_size_type count));
1342
1343 boolean
1344 bfd_copy_private_section_data PARAMS ((bfd *ibfd, asection *isec, bfd *obfd, asection *osec));
1345
1346 #define bfd_copy_private_section_data(ibfd, isection, obfd, osection) \
1347      BFD_SEND (obfd, _bfd_copy_private_section_data, \
1348                (ibfd, isection, obfd, osection))
1349 void
1350 _bfd_strip_section_from_output PARAMS ((struct bfd_link_info *info, asection *section));
1351
1352 enum bfd_architecture
1353 {
1354   bfd_arch_unknown,   /* File arch not known */
1355   bfd_arch_obscure,   /* Arch known, not one of these */
1356   bfd_arch_m68k,      /* Motorola 68xxx */
1357 #define bfd_mach_m68000 1
1358 #define bfd_mach_m68008 2
1359 #define bfd_mach_m68010 3
1360 #define bfd_mach_m68020 4
1361 #define bfd_mach_m68030 5
1362 #define bfd_mach_m68040 6
1363 #define bfd_mach_m68060 7
1364 #define bfd_mach_cpu32  8
1365 #define bfd_mach_mcf5200  9
1366 #define bfd_mach_mcf5206e 10
1367 #define bfd_mach_mcf5307  11
1368 #define bfd_mach_mcf5407  12
1369   bfd_arch_vax,       /* DEC Vax */
1370   bfd_arch_i960,      /* Intel 960 */
1371     /* The order of the following is important.
1372        lower number indicates a machine type that
1373        only accepts a subset of the instructions
1374        available to machines with higher numbers.
1375        The exception is the "ca", which is
1376        incompatible with all other machines except
1377        "core". */
1378
1379 #define bfd_mach_i960_core      1
1380 #define bfd_mach_i960_ka_sa     2
1381 #define bfd_mach_i960_kb_sb     3
1382 #define bfd_mach_i960_mc        4
1383 #define bfd_mach_i960_xa        5
1384 #define bfd_mach_i960_ca        6
1385 #define bfd_mach_i960_jx        7
1386 #define bfd_mach_i960_hx        8
1387
1388   bfd_arch_a29k,      /* AMD 29000 */
1389   bfd_arch_sparc,     /* SPARC */
1390 #define bfd_mach_sparc                 1
1391 /* The difference between v8plus and v9 is that v9 is a true 64 bit env.  */
1392 #define bfd_mach_sparc_sparclet        2
1393 #define bfd_mach_sparc_sparclite       3
1394 #define bfd_mach_sparc_v8plus          4
1395 #define bfd_mach_sparc_v8plusa         5 /* with ultrasparc add'ns */
1396 #define bfd_mach_sparc_sparclite_le    6
1397 #define bfd_mach_sparc_v9              7
1398 #define bfd_mach_sparc_v9a             8 /* with ultrasparc add'ns */
1399 #define bfd_mach_sparc_v8plusb         9 /* with cheetah add'ns */
1400 #define bfd_mach_sparc_v9b             10 /* with cheetah add'ns */
1401 /* Nonzero if MACH has the v9 instruction set.  */
1402 #define bfd_mach_sparc_v9_p(mach) \
1403   ((mach) >= bfd_mach_sparc_v8plus && (mach) <= bfd_mach_sparc_v9b \
1404    && (mach) != bfd_mach_sparc_sparclite_le)
1405   bfd_arch_mips,      /* MIPS Rxxxx */
1406 #define bfd_mach_mips3000              3000
1407 #define bfd_mach_mips3900              3900
1408 #define bfd_mach_mips4000              4000
1409 #define bfd_mach_mips4010              4010
1410 #define bfd_mach_mips4100              4100
1411 #define bfd_mach_mips4111              4111
1412 #define bfd_mach_mips4300              4300
1413 #define bfd_mach_mips4400              4400
1414 #define bfd_mach_mips4600              4600
1415 #define bfd_mach_mips4650              4650
1416 #define bfd_mach_mips5000              5000
1417 #define bfd_mach_mips6000              6000
1418 #define bfd_mach_mips8000              8000
1419 #define bfd_mach_mips10000             10000
1420 #define bfd_mach_mips16                16
1421 #define bfd_mach_mips32                32
1422 #define bfd_mach_mips32_4k             3204113 /* 32, 04, octal 'K' */
1423 #define bfd_mach_mips5                 5
1424 #define bfd_mach_mips64                64
1425 #define bfd_mach_mips_sb1              12310201 /* octal 'SB', 01 */
1426   bfd_arch_i386,      /* Intel 386 */
1427 #define bfd_mach_i386_i386 0
1428 #define bfd_mach_i386_i8086 1
1429 #define bfd_mach_i386_i386_intel_syntax 2
1430 #define bfd_mach_x86_64 3
1431 #define bfd_mach_x86_64_intel_syntax 4
1432   bfd_arch_we32k,     /* AT&T WE32xxx */
1433   bfd_arch_tahoe,     /* CCI/Harris Tahoe */
1434   bfd_arch_i860,      /* Intel 860 */
1435   bfd_arch_i370,      /* IBM 360/370 Mainframes */
1436   bfd_arch_romp,      /* IBM ROMP PC/RT */
1437   bfd_arch_alliant,   /* Alliant */
1438   bfd_arch_convex,    /* Convex */
1439   bfd_arch_m88k,      /* Motorola 88xxx */
1440   bfd_arch_pyramid,   /* Pyramid Technology */
1441   bfd_arch_h8300,     /* Hitachi H8/300 */
1442 #define bfd_mach_h8300   1
1443 #define bfd_mach_h8300h  2
1444 #define bfd_mach_h8300s  3
1445   bfd_arch_pdp11,     /* DEC PDP-11 */
1446   bfd_arch_powerpc,   /* PowerPC */
1447 #define bfd_mach_ppc           0
1448 #define bfd_mach_ppc_403       403
1449 #define bfd_mach_ppc_403gc     4030
1450 #define bfd_mach_ppc_505       505
1451 #define bfd_mach_ppc_601       601
1452 #define bfd_mach_ppc_602       602
1453 #define bfd_mach_ppc_603       603
1454 #define bfd_mach_ppc_ec603e    6031
1455 #define bfd_mach_ppc_604       604
1456 #define bfd_mach_ppc_620       620
1457 #define bfd_mach_ppc_630       630
1458 #define bfd_mach_ppc_750       750
1459 #define bfd_mach_ppc_860       860
1460 #define bfd_mach_ppc_a35       35
1461 #define bfd_mach_ppc_rs64ii    642
1462 #define bfd_mach_ppc_rs64iii   643
1463 #define bfd_mach_ppc_7400      7400
1464   bfd_arch_rs6000,    /* IBM RS/6000 */
1465 #define bfd_mach_rs6k          0
1466 #define bfd_mach_rs6k_rs1      6001
1467 #define bfd_mach_rs6k_rsc      6003
1468 #define bfd_mach_rs6k_rs2      6002
1469   bfd_arch_hppa,      /* HP PA RISC */
1470   bfd_arch_d10v,      /* Mitsubishi D10V */
1471 #define bfd_mach_d10v          0
1472 #define bfd_mach_d10v_ts2      2
1473 #define bfd_mach_d10v_ts3      3
1474   bfd_arch_d30v,      /* Mitsubishi D30V */
1475   bfd_arch_m68hc11,   /* Motorola 68HC11 */
1476   bfd_arch_m68hc12,   /* Motorola 68HC12 */
1477   bfd_arch_z8k,       /* Zilog Z8000 */
1478 #define bfd_mach_z8001         1
1479 #define bfd_mach_z8002         2
1480   bfd_arch_h8500,     /* Hitachi H8/500 */
1481   bfd_arch_sh,        /* Hitachi SH */
1482 #define bfd_mach_sh            0
1483 #define bfd_mach_sh2        0x20
1484 #define bfd_mach_sh_dsp     0x2d
1485 #define bfd_mach_sh3        0x30
1486 #define bfd_mach_sh3_dsp    0x3d
1487 #define bfd_mach_sh3e       0x3e
1488 #define bfd_mach_sh4        0x40
1489   bfd_arch_alpha,     /* Dec Alpha */
1490 #define bfd_mach_alpha_ev4  0x10
1491 #define bfd_mach_alpha_ev5  0x20
1492 #define bfd_mach_alpha_ev6  0x30
1493   bfd_arch_arm,       /* Advanced Risc Machines ARM */
1494 #define bfd_mach_arm_2         1
1495 #define bfd_mach_arm_2a        2
1496 #define bfd_mach_arm_3         3
1497 #define bfd_mach_arm_3M        4
1498 #define bfd_mach_arm_4         5
1499 #define bfd_mach_arm_4T        6
1500 #define bfd_mach_arm_5         7
1501 #define bfd_mach_arm_5T        8
1502 #define bfd_mach_arm_5TE       9
1503 #define bfd_mach_arm_XScale    10
1504   bfd_arch_ns32k,     /* National Semiconductors ns32000 */
1505   bfd_arch_w65,       /* WDC 65816 */
1506   bfd_arch_tic30,     /* Texas Instruments TMS320C30 */
1507   bfd_arch_tic54x,    /* Texas Instruments TMS320C54X */
1508   bfd_arch_tic80,     /* TI TMS320c80 (MVP) */
1509   bfd_arch_v850,      /* NEC V850 */
1510 #define bfd_mach_v850          0
1511 #define bfd_mach_v850e         'E'
1512 #define bfd_mach_v850ea        'A'
1513   bfd_arch_arc,       /* ARC Cores */
1514 #define bfd_mach_arc_5         0
1515 #define bfd_mach_arc_6         1
1516 #define bfd_mach_arc_7         2
1517 #define bfd_mach_arc_8         3
1518   bfd_arch_m32r,      /* Mitsubishi M32R/D */
1519 #define bfd_mach_m32r          0 /* backwards compatibility */
1520 #define bfd_mach_m32rx         'x'
1521   bfd_arch_mn10200,   /* Matsushita MN10200 */
1522   bfd_arch_mn10300,   /* Matsushita MN10300 */
1523 #define bfd_mach_mn10300               300
1524 #define bfd_mach_am33          330
1525   bfd_arch_fr30,
1526 #define bfd_mach_fr30          0x46523330
1527   bfd_arch_mcore,
1528   bfd_arch_ia64,      /* HP/Intel ia64 */
1529 #define bfd_mach_ia64_elf64    0
1530 #define bfd_mach_ia64_elf32    1
1531   bfd_arch_pj,
1532   bfd_arch_avr,       /* Atmel AVR microcontrollers */
1533 #define bfd_mach_avr1          1
1534 #define bfd_mach_avr2          2
1535 #define bfd_mach_avr3          3
1536 #define bfd_mach_avr4          4
1537 #define bfd_mach_avr5          5
1538   bfd_arch_cris,      /* Axis CRIS */
1539   bfd_arch_s390,      /* IBM s390 */
1540 #define bfd_mach_s390_esa      0
1541 #define bfd_mach_s390_esame    1
1542   bfd_arch_openrisc,  /* OpenRISC */
1543   bfd_arch_last
1544   };
1545
1546 typedef struct bfd_arch_info
1547 {
1548   int bits_per_word;
1549   int bits_per_address;
1550   int bits_per_byte;
1551   enum bfd_architecture arch;
1552   unsigned long mach;
1553   const char *arch_name;
1554   const char *printable_name;
1555   unsigned int section_align_power;
1556   /* True if this is the default machine for the architecture.  */
1557   boolean the_default;
1558   const struct bfd_arch_info * (*compatible)
1559        PARAMS ((const struct bfd_arch_info *a,
1560                 const struct bfd_arch_info *b));
1561
1562   boolean (*scan) PARAMS ((const struct bfd_arch_info *, const char *));
1563
1564   const struct bfd_arch_info *next;
1565 } bfd_arch_info_type;
1566 const char *
1567 bfd_printable_name PARAMS ((bfd *abfd));
1568
1569 const bfd_arch_info_type *
1570 bfd_scan_arch PARAMS ((const char *string));
1571
1572 const char **
1573 bfd_arch_list PARAMS ((void));
1574
1575 const bfd_arch_info_type *
1576 bfd_arch_get_compatible PARAMS ((
1577     const bfd *abfd,
1578     const bfd *bbfd));
1579
1580 void
1581 bfd_set_arch_info PARAMS ((bfd *abfd, const bfd_arch_info_type *arg));
1582
1583 enum bfd_architecture
1584 bfd_get_arch PARAMS ((bfd *abfd));
1585
1586 unsigned long
1587 bfd_get_mach PARAMS ((bfd *abfd));
1588
1589 unsigned int
1590 bfd_arch_bits_per_byte PARAMS ((bfd *abfd));
1591
1592 unsigned int
1593 bfd_arch_bits_per_address PARAMS ((bfd *abfd));
1594
1595 const bfd_arch_info_type *
1596 bfd_get_arch_info PARAMS ((bfd *abfd));
1597
1598 const bfd_arch_info_type *
1599 bfd_lookup_arch PARAMS ((enum bfd_architecture
1600     arch,
1601     unsigned long machine));
1602
1603 const char *
1604 bfd_printable_arch_mach PARAMS ((enum bfd_architecture arch, unsigned long machine));
1605
1606 unsigned int
1607 bfd_octets_per_byte PARAMS ((bfd *abfd));
1608
1609 unsigned int
1610 bfd_arch_mach_octets_per_byte PARAMS ((enum bfd_architecture arch,
1611     unsigned long machine));
1612
1613 typedef enum bfd_reloc_status
1614 {
1615        /* No errors detected */
1616   bfd_reloc_ok,
1617
1618        /* The relocation was performed, but there was an overflow. */
1619   bfd_reloc_overflow,
1620
1621        /* The address to relocate was not within the section supplied. */
1622   bfd_reloc_outofrange,
1623
1624        /* Used by special functions */
1625   bfd_reloc_continue,
1626
1627        /* Unsupported relocation size requested. */
1628   bfd_reloc_notsupported,
1629
1630        /* Unused */
1631   bfd_reloc_other,
1632
1633        /* The symbol to relocate against was undefined. */
1634   bfd_reloc_undefined,
1635
1636        /* The relocation was performed, but may not be ok - presently
1637           generated only when linking i960 coff files with i960 b.out
1638           symbols.  If this type is returned, the error_message argument
1639           to bfd_perform_relocation will be set.  */
1640   bfd_reloc_dangerous
1641  }
1642  bfd_reloc_status_type;
1643
1644
1645 typedef struct reloc_cache_entry
1646 {
1647        /* A pointer into the canonical table of pointers  */
1648   struct symbol_cache_entry **sym_ptr_ptr;
1649
1650        /* offset in section */
1651   bfd_size_type address;
1652
1653        /* addend for relocation value */
1654   bfd_vma addend;
1655
1656        /* Pointer to how to perform the required relocation */
1657   reloc_howto_type *howto;
1658
1659 } arelent;
1660 enum complain_overflow
1661 {
1662        /* Do not complain on overflow. */
1663   complain_overflow_dont,
1664
1665        /* Complain if the bitfield overflows, whether it is considered
1666           as signed or unsigned. */
1667   complain_overflow_bitfield,
1668
1669        /* Complain if the value overflows when considered as signed
1670           number. */
1671   complain_overflow_signed,
1672
1673        /* Complain if the value overflows when considered as an
1674           unsigned number. */
1675   complain_overflow_unsigned
1676 };
1677
1678 struct reloc_howto_struct
1679 {
1680        /*  The type field has mainly a documentary use - the back end can
1681            do what it wants with it, though normally the back end's
1682            external idea of what a reloc number is stored
1683            in this field. For example, a PC relative word relocation
1684            in a coff environment has the type 023 - because that's
1685            what the outside world calls a R_PCRWORD reloc. */
1686   unsigned int type;
1687
1688        /*  The value the final relocation is shifted right by. This drops
1689            unwanted data from the relocation.  */
1690   unsigned int rightshift;
1691
1692        /*  The size of the item to be relocated.  This is *not* a
1693            power-of-two measure.  To get the number of bytes operated
1694            on by a type of relocation, use bfd_get_reloc_size.  */
1695   int size;
1696
1697        /*  The number of bits in the item to be relocated.  This is used
1698            when doing overflow checking.  */
1699   unsigned int bitsize;
1700
1701        /*  Notes that the relocation is relative to the location in the
1702            data section of the addend. The relocation function will
1703            subtract from the relocation value the address of the location
1704            being relocated. */
1705   boolean pc_relative;
1706
1707        /*  The bit position of the reloc value in the destination.
1708            The relocated value is left shifted by this amount. */
1709   unsigned int bitpos;
1710
1711        /* What type of overflow error should be checked for when
1712           relocating. */
1713   enum complain_overflow complain_on_overflow;
1714
1715        /* If this field is non null, then the supplied function is
1716           called rather than the normal function. This allows really
1717           strange relocation methods to be accomodated (e.g., i960 callj
1718           instructions). */
1719   bfd_reloc_status_type (*special_function)
1720                                    PARAMS ((bfd *abfd,
1721                                             arelent *reloc_entry,
1722                                             struct symbol_cache_entry *symbol,
1723                                             PTR data,
1724                                             asection *input_section,
1725                                             bfd *output_bfd,
1726                                             char **error_message));
1727
1728        /* The textual name of the relocation type. */
1729   char *name;
1730
1731        /* Some formats record a relocation addend in the section contents
1732           rather than with the relocation.  For ELF formats this is the
1733           distinction between USE_REL and USE_RELA (though the code checks
1734           for USE_REL == 1/0).  The value of this field is TRUE if the
1735           addend is recorded with the section contents; when performing a
1736           partial link (ld -r) the section contents (the data) will be
1737           modified.  The value of this field is FALSE if addends are
1738           recorded with the relocation (in arelent.addend); when performing
1739           a partial link the relocation will be modified.
1740           All relocations for all ELF USE_RELA targets should set this field
1741           to FALSE (values of TRUE should be looked on with suspicion).
1742           However, the converse is not true: not all relocations of all ELF
1743           USE_REL targets set this field to TRUE.  Why this is so is peculiar
1744           to each particular target.  For relocs that aren't used in partial
1745           links (e.g. GOT stuff) it doesn't matter what this is set to.  */
1746   boolean partial_inplace;
1747
1748        /* The src_mask selects which parts of the read in data
1749           are to be used in the relocation sum.  E.g., if this was an 8 bit
1750           byte of data which we read and relocated, this would be
1751           0x000000ff. When we have relocs which have an addend, such as
1752           sun4 extended relocs, the value in the offset part of a
1753           relocating field is garbage so we never use it. In this case
1754           the mask would be 0x00000000. */
1755   bfd_vma src_mask;
1756
1757        /* The dst_mask selects which parts of the instruction are replaced
1758           into the instruction. In most cases src_mask == dst_mask,
1759           except in the above special case, where dst_mask would be
1760           0x000000ff, and src_mask would be 0x00000000.   */
1761   bfd_vma dst_mask;
1762
1763        /* When some formats create PC relative instructions, they leave
1764           the value of the pc of the place being relocated in the offset
1765           slot of the instruction, so that a PC relative relocation can
1766           be made just by adding in an ordinary offset (e.g., sun3 a.out).
1767           Some formats leave the displacement part of an instruction
1768           empty (e.g., m88k bcs); this flag signals the fact.*/
1769   boolean pcrel_offset;
1770
1771 };
1772 #define HOWTO(C, R,S,B, P, BI, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1773   {(unsigned)C,R,S,B, P, BI, O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1774 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,complain_overflow_dont,FUNCTION, NAME,false,0,0,IN)
1775
1776 #define EMPTY_HOWTO(C) \
1777   HOWTO((C),0,0,0,false,0,complain_overflow_dont,NULL,NULL,false,0,0,false)
1778
1779 #define HOWTO_PREPARE(relocation, symbol)      \
1780   {                                            \
1781   if (symbol != (asymbol *)NULL) {             \
1782     if (bfd_is_com_section (symbol->section)) { \
1783       relocation = 0;                          \
1784     }                                          \
1785     else {                                     \
1786       relocation = symbol->value;              \
1787     }                                          \
1788   }                                            \
1789 }
1790 unsigned int
1791 bfd_get_reloc_size PARAMS ((reloc_howto_type *));
1792
1793 typedef struct relent_chain {
1794   arelent relent;
1795   struct   relent_chain *next;
1796 } arelent_chain;
1797 bfd_reloc_status_type
1798 bfd_check_overflow PARAMS ((enum complain_overflow how,
1799     unsigned int bitsize,
1800     unsigned int rightshift,
1801     unsigned int addrsize,
1802     bfd_vma relocation));
1803
1804 bfd_reloc_status_type
1805 bfd_perform_relocation PARAMS ((bfd *abfd,
1806     arelent *reloc_entry,
1807     PTR data,
1808     asection *input_section,
1809     bfd *output_bfd,
1810     char **error_message));
1811
1812 bfd_reloc_status_type
1813 bfd_install_relocation PARAMS ((bfd *abfd,
1814     arelent *reloc_entry,
1815     PTR data, bfd_vma data_start,
1816     asection *input_section,
1817     char **error_message));
1818
1819 enum bfd_reloc_code_real {
1820   _dummy_first_bfd_reloc_code_real,
1821
1822
1823 /* Basic absolute relocations of N bits. */
1824   BFD_RELOC_64,
1825   BFD_RELOC_32,
1826   BFD_RELOC_26,
1827   BFD_RELOC_24,
1828   BFD_RELOC_16,
1829   BFD_RELOC_14,
1830   BFD_RELOC_8,
1831
1832 /* PC-relative relocations.  Sometimes these are relative to the address
1833 of the relocation itself; sometimes they are relative to the start of
1834 the section containing the relocation.  It depends on the specific target.
1835
1836 The 24-bit relocation is used in some Intel 960 configurations. */
1837   BFD_RELOC_64_PCREL,
1838   BFD_RELOC_32_PCREL,
1839   BFD_RELOC_24_PCREL,
1840   BFD_RELOC_16_PCREL,
1841   BFD_RELOC_12_PCREL,
1842   BFD_RELOC_8_PCREL,
1843
1844 /* For ELF. */
1845   BFD_RELOC_32_GOT_PCREL,
1846   BFD_RELOC_16_GOT_PCREL,
1847   BFD_RELOC_8_GOT_PCREL,
1848   BFD_RELOC_32_GOTOFF,
1849   BFD_RELOC_16_GOTOFF,
1850   BFD_RELOC_LO16_GOTOFF,
1851   BFD_RELOC_HI16_GOTOFF,
1852   BFD_RELOC_HI16_S_GOTOFF,
1853   BFD_RELOC_8_GOTOFF,
1854   BFD_RELOC_32_PLT_PCREL,
1855   BFD_RELOC_24_PLT_PCREL,
1856   BFD_RELOC_16_PLT_PCREL,
1857   BFD_RELOC_8_PLT_PCREL,
1858   BFD_RELOC_32_PLTOFF,
1859   BFD_RELOC_16_PLTOFF,
1860   BFD_RELOC_LO16_PLTOFF,
1861   BFD_RELOC_HI16_PLTOFF,
1862   BFD_RELOC_HI16_S_PLTOFF,
1863   BFD_RELOC_8_PLTOFF,
1864
1865 /* Relocations used by 68K ELF. */
1866   BFD_RELOC_68K_GLOB_DAT,
1867   BFD_RELOC_68K_JMP_SLOT,
1868   BFD_RELOC_68K_RELATIVE,
1869
1870 /* Linkage-table relative. */
1871   BFD_RELOC_32_BASEREL,
1872   BFD_RELOC_16_BASEREL,
1873   BFD_RELOC_LO16_BASEREL,
1874   BFD_RELOC_HI16_BASEREL,
1875   BFD_RELOC_HI16_S_BASEREL,
1876   BFD_RELOC_8_BASEREL,
1877   BFD_RELOC_RVA,
1878
1879 /* Absolute 8-bit relocation, but used to form an address like 0xFFnn. */
1880   BFD_RELOC_8_FFnn,
1881
1882 /* These PC-relative relocations are stored as word displacements --
1883 i.e., byte displacements shifted right two bits.  The 30-bit word
1884 displacement (<<32_PCREL_S2>> -- 32 bits, shifted 2) is used on the
1885 SPARC.  (SPARC tools generally refer to this as <<WDISP30>>.)  The
1886 signed 16-bit displacement is used on the MIPS, and the 23-bit
1887 displacement is used on the Alpha. */
1888   BFD_RELOC_32_PCREL_S2,
1889   BFD_RELOC_16_PCREL_S2,
1890   BFD_RELOC_23_PCREL_S2,
1891
1892 /* High 22 bits and low 10 bits of 32-bit value, placed into lower bits of
1893 the target word.  These are used on the SPARC. */
1894   BFD_RELOC_HI22,
1895   BFD_RELOC_LO10,
1896
1897 /* For systems that allocate a Global Pointer register, these are
1898 displacements off that register.  These relocation types are
1899 handled specially, because the value the register will have is
1900 decided relatively late. */
1901   BFD_RELOC_GPREL16,
1902   BFD_RELOC_GPREL32,
1903
1904 /* Reloc types used for i960/b.out. */
1905   BFD_RELOC_I960_CALLJ,
1906
1907 /* SPARC ELF relocations.  There is probably some overlap with other
1908 relocation types already defined. */
1909   BFD_RELOC_NONE,
1910   BFD_RELOC_SPARC_WDISP22,
1911   BFD_RELOC_SPARC22,
1912   BFD_RELOC_SPARC13,
1913   BFD_RELOC_SPARC_GOT10,
1914   BFD_RELOC_SPARC_GOT13,
1915   BFD_RELOC_SPARC_GOT22,
1916   BFD_RELOC_SPARC_PC10,
1917   BFD_RELOC_SPARC_PC22,
1918   BFD_RELOC_SPARC_WPLT30,
1919   BFD_RELOC_SPARC_COPY,
1920   BFD_RELOC_SPARC_GLOB_DAT,
1921   BFD_RELOC_SPARC_JMP_SLOT,
1922   BFD_RELOC_SPARC_RELATIVE,
1923   BFD_RELOC_SPARC_UA32,
1924
1925 /* I think these are specific to SPARC a.out (e.g., Sun 4). */
1926   BFD_RELOC_SPARC_BASE13,
1927   BFD_RELOC_SPARC_BASE22,
1928
1929 /* SPARC64 relocations */
1930 #define BFD_RELOC_SPARC_64 BFD_RELOC_64
1931   BFD_RELOC_SPARC_10,
1932   BFD_RELOC_SPARC_11,
1933   BFD_RELOC_SPARC_OLO10,
1934   BFD_RELOC_SPARC_HH22,
1935   BFD_RELOC_SPARC_HM10,
1936   BFD_RELOC_SPARC_LM22,
1937   BFD_RELOC_SPARC_PC_HH22,
1938   BFD_RELOC_SPARC_PC_HM10,
1939   BFD_RELOC_SPARC_PC_LM22,
1940   BFD_RELOC_SPARC_WDISP16,
1941   BFD_RELOC_SPARC_WDISP19,
1942   BFD_RELOC_SPARC_7,
1943   BFD_RELOC_SPARC_6,
1944   BFD_RELOC_SPARC_5,
1945 #define BFD_RELOC_SPARC_DISP64 BFD_RELOC_64_PCREL
1946   BFD_RELOC_SPARC_PLT64,
1947   BFD_RELOC_SPARC_HIX22,
1948   BFD_RELOC_SPARC_LOX10,
1949   BFD_RELOC_SPARC_H44,
1950   BFD_RELOC_SPARC_M44,
1951   BFD_RELOC_SPARC_L44,
1952   BFD_RELOC_SPARC_REGISTER,
1953
1954 /* SPARC little endian relocation */
1955   BFD_RELOC_SPARC_REV32,
1956
1957 /* Alpha ECOFF and ELF relocations.  Some of these treat the symbol or
1958 "addend" in some special way.
1959 For GPDISP_HI16 ("gpdisp") relocations, the symbol is ignored when
1960 writing; when reading, it will be the absolute section symbol.  The
1961 addend is the displacement in bytes of the "lda" instruction from
1962 the "ldah" instruction (which is at the address of this reloc). */
1963   BFD_RELOC_ALPHA_GPDISP_HI16,
1964
1965 /* For GPDISP_LO16 ("ignore") relocations, the symbol is handled as
1966 with GPDISP_HI16 relocs.  The addend is ignored when writing the
1967 relocations out, and is filled in with the file's GP value on
1968 reading, for convenience. */
1969   BFD_RELOC_ALPHA_GPDISP_LO16,
1970
1971 /* The ELF GPDISP relocation is exactly the same as the GPDISP_HI16
1972 relocation except that there is no accompanying GPDISP_LO16
1973 relocation. */
1974   BFD_RELOC_ALPHA_GPDISP,
1975
1976 /* The Alpha LITERAL/LITUSE relocs are produced by a symbol reference;
1977 the assembler turns it into a LDQ instruction to load the address of
1978 the symbol, and then fills in a register in the real instruction.
1979
1980 The LITERAL reloc, at the LDQ instruction, refers to the .lita
1981 section symbol.  The addend is ignored when writing, but is filled
1982 in with the file's GP value on reading, for convenience, as with the
1983 GPDISP_LO16 reloc.
1984
1985 The ELF_LITERAL reloc is somewhere between 16_GOTOFF and GPDISP_LO16.
1986 It should refer to the symbol to be referenced, as with 16_GOTOFF,
1987 but it generates output not based on the position within the .got
1988 section, but relative to the GP value chosen for the file during the
1989 final link stage.
1990
1991 The LITUSE reloc, on the instruction using the loaded address, gives
1992 information to the linker that it might be able to use to optimize
1993 away some literal section references.  The symbol is ignored (read
1994 as the absolute section symbol), and the "addend" indicates the type
1995 of instruction using the register:
1996 1 - "memory" fmt insn
1997 2 - byte-manipulation (byte offset reg)
1998 3 - jsr (target of branch)
1999
2000 The GNU linker currently doesn't do any of this optimizing. */
2001   BFD_RELOC_ALPHA_LITERAL,
2002   BFD_RELOC_ALPHA_ELF_LITERAL,
2003   BFD_RELOC_ALPHA_LITUSE,
2004
2005 /* The BFD_RELOC_ALPHA_USER_* relocations are used by the assembler to
2006 process the explicit !<reloc>!sequence relocations, and are mapped
2007 into the normal relocations at the end of processing. */
2008   BFD_RELOC_ALPHA_USER_LITERAL,
2009   BFD_RELOC_ALPHA_USER_LITUSE_BASE,
2010   BFD_RELOC_ALPHA_USER_LITUSE_BYTOFF,
2011   BFD_RELOC_ALPHA_USER_LITUSE_JSR,
2012   BFD_RELOC_ALPHA_USER_GPDISP,
2013   BFD_RELOC_ALPHA_USER_GPRELHIGH,
2014   BFD_RELOC_ALPHA_USER_GPRELLOW,
2015
2016 /* The HINT relocation indicates a value that should be filled into the
2017 "hint" field of a jmp/jsr/ret instruction, for possible branch-
2018 prediction logic which may be provided on some processors. */
2019   BFD_RELOC_ALPHA_HINT,
2020
2021 /* The LINKAGE relocation outputs a linkage pair in the object file,
2022 which is filled by the linker. */
2023   BFD_RELOC_ALPHA_LINKAGE,
2024
2025 /* The CODEADDR relocation outputs a STO_CA in the object file,
2026 which is filled by the linker. */
2027   BFD_RELOC_ALPHA_CODEADDR,
2028
2029 /* Bits 27..2 of the relocation address shifted right 2 bits;
2030 simple reloc otherwise. */
2031   BFD_RELOC_MIPS_JMP,
2032
2033 /* The MIPS16 jump instruction. */
2034   BFD_RELOC_MIPS16_JMP,
2035
2036 /* MIPS16 GP relative reloc. */
2037   BFD_RELOC_MIPS16_GPREL,
2038
2039 /* High 16 bits of 32-bit value; simple reloc. */
2040   BFD_RELOC_HI16,
2041
2042 /* High 16 bits of 32-bit value but the low 16 bits will be sign
2043 extended and added to form the final result.  If the low 16
2044 bits form a negative number, we need to add one to the high value
2045 to compensate for the borrow when the low bits are added. */
2046   BFD_RELOC_HI16_S,
2047
2048 /* Low 16 bits. */
2049   BFD_RELOC_LO16,
2050
2051 /* Like BFD_RELOC_HI16_S, but PC relative. */
2052   BFD_RELOC_PCREL_HI16_S,
2053
2054 /* Like BFD_RELOC_LO16, but PC relative. */
2055   BFD_RELOC_PCREL_LO16,
2056
2057 /* Relocation relative to the global pointer. */
2058 #define BFD_RELOC_MIPS_GPREL BFD_RELOC_GPREL16
2059
2060 /* Relocation against a MIPS literal section. */
2061   BFD_RELOC_MIPS_LITERAL,
2062
2063 /* MIPS ELF relocations. */
2064   BFD_RELOC_MIPS_GOT16,
2065   BFD_RELOC_MIPS_CALL16,
2066 #define BFD_RELOC_MIPS_GPREL32 BFD_RELOC_GPREL32
2067   BFD_RELOC_MIPS_GOT_HI16,
2068   BFD_RELOC_MIPS_GOT_LO16,
2069   BFD_RELOC_MIPS_CALL_HI16,
2070   BFD_RELOC_MIPS_CALL_LO16,
2071   BFD_RELOC_MIPS_SUB,
2072   BFD_RELOC_MIPS_GOT_PAGE,
2073   BFD_RELOC_MIPS_GOT_OFST,
2074   BFD_RELOC_MIPS_GOT_DISP,
2075
2076
2077 /* i386/elf relocations */
2078   BFD_RELOC_386_GOT32,
2079   BFD_RELOC_386_PLT32,
2080   BFD_RELOC_386_COPY,
2081   BFD_RELOC_386_GLOB_DAT,
2082   BFD_RELOC_386_JUMP_SLOT,
2083   BFD_RELOC_386_RELATIVE,
2084   BFD_RELOC_386_GOTOFF,
2085   BFD_RELOC_386_GOTPC,
2086
2087 /* x86-64/elf relocations */
2088   BFD_RELOC_X86_64_GOT32,
2089   BFD_RELOC_X86_64_PLT32,
2090   BFD_RELOC_X86_64_COPY,
2091   BFD_RELOC_X86_64_GLOB_DAT,
2092   BFD_RELOC_X86_64_JUMP_SLOT,
2093   BFD_RELOC_X86_64_RELATIVE,
2094   BFD_RELOC_X86_64_GOTPCREL,
2095   BFD_RELOC_X86_64_32S,
2096
2097 /* ns32k relocations */
2098   BFD_RELOC_NS32K_IMM_8,
2099   BFD_RELOC_NS32K_IMM_16,
2100   BFD_RELOC_NS32K_IMM_32,
2101   BFD_RELOC_NS32K_IMM_8_PCREL,
2102   BFD_RELOC_NS32K_IMM_16_PCREL,
2103   BFD_RELOC_NS32K_IMM_32_PCREL,
2104   BFD_RELOC_NS32K_DISP_8,
2105   BFD_RELOC_NS32K_DISP_16,
2106   BFD_RELOC_NS32K_DISP_32,
2107   BFD_RELOC_NS32K_DISP_8_PCREL,
2108   BFD_RELOC_NS32K_DISP_16_PCREL,
2109   BFD_RELOC_NS32K_DISP_32_PCREL,
2110
2111 /* PDP11 relocations */
2112   BFD_RELOC_PDP11_DISP_8_PCREL,
2113   BFD_RELOC_PDP11_DISP_6_PCREL,
2114
2115 /* Picojava relocs.  Not all of these appear in object files. */
2116   BFD_RELOC_PJ_CODE_HI16,
2117   BFD_RELOC_PJ_CODE_LO16,
2118   BFD_RELOC_PJ_CODE_DIR16,
2119   BFD_RELOC_PJ_CODE_DIR32,
2120   BFD_RELOC_PJ_CODE_REL16,
2121   BFD_RELOC_PJ_CODE_REL32,
2122
2123 /* Power(rs6000) and PowerPC relocations. */
2124   BFD_RELOC_PPC_B26,
2125   BFD_RELOC_PPC_BA26,
2126   BFD_RELOC_PPC_TOC16,
2127   BFD_RELOC_PPC_B16,
2128   BFD_RELOC_PPC_B16_BRTAKEN,
2129   BFD_RELOC_PPC_B16_BRNTAKEN,
2130   BFD_RELOC_PPC_BA16,
2131   BFD_RELOC_PPC_BA16_BRTAKEN,
2132   BFD_RELOC_PPC_BA16_BRNTAKEN,
2133   BFD_RELOC_PPC_COPY,
2134   BFD_RELOC_PPC_GLOB_DAT,
2135   BFD_RELOC_PPC_JMP_SLOT,
2136   BFD_RELOC_PPC_RELATIVE,
2137   BFD_RELOC_PPC_LOCAL24PC,
2138   BFD_RELOC_PPC_EMB_NADDR32,
2139   BFD_RELOC_PPC_EMB_NADDR16,
2140   BFD_RELOC_PPC_EMB_NADDR16_LO,
2141   BFD_RELOC_PPC_EMB_NADDR16_HI,
2142   BFD_RELOC_PPC_EMB_NADDR16_HA,
2143   BFD_RELOC_PPC_EMB_SDAI16,
2144   BFD_RELOC_PPC_EMB_SDA2I16,
2145   BFD_RELOC_PPC_EMB_SDA2REL,
2146   BFD_RELOC_PPC_EMB_SDA21,
2147   BFD_RELOC_PPC_EMB_MRKREF,
2148   BFD_RELOC_PPC_EMB_RELSEC16,
2149   BFD_RELOC_PPC_EMB_RELST_LO,
2150   BFD_RELOC_PPC_EMB_RELST_HI,
2151   BFD_RELOC_PPC_EMB_RELST_HA,
2152   BFD_RELOC_PPC_EMB_BIT_FLD,
2153   BFD_RELOC_PPC_EMB_RELSDA,
2154
2155 /* IBM 370/390 relocations */
2156   BFD_RELOC_I370_D12,
2157
2158 /* The type of reloc used to build a contructor table - at the moment
2159 probably a 32 bit wide absolute relocation, but the target can choose.
2160 It generally does map to one of the other relocation types. */
2161   BFD_RELOC_CTOR,
2162
2163 /* ARM 26 bit pc-relative branch.  The lowest two bits must be zero and are
2164 not stored in the instruction. */
2165   BFD_RELOC_ARM_PCREL_BRANCH,
2166
2167 /* ARM 26 bit pc-relative branch.  The lowest bit must be zero and is
2168 not stored in the instruction.  The 2nd lowest bit comes from a 1 bit
2169 field in the instruction. */
2170   BFD_RELOC_ARM_PCREL_BLX,
2171
2172 /* Thumb 22 bit pc-relative branch.  The lowest bit must be zero and is
2173 not stored in the instruction.  The 2nd lowest bit comes from a 1 bit
2174 field in the instruction. */
2175   BFD_RELOC_THUMB_PCREL_BLX,
2176
2177 /* These relocs are only used within the ARM assembler.  They are not
2178 (at present) written to any object files. */
2179   BFD_RELOC_ARM_IMMEDIATE,
2180   BFD_RELOC_ARM_ADRL_IMMEDIATE,
2181   BFD_RELOC_ARM_OFFSET_IMM,
2182   BFD_RELOC_ARM_SHIFT_IMM,
2183   BFD_RELOC_ARM_SWI,
2184   BFD_RELOC_ARM_MULTI,
2185   BFD_RELOC_ARM_CP_OFF_IMM,
2186   BFD_RELOC_ARM_ADR_IMM,
2187   BFD_RELOC_ARM_LDR_IMM,
2188   BFD_RELOC_ARM_LITERAL,
2189   BFD_RELOC_ARM_IN_POOL,
2190   BFD_RELOC_ARM_OFFSET_IMM8,
2191   BFD_RELOC_ARM_HWLITERAL,
2192   BFD_RELOC_ARM_THUMB_ADD,
2193   BFD_RELOC_ARM_THUMB_IMM,
2194   BFD_RELOC_ARM_THUMB_SHIFT,
2195   BFD_RELOC_ARM_THUMB_OFFSET,
2196   BFD_RELOC_ARM_GOT12,
2197   BFD_RELOC_ARM_GOT32,
2198   BFD_RELOC_ARM_JUMP_SLOT,
2199   BFD_RELOC_ARM_COPY,
2200   BFD_RELOC_ARM_GLOB_DAT,
2201   BFD_RELOC_ARM_PLT32,
2202   BFD_RELOC_ARM_RELATIVE,
2203   BFD_RELOC_ARM_GOTOFF,
2204   BFD_RELOC_ARM_GOTPC,
2205
2206 /* Hitachi SH relocs.  Not all of these appear in object files. */
2207   BFD_RELOC_SH_PCDISP8BY2,
2208   BFD_RELOC_SH_PCDISP12BY2,
2209   BFD_RELOC_SH_IMM4,
2210   BFD_RELOC_SH_IMM4BY2,
2211   BFD_RELOC_SH_IMM4BY4,
2212   BFD_RELOC_SH_IMM8,
2213   BFD_RELOC_SH_IMM8BY2,
2214   BFD_RELOC_SH_IMM8BY4,
2215   BFD_RELOC_SH_PCRELIMM8BY2,
2216   BFD_RELOC_SH_PCRELIMM8BY4,
2217   BFD_RELOC_SH_SWITCH16,
2218   BFD_RELOC_SH_SWITCH32,
2219   BFD_RELOC_SH_USES,
2220   BFD_RELOC_SH_COUNT,
2221   BFD_RELOC_SH_ALIGN,
2222   BFD_RELOC_SH_CODE,
2223   BFD_RELOC_SH_DATA,
2224   BFD_RELOC_SH_LABEL,
2225   BFD_RELOC_SH_LOOP_START,
2226   BFD_RELOC_SH_LOOP_END,
2227   BFD_RELOC_SH_COPY,
2228   BFD_RELOC_SH_GLOB_DAT,
2229   BFD_RELOC_SH_JMP_SLOT,
2230   BFD_RELOC_SH_RELATIVE,
2231   BFD_RELOC_SH_GOTPC,
2232
2233 /* Thumb 23-, 12- and 9-bit pc-relative branches.  The lowest bit must
2234 be zero and is not stored in the instruction. */
2235   BFD_RELOC_THUMB_PCREL_BRANCH9,
2236   BFD_RELOC_THUMB_PCREL_BRANCH12,
2237   BFD_RELOC_THUMB_PCREL_BRANCH23,
2238
2239 /* ARC Cores relocs.
2240 ARC 22 bit pc-relative branch.  The lowest two bits must be zero and are
2241 not stored in the instruction.  The high 20 bits are installed in bits 26
2242 through 7 of the instruction. */
2243   BFD_RELOC_ARC_B22_PCREL,
2244
2245 /* ARC 26 bit absolute branch.  The lowest two bits must be zero and are not
2246 stored in the instruction.  The high 24 bits are installed in bits 23
2247 through 0. */
2248   BFD_RELOC_ARC_B26,
2249
2250 /* Mitsubishi D10V relocs.
2251 This is a 10-bit reloc with the right 2 bits
2252 assumed to be 0. */
2253   BFD_RELOC_D10V_10_PCREL_R,
2254
2255 /* Mitsubishi D10V relocs.
2256 This is a 10-bit reloc with the right 2 bits
2257 assumed to be 0.  This is the same as the previous reloc
2258 except it is in the left container, i.e.,
2259 shifted left 15 bits. */
2260   BFD_RELOC_D10V_10_PCREL_L,
2261
2262 /* This is an 18-bit reloc with the right 2 bits
2263 assumed to be 0. */
2264   BFD_RELOC_D10V_18,
2265
2266 /* This is an 18-bit reloc with the right 2 bits
2267 assumed to be 0. */
2268   BFD_RELOC_D10V_18_PCREL,
2269
2270 /* Mitsubishi D30V relocs.
2271 This is a 6-bit absolute reloc. */
2272   BFD_RELOC_D30V_6,
2273
2274 /* This is a 6-bit pc-relative reloc with
2275 the right 3 bits assumed to be 0. */
2276   BFD_RELOC_D30V_9_PCREL,
2277
2278 /* This is a 6-bit pc-relative reloc with
2279 the right 3 bits assumed to be 0. Same
2280 as the previous reloc but on the right side
2281 of the container. */
2282   BFD_RELOC_D30V_9_PCREL_R,
2283
2284 /* This is a 12-bit absolute reloc with the
2285 right 3 bitsassumed to be 0. */
2286   BFD_RELOC_D30V_15,
2287
2288 /* This is a 12-bit pc-relative reloc with
2289 the right 3 bits assumed to be 0. */
2290   BFD_RELOC_D30V_15_PCREL,
2291
2292 /* This is a 12-bit pc-relative reloc with
2293 the right 3 bits assumed to be 0. Same
2294 as the previous reloc but on the right side
2295 of the container. */
2296   BFD_RELOC_D30V_15_PCREL_R,
2297
2298 /* This is an 18-bit absolute reloc with
2299 the right 3 bits assumed to be 0. */
2300   BFD_RELOC_D30V_21,
2301
2302 /* This is an 18-bit pc-relative reloc with
2303 the right 3 bits assumed to be 0. */
2304   BFD_RELOC_D30V_21_PCREL,
2305
2306 /* This is an 18-bit pc-relative reloc with
2307 the right 3 bits assumed to be 0. Same
2308 as the previous reloc but on the right side
2309 of the container. */
2310   BFD_RELOC_D30V_21_PCREL_R,
2311
2312 /* This is a 32-bit absolute reloc. */
2313   BFD_RELOC_D30V_32,
2314
2315 /* This is a 32-bit pc-relative reloc. */
2316   BFD_RELOC_D30V_32_PCREL,
2317
2318 /* Mitsubishi M32R relocs.
2319 This is a 24 bit absolute address. */
2320   BFD_RELOC_M32R_24,
2321
2322 /* This is a 10-bit pc-relative reloc with the right 2 bits assumed to be 0. */
2323   BFD_RELOC_M32R_10_PCREL,
2324
2325 /* This is an 18-bit reloc with the right 2 bits assumed to be 0. */
2326   BFD_RELOC_M32R_18_PCREL,
2327
2328 /* This is a 26-bit reloc with the right 2 bits assumed to be 0. */
2329   BFD_RELOC_M32R_26_PCREL,
2330
2331 /* This is a 16-bit reloc containing the high 16 bits of an address
2332 used when the lower 16 bits are treated as unsigned. */
2333   BFD_RELOC_M32R_HI16_ULO,
2334
2335 /* This is a 16-bit reloc containing the high 16 bits of an address
2336 used when the lower 16 bits are treated as signed. */
2337   BFD_RELOC_M32R_HI16_SLO,
2338
2339 /* This is a 16-bit reloc containing the lower 16 bits of an address. */
2340   BFD_RELOC_M32R_LO16,
2341
2342 /* This is a 16-bit reloc containing the small data area offset for use in
2343 add3, load, and store instructions. */
2344   BFD_RELOC_M32R_SDA16,
2345
2346 /* This is a 9-bit reloc */
2347   BFD_RELOC_V850_9_PCREL,
2348
2349 /* This is a 22-bit reloc */
2350   BFD_RELOC_V850_22_PCREL,
2351
2352 /* This is a 16 bit offset from the short data area pointer. */
2353   BFD_RELOC_V850_SDA_16_16_OFFSET,
2354
2355 /* This is a 16 bit offset (of which only 15 bits are used) from the
2356 short data area pointer. */
2357   BFD_RELOC_V850_SDA_15_16_OFFSET,
2358
2359 /* This is a 16 bit offset from the zero data area pointer. */
2360   BFD_RELOC_V850_ZDA_16_16_OFFSET,
2361
2362 /* This is a 16 bit offset (of which only 15 bits are used) from the
2363 zero data area pointer. */
2364   BFD_RELOC_V850_ZDA_15_16_OFFSET,
2365
2366 /* This is an 8 bit offset (of which only 6 bits are used) from the
2367 tiny data area pointer. */
2368   BFD_RELOC_V850_TDA_6_8_OFFSET,
2369
2370 /* This is an 8bit offset (of which only 7 bits are used) from the tiny
2371 data area pointer. */
2372   BFD_RELOC_V850_TDA_7_8_OFFSET,
2373
2374 /* This is a 7 bit offset from the tiny data area pointer. */
2375   BFD_RELOC_V850_TDA_7_7_OFFSET,
2376
2377 /* This is a 16 bit offset from the tiny data area pointer. */
2378   BFD_RELOC_V850_TDA_16_16_OFFSET,
2379
2380 /* This is a 5 bit offset (of which only 4 bits are used) from the tiny
2381 data area pointer. */
2382   BFD_RELOC_V850_TDA_4_5_OFFSET,
2383
2384 /* This is a 4 bit offset from the tiny data area pointer. */
2385   BFD_RELOC_V850_TDA_4_4_OFFSET,
2386
2387 /* This is a 16 bit offset from the short data area pointer, with the
2388 bits placed non-contigously in the instruction. */
2389   BFD_RELOC_V850_SDA_16_16_SPLIT_OFFSET,
2390
2391 /* This is a 16 bit offset from the zero data area pointer, with the
2392 bits placed non-contigously in the instruction. */
2393   BFD_RELOC_V850_ZDA_16_16_SPLIT_OFFSET,
2394
2395 /* This is a 6 bit offset from the call table base pointer. */
2396   BFD_RELOC_V850_CALLT_6_7_OFFSET,
2397
2398 /* This is a 16 bit offset from the call table base pointer. */
2399   BFD_RELOC_V850_CALLT_16_16_OFFSET,
2400
2401
2402 /* This is a 32bit pcrel reloc for the mn10300, offset by two bytes in the
2403 instruction. */
2404   BFD_RELOC_MN10300_32_PCREL,
2405
2406 /* This is a 16bit pcrel reloc for the mn10300, offset by two bytes in the
2407 instruction. */
2408   BFD_RELOC_MN10300_16_PCREL,
2409
2410 /* This is a 8bit DP reloc for the tms320c30, where the most
2411 significant 8 bits of a 24 bit word are placed into the least
2412 significant 8 bits of the opcode. */
2413   BFD_RELOC_TIC30_LDP,
2414
2415 /* This is a 7bit reloc for the tms320c54x, where the least
2416 significant 7 bits of a 16 bit word are placed into the least
2417 significant 7 bits of the opcode. */
2418   BFD_RELOC_TIC54X_PARTLS7,
2419
2420 /* This is a 9bit DP reloc for the tms320c54x, where the most
2421 significant 9 bits of a 16 bit word are placed into the least
2422 significant 9 bits of the opcode. */
2423   BFD_RELOC_TIC54X_PARTMS9,
2424
2425 /* This is an extended address 23-bit reloc for the tms320c54x. */
2426   BFD_RELOC_TIC54X_23,
2427
2428 /* This is a 16-bit reloc for the tms320c54x, where the least
2429 significant 16 bits of a 23-bit extended address are placed into
2430 the opcode. */
2431   BFD_RELOC_TIC54X_16_OF_23,
2432
2433 /* This is a reloc for the tms320c54x, where the most
2434 significant 7 bits of a 23-bit extended address are placed into
2435 the opcode. */
2436   BFD_RELOC_TIC54X_MS7_OF_23,
2437
2438 /* This is a 48 bit reloc for the FR30 that stores 32 bits. */
2439   BFD_RELOC_FR30_48,
2440
2441 /* This is a 32 bit reloc for the FR30 that stores 20 bits split up into
2442 two sections. */
2443   BFD_RELOC_FR30_20,
2444
2445 /* This is a 16 bit reloc for the FR30 that stores a 6 bit word offset in
2446 4 bits. */
2447   BFD_RELOC_FR30_6_IN_4,
2448
2449 /* This is a 16 bit reloc for the FR30 that stores an 8 bit byte offset
2450 into 8 bits. */
2451   BFD_RELOC_FR30_8_IN_8,
2452
2453 /* This is a 16 bit reloc for the FR30 that stores a 9 bit short offset
2454 into 8 bits. */
2455   BFD_RELOC_FR30_9_IN_8,
2456
2457 /* This is a 16 bit reloc for the FR30 that stores a 10 bit word offset
2458 into 8 bits. */
2459   BFD_RELOC_FR30_10_IN_8,
2460
2461 /* This is a 16 bit reloc for the FR30 that stores a 9 bit pc relative
2462 short offset into 8 bits. */
2463   BFD_RELOC_FR30_9_PCREL,
2464
2465 /* This is a 16 bit reloc for the FR30 that stores a 12 bit pc relative
2466 short offset into 11 bits. */
2467   BFD_RELOC_FR30_12_PCREL,
2468
2469 /* Motorola Mcore relocations. */
2470   BFD_RELOC_MCORE_PCREL_IMM8BY4,
2471   BFD_RELOC_MCORE_PCREL_IMM11BY2,
2472   BFD_RELOC_MCORE_PCREL_IMM4BY2,
2473   BFD_RELOC_MCORE_PCREL_32,
2474   BFD_RELOC_MCORE_PCREL_JSR_IMM11BY2,
2475   BFD_RELOC_MCORE_RVA,
2476
2477 /* This is a 16 bit reloc for the AVR that stores 8 bit pc relative
2478 short offset into 7 bits. */
2479   BFD_RELOC_AVR_7_PCREL,
2480
2481 /* This is a 16 bit reloc for the AVR that stores 13 bit pc relative
2482 short offset into 12 bits. */
2483   BFD_RELOC_AVR_13_PCREL,
2484
2485 /* This is a 16 bit reloc for the AVR that stores 17 bit value (usually
2486 program memory address) into 16 bits. */
2487   BFD_RELOC_AVR_16_PM,
2488
2489 /* This is a 16 bit reloc for the AVR that stores 8 bit value (usually
2490 data memory address) into 8 bit immediate value of LDI insn. */
2491   BFD_RELOC_AVR_LO8_LDI,
2492
2493 /* This is a 16 bit reloc for the AVR that stores 8 bit value (high 8 bit
2494 of data memory address) into 8 bit immediate value of LDI insn. */
2495   BFD_RELOC_AVR_HI8_LDI,
2496
2497 /* This is a 16 bit reloc for the AVR that stores 8 bit value (most high 8 bit
2498 of program memory address) into 8 bit immediate value of LDI insn. */
2499   BFD_RELOC_AVR_HH8_LDI,
2500
2501 /* This is a 16 bit reloc for the AVR that stores negated 8 bit value
2502 (usually data memory address) into 8 bit immediate value of SUBI insn. */
2503   BFD_RELOC_AVR_LO8_LDI_NEG,
2504
2505 /* This is a 16 bit reloc for the AVR that stores negated 8 bit value
2506 (high 8 bit of data memory address) into 8 bit immediate value of
2507 SUBI insn. */
2508   BFD_RELOC_AVR_HI8_LDI_NEG,
2509
2510 /* This is a 16 bit reloc for the AVR that stores negated 8 bit value
2511 (most high 8 bit of program memory address) into 8 bit immediate value
2512 of LDI or SUBI insn. */
2513   BFD_RELOC_AVR_HH8_LDI_NEG,
2514
2515 /* This is a 16 bit reloc for the AVR that stores 8 bit value (usually
2516 command address) into 8 bit immediate value of LDI insn. */
2517   BFD_RELOC_AVR_LO8_LDI_PM,
2518
2519 /* This is a 16 bit reloc for the AVR that stores 8 bit value (high 8 bit
2520 of command address) into 8 bit immediate value of LDI insn. */
2521   BFD_RELOC_AVR_HI8_LDI_PM,
2522
2523 /* This is a 16 bit reloc for the AVR that stores 8 bit value (most high 8 bit
2524 of command address) into 8 bit immediate value of LDI insn. */
2525   BFD_RELOC_AVR_HH8_LDI_PM,
2526
2527 /* This is a 16 bit reloc for the AVR that stores negated 8 bit value
2528 (usually command address) into 8 bit immediate value of SUBI insn. */
2529   BFD_RELOC_AVR_LO8_LDI_PM_NEG,
2530
2531 /* This is a 16 bit reloc for the AVR that stores negated 8 bit value
2532 (high 8 bit of 16 bit command address) into 8 bit immediate value
2533 of SUBI insn. */
2534   BFD_RELOC_AVR_HI8_LDI_PM_NEG,
2535
2536 /* This is a 16 bit reloc for the AVR that stores negated 8 bit value
2537 (high 6 bit of 22 bit command address) into 8 bit immediate
2538 value of SUBI insn. */
2539   BFD_RELOC_AVR_HH8_LDI_PM_NEG,
2540
2541 /* This is a 32 bit reloc for the AVR that stores 23 bit value
2542 into 22 bits. */
2543   BFD_RELOC_AVR_CALL,
2544
2545 /* Direct 12 bit. */
2546   BFD_RELOC_390_12,
2547
2548 /* 12 bit GOT offset. */
2549   BFD_RELOC_390_GOT12,
2550
2551 /* 32 bit PC relative PLT address. */
2552   BFD_RELOC_390_PLT32,
2553
2554 /* Copy symbol at runtime. */
2555   BFD_RELOC_390_COPY,
2556
2557 /* Create GOT entry. */
2558   BFD_RELOC_390_GLOB_DAT,
2559
2560 /* Create PLT entry. */
2561   BFD_RELOC_390_JMP_SLOT,
2562
2563 /* Adjust by program base. */
2564   BFD_RELOC_390_RELATIVE,
2565
2566 /* 32 bit PC relative offset to GOT. */
2567   BFD_RELOC_390_GOTPC,
2568
2569 /* 16 bit GOT offset. */
2570   BFD_RELOC_390_GOT16,
2571
2572 /* PC relative 16 bit shifted by 1. */
2573   BFD_RELOC_390_PC16DBL,
2574
2575 /* 16 bit PC rel. PLT shifted by 1. */
2576   BFD_RELOC_390_PLT16DBL,
2577
2578 /* PC relative 32 bit shifted by 1. */
2579   BFD_RELOC_390_PC32DBL,
2580
2581 /* 32 bit PC rel. PLT shifted by 1. */
2582   BFD_RELOC_390_PLT32DBL,
2583
2584 /* 32 bit PC rel. GOT shifted by 1. */
2585   BFD_RELOC_390_GOTPCDBL,
2586
2587 /* 64 bit GOT offset. */
2588   BFD_RELOC_390_GOT64,
2589
2590 /* 64 bit PC relative PLT address. */
2591   BFD_RELOC_390_PLT64,
2592
2593 /* 32 bit rel. offset to GOT entry. */
2594   BFD_RELOC_390_GOTENT,
2595
2596 /* These two relocations are used by the linker to determine which of
2597 the entries in a C++ virtual function table are actually used.  When
2598 the --gc-sections option is given, the linker will zero out the entries
2599 that are not used, so that the code for those functions need not be
2600 included in the output.
2601
2602 VTABLE_INHERIT is a zero-space relocation used to describe to the
2603 linker the inheritence tree of a C++ virtual function table.  The
2604 relocation's symbol should be the parent class' vtable, and the
2605 relocation should be located at the child vtable.
2606
2607 VTABLE_ENTRY is a zero-space relocation that describes the use of a
2608 virtual function table entry.  The reloc's symbol should refer to the
2609 table of the class mentioned in the code.  Off of that base, an offset
2610 describes the entry that is being used.  For Rela hosts, this offset
2611 is stored in the reloc's addend.  For Rel hosts, we are forced to put
2612 this offset in the reloc's section offset. */
2613   BFD_RELOC_VTABLE_INHERIT,
2614   BFD_RELOC_VTABLE_ENTRY,
2615
2616 /* Intel IA64 Relocations. */
2617   BFD_RELOC_IA64_IMM14,
2618   BFD_RELOC_IA64_IMM22,
2619   BFD_RELOC_IA64_IMM64,
2620   BFD_RELOC_IA64_DIR32MSB,
2621   BFD_RELOC_IA64_DIR32LSB,
2622   BFD_RELOC_IA64_DIR64MSB,
2623   BFD_RELOC_IA64_DIR64LSB,
2624   BFD_RELOC_IA64_GPREL22,
2625   BFD_RELOC_IA64_GPREL64I,
2626   BFD_RELOC_IA64_GPREL32MSB,
2627   BFD_RELOC_IA64_GPREL32LSB,
2628   BFD_RELOC_IA64_GPREL64MSB,
2629   BFD_RELOC_IA64_GPREL64LSB,
2630   BFD_RELOC_IA64_LTOFF22,
2631   BFD_RELOC_IA64_LTOFF64I,
2632   BFD_RELOC_IA64_PLTOFF22,
2633   BFD_RELOC_IA64_PLTOFF64I,
2634   BFD_RELOC_IA64_PLTOFF64MSB,
2635   BFD_RELOC_IA64_PLTOFF64LSB,
2636   BFD_RELOC_IA64_FPTR64I,
2637   BFD_RELOC_IA64_FPTR32MSB,
2638   BFD_RELOC_IA64_FPTR32LSB,
2639   BFD_RELOC_IA64_FPTR64MSB,
2640   BFD_RELOC_IA64_FPTR64LSB,
2641   BFD_RELOC_IA64_PCREL21B,
2642   BFD_RELOC_IA64_PCREL21BI,
2643   BFD_RELOC_IA64_PCREL21M,
2644   BFD_RELOC_IA64_PCREL21F,
2645   BFD_RELOC_IA64_PCREL22,
2646   BFD_RELOC_IA64_PCREL60B,
2647   BFD_RELOC_IA64_PCREL64I,
2648   BFD_RELOC_IA64_PCREL32MSB,
2649   BFD_RELOC_IA64_PCREL32LSB,
2650   BFD_RELOC_IA64_PCREL64MSB,
2651   BFD_RELOC_IA64_PCREL64LSB,
2652   BFD_RELOC_IA64_LTOFF_FPTR22,
2653   BFD_RELOC_IA64_LTOFF_FPTR64I,
2654   BFD_RELOC_IA64_LTOFF_FPTR64MSB,
2655   BFD_RELOC_IA64_LTOFF_FPTR64LSB,
2656   BFD_RELOC_IA64_SEGREL32MSB,
2657   BFD_RELOC_IA64_SEGREL32LSB,
2658   BFD_RELOC_IA64_SEGREL64MSB,
2659   BFD_RELOC_IA64_SEGREL64LSB,
2660   BFD_RELOC_IA64_SECREL32MSB,
2661   BFD_RELOC_IA64_SECREL32LSB,
2662   BFD_RELOC_IA64_SECREL64MSB,
2663   BFD_RELOC_IA64_SECREL64LSB,
2664   BFD_RELOC_IA64_REL32MSB,
2665   BFD_RELOC_IA64_REL32LSB,
2666   BFD_RELOC_IA64_REL64MSB,
2667   BFD_RELOC_IA64_REL64LSB,
2668   BFD_RELOC_IA64_LTV32MSB,
2669   BFD_RELOC_IA64_LTV32LSB,
2670   BFD_RELOC_IA64_LTV64MSB,
2671   BFD_RELOC_IA64_LTV64LSB,
2672   BFD_RELOC_IA64_IPLTMSB,
2673   BFD_RELOC_IA64_IPLTLSB,
2674   BFD_RELOC_IA64_COPY,
2675   BFD_RELOC_IA64_TPREL22,
2676   BFD_RELOC_IA64_TPREL64MSB,
2677   BFD_RELOC_IA64_TPREL64LSB,
2678   BFD_RELOC_IA64_LTOFF_TP22,
2679   BFD_RELOC_IA64_LTOFF22X,
2680   BFD_RELOC_IA64_LDXMOV,
2681
2682 /* Motorola 68HC11 reloc.
2683 This is the 8 bits high part of an absolute address. */
2684   BFD_RELOC_M68HC11_HI8,
2685
2686 /* Motorola 68HC11 reloc.
2687 This is the 8 bits low part of an absolute address. */
2688   BFD_RELOC_M68HC11_LO8,
2689
2690 /* Motorola 68HC11 reloc.
2691 This is the 3 bits of a value. */
2692   BFD_RELOC_M68HC11_3B,
2693
2694 /* These relocs are only used within the CRIS assembler.  They are not
2695 (at present) written to any object files. */
2696   BFD_RELOC_CRIS_BDISP8,
2697   BFD_RELOC_CRIS_UNSIGNED_5,
2698   BFD_RELOC_CRIS_SIGNED_6,
2699   BFD_RELOC_CRIS_UNSIGNED_6,
2700   BFD_RELOC_CRIS_UNSIGNED_4,
2701
2702 /* Relocs used in ELF shared libraries for CRIS. */
2703   BFD_RELOC_CRIS_COPY,
2704   BFD_RELOC_CRIS_GLOB_DAT,
2705   BFD_RELOC_CRIS_JUMP_SLOT,
2706   BFD_RELOC_CRIS_RELATIVE,
2707
2708 /* 32-bit offset to symbol-entry within GOT. */
2709   BFD_RELOC_CRIS_32_GOT,
2710
2711 /* 16-bit offset to symbol-entry within GOT. */
2712   BFD_RELOC_CRIS_16_GOT,
2713
2714 /* 32-bit offset to symbol-entry within GOT, with PLT handling. */
2715   BFD_RELOC_CRIS_32_GOTPLT,
2716
2717 /* 16-bit offset to symbol-entry within GOT, with PLT handling. */
2718   BFD_RELOC_CRIS_16_GOTPLT,
2719
2720 /* 32-bit offset to symbol, relative to GOT. */
2721   BFD_RELOC_CRIS_32_GOTREL,
2722
2723 /* 32-bit offset to symbol with PLT entry, relative to GOT. */
2724   BFD_RELOC_CRIS_32_PLT_GOTREL,
2725
2726 /* 32-bit offset to symbol with PLT entry, relative to this relocation. */
2727   BFD_RELOC_CRIS_32_PLT_PCREL,
2728
2729 /* Intel i860 Relocations. */
2730   BFD_RELOC_860_COPY,
2731   BFD_RELOC_860_GLOB_DAT,
2732   BFD_RELOC_860_JUMP_SLOT,
2733   BFD_RELOC_860_RELATIVE,
2734   BFD_RELOC_860_PC26,
2735   BFD_RELOC_860_PLT26,
2736   BFD_RELOC_860_PC16,
2737   BFD_RELOC_860_LOW0,
2738   BFD_RELOC_860_SPLIT0,
2739   BFD_RELOC_860_LOW1,
2740   BFD_RELOC_860_SPLIT1,
2741   BFD_RELOC_860_LOW2,
2742   BFD_RELOC_860_SPLIT2,
2743   BFD_RELOC_860_LOW3,
2744   BFD_RELOC_860_LOGOT0,
2745   BFD_RELOC_860_SPGOT0,
2746   BFD_RELOC_860_LOGOT1,
2747   BFD_RELOC_860_SPGOT1,
2748   BFD_RELOC_860_LOGOTOFF0,
2749   BFD_RELOC_860_SPGOTOFF0,
2750   BFD_RELOC_860_LOGOTOFF1,
2751   BFD_RELOC_860_SPGOTOFF1,
2752   BFD_RELOC_860_LOGOTOFF2,
2753   BFD_RELOC_860_LOGOTOFF3,
2754   BFD_RELOC_860_LOPC,
2755   BFD_RELOC_860_HIGHADJ,
2756   BFD_RELOC_860_HAGOT,
2757   BFD_RELOC_860_HAGOTOFF,
2758   BFD_RELOC_860_HAPC,
2759   BFD_RELOC_860_HIGH,
2760   BFD_RELOC_860_HIGOT,
2761   BFD_RELOC_860_HIGOTOFF,
2762
2763 /* OpenRISC Relocations. */
2764   BFD_RELOC_OPENRISC_ABS_26,
2765   BFD_RELOC_OPENRISC_REL_26,
2766   BFD_RELOC_UNUSED };
2767 typedef enum bfd_reloc_code_real bfd_reloc_code_real_type;
2768 reloc_howto_type *
2769 bfd_reloc_type_lookup PARAMS ((bfd *abfd, bfd_reloc_code_real_type code));
2770
2771 const char *
2772 bfd_get_reloc_code_name PARAMS ((bfd_reloc_code_real_type code));
2773
2774
2775 typedef struct symbol_cache_entry
2776 {
2777        /* A pointer to the BFD which owns the symbol. This information
2778           is necessary so that a back end can work out what additional
2779           information (invisible to the application writer) is carried
2780           with the symbol.
2781
2782           This field is *almost* redundant, since you can use section->owner
2783           instead, except that some symbols point to the global sections
2784           bfd_{abs,com,und}_section.  This could be fixed by making
2785           these globals be per-bfd (or per-target-flavor).  FIXME. */
2786
2787   struct _bfd *the_bfd; /* Use bfd_asymbol_bfd(sym) to access this field. */
2788
2789        /* The text of the symbol. The name is left alone, and not copied; the
2790           application may not alter it. */
2791   CONST char *name;
2792
2793        /* The value of the symbol.  This really should be a union of a
2794           numeric value with a pointer, since some flags indicate that
2795           a pointer to another symbol is stored here.  */
2796   symvalue value;
2797
2798        /* Attributes of a symbol: */
2799
2800 #define BSF_NO_FLAGS    0x00
2801
2802        /* The symbol has local scope; <<static>> in <<C>>. The value
2803           is the offset into the section of the data. */
2804 #define BSF_LOCAL      0x01
2805
2806        /* The symbol has global scope; initialized data in <<C>>. The
2807           value is the offset into the section of the data. */
2808 #define BSF_GLOBAL     0x02
2809
2810        /* The symbol has global scope and is exported. The value is
2811           the offset into the section of the data. */
2812 #define BSF_EXPORT     BSF_GLOBAL /* no real difference */
2813
2814        /* A normal C symbol would be one of:
2815           <<BSF_LOCAL>>, <<BSF_FORT_COMM>>,  <<BSF_UNDEFINED>> or
2816           <<BSF_GLOBAL>> */
2817
2818        /* The symbol is a debugging record. The value has an arbitary
2819           meaning, unless BSF_DEBUGGING_RELOC is also set.  */
2820 #define BSF_DEBUGGING  0x08
2821
2822        /* The symbol denotes a function entry point.  Used in ELF,
2823           perhaps others someday.  */
2824 #define BSF_FUNCTION    0x10
2825
2826        /* Used by the linker. */
2827 #define BSF_KEEP        0x20
2828 #define BSF_KEEP_G      0x40
2829
2830        /* A weak global symbol, overridable without warnings by
2831           a regular global symbol of the same name.  */
2832 #define BSF_WEAK        0x80
2833
2834        /* This symbol was created to point to a section, e.g. ELF's
2835           STT_SECTION symbols.  */
2836 #define BSF_SECTION_SYM 0x100
2837
2838        /* The symbol used to be a common symbol, but now it is
2839           allocated. */
2840 #define BSF_OLD_COMMON  0x200
2841
2842        /* The default value for common data. */
2843 #define BFD_FORT_COMM_DEFAULT_VALUE 0
2844
2845        /* In some files the type of a symbol sometimes alters its
2846           location in an output file - ie in coff a <<ISFCN>> symbol
2847           which is also <<C_EXT>> symbol appears where it was
2848           declared and not at the end of a section.  This bit is set
2849           by the target BFD part to convey this information. */
2850
2851 #define BSF_NOT_AT_END    0x400
2852
2853        /* Signal that the symbol is the label of constructor section. */
2854 #define BSF_CONSTRUCTOR   0x800
2855
2856        /* Signal that the symbol is a warning symbol.  The name is a
2857           warning.  The name of the next symbol is the one to warn about;
2858           if a reference is made to a symbol with the same name as the next
2859           symbol, a warning is issued by the linker. */
2860 #define BSF_WARNING       0x1000
2861
2862        /* Signal that the symbol is indirect.  This symbol is an indirect
2863           pointer to the symbol with the same name as the next symbol. */
2864 #define BSF_INDIRECT      0x2000
2865
2866        /* BSF_FILE marks symbols that contain a file name.  This is used
2867           for ELF STT_FILE symbols.  */
2868 #define BSF_FILE          0x4000
2869
2870        /* Symbol is from dynamic linking information.  */
2871 #define BSF_DYNAMIC       0x8000
2872
2873        /* The symbol denotes a data object.  Used in ELF, and perhaps
2874           others someday.  */
2875 #define BSF_OBJECT        0x10000
2876
2877        /* This symbol is a debugging symbol.  The value is the offset
2878           into the section of the data.  BSF_DEBUGGING should be set
2879           as well.  */
2880 #define BSF_DEBUGGING_RELOC 0x20000
2881
2882   flagword flags;
2883
2884        /* A pointer to the section to which this symbol is
2885           relative.  This will always be non NULL, there are special
2886           sections for undefined and absolute symbols.  */
2887   struct sec *section;
2888
2889        /* Back end special data.  */
2890   union
2891     {
2892       PTR p;
2893       bfd_vma i;
2894     } udata;
2895
2896 } asymbol;
2897 #define bfd_get_symtab_upper_bound(abfd) \
2898      BFD_SEND (abfd, _bfd_get_symtab_upper_bound, (abfd))
2899 boolean
2900 bfd_is_local_label PARAMS ((bfd *abfd, asymbol *sym));
2901
2902 boolean
2903 bfd_is_local_label_name PARAMS ((bfd *abfd, const char *name));
2904
2905 #define bfd_is_local_label_name(abfd, name) \
2906      BFD_SEND (abfd, _bfd_is_local_label_name, (abfd, name))
2907 #define bfd_canonicalize_symtab(abfd, location) \
2908      BFD_SEND (abfd, _bfd_canonicalize_symtab,\
2909                   (abfd, location))
2910 boolean
2911 bfd_set_symtab PARAMS ((bfd *abfd, asymbol **location, unsigned int count));
2912
2913 void
2914 bfd_print_symbol_vandf PARAMS ((PTR file, asymbol *symbol));
2915
2916 #define bfd_make_empty_symbol(abfd) \
2917      BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
2918 #define bfd_make_debug_symbol(abfd,ptr,size) \
2919         BFD_SEND (abfd, _bfd_make_debug_symbol, (abfd, ptr, size))
2920 int
2921 bfd_decode_symclass PARAMS ((asymbol *symbol));
2922
2923 boolean
2924 bfd_is_undefined_symclass PARAMS ((int symclass));
2925
2926 void
2927 bfd_symbol_info PARAMS ((asymbol *symbol, symbol_info *ret));
2928
2929 boolean
2930 bfd_copy_private_symbol_data PARAMS ((bfd *ibfd, asymbol *isym, bfd *obfd, asymbol *osym));
2931
2932 #define bfd_copy_private_symbol_data(ibfd, isymbol, obfd, osymbol) \
2933      BFD_SEND (obfd, _bfd_copy_private_symbol_data, \
2934                (ibfd, isymbol, obfd, osymbol))
2935 struct _bfd
2936 {
2937     /* The filename the application opened the BFD with.  */
2938     CONST char *filename;
2939
2940     /* A pointer to the target jump table.             */
2941     const struct bfd_target *xvec;
2942
2943     /* To avoid dragging too many header files into every file that
2944        includes `<<bfd.h>>', IOSTREAM has been declared as a "char
2945        *", and MTIME as a "long".  Their correct types, to which they
2946        are cast when used, are "FILE *" and "time_t".    The iostream
2947        is the result of an fopen on the filename.  However, if the
2948        BFD_IN_MEMORY flag is set, then iostream is actually a pointer
2949        to a bfd_in_memory struct.  */
2950     PTR iostream;
2951
2952     /* Is the file descriptor being cached?  That is, can it be closed as
2953        needed, and re-opened when accessed later?  */
2954
2955     boolean cacheable;
2956
2957     /* Marks whether there was a default target specified when the
2958        BFD was opened. This is used to select which matching algorithm
2959        to use to choose the back end. */
2960
2961     boolean target_defaulted;
2962
2963     /* The caching routines use these to maintain a
2964        least-recently-used list of BFDs */
2965
2966     struct _bfd *lru_prev, *lru_next;
2967
2968     /* When a file is closed by the caching routines, BFD retains
2969        state information on the file here: */
2970
2971     file_ptr where;
2972
2973     /* and here: (``once'' means at least once) */
2974
2975     boolean opened_once;
2976
2977     /* Set if we have a locally maintained mtime value, rather than
2978        getting it from the file each time: */
2979
2980     boolean mtime_set;
2981
2982     /* File modified time, if mtime_set is true: */
2983
2984     long mtime;
2985
2986     /* Reserved for an unimplemented file locking extension.*/
2987
2988     int ifd;
2989
2990     /* The format which belongs to the BFD. (object, core, etc.) */
2991
2992     bfd_format format;
2993
2994     /* The direction the BFD was opened with*/
2995
2996     enum bfd_direction {no_direction = 0,
2997                         read_direction = 1,
2998                         write_direction = 2,
2999                         both_direction = 3} direction;
3000
3001     /* Format_specific flags*/
3002
3003     flagword flags;
3004
3005     /* Currently my_archive is tested before adding origin to
3006        anything. I believe that this can become always an add of
3007        origin, with origin set to 0 for non archive files.   */
3008
3009     file_ptr origin;
3010
3011     /* Remember when output has begun, to stop strange things
3012        from happening. */
3013     boolean output_has_begun;
3014
3015     /* Pointer to linked list of sections*/
3016     struct sec  *sections;
3017
3018     /* The number of sections */
3019     unsigned int section_count;
3020
3021     /* Stuff only useful for object files:
3022        The start address. */
3023     bfd_vma start_address;
3024
3025     /* Used for input and output*/
3026     unsigned int symcount;
3027
3028     /* Symbol table for output BFD (with symcount entries) */
3029     struct symbol_cache_entry  **outsymbols;
3030
3031     /* Pointer to structure which contains architecture information*/
3032     const struct bfd_arch_info *arch_info;
3033
3034     /* Stuff only useful for archives:*/
3035     PTR arelt_data;
3036     struct _bfd *my_archive;     /* The containing archive BFD.  */
3037     struct _bfd *next;           /* The next BFD in the archive.  */
3038     struct _bfd *archive_head;   /* The first BFD in the archive.  */
3039     boolean has_armap;
3040
3041     /* A chain of BFD structures involved in a link.  */
3042     struct _bfd *link_next;
3043
3044     /* A field used by _bfd_generic_link_add_archive_symbols.  This will
3045        be used only for archive elements.  */
3046     int archive_pass;
3047
3048     /* Used by the back end to hold private data. */
3049
3050     union
3051       {
3052       struct aout_data_struct *aout_data;
3053       struct artdata *aout_ar_data;
3054       struct _oasys_data *oasys_obj_data;
3055       struct _oasys_ar_data *oasys_ar_data;
3056       struct coff_tdata *coff_obj_data;
3057       struct pe_tdata *pe_obj_data;
3058       struct xcoff_tdata *xcoff_obj_data;
3059       struct ecoff_tdata *ecoff_obj_data;
3060       struct ieee_data_struct *ieee_data;
3061       struct ieee_ar_data_struct *ieee_ar_data;
3062       struct srec_data_struct *srec_data;
3063       struct ihex_data_struct *ihex_data;
3064       struct tekhex_data_struct *tekhex_data;
3065       struct elf_obj_tdata *elf_obj_data;
3066       struct nlm_obj_tdata *nlm_obj_data;
3067       struct bout_data_struct *bout_data;
3068       struct sun_core_struct *sun_core_data;
3069       struct sco5_core_struct *sco5_core_data;
3070       struct trad_core_struct *trad_core_data;
3071       struct som_data_struct *som_data;
3072       struct hpux_core_struct *hpux_core_data;
3073       struct hppabsd_core_struct *hppabsd_core_data;
3074       struct sgi_core_struct *sgi_core_data;
3075       struct lynx_core_struct *lynx_core_data;
3076       struct osf_core_struct *osf_core_data;
3077       struct cisco_core_struct *cisco_core_data;
3078       struct versados_data_struct *versados_data;
3079       struct netbsd_core_struct *netbsd_core_data;
3080       PTR any;
3081       } tdata;
3082
3083     /* Used by the application to hold private data*/
3084     PTR usrdata;
3085
3086   /* Where all the allocated stuff under this BFD goes.  This is a
3087      struct objalloc *, but we use PTR to avoid requiring the inclusion of
3088      objalloc.h.  */
3089     PTR memory;
3090 };
3091
3092 typedef enum bfd_error
3093 {
3094   bfd_error_no_error = 0,
3095   bfd_error_system_call,
3096   bfd_error_invalid_target,
3097   bfd_error_wrong_format,
3098   bfd_error_invalid_operation,
3099   bfd_error_no_memory,
3100   bfd_error_no_symbols,
3101   bfd_error_no_armap,
3102   bfd_error_no_more_archived_files,
3103   bfd_error_malformed_archive,
3104   bfd_error_file_not_recognized,
3105   bfd_error_file_ambiguously_recognized,
3106   bfd_error_no_contents,
3107   bfd_error_nonrepresentable_section,
3108   bfd_error_no_debug_section,
3109   bfd_error_bad_value,
3110   bfd_error_file_truncated,
3111   bfd_error_file_too_big,
3112   bfd_error_invalid_error_code
3113 } bfd_error_type;
3114
3115 bfd_error_type
3116 bfd_get_error PARAMS ((void));
3117
3118 void
3119 bfd_set_error PARAMS ((bfd_error_type error_tag));
3120
3121 CONST char *
3122 bfd_errmsg PARAMS ((bfd_error_type error_tag));
3123
3124 void
3125 bfd_perror PARAMS ((CONST char *message));
3126
3127 typedef void (*bfd_error_handler_type) PARAMS ((const char *, ...));
3128
3129 bfd_error_handler_type
3130 bfd_set_error_handler PARAMS ((bfd_error_handler_type));
3131
3132 void
3133 bfd_set_error_program_name PARAMS ((const char *));
3134
3135 bfd_error_handler_type
3136 bfd_get_error_handler PARAMS ((void));
3137
3138 long
3139 bfd_get_reloc_upper_bound PARAMS ((bfd *abfd, asection *sect));
3140
3141 long
3142 bfd_canonicalize_reloc PARAMS ((bfd *abfd,
3143     asection *sec,
3144     arelent **loc,
3145     asymbol **syms));
3146
3147 void
3148 bfd_set_reloc PARAMS ((bfd *abfd, asection *sec, arelent **rel, unsigned int count)
3149     
3150     );
3151
3152 boolean
3153 bfd_set_file_flags PARAMS ((bfd *abfd, flagword flags));
3154
3155 int
3156 bfd_get_arch_size PARAMS ((bfd *abfd));
3157
3158 int
3159 bfd_get_sign_extend_vma PARAMS ((bfd *abfd));
3160
3161 boolean
3162 bfd_set_start_address PARAMS ((bfd *abfd, bfd_vma vma));
3163
3164 long
3165 bfd_get_mtime PARAMS ((bfd *abfd));
3166
3167 long
3168 bfd_get_size PARAMS ((bfd *abfd));
3169
3170 int
3171 bfd_get_gp_size PARAMS ((bfd *abfd));
3172
3173 void
3174 bfd_set_gp_size PARAMS ((bfd *abfd, int i));
3175
3176 bfd_vma
3177 bfd_scan_vma PARAMS ((CONST char *string, CONST char **end, int base));
3178
3179 boolean
3180 bfd_copy_private_bfd_data PARAMS ((bfd *ibfd, bfd *obfd));
3181
3182 #define bfd_copy_private_bfd_data(ibfd, obfd) \
3183      BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
3184                (ibfd, obfd))
3185 boolean
3186 bfd_merge_private_bfd_data PARAMS ((bfd *ibfd, bfd *obfd));
3187
3188 #define bfd_merge_private_bfd_data(ibfd, obfd) \
3189      BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
3190                (ibfd, obfd))
3191 boolean
3192 bfd_set_private_flags PARAMS ((bfd *abfd, flagword flags));
3193
3194 #define bfd_set_private_flags(abfd, flags) \
3195      BFD_SEND (abfd, _bfd_set_private_flags, \
3196                (abfd, flags))
3197 #define bfd_sizeof_headers(abfd, reloc) \
3198      BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
3199
3200 #define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
3201      BFD_SEND (abfd, _bfd_find_nearest_line,  (abfd, sec, syms, off, file, func, line))
3202
3203        /* Do these three do anything useful at all, for any back end?  */
3204 #define bfd_debug_info_start(abfd) \
3205         BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
3206
3207 #define bfd_debug_info_end(abfd) \
3208         BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
3209
3210 #define bfd_debug_info_accumulate(abfd, section) \
3211         BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
3212
3213
3214 #define bfd_stat_arch_elt(abfd, stat) \
3215         BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
3216
3217 #define bfd_update_armap_timestamp(abfd) \
3218         BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
3219
3220 #define bfd_set_arch_mach(abfd, arch, mach)\
3221         BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
3222
3223 #define bfd_relax_section(abfd, section, link_info, again) \
3224        BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
3225
3226 #define bfd_gc_sections(abfd, link_info) \
3227        BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
3228
3229 #define bfd_link_hash_table_create(abfd) \
3230        BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
3231
3232 #define bfd_link_add_symbols(abfd, info) \
3233        BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
3234
3235 #define bfd_final_link(abfd, info) \
3236        BFD_SEND (abfd, _bfd_final_link, (abfd, info))
3237
3238 #define bfd_free_cached_info(abfd) \
3239        BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
3240
3241 #define bfd_get_dynamic_symtab_upper_bound(abfd) \
3242        BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
3243
3244 #define bfd_print_private_bfd_data(abfd, file)\
3245        BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
3246
3247 #define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
3248        BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
3249
3250 #define bfd_get_dynamic_reloc_upper_bound(abfd) \
3251        BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
3252
3253 #define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
3254        BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
3255
3256 extern bfd_byte *bfd_get_relocated_section_contents
3257        PARAMS ((bfd *, struct bfd_link_info *,
3258                  struct bfd_link_order *, bfd_byte *,
3259                  boolean, asymbol **));
3260
3261 symindex
3262 bfd_get_next_mapent PARAMS ((bfd *abfd, symindex previous, carsym **sym));
3263
3264 boolean
3265 bfd_set_archive_head PARAMS ((bfd *output, bfd *new_head));
3266
3267 bfd *
3268 bfd_openr_next_archived_file PARAMS ((bfd *archive, bfd *previous));
3269
3270 CONST char *
3271 bfd_core_file_failing_command PARAMS ((bfd *abfd));
3272
3273 int
3274 bfd_core_file_failing_signal PARAMS ((bfd *abfd));
3275
3276 boolean
3277 core_file_matches_executable_p PARAMS ((bfd *core_bfd, bfd *exec_bfd));
3278
3279 #define BFD_SEND(bfd, message, arglist) \
3280                ((*((bfd)->xvec->message)) arglist)
3281
3282 #ifdef DEBUG_BFD_SEND
3283 #undef BFD_SEND
3284 #define BFD_SEND(bfd, message, arglist) \
3285   (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
3286     ((*((bfd)->xvec->message)) arglist) : \
3287     (bfd_assert (__FILE__,__LINE__), NULL))
3288 #endif
3289 #define BFD_SEND_FMT(bfd, message, arglist) \
3290             (((bfd)->xvec->message[(int) ((bfd)->format)]) arglist)
3291
3292 #ifdef DEBUG_BFD_SEND
3293 #undef BFD_SEND_FMT
3294 #define BFD_SEND_FMT(bfd, message, arglist) \
3295   (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
3296    (((bfd)->xvec->message[(int) ((bfd)->format)]) arglist) : \
3297    (bfd_assert (__FILE__,__LINE__), NULL))
3298 #endif
3299 enum bfd_flavour {
3300   bfd_target_unknown_flavour,
3301   bfd_target_aout_flavour,
3302   bfd_target_coff_flavour,
3303   bfd_target_ecoff_flavour,
3304   bfd_target_xcoff_flavour,
3305   bfd_target_elf_flavour,
3306   bfd_target_ieee_flavour,
3307   bfd_target_nlm_flavour,
3308   bfd_target_oasys_flavour,
3309   bfd_target_tekhex_flavour,
3310   bfd_target_srec_flavour,
3311   bfd_target_ihex_flavour,
3312   bfd_target_som_flavour,
3313   bfd_target_os9k_flavour,
3314   bfd_target_versados_flavour,
3315   bfd_target_msdos_flavour,
3316   bfd_target_ovax_flavour,
3317   bfd_target_evax_flavour
3318 };
3319
3320 enum bfd_endian { BFD_ENDIAN_BIG, BFD_ENDIAN_LITTLE, BFD_ENDIAN_UNKNOWN };
3321
3322 /* Forward declaration.  */
3323 typedef struct bfd_link_info _bfd_link_info;
3324
3325 typedef struct bfd_target
3326 {
3327   char *name;
3328   enum bfd_flavour flavour;
3329   enum bfd_endian byteorder;
3330   enum bfd_endian header_byteorder;
3331   flagword object_flags;
3332   flagword section_flags;
3333   char symbol_leading_char;
3334   char ar_pad_char;
3335   unsigned short ar_max_namelen;
3336   bfd_vma      (*bfd_getx64) PARAMS ((const bfd_byte *));
3337   bfd_signed_vma (*bfd_getx_signed_64) PARAMS ((const bfd_byte *));
3338   void         (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *));
3339   bfd_vma      (*bfd_getx32) PARAMS ((const bfd_byte *));
3340   bfd_signed_vma (*bfd_getx_signed_32) PARAMS ((const bfd_byte *));
3341   void         (*bfd_putx32) PARAMS ((bfd_vma, bfd_byte *));
3342   bfd_vma      (*bfd_getx16) PARAMS ((const bfd_byte *));
3343   bfd_signed_vma (*bfd_getx_signed_16) PARAMS ((const bfd_byte *));
3344   void         (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *));
3345   bfd_vma      (*bfd_h_getx64) PARAMS ((const bfd_byte *));
3346   bfd_signed_vma (*bfd_h_getx_signed_64) PARAMS ((const bfd_byte *));
3347   void         (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *));
3348   bfd_vma      (*bfd_h_getx32) PARAMS ((const bfd_byte *));
3349   bfd_signed_vma (*bfd_h_getx_signed_32) PARAMS ((const bfd_byte *));
3350   void         (*bfd_h_putx32) PARAMS ((bfd_vma, bfd_byte *));
3351   bfd_vma      (*bfd_h_getx16) PARAMS ((const bfd_byte *));
3352   bfd_signed_vma (*bfd_h_getx_signed_16) PARAMS ((const bfd_byte *));
3353   void         (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *));
3354   const struct bfd_target *(*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *));
3355   boolean             (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *));
3356   boolean             (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *));
3357
3358   /* Generic entry points.  */
3359 #define BFD_JUMP_TABLE_GENERIC(NAME)\
3360 CAT(NAME,_close_and_cleanup),\
3361 CAT(NAME,_bfd_free_cached_info),\
3362 CAT(NAME,_new_section_hook),\
3363 CAT(NAME,_get_section_contents),\
3364 CAT(NAME,_get_section_contents_in_window)
3365
3366   /* Called when the BFD is being closed to do any necessary cleanup.  */
3367   boolean       (*_close_and_cleanup) PARAMS ((bfd *));
3368   /* Ask the BFD to free all cached information.  */
3369   boolean (*_bfd_free_cached_info) PARAMS ((bfd *));
3370   /* Called when a new section is created.  */
3371   boolean       (*_new_section_hook) PARAMS ((bfd *, sec_ptr));
3372   /* Read the contents of a section.  */
3373   boolean       (*_bfd_get_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
3374                                             file_ptr, bfd_size_type));
3375   boolean       (*_bfd_get_section_contents_in_window)
3376                           PARAMS ((bfd *, sec_ptr, bfd_window *,
3377                                    file_ptr, bfd_size_type));
3378
3379   /* Entry points to copy private data.  */
3380 #define BFD_JUMP_TABLE_COPY(NAME)\
3381 CAT(NAME,_bfd_copy_private_bfd_data),\
3382 CAT(NAME,_bfd_merge_private_bfd_data),\
3383 CAT(NAME,_bfd_copy_private_section_data),\
3384 CAT(NAME,_bfd_copy_private_symbol_data),\
3385 CAT(NAME,_bfd_set_private_flags),\
3386 CAT(NAME,_bfd_print_private_bfd_data)\
3387   /* Called to copy BFD general private data from one object file
3388      to another.  */
3389   boolean       (*_bfd_copy_private_bfd_data) PARAMS ((bfd *, bfd *));
3390   /* Called to merge BFD general private data from one object file
3391      to a common output file when linking.  */
3392   boolean       (*_bfd_merge_private_bfd_data) PARAMS ((bfd *, bfd *));
3393   /* Called to copy BFD private section data from one object file
3394      to another.  */
3395   boolean       (*_bfd_copy_private_section_data) PARAMS ((bfd *, sec_ptr,
3396                                                        bfd *, sec_ptr));
3397   /* Called to copy BFD private symbol data from one symbol
3398      to another.  */
3399   boolean       (*_bfd_copy_private_symbol_data) PARAMS ((bfd *, asymbol *,
3400                                                           bfd *, asymbol *));
3401   /* Called to set private backend flags */
3402   boolean       (*_bfd_set_private_flags) PARAMS ((bfd *, flagword));
3403
3404   /* Called to print private BFD data */
3405   boolean       (*_bfd_print_private_bfd_data) PARAMS ((bfd *, PTR));
3406
3407   /* Core file entry points.  */
3408 #define BFD_JUMP_TABLE_CORE(NAME)\
3409 CAT(NAME,_core_file_failing_command),\
3410 CAT(NAME,_core_file_failing_signal),\
3411 CAT(NAME,_core_file_matches_executable_p)
3412   char *   (*_core_file_failing_command) PARAMS ((bfd *));
3413   int      (*_core_file_failing_signal) PARAMS ((bfd *));
3414   boolean  (*_core_file_matches_executable_p) PARAMS ((bfd *, bfd *));
3415
3416   /* Archive entry points.  */
3417 #define BFD_JUMP_TABLE_ARCHIVE(NAME)\
3418 CAT(NAME,_slurp_armap),\
3419 CAT(NAME,_slurp_extended_name_table),\
3420 CAT(NAME,_construct_extended_name_table),\
3421 CAT(NAME,_truncate_arname),\
3422 CAT(NAME,_write_armap),\
3423 CAT(NAME,_read_ar_hdr),\
3424 CAT(NAME,_openr_next_archived_file),\
3425 CAT(NAME,_get_elt_at_index),\
3426 CAT(NAME,_generic_stat_arch_elt),\
3427 CAT(NAME,_update_armap_timestamp)
3428   boolean  (*_bfd_slurp_armap) PARAMS ((bfd *));
3429   boolean  (*_bfd_slurp_extended_name_table) PARAMS ((bfd *));
3430   boolean  (*_bfd_construct_extended_name_table)
3431              PARAMS ((bfd *, char **, bfd_size_type *, const char **));
3432   void     (*_bfd_truncate_arname) PARAMS ((bfd *, CONST char *, char *));
3433   boolean  (*write_armap) PARAMS ((bfd *arch,
3434                               unsigned int elength,
3435                               struct orl *map,
3436                               unsigned int orl_count,
3437                               int stridx));
3438   PTR (*_bfd_read_ar_hdr_fn) PARAMS ((bfd *));
3439   bfd *    (*openr_next_archived_file) PARAMS ((bfd *arch, bfd *prev));
3440 #define bfd_get_elt_at_index(b,i) BFD_SEND(b, _bfd_get_elt_at_index, (b,i))
3441   bfd *    (*_bfd_get_elt_at_index) PARAMS ((bfd *, symindex));
3442   int      (*_bfd_stat_arch_elt) PARAMS ((bfd *, struct stat *));
3443   boolean  (*_bfd_update_armap_timestamp) PARAMS ((bfd *));
3444
3445   /* Entry points used for symbols.  */
3446 #define BFD_JUMP_TABLE_SYMBOLS(NAME)\
3447 CAT(NAME,_get_symtab_upper_bound),\
3448 CAT(NAME,_get_symtab),\
3449 CAT(NAME,_make_empty_symbol),\
3450 CAT(NAME,_print_symbol),\
3451 CAT(NAME,_get_symbol_info),\
3452 CAT(NAME,_bfd_is_local_label_name),\
3453 CAT(NAME,_get_lineno),\
3454 CAT(NAME,_find_nearest_line),\
3455 CAT(NAME,_bfd_make_debug_symbol),\
3456 CAT(NAME,_read_minisymbols),\
3457 CAT(NAME,_minisymbol_to_symbol)
3458   long  (*_bfd_get_symtab_upper_bound) PARAMS ((bfd *));
3459   long  (*_bfd_canonicalize_symtab) PARAMS ((bfd *,
3460                                              struct symbol_cache_entry **));
3461   struct symbol_cache_entry  *
3462                 (*_bfd_make_empty_symbol) PARAMS ((bfd *));
3463   void          (*_bfd_print_symbol) PARAMS ((bfd *, PTR,
3464                                       struct symbol_cache_entry *,
3465                                       bfd_print_symbol_type));
3466 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
3467   void          (*_bfd_get_symbol_info) PARAMS ((bfd *,
3468                                       struct symbol_cache_entry *,
3469                                       symbol_info *));
3470 #define bfd_get_symbol_info(b,p,e) BFD_SEND(b, _bfd_get_symbol_info, (b,p,e))
3471   boolean       (*_bfd_is_local_label_name) PARAMS ((bfd *, const char *));
3472
3473   alent *    (*_get_lineno) PARAMS ((bfd *, struct symbol_cache_entry *));
3474   boolean    (*_bfd_find_nearest_line) PARAMS ((bfd *abfd,
3475                     struct sec *section, struct symbol_cache_entry **symbols,
3476                     bfd_vma offset, CONST char **file, CONST char **func,
3477                     unsigned int *line));
3478  /* Back-door to allow format-aware applications to create debug symbols
3479     while using BFD for everything else.  Currently used by the assembler
3480     when creating COFF files.  */
3481   asymbol *  (*_bfd_make_debug_symbol) PARAMS ((
3482        bfd *abfd,
3483        void *ptr,
3484        unsigned long size));
3485 #define bfd_read_minisymbols(b, d, m, s) \
3486   BFD_SEND (b, _read_minisymbols, (b, d, m, s))
3487   long  (*_read_minisymbols) PARAMS ((bfd *, boolean, PTR *,
3488                                       unsigned int *));
3489 #define bfd_minisymbol_to_symbol(b, d, m, f) \
3490   BFD_SEND (b, _minisymbol_to_symbol, (b, d, m, f))
3491   asymbol *(*_minisymbol_to_symbol) PARAMS ((bfd *, boolean, const PTR,
3492                                              asymbol *));
3493
3494   /* Routines for relocs.  */
3495 #define BFD_JUMP_TABLE_RELOCS(NAME)\
3496 CAT(NAME,_get_reloc_upper_bound),\
3497 CAT(NAME,_canonicalize_reloc),\
3498 CAT(NAME,_bfd_reloc_type_lookup)
3499   long  (*_get_reloc_upper_bound) PARAMS ((bfd *, sec_ptr));
3500   long  (*_bfd_canonicalize_reloc) PARAMS ((bfd *, sec_ptr, arelent **,
3501                                             struct symbol_cache_entry **));
3502   /* See documentation on reloc types.  */
3503   reloc_howto_type *
3504        (*reloc_type_lookup) PARAMS ((bfd *abfd,
3505                                      bfd_reloc_code_real_type code));
3506
3507   /* Routines used when writing an object file.  */
3508 #define BFD_JUMP_TABLE_WRITE(NAME)\
3509 CAT(NAME,_set_arch_mach),\
3510 CAT(NAME,_set_section_contents)
3511   boolean    (*_bfd_set_arch_mach) PARAMS ((bfd *, enum bfd_architecture,
3512                     unsigned long));
3513   boolean       (*_bfd_set_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
3514                                             file_ptr, bfd_size_type));
3515
3516   /* Routines used by the linker.  */
3517 #define BFD_JUMP_TABLE_LINK(NAME)\
3518 CAT(NAME,_sizeof_headers),\
3519 CAT(NAME,_bfd_get_relocated_section_contents),\
3520 CAT(NAME,_bfd_relax_section),\
3521 CAT(NAME,_bfd_link_hash_table_create),\
3522 CAT(NAME,_bfd_link_add_symbols),\
3523 CAT(NAME,_bfd_final_link),\
3524 CAT(NAME,_bfd_link_split_section),\
3525 CAT(NAME,_bfd_gc_sections)
3526   int        (*_bfd_sizeof_headers) PARAMS ((bfd *, boolean));
3527   bfd_byte * (*_bfd_get_relocated_section_contents) PARAMS ((bfd *,
3528                     struct bfd_link_info *, struct bfd_link_order *,
3529                     bfd_byte *data, boolean relocateable,
3530                     struct symbol_cache_entry **));
3531
3532   boolean    (*_bfd_relax_section) PARAMS ((bfd *, struct sec *,
3533                     struct bfd_link_info *, boolean *again));
3534
3535   /* Create a hash table for the linker.  Different backends store
3536      different information in this table.  */
3537   struct bfd_link_hash_table *(*_bfd_link_hash_table_create) PARAMS ((bfd *));
3538
3539   /* Add symbols from this object file into the hash table.  */
3540   boolean (*_bfd_link_add_symbols) PARAMS ((bfd *, struct bfd_link_info *));
3541
3542   /* Do a link based on the link_order structures attached to each
3543      section of the BFD.  */
3544   boolean (*_bfd_final_link) PARAMS ((bfd *, struct bfd_link_info *));
3545
3546   /* Should this section be split up into smaller pieces during linking.  */
3547   boolean (*_bfd_link_split_section) PARAMS ((bfd *, struct sec *));
3548
3549   /* Remove sections that are not referenced from the output.  */
3550   boolean (*_bfd_gc_sections) PARAMS ((bfd *, struct bfd_link_info *));
3551
3552   /* Routines to handle dynamic symbols and relocs.  */
3553 #define BFD_JUMP_TABLE_DYNAMIC(NAME)\
3554 CAT(NAME,_get_dynamic_symtab_upper_bound),\
3555 CAT(NAME,_canonicalize_dynamic_symtab),\
3556 CAT(NAME,_get_dynamic_reloc_upper_bound),\
3557 CAT(NAME,_canonicalize_dynamic_reloc)
3558   /* Get the amount of memory required to hold the dynamic symbols. */
3559   long  (*_bfd_get_dynamic_symtab_upper_bound) PARAMS ((bfd *));
3560   /* Read in the dynamic symbols.  */
3561   long  (*_bfd_canonicalize_dynamic_symtab)
3562     PARAMS ((bfd *, struct symbol_cache_entry **));
3563   /* Get the amount of memory required to hold the dynamic relocs.  */
3564   long  (*_bfd_get_dynamic_reloc_upper_bound) PARAMS ((bfd *));
3565   /* Read in the dynamic relocs.  */
3566   long  (*_bfd_canonicalize_dynamic_reloc)
3567     PARAMS ((bfd *, arelent **, struct symbol_cache_entry **));
3568
3569  /* Opposite endian version of this target.  */
3570  const struct bfd_target * alternative_target;
3571
3572  PTR backend_data;
3573
3574 } bfd_target;
3575 boolean
3576 bfd_set_default_target PARAMS ((const char *name));
3577
3578 const bfd_target *
3579 bfd_find_target PARAMS ((CONST char *target_name, bfd *abfd));
3580
3581 const char **
3582 bfd_target_list PARAMS ((void));
3583
3584 const bfd_target *
3585 bfd_search_for_target PARAMS ((int (* search_func) (const bfd_target *, void *), void *));
3586
3587 boolean
3588 bfd_check_format PARAMS ((bfd *abfd, bfd_format format));
3589
3590 boolean
3591 bfd_check_format_matches PARAMS ((bfd *abfd, bfd_format format, char ***matching));
3592
3593 boolean
3594 bfd_set_format PARAMS ((bfd *abfd, bfd_format format));
3595
3596 CONST char *
3597 bfd_format_string PARAMS ((bfd_format format));
3598
3599 #ifdef __cplusplus
3600 }
3601 #endif
3602 #endif