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