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