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 descriptor being cached? That is, can it be closed as
52 . needed, and re-opened when accessed later? *}
56 . {* Marks whether there was a default target specified when the
57 . BFD was opened. This is used to select what matching algorithm
58 . to use to chose the back end. *}
60 . boolean target_defaulted;
62 . {* The caching routines use these to maintain a
63 . least-recently-used list of BFDs *}
65 . struct _bfd *lru_prev, *lru_next;
67 . {* When a file is closed by the caching routines, BFD retains
68 . state information on the file here:
75 . boolean opened_once;
77 . {* Set if we have a locally maintained mtime value, rather than
78 . getting it from the file each time: *}
82 . {* File modified time, if mtime_set is true: *}
86 . {* Reserved for an unimplemented file locking extension.*}
90 . {* The format which belongs to the BFD.*}
94 . {* The direction the BFD was opened with*}
96 . enum bfd_direction {no_direction = 0,
98 . write_direction = 2,
99 . both_direction = 3} direction;
101 . {* Format_specific flags*}
105 . {* Currently my_archive is tested before adding origin to
106 . anything. I believe that this can become always an add of
107 . origin, with origin set to 0 for non archive files. *}
111 . {* Remember when output has begun, to stop strange things
113 . boolean output_has_begun;
115 . {* Pointer to linked list of sections*}
116 . struct sec *sections;
118 . {* The number of sections *}
119 . unsigned int section_count;
121 . {* Stuff only useful for object files:
122 . The start address. *}
123 . bfd_vma start_address;
125 . {* Used for input and output*}
126 . unsigned int symcount;
128 . {* Symbol table for output BFD*}
129 . struct symbol_cache_entry **outsymbols;
131 . {* Pointer to structure which contains architecture information*}
132 . struct bfd_arch_info *arch_info;
134 . {* Stuff only useful for archives:*}
136 . struct _bfd *my_archive;
138 . struct _bfd *archive_head;
141 . {* Used by the back end to hold private data. *}
145 . struct aout_data_struct *aout_data;
146 . struct artdata *aout_ar_data;
147 . struct _oasys_data *oasys_obj_data;
148 . struct _oasys_ar_data *oasys_ar_data;
149 . struct coff_tdata *coff_obj_data;
150 . struct ecoff_tdata *ecoff_obj_data;
151 . struct ieee_data_struct *ieee_data;
152 . struct ieee_ar_data_struct *ieee_ar_data;
153 . struct srec_data_struct *srec_data;
154 . struct tekhex_data_struct *tekhex_data;
155 . struct elf_obj_tdata *elf_obj_data;
156 . struct nlm_obj_tdata *nlm_obj_data;
157 . struct bout_data_struct *bout_data;
158 . struct sun_core_struct *sun_core_data;
159 . struct trad_core_struct *trad_core_data;
160 . struct som_data_struct *som_data;
161 . struct hpux_core_struct *hpux_core_data;
162 . struct sgi_core_struct *sgi_core_data;
163 . struct lynx_core_struct *lynx_core_data;
164 . struct osf_core_struct *osf_core_data;
168 . {* Used by the application to hold private data*}
171 . {* Where all the allocated stuff under this BFD goes *}
172 . struct obstack memory;
174 . {* Is this really needed in addition to usrdata? *}
175 . asymbol **ld_symbols;
183 #include "coff/internal.h"
184 #include "coff/sym.h"
186 #include "libecoff.h"
191 extern char *strerror();
194 o - Most functions return nonzero on success (check doc for
195 precise semantics); 0 or NULL on error.
196 o - Internal errors are documented by the value of bfd_error.
197 If that is system_call_error then check errno.
198 o - The easiest way to report this to the user is to use bfd_perror.
201 bfd_ec bfd_error = no_error;
203 CONST char *CONST bfd_errmsgs[] = {
207 "File in wrong format",
211 "No relocation info",
212 "No more archived files",
215 "File format not recognized",
216 "File format is ambiguous",
217 "Section has no contents",
218 "Nonrepresentable section on output",
219 "Symbol needs debug section which does not exist",
222 "#<Invalid error code>"
227 DEFUN(bfd_nonrepresentable_section,(abfd, name),
228 CONST bfd * CONST abfd AND
229 CONST char * CONST name)
232 "bfd error writing file %s, format %s can't represent section %s\n",
242 DEFUN(bfd_undefined_symbol,(relent, seclet),
243 CONST arelent *relent AND
244 CONST struct bfd_seclet *seclet)
246 asymbol *symbol = *(relent->sym_ptr_ptr);
247 fprintf(stderr, "bfd error relocating, symbol %s is undefined\n",
254 DEFUN(bfd_reloc_value_truncated,(relent, seclet),
255 CONST arelent *relent AND
256 struct bfd_seclet *seclet)
258 fprintf(stderr, "bfd error relocating, value truncated\n");
264 DEFUN(bfd_reloc_is_dangerous,(relent, seclet),
265 CONST arelent *relent AND
266 CONST struct bfd_seclet *seclet)
268 fprintf(stderr, "bfd error relocating, dangerous\n");
272 bfd_error_vector_type bfd_error_vector =
274 bfd_nonrepresentable_section ,
275 bfd_undefined_symbol,
276 bfd_reloc_value_truncated,
277 bfd_reloc_is_dangerous,
282 bfd_errmsg (error_tag)
288 if (error_tag == system_call_error)
289 return strerror (errno);
291 if ((((int)error_tag <(int) no_error) ||
292 ((int)error_tag > (int)invalid_error_code)))
293 error_tag = invalid_error_code;/* sanity check */
295 return bfd_errmsgs [(int)error_tag];
299 DEFUN (bfd_default_error_trap, (error_tag),
302 fprintf(stderr, "bfd assert fail (%s)\n", bfd_errmsg(error_tag));
305 void (*bfd_error_trap) PARAMS ((bfd_ec)) = bfd_default_error_trap;
306 void (*bfd_error_nonrepresentabltrap) PARAMS ((bfd_ec)) = bfd_default_error_trap;
309 DEFUN(bfd_perror,(message),
312 if (bfd_error == system_call_error)
313 perror((char *)message); /* must be system error then... */
315 if (message == NULL || *message == '\0')
316 fprintf (stderr, "%s\n", bfd_errmsg (bfd_error));
318 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_error));
328 bfd_get_reloc_upper_bound
331 unsigned int bfd_get_reloc_upper_bound(bfd *abfd, asection *sect);
334 This function return the number of bytes required to store the
335 relocation information associated with section <<sect>>
336 attached to bfd <<abfd>>
342 DEFUN(bfd_get_reloc_upper_bound,(abfd, asect),
346 if (abfd->format != bfd_object) {
347 bfd_error = invalid_operation;
351 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
356 bfd_canonicalize_reloc
359 unsigned int bfd_canonicalize_reloc
366 This function calls the back end associated with the open
367 <<abfd>> and translates the external form of the relocation
368 information attached to <<sec>> into the internal canonical
369 form. The table is placed into memory at <<loc>>, which has
370 been preallocated, usually by a call to
371 <<bfd_get_reloc_upper_bound>>.
373 The <<syms>> table is also needed for horrible internal magic
379 DEFUN(bfd_canonicalize_reloc,(abfd, asect, location, symbols),
382 arelent **location AND
385 if (abfd->format != bfd_object) {
386 bfd_error = invalid_operation;
389 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
390 (abfd, asect, location, symbols));
399 boolean bfd_set_file_flags(bfd *abfd, flagword flags);
402 This function attempts to set the flag word in the referenced
403 BFD structure to the value supplied.
406 o wrong_format - The target bfd was not of object format.
407 o invalid_operation - The target bfd was open for reading.
408 o invalid_operation -
409 The flag word contained a bit which was not applicable to the
410 type of file. eg, an attempt was made to set the D_PAGED bit
411 on a bfd format which does not support demand paging
416 bfd_set_file_flags (abfd, flags)
420 if (abfd->format != bfd_object) {
421 bfd_error = wrong_format;
425 if (bfd_read_p (abfd)) {
426 bfd_error = invalid_operation;
430 bfd_get_file_flags (abfd) = flags;
431 if ((flags & bfd_applicable_file_flags (abfd)) != flags) {
432 bfd_error = invalid_operation;
445 (bfd *abfd, asection *sec, arelent **rel, unsigned int count)
448 This function sets the relocation pointer and count within a
449 section to the supplied values.
454 bfd_set_reloc (ignore_abfd, asect, location, count)
460 asect->orelocation = location;
461 asect->reloc_count = count;
465 bfd_assert(file, line)
469 fprintf(stderr, "bfd assertion fail %s:%d\n",file,line);
475 bfd_set_start_address
478 Marks the entry point of an output BFD.
481 Returns <<true>> on success, <<false>> otherwise.
484 boolean bfd_set_start_address(bfd *, bfd_vma);
488 bfd_set_start_address(abfd, vma)
492 abfd->start_address = vma;
499 The bfd_get_mtime function
502 long bfd_get_mtime(bfd *);
505 Return file modification time (as read from file system, or
506 from archive header for archive members).
520 fp = bfd_cache_lookup (abfd);
521 if (0 != fstat (fileno (fp), &buf))
524 abfd->mtime = buf.st_mtime; /* Save value in case anyone wants it */
530 The bfd_get_size function
533 long bfd_get_size(bfd *);
536 Return file size (as read from file system) for the file
537 associated with a bfd.
539 Note that the initial motivation for, and use of, this routine is not
540 so we can get the exact size of the object the bfd applies to, since
541 that might not be generally possible (archive members for example?).
542 Although it would be ideal if someone could eventually modify
543 it so that such results were guaranteed.
545 Instead, we want to ask questions like "is this NNN byte sized
546 object I'm about to try read from file offset YYY reasonable?"
547 As as example of where we might want to do this, some object formats
548 use string tables for which the first sizeof(long) bytes of the table
549 contain the size of the table itself, including the size bytes.
550 If an application tries to read what it thinks is one of these
551 string tables, without some way to validate the size, and for
552 some reason the size is wrong (byte swapping error, wrong location
553 for the string table, etc), the only clue is likely to be a read
554 error when it tries to read the table, or a "virtual memory
555 exhausted" error when it tries to allocated 15 bazillon bytes
556 of space for the 15 bazillon byte table it is about to read.
557 This function at least allows us to answer the quesion, "is the
568 fp = bfd_cache_lookup (abfd);
569 if (0 != fstat (fileno (fp), &buf))
577 The bfd_get_gp_size function
580 int bfd_get_gp_size(bfd *);
583 Get the maximum size of objects to be optimized using the GP
584 register under MIPS ECOFF. This is typically set by the -G
585 argument to the compiler, assembler or linker.
589 bfd_get_gp_size (abfd)
592 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
593 return ecoff_data (abfd)->gp_size;
599 The bfd_set_gp_size function
602 void bfd_set_gp_size(bfd *, int);
605 Set the maximum size of objects to be optimized using the GP
606 register under ECOFF or MIPS ELF. This is typically set by
607 the -G argument to the compiler, assembler or linker.
611 bfd_set_gp_size (abfd, i)
615 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
616 ecoff_data (abfd)->gp_size = i;
617 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
618 elf_gp_size (abfd) = i;
626 Converts, like strtoul, a numerical expression as a
627 string into a bfd_vma integer, and returns that integer.
628 (Though without as many bells and whistles as strtoul.)
629 The expression is assumed to be unsigned (i.e. positive).
630 If given a base, it is used as the base for conversion.
631 A base of 0 causes the function to interpret the string
632 in hex if a leading "0x" or "0X" is found, otherwise
633 in octal if a leading zero is found, otherwise in decimal.
635 Overflow is not detected.
638 bfd_vma bfd_scan_vma(CONST char *string, CONST char **end, int base);
642 DEFUN(bfd_scan_vma,(string, end, base),
643 CONST char *string AND
650 /* Let the host do it if possible. */
651 if (sizeof(bfd_vma) <= sizeof(unsigned long))
652 return (bfd_vma) strtoul (string, 0, base);
654 /* A negative base makes no sense, and we only need to go as high as hex. */
655 if ((base < 0) || (base > 16))
660 if (string[0] == '0')
662 if ((string[1] == 'x') || (string[1] == 'X'))
664 /* XXX should we also allow "0b" or "0B" to set base to 2? */
672 (string[0] == '0') && ((string[1] == 'x') || (string[1] == 'X')))
674 /* XXX should we also skip over "0b" or "0B" if base is 2? */
676 /* Speed could be improved with a table like hex_value[] in gas. */
677 #define HEX_VALUE(c) \
681 (10 + c - (islower(c) ? 'a' : 'A'))) : \
684 for (value = 0; (digit = HEX_VALUE(*string)) < base; string++)
686 value = value * base + digit;
700 stuff which should be documented
702 .#define bfd_sizeof_headers(abfd, reloc) \
703 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
705 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
706 . BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, sec, syms, off, file, func, line))
708 . {* Do these three do anything useful at all, for any back end? *}
709 .#define bfd_debug_info_start(abfd) \
710 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
712 .#define bfd_debug_info_end(abfd) \
713 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
715 .#define bfd_debug_info_accumulate(abfd, section) \
716 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
719 .#define bfd_stat_arch_elt(abfd, stat) \
720 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
722 .#define bfd_set_arch_mach(abfd, arch, mach)\
723 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
725 .#define bfd_get_relocated_section_contents(abfd, seclet, data, relocateable) \
726 . BFD_SEND (abfd, _bfd_get_relocated_section_contents, (abfd, seclet, data, relocateable))
728 .#define bfd_relax_section(abfd, section, symbols) \
729 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, symbols))
731 .#define bfd_seclet_link(abfd, data, relocateable) \
732 . BFD_SEND (abfd, _bfd_seclet_link, (abfd, data, relocateable))