1 /* Generic BFD library interface and support routines.
2 Copyright (C) 1990-2014 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 3 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., 51 Franklin Street - Fifth Floor, Boston,
20 MA 02110-1301, USA. */
24 typedef bfd, Error reporting, BFD front end, BFD front end
29 A BFD has type <<bfd>>; objects of this type are the
30 cornerstone of any application using BFD. Using BFD
31 consists of making references though the BFD and to data in the BFD.
33 Here is the structure that defines the type <<bfd>>. It
34 contains the major data about the file and pointers
35 to the rest of the data.
43 . write_direction = 2,
49 . {* A unique identifier of the BFD *}
52 . {* The filename the application opened the BFD with. *}
53 . const char *filename;
55 . {* A pointer to the target jump table. *}
56 . const struct bfd_target *xvec;
58 . {* The IOSTREAM, and corresponding IO vector that provide access
59 . to the file backing the BFD. *}
61 . const struct bfd_iovec *iovec;
63 . {* The caching routines use these to maintain a
64 . 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... *}
71 . {* File modified time, if mtime_set is TRUE. *}
74 . {* Reserved for an unimplemented file locking extension. *}
77 . {* The format which belongs to the BFD. (object, core, etc.) *}
80 . {* The direction with which the BFD was opened. *}
81 . enum bfd_direction direction;
83 . {* Format_specific flags. *}
86 . {* Values that may appear in the flags field of a BFD. These also
87 . appear in the object_flags field of the bfd_target structure, where
88 . they indicate the set of flags used by that backend (not all flags
89 . are meaningful for all object file formats) (FIXME: at the moment,
90 . the object_flags values have mostly just been copied from backend
91 . to another, and are not necessarily correct). *}
93 .#define BFD_NO_FLAGS 0x00
95 . {* BFD contains relocation entries. *}
96 .#define HAS_RELOC 0x01
98 . {* BFD is directly executable. *}
101 . {* BFD has line number information (basically used for F_LNNO in a
103 .#define HAS_LINENO 0x04
105 . {* BFD has debugging information. *}
106 .#define HAS_DEBUG 0x08
108 . {* BFD has symbols. *}
109 .#define HAS_SYMS 0x10
111 . {* BFD has local symbols (basically used for F_LSYMS in a COFF
113 .#define HAS_LOCALS 0x20
115 . {* BFD is a dynamic object. *}
116 .#define DYNAMIC 0x40
118 . {* Text section is write protected (if D_PAGED is not set, this is
119 . like an a.out NMAGIC file) (the linker sets this by default, but
120 . clears it for -r or -N). *}
121 .#define WP_TEXT 0x80
123 . {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
124 . linker sets this by default, but clears it for -r or -n or -N). *}
125 .#define D_PAGED 0x100
127 . {* BFD is relaxable (this means that bfd_relax_section may be able to
128 . do something) (sometimes bfd_relax_section can do something even if
129 . this is not set). *}
130 .#define BFD_IS_RELAXABLE 0x200
132 . {* This may be set before writing out a BFD to request using a
133 . traditional format. For example, this is used to request that when
134 . writing out an a.out object the symbols not be hashed to eliminate
136 .#define BFD_TRADITIONAL_FORMAT 0x400
138 . {* This flag indicates that the BFD contents are actually cached
139 . in memory. If this is set, iostream points to a bfd_in_memory
141 .#define BFD_IN_MEMORY 0x800
143 . {* The sections in this BFD specify a memory page. *}
144 .#define HAS_LOAD_PAGE 0x1000
146 . {* This BFD has been created by the linker and doesn't correspond
147 . to any input file. *}
148 .#define BFD_LINKER_CREATED 0x2000
150 . {* This may be set before writing out a BFD to request that it
151 . be written using values for UIDs, GIDs, timestamps, etc. that
152 . will be consistent from run to run. *}
153 .#define BFD_DETERMINISTIC_OUTPUT 0x4000
155 . {* Compress sections in this BFD. *}
156 .#define BFD_COMPRESS 0x8000
158 . {* Decompress sections in this BFD. *}
159 .#define BFD_DECOMPRESS 0x10000
161 . {* BFD is a dummy, for plugins. *}
162 .#define BFD_PLUGIN 0x20000
164 . {* Flags bits to be saved in bfd_preserve_save. *}
165 .#define BFD_FLAGS_SAVED \
166 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_PLUGIN)
168 . {* Flags bits which are for BFD use only. *}
169 .#define BFD_FLAGS_FOR_BFD_USE_MASK \
170 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
171 . | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT)
173 . {* Currently my_archive is tested before adding origin to
174 . anything. I believe that this can become always an add of
175 . origin, with origin set to 0 for non archive files. *}
178 . {* The origin in the archive of the proxy entry. This will
179 . normally be the same as origin, except for thin archives,
180 . when it will contain the current offset of the proxy in the
181 . thin archive rather than the offset of the bfd in its actual
183 . ufile_ptr proxy_origin;
185 . {* A hash table for section names. *}
186 . struct bfd_hash_table section_htab;
188 . {* Pointer to linked list of sections. *}
189 . struct bfd_section *sections;
191 . {* The last section on the section list. *}
192 . struct bfd_section *section_last;
194 . {* The number of sections. *}
195 . unsigned int section_count;
197 . {* Stuff only useful for object files:
198 . The start address. *}
199 . bfd_vma start_address;
201 . {* Used for input and output. *}
202 . unsigned int symcount;
204 . {* Symbol table for output BFD (with symcount entries).
205 . Also used by the linker to cache input BFD symbols. *}
206 . struct bfd_symbol **outsymbols;
208 . {* Used for slurped dynamic symbol tables. *}
209 . unsigned int dynsymcount;
211 . {* Pointer to structure which contains architecture information. *}
212 . const struct bfd_arch_info *arch_info;
214 . {* Stuff only useful for archives. *}
216 . struct bfd *my_archive; {* The containing archive BFD. *}
217 . struct bfd *archive_next; {* The next BFD in the archive. *}
218 . struct bfd *archive_head; {* The first BFD in the archive. *}
219 . struct bfd *nested_archives; {* List of nested archive in a flattened
223 . {* For input BFDs, a chain of BFDs involved in a link. *}
225 . {* For output BFD, the linker hash table. *}
226 . struct bfd_link_hash_table *hash;
229 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
230 . be used only for archive elements. *}
233 . {* Used by the back end to hold private data. *}
236 . struct aout_data_struct *aout_data;
237 . struct artdata *aout_ar_data;
238 . struct _oasys_data *oasys_obj_data;
239 . struct _oasys_ar_data *oasys_ar_data;
240 . struct coff_tdata *coff_obj_data;
241 . struct pe_tdata *pe_obj_data;
242 . struct xcoff_tdata *xcoff_obj_data;
243 . struct ecoff_tdata *ecoff_obj_data;
244 . struct ieee_data_struct *ieee_data;
245 . struct ieee_ar_data_struct *ieee_ar_data;
246 . struct srec_data_struct *srec_data;
247 . struct verilog_data_struct *verilog_data;
248 . struct ihex_data_struct *ihex_data;
249 . struct tekhex_data_struct *tekhex_data;
250 . struct elf_obj_tdata *elf_obj_data;
251 . struct nlm_obj_tdata *nlm_obj_data;
252 . struct bout_data_struct *bout_data;
253 . struct mmo_data_struct *mmo_data;
254 . struct sun_core_struct *sun_core_data;
255 . struct sco5_core_struct *sco5_core_data;
256 . struct trad_core_struct *trad_core_data;
257 . struct som_data_struct *som_data;
258 . struct hpux_core_struct *hpux_core_data;
259 . struct hppabsd_core_struct *hppabsd_core_data;
260 . struct sgi_core_struct *sgi_core_data;
261 . struct lynx_core_struct *lynx_core_data;
262 . struct osf_core_struct *osf_core_data;
263 . struct cisco_core_struct *cisco_core_data;
264 . struct versados_data_struct *versados_data;
265 . struct netbsd_core_struct *netbsd_core_data;
266 . struct mach_o_data_struct *mach_o_data;
267 . struct mach_o_fat_data_struct *mach_o_fat_data;
268 . struct plugin_data_struct *plugin_data;
269 . struct bfd_pef_data_struct *pef_data;
270 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
271 . struct bfd_sym_data_struct *sym_data;
276 . {* Used by the application to hold private data. *}
279 . {* Where all the allocated stuff under this BFD goes. This is a
280 . struct objalloc *, but we use void * to avoid requiring the inclusion
284 . {* Is the file descriptor being cached? That is, can it be closed as
285 . needed, and re-opened when accessed later? *}
286 . unsigned int cacheable : 1;
288 . {* Marks whether there was a default target specified when the
289 . BFD was opened. This is used to select which matching algorithm
290 . to use to choose the back end. *}
291 . unsigned int target_defaulted : 1;
293 . {* ... and here: (``once'' means at least once). *}
294 . unsigned int opened_once : 1;
296 . {* Set if we have a locally maintained mtime value, rather than
297 . getting it from the file each time. *}
298 . unsigned int mtime_set : 1;
300 . {* Flag set if symbols from this BFD should not be exported. *}
301 . unsigned int no_export : 1;
303 . {* Remember when output has begun, to stop strange things
305 . unsigned int output_has_begun : 1;
307 . {* Have archive map. *}
308 . unsigned int has_armap : 1;
310 . {* Set if this is a thin archive. *}
311 . unsigned int is_thin_archive : 1;
313 . {* Set if only required symbols should be added in the link hash table for
314 . this object. Used by VMS linkers. *}
315 . unsigned int selective_search : 1;
318 .{* See note beside bfd_set_section_userdata. *}
319 .static inline bfd_boolean
320 .bfd_set_cacheable (bfd * abfd, bfd_boolean val)
322 . abfd->cacheable = val;
332 #include "libiberty.h"
333 #include "demangle.h"
334 #include "safe-ctype.h"
337 #include "coff/internal.h"
338 #include "coff/sym.h"
340 #include "libecoff.h"
345 #define EXIT_FAILURE 1
349 /* provide storage for subsystem, stack and heap data which may have been
350 passed in on the command line. Ld puts this data into a bfd_link_info
351 struct which ultimately gets passed in to the bfd. When it arrives, copy
352 it to the following struct so that the data will be available in coffcode.h
353 where it is needed. The typedef's used are defined in bfd.h */
357 Error reporting, Miscellaneous, typedef bfd, BFD front end
362 Most BFD functions return nonzero on success (check their
363 individual documentation for precise semantics). On an error,
364 they call <<bfd_set_error>> to set an error condition that callers
365 can check by calling <<bfd_get_error>>.
366 If that returns <<bfd_error_system_call>>, then check
369 The easiest way to report a BFD error to the user is to
373 Type <<bfd_error_type>>
375 The values returned by <<bfd_get_error>> are defined by the
376 enumerated type <<bfd_error_type>>.
380 .typedef enum bfd_error
382 . bfd_error_no_error = 0,
383 . bfd_error_system_call,
384 . bfd_error_invalid_target,
385 . bfd_error_wrong_format,
386 . bfd_error_wrong_object_format,
387 . bfd_error_invalid_operation,
388 . bfd_error_no_memory,
389 . bfd_error_no_symbols,
390 . bfd_error_no_armap,
391 . bfd_error_no_more_archived_files,
392 . bfd_error_malformed_archive,
393 . bfd_error_missing_dso,
394 . bfd_error_file_not_recognized,
395 . bfd_error_file_ambiguously_recognized,
396 . bfd_error_no_contents,
397 . bfd_error_nonrepresentable_section,
398 . bfd_error_no_debug_section,
399 . bfd_error_bad_value,
400 . bfd_error_file_truncated,
401 . bfd_error_file_too_big,
402 . bfd_error_on_input,
403 . bfd_error_invalid_error_code
409 static bfd_error_type bfd_error = bfd_error_no_error;
410 static bfd *input_bfd = NULL;
411 static bfd_error_type input_error = bfd_error_no_error;
413 const char *const bfd_errmsgs[] =
416 N_("System call error"),
417 N_("Invalid bfd target"),
418 N_("File in wrong format"),
419 N_("Archive object file in wrong format"),
420 N_("Invalid operation"),
421 N_("Memory exhausted"),
423 N_("Archive has no index; run ranlib to add one"),
424 N_("No more archived files"),
425 N_("Malformed archive"),
426 N_("DSO missing from command line"),
427 N_("File format not recognized"),
428 N_("File format is ambiguous"),
429 N_("Section has no contents"),
430 N_("Nonrepresentable section on output"),
431 N_("Symbol needs debug section which does not exist"),
433 N_("File truncated"),
435 N_("Error reading %s: %s"),
436 N_("#<Invalid error code>")
444 bfd_error_type bfd_get_error (void);
447 Return the current BFD error condition.
461 void bfd_set_error (bfd_error_type error_tag, ...);
464 Set the BFD error condition to be @var{error_tag}.
465 If @var{error_tag} is bfd_error_on_input, then this function
466 takes two more parameters, the input bfd where the error
467 occurred, and the bfd_error_type error.
471 bfd_set_error (bfd_error_type error_tag, ...)
473 bfd_error = error_tag;
474 if (error_tag == bfd_error_on_input)
476 /* This is an error that occurred during bfd_close when
477 writing an archive, but on one of the input files. */
480 va_start (ap, error_tag);
481 input_bfd = va_arg (ap, bfd *);
482 input_error = (bfd_error_type) va_arg (ap, int);
483 if (input_error >= bfd_error_on_input)
494 const char *bfd_errmsg (bfd_error_type error_tag);
497 Return a string describing the error @var{error_tag}, or
498 the system error if @var{error_tag} is <<bfd_error_system_call>>.
502 bfd_errmsg (bfd_error_type error_tag)
507 if (error_tag == bfd_error_on_input)
510 const char *msg = bfd_errmsg (input_error);
512 if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
516 /* Ick, what to do on out of memory? */
520 if (error_tag == bfd_error_system_call)
521 return xstrerror (errno);
523 if (error_tag > bfd_error_invalid_error_code)
524 error_tag = bfd_error_invalid_error_code; /* sanity check */
526 return _(bfd_errmsgs [error_tag]);
534 void bfd_perror (const char *message);
537 Print to the standard error stream a string describing the
538 last BFD error that occurred, or the last system error if
539 the last BFD error was a system call failure. If @var{message}
540 is non-NULL and non-empty, the error string printed is preceded
541 by @var{message}, a colon, and a space. It is followed by a newline.
545 bfd_perror (const char *message)
548 if (message == NULL || *message == '\0')
549 fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
551 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
559 Some BFD functions want to print messages describing the
560 problem. They call a BFD error handler function. This
561 function may be overridden by the program.
563 The BFD error handler acts like printf.
567 .typedef void (*bfd_error_handler_type) (const char *, ...);
571 /* The program name used when printing BFD error messages. */
573 static const char *_bfd_error_program_name;
575 /* This is the default routine to handle BFD error messages.
576 Like fprintf (stderr, ...), but also handles some extra format specifiers.
578 %A section name from section. For group components, print group name too.
579 %B file name from bfd. For archive components, prints archive too.
581 Note - because these two extra format specifiers require special handling
582 they are scanned for and processed in this function, before calling
583 vfprintf. This means that the *arguments* for these format specifiers
584 must be the first ones in the variable argument list, regardless of where
585 the specifiers appear in the format string. Thus for example calling
586 this function with a format string of:
588 "blah %s blah %A blah %d blah %B"
590 would involve passing the arguments as:
592 "blah %s blah %A blah %d blah %B",
600 _bfd_default_error_handler (const char *fmt, ...)
604 const char *new_fmt, *p;
608 /* PR 4992: Don't interrupt output being sent to stdout. */
611 if (_bfd_error_program_name != NULL)
612 fprintf (stderr, "%s: ", _bfd_error_program_name);
614 fprintf (stderr, "BFD: ");
620 /* Reserve enough space for the existing format string. */
621 avail -= strlen (fmt) + 1;
623 _exit (EXIT_FAILURE);
629 size_t len, extra, trim;
632 if (p == NULL || p[1] == '\0')
637 memcpy (bufp, fmt, len + 1);
642 if (p[1] == 'A' || p[1] == 'B')
645 memcpy (bufp, fmt, len);
650 /* If we run out of space, tough, you lose your ridiculously
651 long file or section name. It's not safe to try to alloc
652 memory here; We might be printing an out of memory message. */
663 bfd *abfd = va_arg (ap, bfd *);
666 /* Invoking %B with a null bfd pointer is an internal error. */
668 else if (abfd->my_archive)
669 snprintf (bufp, avail, "%s(%s)",
670 abfd->my_archive->filename, abfd->filename);
672 snprintf (bufp, avail, "%s", abfd->filename);
676 asection *sec = va_arg (ap, asection *);
678 const char *group = NULL;
679 struct coff_comdat_info *ci;
682 /* Invoking %A with a null section pointer is an internal error. */
686 && bfd_get_flavour (abfd) == bfd_target_elf_flavour
687 && elf_next_in_group (sec) != NULL
688 && (sec->flags & SEC_GROUP) == 0)
689 group = elf_group_name (sec);
690 else if (abfd != NULL
691 && bfd_get_flavour (abfd) == bfd_target_coff_flavour
692 && (ci = bfd_coff_get_comdat_section (sec->owner,
696 snprintf (bufp, avail, "%s[%s]", sec->name, group);
698 snprintf (bufp, avail, "%s", sec->name);
701 avail = avail - len + 2;
703 /* We need to replace any '%' we printed by "%%".
704 First count how many. */
708 while ((q = strchr (q, '%')) != NULL)
714 /* If there isn't room, trim off the end of the string. */
719 trim = extra - avail;
732 /* Now double all '%' chars, shuffling the string as we go. */
735 while ((q[extra] = *q) != '%')
745 vfprintf (stderr, new_fmt, ap);
748 /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
749 warning, so use the fputc function to avoid it. */
750 fputc ('\n', stderr);
754 /* This is a function pointer to the routine which should handle BFD
755 error messages. It is called when a BFD routine encounters an
756 error for which it wants to print a message. Going through a
757 function pointer permits a program linked against BFD to intercept
758 the messages and deal with them itself. */
760 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
764 bfd_set_error_handler
767 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
770 Set the BFD error handler function. Returns the previous
774 bfd_error_handler_type
775 bfd_set_error_handler (bfd_error_handler_type pnew)
777 bfd_error_handler_type pold;
779 pold = _bfd_error_handler;
780 _bfd_error_handler = pnew;
786 bfd_set_error_program_name
789 void bfd_set_error_program_name (const char *);
792 Set the program name to use when printing a BFD error. This
793 is printed before the error message followed by a colon and
794 space. The string must not be changed after it is passed to
799 bfd_set_error_program_name (const char *name)
801 _bfd_error_program_name = name;
806 bfd_get_error_handler
809 bfd_error_handler_type bfd_get_error_handler (void);
812 Return the BFD error handler function.
815 bfd_error_handler_type
816 bfd_get_error_handler (void)
818 return _bfd_error_handler;
825 If BFD finds an internal inconsistency, the bfd assert
826 handler is called with information on the BFD version, BFD
827 source file and line. If this happens, most programs linked
828 against BFD are expected to want to exit with an error, or mark
829 the current BFD operation as failed, so it is recommended to
830 override the default handler, which just calls
831 _bfd_error_handler and continues.
835 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
836 . const char *bfd_version,
837 . const char *bfd_file,
842 /* Note the use of bfd_ prefix on the parameter names above: we want to
843 show which one is the message and which is the version by naming the
844 parameters, but avoid polluting the program-using-bfd namespace as
845 the typedef is visible in the exported headers that the program
846 includes. Below, it's just for consistency. */
849 _bfd_default_assert_handler (const char *bfd_formatmsg,
850 const char *bfd_version,
851 const char *bfd_file,
855 (*_bfd_error_handler) (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
858 /* Similar to _bfd_error_handler, a program can decide to exit on an
859 internal BFD error. We use a non-variadic type to simplify passing
860 on parameters to other functions, e.g. _bfd_error_handler. */
862 bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
866 bfd_set_assert_handler
869 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
872 Set the BFD assert handler function. Returns the previous
876 bfd_assert_handler_type
877 bfd_set_assert_handler (bfd_assert_handler_type pnew)
879 bfd_assert_handler_type pold;
881 pold = _bfd_assert_handler;
882 _bfd_assert_handler = pnew;
888 bfd_get_assert_handler
891 bfd_assert_handler_type bfd_get_assert_handler (void);
894 Return the BFD assert handler function.
897 bfd_assert_handler_type
898 bfd_get_assert_handler (void)
900 return _bfd_assert_handler;
905 Miscellaneous, Memory Usage, Error reporting, BFD front end
911 Miscellaneous functions
916 bfd_get_reloc_upper_bound
919 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
922 Return the number of bytes required to store the
923 relocation information associated with section @var{sect}
924 attached to bfd @var{abfd}. If an error occurs, return -1.
929 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
931 if (abfd->format != bfd_object)
933 bfd_set_error (bfd_error_invalid_operation);
937 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
942 bfd_canonicalize_reloc
945 long bfd_canonicalize_reloc
946 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
949 Call the back end associated with the open BFD
950 @var{abfd} and translate the external form of the relocation
951 information attached to @var{sec} into the internal canonical
952 form. Place the table into memory at @var{loc}, which has
953 been preallocated, usually by a call to
954 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
957 The @var{syms} table is also needed for horrible internal magic
962 bfd_canonicalize_reloc (bfd *abfd,
967 if (abfd->format != bfd_object)
969 bfd_set_error (bfd_error_invalid_operation);
973 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
974 (abfd, asect, location, symbols));
983 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
986 Set the relocation pointer and count within
987 section @var{sec} to the values @var{rel} and @var{count}.
988 The argument @var{abfd} is ignored.
993 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
998 asect->orelocation = location;
999 asect->reloc_count = count;
1007 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
1010 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1012 Possible errors are:
1013 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1014 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1015 o <<bfd_error_invalid_operation>> -
1016 The flag word contained a bit which was not applicable to the
1017 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
1018 on a BFD format which does not support demand paging.
1023 bfd_set_file_flags (bfd *abfd, flagword flags)
1025 if (abfd->format != bfd_object)
1027 bfd_set_error (bfd_error_wrong_format);
1031 if (bfd_read_p (abfd))
1033 bfd_set_error (bfd_error_invalid_operation);
1037 bfd_get_file_flags (abfd) = flags;
1038 if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1040 bfd_set_error (bfd_error_invalid_operation);
1048 bfd_assert (const char *file, int line)
1050 (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1051 BFD_VERSION_STRING, file, line);
1054 /* A more or less friendly abort message. In libbfd.h abort is
1055 defined to call this function. */
1058 _bfd_abort (const char *file, int line, const char *fn)
1061 (*_bfd_error_handler)
1062 (_("BFD %s internal error, aborting at %s line %d in %s\n"),
1063 BFD_VERSION_STRING, file, line, fn);
1065 (*_bfd_error_handler)
1066 (_("BFD %s internal error, aborting at %s line %d\n"),
1067 BFD_VERSION_STRING, file, line);
1068 (*_bfd_error_handler) (_("Please report this bug.\n"));
1069 _exit (EXIT_FAILURE);
1077 int bfd_get_arch_size (bfd *abfd);
1080 Returns the normalized architecture address size, in bits, as
1081 determined by the object file's format. By normalized, we mean
1082 either 32 or 64. For ELF, this information is included in the
1083 header. Use bfd_arch_bits_per_address for number of bits in
1084 the architecture address.
1087 Returns the arch size in bits if known, <<-1>> otherwise.
1091 bfd_get_arch_size (bfd *abfd)
1093 if (abfd->xvec->flavour == bfd_target_elf_flavour)
1094 return get_elf_backend_data (abfd)->s->arch_size;
1096 return bfd_arch_bits_per_address (abfd) > 32 ? 64 : 32;
1101 bfd_get_sign_extend_vma
1104 int bfd_get_sign_extend_vma (bfd *abfd);
1107 Indicates if the target architecture "naturally" sign extends
1108 an address. Some architectures implicitly sign extend address
1109 values when they are converted to types larger than the size
1110 of an address. For instance, bfd_get_start_address() will
1111 return an address sign extended to fill a bfd_vma when this is
1115 Returns <<1>> if the target architecture is known to sign
1116 extend addresses, <<0>> if the target architecture is known to
1117 not sign extend addresses, and <<-1>> otherwise.
1121 bfd_get_sign_extend_vma (bfd *abfd)
1125 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1126 return get_elf_backend_data (abfd)->sign_extend_vma;
1128 name = bfd_get_target (abfd);
1130 /* Return a proper value for DJGPP & PE COFF.
1131 This function is required for DWARF2 support, but there is
1132 no place to store this information in the COFF back end.
1133 Should enough other COFF targets add support for DWARF2,
1134 a place will have to be found. Until then, this hack will do. */
1135 if (CONST_STRNEQ (name, "coff-go32")
1136 || strcmp (name, "pe-i386") == 0
1137 || strcmp (name, "pei-i386") == 0
1138 || strcmp (name, "pe-x86-64") == 0
1139 || strcmp (name, "pei-x86-64") == 0
1140 || strcmp (name, "pe-arm-wince-little") == 0
1141 || strcmp (name, "pei-arm-wince-little") == 0
1142 || strcmp (name, "aixcoff-rs6000") == 0)
1145 if (CONST_STRNEQ (name, "mach-o"))
1148 bfd_set_error (bfd_error_wrong_format);
1154 bfd_set_start_address
1157 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1160 Make @var{vma} the entry point of output BFD @var{abfd}.
1163 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1167 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1169 abfd->start_address = vma;
1178 unsigned int bfd_get_gp_size (bfd *abfd);
1181 Return the maximum size of objects to be optimized using the GP
1182 register under MIPS ECOFF. This is typically set by the <<-G>>
1183 argument to the compiler, assembler or linker.
1187 bfd_get_gp_size (bfd *abfd)
1189 if (abfd->format == bfd_object)
1191 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1192 return ecoff_data (abfd)->gp_size;
1193 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1194 return elf_gp_size (abfd);
1204 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1207 Set the maximum size of objects to be optimized using the GP
1208 register under ECOFF or MIPS ELF. This is typically set by
1209 the <<-G>> argument to the compiler, assembler or linker.
1213 bfd_set_gp_size (bfd *abfd, unsigned int i)
1215 /* Don't try to set GP size on an archive or core file! */
1216 if (abfd->format != bfd_object)
1219 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1220 ecoff_data (abfd)->gp_size = i;
1221 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1222 elf_gp_size (abfd) = i;
1225 /* Get the GP value. This is an internal function used by some of the
1226 relocation special_function routines on targets which support a GP
1230 _bfd_get_gp_value (bfd *abfd)
1234 if (abfd->format != bfd_object)
1237 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1238 return ecoff_data (abfd)->gp;
1239 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1240 return elf_gp (abfd);
1245 /* Set the GP value. */
1248 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1252 if (abfd->format != bfd_object)
1255 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1256 ecoff_data (abfd)->gp = v;
1257 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1266 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1269 Convert, like <<strtoul>>, a numerical expression
1270 @var{string} into a <<bfd_vma>> integer, and return that integer.
1271 (Though without as many bells and whistles as <<strtoul>>.)
1272 The expression is assumed to be unsigned (i.e., positive).
1273 If given a @var{base}, it is used as the base for conversion.
1274 A base of 0 causes the function to interpret the string
1275 in hex if a leading "0x" or "0X" is found, otherwise
1276 in octal if a leading zero is found, otherwise in decimal.
1278 If the value would overflow, the maximum <<bfd_vma>> value is
1283 bfd_scan_vma (const char *string, const char **end, int base)
1287 unsigned int cutlim;
1290 /* Let the host do it if possible. */
1291 if (sizeof (bfd_vma) <= sizeof (unsigned long))
1292 return strtoul (string, (char **) end, base);
1294 #ifdef HAVE_STRTOULL
1295 if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1296 return strtoull (string, (char **) end, base);
1301 if (string[0] == '0')
1303 if ((string[1] == 'x') || (string[1] == 'X'))
1310 if ((base < 2) || (base > 36))
1315 && (string[1] == 'x' || string[1] == 'X')
1316 && ISXDIGIT (string[2]))
1321 cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1322 cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1330 if (ISDIGIT (digit))
1331 digit = digit - '0';
1332 else if (ISALPHA (digit))
1333 digit = TOUPPER (digit) - 'A' + 10;
1336 if (digit >= (unsigned int) base)
1338 if (value > cutoff || (value == cutoff && digit > cutlim))
1340 value = value * base + digit;
1345 value = ~ (bfd_vma) 0;
1355 bfd_copy_private_header_data
1358 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1361 Copy private BFD header information from the BFD @var{ibfd} to the
1362 the BFD @var{obfd}. This copies information that may require
1363 sections to exist, but does not require symbol tables. Return
1364 <<true>> on success, <<false>> on error.
1365 Possible error returns are:
1367 o <<bfd_error_no_memory>> -
1368 Not enough memory exists to create private data for @var{obfd}.
1370 .#define bfd_copy_private_header_data(ibfd, obfd) \
1371 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1378 bfd_copy_private_bfd_data
1381 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1384 Copy private BFD information from the BFD @var{ibfd} to the
1385 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1386 Possible error returns are:
1388 o <<bfd_error_no_memory>> -
1389 Not enough memory exists to create private data for @var{obfd}.
1391 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1392 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1399 bfd_merge_private_bfd_data
1402 bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1405 Merge private BFD information from the BFD @var{ibfd} to the
1406 the output file BFD @var{obfd} when linking. Return <<TRUE>>
1407 on success, <<FALSE>> on error. Possible error returns are:
1409 o <<bfd_error_no_memory>> -
1410 Not enough memory exists to create private data for @var{obfd}.
1412 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1413 . BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1420 bfd_set_private_flags
1423 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1426 Set private BFD flag information in the BFD @var{abfd}.
1427 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1430 o <<bfd_error_no_memory>> -
1431 Not enough memory exists to create private data for @var{obfd}.
1433 .#define bfd_set_private_flags(abfd, flags) \
1434 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1443 The following functions exist but have not yet been documented.
1445 .#define bfd_sizeof_headers(abfd, info) \
1446 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1448 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1449 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1450 . (abfd, sec, syms, off, file, func, line))
1452 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
1454 . BFD_SEND (abfd, _bfd_find_nearest_line_discriminator, \
1455 . (abfd, sec, syms, off, file, func, line, disc))
1457 .#define bfd_find_line(abfd, syms, sym, file, line) \
1458 . BFD_SEND (abfd, _bfd_find_line, \
1459 . (abfd, syms, sym, file, line))
1461 .#define bfd_find_inliner_info(abfd, file, func, line) \
1462 . BFD_SEND (abfd, _bfd_find_inliner_info, \
1463 . (abfd, file, func, line))
1465 .#define bfd_debug_info_start(abfd) \
1466 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1468 .#define bfd_debug_info_end(abfd) \
1469 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1471 .#define bfd_debug_info_accumulate(abfd, section) \
1472 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1474 .#define bfd_stat_arch_elt(abfd, stat) \
1475 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1477 .#define bfd_update_armap_timestamp(abfd) \
1478 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1480 .#define bfd_set_arch_mach(abfd, arch, mach)\
1481 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1483 .#define bfd_relax_section(abfd, section, link_info, again) \
1484 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1486 .#define bfd_gc_sections(abfd, link_info) \
1487 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1489 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
1490 . BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
1492 .#define bfd_merge_sections(abfd, link_info) \
1493 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1495 .#define bfd_is_group_section(abfd, sec) \
1496 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1498 .#define bfd_discard_group(abfd, sec) \
1499 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1501 .#define bfd_link_hash_table_create(abfd) \
1502 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1504 .#define bfd_link_add_symbols(abfd, info) \
1505 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1507 .#define bfd_link_just_syms(abfd, sec, info) \
1508 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1510 .#define bfd_final_link(abfd, info) \
1511 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1513 .#define bfd_free_cached_info(abfd) \
1514 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1516 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1517 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1519 .#define bfd_print_private_bfd_data(abfd, file)\
1520 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1522 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1523 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1525 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1526 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1527 . dyncount, dynsyms, ret))
1529 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1530 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1532 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1533 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1535 .extern bfd_byte *bfd_get_relocated_section_contents
1536 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1537 . bfd_boolean, asymbol **);
1543 bfd_get_relocated_section_contents (bfd *abfd,
1544 struct bfd_link_info *link_info,
1545 struct bfd_link_order *link_order,
1547 bfd_boolean relocatable,
1551 bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1552 bfd_byte *, bfd_boolean, asymbol **);
1554 if (link_order->type == bfd_indirect_link_order)
1556 abfd2 = link_order->u.indirect.section->owner;
1563 fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1565 return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1568 /* Record information about an ELF program header. */
1571 bfd_record_phdr (bfd *abfd,
1573 bfd_boolean flags_valid,
1575 bfd_boolean at_valid,
1577 bfd_boolean includes_filehdr,
1578 bfd_boolean includes_phdrs,
1582 struct elf_segment_map *m, **pm;
1585 if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1588 amt = sizeof (struct elf_segment_map);
1589 amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1590 m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
1597 m->p_flags_valid = flags_valid;
1598 m->p_paddr_valid = at_valid;
1599 m->includes_filehdr = includes_filehdr;
1600 m->includes_phdrs = includes_phdrs;
1603 memcpy (m->sections, secs, count * sizeof (asection *));
1605 for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
1613 /* Return true iff this target is 32-bit. */
1618 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1620 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1621 return bed->s->elfclass == ELFCLASS32;
1624 /* For non-ELF targets, use architecture information. */
1625 return bfd_arch_bits_per_address (abfd) <= 32;
1629 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1630 target's address size. */
1633 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1638 sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1642 sprintf_vma (buf, value);
1646 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1651 fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1655 fprintf_vma ((FILE *) stream, value);
1663 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1667 When more than one machine code number is available for the
1668 same machine type, this function can be used to switch between
1669 the preferred one (alternative == 0) and any others. Currently,
1670 only ELF supports this feature, with up to two alternate
1675 bfd_alt_mach_code (bfd *abfd, int alternative)
1677 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1681 switch (alternative)
1684 code = get_elf_backend_data (abfd)->elf_machine_code;
1688 code = get_elf_backend_data (abfd)->elf_machine_alt1;
1694 code = get_elf_backend_data (abfd)->elf_machine_alt2;
1703 elf_elfheader (abfd)->e_machine = code;
1713 bfd_emul_get_maxpagesize
1716 bfd_vma bfd_emul_get_maxpagesize (const char *);
1719 Returns the maximum page size, in bytes, as determined by
1723 Returns the maximum page size in bytes for ELF, 0 otherwise.
1727 bfd_emul_get_maxpagesize (const char *emul)
1729 const bfd_target *target;
1731 target = bfd_find_target (emul, NULL);
1733 && target->flavour == bfd_target_elf_flavour)
1734 return xvec_get_elf_backend_data (target)->maxpagesize;
1740 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1741 int offset, const bfd_target *orig_target)
1743 if (target->flavour == bfd_target_elf_flavour)
1745 const struct elf_backend_data *bed;
1747 bed = xvec_get_elf_backend_data (target);
1748 *((bfd_vma *) ((char *) bed + offset)) = size;
1751 if (target->alternative_target
1752 && target->alternative_target != orig_target)
1753 bfd_elf_set_pagesize (target->alternative_target, size, offset,
1759 bfd_emul_set_maxpagesize
1762 void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1765 For ELF, set the maximum page size for the emulation. It is
1766 a no-op for other formats.
1771 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1773 const bfd_target *target;
1775 target = bfd_find_target (emul, NULL);
1777 bfd_elf_set_pagesize (target, size,
1778 offsetof (struct elf_backend_data,
1779 maxpagesize), target);
1784 bfd_emul_get_commonpagesize
1787 bfd_vma bfd_emul_get_commonpagesize (const char *);
1790 Returns the common page size, in bytes, as determined by
1794 Returns the common page size in bytes for ELF, 0 otherwise.
1798 bfd_emul_get_commonpagesize (const char *emul)
1800 const bfd_target *target;
1802 target = bfd_find_target (emul, NULL);
1804 && target->flavour == bfd_target_elf_flavour)
1805 return xvec_get_elf_backend_data (target)->commonpagesize;
1812 bfd_emul_set_commonpagesize
1815 void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1818 For ELF, set the common page size for the emulation. It is
1819 a no-op for other formats.
1824 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1826 const bfd_target *target;
1828 target = bfd_find_target (emul, NULL);
1830 bfd_elf_set_pagesize (target, size,
1831 offsetof (struct elf_backend_data,
1832 commonpagesize), target);
1840 char *bfd_demangle (bfd *, const char *, int);
1843 Wrapper around cplus_demangle. Strips leading underscores and
1844 other such chars that would otherwise confuse the demangler.
1845 If passed a g++ v3 ABI mangled name, returns a buffer allocated
1846 with malloc holding the demangled name. Returns NULL otherwise
1847 and on memory alloc failure.
1851 bfd_demangle (bfd *abfd, const char *name, int options)
1854 const char *pre, *suf;
1856 bfd_boolean skip_lead;
1858 skip_lead = (abfd != NULL
1860 && bfd_get_symbol_leading_char (abfd) == *name);
1864 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1865 or the MS PE format. These formats have a number of leading '.'s
1866 on at least some symbols, so we remove all dots to avoid
1867 confusing the demangler. */
1869 while (*name == '.' || *name == '$')
1871 pre_len = name - pre;
1873 /* Strip off @plt and suchlike too. */
1875 suf = strchr (name, '@');
1878 alloc = (char *) bfd_malloc (suf - name + 1);
1881 memcpy (alloc, name, suf - name);
1882 alloc[suf - name] = '\0';
1886 res = cplus_demangle (name, options);
1895 size_t len = strlen (pre) + 1;
1896 alloc = (char *) bfd_malloc (len);
1899 memcpy (alloc, pre, len);
1905 /* Put back any prefix or suffix. */
1906 if (pre_len != 0 || suf != NULL)
1915 suf_len = strlen (suf) + 1;
1916 final = (char *) bfd_malloc (pre_len + len + suf_len);
1919 memcpy (final, pre, pre_len);
1920 memcpy (final + pre_len, res, len);
1921 memcpy (final + pre_len + len, suf, suf_len);