1 /* Generic BFD library interface and support routines.
2 Copyright (C) 1990, 91, 92, 93, 94 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 has type <<bfd>>; objects of this type are the
26 cornerstone of any application using BFD. Using BFD
27 consists of making references though the BFD and to data in the BFD.
29 Here is the structure that defines the type <<bfd>>. It
30 contains the major data about the file and pointers
31 to the rest of the data.
37 . {* The filename the application opened the BFD with. *}
38 . CONST char *filename;
40 . {* A pointer to the target jump table. *}
41 . struct bfd_target *xvec;
43 . {* To avoid dragging too many header files into every file that
44 . includes `<<bfd.h>>', IOSTREAM has been declared as a "char
45 . *", and MTIME as a "long". Their correct types, to which they
46 . are cast when used, are "FILE *" and "time_t". The iostream
47 . is the result of an fopen on the filename. *}
50 . {* Is the file descriptor being cached? That is, can it be closed as
51 . needed, and re-opened when accessed later? *}
55 . {* Marks whether there was a default target specified when the
56 . BFD was opened. This is used to select which matching algorithm
57 . to use to choose 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: *}
71 . {* and here: (``once'' means at least once) *}
73 . boolean opened_once;
75 . {* Set if we have a locally maintained mtime value, rather than
76 . getting it from the file each time: *}
80 . {* File modified time, if mtime_set is true: *}
84 . {* Reserved for an unimplemented file locking extension.*}
88 . {* The format which belongs to the BFD. (object, core, etc.) *}
92 . {* The direction the BFD was opened with*}
94 . enum bfd_direction {no_direction = 0,
96 . write_direction = 2,
97 . both_direction = 3} direction;
99 . {* Format_specific flags*}
103 . {* Currently my_archive is tested before adding origin to
104 . anything. I believe that this can become always an add of
105 . origin, with origin set to 0 for non archive files. *}
109 . {* Remember when output has begun, to stop strange things
111 . boolean output_has_begun;
113 . {* Pointer to linked list of sections*}
114 . struct sec *sections;
116 . {* The number of sections *}
117 . unsigned int section_count;
119 . {* Stuff only useful for object files:
120 . The start address. *}
121 . bfd_vma start_address;
123 . {* Used for input and output*}
124 . unsigned int symcount;
126 . {* Symbol table for output BFD (with symcount entries) *}
127 . struct symbol_cache_entry **outsymbols;
129 . {* Pointer to structure which contains architecture information*}
130 . struct bfd_arch_info *arch_info;
132 . {* Stuff only useful for archives:*}
134 . struct _bfd *my_archive; {* The containing archive BFD. *}
135 . struct _bfd *next; {* The next BFD in the archive. *}
136 . struct _bfd *archive_head; {* The first BFD in the archive. *}
139 . {* A chain of BFD structures involved in a link. *}
140 . struct _bfd *link_next;
142 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
143 . be used only for archive elements. *}
146 . {* Used by the back end to hold private data. *}
150 . struct aout_data_struct *aout_data;
151 . struct artdata *aout_ar_data;
152 . struct _oasys_data *oasys_obj_data;
153 . struct _oasys_ar_data *oasys_ar_data;
154 . struct coff_tdata *coff_obj_data;
155 . struct ecoff_tdata *ecoff_obj_data;
156 . struct ieee_data_struct *ieee_data;
157 . struct ieee_ar_data_struct *ieee_ar_data;
158 . struct srec_data_struct *srec_data;
159 . struct tekhex_data_struct *tekhex_data;
160 . struct elf_obj_tdata *elf_obj_data;
161 . struct nlm_obj_tdata *nlm_obj_data;
162 . struct bout_data_struct *bout_data;
163 . struct sun_core_struct *sun_core_data;
164 . struct trad_core_struct *trad_core_data;
165 . struct som_data_struct *som_data;
166 . struct hpux_core_struct *hpux_core_data;
167 . struct hppabsd_core_struct *hppabsd_core_data;
168 . struct sgi_core_struct *sgi_core_data;
169 . struct lynx_core_struct *lynx_core_data;
170 . struct osf_core_struct *osf_core_data;
174 . {* Used by the application to hold private data*}
177 . {* Where all the allocated stuff under this BFD goes *}
178 . struct obstack memory;
187 #include "coff/internal.h"
188 #include "coff/sym.h"
190 #include "libecoff.h"
199 Most BFD functions return nonzero on success (check their
200 individual documentation for precise semantics). On an error,
201 they call <<bfd_set_error>> to set an error condition that callers
202 can check by calling <<bfd_get_error>>.
203 If that returns <<bfd_error_system_call>>, then check
206 The easiest way to report a BFD error to the user is to
210 Type <<bfd_error_type>>
212 The values returned by <<bfd_get_error>> are defined by the
213 enumerated type <<bfd_error_type>>.
217 .typedef enum bfd_error
219 . bfd_error_no_error = 0,
220 . bfd_error_system_call,
221 . bfd_error_invalid_target,
222 . bfd_error_wrong_format,
223 . bfd_error_invalid_operation,
224 . bfd_error_no_memory,
225 . bfd_error_no_symbols,
226 . bfd_error_no_more_archived_files,
227 . bfd_error_malformed_archive,
228 . bfd_error_file_not_recognized,
229 . bfd_error_file_ambiguously_recognized,
230 . bfd_error_no_contents,
231 . bfd_error_nonrepresentable_section,
232 . bfd_error_no_debug_section,
233 . bfd_error_bad_value,
234 . bfd_error_file_truncated,
235 . bfd_error_invalid_error_code
241 extern char *strerror();
243 static bfd_error_type bfd_error = bfd_error_no_error;
245 CONST char *CONST bfd_errmsgs[] = {
248 "Invalid bfd target",
249 "File in wrong format",
253 "No more archived files",
255 "File format not recognized",
256 "File format is ambiguous",
257 "Section has no contents",
258 "Nonrepresentable section on output",
259 "Symbol needs debug section which does not exist",
262 "#<Invalid error code>"
270 bfd_error_type bfd_get_error (void);
273 Return the current BFD error condition.
287 void bfd_set_error (bfd_error_type error_tag);
290 Set the BFD error condition to be @var{error_tag}.
294 bfd_set_error (error_tag)
295 bfd_error_type error_tag;
297 bfd_error = error_tag;
305 CONST char *bfd_errmsg (bfd_error_type error_tag);
308 Return a string describing the error @var{error_tag}, or
309 the system error if @var{error_tag} is <<bfd_error_system_call>>.
313 bfd_errmsg (error_tag)
314 bfd_error_type error_tag;
319 if (error_tag == bfd_error_system_call)
320 return strerror (errno);
322 if ((((int)error_tag <(int) bfd_error_no_error) ||
323 ((int)error_tag > (int)bfd_error_invalid_error_code)))
324 error_tag = bfd_error_invalid_error_code;/* sanity check */
326 return bfd_errmsgs [(int)error_tag];
334 void bfd_perror (CONST char *message);
337 Print to the standard error stream a string describing the
338 last BFD error that occurred, or the last system error if
339 the last BFD error was a system call failure. If @var{message}
340 is non-NULL and non-empty, the error string printed is preceded
341 by @var{message}, a colon, and a space. It is followed by a newline.
348 if (bfd_get_error () == bfd_error_system_call)
349 perror((char *)message); /* must be system error then... */
351 if (message == NULL || *message == '\0')
352 fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
354 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
366 bfd_get_reloc_upper_bound
369 unsigned int bfd_get_reloc_upper_bound(bfd *abfd, asection *sect);
372 Return the number of bytes required to store the
373 relocation information associated with section @var{sect}
374 attached to bfd @var{abfd}.
380 bfd_get_reloc_upper_bound (abfd, asect)
384 if (abfd->format != bfd_object) {
385 bfd_set_error (bfd_error_invalid_operation);
389 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
394 bfd_canonicalize_reloc
397 unsigned int bfd_canonicalize_reloc
404 Call the back end associated with the open BFD
405 @var{abfd} and translate the external form of the relocation
406 information attached to @var{sec} into the internal canonical
407 form. Place the table into memory at @var{loc}, which has
408 been preallocated, usually by a call to
409 <<bfd_get_reloc_upper_bound>>.
411 The @var{syms} table is also needed for horrible internal magic
417 bfd_canonicalize_reloc (abfd, asect, location, symbols)
423 if (abfd->format != bfd_object) {
424 bfd_set_error (bfd_error_invalid_operation);
427 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
428 (abfd, asect, location, symbols));
437 (bfd *abfd, asection *sec, arelent **rel, unsigned int count)
440 Set the relocation pointer and count within
441 section @var{sec} to the values @var{rel} and @var{count}.
442 The argument @var{abfd} is ignored.
447 bfd_set_reloc (ignore_abfd, asect, location, count)
453 asect->orelocation = location;
454 asect->reloc_count = count;
462 boolean bfd_set_file_flags(bfd *abfd, flagword flags);
465 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
468 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
469 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
470 o <<bfd_error_invalid_operation>> -
471 The flag word contained a bit which was not applicable to the
472 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
473 on a BFD format which does not support demand paging.
478 bfd_set_file_flags (abfd, flags)
482 if (abfd->format != bfd_object) {
483 bfd_set_error (bfd_error_wrong_format);
487 if (bfd_read_p (abfd)) {
488 bfd_set_error (bfd_error_invalid_operation);
492 bfd_get_file_flags (abfd) = flags;
493 if ((flags & bfd_applicable_file_flags (abfd)) != flags) {
494 bfd_set_error (bfd_error_invalid_operation);
502 bfd_assert(file, line)
506 fprintf(stderr, "bfd assertion fail %s:%d\n",file,line);
512 bfd_set_start_address
515 boolean bfd_set_start_address(bfd *abfd, bfd_vma vma);
518 Make @var{vma} the entry point of output BFD @var{abfd}.
521 Returns <<true>> on success, <<false>> otherwise.
525 bfd_set_start_address(abfd, vma)
529 abfd->start_address = vma;
539 long bfd_get_mtime(bfd *abfd);
542 Return the file modification time (as read from the file system, or
543 from the archive header for archive members).
557 fp = bfd_cache_lookup (abfd);
558 if (0 != fstat (fileno (fp), &buf))
561 abfd->mtime = buf.st_mtime; /* Save value in case anyone wants it */
570 long bfd_get_size(bfd *abfd);
573 Return the file size (as read from file system) for the file
574 associated with BFD @var{abfd}.
576 The initial motivation for, and use of, this routine is not
577 so we can get the exact size of the object the BFD applies to, since
578 that might not be generally possible (archive members for example).
579 It would be ideal if someone could eventually modify
580 it so that such results were guaranteed.
582 Instead, we want to ask questions like "is this NNN byte sized
583 object I'm about to try read from file offset YYY reasonable?"
584 As as example of where we might do this, some object formats
585 use string tables for which the first <<sizeof(long)>> bytes of the
586 table contain the size of the table itself, including the size bytes.
587 If an application tries to read what it thinks is one of these
588 string tables, without some way to validate the size, and for
589 some reason the size is wrong (byte swapping error, wrong location
590 for the string table, etc.), the only clue is likely to be a read
591 error when it tries to read the table, or a "virtual memory
592 exhausted" error when it tries to allocate 15 bazillon bytes
593 of space for the 15 bazillon byte table it is about to read.
594 This function at least allows us to answer the quesion, "is the
605 fp = bfd_cache_lookup (abfd);
606 if (0 != fstat (fileno (fp), &buf))
617 int bfd_get_gp_size(bfd *abfd);
620 Return the maximum size of objects to be optimized using the GP
621 register under MIPS ECOFF. This is typically set by the <<-G>>
622 argument to the compiler, assembler or linker.
626 bfd_get_gp_size (abfd)
629 if (abfd->format == bfd_object)
631 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
632 return ecoff_data (abfd)->gp_size;
633 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
634 return elf_gp_size (abfd);
644 void bfd_set_gp_size(bfd *abfd, int i);
647 Set the maximum size of objects to be optimized using the GP
648 register under ECOFF or MIPS ELF. This is typically set by
649 the <<-G>> argument to the compiler, assembler or linker.
653 bfd_set_gp_size (abfd, i)
657 /* Don't try to set GP size on an archive or core file! */
658 if (abfd->format != bfd_object)
660 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
661 ecoff_data (abfd)->gp_size = i;
662 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
663 elf_gp_size (abfd) = i;
671 bfd_vma bfd_scan_vma(CONST char *string, CONST char **end, int base);
674 Convert, like <<strtoul>>, a numerical expression
675 @var{string} into a <<bfd_vma>> integer, and return that integer.
676 (Though without as many bells and whistles as <<strtoul>>.)
677 The expression is assumed to be unsigned (i.e., positive).
678 If given a @var{base}, it is used as the base for conversion.
679 A base of 0 causes the function to interpret the string
680 in hex if a leading "0x" or "0X" is found, otherwise
681 in octal if a leading zero is found, otherwise in decimal.
683 Overflow is not detected.
687 bfd_scan_vma (string, end, base)
695 /* Let the host do it if possible. */
696 if (sizeof(bfd_vma) <= sizeof(unsigned long))
697 return (bfd_vma) strtoul (string, 0, base);
699 /* A negative base makes no sense, and we only need to go as high as hex. */
700 if ((base < 0) || (base > 16))
705 if (string[0] == '0')
707 if ((string[1] == 'x') || (string[1] == 'X'))
709 /* XXX should we also allow "0b" or "0B" to set base to 2? */
717 (string[0] == '0') && ((string[1] == 'x') || (string[1] == 'X')))
719 /* XXX should we also skip over "0b" or "0B" if base is 2? */
721 /* Speed could be improved with a table like hex_value[] in gas. */
722 #define HEX_VALUE(c) \
726 (10 + c - (islower(c) ? 'a' : 'A'))) : \
729 for (value = 0; (digit = HEX_VALUE(*string)) < base; string++)
731 value = value * base + digit;
745 Stuff which should be documented:
747 .#define bfd_sizeof_headers(abfd, reloc) \
748 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
750 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
751 . BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, sec, syms, off, file, func, line))
753 . {* Do these three do anything useful at all, for any back end? *}
754 .#define bfd_debug_info_start(abfd) \
755 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
757 .#define bfd_debug_info_end(abfd) \
758 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
760 .#define bfd_debug_info_accumulate(abfd, section) \
761 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
764 .#define bfd_stat_arch_elt(abfd, stat) \
765 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
767 .#define bfd_set_arch_mach(abfd, arch, mach)\
768 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
770 .#define bfd_get_relocated_section_contents(abfd, link_info, link_order, data, relocateable, symbols) \
771 . BFD_SEND (abfd, _bfd_get_relocated_section_contents, \
772 . (abfd, link_info, link_order, data, relocateable, symbols))
774 .#define bfd_relax_section(abfd, section, link_info, symbols) \
775 . BFD_SEND (abfd, _bfd_relax_section, \
776 . (abfd, section, link_info, symbols))
778 .#define bfd_link_hash_table_create(abfd) \
779 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
781 .#define bfd_link_add_symbols(abfd, info) \
782 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
784 .#define bfd_final_link(abfd, info) \
785 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))