1 /* Generic BFD library interface and support routines.
2 Copyright (C) 1990-1991 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. */
27 A BFD is has type <<bfd>>; objects of this type are the
28 cornerstone of any application using <<libbfd>>. References
29 though the BFD and to data in the BFD give the entire BFD
32 Here is the struct used to define the type <<bfd>>. This
33 contains he major data about the file, and contains pointers
34 to the rest of the data.
40 . {* The filename the application opened the BFD with. *}
41 . CONST char *filename;
43 . {* A pointer to the target jump table. *}
44 . struct bfd_target *xvec;
46 . {* To avoid dragging too many header files into every file that
47 . includes @file{bfd.h}, IOSTREAM has been declared as a "char
48 . *", and MTIME as a "long". Their correct types, to which they
49 . are cast when used, are "FILE *" and "time_t". The iostream
50 . is the result of an fopen on the filename. *}
53 . {* Is the file being cached *}
57 . {* Marks whether there was a default target specified when the
58 . BFD was opened. This is used to select what matching algorithm
59 . to use to chose the back end. *}
61 . boolean target_defaulted;
63 . {* The caching routines use these to maintain a
64 . least-recently-used list of BFDs *}
66 . struct _bfd *lru_prev, *lru_next;
68 . {* When a file is closed by the caching routines, BFD retains
69 . state information on the file here:
76 . boolean opened_once;
78 . {* Set if we have a locally maintained mtime value, rather than
79 . getting it from the file each time: *}
83 . {* File modified time, if mtime_set is true: *}
87 . {* Reserved for an unimplemented file locking extension.*}
91 . {* The format which belongs to the BFD.*}
95 . {* The direction the BFD was opened with*}
97 . enum bfd_direction {no_direction = 0,
99 . write_direction = 2,
100 . both_direction = 3} direction;
102 . {* Format_specific flags*}
106 . {* Currently my_archive is tested before adding origin to
107 . anything. I believe that this can become always an add of
108 . origin, with origin set to 0 for non archive files. *}
112 . {* Remember when output has begun, to stop strange things
114 . boolean output_has_begun;
116 . {* Pointer to linked list of sections*}
117 . struct sec *sections;
119 . {* The number of sections *}
120 . unsigned int section_count;
122 . {* Stuff only useful for object files:
123 . The start address. *}
124 . bfd_vma start_address;
126 . {* Used for input and output*}
127 . unsigned int symcount;
129 . {* Symbol table for output BFD*}
130 . struct symbol_cache_entry **outsymbols;
132 . {* Pointer to structure which contains architecture information*}
133 . struct bfd_arch_info *arch_info;
135 . {* Stuff only useful for archives:*}
137 . struct _bfd *my_archive;
139 . struct _bfd *archive_head;
142 . {* Used by the back end to hold private data. *}
146 . struct aout_data_struct *aout_data;
147 . struct artdata *aout_ar_data;
148 . struct _oasys_data *oasys_obj_data;
149 . struct _oasys_ar_data *oasys_ar_data;
150 . struct coff_tdata *coff_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 elf_obj_tdata_struct *elf_obj_data;
155 . struct elf_core_tdata_struct *elf_core_data;
156 . struct bout_data_struct *bout_data;
157 . struct sun_core_struct *sun_core_data;
161 . {* Used by the application to hold private data*}
164 . {* Where all the allocated stuff under this BFD goes *}
165 . struct obstack memory;
167 . asymbol **ld_symbols;
177 extern char *strerror();
180 CONST short _bfd_host_big_endian = 0x0100;
181 /* Accessing the above as (*(char*)&_bfd_host_big_endian), will
182 return 1 if the host is big-endian, 0 otherwise.
183 (assuming that a short is two bytes long!!! FIXME)
184 (See HOST_IS_BIG_ENDIAN_P in bfd.h.) */
187 o - Most functions return nonzero on success (check doc for
188 precise semantics); 0 or NULL on error.
189 o - Internal errors are documented by the value of bfd_error.
190 If that is system_call_error then check errno.
191 o - The easiest way to report this to the user is to use bfd_perror.
194 bfd_ec bfd_error = no_error;
196 char *bfd_errmsgs[] = { "No error",
199 "File in wrong format",
203 "No relocation info",
204 "No more archived files",
207 "File format not recognized",
208 "File format is ambiguous",
209 "Section has no contents",
210 "Nonrepresentable section on output",
211 "Symbol needs debug section which does not exist",
212 "#<Invalid error code>"
217 DEFUN(bfd_nonrepresentable_section,(abfd, name),
218 CONST bfd * CONST abfd AND
219 CONST char * CONST name)
221 printf("bfd error writing file %s, format %s can't represent section %s\n",
230 DEFUN(bfd_undefined_symbol,(relent, seclet),
231 CONST arelent *relent AND
232 CONST struct bfd_seclet_struct *seclet)
234 asymbol *symbol = *(relent->sym_ptr_ptr);
235 printf("bfd error relocating, symbol %s is undefined\n",
241 DEFUN(bfd_reloc_value_truncated,(relent, seclet),
242 CONST arelent *relent AND
243 struct bfd_seclet_struct *seclet)
245 asymbol *symbol = *(relent->sym_ptr_ptr);
246 printf("bfd error relocating, value truncated\n");
251 DEFUN(bfd_reloc_is_dangerous,(relent, seclet),
252 CONST arelent *relent AND
253 CONST struct bfd_seclet_struct *seclet)
255 asymbol *symbol = *(relent->sym_ptr_ptr);
256 printf("bfd error relocating, dangerous\n");
260 bfd_error_vector_type bfd_error_vector =
262 bfd_nonrepresentable_section ,
263 bfd_undefined_symbol,
264 bfd_reloc_value_truncated,
265 bfd_reloc_is_dangerous,
270 bfd_errmsg (error_tag)
276 if (error_tag == system_call_error)
277 return strerror (errno);
279 if ((((int)error_tag <(int) no_error) ||
280 ((int)error_tag > (int)invalid_error_code)))
281 error_tag = invalid_error_code;/* sanity check */
283 return bfd_errmsgs [(int)error_tag];
287 void bfd_default_error_trap(error_tag)
290 printf("bfd assert fail (%s)\n", bfd_errmsg(error_tag));
293 void (*bfd_error_trap)() = bfd_default_error_trap;
294 void (*bfd_error_nonrepresentabltrap)() = bfd_default_error_trap;
297 DEFUN(bfd_perror,(message),
300 if (bfd_error == system_call_error)
301 perror((char *)message); /* must be system error then... */
303 if (message == NULL || *message == '\0')
304 fprintf (stderr, "%s\n", bfd_errmsg (bfd_error));
306 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_error));
316 bfd_get_reloc_upper_bound
319 unsigned int bfd_get_reloc_upper_bound(bfd *abfd, asection *sect);
322 This function return the number of bytes required to store the
323 relocation information associated with section <<sect>>
324 attached to bfd <<abfd>>
330 DEFUN(bfd_get_reloc_upper_bound,(abfd, asect),
334 if (abfd->format != bfd_object) {
335 bfd_error = invalid_operation;
339 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
344 bfd_canonicalize_reloc
347 unsigned int bfd_canonicalize_reloc
354 This function calls the back end associated with the open
355 <<abfd>> and translates the external form of the relocation
356 information attached to <<sec>> into the internal canonical
357 form. The table is placed into memory at <<loc>>, which has
358 been preallocated, usually by a call to
359 <<bfd_get_reloc_upper_bound>>.
361 The <<syms>> table is also needed for horrible internal magic
367 DEFUN(bfd_canonicalize_reloc,(abfd, asect, location, symbols),
370 arelent **location AND
373 if (abfd->format != bfd_object) {
374 bfd_error = invalid_operation;
377 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
378 (abfd, asect, location, symbols));
387 boolean bfd_set_file_flags(bfd *abfd, flagword flags);
390 This function attempts to set the flag word in the referenced
391 BFD structure to the value supplied.
394 o wrong_format - The target bfd was not of object format.
395 o invalid_operation - The target bfd was open for reading.
396 o invalid_operation -
397 The flag word contained a bit which was not applicable to the
398 type of file. eg, an attempt was made to set the D_PAGED bit
399 on a bfd format which does not support demand paging
404 bfd_set_file_flags (abfd, flags)
408 if (abfd->format != bfd_object) {
409 bfd_error = wrong_format;
413 if (bfd_read_p (abfd)) {
414 bfd_error = invalid_operation;
418 if ((flags & bfd_applicable_file_flags (abfd)) != flags) {
419 bfd_error = invalid_operation;
423 bfd_get_file_flags (abfd) = flags;
433 (bfd *abfd, asection *sec, arelent **rel, unsigned int count)
436 This function sets the relocation pointer and count within a
437 section to the supplied values.
442 bfd_set_reloc (ignore_abfd, asect, location, count)
448 asect->orelocation = location;
449 asect->reloc_count = count;
453 bfd_assert(file, line)
457 printf("bfd assertion fail %s:%d\n",file,line);
463 bfd_set_start_address
466 Marks the entry point of an output BFD.
469 Returns <<true>> on success, <<false>> otherwise.
472 boolean bfd_set_start_address(bfd *, bfd_vma);
476 bfd_set_start_address(abfd, vma)
480 abfd->start_address = vma;
487 The bfd_get_mtime function
490 long bfd_get_mtime(bfd *);
493 Return file modification time (as read from file system, or
494 from archive header for archive members).
508 fp = bfd_cache_lookup (abfd);
509 if (0 != fstat (fileno (fp), &buf))
512 abfd->mtime = buf.st_mtime; /* Save value in case anyone wants it */
521 stuff which should be documented
523 .#define bfd_sizeof_headers(abfd, reloc) \
524 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
526 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
527 . BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, sec, syms, off, file, func, line))
529 .#define bfd_debug_info_start(abfd) \
530 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
532 .#define bfd_debug_info_end(abfd) \
533 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
535 .#define bfd_debug_info_accumulate(abfd, section) \
536 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
538 .#define bfd_stat_arch_elt(abfd, stat) \
539 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
541 .#define bfd_coff_swap_aux_in(a,e,t,c,i) \
542 . BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i))
544 .#define bfd_coff_swap_sym_in(a,e,i) \
545 . BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i))
547 .#define bfd_coff_swap_lineno_in(a,e,i) \
548 . BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i))
550 .#define bfd_set_arch_mach(abfd, arch, mach)\
551 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
553 .#define bfd_coff_swap_reloc_out(abfd, i, o) \
554 . BFD_SEND (abfd, _bfd_coff_swap_reloc_out, (abfd, i, o))
556 .#define bfd_coff_swap_lineno_out(abfd, i, o) \
557 . BFD_SEND (abfd, _bfd_coff_swap_lineno_out, (abfd, i, o))
559 .#define bfd_coff_swap_aux_out(abfd, i, t,c,o) \
560 . BFD_SEND (abfd, _bfd_coff_swap_aux_out, (abfd, i,t,c, o))
562 .#define bfd_coff_swap_sym_out(abfd, i,o) \
563 . BFD_SEND (abfd, _bfd_coff_swap_sym_out, (abfd, i, o))
565 .#define bfd_coff_swap_scnhdr_out(abfd, i,o) \
566 . BFD_SEND (abfd, _bfd_coff_swap_scnhdr_out, (abfd, i, o))
568 .#define bfd_coff_swap_filehdr_out(abfd, i,o) \
569 . BFD_SEND (abfd, _bfd_coff_swap_filehdr_out, (abfd, i, o))
571 .#define bfd_coff_swap_aouthdr_out(abfd, i,o) \
572 . BFD_SEND (abfd, _bfd_coff_swap_aouthdr_out, (abfd, i, o))
574 .#define bfd_get_relocated_section_contents(abfd, seclet) \
575 . BFD_SEND (abfd, _bfd_get_relocated_section_contents, (abfd, seclet))