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. */
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 ieee_data_struct *ieee_data;
150 . struct ieee_ar_data_struct *ieee_ar_data;
151 . struct srec_data_struct *srec_data;
152 . struct tekhex_data_struct *tekhex_data;
153 . struct elf_obj_tdata *elf_obj_data;
154 . struct bout_data_struct *bout_data;
155 . struct sun_core_struct *sun_core_data;
156 . struct trad_core_struct *trad_core_data;
157 . struct hppa_data_struct *hppa_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 . {* Is this really needed in addition to usrdata? *}
168 . asymbol **ld_symbols;
178 extern char *strerror();
181 CONST
short _bfd_host_big_endian
= 0x0100;
182 /* Accessing the above as (*(char*)&_bfd_host_big_endian), will
183 return 1 if the host is big-endian, 0 otherwise.
184 (assuming that a short is two bytes long!!! FIXME)
185 (See HOST_IS_BIG_ENDIAN_P in bfd.h.) */
188 o - Most functions return nonzero on success (check doc for
189 precise semantics); 0 or NULL on error.
190 o - Internal errors are documented by the value of bfd_error.
191 If that is system_call_error then check errno.
192 o - The easiest way to report this to the user is to use bfd_perror.
195 bfd_ec bfd_error
= no_error
;
197 CONST
char *CONST bfd_errmsgs
[] = { "No error",
200 "File in wrong format",
204 "No relocation info",
205 "No more archived files",
208 "File format not recognized",
209 "File format is ambiguous",
210 "Section has no contents",
211 "Nonrepresentable section on output",
212 "Symbol needs debug section which does not exist",
214 "#<Invalid error code>"
219 DEFUN(bfd_nonrepresentable_section
,(abfd
, name
),
220 CONST bfd
* CONST abfd AND
221 CONST
char * CONST name
)
223 printf("bfd error writing file %s, format %s can't represent section %s\n",
233 DEFUN(bfd_undefined_symbol
,(relent
, seclet
),
234 CONST arelent
*relent AND
235 CONST
struct bfd_seclet
*seclet
)
237 asymbol
*symbol
= *(relent
->sym_ptr_ptr
);
238 printf("bfd error relocating, symbol %s is undefined\n",
245 DEFUN(bfd_reloc_value_truncated
,(relent
, seclet
),
246 CONST arelent
*relent AND
247 struct bfd_seclet
*seclet
)
249 printf("bfd error relocating, value truncated\n");
255 DEFUN(bfd_reloc_is_dangerous
,(relent
, seclet
),
256 CONST arelent
*relent AND
257 CONST
struct bfd_seclet
*seclet
)
259 printf("bfd error relocating, dangerous\n");
263 bfd_error_vector_type bfd_error_vector
=
265 bfd_nonrepresentable_section
,
266 bfd_undefined_symbol
,
267 bfd_reloc_value_truncated
,
268 bfd_reloc_is_dangerous
,
273 bfd_errmsg (error_tag
)
279 if (error_tag
== system_call_error
)
280 return strerror (errno
);
282 if ((((int)error_tag
<(int) no_error
) ||
283 ((int)error_tag
> (int)invalid_error_code
)))
284 error_tag
= invalid_error_code
;/* sanity check */
286 return bfd_errmsgs
[(int)error_tag
];
290 void bfd_default_error_trap(error_tag
)
293 printf("bfd assert fail (%s)\n", bfd_errmsg(error_tag
));
296 void (*bfd_error_trap
)() = bfd_default_error_trap
;
297 void (*bfd_error_nonrepresentabltrap
)() = bfd_default_error_trap
;
300 DEFUN(bfd_perror
,(message
),
303 if (bfd_error
== system_call_error
)
304 perror((char *)message
); /* must be system error then... */
306 if (message
== NULL
|| *message
== '\0')
307 fprintf (stderr
, "%s\n", bfd_errmsg (bfd_error
));
309 fprintf (stderr
, "%s: %s\n", message
, bfd_errmsg (bfd_error
));
319 bfd_get_reloc_upper_bound
322 unsigned int bfd_get_reloc_upper_bound(bfd *abfd, asection *sect);
325 This function return the number of bytes required to store the
326 relocation information associated with section <<sect>>
327 attached to bfd <<abfd>>
333 DEFUN(bfd_get_reloc_upper_bound
,(abfd
, asect
),
337 if (abfd
->format
!= bfd_object
) {
338 bfd_error
= invalid_operation
;
342 return BFD_SEND (abfd
, _get_reloc_upper_bound
, (abfd
, asect
));
347 bfd_canonicalize_reloc
350 unsigned int bfd_canonicalize_reloc
357 This function calls the back end associated with the open
358 <<abfd>> and translates the external form of the relocation
359 information attached to <<sec>> into the internal canonical
360 form. The table is placed into memory at <<loc>>, which has
361 been preallocated, usually by a call to
362 <<bfd_get_reloc_upper_bound>>.
364 The <<syms>> table is also needed for horrible internal magic
370 DEFUN(bfd_canonicalize_reloc
,(abfd
, asect
, location
, symbols
),
373 arelent
**location AND
376 if (abfd
->format
!= bfd_object
) {
377 bfd_error
= invalid_operation
;
380 return BFD_SEND (abfd
, _bfd_canonicalize_reloc
,
381 (abfd
, asect
, location
, symbols
));
390 boolean bfd_set_file_flags(bfd *abfd, flagword flags);
393 This function attempts to set the flag word in the referenced
394 BFD structure to the value supplied.
397 o wrong_format - The target bfd was not of object format.
398 o invalid_operation - The target bfd was open for reading.
399 o invalid_operation -
400 The flag word contained a bit which was not applicable to the
401 type of file. eg, an attempt was made to set the D_PAGED bit
402 on a bfd format which does not support demand paging
407 bfd_set_file_flags (abfd
, flags
)
411 if (abfd
->format
!= bfd_object
) {
412 bfd_error
= wrong_format
;
416 if (bfd_read_p (abfd
)) {
417 bfd_error
= invalid_operation
;
421 bfd_get_file_flags (abfd
) = flags
;
422 if ((flags
& bfd_applicable_file_flags (abfd
)) != flags
) {
423 bfd_error
= invalid_operation
;
436 (bfd *abfd, asection *sec, arelent **rel, unsigned int count)
439 This function sets the relocation pointer and count within a
440 section to the supplied values.
445 bfd_set_reloc (ignore_abfd
, asect
, location
, count
)
451 asect
->orelocation
= location
;
452 asect
->reloc_count
= count
;
456 bfd_assert(file
, line
)
460 printf("bfd assertion fail %s:%d\n",file
,line
);
466 bfd_set_start_address
469 Marks the entry point of an output BFD.
472 Returns <<true>> on success, <<false>> otherwise.
475 boolean bfd_set_start_address(bfd *, bfd_vma);
479 bfd_set_start_address(abfd
, vma
)
483 abfd
->start_address
= vma
;
490 The bfd_get_mtime function
493 long bfd_get_mtime(bfd *);
496 Return file modification time (as read from file system, or
497 from archive header for archive members).
511 fp
= bfd_cache_lookup (abfd
);
512 if (0 != fstat (fileno (fp
), &buf
))
515 abfd
->mtime
= buf
.st_mtime
; /* Save value in case anyone wants it */
524 stuff which should be documented
526 .#define bfd_sizeof_headers(abfd, reloc) \
527 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
529 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
530 . BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, sec, syms, off, file, func, line))
532 . {* Do these three do anything useful at all, for any back end? *}
533 .#define bfd_debug_info_start(abfd) \
534 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
536 .#define bfd_debug_info_end(abfd) \
537 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
539 .#define bfd_debug_info_accumulate(abfd, section) \
540 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
543 .#define bfd_stat_arch_elt(abfd, stat) \
544 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
546 .#define bfd_set_arch_mach(abfd, arch, mach)\
547 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
549 .#define bfd_get_relocated_section_contents(abfd, seclet, data) \
550 . BFD_SEND (abfd, _bfd_get_relocated_section_contents, (abfd, seclet, data))
552 .#define bfd_relax_section(abfd, section, symbols) \
553 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, symbols))