1 /* Generic BFD library interface and support routines.
2 Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
3 Written by Cygnus Support.
5 This file is part of BFD, the Binary File Descriptor library.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
25 A BFD is has type <<bfd>>; objects of this type are the
26 cornerstone of any application using <<libbfd>>. References
27 though the BFD and to data in the BFD give the entire BFD
30 Here is the struct used to define the type <<bfd>>. This
31 contains the major data about the file, and contains pointers
32 to the rest of the data.
38 . {* The filename the application opened the BFD with. *}
39 . CONST char *filename;
41 . {* A pointer to the target jump table. *}
42 . struct bfd_target *xvec;
44 . {* To avoid dragging too many header files into every file that
45 . includes `<<bfd.h>>', IOSTREAM has been declared as a "char
46 . *", and MTIME as a "long". Their correct types, to which they
47 . are cast when used, are "FILE *" and "time_t". The iostream
48 . is the result of an fopen on the filename. *}
51 . {* Is the file being cached *}
55 . {* Marks whether there was a default target specified when the
56 . BFD was opened. This is used to select what matching algorithm
57 . to use to chose the back end. *}
59 . boolean target_defaulted;
61 . {* The caching routines use these to maintain a
62 . least-recently-used list of BFDs *}
64 . struct _bfd *lru_prev, *lru_next;
66 . {* When a file is closed by the caching routines, BFD retains
67 . state information on the file here:
74 . boolean opened_once;
76 . {* Set if we have a locally maintained mtime value, rather than
77 . getting it from the file each time: *}
81 . {* File modified time, if mtime_set is true: *}
85 . {* Reserved for an unimplemented file locking extension.*}
89 . {* The format which belongs to the BFD.*}
93 . {* The direction the BFD was opened with*}
95 . enum bfd_direction {no_direction = 0,
97 . write_direction = 2,
98 . both_direction = 3} direction;
100 . {* Format_specific flags*}
104 . {* Currently my_archive is tested before adding origin to
105 . anything. I believe that this can become always an add of
106 . origin, with origin set to 0 for non archive files. *}
110 . {* Remember when output has begun, to stop strange things
112 . boolean output_has_begun;
114 . {* Pointer to linked list of sections*}
115 . struct sec *sections;
117 . {* The number of sections *}
118 . unsigned int section_count;
120 . {* Stuff only useful for object files:
121 . The start address. *}
122 . bfd_vma start_address;
124 . {* Used for input and output*}
125 . unsigned int symcount;
127 . {* Symbol table for output BFD*}
128 . struct symbol_cache_entry **outsymbols;
130 . {* Pointer to structure which contains architecture information*}
131 . struct bfd_arch_info *arch_info;
133 . {* Stuff only useful for archives:*}
135 . struct _bfd *my_archive;
137 . struct _bfd *archive_head;
140 . {* Used by the back end to hold private data. *}
144 . struct aout_data_struct *aout_data;
145 . struct artdata *aout_ar_data;
146 . struct _oasys_data *oasys_obj_data;
147 . struct _oasys_ar_data *oasys_ar_data;
148 . struct coff_tdata *coff_obj_data;
149 . struct ecoff_tdata *ecoff_obj_data;
150 . struct ieee_data_struct *ieee_data;
151 . struct ieee_ar_data_struct *ieee_ar_data;
152 . struct srec_data_struct *srec_data;
153 . struct tekhex_data_struct *tekhex_data;
154 . struct elf_obj_tdata *elf_obj_data;
155 . struct bout_data_struct *bout_data;
156 . struct sun_core_struct *sun_core_data;
157 . struct trad_core_struct *trad_core_data;
158 . struct hppa_data_struct *hppa_data;
159 . struct hppa_core_struct *hppa_core_data;
160 . struct sgi_core_struct *sgi_core_data;
164 . {* Used by the application to hold private data*}
167 . {* Where all the allocated stuff under this BFD goes *}
168 . struct obstack memory;
170 . {* Is this really needed in addition to usrdata? *}
171 . asymbol **ld_symbols;
179 #include "coff/sym.h"
180 #include "libecoff.h"
183 extern char *strerror();
186 CONST
short _bfd_host_big_endian
= 0x0100;
187 /* Accessing the above as (*(char*)&_bfd_host_big_endian), will
188 return 1 if the host is big-endian, 0 otherwise.
189 (assuming that a short is two bytes long!!! FIXME)
190 (See HOST_IS_BIG_ENDIAN_P in bfd.h.) */
193 o - Most functions return nonzero on success (check doc for
194 precise semantics); 0 or NULL on error.
195 o - Internal errors are documented by the value of bfd_error.
196 If that is system_call_error then check errno.
197 o - The easiest way to report this to the user is to use bfd_perror.
200 bfd_ec bfd_error
= no_error
;
202 CONST
char *CONST bfd_errmsgs
[] = {
206 "File in wrong format",
210 "No relocation info",
211 "No more archived files",
214 "File format not recognized",
215 "File format is ambiguous",
216 "Section has no contents",
217 "Nonrepresentable section on output",
218 "Symbol needs debug section which does not exist",
221 "#<Invalid error code>"
226 DEFUN(bfd_nonrepresentable_section
,(abfd
, name
),
227 CONST bfd
* CONST abfd AND
228 CONST
char * CONST name
)
230 printf("bfd error writing file %s, format %s can't represent section %s\n",
240 DEFUN(bfd_undefined_symbol
,(relent
, seclet
),
241 CONST arelent
*relent AND
242 CONST
struct bfd_seclet
*seclet
)
244 asymbol
*symbol
= *(relent
->sym_ptr_ptr
);
245 printf("bfd error relocating, symbol %s is undefined\n",
252 DEFUN(bfd_reloc_value_truncated
,(relent
, seclet
),
253 CONST arelent
*relent AND
254 struct bfd_seclet
*seclet
)
256 printf("bfd error relocating, value truncated\n");
262 DEFUN(bfd_reloc_is_dangerous
,(relent
, seclet
),
263 CONST arelent
*relent AND
264 CONST
struct bfd_seclet
*seclet
)
266 printf("bfd error relocating, dangerous\n");
270 bfd_error_vector_type bfd_error_vector
=
272 bfd_nonrepresentable_section
,
273 bfd_undefined_symbol
,
274 bfd_reloc_value_truncated
,
275 bfd_reloc_is_dangerous
,
280 bfd_errmsg (error_tag
)
286 if (error_tag
== system_call_error
)
287 return strerror (errno
);
289 if ((((int)error_tag
<(int) no_error
) ||
290 ((int)error_tag
> (int)invalid_error_code
)))
291 error_tag
= invalid_error_code
;/* sanity check */
293 return bfd_errmsgs
[(int)error_tag
];
297 DEFUN (bfd_default_error_trap
, (error_tag
),
300 printf("bfd assert fail (%s)\n", bfd_errmsg(error_tag
));
303 void (*bfd_error_trap
) PARAMS ((bfd_ec
)) = bfd_default_error_trap
;
304 void (*bfd_error_nonrepresentabltrap
) PARAMS ((bfd_ec
)) = bfd_default_error_trap
;
307 DEFUN(bfd_perror
,(message
),
310 if (bfd_error
== system_call_error
)
311 perror((char *)message
); /* must be system error then... */
313 if (message
== NULL
|| *message
== '\0')
314 fprintf (stderr
, "%s\n", bfd_errmsg (bfd_error
));
316 fprintf (stderr
, "%s: %s\n", message
, bfd_errmsg (bfd_error
));
326 bfd_get_reloc_upper_bound
329 unsigned int bfd_get_reloc_upper_bound(bfd *abfd, asection *sect);
332 This function return the number of bytes required to store the
333 relocation information associated with section <<sect>>
334 attached to bfd <<abfd>>
340 DEFUN(bfd_get_reloc_upper_bound
,(abfd
, asect
),
344 if (abfd
->format
!= bfd_object
) {
345 bfd_error
= invalid_operation
;
349 return BFD_SEND (abfd
, _get_reloc_upper_bound
, (abfd
, asect
));
354 bfd_canonicalize_reloc
357 unsigned int bfd_canonicalize_reloc
364 This function calls the back end associated with the open
365 <<abfd>> and translates the external form of the relocation
366 information attached to <<sec>> into the internal canonical
367 form. The table is placed into memory at <<loc>>, which has
368 been preallocated, usually by a call to
369 <<bfd_get_reloc_upper_bound>>.
371 The <<syms>> table is also needed for horrible internal magic
377 DEFUN(bfd_canonicalize_reloc
,(abfd
, asect
, location
, symbols
),
380 arelent
**location AND
383 if (abfd
->format
!= bfd_object
) {
384 bfd_error
= invalid_operation
;
387 return BFD_SEND (abfd
, _bfd_canonicalize_reloc
,
388 (abfd
, asect
, location
, symbols
));
397 boolean bfd_set_file_flags(bfd *abfd, flagword flags);
400 This function attempts to set the flag word in the referenced
401 BFD structure to the value supplied.
404 o wrong_format - The target bfd was not of object format.
405 o invalid_operation - The target bfd was open for reading.
406 o invalid_operation -
407 The flag word contained a bit which was not applicable to the
408 type of file. eg, an attempt was made to set the D_PAGED bit
409 on a bfd format which does not support demand paging
414 bfd_set_file_flags (abfd
, flags
)
418 if (abfd
->format
!= bfd_object
) {
419 bfd_error
= wrong_format
;
423 if (bfd_read_p (abfd
)) {
424 bfd_error
= invalid_operation
;
428 bfd_get_file_flags (abfd
) = flags
;
429 if ((flags
& bfd_applicable_file_flags (abfd
)) != flags
) {
430 bfd_error
= invalid_operation
;
443 (bfd *abfd, asection *sec, arelent **rel, unsigned int count)
446 This function sets the relocation pointer and count within a
447 section to the supplied values.
452 bfd_set_reloc (ignore_abfd
, asect
, location
, count
)
458 asect
->orelocation
= location
;
459 asect
->reloc_count
= count
;
463 bfd_assert(file
, line
)
467 printf("bfd assertion fail %s:%d\n",file
,line
);
473 bfd_set_start_address
476 Marks the entry point of an output BFD.
479 Returns <<true>> on success, <<false>> otherwise.
482 boolean bfd_set_start_address(bfd *, bfd_vma);
486 bfd_set_start_address(abfd
, vma
)
490 abfd
->start_address
= vma
;
497 The bfd_get_mtime function
500 long bfd_get_mtime(bfd *);
503 Return file modification time (as read from file system, or
504 from archive header for archive members).
518 fp
= bfd_cache_lookup (abfd
);
519 if (0 != fstat (fileno (fp
), &buf
))
522 abfd
->mtime
= buf
.st_mtime
; /* Save value in case anyone wants it */
528 The bfd_get_size function
531 long bfd_get_size(bfd *);
534 Return file size (as read from file system) for the file
535 associated with a bfd.
537 Note that the initial motivation for, and use of, this routine is not
538 so we can get the exact size of the object the bfd applies to, since
539 that might not be generally possible (archive members for example?).
540 Although it would be ideal if someone could eventually modify
541 it so that such results were guaranteed.
543 Instead, we want to ask questions like "is this NNN byte sized
544 object I'm about to try read from file offset YYY reasonable?"
545 As as example of where we might want to do this, some object formats
546 use string tables for which the first sizeof(long) bytes of the table
547 contain the size of the table itself, including the size bytes.
548 If an application tries to read what it thinks is one of these
549 string tables, without some way to validate the size, and for
550 some reason the size is wrong (byte swapping error, wrong location
551 for the string table, etc), the only clue is likely to be a read
552 error when it tries to read the table, or a "virtual memory
553 exhausted" error when it tries to allocated 15 bazillon bytes
554 of space for the 15 bazillon byte table it is about to read.
555 This function at least allows us to answer the quesion, "is the
566 fp
= bfd_cache_lookup (abfd
);
567 if (0 != fstat (fileno (fp
), &buf
))
575 The bfd_get_gp_size function
578 int bfd_get_gp_size(bfd *);
581 Get the maximum size of objects to be optimized using the GP
582 register under MIPS ECOFF. This is typically set by the -G
583 argument to the compiler, assembler or linker.
587 bfd_get_gp_size (abfd
)
590 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
591 return ecoff_data (abfd
)->gp_size
;
597 The bfd_set_gp_size function
600 void bfd_set_gp_size(bfd *, int);
603 Set the maximum size of objects to be optimized using the GP
604 register under MIPS ECOFF. This is typically set by the -G
605 argument to the compiler, assembler or linker.
609 bfd_set_gp_size (abfd
, i
)
613 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
614 ecoff_data (abfd
)->gp_size
= i
;
622 stuff which should be documented
624 .#define bfd_sizeof_headers(abfd, reloc) \
625 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
627 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
628 . BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, sec, syms, off, file, func, line))
630 . {* Do these three do anything useful at all, for any back end? *}
631 .#define bfd_debug_info_start(abfd) \
632 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
634 .#define bfd_debug_info_end(abfd) \
635 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
637 .#define bfd_debug_info_accumulate(abfd, section) \
638 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
641 .#define bfd_stat_arch_elt(abfd, stat) \
642 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
644 .#define bfd_set_arch_mach(abfd, arch, mach)\
645 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
647 .#define bfd_get_relocated_section_contents(abfd, seclet, data, relocateable) \
648 . BFD_SEND (abfd, _bfd_get_relocated_section_contents, (abfd, seclet, data, relocateable))
650 .#define bfd_relax_section(abfd, section, symbols) \
651 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, symbols))
653 .#define bfd_seclet_link(abfd, data, relocateable) \
654 . BFD_SEND (abfd, _bfd_seclet_link, (abfd, data, relocateable))