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