Add comment (part of immediately previous commit).
[deliverable/binutils-gdb.git] / bfd / bfd-in.h
CommitLineData
252b5132 1/* Main header file for the bfd library -- portable access to object files.
5b93d8bb 2 Copyright 1990, 91, 92, 93, 94, 95, 96, 97, 98, 99, 2000
252b5132
RH
3 Free Software Foundation, Inc.
4 Contributed by Cygnus Support.
5
6** NOTE: bfd.h and bfd-in2.h are GENERATED files. Don't change them;
7** instead, change bfd-in.h or the other BFD source files processed to
8** generate these files.
9
10This file is part of BFD, the Binary File Descriptor library.
11
12This program is free software; you can redistribute it and/or modify
13it under the terms of the GNU General Public License as published by
14the Free Software Foundation; either version 2 of the License, or
15(at your option) any later version.
16
17This program is distributed in the hope that it will be useful,
18but WITHOUT ANY WARRANTY; without even the implied warranty of
19MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20GNU General Public License for more details.
21
22You should have received a copy of the GNU General Public License
23along with this program; if not, write to the Free Software
24Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
25
60bcf0fa 26/* bfd.h -- The only header file required by users of the bfd library
252b5132
RH
27
28The bfd.h file is generated from bfd-in.h and various .c files; if you
29change it, your changes will probably be lost.
30
31All the prototypes and definitions following the comment "THE FOLLOWING
32IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
33BFD. If you change it, someone oneday will extract it from the source
34again, and your changes will be lost. To save yourself from this bind,
35change the definitions in the source in the bfd directory. Type "make
36docs" and then "make headers" in that directory, and magically this file
37will change to reflect your changes.
38
39If you don't have the tools to perform the extraction, then you are
40safe from someone on your system trampling over your header files.
41You should still maintain the equivalence between the source and this
42file though; every change you make to the .c file should be reflected
43here. */
44
45#ifndef __BFD_H_SEEN__
46#define __BFD_H_SEEN__
47
48#ifdef __cplusplus
49extern "C" {
50#endif
51
52#include "ansidecl.h"
53
54/* These two lines get substitutions done by commands in Makefile.in. */
55#define BFD_VERSION "@VERSION@"
56#define BFD_ARCH_SIZE @wordsize@
57#define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
58#if @BFD_HOST_64_BIT_DEFINED@
59#define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
60#define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
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/* To squelch erroneous compiler warnings ("illegal pointer
79 combination") from the SVR3 compiler, we would like to typedef
80 boolean to int (it doesn't like functions which return boolean.
81 Making sure they are never implicitly declared to return int
82 doesn't seem to help). But this file is not configured based on
83 the host. */
84/* General rules: functions which are boolean return true on success
85 and false on failure (unless they're a predicate). -- bfd.doc */
86/* I'm sure this is going to break something and someone is going to
8546af74 87 force me to change it. */
252b5132
RH
88/* typedef enum boolean {false, true} boolean; */
89/* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h> -fnf */
90/* It gets worse if the host also defines a true/false enum... -sts */
91/* And even worse if your compiler has built-in boolean types... -law */
a1934524 92#if defined (__GNUG__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))
252b5132
RH
93#define TRUE_FALSE_ALREADY_DEFINED
94#endif
95#ifdef MPW
8546af74 96/* Pre-emptive strike - get the file with the enum. */
252b5132
RH
97#include <Types.h>
98#define TRUE_FALSE_ALREADY_DEFINED
99#endif /* MPW */
100#ifndef TRUE_FALSE_ALREADY_DEFINED
101typedef enum bfd_boolean {false, true} boolean;
102#define BFD_TRUE_FALSE
103#else
104/* Use enum names that will appear nowhere else. */
105typedef enum bfd_boolean {bfd_fffalse, bfd_tttrue} boolean;
106#endif
107
108/* A pointer to a position in a file. */
109/* FIXME: This should be using off_t from <sys/types.h>.
110 For now, try to avoid breaking stuff by not including <sys/types.h> here.
111 This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
60bcf0fa 112 Probably the best long-term answer is to avoid using file_ptr AND off_t
252b5132
RH
113 in this header file, and to handle this in the BFD implementation
114 rather than in its interface. */
115/* typedef off_t file_ptr; */
116typedef long int file_ptr;
117
118/* Support for different sizes of target format ints and addresses.
119 If the type `long' is at least 64 bits, BFD_HOST_64BIT_LONG will be
120 set to 1 above. Otherwise, if gcc is being used, this code will
121 use gcc's "long long" type. Otherwise, BFD_HOST_64_BIT must be
122 defined above. */
123
124#ifndef BFD_HOST_64_BIT
125# if BFD_HOST_64BIT_LONG
126# define BFD_HOST_64_BIT long
127# define BFD_HOST_U_64_BIT unsigned long
128# else
129# ifdef __GNUC__
130# if __GNUC__ >= 2
131# define BFD_HOST_64_BIT long long
132# define BFD_HOST_U_64_BIT unsigned long long
133# endif /* __GNUC__ >= 2 */
134# endif /* ! defined (__GNUC__) */
135# endif /* ! BFD_HOST_64BIT_LONG */
136#endif /* ! defined (BFD_HOST_64_BIT) */
137
138#ifdef BFD64
139
140#ifndef BFD_HOST_64_BIT
141 #error No 64 bit integer type available
142#endif /* ! defined (BFD_HOST_64_BIT) */
143
144typedef BFD_HOST_U_64_BIT bfd_vma;
145typedef BFD_HOST_64_BIT bfd_signed_vma;
146typedef BFD_HOST_U_64_BIT bfd_size_type;
147typedef BFD_HOST_U_64_BIT symvalue;
148
149#ifndef fprintf_vma
150#if BFD_HOST_64BIT_LONG
151#define sprintf_vma(s,x) sprintf (s, "%016lx", x)
152#define fprintf_vma(f,x) fprintf (f, "%016lx", x)
153#else
154#define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
155#define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
156#define fprintf_vma(s,x) \
157 fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
158#define sprintf_vma(s,x) \
159 sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
160#endif
161#endif
162
163#else /* not BFD64 */
164
165/* Represent a target address. Also used as a generic unsigned type
166 which is guaranteed to be big enough to hold any arithmetic types
167 we need to deal with. */
168typedef unsigned long bfd_vma;
169
170/* A generic signed type which is guaranteed to be big enough to hold any
171 arithmetic types we need to deal with. Can be assumed to be compatible
172 with bfd_vma in the same way that signed and unsigned ints are compatible
173 (as parameters, in assignment, etc). */
174typedef long bfd_signed_vma;
175
176typedef unsigned long symvalue;
177typedef unsigned long bfd_size_type;
178
179/* Print a bfd_vma x on stream s. */
e60b52c6
KH
180#define fprintf_vma(s,x) fprintf (s, "%08lx", x)
181#define sprintf_vma(s,x) sprintf (s, "%08lx", x)
252b5132
RH
182
183#endif /* not BFD64 */
184
185#define printf_vma(x) fprintf_vma(stdout,x)
186
187typedef unsigned int flagword; /* 32 bits of flags */
188typedef unsigned char bfd_byte;
189\f
190/** File formats */
191
192typedef enum bfd_format {
193 bfd_unknown = 0, /* file format is unknown */
194 bfd_object, /* linker/assember/compiler output */
195 bfd_archive, /* object archive file */
196 bfd_core, /* core dump */
197 bfd_type_end} /* marks the end; don't use it! */
198 bfd_format;
199
200/* Values that may appear in the flags field of a BFD. These also
201 appear in the object_flags field of the bfd_target structure, where
202 they indicate the set of flags used by that backend (not all flags
203 are meaningful for all object file formats) (FIXME: at the moment,
204 the object_flags values have mostly just been copied from backend
205 to another, and are not necessarily correct). */
206
207/* No flags. */
208#define BFD_NO_FLAGS 0x00
209
210/* BFD contains relocation entries. */
211#define HAS_RELOC 0x01
212
213/* BFD is directly executable. */
214#define EXEC_P 0x02
215
216/* BFD has line number information (basically used for F_LNNO in a
217 COFF header). */
218#define HAS_LINENO 0x04
219
220/* BFD has debugging information. */
221#define HAS_DEBUG 0x08
222
223/* BFD has symbols. */
224#define HAS_SYMS 0x10
225
226/* BFD has local symbols (basically used for F_LSYMS in a COFF
227 header). */
228#define HAS_LOCALS 0x20
229
230/* BFD is a dynamic object. */
231#define DYNAMIC 0x40
232
233/* Text section is write protected (if D_PAGED is not set, this is
234 like an a.out NMAGIC file) (the linker sets this by default, but
235 clears it for -r or -N). */
236#define WP_TEXT 0x80
237
238/* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
239 linker sets this by default, but clears it for -r or -n or -N). */
240#define D_PAGED 0x100
241
242/* BFD is relaxable (this means that bfd_relax_section may be able to
243 do something) (sometimes bfd_relax_section can do something even if
244 this is not set). */
245#define BFD_IS_RELAXABLE 0x200
246
247/* This may be set before writing out a BFD to request using a
248 traditional format. For example, this is used to request that when
249 writing out an a.out object the symbols not be hashed to eliminate
250 duplicates. */
251#define BFD_TRADITIONAL_FORMAT 0x400
252
253/* This flag indicates that the BFD contents are actually cached in
254 memory. If this is set, iostream points to a bfd_in_memory struct. */
255#define BFD_IN_MEMORY 0x800
256\f
257/* symbols and relocation */
258
259/* A count of carsyms (canonical archive symbols). */
260typedef unsigned long symindex;
261
262/* How to perform a relocation. */
263typedef const struct reloc_howto_struct reloc_howto_type;
264
265#define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
266
267/* General purpose part of a symbol X;
268 target specific parts are in libcoff.h, libaout.h, etc. */
269
270#define bfd_get_section(x) ((x)->section)
271#define bfd_get_output_section(x) ((x)->section->output_section)
272#define bfd_set_section(x,y) ((x)->section) = (y)
273#define bfd_asymbol_base(x) ((x)->section->vma)
274#define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
275#define bfd_asymbol_name(x) ((x)->name)
276/*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
277#define bfd_asymbol_bfd(x) ((x)->the_bfd)
278#define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
279
280/* A canonical archive symbol. */
281/* This is a type pun with struct ranlib on purpose! */
282typedef struct carsym {
283 char *name;
284 file_ptr file_offset; /* look here to find the file */
285} carsym; /* to make these you call a carsymogen */
286
252b5132
RH
287/* Used in generating armaps (archive tables of contents).
288 Perhaps just a forward definition would do? */
289struct orl { /* output ranlib */
60bcf0fa 290 char **name; /* symbol name */
252b5132
RH
291 file_ptr pos; /* bfd* or file position */
292 int namidx; /* index into string table */
293};
294\f
252b5132
RH
295/* Linenumber stuff */
296typedef struct lineno_cache_entry {
60bcf0fa 297 unsigned int line_number; /* Linenumber from start of function*/
252b5132
RH
298 union {
299 struct symbol_cache_entry *sym; /* Function name */
300 unsigned long offset; /* Offset into section */
301 } u;
302} alent;
303\f
304/* object and core file sections */
305
306#define align_power(addr, align) \
307 ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
308
309typedef struct sec *sec_ptr;
310
311#define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
312#define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
313#define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
314#define bfd_section_name(bfd, ptr) ((ptr)->name)
315#define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
316#define bfd_section_vma(bfd, ptr) ((ptr)->vma)
317#define bfd_section_lma(bfd, ptr) ((ptr)->lma)
318#define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
319#define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
320#define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
321
322#define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
323
324#define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = (boolean)true), true)
325#define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
326#define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
327
60bcf0fa 328typedef struct stat stat_type;
252b5132
RH
329\f
330typedef enum bfd_print_symbol
60bcf0fa 331{
252b5132
RH
332 bfd_print_symbol_name,
333 bfd_print_symbol_more,
334 bfd_print_symbol_all
335} bfd_print_symbol_type;
60bcf0fa 336
252b5132
RH
337/* Information about a symbol that nm needs. */
338
339typedef struct _symbol_info
340{
341 symvalue value;
342 char type;
343 CONST char *name; /* Symbol name. */
344 unsigned char stab_type; /* Stab type. */
8546af74 345 char stab_other; /* Stab other. */
252b5132
RH
346 short stab_desc; /* Stab desc. */
347 CONST char *stab_name; /* String for stab type. */
348} symbol_info;
349
350/* Get the name of a stabs type code. */
351
352extern const char *bfd_get_stab_name PARAMS ((int));
353\f
354/* Hash table routines. There is no way to free up a hash table. */
355
356/* An element in the hash table. Most uses will actually use a larger
357 structure, and an instance of this will be the first field. */
358
359struct bfd_hash_entry
360{
361 /* Next entry for this hash code. */
362 struct bfd_hash_entry *next;
363 /* String being hashed. */
364 const char *string;
365 /* Hash code. This is the full hash code, not the index into the
366 table. */
367 unsigned long hash;
368};
369
370/* A hash table. */
371
372struct bfd_hash_table
373{
374 /* The hash array. */
375 struct bfd_hash_entry **table;
376 /* The number of slots in the hash table. */
377 unsigned int size;
378 /* A function used to create new elements in the hash table. The
379 first entry is itself a pointer to an element. When this
380 function is first invoked, this pointer will be NULL. However,
381 having the pointer permits a hierarchy of method functions to be
382 built each of which calls the function in the superclass. Thus
383 each function should be written to allocate a new block of memory
384 only if the argument is NULL. */
385 struct bfd_hash_entry *(*newfunc) PARAMS ((struct bfd_hash_entry *,
386 struct bfd_hash_table *,
387 const char *));
388 /* An objalloc for this hash table. This is a struct objalloc *,
389 but we use PTR to avoid requiring the inclusion of objalloc.h. */
390 PTR memory;
391};
392
393/* Initialize a hash table. */
394extern boolean bfd_hash_table_init
395 PARAMS ((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 boolean bfd_hash_table_init_n
402 PARAMS ((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 PARAMS ((struct bfd_hash_table *));
410
411/* Look up a string in a hash table. If CREATE is true, a new entry
412 will be created for this string if one does not already exist. The
413 COPY argument must be true if this routine should copy the string
414 into newly allocated memory when adding an entry. */
415extern struct bfd_hash_entry *bfd_hash_lookup
416 PARAMS ((struct bfd_hash_table *, const char *, boolean create,
417 boolean copy));
418
419/* Replace an entry in a hash table. */
420extern void bfd_hash_replace
421 PARAMS ((struct bfd_hash_table *, struct bfd_hash_entry *old,
422 struct bfd_hash_entry *nw));
423
424/* Base method for creating a hash table entry. */
425extern struct bfd_hash_entry *bfd_hash_newfunc
426 PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *,
427 const char *));
428
429/* Grab some space for a hash table entry. */
430extern PTR bfd_hash_allocate PARAMS ((struct bfd_hash_table *,
431 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 PARAMS ((struct bfd_hash_table *,
437 boolean (*) (struct bfd_hash_entry *,
438 PTR),
439 PTR info));
440\f
441/* Semi-portable string concatenation in cpp.
442 The CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
443 The problem is, "32_" is not a valid preprocessing token, and we don't
444 want extra underscores (e.g., "nlm_32_"). The XCAT2 macro will cause the
445 inner CAT macros to be evaluated first, producing still-valid pp-tokens.
446 Then the final concatenation can be done. (Sigh.) */
447#ifndef CAT
448#ifdef SABER
449#define CAT(a,b) a##b
450#define CAT3(a,b,c) a##b##c
451#define CAT4(a,b,c,d) a##b##c##d
452#else
453#if defined(__STDC__) || defined(ALMOST_STDC)
454#define CAT(a,b) a##b
455#define CAT3(a,b,c) a##b##c
456#define XCAT2(a,b) CAT(a,b)
457#define CAT4(a,b,c,d) XCAT2(CAT(a,b),CAT(c,d))
458#else
459#define CAT(a,b) a/**/b
460#define CAT3(a,b,c) a/**/b/**/c
461#define CAT4(a,b,c,d) a/**/b/**/c/**/d
462#endif
463#endif
464#endif
465
466#define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
467\f
468/* User program access to BFD facilities */
469
470/* Direct I/O routines, for programs which know more about the object
471 file than BFD does. Use higher level routines if possible. */
472
473extern bfd_size_type bfd_read
474 PARAMS ((PTR, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
475extern bfd_size_type bfd_write
476 PARAMS ((const PTR, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
477extern int bfd_seek PARAMS ((bfd *abfd, file_ptr fp, int direction));
478extern long bfd_tell PARAMS ((bfd *abfd));
479extern int bfd_flush PARAMS ((bfd *abfd));
480extern int bfd_stat PARAMS ((bfd *abfd, struct stat *));
481
252b5132
RH
482/* Cast from const char * to char * so that caller can assign to
483 a char * without a warning. */
484#define bfd_get_filename(abfd) ((char *) (abfd)->filename)
485#define bfd_get_cacheable(abfd) ((abfd)->cacheable)
486#define bfd_get_format(abfd) ((abfd)->format)
487#define bfd_get_target(abfd) ((abfd)->xvec->name)
488#define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
9bd09e22
ND
489#define bfd_family_coff(abfd) \
490 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
491 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
252b5132
RH
492#define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
493#define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
494#define bfd_header_big_endian(abfd) \
495 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
496#define bfd_header_little_endian(abfd) \
497 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
498#define bfd_get_file_flags(abfd) ((abfd)->flags)
499#define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
500#define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
501#define bfd_my_archive(abfd) ((abfd)->my_archive)
502#define bfd_has_map(abfd) ((abfd)->has_armap)
503
504#define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
505#define bfd_usrdata(abfd) ((abfd)->usrdata)
506
507#define bfd_get_start_address(abfd) ((abfd)->start_address)
508#define bfd_get_symcount(abfd) ((abfd)->symcount)
509#define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
510#define bfd_count_sections(abfd) ((abfd)->section_count)
511
512#define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
513
eb6e10cb 514#define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (boolean) (bool)), true)
252b5132
RH
515
516extern boolean bfd_record_phdr
517 PARAMS ((bfd *, unsigned long, boolean, flagword, boolean, bfd_vma,
518 boolean, boolean, unsigned int, struct sec **));
519
520/* Byte swapping routines. */
521
522bfd_vma bfd_getb64 PARAMS ((const unsigned char *));
523bfd_vma bfd_getl64 PARAMS ((const unsigned char *));
524bfd_signed_vma bfd_getb_signed_64 PARAMS ((const unsigned char *));
525bfd_signed_vma bfd_getl_signed_64 PARAMS ((const unsigned char *));
526bfd_vma bfd_getb32 PARAMS ((const unsigned char *));
527bfd_vma bfd_getl32 PARAMS ((const unsigned char *));
528bfd_signed_vma bfd_getb_signed_32 PARAMS ((const unsigned char *));
529bfd_signed_vma bfd_getl_signed_32 PARAMS ((const unsigned char *));
530bfd_vma bfd_getb16 PARAMS ((const unsigned char *));
531bfd_vma bfd_getl16 PARAMS ((const unsigned char *));
532bfd_signed_vma bfd_getb_signed_16 PARAMS ((const unsigned char *));
533bfd_signed_vma bfd_getl_signed_16 PARAMS ((const unsigned char *));
534void bfd_putb64 PARAMS ((bfd_vma, unsigned char *));
535void bfd_putl64 PARAMS ((bfd_vma, unsigned char *));
536void bfd_putb32 PARAMS ((bfd_vma, unsigned char *));
537void bfd_putl32 PARAMS ((bfd_vma, unsigned char *));
538void bfd_putb16 PARAMS ((bfd_vma, unsigned char *));
539void bfd_putl16 PARAMS ((bfd_vma, unsigned char *));
8c603c85
NC
540
541/* Byte swapping routines which take size and endiannes as arguments. */
542
543bfd_vma bfd_get_bits PARAMS ((bfd_byte *, int, boolean));
544void bfd_put_bits PARAMS ((bfd_vma, bfd_byte *, int, boolean));
252b5132
RH
545\f
546/* Externally visible ECOFF routines. */
547
548#if defined(__STDC__) || defined(ALMOST_STDC)
549struct ecoff_debug_info;
550struct ecoff_debug_swap;
551struct ecoff_extr;
552struct symbol_cache_entry;
553struct bfd_link_info;
554struct bfd_link_hash_entry;
555struct bfd_elf_version_tree;
556#endif
557extern bfd_vma bfd_ecoff_get_gp_value PARAMS ((bfd * abfd));
558extern boolean bfd_ecoff_set_gp_value PARAMS ((bfd *abfd, bfd_vma gp_value));
559extern boolean bfd_ecoff_set_regmasks
560 PARAMS ((bfd *abfd, unsigned long gprmask, unsigned long fprmask,
561 unsigned long *cprmask));
562extern PTR bfd_ecoff_debug_init
563 PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
564 const struct ecoff_debug_swap *output_swap,
565 struct bfd_link_info *));
566extern void bfd_ecoff_debug_free
567 PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
568 const struct ecoff_debug_swap *output_swap,
569 struct bfd_link_info *));
570extern boolean bfd_ecoff_debug_accumulate
571 PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
572 const struct ecoff_debug_swap *output_swap,
573 bfd *input_bfd, struct ecoff_debug_info *input_debug,
574 const struct ecoff_debug_swap *input_swap,
575 struct bfd_link_info *));
576extern boolean bfd_ecoff_debug_accumulate_other
577 PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
578 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
579 struct bfd_link_info *));
580extern boolean bfd_ecoff_debug_externals
581 PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
582 const struct ecoff_debug_swap *swap,
583 boolean relocateable,
584 boolean (*get_extr) (struct symbol_cache_entry *,
585 struct ecoff_extr *),
586 void (*set_index) (struct symbol_cache_entry *,
587 bfd_size_type)));
588extern boolean bfd_ecoff_debug_one_external
589 PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
590 const struct ecoff_debug_swap *swap,
591 const char *name, struct ecoff_extr *esym));
592extern bfd_size_type bfd_ecoff_debug_size
593 PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
594 const struct ecoff_debug_swap *swap));
595extern boolean bfd_ecoff_write_debug
596 PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
597 const struct ecoff_debug_swap *swap, file_ptr where));
598extern boolean bfd_ecoff_write_accumulated_debug
599 PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
600 const struct ecoff_debug_swap *swap,
601 struct bfd_link_info *info, file_ptr where));
602extern boolean bfd_mips_ecoff_create_embedded_relocs
603 PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
604 char **));
605
606/* Externally visible ELF routines. */
607
608struct bfd_link_needed_list
609{
610 struct bfd_link_needed_list *next;
611 bfd *by;
612 const char *name;
613};
614
615extern boolean bfd_elf32_record_link_assignment
616 PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
617extern boolean bfd_elf64_record_link_assignment
618 PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
619extern struct bfd_link_needed_list *bfd_elf_get_needed_list
620 PARAMS ((bfd *, struct bfd_link_info *));
621extern boolean bfd_elf_get_bfd_needed_list
622 PARAMS ((bfd *, struct bfd_link_needed_list **));
623extern boolean bfd_elf32_size_dynamic_sections
624 PARAMS ((bfd *, const char *, const char *, boolean, const char *,
625 const char * const *, struct bfd_link_info *, struct sec **,
626 struct bfd_elf_version_tree *));
627extern boolean bfd_elf64_size_dynamic_sections
628 PARAMS ((bfd *, const char *, const char *, boolean, const char *,
629 const char * const *, struct bfd_link_info *, struct sec **,
630 struct bfd_elf_version_tree *));
631extern void bfd_elf_set_dt_needed_name PARAMS ((bfd *, const char *));
74816898 632extern void bfd_elf_set_dt_needed_soname PARAMS ((bfd *, const char *));
252b5132 633extern const char *bfd_elf_get_dt_soname PARAMS ((bfd *));
a963dc6a
L
634extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
635 PARAMS ((bfd *, struct bfd_link_info *));
252b5132 636
7f8d5fc9
ILT
637/* Return an upper bound on the number of bytes required to store a
638 copy of ABFD's program header table entries. Return -1 if an error
639 occurs; bfd_get_error will return an appropriate code. */
640extern long bfd_get_elf_phdr_upper_bound PARAMS ((bfd *abfd));
641
642/* Copy ABFD's program header table entries to *PHDRS. The entries
643 will be stored as an array of Elf_Internal_Phdr structures, as
644 defined in include/elf/internal.h. To find out how large the
645 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
646
647 Return the number of program header table entries read, or -1 if an
648 error occurs; bfd_get_error will return an appropriate code. */
649extern int bfd_get_elf_phdrs PARAMS ((bfd *abfd, void *phdrs));
650
3425c182 651/* Return the arch_size field of an elf bfd, or -1 if not elf. */
125c4a69 652extern int bfd_get_arch_size PARAMS ((bfd *));
3425c182 653
8546af74 654/* Return true if address "naturally" sign extends, or -1 if not elf. */
125c4a69 655extern int bfd_get_sign_extend_vma PARAMS ((bfd *));
6d9019e4 656
0752970e
NC
657extern boolean bfd_m68k_elf32_create_embedded_relocs
658 PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
659 char **));
660
252b5132
RH
661/* SunOS shared library support routines for the linker. */
662
663extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
664 PARAMS ((bfd *, struct bfd_link_info *));
665extern boolean bfd_sunos_record_link_assignment
666 PARAMS ((bfd *, struct bfd_link_info *, const char *));
667extern boolean bfd_sunos_size_dynamic_sections
668 PARAMS ((bfd *, struct bfd_link_info *, struct sec **, struct sec **,
669 struct sec **));
670
671/* Linux shared library support routines for the linker. */
672
673extern boolean bfd_i386linux_size_dynamic_sections
674 PARAMS ((bfd *, struct bfd_link_info *));
675extern boolean bfd_m68klinux_size_dynamic_sections
676 PARAMS ((bfd *, struct bfd_link_info *));
677extern boolean bfd_sparclinux_size_dynamic_sections
678 PARAMS ((bfd *, struct bfd_link_info *));
679
680/* mmap hacks */
681
682struct _bfd_window_internal;
683typedef struct _bfd_window_internal bfd_window_internal;
684
685typedef struct _bfd_window {
686 /* What the user asked for. */
687 PTR data;
688 bfd_size_type size;
689 /* The actual window used by BFD. Small user-requested read-only
690 regions sharing a page may share a single window into the object
691 file. Read-write versions shouldn't until I've fixed things to
692 keep track of which portions have been claimed by the
693 application; don't want to give the same region back when the
694 application wants two writable copies! */
695 struct _bfd_window_internal *i;
696} bfd_window;
697
698extern void bfd_init_window PARAMS ((bfd_window *));
699extern void bfd_free_window PARAMS ((bfd_window *));
700extern boolean bfd_get_file_window
701 PARAMS ((bfd *, file_ptr, bfd_size_type, bfd_window *, boolean));
702
703/* XCOFF support routines for the linker. */
704
705extern boolean bfd_xcoff_link_record_set
706 PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
707 bfd_size_type));
708extern boolean bfd_xcoff_import_symbol
709 PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
710 bfd_vma, const char *, const char *, const char *));
711extern boolean bfd_xcoff_export_symbol
712 PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
713 boolean));
714extern boolean bfd_xcoff_link_count_reloc
715 PARAMS ((bfd *, struct bfd_link_info *, const char *));
716extern boolean bfd_xcoff_record_link_assignment
717 PARAMS ((bfd *, struct bfd_link_info *, const char *));
718extern boolean bfd_xcoff_size_dynamic_sections
719 PARAMS ((bfd *, struct bfd_link_info *, const char *, const char *,
720 unsigned long, unsigned long, unsigned long, boolean,
721 int, boolean, boolean, struct sec **));
722
723/* Externally visible COFF routines. */
724
725#if defined(__STDC__) || defined(ALMOST_STDC)
726struct internal_syment;
727union internal_auxent;
728#endif
729
730extern boolean bfd_coff_get_syment
731 PARAMS ((bfd *, struct symbol_cache_entry *, struct internal_syment *));
732
733extern boolean bfd_coff_get_auxent
734 PARAMS ((bfd *, struct symbol_cache_entry *, int, union internal_auxent *));
735
736extern boolean bfd_coff_set_symbol_class
737 PARAMS ((bfd *, struct symbol_cache_entry *, unsigned int));
738
e702a51c
NC
739extern boolean bfd_m68k_coff_create_embedded_relocs
740 PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
741 char **));
742
252b5132
RH
743/* ARM Interworking support. Called from linker. */
744extern boolean bfd_arm_allocate_interworking_sections
745 PARAMS ((struct bfd_link_info *));
746
747extern boolean bfd_arm_process_before_allocation
748 PARAMS ((bfd *, struct bfd_link_info *, int));
749
750extern boolean bfd_arm_get_bfd_for_interworking
751 PARAMS ((bfd *, struct bfd_link_info *));
752
86033394
NC
753/* PE ARM Interworking support. Called from linker. */
754extern boolean bfd_arm_pe_allocate_interworking_sections
755 PARAMS ((struct bfd_link_info *));
756
757extern boolean bfd_arm_pe_process_before_allocation
758 PARAMS ((bfd *, struct bfd_link_info *, int));
759
760extern boolean bfd_arm_pe_get_bfd_for_interworking
761 PARAMS ((bfd *, struct bfd_link_info *));
762
252b5132 763/* ELF ARM Interworking support. Called from linker. */
67e5d3d6
ILT
764extern boolean bfd_elf32_arm_allocate_interworking_sections
765 PARAMS ((struct bfd_link_info *));
766
767extern boolean bfd_elf32_arm_process_before_allocation
768 PARAMS ((bfd *, struct bfd_link_info *, int));
769
770extern boolean bfd_elf32_arm_get_bfd_for_interworking
771 PARAMS ((bfd *, struct bfd_link_info *));
252b5132 772
8546af74 773/* TI COFF load page support. */
b9af77f5
TW
774extern void bfd_ticoff_set_section_load_page
775 PARAMS ((struct sec *, int));
776
777extern int bfd_ticoff_get_section_load_page
778 PARAMS ((struct sec *));
779
252b5132 780/* And more from the source. */
This page took 0.098415 seconds and 4 git commands to generate.