start-sanitize-d10v
[external/binutils.git] / bfd / bfd-in2.h
1 /* Main header file for the bfd library -- portable access to object files.
2    Copyright 1990, 91, 92, 93, 94, 95, 1996 Free Software Foundation, Inc.
3    Contributed by Cygnus Support.
4
5 ** NOTE: bfd.h and bfd-in2.h are GENERATED files.  Don't change them;
6 ** instead, change bfd-in.h or the other BFD source files processed to
7 ** generate these files.
8
9 This file is part of BFD, the Binary File Descriptor library.
10
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
15
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 GNU General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
24
25 /* bfd.h -- The only header file required by users of the bfd library 
26
27 The bfd.h file is generated from bfd-in.h and various .c files; if you
28 change it, your changes will probably be lost.
29
30 All the prototypes and definitions following the comment "THE FOLLOWING
31 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
32 BFD.  If you change it, someone oneday will extract it from the source
33 again, and your changes will be lost.  To save yourself from this bind,
34 change the definitions in the source in the bfd directory.  Type "make
35 docs" and then "make headers" in that directory, and magically this file
36 will change to reflect your changes.
37
38 If you don't have the tools to perform the extraction, then you are
39 safe from someone on your system trampling over your header files.
40 You should still maintain the equivalence between the source and this
41 file though; every change you make to the .c file should be reflected
42 here.  */
43
44 #ifndef __BFD_H_SEEN__
45 #define __BFD_H_SEEN__
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 #include "ansidecl.h"
52 #include "obstack.h"
53
54 /* These two lines get substitutions done by commands in Makefile.in.  */
55 #define BFD_VERSION  "@VERSION@"
56 #define BFD_ARCH_SIZE @WORDSIZE@
57 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
58
59 #if BFD_ARCH_SIZE >= 64
60 #define BFD64
61 #endif
62
63 #ifndef INLINE
64 #if __GNUC__ >= 2
65 #define INLINE __inline__
66 #else
67 #define INLINE
68 #endif
69 #endif
70
71 /* forward declaration */
72 typedef struct _bfd bfd;
73
74 /* To squelch erroneous compiler warnings ("illegal pointer
75    combination") from the SVR3 compiler, we would like to typedef
76    boolean to int (it doesn't like functions which return boolean.
77    Making sure they are never implicitly declared to return int
78    doesn't seem to help).  But this file is not configured based on
79    the host.  */
80 /* General rules: functions which are boolean return true on success
81    and false on failure (unless they're a predicate).   -- bfd.doc */
82 /* I'm sure this is going to break something and someone is going to
83    force me to change it. */
84 /* typedef enum boolean {false, true} boolean; */
85 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
86 /* It gets worse if the host also defines a true/false enum... -sts */
87 /* And even worse if your compiler has built-in boolean types... -law */
88 #if defined (__GNUG__) && (__GNUC_MINOR__ > 5)
89 #define TRUE_FALSE_ALREADY_DEFINED
90 #endif
91 #ifdef MPW
92 /* Pre-emptive strike - get the file with the enum. */
93 #include <Types.h>
94 #define TRUE_FALSE_ALREADY_DEFINED
95 #endif /* MPW */
96 #ifndef TRUE_FALSE_ALREADY_DEFINED
97 typedef enum bfd_boolean {false, true} boolean;
98 #define BFD_TRUE_FALSE
99 #else
100 /* Use enum names that will appear nowhere else.  */
101 typedef enum bfd_boolean {bfd_fffalse, bfd_tttrue} boolean;
102 #endif
103
104 /* A pointer to a position in a file.  */
105 /* FIXME:  This should be using off_t from <sys/types.h>.
106    For now, try to avoid breaking stuff by not including <sys/types.h> here.
107    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
108    Probably the best long-term answer is to avoid using file_ptr AND off_t 
109    in this header file, and to handle this in the BFD implementation
110    rather than in its interface.  */
111 /* typedef off_t        file_ptr; */
112 typedef long int file_ptr;
113
114 /* Support for different sizes of target format ints and addresses.
115    If the type `long' is at least 64 bits, BFD_HOST_64BIT_LONG will be
116    set to 1 above.  Otherwise, if gcc is being used, this code will
117    use gcc's "long long" type.  Otherwise, the compilation will fail
118    if 64-bit targets are requested.  */
119
120 #ifdef BFD64
121
122 #ifndef BFD_HOST_64_BIT
123 #if BFD_HOST_64BIT_LONG
124 #define BFD_HOST_64_BIT long
125 #else
126 #ifdef __GNUC__
127 #define BFD_HOST_64_BIT long long
128 #else /* ! defined (__GNUC__) */
129  #error No 64 bit integer type available
130 #endif /* ! defined (__GNUC__) */
131 #endif /* ! BFD_HOST_64BIT_LONG */
132 #endif /* ! defined (BFD_HOST_64_BIT) */
133
134 typedef unsigned BFD_HOST_64_BIT bfd_vma;
135 typedef BFD_HOST_64_BIT bfd_signed_vma;
136 typedef unsigned BFD_HOST_64_BIT bfd_size_type;
137 typedef unsigned BFD_HOST_64_BIT symvalue;
138
139 #ifndef fprintf_vma
140 #if BFD_HOST_64BIT_LONG
141 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
142 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
143 #else
144 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
145 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
146 #define fprintf_vma(s,x) \
147   fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
148 #define sprintf_vma(s,x) \
149   sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
150 #endif
151 #endif
152
153 #else /* not BFD64  */
154
155 /* Represent a target address.  Also used as a generic unsigned type
156    which is guaranteed to be big enough to hold any arithmetic types
157    we need to deal with.  */
158 typedef unsigned long bfd_vma;
159
160 /* A generic signed type which is guaranteed to be big enough to hold any
161    arithmetic types we need to deal with.  Can be assumed to be compatible
162    with bfd_vma in the same way that signed and unsigned ints are compatible
163    (as parameters, in assignment, etc).  */
164 typedef long bfd_signed_vma;
165
166 typedef unsigned long symvalue;
167 typedef unsigned long bfd_size_type;
168
169 /* Print a bfd_vma x on stream s.  */
170 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
171 #define sprintf_vma(s,x) sprintf(s, "%08lx", x)
172 #endif /* not BFD64  */
173 #define printf_vma(x) fprintf_vma(stdout,x)
174
175 typedef unsigned int flagword;  /* 32 bits of flags */
176 typedef unsigned char bfd_byte;
177 \f
178 /** File formats */
179
180 typedef enum bfd_format {
181               bfd_unknown = 0,  /* file format is unknown */
182               bfd_object,       /* linker/assember/compiler output */
183               bfd_archive,      /* object archive file */
184               bfd_core,         /* core dump */
185               bfd_type_end}     /* marks the end; don't use it! */
186          bfd_format;
187
188 /* Values that may appear in the flags field of a BFD.  These also
189    appear in the object_flags field of the bfd_target structure, where
190    they indicate the set of flags used by that backend (not all flags
191    are meaningful for all object file formats) (FIXME: at the moment,
192    the object_flags values have mostly just been copied from backend
193    to another, and are not necessarily correct).  */
194
195 /* No flags.  */
196 #define NO_FLAGS        0x00
197
198 /* BFD contains relocation entries.  */
199 #define HAS_RELOC       0x01
200
201 /* BFD is directly executable.  */
202 #define EXEC_P          0x02
203
204 /* BFD has line number information (basically used for F_LNNO in a
205    COFF header).  */
206 #define HAS_LINENO      0x04
207
208 /* BFD has debugging information.  */
209 #define HAS_DEBUG       0x08
210
211 /* BFD has symbols.  */
212 #define HAS_SYMS        0x10
213
214 /* BFD has local symbols (basically used for F_LSYMS in a COFF
215    header).  */
216 #define HAS_LOCALS      0x20
217
218 /* BFD is a dynamic object.  */
219 #define DYNAMIC         0x40
220
221 /* Text section is write protected (if D_PAGED is not set, this is
222    like an a.out NMAGIC file) (the linker sets this by default, but
223    clears it for -r or -N).  */
224 #define WP_TEXT         0x80
225
226 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
227    linker sets this by default, but clears it for -r or -n or -N).  */
228 #define D_PAGED         0x100
229
230 /* BFD is relaxable (this means that bfd_relax_section may be able to
231    do something) (sometimes bfd_relax_section can do something even if
232    this is not set).  */
233 #define BFD_IS_RELAXABLE 0x200
234
235 /* This may be set before writing out a BFD to request using a
236    traditional format.  For example, this is used to request that when
237    writing out an a.out object the symbols not be hashed to eliminate
238    duplicates.  */
239 #define BFD_TRADITIONAL_FORMAT 0x400
240
241 /* This flag indicates that the BFD contents are actually cached in
242    memory.  If this is set, iostream points to a bfd_in_memory struct.  */
243 #define BFD_IN_MEMORY 0x800
244 \f
245 /* symbols and relocation */
246
247 /* A count of carsyms (canonical archive symbols).  */
248 typedef unsigned long symindex;
249
250 /* How to perform a relocation.  */
251 typedef const struct reloc_howto_struct reloc_howto_type;
252
253 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
254
255 /* General purpose part of a symbol X;
256    target specific parts are in libcoff.h, libaout.h, etc.  */
257
258 #define bfd_get_section(x) ((x)->section)
259 #define bfd_get_output_section(x) ((x)->section->output_section)
260 #define bfd_set_section(x,y) ((x)->section) = (y)
261 #define bfd_asymbol_base(x) ((x)->section->vma)
262 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
263 #define bfd_asymbol_name(x) ((x)->name)
264 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
265 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
266 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
267
268 /* A canonical archive symbol.  */
269 /* This is a type pun with struct ranlib on purpose! */
270 typedef struct carsym {
271   char *name;
272   file_ptr file_offset;         /* look here to find the file */
273 } carsym;                       /* to make these you call a carsymogen */
274
275   
276 /* Used in generating armaps (archive tables of contents).
277    Perhaps just a forward definition would do? */
278 struct orl {                    /* output ranlib */
279   char **name;                  /* symbol name */ 
280   file_ptr pos;                 /* bfd* or file position */
281   int namidx;                   /* index into string table */
282 };
283 \f
284
285 /* Linenumber stuff */
286 typedef struct lineno_cache_entry {
287   unsigned int line_number;     /* Linenumber from start of function*/  
288   union {
289     struct symbol_cache_entry *sym; /* Function name */
290     unsigned long offset;       /* Offset into section */
291   } u;
292 } alent;
293 \f
294 /* object and core file sections */
295
296 #define align_power(addr, align)        \
297         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
298
299 typedef struct sec *sec_ptr;
300
301 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
302 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
303 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
304 #define bfd_section_name(bfd, ptr) ((ptr)->name)
305 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
306 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
307 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
308 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
309 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
310
311 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
312
313 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = (boolean)true), true)
314 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
315 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
316
317 typedef struct stat stat_type; 
318 \f
319 typedef enum bfd_print_symbol
320
321   bfd_print_symbol_name,
322   bfd_print_symbol_more,
323   bfd_print_symbol_all
324 } bfd_print_symbol_type;
325     
326 /* Information about a symbol that nm needs.  */
327
328 typedef struct _symbol_info
329 {
330   symvalue value;
331   char type;
332   CONST char *name;            /* Symbol name.  */
333   unsigned char stab_type;     /* Stab type.  */
334   char stab_other;             /* Stab other. */
335   short stab_desc;             /* Stab desc.  */
336   CONST char *stab_name;       /* String for stab type.  */
337 } symbol_info;
338
339 /* Get the name of a stabs type code.  */
340
341 extern const char *bfd_get_stab_name PARAMS ((int));
342 \f
343 /* Hash table routines.  There is no way to free up a hash table.  */
344
345 /* An element in the hash table.  Most uses will actually use a larger
346    structure, and an instance of this will be the first field.  */
347
348 struct bfd_hash_entry
349 {
350   /* Next entry for this hash code.  */
351   struct bfd_hash_entry *next;
352   /* String being hashed.  */
353   const char *string;
354   /* Hash code.  This is the full hash code, not the index into the
355      table.  */
356   unsigned long hash;
357 };
358
359 /* A hash table.  */
360
361 struct bfd_hash_table
362 {
363   /* The hash array.  */
364   struct bfd_hash_entry **table;
365   /* The number of slots in the hash table.  */
366   unsigned int size;
367   /* A function used to create new elements in the hash table.  The
368      first entry is itself a pointer to an element.  When this
369      function is first invoked, this pointer will be NULL.  However,
370      having the pointer permits a hierarchy of method functions to be
371      built each of which calls the function in the superclass.  Thus
372      each function should be written to allocate a new block of memory
373      only if the argument is NULL.  */
374   struct bfd_hash_entry *(*newfunc) PARAMS ((struct bfd_hash_entry *,
375                                              struct bfd_hash_table *,
376                                              const char *));
377   /* An obstack for this hash table.  */
378   struct obstack memory;
379 };
380
381 /* Initialize a hash table.  */
382 extern boolean bfd_hash_table_init
383   PARAMS ((struct bfd_hash_table *,
384            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
385                                        struct bfd_hash_table *,
386                                        const char *)));
387
388 /* Initialize a hash table specifying a size.  */
389 extern boolean bfd_hash_table_init_n
390   PARAMS ((struct bfd_hash_table *,
391            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
392                                        struct bfd_hash_table *,
393                                        const char *),
394            unsigned int size));
395
396 /* Free up a hash table.  */
397 extern void bfd_hash_table_free PARAMS ((struct bfd_hash_table *));
398
399 /* Look up a string in a hash table.  If CREATE is true, a new entry
400    will be created for this string if one does not already exist.  The
401    COPY argument must be true if this routine should copy the string
402    into newly allocated memory when adding an entry.  */
403 extern struct bfd_hash_entry *bfd_hash_lookup
404   PARAMS ((struct bfd_hash_table *, const char *, boolean create,
405            boolean copy));
406
407 /* Replace an entry in a hash table.  */
408 extern void bfd_hash_replace
409   PARAMS ((struct bfd_hash_table *, struct bfd_hash_entry *old,
410            struct bfd_hash_entry *nw));
411
412 /* Base method for creating a hash table entry.  */
413 extern struct bfd_hash_entry *bfd_hash_newfunc
414   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *,
415            const char *));
416
417 /* Grab some space for a hash table entry.  */
418 extern PTR bfd_hash_allocate PARAMS ((struct bfd_hash_table *,
419                                       unsigned int));
420
421 /* Traverse a hash table in a random order, calling a function on each
422    element.  If the function returns false, the traversal stops.  The
423    INFO argument is passed to the function.  */
424 extern void bfd_hash_traverse PARAMS ((struct bfd_hash_table *,
425                                        boolean (*) (struct bfd_hash_entry *,
426                                                     PTR),
427                                        PTR info));
428 \f
429 /* Semi-portable string concatenation in cpp.
430    The CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
431    The problem is, "32_" is not a valid preprocessing token, and we don't
432    want extra underscores (e.g., "nlm_32_").  The XCAT2 macro will cause the
433    inner CAT macros to be evaluated first, producing still-valid pp-tokens.
434    Then the final concatenation can be done.  (Sigh.)  */
435 #ifndef CAT
436 #ifdef SABER
437 #define CAT(a,b)        a##b
438 #define CAT3(a,b,c)     a##b##c
439 #define CAT4(a,b,c,d)   a##b##c##d
440 #else
441 #if defined(__STDC__) || defined(ALMOST_STDC)
442 #define CAT(a,b) a##b
443 #define CAT3(a,b,c) a##b##c
444 #define XCAT2(a,b)      CAT(a,b)
445 #define CAT4(a,b,c,d)   XCAT2(CAT(a,b),CAT(c,d))
446 #else
447 #define CAT(a,b) a/**/b
448 #define CAT3(a,b,c) a/**/b/**/c
449 #define CAT4(a,b,c,d)   a/**/b/**/c/**/d
450 #endif
451 #endif
452 #endif
453
454 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
455 \f
456 /* User program access to BFD facilities */
457
458 /* Direct I/O routines, for programs which know more about the object
459    file than BFD does.  Use higher level routines if possible.  */
460
461 extern bfd_size_type bfd_read
462   PARAMS ((PTR, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
463 extern bfd_size_type bfd_write
464   PARAMS ((const PTR, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
465 extern int bfd_seek PARAMS ((bfd *abfd, file_ptr fp, int direction));
466 extern long bfd_tell PARAMS ((bfd *abfd));
467 extern int bfd_flush PARAMS ((bfd *abfd));
468 extern int bfd_stat PARAMS ((bfd *abfd, struct stat *));
469
470
471 /* Cast from const char * to char * so that caller can assign to
472    a char * without a warning.  */
473 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
474 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
475 #define bfd_get_format(abfd) ((abfd)->format)
476 #define bfd_get_target(abfd) ((abfd)->xvec->name)
477 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
478 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
479 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
480 #define bfd_header_big_endian(abfd) \
481   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
482 #define bfd_header_little_endian(abfd) \
483   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
484 #define bfd_get_file_flags(abfd) ((abfd)->flags)
485 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
486 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
487 #define bfd_my_archive(abfd) ((abfd)->my_archive)
488 #define bfd_has_map(abfd) ((abfd)->has_armap)
489
490 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
491 #define bfd_usrdata(abfd) ((abfd)->usrdata)
492
493 #define bfd_get_start_address(abfd) ((abfd)->start_address)
494 #define bfd_get_symcount(abfd) ((abfd)->symcount)
495 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
496 #define bfd_count_sections(abfd) ((abfd)->section_count)
497
498 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
499
500 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (boolean)(bool)), true)
501
502 extern boolean bfd_record_phdr
503   PARAMS ((bfd *, unsigned long, boolean, flagword, boolean, bfd_vma,
504            boolean, boolean, unsigned int, struct sec **));
505
506 /* Byte swapping routines.  */
507
508 bfd_vma         bfd_getb64         PARAMS ((const unsigned char *));
509 bfd_vma         bfd_getl64         PARAMS ((const unsigned char *));
510 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((const unsigned char *));
511 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((const unsigned char *));
512 bfd_vma         bfd_getb32         PARAMS ((const unsigned char *));
513 bfd_vma         bfd_getl32         PARAMS ((const unsigned char *));
514 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((const unsigned char *));
515 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((const unsigned char *));
516 bfd_vma         bfd_getb16         PARAMS ((const unsigned char *));
517 bfd_vma         bfd_getl16         PARAMS ((const unsigned char *));
518 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((const unsigned char *));
519 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((const unsigned char *));
520 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
521 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
522 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
523 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
524 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
525 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
526 \f
527 /* Externally visible ECOFF routines.  */
528
529 #if defined(__STDC__) || defined(ALMOST_STDC)
530 struct ecoff_debug_info;
531 struct ecoff_debug_swap;
532 struct ecoff_extr;
533 struct symbol_cache_entry;
534 struct bfd_link_info;
535 struct bfd_link_hash_entry;
536 #endif
537 extern bfd_vma bfd_ecoff_get_gp_value PARAMS ((bfd * abfd));
538 extern boolean bfd_ecoff_set_gp_value PARAMS ((bfd *abfd, bfd_vma gp_value));
539 extern boolean bfd_ecoff_set_regmasks
540   PARAMS ((bfd *abfd, unsigned long gprmask, unsigned long fprmask,
541            unsigned long *cprmask));
542 extern PTR bfd_ecoff_debug_init
543   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
544            const struct ecoff_debug_swap *output_swap,
545            struct bfd_link_info *));
546 extern void bfd_ecoff_debug_free
547   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
548            const struct ecoff_debug_swap *output_swap,
549            struct bfd_link_info *));
550 extern boolean bfd_ecoff_debug_accumulate
551   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
552            const struct ecoff_debug_swap *output_swap,
553            bfd *input_bfd, struct ecoff_debug_info *input_debug,
554            const struct ecoff_debug_swap *input_swap,
555            struct bfd_link_info *));
556 extern boolean bfd_ecoff_debug_accumulate_other
557   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
558            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
559            struct bfd_link_info *));
560 extern boolean bfd_ecoff_debug_externals
561   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
562            const struct ecoff_debug_swap *swap,
563            boolean relocateable,
564            boolean (*get_extr) (struct symbol_cache_entry *,
565                                 struct ecoff_extr *),
566            void (*set_index) (struct symbol_cache_entry *,
567                               bfd_size_type)));
568 extern boolean bfd_ecoff_debug_one_external
569   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
570            const struct ecoff_debug_swap *swap,
571            const char *name, struct ecoff_extr *esym));
572 extern bfd_size_type bfd_ecoff_debug_size
573   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
574            const struct ecoff_debug_swap *swap));
575 extern boolean bfd_ecoff_write_debug
576   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
577            const struct ecoff_debug_swap *swap, file_ptr where));
578 extern boolean bfd_ecoff_write_accumulated_debug
579   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
580            const struct ecoff_debug_swap *swap,
581            struct bfd_link_info *info, file_ptr where));
582 extern boolean bfd_mips_ecoff_create_embedded_relocs
583   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
584            char **));
585
586 /* Externally visible ELF routines.  */
587
588 struct bfd_link_needed_list
589 {
590   struct bfd_link_needed_list *next;
591   bfd *by;
592   const char *name;
593 };
594
595 extern boolean bfd_elf32_record_link_assignment
596   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
597 extern boolean bfd_elf64_record_link_assignment
598   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
599 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
600   PARAMS ((bfd *, struct bfd_link_info *));
601 extern boolean bfd_elf32_size_dynamic_sections
602   PARAMS ((bfd *, const char *, const char *, boolean,
603            struct bfd_link_info *, struct sec **));
604 extern boolean bfd_elf64_size_dynamic_sections
605   PARAMS ((bfd *, const char *, const char *, boolean,
606            struct bfd_link_info *, struct sec **));
607 extern void bfd_elf_set_dt_needed_name PARAMS ((bfd *, const char *));
608 extern const char *bfd_elf_get_dt_soname PARAMS ((bfd *));
609
610 /* SunOS shared library support routines for the linker.  */
611
612 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
613   PARAMS ((bfd *, struct bfd_link_info *));
614 extern boolean bfd_sunos_record_link_assignment
615   PARAMS ((bfd *, struct bfd_link_info *, const char *));
616 extern boolean bfd_sunos_size_dynamic_sections
617   PARAMS ((bfd *, struct bfd_link_info *, struct sec **, struct sec **,
618            struct sec **));
619
620 /* Linux shared library support routines for the linker.  */
621
622 extern boolean bfd_i386linux_size_dynamic_sections
623   PARAMS ((bfd *, struct bfd_link_info *));
624 extern boolean bfd_m68klinux_size_dynamic_sections
625   PARAMS ((bfd *, struct bfd_link_info *));
626
627 /* mmap hacks */
628
629 struct _bfd_window_internal;
630 typedef struct _bfd_window_internal bfd_window_internal;
631
632 typedef struct _bfd_window {
633   /* What the user asked for.  */
634   PTR data;
635   bfd_size_type size;
636   /* The actual window used by BFD.  Small user-requested read-only
637      regions sharing a page may share a single window into the object
638      file.  Read-write versions shouldn't until I've fixed things to
639      keep track of which portions have been claimed by the
640      application; don't want to give the same region back when the
641      application wants two writable copies!  */
642   struct _bfd_window_internal *i;
643 } bfd_window;
644
645 extern void bfd_init_window PARAMS ((bfd_window *));
646 extern void bfd_free_window PARAMS ((bfd_window *));
647 extern boolean bfd_get_file_window
648   PARAMS ((bfd *, file_ptr, bfd_size_type, bfd_window *, boolean));
649
650 /* XCOFF support routines for the linker.  */
651
652 extern boolean bfd_xcoff_link_record_set
653   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
654            bfd_size_type));
655 extern boolean bfd_xcoff_import_symbol
656   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
657            bfd_vma, const char *, const char *, const char *));
658 extern boolean bfd_xcoff_export_symbol
659   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
660            boolean));
661 extern boolean bfd_xcoff_link_count_reloc
662   PARAMS ((bfd *, struct bfd_link_info *, const char *));
663 extern boolean bfd_xcoff_record_link_assignment
664   PARAMS ((bfd *, struct bfd_link_info *, const char *));
665 extern boolean bfd_xcoff_size_dynamic_sections
666   PARAMS ((bfd *, struct bfd_link_info *, const char *, const char *,
667            unsigned long, unsigned long, unsigned long, boolean,
668            int, boolean, boolean, struct sec **));
669
670 /* Externally visible COFF routines.  */
671
672 #if defined(__STDC__) || defined(ALMOST_STDC)
673 struct internal_syment;
674 union internal_auxent;
675 #endif
676
677 extern boolean bfd_coff_get_syment
678   PARAMS ((bfd *, struct symbol_cache_entry *, struct internal_syment *));
679 extern boolean bfd_coff_get_auxent
680   PARAMS ((bfd *, struct symbol_cache_entry *, int, union internal_auxent *));
681
682 /* And more from the source.  */
683 void 
684 bfd_init PARAMS ((void));
685
686 bfd *
687 bfd_openr PARAMS ((CONST char *filename, CONST char *target));
688
689 bfd *
690 bfd_fdopenr PARAMS ((CONST char *filename, CONST char *target, int fd));
691
692 bfd *
693 bfd_openstreamr PARAMS (());
694
695 bfd *
696 bfd_openw PARAMS ((CONST char *filename, CONST char *target));
697
698 boolean 
699 bfd_close PARAMS ((bfd *abfd));
700
701 boolean 
702 bfd_close_all_done PARAMS ((bfd *));
703
704 bfd_size_type 
705 bfd_alloc_size PARAMS ((bfd *abfd));
706
707 bfd *
708 bfd_create PARAMS ((CONST char *filename, bfd *templ));
709
710
711  /* Byte swapping macros for user section data.  */
712
713 #define bfd_put_8(abfd, val, ptr) \
714                 (*((unsigned char *)(ptr)) = (unsigned char)(val))
715 #define bfd_put_signed_8 \
716                 bfd_put_8
717 #define bfd_get_8(abfd, ptr) \
718                 (*(unsigned char *)(ptr))
719 #define bfd_get_signed_8(abfd, ptr) \
720                 ((*(unsigned char *)(ptr) ^ 0x80) - 0x80)
721
722 #define bfd_put_16(abfd, val, ptr) \
723                 BFD_SEND(abfd, bfd_putx16, ((val),(ptr)))
724 #define bfd_put_signed_16 \
725                  bfd_put_16
726 #define bfd_get_16(abfd, ptr) \
727                 BFD_SEND(abfd, bfd_getx16, (ptr))
728 #define bfd_get_signed_16(abfd, ptr) \
729                  BFD_SEND (abfd, bfd_getx_signed_16, (ptr))
730
731 #define bfd_put_32(abfd, val, ptr) \
732                 BFD_SEND(abfd, bfd_putx32, ((val),(ptr)))
733 #define bfd_put_signed_32 \
734                  bfd_put_32
735 #define bfd_get_32(abfd, ptr) \
736                 BFD_SEND(abfd, bfd_getx32, (ptr))
737 #define bfd_get_signed_32(abfd, ptr) \
738                  BFD_SEND(abfd, bfd_getx_signed_32, (ptr))
739
740 #define bfd_put_64(abfd, val, ptr) \
741                 BFD_SEND(abfd, bfd_putx64, ((val), (ptr)))
742 #define bfd_put_signed_64 \
743                  bfd_put_64
744 #define bfd_get_64(abfd, ptr) \
745                 BFD_SEND(abfd, bfd_getx64, (ptr))
746 #define bfd_get_signed_64(abfd, ptr) \
747                  BFD_SEND(abfd, bfd_getx_signed_64, (ptr))
748
749
750  /* Byte swapping macros for file header data.  */
751
752 #define bfd_h_put_8(abfd, val, ptr) \
753                 bfd_put_8 (abfd, val, ptr)
754 #define bfd_h_put_signed_8(abfd, val, ptr) \
755                 bfd_put_8 (abfd, val, ptr)
756 #define bfd_h_get_8(abfd, ptr) \
757                 bfd_get_8 (abfd, ptr)
758 #define bfd_h_get_signed_8(abfd, ptr) \
759                 bfd_get_signed_8 (abfd, ptr)
760
761 #define bfd_h_put_16(abfd, val, ptr) \
762                 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
763 #define bfd_h_put_signed_16 \
764                  bfd_h_put_16
765 #define bfd_h_get_16(abfd, ptr) \
766                 BFD_SEND(abfd, bfd_h_getx16,(ptr))
767 #define bfd_h_get_signed_16(abfd, ptr) \
768                  BFD_SEND(abfd, bfd_h_getx_signed_16, (ptr))
769
770 #define bfd_h_put_32(abfd, val, ptr) \
771                 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
772 #define bfd_h_put_signed_32 \
773                  bfd_h_put_32
774 #define bfd_h_get_32(abfd, ptr) \
775                 BFD_SEND(abfd, bfd_h_getx32,(ptr))
776 #define bfd_h_get_signed_32(abfd, ptr) \
777                  BFD_SEND(abfd, bfd_h_getx_signed_32, (ptr))
778
779 #define bfd_h_put_64(abfd, val, ptr) \
780                 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
781 #define bfd_h_put_signed_64 \
782                  bfd_h_put_64
783 #define bfd_h_get_64(abfd, ptr) \
784                 BFD_SEND(abfd, bfd_h_getx64,(ptr))
785 #define bfd_h_get_signed_64(abfd, ptr) \
786                  BFD_SEND(abfd, bfd_h_getx_signed_64, (ptr))
787
788 typedef struct sec
789 {
790          /* The name of the section; the name isn't a copy, the pointer is
791         the same as that passed to bfd_make_section. */
792
793     CONST char *name;
794
795          /* Which section is it; 0..nth.      */
796
797    int index;
798
799          /* The next section in the list belonging to the BFD, or NULL. */
800
801     struct sec *next;
802
803          /* The field flags contains attributes of the section. Some
804            flags are read in from the object file, and some are
805            synthesized from other information.  */
806
807     flagword flags;
808
809 #define SEC_NO_FLAGS   0x000
810
811          /* Tells the OS to allocate space for this section when loading.
812            This is clear for a section containing debug information
813            only. */
814 #define SEC_ALLOC      0x001
815
816          /* Tells the OS to load the section from the file when loading.
817            This is clear for a .bss section. */
818 #define SEC_LOAD       0x002
819
820          /* The section contains data still to be relocated, so there is
821            some relocation information too. */
822 #define SEC_RELOC      0x004
823
824 #if 0    /* Obsolete ? */
825 #define SEC_BALIGN     0x008
826 #endif
827
828          /* A signal to the OS that the section contains read only
829           data. */
830 #define SEC_READONLY   0x010
831
832          /* The section contains code only. */
833 #define SEC_CODE       0x020
834
835          /* The section contains data only. */
836 #define SEC_DATA       0x040
837
838          /* The section will reside in ROM. */
839 #define SEC_ROM        0x080
840
841          /* The section contains constructor information. This section
842            type is used by the linker to create lists of constructors and
843            destructors used by <<g++>>. When a back end sees a symbol
844            which should be used in a constructor list, it creates a new
845            section for the type of name (e.g., <<__CTOR_LIST__>>), attaches
846            the symbol to it, and builds a relocation. To build the lists
847            of constructors, all the linker has to do is catenate all the
848            sections called <<__CTOR_LIST__>> and relocate the data
849            contained within - exactly the operations it would peform on
850            standard data. */
851 #define SEC_CONSTRUCTOR 0x100
852
853          /* The section is a constuctor, and should be placed at the
854           end of the text, data, or bss section(?). */
855 #define SEC_CONSTRUCTOR_TEXT 0x1100
856 #define SEC_CONSTRUCTOR_DATA 0x2100
857 #define SEC_CONSTRUCTOR_BSS  0x3100
858
859          /* The section has contents - a data section could be
860            <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>; a debug section could be
861            <<SEC_HAS_CONTENTS>> */
862 #define SEC_HAS_CONTENTS 0x200
863
864          /* An instruction to the linker to not output the section
865            even if it has information which would normally be written. */
866 #define SEC_NEVER_LOAD 0x400
867
868          /* The section is a COFF shared library section.  This flag is
869            only for the linker.  If this type of section appears in
870            the input file, the linker must copy it to the output file
871            without changing the vma or size.  FIXME: Although this
872            was originally intended to be general, it really is COFF
873            specific (and the flag was renamed to indicate this).  It
874            might be cleaner to have some more general mechanism to
875            allow the back end to control what the linker does with
876            sections. */
877 #define SEC_COFF_SHARED_LIBRARY 0x800
878
879          /* The section contains common symbols (symbols may be defined
880            multiple times, the value of a symbol is the amount of
881            space it requires, and the largest symbol value is the one
882            used).  Most targets have exactly one of these (which we
883             translate to bfd_com_section_ptr), but ECOFF has two. */
884 #define SEC_IS_COMMON 0x8000
885
886          /* The section contains only debugging information.  For
887            example, this is set for ELF .debug and .stab sections.
888            strip tests this flag to see if a section can be
889            discarded. */
890 #define SEC_DEBUGGING 0x10000
891
892          /* The contents of this section are held in memory pointed to
893            by the contents field.  This is checked by
894            bfd_get_section_contents, and the data is retrieved from
895            memory if appropriate.  */
896 #define SEC_IN_MEMORY 0x20000
897
898          /* The contents of this section are to be excluded by the
899             linker for executable and shared objects unless those
900             objects are to be further relocated.  */
901 #define SEC_EXCLUDE 0x40000
902
903          /* The contents of this section are to be sorted by the
904            based on the address specified in the associated symbol
905            table.  */
906 #define SEC_SORT_ENTRIES 0x80000
907
908          /* When linking, duplicate sections of the same name should be
909            discarded, rather than being combined into a single section as
910            is usually done.  This is similar to how common symbols are
911            handled.  See SEC_LINK_DUPLICATES below.  */
912 #define SEC_LINK_ONCE 0x100000
913
914          /* If SEC_LINK_ONCE is set, this bitfield describes how the linker
915            should handle duplicate sections.  */
916 #define SEC_LINK_DUPLICATES 0x600000
917
918          /* This value for SEC_LINK_DUPLICATES means that duplicate
919            sections with the same name should simply be discarded. */
920 #define SEC_LINK_DUPLICATES_DISCARD 0x0
921
922          /* This value for SEC_LINK_DUPLICATES means that the linker
923            should warn if there are any duplicate sections, although
924            it should still only link one copy.  */
925 #define SEC_LINK_DUPLICATES_ONE_ONLY 0x200000
926
927          /* This value for SEC_LINK_DUPLICATES means that the linker
928            should warn if any duplicate sections are a different size.  */
929 #define SEC_LINK_DUPLICATES_SAME_SIZE 0x400000
930
931          /* This value for SEC_LINK_DUPLICATES means that the linker
932            should warn if any duplicate sections contain different
933            contents.  */
934 #define SEC_LINK_DUPLICATES_SAME_CONTENTS 0x600000
935
936          /*  End of section flags.  */
937
938          /* Some internal packed boolean fields.  */
939
940          /* See the vma field.  */
941         unsigned int user_set_vma : 1;
942
943          /* Whether relocations have been processed.  */
944         unsigned int reloc_done : 1;
945
946          /* A mark flag used by some of the linker backends.  */
947         unsigned int linker_mark : 1;
948
949          /* End of internal packed boolean fields.  */
950
951         /*  The virtual memory address of the section - where it will be
952            at run time.  The symbols are relocated against this.  The
953             user_set_vma flag is maintained by bfd; if it's not set, the
954             backend can assign addresses (for example, in <<a.out>>, where
955             the default address for <<.data>> is dependent on the specific
956             target and various flags).  */
957
958    bfd_vma vma;
959
960         /*  The load address of the section - where it would be in a
961            rom image; really only used for writing section header
962             information. */
963
964    bfd_vma lma;
965
966          /* The size of the section in bytes, as it will be output.
967            contains a value even if the section has no contents (e.g., the
968            size of <<.bss>>). This will be filled in after relocation */
969
970    bfd_size_type _cooked_size;
971
972          /* The original size on disk of the section, in bytes.  Normally this
973             value is the same as the size, but if some relaxing has
974             been done, then this value will be bigger.  */
975
976    bfd_size_type _raw_size;
977
978          /* If this section is going to be output, then this value is the
979            offset into the output section of the first byte in the input
980            section. E.g., if this was going to start at the 100th byte in
981            the output section, this value would be 100. */
982
983    bfd_vma output_offset;
984
985          /* The output section through which to map on output. */
986
987    struct sec *output_section;
988
989          /* The alignment requirement of the section, as an exponent of 2 -
990            e.g., 3 aligns to 2^3 (or 8). */
991
992    unsigned int alignment_power;
993
994          /* If an input section, a pointer to a vector of relocation
995            records for the data in this section. */
996
997    struct reloc_cache_entry *relocation;
998
999          /* If an output section, a pointer to a vector of pointers to
1000            relocation records for the data in this section. */
1001
1002    struct reloc_cache_entry **orelocation;
1003
1004          /* The number of relocation records in one of the above  */
1005
1006    unsigned reloc_count;
1007
1008          /* Information below is back end specific - and not always used
1009            or updated.  */
1010
1011          /* File position of section data    */
1012
1013    file_ptr filepos;
1014
1015          /* File position of relocation info */
1016
1017    file_ptr rel_filepos;
1018
1019          /* File position of line data       */
1020
1021    file_ptr line_filepos;
1022
1023          /* Pointer to data for applications */
1024
1025    PTR userdata;
1026
1027          /* If the SEC_IN_MEMORY flag is set, this points to the actual
1028            contents.  */
1029    unsigned char *contents;
1030
1031          /* Attached line number information */
1032
1033    alent *lineno;
1034
1035          /* Number of line number records   */
1036
1037    unsigned int lineno_count;
1038
1039          /* When a section is being output, this value changes as more
1040            linenumbers are written out */
1041
1042    file_ptr moving_line_filepos;
1043
1044          /* What the section number is in the target world  */
1045
1046    int target_index;
1047
1048    PTR used_by_bfd;
1049
1050          /* If this is a constructor section then here is a list of the
1051            relocations created to relocate items within it. */
1052
1053    struct relent_chain *constructor_chain;
1054
1055          /* The BFD which owns the section. */
1056
1057    bfd *owner;
1058
1059           /* A symbol which points at this section only */
1060    struct symbol_cache_entry *symbol;
1061    struct symbol_cache_entry **symbol_ptr_ptr;
1062
1063    struct bfd_link_order *link_order_head;
1064    struct bfd_link_order *link_order_tail;
1065 } asection ;
1066
1067      /* These sections are global, and are managed by BFD.  The application
1068        and target back end are not permitted to change the values in
1069         these sections.  New code should use the section_ptr macros rather
1070        than referring directly to the const sections.  The const sections
1071        may eventually vanish.  */
1072 #define BFD_ABS_SECTION_NAME "*ABS*"
1073 #define BFD_UND_SECTION_NAME "*UND*"
1074 #define BFD_COM_SECTION_NAME "*COM*"
1075 #define BFD_IND_SECTION_NAME "*IND*"
1076
1077      /* the absolute section */
1078 extern const asection bfd_abs_section;
1079 #define bfd_abs_section_ptr ((asection *) &bfd_abs_section)
1080 #define bfd_is_abs_section(sec) ((sec) == bfd_abs_section_ptr)
1081      /* Pointer to the undefined section */
1082 extern const asection bfd_und_section;
1083 #define bfd_und_section_ptr ((asection *) &bfd_und_section)
1084 #define bfd_is_und_section(sec) ((sec) == bfd_und_section_ptr)
1085      /* Pointer to the common section */
1086 extern const asection bfd_com_section;
1087 #define bfd_com_section_ptr ((asection *) &bfd_com_section)
1088      /* Pointer to the indirect section */
1089 extern const asection bfd_ind_section;
1090 #define bfd_ind_section_ptr ((asection *) &bfd_ind_section)
1091 #define bfd_is_ind_section(sec) ((sec) == bfd_ind_section_ptr)
1092
1093 extern const struct symbol_cache_entry * const bfd_abs_symbol;
1094 extern const struct symbol_cache_entry * const bfd_com_symbol;
1095 extern const struct symbol_cache_entry * const bfd_und_symbol;
1096 extern const struct symbol_cache_entry * const bfd_ind_symbol;
1097 #define bfd_get_section_size_before_reloc(section) \
1098      (section->reloc_done ? (abort(),1): (section)->_raw_size)
1099 #define bfd_get_section_size_after_reloc(section) \
1100      ((section->reloc_done) ? (section)->_cooked_size: (abort(),1))
1101 asection *
1102 bfd_get_section_by_name PARAMS ((bfd *abfd, CONST char *name));
1103
1104 asection *
1105 bfd_make_section_old_way PARAMS ((bfd *abfd, CONST char *name));
1106
1107 asection *
1108 bfd_make_section_anyway PARAMS ((bfd *abfd, CONST char *name));
1109
1110 asection *
1111 bfd_make_section PARAMS ((bfd *, CONST char *name));
1112
1113 boolean 
1114 bfd_set_section_flags PARAMS ((bfd *abfd, asection *sec, flagword flags));
1115
1116 void 
1117 bfd_map_over_sections PARAMS ((bfd *abfd,
1118     void (*func)(bfd *abfd,
1119     asection *sect,
1120     PTR obj),
1121     PTR obj));
1122
1123 boolean 
1124 bfd_set_section_size PARAMS ((bfd *abfd, asection *sec, bfd_size_type val));
1125
1126 boolean 
1127 bfd_set_section_contents
1128  PARAMS ((bfd *abfd,
1129     asection *section,
1130     PTR data,
1131     file_ptr offset,
1132     bfd_size_type count));
1133
1134 boolean 
1135 bfd_get_section_contents
1136  PARAMS ((bfd *abfd, asection *section, PTR location,
1137     file_ptr offset, bfd_size_type count));
1138
1139 boolean 
1140 bfd_copy_private_section_data PARAMS ((bfd *ibfd, asection *isec, bfd *obfd, asection *osec));
1141
1142 #define bfd_copy_private_section_data(ibfd, isection, obfd, osection) \
1143      BFD_SEND (ibfd, _bfd_copy_private_section_data, \
1144                 (ibfd, isection, obfd, osection))
1145 enum bfd_architecture 
1146 {
1147   bfd_arch_unknown,    /* File arch not known */
1148   bfd_arch_obscure,    /* Arch known, not one of these */
1149   bfd_arch_m68k,       /* Motorola 68xxx */
1150   bfd_arch_vax,        /* DEC Vax */   
1151   bfd_arch_i960,       /* Intel 960 */
1152      /* The order of the following is important.
1153        lower number indicates a machine type that 
1154        only accepts a subset of the instructions
1155        available to machines with higher numbers.
1156        The exception is the "ca", which is
1157        incompatible with all other machines except 
1158        "core". */
1159
1160 #define bfd_mach_i960_core      1
1161 #define bfd_mach_i960_ka_sa     2
1162 #define bfd_mach_i960_kb_sb     3
1163 #define bfd_mach_i960_mc        4
1164 #define bfd_mach_i960_xa        5
1165 #define bfd_mach_i960_ca        6
1166 #define bfd_mach_i960_jx         7
1167 #define bfd_mach_i960_hx        8
1168
1169   bfd_arch_a29k,       /* AMD 29000 */
1170   bfd_arch_sparc,      /* SPARC */
1171 #define bfd_mach_sparc                  1
1172  /* The difference between v8plus and v9 is that v9 is a true 64 bit env.  */
1173 #define bfd_mach_sparc_sparclet 2
1174 #define bfd_mach_sparc_sparclite        3
1175 #define bfd_mach_sparc_v8plus           4
1176 #define bfd_mach_sparc_v8plusa          5  /* with ultrasparc add'ns */
1177 #define bfd_mach_sparc_v9               6
1178 #define bfd_mach_sparc_v9a              7  /* with ultrasparc add'ns */
1179  /* Nonzero if MACH has the v9 instruction set.  */
1180 #define bfd_mach_sparc_v9_p(mach) \
1181   ((mach) >= bfd_mach_sparc_v8plus && (mach) <= bfd_mach_sparc_v9a)
1182   bfd_arch_mips,       /* MIPS Rxxxx */
1183   bfd_arch_i386,       /* Intel 386 */
1184 #define bfd_mach_i386_i386 0
1185 #define bfd_mach_i386_i8086 1
1186   bfd_arch_we32k,      /* AT&T WE32xxx */
1187   bfd_arch_tahoe,      /* CCI/Harris Tahoe */
1188   bfd_arch_i860,       /* Intel 860 */
1189   bfd_arch_romp,       /* IBM ROMP PC/RT */
1190   bfd_arch_alliant,    /* Alliant */
1191   bfd_arch_convex,     /* Convex */
1192   bfd_arch_m88k,       /* Motorola 88xxx */
1193   bfd_arch_pyramid,    /* Pyramid Technology */
1194   bfd_arch_h8300,      /* Hitachi H8/300 */
1195 #define bfd_mach_h8300   1
1196 #define bfd_mach_h8300h  2
1197 #define bfd_mach_h8300s  3
1198   bfd_arch_powerpc,    /* PowerPC */
1199   bfd_arch_rs6000,     /* IBM RS/6000 */
1200   bfd_arch_hppa,       /* HP PA RISC */
1201 /* start-sanitize-d10v */
1202   bfd_arch_d10v,       /* Mitsubishi D10V */
1203 /* end-sanitize-d10v */
1204   bfd_arch_z8k,        /* Zilog Z8000 */
1205 #define bfd_mach_z8001          1
1206 #define bfd_mach_z8002          2
1207   bfd_arch_h8500,      /* Hitachi H8/500 */
1208   bfd_arch_sh,         /* Hitachi SH */
1209   bfd_arch_alpha,      /* Dec Alpha */
1210   bfd_arch_arm,        /* Advanced Risc Machines ARM */
1211   bfd_arch_ns32k,      /* National Semiconductors ns32000 */
1212   bfd_arch_w65,        /* WDC 65816 */
1213   /* start-sanitize-arc */
1214   bfd_arch_arc,        /* Argonaut RISC Core */
1215 #define bfd_mach_arc_base 0
1216 #define bfd_mach_arc_host 1
1217 #define bfd_mach_arc_graphics 2
1218 #define bfd_mach_arc_audio 3
1219   /* end-sanitize-arc */
1220   bfd_arch_last
1221   };
1222
1223 typedef struct bfd_arch_info 
1224 {
1225   int bits_per_word;
1226   int bits_per_address;
1227   int bits_per_byte;
1228   enum bfd_architecture arch;
1229   unsigned long mach;
1230   const char *arch_name;
1231   const char *printable_name;
1232   unsigned int section_align_power;
1233   /* true if this is the default machine for the architecture */
1234   boolean the_default;  
1235   const struct bfd_arch_info * (*compatible)
1236         PARAMS ((const struct bfd_arch_info *a,
1237                  const struct bfd_arch_info *b));
1238
1239   boolean (*scan) PARAMS ((const struct bfd_arch_info *, const char *));
1240
1241   const struct bfd_arch_info *next;
1242 } bfd_arch_info_type;
1243 const char *
1244 bfd_printable_name PARAMS ((bfd *abfd));
1245
1246 const bfd_arch_info_type *
1247 bfd_scan_arch PARAMS ((const char *string));
1248
1249 const bfd_arch_info_type *
1250 bfd_arch_get_compatible PARAMS ((
1251     const bfd *abfd,
1252     const bfd *bbfd));
1253
1254 void 
1255 bfd_set_arch_info PARAMS ((bfd *abfd, const bfd_arch_info_type *arg));
1256
1257 enum bfd_architecture 
1258 bfd_get_arch PARAMS ((bfd *abfd));
1259
1260 unsigned long 
1261 bfd_get_mach PARAMS ((bfd *abfd));
1262
1263 unsigned int 
1264 bfd_arch_bits_per_byte PARAMS ((bfd *abfd));
1265
1266 unsigned int 
1267 bfd_arch_bits_per_address PARAMS ((bfd *abfd));
1268
1269 const bfd_arch_info_type * 
1270 bfd_get_arch_info PARAMS ((bfd *abfd));
1271
1272 const bfd_arch_info_type *
1273 bfd_lookup_arch
1274  PARAMS ((enum bfd_architecture
1275     arch,
1276     unsigned long machine));
1277
1278 const char *
1279 bfd_printable_arch_mach
1280  PARAMS ((enum bfd_architecture arch, unsigned long machine));
1281
1282 typedef enum bfd_reloc_status
1283 {
1284         /* No errors detected */
1285   bfd_reloc_ok,
1286
1287         /* The relocation was performed, but there was an overflow. */
1288   bfd_reloc_overflow,
1289
1290         /* The address to relocate was not within the section supplied. */
1291   bfd_reloc_outofrange,
1292
1293         /* Used by special functions */
1294   bfd_reloc_continue,
1295
1296         /* Unsupported relocation size requested. */
1297   bfd_reloc_notsupported,
1298
1299         /* Unused */
1300   bfd_reloc_other,
1301
1302         /* The symbol to relocate against was undefined. */
1303   bfd_reloc_undefined,
1304
1305         /* The relocation was performed, but may not be ok - presently
1306           generated only when linking i960 coff files with i960 b.out
1307           symbols.  If this type is returned, the error_message argument
1308           to bfd_perform_relocation will be set.  */
1309   bfd_reloc_dangerous
1310  }
1311  bfd_reloc_status_type;
1312
1313
1314 typedef struct reloc_cache_entry
1315 {
1316         /* A pointer into the canonical table of pointers  */
1317   struct symbol_cache_entry **sym_ptr_ptr;
1318
1319         /* offset in section */
1320   bfd_size_type address;
1321
1322         /* addend for relocation value */
1323   bfd_vma addend;
1324
1325         /* Pointer to how to perform the required relocation */
1326   reloc_howto_type *howto;
1327
1328 } arelent;
1329 enum complain_overflow
1330 {
1331          /* Do not complain on overflow. */
1332   complain_overflow_dont,
1333
1334          /* Complain if the bitfield overflows, whether it is considered
1335            as signed or unsigned. */
1336   complain_overflow_bitfield,
1337
1338          /* Complain if the value overflows when considered as signed
1339            number. */
1340   complain_overflow_signed,
1341
1342          /* Complain if the value overflows when considered as an
1343            unsigned number. */
1344   complain_overflow_unsigned
1345 };
1346
1347 struct reloc_howto_struct
1348 {
1349         /*  The type field has mainly a documetary use - the back end can
1350            do what it wants with it, though normally the back end's
1351            external idea of what a reloc number is stored
1352            in this field. For example, a PC relative word relocation
1353            in a coff environment has the type 023 - because that's
1354            what the outside world calls a R_PCRWORD reloc. */
1355   unsigned int type;
1356
1357         /*  The value the final relocation is shifted right by. This drops
1358            unwanted data from the relocation.  */
1359   unsigned int rightshift;
1360
1361          /*  The size of the item to be relocated.  This is *not* a
1362             power-of-two measure.  To get the number of bytes operated
1363             on by a type of relocation, use bfd_get_reloc_size.  */
1364   int size;
1365
1366         /*  The number of bits in the item to be relocated.  This is used
1367             when doing overflow checking.  */
1368   unsigned int bitsize;
1369
1370         /*  Notes that the relocation is relative to the location in the
1371            data section of the addend. The relocation function will
1372            subtract from the relocation value the address of the location
1373            being relocated. */
1374   boolean pc_relative;
1375
1376          /*  The bit position of the reloc value in the destination.
1377             The relocated value is left shifted by this amount. */
1378   unsigned int bitpos;
1379
1380          /* What type of overflow error should be checked for when
1381            relocating. */
1382   enum complain_overflow complain_on_overflow;
1383
1384         /* If this field is non null, then the supplied function is
1385           called rather than the normal function. This allows really
1386           strange relocation methods to be accomodated (e.g., i960 callj
1387           instructions). */
1388   bfd_reloc_status_type (*special_function)
1389                                     PARAMS ((bfd *abfd,
1390                                              arelent *reloc_entry,
1391                                             struct symbol_cache_entry *symbol,
1392                                             PTR data,
1393                                             asection *input_section,
1394                                             bfd *output_bfd,
1395                                             char **error_message));
1396
1397         /* The textual name of the relocation type. */
1398   char *name;
1399
1400         /* When performing a partial link, some formats must modify the
1401           relocations rather than the data - this flag signals this.*/
1402   boolean partial_inplace;
1403
1404         /* The src_mask selects which parts of the read in data
1405           are to be used in the relocation sum.  E.g., if this was an 8 bit
1406           bit of data which we read and relocated, this would be
1407           0x000000ff. When we have relocs which have an addend, such as
1408           sun4 extended relocs, the value in the offset part of a
1409           relocating field is garbage so we never use it. In this case
1410           the mask would be 0x00000000. */
1411   bfd_vma src_mask;
1412
1413         /* The dst_mask selects which parts of the instruction are replaced
1414           into the instruction. In most cases src_mask == dst_mask,
1415           except in the above special case, where dst_mask would be
1416           0x000000ff, and src_mask would be 0x00000000.   */
1417   bfd_vma dst_mask;
1418
1419         /* When some formats create PC relative instructions, they leave
1420           the value of the pc of the place being relocated in the offset
1421           slot of the instruction, so that a PC relative relocation can
1422           be made just by adding in an ordinary offset (e.g., sun3 a.out).
1423           Some formats leave the displacement part of an instruction
1424           empty (e.g., m88k bcs); this flag signals the fact.*/
1425   boolean pcrel_offset;
1426
1427 };
1428 #define HOWTO(C, R,S,B, P, BI, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1429   {(unsigned)C,R,S,B, P, BI, O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1430 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,complain_overflow_dont,FUNCTION, NAME,false,0,0,IN)
1431
1432 #define HOWTO_PREPARE(relocation, symbol)      \
1433   {                                            \
1434   if (symbol != (asymbol *)NULL) {             \
1435     if (bfd_is_com_section (symbol->section)) { \
1436       relocation = 0;                          \
1437     }                                          \
1438     else {                                     \
1439       relocation = symbol->value;              \
1440     }                                          \
1441   }                                            \
1442 }
1443 int 
1444 bfd_get_reloc_size  PARAMS ((reloc_howto_type *));
1445
1446 typedef struct relent_chain {
1447   arelent relent;
1448   struct   relent_chain *next;
1449 } arelent_chain;
1450 bfd_reloc_status_type
1451
1452 bfd_perform_relocation
1453  PARAMS ((bfd *abfd,
1454     arelent *reloc_entry,
1455     PTR data,
1456     asection *input_section,
1457     bfd *output_bfd,
1458     char **error_message));
1459
1460 bfd_reloc_status_type
1461
1462 bfd_install_relocation
1463  PARAMS ((bfd *abfd,
1464     arelent *reloc_entry,
1465     PTR data, bfd_vma data_start,
1466     asection *input_section,
1467     char **error_message));
1468
1469 enum bfd_reloc_code_real {
1470   _dummy_first_bfd_reloc_code_real,
1471
1472
1473 /* Basic absolute relocations of N bits. */
1474   BFD_RELOC_64,
1475   BFD_RELOC_32,
1476   BFD_RELOC_26,
1477   BFD_RELOC_16,
1478   BFD_RELOC_14,
1479   BFD_RELOC_8,
1480
1481 /* PC-relative relocations.  Sometimes these are relative to the address
1482 of the relocation itself; sometimes they are relative to the start of
1483 the section containing the relocation.  It depends on the specific target.
1484
1485 The 24-bit relocation is used in some Intel 960 configurations. */
1486   BFD_RELOC_64_PCREL,
1487   BFD_RELOC_32_PCREL,
1488   BFD_RELOC_24_PCREL,
1489   BFD_RELOC_16_PCREL,
1490   BFD_RELOC_12_PCREL,
1491   BFD_RELOC_8_PCREL,
1492
1493 /* For ELF. */
1494   BFD_RELOC_32_GOT_PCREL,
1495   BFD_RELOC_16_GOT_PCREL,
1496   BFD_RELOC_8_GOT_PCREL,
1497   BFD_RELOC_32_GOTOFF,
1498   BFD_RELOC_16_GOTOFF,
1499   BFD_RELOC_LO16_GOTOFF,
1500   BFD_RELOC_HI16_GOTOFF,
1501   BFD_RELOC_HI16_S_GOTOFF,
1502   BFD_RELOC_8_GOTOFF,
1503   BFD_RELOC_32_PLT_PCREL,
1504   BFD_RELOC_24_PLT_PCREL,
1505   BFD_RELOC_16_PLT_PCREL,
1506   BFD_RELOC_8_PLT_PCREL,
1507   BFD_RELOC_32_PLTOFF,
1508   BFD_RELOC_16_PLTOFF,
1509   BFD_RELOC_LO16_PLTOFF,
1510   BFD_RELOC_HI16_PLTOFF,
1511   BFD_RELOC_HI16_S_PLTOFF,
1512   BFD_RELOC_8_PLTOFF,
1513
1514 /* Relocations used by 68K ELF. */
1515   BFD_RELOC_68K_GLOB_DAT,
1516   BFD_RELOC_68K_JMP_SLOT,
1517   BFD_RELOC_68K_RELATIVE,
1518
1519 /* Linkage-table relative. */
1520   BFD_RELOC_32_BASEREL,
1521   BFD_RELOC_16_BASEREL,
1522   BFD_RELOC_LO16_BASEREL,
1523   BFD_RELOC_HI16_BASEREL,
1524   BFD_RELOC_HI16_S_BASEREL,
1525   BFD_RELOC_8_BASEREL,
1526   BFD_RELOC_RVA,
1527
1528 /* Absolute 8-bit relocation, but used to form an address like 0xFFnn. */
1529   BFD_RELOC_8_FFnn,
1530
1531 /* These PC-relative relocations are stored as word displacements --
1532 i.e., byte displacements shifted right two bits.  The 30-bit word
1533 displacement (<<32_PCREL_S2>> -- 32 bits, shifted 2) is used on the
1534 SPARC.  (SPARC tools generally refer to this as <<WDISP30>>.)  The
1535 signed 16-bit displacement is used on the MIPS, and the 23-bit
1536 displacement is used on the Alpha. */
1537   BFD_RELOC_32_PCREL_S2,
1538   BFD_RELOC_16_PCREL_S2,
1539   BFD_RELOC_23_PCREL_S2,
1540
1541 /* High 22 bits and low 10 bits of 32-bit value, placed into lower bits of
1542 the target word.  These are used on the SPARC. */
1543   BFD_RELOC_HI22,
1544   BFD_RELOC_LO10,
1545
1546 /* For systems that allocate a Global Pointer register, these are
1547 displacements off that register.  These relocation types are
1548 handled specially, because the value the register will have is
1549 decided relatively late. */
1550   BFD_RELOC_GPREL16,
1551   BFD_RELOC_GPREL32,
1552
1553 /* For openVMS/Alpha systems, these are displacements for switch
1554 tables. */
1555   BFD_RELOC_SWREL32,
1556   BFD_RELOC_SWREL64,
1557
1558 /* Reloc types used for i960/b.out. */
1559   BFD_RELOC_I960_CALLJ,
1560
1561 /* SPARC ELF relocations.  There is probably some overlap with other
1562 relocation types already defined. */
1563   BFD_RELOC_NONE,
1564   BFD_RELOC_SPARC_WDISP22,
1565   BFD_RELOC_SPARC22,
1566   BFD_RELOC_SPARC13,
1567   BFD_RELOC_SPARC_GOT10,
1568   BFD_RELOC_SPARC_GOT13,
1569   BFD_RELOC_SPARC_GOT22,
1570   BFD_RELOC_SPARC_PC10,
1571   BFD_RELOC_SPARC_PC22,
1572   BFD_RELOC_SPARC_WPLT30,
1573   BFD_RELOC_SPARC_COPY,
1574   BFD_RELOC_SPARC_GLOB_DAT,
1575   BFD_RELOC_SPARC_JMP_SLOT,
1576   BFD_RELOC_SPARC_RELATIVE,
1577   BFD_RELOC_SPARC_UA32,
1578
1579 /* I think these are specific to SPARC a.out (e.g., Sun 4). */
1580   BFD_RELOC_SPARC_BASE13,
1581   BFD_RELOC_SPARC_BASE22,
1582
1583 /* Some relocations we're using for SPARC V9 -- subject to change. */
1584 #define BFD_RELOC_SPARC_64 BFD_RELOC_64
1585   BFD_RELOC_SPARC_10,
1586   BFD_RELOC_SPARC_11,
1587   BFD_RELOC_SPARC_OLO10,
1588   BFD_RELOC_SPARC_HH22,
1589   BFD_RELOC_SPARC_HM10,
1590   BFD_RELOC_SPARC_LM22,
1591   BFD_RELOC_SPARC_PC_HH22,
1592   BFD_RELOC_SPARC_PC_HM10,
1593   BFD_RELOC_SPARC_PC_LM22,
1594   BFD_RELOC_SPARC_WDISP16,
1595   BFD_RELOC_SPARC_WDISP19,
1596   BFD_RELOC_SPARC_GLOB_JMP,
1597   BFD_RELOC_SPARC_7,
1598   BFD_RELOC_SPARC_6,
1599   BFD_RELOC_SPARC_5,
1600
1601 /* Alpha ECOFF and ELF relocations.  Some of these treat the symbol or
1602 "addend" in some special way.
1603 For GPDISP_HI16 ("gpdisp") relocations, the symbol is ignored when
1604 writing; when reading, it will be the absolute section symbol.  The
1605 addend is the displacement in bytes of the "lda" instruction from
1606 the "ldah" instruction (which is at the address of this reloc). */
1607   BFD_RELOC_ALPHA_GPDISP_HI16,
1608
1609 /* For GPDISP_LO16 ("ignore") relocations, the symbol is handled as
1610 with GPDISP_HI16 relocs.  The addend is ignored when writing the
1611 relocations out, and is filled in with the file's GP value on
1612 reading, for convenience. */
1613   BFD_RELOC_ALPHA_GPDISP_LO16,
1614
1615 /* The ELF GPDISP relocation is exactly the same as the GPDISP_HI16
1616 relocation except that there is no accompanying GPDISP_LO16
1617 relocation. */
1618   BFD_RELOC_ALPHA_GPDISP,
1619
1620 /* The Alpha LITERAL/LITUSE relocs are produced by a symbol reference;
1621 the assembler turns it into a LDQ instruction to load the address of
1622 the symbol, and then fills in a register in the real instruction.
1623
1624 The LITERAL reloc, at the LDQ instruction, refers to the .lita
1625 section symbol.  The addend is ignored when writing, but is filled
1626 in with the file's GP value on reading, for convenience, as with the
1627 GPDISP_LO16 reloc.
1628
1629 The LITUSE reloc, on the instruction using the loaded address, gives
1630 information to the linker that it might be able to use to optimize
1631 away some literal section references.  The symbol is ignored (read
1632 as the absolute section symbol), and the "addend" indicates the type
1633 of instruction using the register:
1634 1 - "memory" fmt insn
1635 2 - byte-manipulation (byte offset reg)
1636 3 - jsr (target of branch)
1637
1638 The GNU linker currently doesn't do any of this optimizing. */
1639   BFD_RELOC_ALPHA_LITERAL,
1640   BFD_RELOC_ALPHA_LITUSE,
1641
1642 /* The HINT relocation indicates a value that should be filled into the
1643 "hint" field of a jmp/jsr/ret instruction, for possible branch-
1644 prediction logic which may be provided on some processors. */
1645   BFD_RELOC_ALPHA_HINT,
1646
1647 /* The LINKAGE relocation outputs a special code in the object file,
1648 the rest is handled by the linker. */
1649   BFD_RELOC_ALPHA_LINKAGE,
1650
1651 /* The BASEREG relocation calculates differences to basereg. */
1652   BFD_RELOC_ALPHA_BASEREG,
1653
1654 /* Bits 27..2 of the relocation address shifted right 2 bits;
1655 simple reloc otherwise. */
1656   BFD_RELOC_MIPS_JMP,
1657
1658 /* High 16 bits of 32-bit value; simple reloc. */
1659   BFD_RELOC_HI16,
1660
1661 /* High 16 bits of 32-bit value but the low 16 bits will be sign
1662 extended and added to form the final result.  If the low 16
1663 bits form a negative number, we need to add one to the high value
1664 to compensate for the borrow when the low bits are added. */
1665   BFD_RELOC_HI16_S,
1666
1667 /* Low 16 bits. */
1668   BFD_RELOC_LO16,
1669
1670 /* Like BFD_RELOC_HI16_S, but PC relative. */
1671   BFD_RELOC_PCREL_HI16_S,
1672
1673 /* Like BFD_RELOC_LO16, but PC relative. */
1674   BFD_RELOC_PCREL_LO16,
1675
1676 /* Relocation relative to the global pointer. */
1677 #define BFD_RELOC_MIPS_GPREL BFD_RELOC_GPREL16
1678
1679 /* Relocation against a MIPS literal section. */
1680   BFD_RELOC_MIPS_LITERAL,
1681
1682 /* MIPS ELF relocations. */
1683   BFD_RELOC_MIPS_GOT16,
1684   BFD_RELOC_MIPS_CALL16,
1685 #define BFD_RELOC_MIPS_GPREL32 BFD_RELOC_GPREL32
1686   BFD_RELOC_MIPS_GOT_HI16,
1687   BFD_RELOC_MIPS_GOT_LO16,
1688   BFD_RELOC_MIPS_CALL_HI16,
1689   BFD_RELOC_MIPS_CALL_LO16,
1690
1691 /* i386/elf relocations */
1692   BFD_RELOC_386_GOT32,
1693   BFD_RELOC_386_PLT32,
1694   BFD_RELOC_386_COPY,
1695   BFD_RELOC_386_GLOB_DAT,
1696   BFD_RELOC_386_JUMP_SLOT,
1697   BFD_RELOC_386_RELATIVE,
1698   BFD_RELOC_386_GOTOFF,
1699   BFD_RELOC_386_GOTPC,
1700
1701 /* ns32k relocations */
1702   BFD_RELOC_NS32K_IMM_8,
1703   BFD_RELOC_NS32K_IMM_16,
1704   BFD_RELOC_NS32K_IMM_32,
1705   BFD_RELOC_NS32K_IMM_8_PCREL,
1706   BFD_RELOC_NS32K_IMM_16_PCREL,
1707   BFD_RELOC_NS32K_IMM_32_PCREL,
1708   BFD_RELOC_NS32K_DISP_8,
1709   BFD_RELOC_NS32K_DISP_16,
1710   BFD_RELOC_NS32K_DISP_32,
1711   BFD_RELOC_NS32K_DISP_8_PCREL,
1712   BFD_RELOC_NS32K_DISP_16_PCREL,
1713   BFD_RELOC_NS32K_DISP_32_PCREL,
1714
1715 /* Power(rs6000) and PowerPC relocations. */
1716   BFD_RELOC_PPC_B26,
1717   BFD_RELOC_PPC_BA26,
1718   BFD_RELOC_PPC_TOC16,
1719   BFD_RELOC_PPC_B16,
1720   BFD_RELOC_PPC_B16_BRTAKEN,
1721   BFD_RELOC_PPC_B16_BRNTAKEN,
1722   BFD_RELOC_PPC_BA16,
1723   BFD_RELOC_PPC_BA16_BRTAKEN,
1724   BFD_RELOC_PPC_BA16_BRNTAKEN,
1725   BFD_RELOC_PPC_COPY,
1726   BFD_RELOC_PPC_GLOB_DAT,
1727   BFD_RELOC_PPC_JMP_SLOT,
1728   BFD_RELOC_PPC_RELATIVE,
1729   BFD_RELOC_PPC_LOCAL24PC,
1730   BFD_RELOC_PPC_EMB_NADDR32,
1731   BFD_RELOC_PPC_EMB_NADDR16,
1732   BFD_RELOC_PPC_EMB_NADDR16_LO,
1733   BFD_RELOC_PPC_EMB_NADDR16_HI,
1734   BFD_RELOC_PPC_EMB_NADDR16_HA,
1735   BFD_RELOC_PPC_EMB_SDAI16,
1736   BFD_RELOC_PPC_EMB_SDA2I16,
1737   BFD_RELOC_PPC_EMB_SDA2REL,
1738   BFD_RELOC_PPC_EMB_SDA21,
1739   BFD_RELOC_PPC_EMB_MRKREF,
1740   BFD_RELOC_PPC_EMB_RELSEC16,
1741   BFD_RELOC_PPC_EMB_RELST_LO,
1742   BFD_RELOC_PPC_EMB_RELST_HI,
1743   BFD_RELOC_PPC_EMB_RELST_HA,
1744   BFD_RELOC_PPC_EMB_BIT_FLD,
1745   BFD_RELOC_PPC_EMB_RELSDA,
1746
1747 /* The type of reloc used to build a contructor table - at the moment
1748 probably a 32 bit wide absolute relocation, but the target can choose.
1749 It generally does map to one of the other relocation types. */
1750   BFD_RELOC_CTOR,
1751
1752 /* ARM 26 bit pc-relative branch.  The lowest two bits must be zero and are
1753 not stored in the instruction. */
1754   BFD_RELOC_ARM_PCREL_BRANCH,
1755
1756 /* These relocs are only used within the ARM assembler.  They are not
1757 (at present) written to any object files. */
1758   BFD_RELOC_ARM_IMMEDIATE,
1759   BFD_RELOC_ARM_OFFSET_IMM,
1760   BFD_RELOC_ARM_SHIFT_IMM,
1761   BFD_RELOC_ARM_SWI,
1762   BFD_RELOC_ARM_MULTI,
1763   BFD_RELOC_ARM_CP_OFF_IMM,
1764   BFD_RELOC_ARM_ADR_IMM,
1765   BFD_RELOC_ARM_LDR_IMM,
1766   BFD_RELOC_ARM_LITERAL,
1767   BFD_RELOC_ARM_IN_POOL,
1768 /* start-sanitize-arc */
1769
1770 /* Argonaut RISC Core (ARC) relocs.
1771 ARC 22 bit pc-relative branch.  The lowest two bits must be zero and are
1772 not stored in the instruction.  The high 20 bits are installed in bits 26
1773 through 7 of the instruction. */
1774   BFD_RELOC_ARC_B22_PCREL,
1775
1776 /* ARC 26 bit absolute branch.  The lowest two bits must be zero and are not
1777 stored in the instruction.  The high 24 bits are installed in bits 23
1778 through 0. */
1779   BFD_RELOC_ARC_B26,
1780 /* end-sanitize-arc */
1781
1782 /* start-sanitize-d10v */
1783
1784 /* Mitsubishi D10V relocs.
1785 This is a 10-bit reloc with the right 2 bits
1786 assumed to be 0. */
1787   BFD_RELOC_D10V_10_PCREL_L,
1788   BFD_RELOC_D10V_10_PCREL_R,
1789
1790 /* This is an 18-bit reloc with the right 2 bits
1791 assumed to be 0. */
1792   BFD_RELOC_D10V_18,
1793
1794 /* This is an 18-bit reloc with the right 2 bits
1795 assumed to be 0. */
1796   BFD_RELOC_D10V_18_PCREL,
1797 /* end-sanitize-d10v */
1798
1799   BFD_RELOC_UNUSED };
1800 typedef enum bfd_reloc_code_real bfd_reloc_code_real_type;
1801 reloc_howto_type *
1802
1803 bfd_reloc_type_lookup  PARAMS ((bfd *abfd, bfd_reloc_code_real_type code));
1804
1805 const char *
1806 bfd_get_reloc_code_name  PARAMS ((bfd_reloc_code_real_type code));
1807
1808
1809 typedef struct symbol_cache_entry
1810 {
1811          /* A pointer to the BFD which owns the symbol. This information
1812            is necessary so that a back end can work out what additional
1813            information (invisible to the application writer) is carried
1814            with the symbol.
1815
1816            This field is *almost* redundant, since you can use section->owner
1817            instead, except that some symbols point to the global sections
1818            bfd_{abs,com,und}_section.  This could be fixed by making
1819            these globals be per-bfd (or per-target-flavor).  FIXME. */
1820
1821   struct _bfd *the_bfd;  /* Use bfd_asymbol_bfd(sym) to access this field. */
1822
1823          /* The text of the symbol. The name is left alone, and not copied; the
1824            application may not alter it. */
1825   CONST char *name;
1826
1827          /* The value of the symbol.  This really should be a union of a
1828           numeric value with a pointer, since some flags indicate that
1829           a pointer to another symbol is stored here.  */
1830   symvalue value;
1831
1832          /* Attributes of a symbol: */
1833
1834 #define BSF_NO_FLAGS    0x00
1835
1836          /* The symbol has local scope; <<static>> in <<C>>. The value
1837            is the offset into the section of the data. */
1838 #define BSF_LOCAL       0x01
1839
1840          /* The symbol has global scope; initialized data in <<C>>. The
1841            value is the offset into the section of the data. */
1842 #define BSF_GLOBAL      0x02
1843
1844          /* The symbol has global scope and is exported. The value is
1845            the offset into the section of the data. */
1846 #define BSF_EXPORT      BSF_GLOBAL  /* no real difference */
1847
1848          /* A normal C symbol would be one of:
1849            <<BSF_LOCAL>>, <<BSF_FORT_COMM>>,  <<BSF_UNDEFINED>> or
1850            <<BSF_GLOBAL>> */
1851
1852          /* The symbol is a debugging record. The value has an arbitary
1853            meaning. */
1854 #define BSF_DEBUGGING   0x08
1855
1856          /* The symbol denotes a function entry point.  Used in ELF,
1857            perhaps others someday.  */
1858 #define BSF_FUNCTION    0x10
1859
1860          /* Used by the linker. */
1861 #define BSF_KEEP        0x20
1862 #define BSF_KEEP_G      0x40
1863
1864          /* A weak global symbol, overridable without warnings by
1865            a regular global symbol of the same name.  */
1866 #define BSF_WEAK        0x80
1867
1868         /* This symbol was created to point to a section, e.g. ELF's
1869            STT_SECTION symbols.  */
1870 #define BSF_SECTION_SYM 0x100
1871
1872          /* The symbol used to be a common symbol, but now it is
1873            allocated. */
1874 #define BSF_OLD_COMMON  0x200
1875
1876          /* The default value for common data. */
1877 #define BFD_FORT_COMM_DEFAULT_VALUE 0
1878
1879          /* In some files the type of a symbol sometimes alters its
1880            location in an output file - ie in coff a <<ISFCN>> symbol
1881            which is also <<C_EXT>> symbol appears where it was
1882            declared and not at the end of a section.  This bit is set
1883            by the target BFD part to convey this information. */
1884
1885 #define BSF_NOT_AT_END    0x400
1886
1887          /* Signal that the symbol is the label of constructor section. */
1888 #define BSF_CONSTRUCTOR   0x800
1889
1890          /* Signal that the symbol is a warning symbol.  The name is a
1891            warning.  The name of the next symbol is the one to warn about;
1892            if a reference is made to a symbol with the same name as the next
1893            symbol, a warning is issued by the linker. */
1894 #define BSF_WARNING       0x1000
1895
1896          /* Signal that the symbol is indirect.  This symbol is an indirect
1897            pointer to the symbol with the same name as the next symbol. */
1898 #define BSF_INDIRECT      0x2000
1899
1900          /* BSF_FILE marks symbols that contain a file name.  This is used
1901            for ELF STT_FILE symbols.  */
1902 #define BSF_FILE          0x4000
1903
1904          /* Symbol is from dynamic linking information.  */
1905 #define BSF_DYNAMIC        0x8000
1906
1907         /* The symbol denotes a data object.  Used in ELF, and perhaps
1908           others someday.  */
1909 #define BSF_OBJECT         0x10000
1910
1911   flagword flags;
1912
1913          /* A pointer to the section to which this symbol is
1914            relative.  This will always be non NULL, there are special
1915           sections for undefined and absolute symbols.  */
1916   struct sec *section;
1917
1918          /* Back end special data.  */
1919   union
1920     {
1921       PTR p;
1922       bfd_vma i;
1923     } udata;
1924
1925 } asymbol;
1926 #define bfd_get_symtab_upper_bound(abfd) \
1927      BFD_SEND (abfd, _bfd_get_symtab_upper_bound, (abfd))
1928 boolean 
1929 bfd_is_local_label PARAMS ((bfd *abfd, asymbol *sym));
1930
1931 #define bfd_is_local_label(abfd, sym) \
1932      BFD_SEND (abfd, _bfd_is_local_label,(abfd, sym))
1933 #define bfd_canonicalize_symtab(abfd, location) \
1934      BFD_SEND (abfd, _bfd_canonicalize_symtab,\
1935                   (abfd, location))
1936 boolean 
1937 bfd_set_symtab  PARAMS ((bfd *abfd, asymbol **location, unsigned int count));
1938
1939 void 
1940 bfd_print_symbol_vandf PARAMS ((PTR file, asymbol *symbol));
1941
1942 #define bfd_make_empty_symbol(abfd) \
1943      BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
1944 #define bfd_make_debug_symbol(abfd,ptr,size) \
1945         BFD_SEND (abfd, _bfd_make_debug_symbol, (abfd, ptr, size))
1946 int 
1947 bfd_decode_symclass PARAMS ((asymbol *symbol));
1948
1949 void 
1950 bfd_symbol_info PARAMS ((asymbol *symbol, symbol_info *ret));
1951
1952 boolean 
1953 bfd_copy_private_symbol_data PARAMS ((bfd *ibfd, asymbol *isym, bfd *obfd, asymbol *osym));
1954
1955 #define bfd_copy_private_symbol_data(ibfd, isymbol, obfd, osymbol) \
1956      BFD_SEND (ibfd, _bfd_copy_private_symbol_data, \
1957                 (ibfd, isymbol, obfd, osymbol))
1958 struct _bfd 
1959 {
1960      /* The filename the application opened the BFD with.  */
1961     CONST char *filename;                
1962
1963      /* A pointer to the target jump table.             */
1964     const struct bfd_target *xvec;
1965
1966      /* To avoid dragging too many header files into every file that
1967        includes `<<bfd.h>>', IOSTREAM has been declared as a "char
1968        *", and MTIME as a "long".  Their correct types, to which they
1969        are cast when used, are "FILE *" and "time_t".    The iostream
1970        is the result of an fopen on the filename.  However, if the
1971        BFD_IN_MEMORY flag is set, then iostream is actually a pointer
1972        to a bfd_in_memory struct.  */
1973     PTR iostream;
1974
1975      /* Is the file descriptor being cached?  That is, can it be closed as
1976        needed, and re-opened when accessed later?  */
1977
1978     boolean cacheable;
1979
1980      /* Marks whether there was a default target specified when the
1981        BFD was opened. This is used to select which matching algorithm
1982        to use to choose the back end. */
1983
1984     boolean target_defaulted;
1985
1986      /* The caching routines use these to maintain a
1987        least-recently-used list of BFDs */
1988
1989     struct _bfd *lru_prev, *lru_next;
1990
1991      /* When a file is closed by the caching routines, BFD retains
1992        state information on the file here: */
1993
1994     file_ptr where;              
1995
1996      /* and here: (``once'' means at least once) */
1997
1998     boolean opened_once;
1999
2000      /* Set if we have a locally maintained mtime value, rather than
2001        getting it from the file each time: */
2002
2003     boolean mtime_set;
2004
2005      /* File modified time, if mtime_set is true: */
2006
2007     long mtime;          
2008
2009      /* Reserved for an unimplemented file locking extension.*/
2010
2011     int ifd;
2012
2013      /* The format which belongs to the BFD. (object, core, etc.) */
2014
2015     bfd_format format;
2016
2017      /* The direction the BFD was opened with*/
2018
2019     enum bfd_direction {no_direction = 0,
2020                         read_direction = 1,
2021                         write_direction = 2,
2022                         both_direction = 3} direction;
2023
2024      /* Format_specific flags*/
2025
2026     flagword flags;              
2027
2028      /* Currently my_archive is tested before adding origin to
2029        anything. I believe that this can become always an add of
2030        origin, with origin set to 0 for non archive files.   */
2031
2032     file_ptr origin;             
2033
2034      /* Remember when output has begun, to stop strange things
2035        from happening. */
2036     boolean output_has_begun;
2037
2038      /* Pointer to linked list of sections*/
2039     struct sec  *sections;
2040
2041      /* The number of sections */
2042     unsigned int section_count;
2043
2044      /* Stuff only useful for object files: 
2045        The start address. */
2046     bfd_vma start_address;
2047
2048      /* Used for input and output*/
2049     unsigned int symcount;
2050
2051      /* Symbol table for output BFD (with symcount entries) */
2052     struct symbol_cache_entry  **outsymbols;             
2053
2054      /* Pointer to structure which contains architecture information*/
2055     const struct bfd_arch_info *arch_info;
2056
2057      /* Stuff only useful for archives:*/
2058     PTR arelt_data;              
2059     struct _bfd *my_archive;      /* The containing archive BFD.  */
2060     struct _bfd *next;            /* The next BFD in the archive.  */
2061     struct _bfd *archive_head;    /* The first BFD in the archive.  */
2062     boolean has_armap;           
2063
2064      /* A chain of BFD structures involved in a link.  */
2065     struct _bfd *link_next;
2066
2067      /* A field used by _bfd_generic_link_add_archive_symbols.  This will
2068        be used only for archive elements.  */
2069     int archive_pass;
2070
2071      /* Used by the back end to hold private data. */
2072
2073     union 
2074       {
2075       struct aout_data_struct *aout_data;
2076       struct artdata *aout_ar_data;
2077       struct _oasys_data *oasys_obj_data;
2078       struct _oasys_ar_data *oasys_ar_data;
2079       struct coff_tdata *coff_obj_data;
2080       struct pe_tdata *pe_obj_data;
2081       struct xcoff_tdata *xcoff_obj_data;
2082       struct ecoff_tdata *ecoff_obj_data;
2083       struct ieee_data_struct *ieee_data;
2084       struct ieee_ar_data_struct *ieee_ar_data;
2085       struct srec_data_struct *srec_data;
2086       struct ihex_data_struct *ihex_data;
2087       struct tekhex_data_struct *tekhex_data;
2088       struct elf_obj_tdata *elf_obj_data;
2089       struct nlm_obj_tdata *nlm_obj_data;
2090       struct bout_data_struct *bout_data;
2091       struct sun_core_struct *sun_core_data;
2092       struct trad_core_struct *trad_core_data;
2093       struct som_data_struct *som_data;
2094       struct hpux_core_struct *hpux_core_data;
2095       struct hppabsd_core_struct *hppabsd_core_data;
2096       struct sgi_core_struct *sgi_core_data;
2097       struct lynx_core_struct *lynx_core_data;
2098       struct osf_core_struct *osf_core_data;
2099       struct cisco_core_struct *cisco_core_data;
2100       struct versados_data_struct *versados_data;
2101       struct netbsd_core_struct *netbsd_core_data;
2102       PTR any;
2103       } tdata;
2104   
2105      /* Used by the application to hold private data*/
2106     PTR usrdata;
2107
2108      /* Where all the allocated stuff under this BFD goes */
2109     struct obstack memory;
2110 };
2111
2112 typedef enum bfd_error
2113 {
2114   bfd_error_no_error = 0,
2115   bfd_error_system_call,
2116   bfd_error_invalid_target,
2117   bfd_error_wrong_format,
2118   bfd_error_invalid_operation,
2119   bfd_error_no_memory,
2120   bfd_error_no_symbols,
2121   bfd_error_no_armap,
2122   bfd_error_no_more_archived_files,
2123   bfd_error_malformed_archive,
2124   bfd_error_file_not_recognized,
2125   bfd_error_file_ambiguously_recognized,
2126   bfd_error_no_contents,
2127   bfd_error_nonrepresentable_section,
2128   bfd_error_no_debug_section,
2129   bfd_error_bad_value,
2130   bfd_error_file_truncated,
2131   bfd_error_file_too_big,
2132   bfd_error_invalid_error_code
2133 } bfd_error_type;
2134
2135 bfd_error_type 
2136 bfd_get_error  PARAMS ((void));
2137
2138 void 
2139 bfd_set_error  PARAMS ((bfd_error_type error_tag));
2140
2141 CONST char *
2142 bfd_errmsg  PARAMS ((bfd_error_type error_tag));
2143
2144 void 
2145 bfd_perror  PARAMS ((CONST char *message));
2146
2147 typedef void (*bfd_error_handler_type) PARAMS ((const char *, ...));
2148
2149 bfd_error_handler_type 
2150 bfd_set_error_handler  PARAMS ((bfd_error_handler_type));
2151
2152 void 
2153 bfd_set_error_program_name  PARAMS ((const char *));
2154
2155 long 
2156 bfd_get_reloc_upper_bound PARAMS ((bfd *abfd, asection *sect));
2157
2158 long 
2159 bfd_canonicalize_reloc
2160  PARAMS ((bfd *abfd,
2161     asection *sec,
2162     arelent **loc,
2163     asymbol     **syms));
2164
2165 void 
2166 bfd_set_reloc
2167  PARAMS ((bfd *abfd, asection *sec, arelent **rel, unsigned int count)
2168     
2169     );
2170
2171 boolean 
2172 bfd_set_file_flags PARAMS ((bfd *abfd, flagword flags));
2173
2174 boolean 
2175 bfd_set_start_address PARAMS ((bfd *abfd, bfd_vma vma));
2176
2177 long 
2178 bfd_get_mtime PARAMS ((bfd *abfd));
2179
2180 long 
2181 bfd_get_size PARAMS ((bfd *abfd));
2182
2183 int 
2184 bfd_get_gp_size PARAMS ((bfd *abfd));
2185
2186 void 
2187 bfd_set_gp_size PARAMS ((bfd *abfd, int i));
2188
2189 bfd_vma 
2190 bfd_scan_vma PARAMS ((CONST char *string, CONST char **end, int base));
2191
2192 boolean 
2193 bfd_copy_private_bfd_data PARAMS ((bfd *ibfd, bfd *obfd));
2194
2195 #define bfd_copy_private_bfd_data(ibfd, obfd) \
2196      BFD_SEND (ibfd, _bfd_copy_private_bfd_data, \
2197                 (ibfd, obfd))
2198 boolean 
2199 bfd_merge_private_bfd_data PARAMS ((bfd *ibfd, bfd *obfd));
2200
2201 #define bfd_merge_private_bfd_data(ibfd, obfd) \
2202      BFD_SEND (ibfd, _bfd_merge_private_bfd_data, \
2203                 (ibfd, obfd))
2204 boolean 
2205 bfd_set_private_flags PARAMS ((bfd *abfd, flagword flags));
2206
2207 #define bfd_set_private_flags(abfd, flags) \
2208      BFD_SEND (abfd, _bfd_set_private_flags, \
2209                 (abfd, flags))
2210 #define bfd_sizeof_headers(abfd, reloc) \
2211      BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
2212
2213 #define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
2214      BFD_SEND (abfd, _bfd_find_nearest_line,  (abfd, sec, syms, off, file, func, line))
2215
2216         /* Do these three do anything useful at all, for any back end?  */
2217 #define bfd_debug_info_start(abfd) \
2218         BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
2219
2220 #define bfd_debug_info_end(abfd) \
2221         BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
2222
2223 #define bfd_debug_info_accumulate(abfd, section) \
2224         BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
2225
2226
2227 #define bfd_stat_arch_elt(abfd, stat) \
2228         BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
2229
2230 #define bfd_update_armap_timestamp(abfd) \
2231         BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
2232
2233 #define bfd_set_arch_mach(abfd, arch, mach)\
2234         BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
2235
2236 #define bfd_relax_section(abfd, section, link_info, again) \
2237        BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
2238
2239 #define bfd_link_hash_table_create(abfd) \
2240         BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
2241
2242 #define bfd_link_add_symbols(abfd, info) \
2243         BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
2244
2245 #define bfd_final_link(abfd, info) \
2246         BFD_SEND (abfd, _bfd_final_link, (abfd, info))
2247
2248 #define bfd_free_cached_info(abfd) \
2249        BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
2250
2251 #define bfd_get_dynamic_symtab_upper_bound(abfd) \
2252         BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
2253
2254 #define bfd_print_private_bfd_data(abfd, file)\
2255         BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
2256
2257 #define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
2258         BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
2259
2260 #define bfd_get_dynamic_reloc_upper_bound(abfd) \
2261         BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
2262
2263 #define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
2264         BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
2265
2266 extern bfd_byte *bfd_get_relocated_section_contents
2267         PARAMS ((bfd *, struct bfd_link_info *,
2268                   struct bfd_link_order *, bfd_byte *,
2269                   boolean, asymbol **));
2270
2271 symindex 
2272 bfd_get_next_mapent PARAMS ((bfd *abfd, symindex previous, carsym **sym));
2273
2274 boolean 
2275 bfd_set_archive_head PARAMS ((bfd *output, bfd *new_head));
2276
2277 bfd *
2278 bfd_openr_next_archived_file PARAMS ((bfd *archive, bfd *previous));
2279
2280 CONST char *
2281 bfd_core_file_failing_command PARAMS ((bfd *abfd));
2282
2283 int 
2284 bfd_core_file_failing_signal PARAMS ((bfd *abfd));
2285
2286 boolean 
2287 core_file_matches_executable_p
2288  PARAMS ((bfd *core_bfd, bfd *exec_bfd));
2289
2290 #define BFD_SEND(bfd, message, arglist) \
2291                ((*((bfd)->xvec->message)) arglist)
2292
2293 #ifdef DEBUG_BFD_SEND
2294 #undef BFD_SEND
2295 #define BFD_SEND(bfd, message, arglist) \
2296   (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
2297     ((*((bfd)->xvec->message)) arglist) : \
2298     (bfd_assert (__FILE__,__LINE__), NULL))
2299 #endif
2300 #define BFD_SEND_FMT(bfd, message, arglist) \
2301             (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
2302
2303 #ifdef DEBUG_BFD_SEND
2304 #undef BFD_SEND_FMT
2305 #define BFD_SEND_FMT(bfd, message, arglist) \
2306   (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
2307    (((bfd)->xvec->message[(int)((bfd)->format)]) arglist) : \
2308    (bfd_assert (__FILE__,__LINE__), NULL))
2309 #endif
2310 enum bfd_flavour {
2311   bfd_target_unknown_flavour,
2312   bfd_target_aout_flavour,
2313   bfd_target_coff_flavour,
2314   bfd_target_ecoff_flavour,
2315   bfd_target_elf_flavour,
2316   bfd_target_ieee_flavour,
2317   bfd_target_nlm_flavour,
2318   bfd_target_oasys_flavour,
2319   bfd_target_tekhex_flavour,
2320   bfd_target_srec_flavour,
2321   bfd_target_ihex_flavour,
2322   bfd_target_som_flavour,
2323   bfd_target_os9k_flavour,
2324   bfd_target_versados_flavour,
2325   bfd_target_msdos_flavour,
2326   bfd_target_evax_flavour
2327 };
2328
2329 enum bfd_endian { BFD_ENDIAN_BIG, BFD_ENDIAN_LITTLE, BFD_ENDIAN_UNKNOWN };
2330
2331  /* Forward declaration.  */
2332 typedef struct bfd_link_info _bfd_link_info;
2333
2334 typedef struct bfd_target
2335 {
2336   char *name;
2337   enum bfd_flavour flavour;
2338   enum bfd_endian byteorder;
2339   enum bfd_endian header_byteorder;
2340   flagword object_flags;       
2341   flagword section_flags;
2342   char symbol_leading_char;
2343   char ar_pad_char;            
2344   unsigned short ar_max_namelen;
2345   bfd_vma      (*bfd_getx64) PARAMS ((const bfd_byte *));
2346   bfd_signed_vma (*bfd_getx_signed_64) PARAMS ((const bfd_byte *));
2347   void         (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *));
2348   bfd_vma      (*bfd_getx32) PARAMS ((const bfd_byte *));
2349   bfd_signed_vma (*bfd_getx_signed_32) PARAMS ((const bfd_byte *));
2350   void         (*bfd_putx32) PARAMS ((bfd_vma, bfd_byte *));
2351   bfd_vma      (*bfd_getx16) PARAMS ((const bfd_byte *));
2352   bfd_signed_vma (*bfd_getx_signed_16) PARAMS ((const bfd_byte *));
2353   void         (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *));
2354   bfd_vma      (*bfd_h_getx64) PARAMS ((const bfd_byte *));
2355   bfd_signed_vma (*bfd_h_getx_signed_64) PARAMS ((const bfd_byte *));
2356   void         (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *));
2357   bfd_vma      (*bfd_h_getx32) PARAMS ((const bfd_byte *));
2358   bfd_signed_vma (*bfd_h_getx_signed_32) PARAMS ((const bfd_byte *));
2359   void         (*bfd_h_putx32) PARAMS ((bfd_vma, bfd_byte *));
2360   bfd_vma      (*bfd_h_getx16) PARAMS ((const bfd_byte *));
2361   bfd_signed_vma (*bfd_h_getx_signed_16) PARAMS ((const bfd_byte *));
2362   void         (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *));
2363   const struct bfd_target *(*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *));
2364   boolean             (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *));
2365   boolean             (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *));
2366
2367    /* Generic entry points.  */
2368 #define BFD_JUMP_TABLE_GENERIC(NAME)\
2369 CAT(NAME,_close_and_cleanup),\
2370 CAT(NAME,_bfd_free_cached_info),\
2371 CAT(NAME,_new_section_hook),\
2372 CAT(NAME,_get_section_contents),\
2373 CAT(NAME,_get_section_contents_in_window)
2374
2375    /* Called when the BFD is being closed to do any necessary cleanup.  */
2376   boolean       (*_close_and_cleanup) PARAMS ((bfd *));
2377    /* Ask the BFD to free all cached information.  */
2378   boolean (*_bfd_free_cached_info) PARAMS ((bfd *));
2379    /* Called when a new section is created.  */
2380   boolean       (*_new_section_hook) PARAMS ((bfd *, sec_ptr));
2381    /* Read the contents of a section.  */
2382   boolean       (*_bfd_get_section_contents) PARAMS ((bfd *, sec_ptr, PTR, 
2383                                             file_ptr, bfd_size_type));
2384   boolean       (*_bfd_get_section_contents_in_window)
2385                           PARAMS ((bfd *, sec_ptr, bfd_window *,
2386                                    file_ptr, bfd_size_type));
2387
2388    /* Entry points to copy private data.  */
2389 #define BFD_JUMP_TABLE_COPY(NAME)\
2390 CAT(NAME,_bfd_copy_private_bfd_data),\
2391 CAT(NAME,_bfd_merge_private_bfd_data),\
2392 CAT(NAME,_bfd_copy_private_section_data),\
2393 CAT(NAME,_bfd_copy_private_symbol_data),\
2394 CAT(NAME,_bfd_set_private_flags),\
2395 CAT(NAME,_bfd_print_private_bfd_data)\
2396    /* Called to copy BFD general private data from one object file
2397      to another.  */
2398   boolean        (*_bfd_copy_private_bfd_data) PARAMS ((bfd *, bfd *));
2399    /* Called to merge BFD general private data from one object file
2400      to a common output file when linking.  */
2401   boolean        (*_bfd_merge_private_bfd_data) PARAMS ((bfd *, bfd *));
2402    /* Called to copy BFD private section data from one object file
2403      to another.  */
2404   boolean       (*_bfd_copy_private_section_data) PARAMS ((bfd *, sec_ptr,
2405                                                        bfd *, sec_ptr));
2406    /* Called to copy BFD private symbol data from one symbol 
2407      to another.  */
2408   boolean       (*_bfd_copy_private_symbol_data) PARAMS ((bfd *, asymbol *,
2409                                                            bfd *, asymbol *));
2410    /* Called to set private backend flags */
2411   boolean        (*_bfd_set_private_flags) PARAMS ((bfd *, flagword));
2412
2413    /* Called to print private BFD data */
2414   boolean       (*_bfd_print_private_bfd_data) PARAMS ((bfd *, PTR));
2415
2416    /* Core file entry points.  */
2417 #define BFD_JUMP_TABLE_CORE(NAME)\
2418 CAT(NAME,_core_file_failing_command),\
2419 CAT(NAME,_core_file_failing_signal),\
2420 CAT(NAME,_core_file_matches_executable_p)
2421   char *   (*_core_file_failing_command) PARAMS ((bfd *));
2422   int      (*_core_file_failing_signal) PARAMS ((bfd *));
2423   boolean  (*_core_file_matches_executable_p) PARAMS ((bfd *, bfd *));
2424
2425    /* Archive entry points.  */
2426 #define BFD_JUMP_TABLE_ARCHIVE(NAME)\
2427 CAT(NAME,_slurp_armap),\
2428 CAT(NAME,_slurp_extended_name_table),\
2429 CAT(NAME,_construct_extended_name_table),\
2430 CAT(NAME,_truncate_arname),\
2431 CAT(NAME,_write_armap),\
2432 CAT(NAME,_read_ar_hdr),\
2433 CAT(NAME,_openr_next_archived_file),\
2434 CAT(NAME,_get_elt_at_index),\
2435 CAT(NAME,_generic_stat_arch_elt),\
2436 CAT(NAME,_update_armap_timestamp)
2437   boolean  (*_bfd_slurp_armap) PARAMS ((bfd *));
2438   boolean  (*_bfd_slurp_extended_name_table) PARAMS ((bfd *));
2439   boolean  (*_bfd_construct_extended_name_table)
2440              PARAMS ((bfd *, char **, bfd_size_type *, const char **));
2441   void     (*_bfd_truncate_arname) PARAMS ((bfd *, CONST char *, char *));
2442   boolean  (*write_armap) PARAMS ((bfd *arch, 
2443                               unsigned int elength,
2444                               struct orl *map,
2445                               unsigned int orl_count, 
2446                               int stridx));
2447   PTR (*_bfd_read_ar_hdr_fn) PARAMS ((bfd *));
2448   bfd *    (*openr_next_archived_file) PARAMS ((bfd *arch, bfd *prev));
2449 #define bfd_get_elt_at_index(b,i) BFD_SEND(b, _bfd_get_elt_at_index, (b,i))
2450   bfd *    (*_bfd_get_elt_at_index) PARAMS ((bfd *, symindex));
2451   int      (*_bfd_stat_arch_elt) PARAMS ((bfd *, struct stat *));
2452   boolean  (*_bfd_update_armap_timestamp) PARAMS ((bfd *));
2453
2454    /* Entry points used for symbols.  */
2455 #define BFD_JUMP_TABLE_SYMBOLS(NAME)\
2456 CAT(NAME,_get_symtab_upper_bound),\
2457 CAT(NAME,_get_symtab),\
2458 CAT(NAME,_make_empty_symbol),\
2459 CAT(NAME,_print_symbol),\
2460 CAT(NAME,_get_symbol_info),\
2461 CAT(NAME,_bfd_is_local_label),\
2462 CAT(NAME,_get_lineno),\
2463 CAT(NAME,_find_nearest_line),\
2464 CAT(NAME,_bfd_make_debug_symbol),\
2465 CAT(NAME,_read_minisymbols),\
2466 CAT(NAME,_minisymbol_to_symbol)
2467   long  (*_bfd_get_symtab_upper_bound) PARAMS ((bfd *));
2468   long  (*_bfd_canonicalize_symtab) PARAMS ((bfd *,
2469                                              struct symbol_cache_entry **));
2470   struct symbol_cache_entry  *
2471                 (*_bfd_make_empty_symbol) PARAMS ((bfd *));
2472   void          (*_bfd_print_symbol) PARAMS ((bfd *, PTR,
2473                                       struct symbol_cache_entry *,
2474                                       bfd_print_symbol_type));
2475 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
2476   void          (*_bfd_get_symbol_info) PARAMS ((bfd *,
2477                                       struct symbol_cache_entry *,
2478                                       symbol_info *));
2479 #define bfd_get_symbol_info(b,p,e) BFD_SEND(b, _bfd_get_symbol_info, (b,p,e))
2480   boolean        (*_bfd_is_local_label) PARAMS ((bfd *, asymbol *));
2481
2482   alent *    (*_get_lineno) PARAMS ((bfd *, struct symbol_cache_entry *));
2483   boolean    (*_bfd_find_nearest_line) PARAMS ((bfd *abfd,
2484                     struct sec *section, struct symbol_cache_entry **symbols,
2485                     bfd_vma offset, CONST char **file, CONST char **func,
2486                     unsigned int *line));
2487   /* Back-door to allow format-aware applications to create debug symbols
2488     while using BFD for everything else.  Currently used by the assembler
2489     when creating COFF files.  */
2490   asymbol *  (*_bfd_make_debug_symbol) PARAMS ((
2491        bfd *abfd,
2492        void *ptr,
2493        unsigned long size));
2494 #define bfd_read_minisymbols(b, d, m, s) \
2495   BFD_SEND (b, _read_minisymbols, (b, d, m, s))
2496   long  (*_read_minisymbols) PARAMS ((bfd *, boolean, PTR *,
2497                                       unsigned int *));
2498 #define bfd_minisymbol_to_symbol(b, d, m, f) \
2499   BFD_SEND (b, _minisymbol_to_symbol, (b, d, m, f))
2500   asymbol *(*_minisymbol_to_symbol) PARAMS ((bfd *, boolean, const PTR,
2501                                              asymbol *));
2502
2503    /* Routines for relocs.  */
2504 #define BFD_JUMP_TABLE_RELOCS(NAME)\
2505 CAT(NAME,_get_reloc_upper_bound),\
2506 CAT(NAME,_canonicalize_reloc),\
2507 CAT(NAME,_bfd_reloc_type_lookup)
2508   long  (*_get_reloc_upper_bound) PARAMS ((bfd *, sec_ptr));
2509   long  (*_bfd_canonicalize_reloc) PARAMS ((bfd *, sec_ptr, arelent **,
2510                                             struct symbol_cache_entry **));
2511    /* See documentation on reloc types.  */
2512   reloc_howto_type *
2513        (*reloc_type_lookup) PARAMS ((bfd *abfd,
2514                                      bfd_reloc_code_real_type code));
2515
2516    /* Routines used when writing an object file.  */
2517 #define BFD_JUMP_TABLE_WRITE(NAME)\
2518 CAT(NAME,_set_arch_mach),\
2519 CAT(NAME,_set_section_contents)
2520   boolean    (*_bfd_set_arch_mach) PARAMS ((bfd *, enum bfd_architecture,
2521                     unsigned long));
2522   boolean       (*_bfd_set_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
2523                                             file_ptr, bfd_size_type));
2524
2525    /* Routines used by the linker.  */
2526 #define BFD_JUMP_TABLE_LINK(NAME)\
2527 CAT(NAME,_sizeof_headers),\
2528 CAT(NAME,_bfd_get_relocated_section_contents),\
2529 CAT(NAME,_bfd_relax_section),\
2530 CAT(NAME,_bfd_link_hash_table_create),\
2531 CAT(NAME,_bfd_link_add_symbols),\
2532 CAT(NAME,_bfd_final_link),\
2533 CAT(NAME,_bfd_link_split_section)
2534   int        (*_bfd_sizeof_headers) PARAMS ((bfd *, boolean));
2535   bfd_byte * (*_bfd_get_relocated_section_contents) PARAMS ((bfd *,
2536                     struct bfd_link_info *, struct bfd_link_order *,
2537                     bfd_byte *data, boolean relocateable,
2538                     struct symbol_cache_entry **));
2539
2540   boolean    (*_bfd_relax_section) PARAMS ((bfd *, struct sec *,
2541                     struct bfd_link_info *, boolean *again));
2542
2543    /* Create a hash table for the linker.  Different backends store
2544      different information in this table.  */
2545   struct bfd_link_hash_table *(*_bfd_link_hash_table_create) PARAMS ((bfd *));
2546
2547    /* Add symbols from this object file into the hash table.  */
2548   boolean (*_bfd_link_add_symbols) PARAMS ((bfd *, struct bfd_link_info *));
2549
2550    /* Do a link based on the link_order structures attached to each
2551      section of the BFD.  */
2552   boolean (*_bfd_final_link) PARAMS ((bfd *, struct bfd_link_info *));
2553
2554    /* Should this section be split up into smaller pieces during linking.  */
2555   boolean (*_bfd_link_split_section) PARAMS ((bfd *, struct sec *));
2556
2557   /* Routines to handle dynamic symbols and relocs.  */
2558 #define BFD_JUMP_TABLE_DYNAMIC(NAME)\
2559 CAT(NAME,_get_dynamic_symtab_upper_bound),\
2560 CAT(NAME,_canonicalize_dynamic_symtab),\
2561 CAT(NAME,_get_dynamic_reloc_upper_bound),\
2562 CAT(NAME,_canonicalize_dynamic_reloc)
2563    /* Get the amount of memory required to hold the dynamic symbols. */
2564   long  (*_bfd_get_dynamic_symtab_upper_bound) PARAMS ((bfd *));
2565    /* Read in the dynamic symbols.  */
2566   long  (*_bfd_canonicalize_dynamic_symtab)
2567     PARAMS ((bfd *, struct symbol_cache_entry **));
2568    /* Get the amount of memory required to hold the dynamic relocs.  */
2569   long  (*_bfd_get_dynamic_reloc_upper_bound) PARAMS ((bfd *));
2570    /* Read in the dynamic relocs.  */
2571   long  (*_bfd_canonicalize_dynamic_reloc)
2572     PARAMS ((bfd *, arelent **, struct symbol_cache_entry **));
2573
2574  PTR backend_data;
2575 } bfd_target;
2576 const bfd_target *
2577 bfd_find_target PARAMS ((CONST char *target_name, bfd *abfd));
2578
2579 const char **
2580 bfd_target_list PARAMS ((void));
2581
2582 boolean 
2583 bfd_check_format PARAMS ((bfd *abfd, bfd_format format));
2584
2585 boolean 
2586 bfd_check_format_matches PARAMS ((bfd *abfd, bfd_format format, char ***matching));
2587
2588 boolean 
2589 bfd_set_format PARAMS ((bfd *abfd, bfd_format format));
2590
2591 CONST char *
2592 bfd_format_string PARAMS ((bfd_format format));
2593
2594 #ifdef __cplusplus
2595 }
2596 #endif
2597 #endif