1 /* Generic BFD library interface and support routines.
2 Copyright (C) 1990-2017 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,
47 .enum bfd_plugin_format
49 . bfd_plugin_unknown = 0,
62 . {* The filename the application opened the BFD with. *}
63 . const char *filename;
65 . {* A pointer to the target jump table. *}
66 . const struct bfd_target *xvec;
68 . {* The IOSTREAM, and corresponding IO vector that provide access
69 . to the file backing the BFD. *}
71 . const struct bfd_iovec *iovec;
73 . {* The caching routines use these to maintain a
74 . least-recently-used list of BFDs. *}
75 . struct bfd *lru_prev, *lru_next;
77 . {* When a file is closed by the caching routines, BFD retains
78 . state information on the file here... *}
81 . {* File modified time, if mtime_set is TRUE. *}
84 . {* A unique identifier of the BFD *}
87 . {* The format which belongs to the BFD. (object, core, etc.) *}
88 . ENUM_BITFIELD (bfd_format) format : 3;
90 . {* The direction with which the BFD was opened. *}
91 . ENUM_BITFIELD (bfd_direction) direction : 2;
93 . {* Format_specific flags. *}
94 . flagword flags : 20;
96 . {* Values that may appear in the flags field of a BFD. These also
97 . appear in the object_flags field of the bfd_target structure, where
98 . they indicate the set of flags used by that backend (not all flags
99 . are meaningful for all object file formats) (FIXME: at the moment,
100 . the object_flags values have mostly just been copied from backend
101 . to another, and are not necessarily correct). *}
103 .#define BFD_NO_FLAGS 0x00
105 . {* BFD contains relocation entries. *}
106 .#define HAS_RELOC 0x01
108 . {* BFD is directly executable. *}
111 . {* BFD has line number information (basically used for F_LNNO in a
113 .#define HAS_LINENO 0x04
115 . {* BFD has debugging information. *}
116 .#define HAS_DEBUG 0x08
118 . {* BFD has symbols. *}
119 .#define HAS_SYMS 0x10
121 . {* BFD has local symbols (basically used for F_LSYMS in a COFF
123 .#define HAS_LOCALS 0x20
125 . {* BFD is a dynamic object. *}
126 .#define DYNAMIC 0x40
128 . {* Text section is write protected (if D_PAGED is not set, this is
129 . like an a.out NMAGIC file) (the linker sets this by default, but
130 . clears it for -r or -N). *}
131 .#define WP_TEXT 0x80
133 . {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
134 . linker sets this by default, but clears it for -r or -n or -N). *}
135 .#define D_PAGED 0x100
137 . {* BFD is relaxable (this means that bfd_relax_section may be able to
138 . do something) (sometimes bfd_relax_section can do something even if
139 . this is not set). *}
140 .#define BFD_IS_RELAXABLE 0x200
142 . {* This may be set before writing out a BFD to request using a
143 . traditional format. For example, this is used to request that when
144 . writing out an a.out object the symbols not be hashed to eliminate
146 .#define BFD_TRADITIONAL_FORMAT 0x400
148 . {* This flag indicates that the BFD contents are actually cached
149 . in memory. If this is set, iostream points to a bfd_in_memory
151 .#define BFD_IN_MEMORY 0x800
153 . {* This BFD has been created by the linker and doesn't correspond
154 . to any input file. *}
155 .#define BFD_LINKER_CREATED 0x1000
157 . {* This may be set before writing out a BFD to request that it
158 . be written using values for UIDs, GIDs, timestamps, etc. that
159 . will be consistent from run to run. *}
160 .#define BFD_DETERMINISTIC_OUTPUT 0x2000
162 . {* Compress sections in this BFD. *}
163 .#define BFD_COMPRESS 0x4000
165 . {* Decompress sections in this BFD. *}
166 .#define BFD_DECOMPRESS 0x8000
168 . {* BFD is a dummy, for plugins. *}
169 .#define BFD_PLUGIN 0x10000
171 . {* Compress sections in this BFD with SHF_COMPRESSED from gABI. *}
172 .#define BFD_COMPRESS_GABI 0x20000
174 . {* Convert ELF common symbol type to STT_COMMON or STT_OBJECT in this
176 .#define BFD_CONVERT_ELF_COMMON 0x40000
178 . {* Use the ELF STT_COMMON type in this BFD. *}
179 .#define BFD_USE_ELF_STT_COMMON 0x80000
181 . {* Flags bits to be saved in bfd_preserve_save. *}
182 .#define BFD_FLAGS_SAVED \
183 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
184 . | BFD_PLUGIN | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON \
185 . | BFD_USE_ELF_STT_COMMON)
187 . {* Flags bits which are for BFD use only. *}
188 .#define BFD_FLAGS_FOR_BFD_USE_MASK \
189 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
190 . | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT \
191 . | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON)
193 . {* Is the file descriptor being cached? That is, can it be closed as
194 . needed, and re-opened when accessed later? *}
195 . unsigned int cacheable : 1;
197 . {* Marks whether there was a default target specified when the
198 . BFD was opened. This is used to select which matching algorithm
199 . to use to choose the back end. *}
200 . unsigned int target_defaulted : 1;
202 . {* ... and here: (``once'' means at least once). *}
203 . unsigned int opened_once : 1;
205 . {* Set if we have a locally maintained mtime value, rather than
206 . getting it from the file each time. *}
207 . unsigned int mtime_set : 1;
209 . {* Flag set if symbols from this BFD should not be exported. *}
210 . unsigned int no_export : 1;
212 . {* Remember when output has begun, to stop strange things
214 . unsigned int output_has_begun : 1;
216 . {* Have archive map. *}
217 . unsigned int has_armap : 1;
219 . {* Set if this is a thin archive. *}
220 . unsigned int is_thin_archive : 1;
222 . {* Set if only required symbols should be added in the link hash table for
223 . this object. Used by VMS linkers. *}
224 . unsigned int selective_search : 1;
226 . {* Set if this is the linker output BFD. *}
227 . unsigned int is_linker_output : 1;
229 . {* Set if this is the linker input BFD. *}
230 . unsigned int is_linker_input : 1;
232 . {* If this is an input for a compiler plug-in library. *}
233 . ENUM_BITFIELD (bfd_plugin_format) plugin_format : 2;
235 . {* Set if this is a plugin output file. *}
236 . unsigned int lto_output : 1;
238 . {* Set to dummy BFD created when claimed by a compiler plug-in
240 . bfd *plugin_dummy_bfd;
242 . {* Currently my_archive is tested before adding origin to
243 . anything. I believe that this can become always an add of
244 . origin, with origin set to 0 for non archive files. *}
247 . {* The origin in the archive of the proxy entry. This will
248 . normally be the same as origin, except for thin archives,
249 . when it will contain the current offset of the proxy in the
250 . thin archive rather than the offset of the bfd in its actual
252 . ufile_ptr proxy_origin;
254 . {* A hash table for section names. *}
255 . struct bfd_hash_table section_htab;
257 . {* Pointer to linked list of sections. *}
258 . struct bfd_section *sections;
260 . {* The last section on the section list. *}
261 . struct bfd_section *section_last;
263 . {* The number of sections. *}
264 . unsigned int section_count;
266 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
267 . be used only for archive elements. *}
270 . {* Stuff only useful for object files:
271 . The start address. *}
272 . bfd_vma start_address;
274 . {* Symbol table for output BFD (with symcount entries).
275 . Also used by the linker to cache input BFD symbols. *}
276 . struct bfd_symbol **outsymbols;
278 . {* Used for input and output. *}
279 . unsigned int symcount;
281 . {* Used for slurped dynamic symbol tables. *}
282 . unsigned int dynsymcount;
284 . {* Pointer to structure which contains architecture information. *}
285 . const struct bfd_arch_info *arch_info;
287 . {* Stuff only useful for archives. *}
289 . struct bfd *my_archive; {* The containing archive BFD. *}
290 . struct bfd *archive_next; {* The next BFD in the archive. *}
291 . struct bfd *archive_head; {* The first BFD in the archive. *}
292 . struct bfd *nested_archives; {* List of nested archive in a flattened
296 . {* For input BFDs, a chain of BFDs involved in a link. *}
298 . {* For output BFD, the linker hash table. *}
299 . struct bfd_link_hash_table *hash;
302 . {* Used by the back end to hold private data. *}
305 . struct aout_data_struct *aout_data;
306 . struct artdata *aout_ar_data;
307 . struct _oasys_data *oasys_obj_data;
308 . struct _oasys_ar_data *oasys_ar_data;
309 . struct coff_tdata *coff_obj_data;
310 . struct pe_tdata *pe_obj_data;
311 . struct xcoff_tdata *xcoff_obj_data;
312 . struct ecoff_tdata *ecoff_obj_data;
313 . struct ieee_data_struct *ieee_data;
314 . struct ieee_ar_data_struct *ieee_ar_data;
315 . struct srec_data_struct *srec_data;
316 . struct verilog_data_struct *verilog_data;
317 . struct ihex_data_struct *ihex_data;
318 . struct tekhex_data_struct *tekhex_data;
319 . struct elf_obj_tdata *elf_obj_data;
320 . struct nlm_obj_tdata *nlm_obj_data;
321 . struct bout_data_struct *bout_data;
322 . struct mmo_data_struct *mmo_data;
323 . struct sun_core_struct *sun_core_data;
324 . struct sco5_core_struct *sco5_core_data;
325 . struct trad_core_struct *trad_core_data;
326 . struct som_data_struct *som_data;
327 . struct hpux_core_struct *hpux_core_data;
328 . struct hppabsd_core_struct *hppabsd_core_data;
329 . struct sgi_core_struct *sgi_core_data;
330 . struct lynx_core_struct *lynx_core_data;
331 . struct osf_core_struct *osf_core_data;
332 . struct cisco_core_struct *cisco_core_data;
333 . struct versados_data_struct *versados_data;
334 . struct netbsd_core_struct *netbsd_core_data;
335 . struct mach_o_data_struct *mach_o_data;
336 . struct mach_o_fat_data_struct *mach_o_fat_data;
337 . struct plugin_data_struct *plugin_data;
338 . struct bfd_pef_data_struct *pef_data;
339 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
340 . struct bfd_sym_data_struct *sym_data;
345 . {* Used by the application to hold private data. *}
348 . {* Where all the allocated stuff under this BFD goes. This is a
349 . struct objalloc *, but we use void * to avoid requiring the inclusion
353 . {* For input BFDs, the build ID, if the object has one. *}
354 . const struct bfd_build_id *build_id;
357 .{* See note beside bfd_set_section_userdata. *}
358 .static inline bfd_boolean
359 .bfd_set_cacheable (bfd * abfd, bfd_boolean val)
361 . abfd->cacheable = val;
371 #include "libiberty.h"
372 #include "demangle.h"
373 #include "safe-ctype.h"
376 #include "coff/internal.h"
377 #include "coff/sym.h"
379 #include "libecoff.h"
384 #define EXIT_FAILURE 1
388 /* provide storage for subsystem, stack and heap data which may have been
389 passed in on the command line. Ld puts this data into a bfd_link_info
390 struct which ultimately gets passed in to the bfd. When it arrives, copy
391 it to the following struct so that the data will be available in coffcode.h
392 where it is needed. The typedef's used are defined in bfd.h */
396 Error reporting, Miscellaneous, typedef bfd, BFD front end
401 Most BFD functions return nonzero on success (check their
402 individual documentation for precise semantics). On an error,
403 they call <<bfd_set_error>> to set an error condition that callers
404 can check by calling <<bfd_get_error>>.
405 If that returns <<bfd_error_system_call>>, then check
408 The easiest way to report a BFD error to the user is to
412 Type <<bfd_error_type>>
414 The values returned by <<bfd_get_error>> are defined by the
415 enumerated type <<bfd_error_type>>.
419 .typedef enum bfd_error
421 . bfd_error_no_error = 0,
422 . bfd_error_system_call,
423 . bfd_error_invalid_target,
424 . bfd_error_wrong_format,
425 . bfd_error_wrong_object_format,
426 . bfd_error_invalid_operation,
427 . bfd_error_no_memory,
428 . bfd_error_no_symbols,
429 . bfd_error_no_armap,
430 . bfd_error_no_more_archived_files,
431 . bfd_error_malformed_archive,
432 . bfd_error_missing_dso,
433 . bfd_error_file_not_recognized,
434 . bfd_error_file_ambiguously_recognized,
435 . bfd_error_no_contents,
436 . bfd_error_nonrepresentable_section,
437 . bfd_error_no_debug_section,
438 . bfd_error_bad_value,
439 . bfd_error_file_truncated,
440 . bfd_error_file_too_big,
441 . bfd_error_on_input,
442 . bfd_error_invalid_error_code
448 static bfd_error_type bfd_error = bfd_error_no_error;
449 static bfd *input_bfd = NULL;
450 static bfd_error_type input_error = bfd_error_no_error;
452 const char *const bfd_errmsgs[] =
455 N_("System call error"),
456 N_("Invalid bfd target"),
457 N_("File in wrong format"),
458 N_("Archive object file in wrong format"),
459 N_("Invalid operation"),
460 N_("Memory exhausted"),
462 N_("Archive has no index; run ranlib to add one"),
463 N_("No more archived files"),
464 N_("Malformed archive"),
465 N_("DSO missing from command line"),
466 N_("File format not recognized"),
467 N_("File format is ambiguous"),
468 N_("Section has no contents"),
469 N_("Nonrepresentable section on output"),
470 N_("Symbol needs debug section which does not exist"),
472 N_("File truncated"),
474 N_("Error reading %s: %s"),
475 N_("#<Invalid error code>")
483 bfd_error_type bfd_get_error (void);
486 Return the current BFD error condition.
500 void bfd_set_error (bfd_error_type error_tag, ...);
503 Set the BFD error condition to be @var{error_tag}.
504 If @var{error_tag} is bfd_error_on_input, then this function
505 takes two more parameters, the input bfd where the error
506 occurred, and the bfd_error_type error.
510 bfd_set_error (bfd_error_type error_tag, ...)
512 bfd_error = error_tag;
513 if (error_tag == bfd_error_on_input)
515 /* This is an error that occurred during bfd_close when
516 writing an archive, but on one of the input files. */
519 va_start (ap, error_tag);
520 input_bfd = va_arg (ap, bfd *);
521 input_error = (bfd_error_type) va_arg (ap, int);
522 if (input_error >= bfd_error_on_input)
533 const char *bfd_errmsg (bfd_error_type error_tag);
536 Return a string describing the error @var{error_tag}, or
537 the system error if @var{error_tag} is <<bfd_error_system_call>>.
541 bfd_errmsg (bfd_error_type error_tag)
546 if (error_tag == bfd_error_on_input)
549 const char *msg = bfd_errmsg (input_error);
551 if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
555 /* Ick, what to do on out of memory? */
559 if (error_tag == bfd_error_system_call)
560 return xstrerror (errno);
562 if (error_tag > bfd_error_invalid_error_code)
563 error_tag = bfd_error_invalid_error_code; /* sanity check */
565 return _(bfd_errmsgs [error_tag]);
573 void bfd_perror (const char *message);
576 Print to the standard error stream a string describing the
577 last BFD error that occurred, or the last system error if
578 the last BFD error was a system call failure. If @var{message}
579 is non-NULL and non-empty, the error string printed is preceded
580 by @var{message}, a colon, and a space. It is followed by a newline.
584 bfd_perror (const char *message)
587 if (message == NULL || *message == '\0')
588 fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
590 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
598 Some BFD functions want to print messages describing the
599 problem. They call a BFD error handler function. This
600 function may be overridden by the program.
602 The BFD error handler acts like vprintf.
606 .typedef void (*bfd_error_handler_type) (const char *, va_list);
610 /* The program name used when printing BFD error messages. */
612 static const char *_bfd_error_program_name;
614 /* This macro and _doprnt taken from libiberty _doprnt.c, tidied a
615 little and extended to handle '%A' and '%B'. 'L' as a modifer for
616 integer formats is used for bfd_vma and bfd_size_type args, which
617 vary in size depending on BFD configuration. */
619 #define PRINT_TYPE(TYPE) \
622 TYPE value = va_arg (ap, TYPE); \
623 result = fprintf (stream, specifier, value); \
627 _doprnt (FILE *stream, const char *format, va_list ap)
629 const char *ptr = format;
631 int total_printed = 0;
639 /* While we have regular characters, print them. */
640 char *end = strchr (ptr, '%');
642 result = fprintf (stream, "%.*s", (int) (end - ptr), ptr);
644 result = fprintf (stream, "%s", ptr);
649 /* We have a format specifier! */
650 char *sptr = specifier;
651 int wide_width = 0, short_width = 0;
653 /* Copy the % and move forward. */
656 /* Move past flags. */
657 while (strchr ("-+ #0", *ptr))
662 int value = abs (va_arg (ap, int));
663 sptr += sprintf (sptr, "%d", value);
667 /* Handle explicit numeric value. */
668 while (ISDIGIT (*ptr))
673 /* Copy and go past the period. */
677 int value = abs (va_arg (ap, int));
678 sptr += sprintf (sptr, "%d", value);
682 /* Handle explicit numeric value. */
683 while (ISDIGIT (*ptr))
686 while (strchr ("hlL", *ptr))
705 /* Copy the type specifier, and NULL terminate. */
719 /* Short values are promoted to int, so just copy it
720 as an int and trust the C library printf to cast it
721 to the right width. */
726 /* L modifier for bfd_vma or bfd_size_type may be
727 either long long or long. */
728 if ((BFD_ARCH_SIZE < 64 || BFD_HOST_64BIT_LONG)
742 #if defined (__GNUC__) || defined (HAVE_LONG_LONG)
743 # if defined (__MSVCRT__)
745 while (sptr[-1] == 'L' || sptr[-1] == 'l')
753 PRINT_TYPE (long long);
755 /* Fake it and hope for the best. */
773 #if defined (__GNUC__) || defined (HAVE_LONG_DOUBLE)
774 PRINT_TYPE (long double);
776 /* Fake it and hope for the best. */
794 asection *sec = va_arg (ap, asection *);
796 const char *group = NULL;
797 struct coff_comdat_info *ci;
800 /* Invoking %A with a null section pointer is an
805 && bfd_get_flavour (abfd) == bfd_target_elf_flavour
806 && elf_next_in_group (sec) != NULL
807 && (sec->flags & SEC_GROUP) == 0)
808 group = elf_group_name (sec);
809 else if (abfd != NULL
810 && bfd_get_flavour (abfd) == bfd_target_coff_flavour
811 && (ci = bfd_coff_get_comdat_section (sec->owner,
815 result = fprintf (stream, "%s[%s]", sec->name, group);
817 result = fprintf (stream, "%s", sec->name);
822 bfd *abfd = va_arg (ap, bfd *);
825 /* Invoking %B with a null bfd pointer is an
828 else if (abfd->my_archive
829 && !bfd_is_thin_archive (abfd->my_archive))
830 result = fprintf (stream, "%s(%s)",
831 abfd->my_archive->filename, abfd->filename);
833 result = fprintf (stream, "%s", abfd->filename);
842 total_printed += result;
845 return total_printed;
848 /* This is the default routine to handle BFD error messages.
849 Like fprintf (stderr, ...), but also handles some extra format specifiers.
851 %A section name from section. For group components, print group name too.
852 %B file name from bfd. For archive components, prints archive too. */
855 error_handler_internal (const char *fmt, va_list ap)
857 /* PR 4992: Don't interrupt output being sent to stdout. */
860 if (_bfd_error_program_name != NULL)
861 fprintf (stderr, "%s: ", _bfd_error_program_name);
863 fprintf (stderr, "BFD: ");
865 _doprnt (stderr, fmt, ap);
867 /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
868 warning, so use the fputc function to avoid it. */
869 fputc ('\n', stderr);
873 /* This is a function pointer to the routine which should handle BFD
874 error messages. It is called when a BFD routine encounters an
875 error for which it wants to print a message. Going through a
876 function pointer permits a program linked against BFD to intercept
877 the messages and deal with them itself. */
879 static bfd_error_handler_type _bfd_error_internal = error_handler_internal;
882 _bfd_error_handler (const char *fmt, ...)
887 _bfd_error_internal (fmt, ap);
893 bfd_set_error_handler
896 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
899 Set the BFD error handler function. Returns the previous
903 bfd_error_handler_type
904 bfd_set_error_handler (bfd_error_handler_type pnew)
906 bfd_error_handler_type pold;
908 pold = _bfd_error_internal;
909 _bfd_error_internal = pnew;
915 bfd_set_error_program_name
918 void bfd_set_error_program_name (const char *);
921 Set the program name to use when printing a BFD error. This
922 is printed before the error message followed by a colon and
923 space. The string must not be changed after it is passed to
928 bfd_set_error_program_name (const char *name)
930 _bfd_error_program_name = name;
937 If BFD finds an internal inconsistency, the bfd assert
938 handler is called with information on the BFD version, BFD
939 source file and line. If this happens, most programs linked
940 against BFD are expected to want to exit with an error, or mark
941 the current BFD operation as failed, so it is recommended to
942 override the default handler, which just calls
943 _bfd_error_handler and continues.
947 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
948 . const char *bfd_version,
949 . const char *bfd_file,
954 /* Note the use of bfd_ prefix on the parameter names above: we want to
955 show which one is the message and which is the version by naming the
956 parameters, but avoid polluting the program-using-bfd namespace as
957 the typedef is visible in the exported headers that the program
958 includes. Below, it's just for consistency. */
961 _bfd_default_assert_handler (const char *bfd_formatmsg,
962 const char *bfd_version,
963 const char *bfd_file,
967 _bfd_error_handler (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
970 /* Similar to _bfd_error_handler, a program can decide to exit on an
971 internal BFD error. We use a non-variadic type to simplify passing
972 on parameters to other functions, e.g. _bfd_error_handler. */
974 static bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
978 bfd_set_assert_handler
981 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
984 Set the BFD assert handler function. Returns the previous
988 bfd_assert_handler_type
989 bfd_set_assert_handler (bfd_assert_handler_type pnew)
991 bfd_assert_handler_type pold;
993 pold = _bfd_assert_handler;
994 _bfd_assert_handler = pnew;
1000 Miscellaneous, Memory Usage, Error reporting, BFD front end
1006 Miscellaneous functions
1011 bfd_get_reloc_upper_bound
1014 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
1017 Return the number of bytes required to store the
1018 relocation information associated with section @var{sect}
1019 attached to bfd @var{abfd}. If an error occurs, return -1.
1024 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
1026 if (abfd->format != bfd_object)
1028 bfd_set_error (bfd_error_invalid_operation);
1032 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
1037 bfd_canonicalize_reloc
1040 long bfd_canonicalize_reloc
1041 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
1044 Call the back end associated with the open BFD
1045 @var{abfd} and translate the external form of the relocation
1046 information attached to @var{sec} into the internal canonical
1047 form. Place the table into memory at @var{loc}, which has
1048 been preallocated, usually by a call to
1049 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
1052 The @var{syms} table is also needed for horrible internal magic
1057 bfd_canonicalize_reloc (bfd *abfd,
1062 if (abfd->format != bfd_object)
1064 bfd_set_error (bfd_error_invalid_operation);
1068 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
1069 (abfd, asect, location, symbols));
1078 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
1081 Set the relocation pointer and count within
1082 section @var{sec} to the values @var{rel} and @var{count}.
1083 The argument @var{abfd} is ignored.
1085 .#define bfd_set_reloc(abfd, asect, location, count) \
1086 . BFD_SEND (abfd, _bfd_set_reloc, (abfd, asect, location, count))
1094 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
1097 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1099 Possible errors are:
1100 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1101 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1102 o <<bfd_error_invalid_operation>> -
1103 The flag word contained a bit which was not applicable to the
1104 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
1105 on a BFD format which does not support demand paging.
1110 bfd_set_file_flags (bfd *abfd, flagword flags)
1112 if (abfd->format != bfd_object)
1114 bfd_set_error (bfd_error_wrong_format);
1118 if (bfd_read_p (abfd))
1120 bfd_set_error (bfd_error_invalid_operation);
1124 bfd_get_file_flags (abfd) = flags;
1125 if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1127 bfd_set_error (bfd_error_invalid_operation);
1135 bfd_assert (const char *file, int line)
1137 /* xgettext:c-format */
1138 (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1139 BFD_VERSION_STRING, file, line);
1142 /* A more or less friendly abort message. In libbfd.h abort is
1143 defined to call this function. */
1146 _bfd_abort (const char *file, int line, const char *fn)
1150 /* xgettext:c-format */
1151 (_("BFD %s internal error, aborting at %s:%d in %s\n"),
1152 BFD_VERSION_STRING, file, line, fn);
1155 /* xgettext:c-format */
1156 (_("BFD %s internal error, aborting at %s:%d\n"),
1157 BFD_VERSION_STRING, file, line);
1158 _bfd_error_handler (_("Please report this bug.\n"));
1159 _exit (EXIT_FAILURE);
1167 int bfd_get_arch_size (bfd *abfd);
1170 Returns the normalized architecture address size, in bits, as
1171 determined by the object file's format. By normalized, we mean
1172 either 32 or 64. For ELF, this information is included in the
1173 header. Use bfd_arch_bits_per_address for number of bits in
1174 the architecture address.
1177 Returns the arch size in bits if known, <<-1>> otherwise.
1181 bfd_get_arch_size (bfd *abfd)
1183 if (abfd->xvec->flavour == bfd_target_elf_flavour)
1184 return get_elf_backend_data (abfd)->s->arch_size;
1186 return bfd_arch_bits_per_address (abfd) > 32 ? 64 : 32;
1191 bfd_get_sign_extend_vma
1194 int bfd_get_sign_extend_vma (bfd *abfd);
1197 Indicates if the target architecture "naturally" sign extends
1198 an address. Some architectures implicitly sign extend address
1199 values when they are converted to types larger than the size
1200 of an address. For instance, bfd_get_start_address() will
1201 return an address sign extended to fill a bfd_vma when this is
1205 Returns <<1>> if the target architecture is known to sign
1206 extend addresses, <<0>> if the target architecture is known to
1207 not sign extend addresses, and <<-1>> otherwise.
1211 bfd_get_sign_extend_vma (bfd *abfd)
1215 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1216 return get_elf_backend_data (abfd)->sign_extend_vma;
1218 name = bfd_get_target (abfd);
1220 /* Return a proper value for DJGPP & PE COFF.
1221 This function is required for DWARF2 support, but there is
1222 no place to store this information in the COFF back end.
1223 Should enough other COFF targets add support for DWARF2,
1224 a place will have to be found. Until then, this hack will do. */
1225 if (CONST_STRNEQ (name, "coff-go32")
1226 || strcmp (name, "pe-i386") == 0
1227 || strcmp (name, "pei-i386") == 0
1228 || strcmp (name, "pe-x86-64") == 0
1229 || strcmp (name, "pei-x86-64") == 0
1230 || strcmp (name, "pe-arm-wince-little") == 0
1231 || strcmp (name, "pei-arm-wince-little") == 0
1232 || strcmp (name, "aixcoff-rs6000") == 0)
1235 if (CONST_STRNEQ (name, "mach-o"))
1238 bfd_set_error (bfd_error_wrong_format);
1244 bfd_set_start_address
1247 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1250 Make @var{vma} the entry point of output BFD @var{abfd}.
1253 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1257 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1259 abfd->start_address = vma;
1268 unsigned int bfd_get_gp_size (bfd *abfd);
1271 Return the maximum size of objects to be optimized using the GP
1272 register under MIPS ECOFF. This is typically set by the <<-G>>
1273 argument to the compiler, assembler or linker.
1277 bfd_get_gp_size (bfd *abfd)
1279 if (abfd->format == bfd_object)
1281 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1282 return ecoff_data (abfd)->gp_size;
1283 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1284 return elf_gp_size (abfd);
1294 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1297 Set the maximum size of objects to be optimized using the GP
1298 register under ECOFF or MIPS ELF. This is typically set by
1299 the <<-G>> argument to the compiler, assembler or linker.
1303 bfd_set_gp_size (bfd *abfd, unsigned int i)
1305 /* Don't try to set GP size on an archive or core file! */
1306 if (abfd->format != bfd_object)
1309 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1310 ecoff_data (abfd)->gp_size = i;
1311 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1312 elf_gp_size (abfd) = i;
1315 /* Get the GP value. This is an internal function used by some of the
1316 relocation special_function routines on targets which support a GP
1320 _bfd_get_gp_value (bfd *abfd)
1324 if (abfd->format != bfd_object)
1327 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1328 return ecoff_data (abfd)->gp;
1329 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1330 return elf_gp (abfd);
1335 /* Set the GP value. */
1338 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1342 if (abfd->format != bfd_object)
1345 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1346 ecoff_data (abfd)->gp = v;
1347 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1356 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1359 Convert, like <<strtoul>>, a numerical expression
1360 @var{string} into a <<bfd_vma>> integer, and return that integer.
1361 (Though without as many bells and whistles as <<strtoul>>.)
1362 The expression is assumed to be unsigned (i.e., positive).
1363 If given a @var{base}, it is used as the base for conversion.
1364 A base of 0 causes the function to interpret the string
1365 in hex if a leading "0x" or "0X" is found, otherwise
1366 in octal if a leading zero is found, otherwise in decimal.
1368 If the value would overflow, the maximum <<bfd_vma>> value is
1373 bfd_scan_vma (const char *string, const char **end, int base)
1377 unsigned int cutlim;
1380 /* Let the host do it if possible. */
1381 if (sizeof (bfd_vma) <= sizeof (unsigned long))
1382 return strtoul (string, (char **) end, base);
1384 #if defined (HAVE_STRTOULL) && defined (HAVE_LONG_LONG)
1385 if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1386 return strtoull (string, (char **) end, base);
1391 if (string[0] == '0')
1393 if ((string[1] == 'x') || (string[1] == 'X'))
1400 if ((base < 2) || (base > 36))
1405 && (string[1] == 'x' || string[1] == 'X')
1406 && ISXDIGIT (string[2]))
1411 cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1412 cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1420 if (ISDIGIT (digit))
1421 digit = digit - '0';
1422 else if (ISALPHA (digit))
1423 digit = TOUPPER (digit) - 'A' + 10;
1426 if (digit >= (unsigned int) base)
1428 if (value > cutoff || (value == cutoff && digit > cutlim))
1430 value = value * base + digit;
1435 value = ~ (bfd_vma) 0;
1445 bfd_copy_private_header_data
1448 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1451 Copy private BFD header information from the BFD @var{ibfd} to the
1452 the BFD @var{obfd}. This copies information that may require
1453 sections to exist, but does not require symbol tables. Return
1454 <<true>> on success, <<false>> on error.
1455 Possible error returns are:
1457 o <<bfd_error_no_memory>> -
1458 Not enough memory exists to create private data for @var{obfd}.
1460 .#define bfd_copy_private_header_data(ibfd, obfd) \
1461 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1468 bfd_copy_private_bfd_data
1471 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1474 Copy private BFD information from the BFD @var{ibfd} to the
1475 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1476 Possible error returns are:
1478 o <<bfd_error_no_memory>> -
1479 Not enough memory exists to create private data for @var{obfd}.
1481 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1482 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1489 bfd_set_private_flags
1492 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1495 Set private BFD flag information in the BFD @var{abfd}.
1496 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1499 o <<bfd_error_no_memory>> -
1500 Not enough memory exists to create private data for @var{obfd}.
1502 .#define bfd_set_private_flags(abfd, flags) \
1503 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1512 The following functions exist but have not yet been documented.
1514 .#define bfd_sizeof_headers(abfd, info) \
1515 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1517 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1518 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1519 . (abfd, syms, sec, off, file, func, line, NULL))
1521 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
1523 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1524 . (abfd, syms, sec, off, file, func, line, disc))
1526 .#define bfd_find_line(abfd, syms, sym, file, line) \
1527 . BFD_SEND (abfd, _bfd_find_line, \
1528 . (abfd, syms, sym, file, line))
1530 .#define bfd_find_inliner_info(abfd, file, func, line) \
1531 . BFD_SEND (abfd, _bfd_find_inliner_info, \
1532 . (abfd, file, func, line))
1534 .#define bfd_debug_info_start(abfd) \
1535 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1537 .#define bfd_debug_info_end(abfd) \
1538 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1540 .#define bfd_debug_info_accumulate(abfd, section) \
1541 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1543 .#define bfd_stat_arch_elt(abfd, stat) \
1544 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1546 .#define bfd_update_armap_timestamp(abfd) \
1547 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1549 .#define bfd_set_arch_mach(abfd, arch, mach)\
1550 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1552 .#define bfd_relax_section(abfd, section, link_info, again) \
1553 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1555 .#define bfd_gc_sections(abfd, link_info) \
1556 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1558 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
1559 . BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
1561 .#define bfd_merge_sections(abfd, link_info) \
1562 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1564 .#define bfd_is_group_section(abfd, sec) \
1565 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1567 .#define bfd_discard_group(abfd, sec) \
1568 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1570 .#define bfd_link_hash_table_create(abfd) \
1571 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1573 .#define bfd_link_add_symbols(abfd, info) \
1574 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1576 .#define bfd_link_just_syms(abfd, sec, info) \
1577 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1579 .#define bfd_final_link(abfd, info) \
1580 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1582 .#define bfd_free_cached_info(abfd) \
1583 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1585 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1586 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1588 .#define bfd_print_private_bfd_data(abfd, file)\
1589 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1591 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1592 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1594 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1595 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1596 . dyncount, dynsyms, ret))
1598 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1599 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1601 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1602 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1604 .extern bfd_byte *bfd_get_relocated_section_contents
1605 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1606 . bfd_boolean, asymbol **);
1612 bfd_get_relocated_section_contents (bfd *abfd,
1613 struct bfd_link_info *link_info,
1614 struct bfd_link_order *link_order,
1616 bfd_boolean relocatable,
1620 bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1621 bfd_byte *, bfd_boolean, asymbol **);
1623 if (link_order->type == bfd_indirect_link_order)
1625 abfd2 = link_order->u.indirect.section->owner;
1632 fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1634 return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1637 /* Record information about an ELF program header. */
1640 bfd_record_phdr (bfd *abfd,
1642 bfd_boolean flags_valid,
1644 bfd_boolean at_valid,
1646 bfd_boolean includes_filehdr,
1647 bfd_boolean includes_phdrs,
1651 struct elf_segment_map *m, **pm;
1654 if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1657 amt = sizeof (struct elf_segment_map);
1658 amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1659 m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
1666 m->p_flags_valid = flags_valid;
1667 m->p_paddr_valid = at_valid;
1668 m->includes_filehdr = includes_filehdr;
1669 m->includes_phdrs = includes_phdrs;
1672 memcpy (m->sections, secs, count * sizeof (asection *));
1674 for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
1682 /* Return true iff this target is 32-bit. */
1687 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1689 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1690 return bed->s->elfclass == ELFCLASS32;
1693 /* For non-ELF targets, use architecture information. */
1694 return bfd_arch_bits_per_address (abfd) <= 32;
1698 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1699 target's address size. */
1702 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1707 sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1711 sprintf_vma (buf, value);
1715 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1720 fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1724 fprintf_vma ((FILE *) stream, value);
1732 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1736 When more than one machine code number is available for the
1737 same machine type, this function can be used to switch between
1738 the preferred one (alternative == 0) and any others. Currently,
1739 only ELF supports this feature, with up to two alternate
1744 bfd_alt_mach_code (bfd *abfd, int alternative)
1746 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1750 switch (alternative)
1753 code = get_elf_backend_data (abfd)->elf_machine_code;
1757 code = get_elf_backend_data (abfd)->elf_machine_alt1;
1763 code = get_elf_backend_data (abfd)->elf_machine_alt2;
1772 elf_elfheader (abfd)->e_machine = code;
1782 bfd_emul_get_maxpagesize
1785 bfd_vma bfd_emul_get_maxpagesize (const char *);
1788 Returns the maximum page size, in bytes, as determined by
1792 Returns the maximum page size in bytes for ELF, 0 otherwise.
1796 bfd_emul_get_maxpagesize (const char *emul)
1798 const bfd_target *target;
1800 target = bfd_find_target (emul, NULL);
1802 && target->flavour == bfd_target_elf_flavour)
1803 return xvec_get_elf_backend_data (target)->maxpagesize;
1809 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1810 int offset, const bfd_target *orig_target)
1812 if (target->flavour == bfd_target_elf_flavour)
1814 const struct elf_backend_data *bed;
1816 bed = xvec_get_elf_backend_data (target);
1817 *((bfd_vma *) ((char *) bed + offset)) = size;
1820 if (target->alternative_target
1821 && target->alternative_target != orig_target)
1822 bfd_elf_set_pagesize (target->alternative_target, size, offset,
1828 bfd_emul_set_maxpagesize
1831 void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1834 For ELF, set the maximum page size for the emulation. It is
1835 a no-op for other formats.
1840 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1842 const bfd_target *target;
1844 target = bfd_find_target (emul, NULL);
1846 bfd_elf_set_pagesize (target, size,
1847 offsetof (struct elf_backend_data,
1848 maxpagesize), target);
1853 bfd_emul_get_commonpagesize
1856 bfd_vma bfd_emul_get_commonpagesize (const char *);
1859 Returns the common page size, in bytes, as determined by
1863 Returns the common page size in bytes for ELF, 0 otherwise.
1867 bfd_emul_get_commonpagesize (const char *emul)
1869 const bfd_target *target;
1871 target = bfd_find_target (emul, NULL);
1873 && target->flavour == bfd_target_elf_flavour)
1874 return xvec_get_elf_backend_data (target)->commonpagesize;
1881 bfd_emul_set_commonpagesize
1884 void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1887 For ELF, set the common page size for the emulation. It is
1888 a no-op for other formats.
1893 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1895 const bfd_target *target;
1897 target = bfd_find_target (emul, NULL);
1899 bfd_elf_set_pagesize (target, size,
1900 offsetof (struct elf_backend_data,
1901 commonpagesize), target);
1909 char *bfd_demangle (bfd *, const char *, int);
1912 Wrapper around cplus_demangle. Strips leading underscores and
1913 other such chars that would otherwise confuse the demangler.
1914 If passed a g++ v3 ABI mangled name, returns a buffer allocated
1915 with malloc holding the demangled name. Returns NULL otherwise
1916 and on memory alloc failure.
1920 bfd_demangle (bfd *abfd, const char *name, int options)
1923 const char *pre, *suf;
1925 bfd_boolean skip_lead;
1927 skip_lead = (abfd != NULL
1929 && bfd_get_symbol_leading_char (abfd) == *name);
1933 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1934 or the MS PE format. These formats have a number of leading '.'s
1935 on at least some symbols, so we remove all dots to avoid
1936 confusing the demangler. */
1938 while (*name == '.' || *name == '$')
1940 pre_len = name - pre;
1942 /* Strip off @plt and suchlike too. */
1944 suf = strchr (name, '@');
1947 alloc = (char *) bfd_malloc (suf - name + 1);
1950 memcpy (alloc, name, suf - name);
1951 alloc[suf - name] = '\0';
1955 res = cplus_demangle (name, options);
1964 size_t len = strlen (pre) + 1;
1965 alloc = (char *) bfd_malloc (len);
1968 memcpy (alloc, pre, len);
1974 /* Put back any prefix or suffix. */
1975 if (pre_len != 0 || suf != NULL)
1984 suf_len = strlen (suf) + 1;
1985 final = (char *) bfd_malloc (pre_len + len + suf_len);
1988 memcpy (final, pre, pre_len);
1989 memcpy (final + pre_len, res, len);
1990 memcpy (final + pre_len + len, suf, suf_len);
2001 bfd_update_compression_header
2004 void bfd_update_compression_header
2005 (bfd *abfd, bfd_byte *contents, asection *sec);
2008 Set the compression header at CONTENTS of SEC in ABFD and update
2009 elf_section_flags for compression.
2013 bfd_update_compression_header (bfd *abfd, bfd_byte *contents,
2016 if ((abfd->flags & BFD_COMPRESS) != 0)
2018 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2020 if ((abfd->flags & BFD_COMPRESS_GABI) != 0)
2022 const struct elf_backend_data *bed
2023 = get_elf_backend_data (abfd);
2025 /* Set the SHF_COMPRESSED bit. */
2026 elf_section_flags (sec) |= SHF_COMPRESSED;
2028 if (bed->s->elfclass == ELFCLASS32)
2030 Elf32_External_Chdr *echdr
2031 = (Elf32_External_Chdr *) contents;
2032 bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2033 bfd_put_32 (abfd, sec->size, &echdr->ch_size);
2034 bfd_put_32 (abfd, 1 << sec->alignment_power,
2035 &echdr->ch_addralign);
2039 Elf64_External_Chdr *echdr
2040 = (Elf64_External_Chdr *) contents;
2041 bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2042 bfd_put_32 (abfd, 0, &echdr->ch_reserved);
2043 bfd_put_64 (abfd, sec->size, &echdr->ch_size);
2044 bfd_put_64 (abfd, 1 << sec->alignment_power,
2045 &echdr->ch_addralign);
2050 /* Clear the SHF_COMPRESSED bit. */
2051 elf_section_flags (sec) &= ~SHF_COMPRESSED;
2053 /* Write the zlib header. It should be "ZLIB" followed by
2054 the uncompressed section size, 8 bytes in big-endian
2056 memcpy (contents, "ZLIB", 4);
2057 bfd_putb64 (sec->size, contents + 4);
2067 bfd_check_compression_header
2070 bfd_boolean bfd_check_compression_header
2071 (bfd *abfd, bfd_byte *contents, asection *sec,
2072 bfd_size_type *uncompressed_size);
2075 Check the compression header at CONTENTS of SEC in ABFD and
2076 store the uncompressed size in UNCOMPRESSED_SIZE if the
2077 compression header is valid.
2080 Return TRUE if the compression header is valid.
2084 bfd_check_compression_header (bfd *abfd, bfd_byte *contents,
2086 bfd_size_type *uncompressed_size)
2088 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
2089 && (elf_section_flags (sec) & SHF_COMPRESSED) != 0)
2091 Elf_Internal_Chdr chdr;
2092 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
2093 if (bed->s->elfclass == ELFCLASS32)
2095 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2096 chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2097 chdr.ch_size = bfd_get_32 (abfd, &echdr->ch_size);
2098 chdr.ch_addralign = bfd_get_32 (abfd, &echdr->ch_addralign);
2102 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2103 chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2104 chdr.ch_size = bfd_get_64 (abfd, &echdr->ch_size);
2105 chdr.ch_addralign = bfd_get_64 (abfd, &echdr->ch_addralign);
2107 if (chdr.ch_type == ELFCOMPRESS_ZLIB
2108 && chdr.ch_addralign == 1U << sec->alignment_power)
2110 *uncompressed_size = chdr.ch_size;
2120 bfd_get_compression_header_size
2123 int bfd_get_compression_header_size (bfd *abfd, asection *sec);
2126 Return the size of the compression header of SEC in ABFD.
2129 Return the size of the compression header in bytes.
2133 bfd_get_compression_header_size (bfd *abfd, asection *sec)
2135 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2139 if (!(abfd->flags & BFD_COMPRESS_GABI))
2142 else if (!(elf_section_flags (sec) & SHF_COMPRESSED))
2145 if (get_elf_backend_data (abfd)->s->elfclass == ELFCLASS32)
2146 return sizeof (Elf32_External_Chdr);
2148 return sizeof (Elf64_External_Chdr);
2156 bfd_convert_section_size
2159 bfd_size_type bfd_convert_section_size
2160 (bfd *ibfd, asection *isec, bfd *obfd, bfd_size_type size);
2163 Convert the size @var{size} of the section @var{isec} in input
2164 BFD @var{ibfd} to the section size in output BFD @var{obfd}.
2168 bfd_convert_section_size (bfd *ibfd, sec_ptr isec, bfd *obfd,
2171 bfd_size_type hdr_size;
2173 /* Do nothing if input file will be decompressed. */
2174 if ((ibfd->flags & BFD_DECOMPRESS))
2177 /* Do nothing if either input or output aren't ELF. */
2178 if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2179 || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2182 /* Do nothing if ELF classes of input and output are the same. */
2183 if (get_elf_backend_data (ibfd)->s->elfclass
2184 == get_elf_backend_data (obfd)->s->elfclass)
2187 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2188 hdr_size = bfd_get_compression_header_size (ibfd, isec);
2192 /* Adjust the size of the output SHF_COMPRESSED section. */
2193 if (hdr_size == sizeof (Elf32_External_Chdr))
2194 return (size - sizeof (Elf32_External_Chdr)
2195 + sizeof (Elf64_External_Chdr));
2197 return (size - sizeof (Elf64_External_Chdr)
2198 + sizeof (Elf32_External_Chdr));
2203 bfd_convert_section_contents
2206 bfd_boolean bfd_convert_section_contents
2207 (bfd *ibfd, asection *isec, bfd *obfd,
2208 bfd_byte **ptr, bfd_size_type *ptr_size);
2211 Convert the contents, stored in @var{*ptr}, of the section
2212 @var{isec} in input BFD @var{ibfd} to output BFD @var{obfd}
2213 if needed. The original buffer pointed to by @var{*ptr} may
2214 be freed and @var{*ptr} is returned with memory malloc'd by this
2215 function, and the new size written to @var{ptr_size}.
2219 bfd_convert_section_contents (bfd *ibfd, sec_ptr isec, bfd *obfd,
2220 bfd_byte **ptr, bfd_size_type *ptr_size)
2223 bfd_size_type ihdr_size, ohdr_size, size;
2224 Elf_Internal_Chdr chdr;
2225 bfd_boolean use_memmove;
2227 /* Do nothing if input file will be decompressed. */
2228 if ((ibfd->flags & BFD_DECOMPRESS))
2231 /* Do nothing if either input or output aren't ELF. */
2232 if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2233 || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2236 /* Do nothing if ELF classes of input and output are the same. */
2237 if (get_elf_backend_data (ibfd)->s->elfclass
2238 == get_elf_backend_data (obfd)->s->elfclass)
2241 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2242 ihdr_size = bfd_get_compression_header_size (ibfd, isec);
2248 /* Convert the contents of the input SHF_COMPRESSED section to
2249 output. Get the input compression header and the size of the
2250 output compression header. */
2251 if (ihdr_size == sizeof (Elf32_External_Chdr))
2253 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2254 chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2255 chdr.ch_size = bfd_get_32 (ibfd, &echdr->ch_size);
2256 chdr.ch_addralign = bfd_get_32 (ibfd, &echdr->ch_addralign);
2258 ohdr_size = sizeof (Elf64_External_Chdr);
2260 use_memmove = FALSE;
2264 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2265 chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2266 chdr.ch_size = bfd_get_64 (ibfd, &echdr->ch_size);
2267 chdr.ch_addralign = bfd_get_64 (ibfd, &echdr->ch_addralign);
2269 ohdr_size = sizeof (Elf32_External_Chdr);
2273 size = bfd_get_section_size (isec) - ihdr_size + ohdr_size;
2276 contents = (bfd_byte *) bfd_malloc (size);
2277 if (contents == NULL)
2281 /* Write out the output compression header. */
2282 if (ohdr_size == sizeof (Elf32_External_Chdr))
2284 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2285 bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2286 bfd_put_32 (obfd, chdr.ch_size, &echdr->ch_size);
2287 bfd_put_32 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2291 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2292 bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2293 bfd_put_32 (obfd, 0, &echdr->ch_reserved);
2294 bfd_put_64 (obfd, chdr.ch_size, &echdr->ch_size);
2295 bfd_put_64 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2298 /* Copy the compressed contents. */
2300 memmove (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);
2303 memcpy (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);