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