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_PLUGIN \
184 . | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON)
186 . {* Flags bits which are for BFD use only. *}
187 .#define BFD_FLAGS_FOR_BFD_USE_MASK \
188 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
189 . | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT \
190 . | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON)
192 . {* Is the file descriptor being cached? That is, can it be closed as
193 . needed, and re-opened when accessed later? *}
194 . unsigned int cacheable : 1;
196 . {* Marks whether there was a default target specified when the
197 . BFD was opened. This is used to select which matching algorithm
198 . to use to choose the back end. *}
199 . unsigned int target_defaulted : 1;
201 . {* ... and here: (``once'' means at least once). *}
202 . unsigned int opened_once : 1;
204 . {* Set if we have a locally maintained mtime value, rather than
205 . getting it from the file each time. *}
206 . unsigned int mtime_set : 1;
208 . {* Flag set if symbols from this BFD should not be exported. *}
209 . unsigned int no_export : 1;
211 . {* Remember when output has begun, to stop strange things
213 . unsigned int output_has_begun : 1;
215 . {* Have archive map. *}
216 . unsigned int has_armap : 1;
218 . {* Set if this is a thin archive. *}
219 . unsigned int is_thin_archive : 1;
221 . {* Set if only required symbols should be added in the link hash table for
222 . this object. Used by VMS linkers. *}
223 . unsigned int selective_search : 1;
225 . {* Set if this is the linker output BFD. *}
226 . unsigned int is_linker_output : 1;
228 . {* Set if this is the linker input BFD. *}
229 . unsigned int is_linker_input : 1;
231 . {* If this is an input for a compiler plug-in library. *}
232 . ENUM_BITFIELD (bfd_plugin_format) plugin_format : 2;
234 . {* Set if this is a plugin output file. *}
235 . unsigned int lto_output : 1;
237 . {* Set to dummy BFD created when claimed by a compiler plug-in
239 . bfd *plugin_dummy_bfd;
241 . {* Currently my_archive is tested before adding origin to
242 . anything. I believe that this can become always an add of
243 . origin, with origin set to 0 for non archive files. *}
246 . {* The origin in the archive of the proxy entry. This will
247 . normally be the same as origin, except for thin archives,
248 . when it will contain the current offset of the proxy in the
249 . thin archive rather than the offset of the bfd in its actual
251 . ufile_ptr proxy_origin;
253 . {* A hash table for section names. *}
254 . struct bfd_hash_table section_htab;
256 . {* Pointer to linked list of sections. *}
257 . struct bfd_section *sections;
259 . {* The last section on the section list. *}
260 . struct bfd_section *section_last;
262 . {* The number of sections. *}
263 . unsigned int section_count;
265 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
266 . be used only for archive elements. *}
269 . {* Stuff only useful for object files:
270 . The start address. *}
271 . bfd_vma start_address;
273 . {* Symbol table for output BFD (with symcount entries).
274 . Also used by the linker to cache input BFD symbols. *}
275 . struct bfd_symbol **outsymbols;
277 . {* Used for input and output. *}
278 . unsigned int symcount;
280 . {* Used for slurped dynamic symbol tables. *}
281 . unsigned int dynsymcount;
283 . {* Pointer to structure which contains architecture information. *}
284 . const struct bfd_arch_info *arch_info;
286 . {* Stuff only useful for archives. *}
288 . struct bfd *my_archive; {* The containing archive BFD. *}
289 . struct bfd *archive_next; {* The next BFD in the archive. *}
290 . struct bfd *archive_head; {* The first BFD in the archive. *}
291 . struct bfd *nested_archives; {* List of nested archive in a flattened
295 . {* For input BFDs, a chain of BFDs involved in a link. *}
297 . {* For output BFD, the linker hash table. *}
298 . struct bfd_link_hash_table *hash;
301 . {* Used by the back end to hold private data. *}
304 . struct aout_data_struct *aout_data;
305 . struct artdata *aout_ar_data;
306 . struct _oasys_data *oasys_obj_data;
307 . struct _oasys_ar_data *oasys_ar_data;
308 . struct coff_tdata *coff_obj_data;
309 . struct pe_tdata *pe_obj_data;
310 . struct xcoff_tdata *xcoff_obj_data;
311 . struct ecoff_tdata *ecoff_obj_data;
312 . struct ieee_data_struct *ieee_data;
313 . struct ieee_ar_data_struct *ieee_ar_data;
314 . struct srec_data_struct *srec_data;
315 . struct verilog_data_struct *verilog_data;
316 . struct ihex_data_struct *ihex_data;
317 . struct tekhex_data_struct *tekhex_data;
318 . struct elf_obj_tdata *elf_obj_data;
319 . struct nlm_obj_tdata *nlm_obj_data;
320 . struct bout_data_struct *bout_data;
321 . struct mmo_data_struct *mmo_data;
322 . struct sun_core_struct *sun_core_data;
323 . struct sco5_core_struct *sco5_core_data;
324 . struct trad_core_struct *trad_core_data;
325 . struct som_data_struct *som_data;
326 . struct hpux_core_struct *hpux_core_data;
327 . struct hppabsd_core_struct *hppabsd_core_data;
328 . struct sgi_core_struct *sgi_core_data;
329 . struct lynx_core_struct *lynx_core_data;
330 . struct osf_core_struct *osf_core_data;
331 . struct cisco_core_struct *cisco_core_data;
332 . struct versados_data_struct *versados_data;
333 . struct netbsd_core_struct *netbsd_core_data;
334 . struct mach_o_data_struct *mach_o_data;
335 . struct mach_o_fat_data_struct *mach_o_fat_data;
336 . struct plugin_data_struct *plugin_data;
337 . struct bfd_pef_data_struct *pef_data;
338 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
339 . struct bfd_sym_data_struct *sym_data;
344 . {* Used by the application to hold private data. *}
347 . {* Where all the allocated stuff under this BFD goes. This is a
348 . struct objalloc *, but we use void * to avoid requiring the inclusion
352 . {* For input BFDs, the build ID, if the object has one. *}
353 . const struct bfd_build_id *build_id;
356 .{* See note beside bfd_set_section_userdata. *}
357 .static inline bfd_boolean
358 .bfd_set_cacheable (bfd * abfd, bfd_boolean val)
360 . abfd->cacheable = val;
370 #include "libiberty.h"
371 #include "demangle.h"
372 #include "safe-ctype.h"
375 #include "coff/internal.h"
376 #include "coff/sym.h"
378 #include "libecoff.h"
383 #define EXIT_FAILURE 1
387 /* provide storage for subsystem, stack and heap data which may have been
388 passed in on the command line. Ld puts this data into a bfd_link_info
389 struct which ultimately gets passed in to the bfd. When it arrives, copy
390 it to the following struct so that the data will be available in coffcode.h
391 where it is needed. The typedef's used are defined in bfd.h */
395 Error reporting, Miscellaneous, typedef bfd, BFD front end
400 Most BFD functions return nonzero on success (check their
401 individual documentation for precise semantics). On an error,
402 they call <<bfd_set_error>> to set an error condition that callers
403 can check by calling <<bfd_get_error>>.
404 If that returns <<bfd_error_system_call>>, then check
407 The easiest way to report a BFD error to the user is to
411 Type <<bfd_error_type>>
413 The values returned by <<bfd_get_error>> are defined by the
414 enumerated type <<bfd_error_type>>.
418 .typedef enum bfd_error
420 . bfd_error_no_error = 0,
421 . bfd_error_system_call,
422 . bfd_error_invalid_target,
423 . bfd_error_wrong_format,
424 . bfd_error_wrong_object_format,
425 . bfd_error_invalid_operation,
426 . bfd_error_no_memory,
427 . bfd_error_no_symbols,
428 . bfd_error_no_armap,
429 . bfd_error_no_more_archived_files,
430 . bfd_error_malformed_archive,
431 . bfd_error_missing_dso,
432 . bfd_error_file_not_recognized,
433 . bfd_error_file_ambiguously_recognized,
434 . bfd_error_no_contents,
435 . bfd_error_nonrepresentable_section,
436 . bfd_error_no_debug_section,
437 . bfd_error_bad_value,
438 . bfd_error_file_truncated,
439 . bfd_error_file_too_big,
440 . bfd_error_on_input,
441 . bfd_error_invalid_error_code
447 static bfd_error_type bfd_error = bfd_error_no_error;
448 static bfd *input_bfd = NULL;
449 static bfd_error_type input_error = bfd_error_no_error;
451 const char *const bfd_errmsgs[] =
454 N_("System call error"),
455 N_("Invalid bfd target"),
456 N_("File in wrong format"),
457 N_("Archive object file in wrong format"),
458 N_("Invalid operation"),
459 N_("Memory exhausted"),
461 N_("Archive has no index; run ranlib to add one"),
462 N_("No more archived files"),
463 N_("Malformed archive"),
464 N_("DSO missing from command line"),
465 N_("File format not recognized"),
466 N_("File format is ambiguous"),
467 N_("Section has no contents"),
468 N_("Nonrepresentable section on output"),
469 N_("Symbol needs debug section which does not exist"),
471 N_("File truncated"),
473 N_("Error reading %s: %s"),
474 N_("#<Invalid error code>")
482 bfd_error_type bfd_get_error (void);
485 Return the current BFD error condition.
499 void bfd_set_error (bfd_error_type error_tag, ...);
502 Set the BFD error condition to be @var{error_tag}.
503 If @var{error_tag} is bfd_error_on_input, then this function
504 takes two more parameters, the input bfd where the error
505 occurred, and the bfd_error_type error.
509 bfd_set_error (bfd_error_type error_tag, ...)
511 bfd_error = error_tag;
512 if (error_tag == bfd_error_on_input)
514 /* This is an error that occurred during bfd_close when
515 writing an archive, but on one of the input files. */
518 va_start (ap, error_tag);
519 input_bfd = va_arg (ap, bfd *);
520 input_error = (bfd_error_type) va_arg (ap, int);
521 if (input_error >= bfd_error_on_input)
532 const char *bfd_errmsg (bfd_error_type error_tag);
535 Return a string describing the error @var{error_tag}, or
536 the system error if @var{error_tag} is <<bfd_error_system_call>>.
540 bfd_errmsg (bfd_error_type error_tag)
545 if (error_tag == bfd_error_on_input)
548 const char *msg = bfd_errmsg (input_error);
550 if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
554 /* Ick, what to do on out of memory? */
558 if (error_tag == bfd_error_system_call)
559 return xstrerror (errno);
561 if (error_tag > bfd_error_invalid_error_code)
562 error_tag = bfd_error_invalid_error_code; /* sanity check */
564 return _(bfd_errmsgs [error_tag]);
572 void bfd_perror (const char *message);
575 Print to the standard error stream a string describing the
576 last BFD error that occurred, or the last system error if
577 the last BFD error was a system call failure. If @var{message}
578 is non-NULL and non-empty, the error string printed is preceded
579 by @var{message}, a colon, and a space. It is followed by a newline.
583 bfd_perror (const char *message)
586 if (message == NULL || *message == '\0')
587 fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
589 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
597 Some BFD functions want to print messages describing the
598 problem. They call a BFD error handler function. This
599 function may be overridden by the program.
601 The BFD error handler acts like vprintf.
605 .typedef void (*bfd_error_handler_type) (const char *, va_list);
609 /* The program name used when printing BFD error messages. */
611 static const char *_bfd_error_program_name;
613 /* This is the default routine to handle BFD error messages.
614 Like fprintf (stderr, ...), but also handles some extra format specifiers.
616 %A section name from section. For group components, print group name too.
617 %B file name from bfd. For archive components, prints archive too.
619 Note - because these two extra format specifiers require special handling
620 they are scanned for and processed in this function, before calling
621 vfprintf. This means that the *arguments* for these format specifiers
622 must be the first ones in the variable argument list, regardless of where
623 the specifiers appear in the format string. Thus for example calling
624 this function with a format string of:
626 "blah %s blah %A blah %d blah %B"
628 would involve passing the arguments as:
630 "blah %s blah %A blah %d blah %B",
638 error_handler_internal (const char *fmt, va_list ap)
641 const char *new_fmt, *p;
645 /* PR 4992: Don't interrupt output being sent to stdout. */
648 if (_bfd_error_program_name != NULL)
649 fprintf (stderr, "%s: ", _bfd_error_program_name);
651 fprintf (stderr, "BFD: ");
656 /* Reserve enough space for the existing format string. */
657 avail -= strlen (fmt) + 1;
659 _exit (EXIT_FAILURE);
665 size_t len, extra, trim;
668 if (p == NULL || p[1] == '\0')
673 memcpy (bufp, fmt, len + 1);
678 if (p[1] == 'A' || p[1] == 'B')
681 memcpy (bufp, fmt, len);
686 /* If we run out of space, tough, you lose your ridiculously
687 long file or section name. It's not safe to try to alloc
688 memory here; We might be printing an out of memory message. */
699 bfd *abfd = va_arg (ap, bfd *);
702 /* Invoking %B with a null bfd pointer is an internal error. */
704 else if (abfd->my_archive
705 && !bfd_is_thin_archive (abfd->my_archive))
706 snprintf (bufp, avail, "%s(%s)",
707 abfd->my_archive->filename, abfd->filename);
709 snprintf (bufp, avail, "%s", abfd->filename);
713 asection *sec = va_arg (ap, asection *);
715 const char *group = NULL;
716 struct coff_comdat_info *ci;
719 /* Invoking %A with a null section pointer is an internal error. */
723 && bfd_get_flavour (abfd) == bfd_target_elf_flavour
724 && elf_next_in_group (sec) != NULL
725 && (sec->flags & SEC_GROUP) == 0)
726 group = elf_group_name (sec);
727 else if (abfd != NULL
728 && bfd_get_flavour (abfd) == bfd_target_coff_flavour
729 && (ci = bfd_coff_get_comdat_section (sec->owner,
733 snprintf (bufp, avail, "%s[%s]", sec->name, group);
735 snprintf (bufp, avail, "%s", sec->name);
738 avail = avail - len + 2;
740 /* We need to replace any '%' we printed by "%%".
741 First count how many. */
745 while ((q = strchr (q, '%')) != NULL)
751 /* If there isn't room, trim off the end of the string. */
756 trim = extra - avail;
769 /* Now double all '%' chars, shuffling the string as we go. */
772 while ((q[extra] = *q) != '%')
782 vfprintf (stderr, new_fmt, ap);
784 /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
785 warning, so use the fputc function to avoid it. */
786 fputc ('\n', stderr);
790 /* This is a function pointer to the routine which should handle BFD
791 error messages. It is called when a BFD routine encounters an
792 error for which it wants to print a message. Going through a
793 function pointer permits a program linked against BFD to intercept
794 the messages and deal with them itself. */
796 static bfd_error_handler_type _bfd_error_internal = error_handler_internal;
799 _bfd_error_handler (const char *fmt, ...)
804 _bfd_error_internal (fmt, ap);
810 bfd_set_error_handler
813 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
816 Set the BFD error handler function. Returns the previous
820 bfd_error_handler_type
821 bfd_set_error_handler (bfd_error_handler_type pnew)
823 bfd_error_handler_type pold;
825 pold = _bfd_error_internal;
826 _bfd_error_internal = pnew;
832 bfd_set_error_program_name
835 void bfd_set_error_program_name (const char *);
838 Set the program name to use when printing a BFD error. This
839 is printed before the error message followed by a colon and
840 space. The string must not be changed after it is passed to
845 bfd_set_error_program_name (const char *name)
847 _bfd_error_program_name = name;
854 If BFD finds an internal inconsistency, the bfd assert
855 handler is called with information on the BFD version, BFD
856 source file and line. If this happens, most programs linked
857 against BFD are expected to want to exit with an error, or mark
858 the current BFD operation as failed, so it is recommended to
859 override the default handler, which just calls
860 _bfd_error_handler and continues.
864 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
865 . const char *bfd_version,
866 . const char *bfd_file,
871 /* Note the use of bfd_ prefix on the parameter names above: we want to
872 show which one is the message and which is the version by naming the
873 parameters, but avoid polluting the program-using-bfd namespace as
874 the typedef is visible in the exported headers that the program
875 includes. Below, it's just for consistency. */
878 _bfd_default_assert_handler (const char *bfd_formatmsg,
879 const char *bfd_version,
880 const char *bfd_file,
884 _bfd_error_handler (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
887 /* Similar to _bfd_error_handler, a program can decide to exit on an
888 internal BFD error. We use a non-variadic type to simplify passing
889 on parameters to other functions, e.g. _bfd_error_handler. */
891 static bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
895 bfd_set_assert_handler
898 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
901 Set the BFD assert handler function. Returns the previous
905 bfd_assert_handler_type
906 bfd_set_assert_handler (bfd_assert_handler_type pnew)
908 bfd_assert_handler_type pold;
910 pold = _bfd_assert_handler;
911 _bfd_assert_handler = pnew;
917 Miscellaneous, Memory Usage, Error reporting, BFD front end
923 Miscellaneous functions
928 bfd_get_reloc_upper_bound
931 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
934 Return the number of bytes required to store the
935 relocation information associated with section @var{sect}
936 attached to bfd @var{abfd}. If an error occurs, return -1.
941 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
943 if (abfd->format != bfd_object)
945 bfd_set_error (bfd_error_invalid_operation);
949 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
954 bfd_canonicalize_reloc
957 long bfd_canonicalize_reloc
958 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
961 Call the back end associated with the open BFD
962 @var{abfd} and translate the external form of the relocation
963 information attached to @var{sec} into the internal canonical
964 form. Place the table into memory at @var{loc}, which has
965 been preallocated, usually by a call to
966 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
969 The @var{syms} table is also needed for horrible internal magic
974 bfd_canonicalize_reloc (bfd *abfd,
979 if (abfd->format != bfd_object)
981 bfd_set_error (bfd_error_invalid_operation);
985 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
986 (abfd, asect, location, symbols));
995 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
998 Set the relocation pointer and count within
999 section @var{sec} to the values @var{rel} and @var{count}.
1000 The argument @var{abfd} is ignored.
1005 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
1010 asect->orelocation = location;
1011 asect->reloc_count = count;
1019 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
1022 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1024 Possible errors are:
1025 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1026 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1027 o <<bfd_error_invalid_operation>> -
1028 The flag word contained a bit which was not applicable to the
1029 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
1030 on a BFD format which does not support demand paging.
1035 bfd_set_file_flags (bfd *abfd, flagword flags)
1037 if (abfd->format != bfd_object)
1039 bfd_set_error (bfd_error_wrong_format);
1043 if (bfd_read_p (abfd))
1045 bfd_set_error (bfd_error_invalid_operation);
1049 bfd_get_file_flags (abfd) = flags;
1050 if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1052 bfd_set_error (bfd_error_invalid_operation);
1060 bfd_assert (const char *file, int line)
1062 /* xgettext:c-format */
1063 (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1064 BFD_VERSION_STRING, file, line);
1067 /* A more or less friendly abort message. In libbfd.h abort is
1068 defined to call this function. */
1071 _bfd_abort (const char *file, int line, const char *fn)
1075 /* xgettext:c-format */
1076 (_("BFD %s internal error, aborting at %s:%d in %s\n"),
1077 BFD_VERSION_STRING, file, line, fn);
1080 /* xgettext:c-format */
1081 (_("BFD %s internal error, aborting at %s:%d\n"),
1082 BFD_VERSION_STRING, file, line);
1083 _bfd_error_handler (_("Please report this bug.\n"));
1084 _exit (EXIT_FAILURE);
1092 int bfd_get_arch_size (bfd *abfd);
1095 Returns the normalized architecture address size, in bits, as
1096 determined by the object file's format. By normalized, we mean
1097 either 32 or 64. For ELF, this information is included in the
1098 header. Use bfd_arch_bits_per_address for number of bits in
1099 the architecture address.
1102 Returns the arch size in bits if known, <<-1>> otherwise.
1106 bfd_get_arch_size (bfd *abfd)
1108 if (abfd->xvec->flavour == bfd_target_elf_flavour)
1109 return get_elf_backend_data (abfd)->s->arch_size;
1111 return bfd_arch_bits_per_address (abfd) > 32 ? 64 : 32;
1116 bfd_get_sign_extend_vma
1119 int bfd_get_sign_extend_vma (bfd *abfd);
1122 Indicates if the target architecture "naturally" sign extends
1123 an address. Some architectures implicitly sign extend address
1124 values when they are converted to types larger than the size
1125 of an address. For instance, bfd_get_start_address() will
1126 return an address sign extended to fill a bfd_vma when this is
1130 Returns <<1>> if the target architecture is known to sign
1131 extend addresses, <<0>> if the target architecture is known to
1132 not sign extend addresses, and <<-1>> otherwise.
1136 bfd_get_sign_extend_vma (bfd *abfd)
1140 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1141 return get_elf_backend_data (abfd)->sign_extend_vma;
1143 name = bfd_get_target (abfd);
1145 /* Return a proper value for DJGPP & PE COFF.
1146 This function is required for DWARF2 support, but there is
1147 no place to store this information in the COFF back end.
1148 Should enough other COFF targets add support for DWARF2,
1149 a place will have to be found. Until then, this hack will do. */
1150 if (CONST_STRNEQ (name, "coff-go32")
1151 || strcmp (name, "pe-i386") == 0
1152 || strcmp (name, "pei-i386") == 0
1153 || strcmp (name, "pe-x86-64") == 0
1154 || strcmp (name, "pei-x86-64") == 0
1155 || strcmp (name, "pe-arm-wince-little") == 0
1156 || strcmp (name, "pei-arm-wince-little") == 0
1157 || strcmp (name, "aixcoff-rs6000") == 0)
1160 if (CONST_STRNEQ (name, "mach-o"))
1163 bfd_set_error (bfd_error_wrong_format);
1169 bfd_set_start_address
1172 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1175 Make @var{vma} the entry point of output BFD @var{abfd}.
1178 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1182 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1184 abfd->start_address = vma;
1193 unsigned int bfd_get_gp_size (bfd *abfd);
1196 Return the maximum size of objects to be optimized using the GP
1197 register under MIPS ECOFF. This is typically set by the <<-G>>
1198 argument to the compiler, assembler or linker.
1202 bfd_get_gp_size (bfd *abfd)
1204 if (abfd->format == bfd_object)
1206 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1207 return ecoff_data (abfd)->gp_size;
1208 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1209 return elf_gp_size (abfd);
1219 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1222 Set the maximum size of objects to be optimized using the GP
1223 register under ECOFF or MIPS ELF. This is typically set by
1224 the <<-G>> argument to the compiler, assembler or linker.
1228 bfd_set_gp_size (bfd *abfd, unsigned int i)
1230 /* Don't try to set GP size on an archive or core file! */
1231 if (abfd->format != bfd_object)
1234 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1235 ecoff_data (abfd)->gp_size = i;
1236 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1237 elf_gp_size (abfd) = i;
1240 /* Get the GP value. This is an internal function used by some of the
1241 relocation special_function routines on targets which support a GP
1245 _bfd_get_gp_value (bfd *abfd)
1249 if (abfd->format != bfd_object)
1252 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1253 return ecoff_data (abfd)->gp;
1254 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1255 return elf_gp (abfd);
1260 /* Set the GP value. */
1263 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1267 if (abfd->format != bfd_object)
1270 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1271 ecoff_data (abfd)->gp = v;
1272 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1281 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1284 Convert, like <<strtoul>>, a numerical expression
1285 @var{string} into a <<bfd_vma>> integer, and return that integer.
1286 (Though without as many bells and whistles as <<strtoul>>.)
1287 The expression is assumed to be unsigned (i.e., positive).
1288 If given a @var{base}, it is used as the base for conversion.
1289 A base of 0 causes the function to interpret the string
1290 in hex if a leading "0x" or "0X" is found, otherwise
1291 in octal if a leading zero is found, otherwise in decimal.
1293 If the value would overflow, the maximum <<bfd_vma>> value is
1298 bfd_scan_vma (const char *string, const char **end, int base)
1302 unsigned int cutlim;
1305 /* Let the host do it if possible. */
1306 if (sizeof (bfd_vma) <= sizeof (unsigned long))
1307 return strtoul (string, (char **) end, base);
1309 #ifdef HAVE_STRTOULL
1310 if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1311 return strtoull (string, (char **) end, base);
1316 if (string[0] == '0')
1318 if ((string[1] == 'x') || (string[1] == 'X'))
1325 if ((base < 2) || (base > 36))
1330 && (string[1] == 'x' || string[1] == 'X')
1331 && ISXDIGIT (string[2]))
1336 cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1337 cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1345 if (ISDIGIT (digit))
1346 digit = digit - '0';
1347 else if (ISALPHA (digit))
1348 digit = TOUPPER (digit) - 'A' + 10;
1351 if (digit >= (unsigned int) base)
1353 if (value > cutoff || (value == cutoff && digit > cutlim))
1355 value = value * base + digit;
1360 value = ~ (bfd_vma) 0;
1370 bfd_copy_private_header_data
1373 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1376 Copy private BFD header information from the BFD @var{ibfd} to the
1377 the BFD @var{obfd}. This copies information that may require
1378 sections to exist, but does not require symbol tables. Return
1379 <<true>> on success, <<false>> on error.
1380 Possible error returns are:
1382 o <<bfd_error_no_memory>> -
1383 Not enough memory exists to create private data for @var{obfd}.
1385 .#define bfd_copy_private_header_data(ibfd, obfd) \
1386 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1393 bfd_copy_private_bfd_data
1396 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1399 Copy private BFD information from the BFD @var{ibfd} to the
1400 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1401 Possible error returns are:
1403 o <<bfd_error_no_memory>> -
1404 Not enough memory exists to create private data for @var{obfd}.
1406 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1407 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1414 bfd_set_private_flags
1417 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1420 Set private BFD flag information in the BFD @var{abfd}.
1421 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1424 o <<bfd_error_no_memory>> -
1425 Not enough memory exists to create private data for @var{obfd}.
1427 .#define bfd_set_private_flags(abfd, flags) \
1428 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1437 The following functions exist but have not yet been documented.
1439 .#define bfd_sizeof_headers(abfd, info) \
1440 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1442 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1443 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1444 . (abfd, syms, sec, off, file, func, line, NULL))
1446 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
1448 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1449 . (abfd, syms, sec, off, file, func, line, disc))
1451 .#define bfd_find_line(abfd, syms, sym, file, line) \
1452 . BFD_SEND (abfd, _bfd_find_line, \
1453 . (abfd, syms, sym, file, line))
1455 .#define bfd_find_inliner_info(abfd, file, func, line) \
1456 . BFD_SEND (abfd, _bfd_find_inliner_info, \
1457 . (abfd, file, func, line))
1459 .#define bfd_debug_info_start(abfd) \
1460 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1462 .#define bfd_debug_info_end(abfd) \
1463 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1465 .#define bfd_debug_info_accumulate(abfd, section) \
1466 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1468 .#define bfd_stat_arch_elt(abfd, stat) \
1469 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1471 .#define bfd_update_armap_timestamp(abfd) \
1472 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1474 .#define bfd_set_arch_mach(abfd, arch, mach)\
1475 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1477 .#define bfd_relax_section(abfd, section, link_info, again) \
1478 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1480 .#define bfd_gc_sections(abfd, link_info) \
1481 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1483 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
1484 . BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
1486 .#define bfd_merge_sections(abfd, link_info) \
1487 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1489 .#define bfd_is_group_section(abfd, sec) \
1490 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1492 .#define bfd_discard_group(abfd, sec) \
1493 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1495 .#define bfd_link_hash_table_create(abfd) \
1496 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1498 .#define bfd_link_add_symbols(abfd, info) \
1499 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1501 .#define bfd_link_just_syms(abfd, sec, info) \
1502 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1504 .#define bfd_final_link(abfd, info) \
1505 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1507 .#define bfd_free_cached_info(abfd) \
1508 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1510 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1511 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1513 .#define bfd_print_private_bfd_data(abfd, file)\
1514 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1516 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1517 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1519 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1520 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1521 . dyncount, dynsyms, ret))
1523 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1524 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1526 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1527 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1529 .extern bfd_byte *bfd_get_relocated_section_contents
1530 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1531 . bfd_boolean, asymbol **);
1537 bfd_get_relocated_section_contents (bfd *abfd,
1538 struct bfd_link_info *link_info,
1539 struct bfd_link_order *link_order,
1541 bfd_boolean relocatable,
1545 bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1546 bfd_byte *, bfd_boolean, asymbol **);
1548 if (link_order->type == bfd_indirect_link_order)
1550 abfd2 = link_order->u.indirect.section->owner;
1557 fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1559 return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1562 /* Record information about an ELF program header. */
1565 bfd_record_phdr (bfd *abfd,
1567 bfd_boolean flags_valid,
1569 bfd_boolean at_valid,
1571 bfd_boolean includes_filehdr,
1572 bfd_boolean includes_phdrs,
1576 struct elf_segment_map *m, **pm;
1579 if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1582 amt = sizeof (struct elf_segment_map);
1583 amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1584 m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
1591 m->p_flags_valid = flags_valid;
1592 m->p_paddr_valid = at_valid;
1593 m->includes_filehdr = includes_filehdr;
1594 m->includes_phdrs = includes_phdrs;
1597 memcpy (m->sections, secs, count * sizeof (asection *));
1599 for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
1607 /* Return true iff this target is 32-bit. */
1612 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1614 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1615 return bed->s->elfclass == ELFCLASS32;
1618 /* For non-ELF targets, use architecture information. */
1619 return bfd_arch_bits_per_address (abfd) <= 32;
1623 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1624 target's address size. */
1627 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1632 sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1636 sprintf_vma (buf, value);
1640 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1645 fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1649 fprintf_vma ((FILE *) stream, value);
1657 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1661 When more than one machine code number is available for the
1662 same machine type, this function can be used to switch between
1663 the preferred one (alternative == 0) and any others. Currently,
1664 only ELF supports this feature, with up to two alternate
1669 bfd_alt_mach_code (bfd *abfd, int alternative)
1671 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1675 switch (alternative)
1678 code = get_elf_backend_data (abfd)->elf_machine_code;
1682 code = get_elf_backend_data (abfd)->elf_machine_alt1;
1688 code = get_elf_backend_data (abfd)->elf_machine_alt2;
1697 elf_elfheader (abfd)->e_machine = code;
1707 bfd_emul_get_maxpagesize
1710 bfd_vma bfd_emul_get_maxpagesize (const char *);
1713 Returns the maximum page size, in bytes, as determined by
1717 Returns the maximum page size in bytes for ELF, 0 otherwise.
1721 bfd_emul_get_maxpagesize (const char *emul)
1723 const bfd_target *target;
1725 target = bfd_find_target (emul, NULL);
1727 && target->flavour == bfd_target_elf_flavour)
1728 return xvec_get_elf_backend_data (target)->maxpagesize;
1734 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1735 int offset, const bfd_target *orig_target)
1737 if (target->flavour == bfd_target_elf_flavour)
1739 const struct elf_backend_data *bed;
1741 bed = xvec_get_elf_backend_data (target);
1742 *((bfd_vma *) ((char *) bed + offset)) = size;
1745 if (target->alternative_target
1746 && target->alternative_target != orig_target)
1747 bfd_elf_set_pagesize (target->alternative_target, size, offset,
1753 bfd_emul_set_maxpagesize
1756 void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1759 For ELF, set the maximum page size for the emulation. It is
1760 a no-op for other formats.
1765 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1767 const bfd_target *target;
1769 target = bfd_find_target (emul, NULL);
1771 bfd_elf_set_pagesize (target, size,
1772 offsetof (struct elf_backend_data,
1773 maxpagesize), target);
1778 bfd_emul_get_commonpagesize
1781 bfd_vma bfd_emul_get_commonpagesize (const char *);
1784 Returns the common page size, in bytes, as determined by
1788 Returns the common page size in bytes for ELF, 0 otherwise.
1792 bfd_emul_get_commonpagesize (const char *emul)
1794 const bfd_target *target;
1796 target = bfd_find_target (emul, NULL);
1798 && target->flavour == bfd_target_elf_flavour)
1799 return xvec_get_elf_backend_data (target)->commonpagesize;
1806 bfd_emul_set_commonpagesize
1809 void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1812 For ELF, set the common page size for the emulation. It is
1813 a no-op for other formats.
1818 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1820 const bfd_target *target;
1822 target = bfd_find_target (emul, NULL);
1824 bfd_elf_set_pagesize (target, size,
1825 offsetof (struct elf_backend_data,
1826 commonpagesize), target);
1834 char *bfd_demangle (bfd *, const char *, int);
1837 Wrapper around cplus_demangle. Strips leading underscores and
1838 other such chars that would otherwise confuse the demangler.
1839 If passed a g++ v3 ABI mangled name, returns a buffer allocated
1840 with malloc holding the demangled name. Returns NULL otherwise
1841 and on memory alloc failure.
1845 bfd_demangle (bfd *abfd, const char *name, int options)
1848 const char *pre, *suf;
1850 bfd_boolean skip_lead;
1852 skip_lead = (abfd != NULL
1854 && bfd_get_symbol_leading_char (abfd) == *name);
1858 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1859 or the MS PE format. These formats have a number of leading '.'s
1860 on at least some symbols, so we remove all dots to avoid
1861 confusing the demangler. */
1863 while (*name == '.' || *name == '$')
1865 pre_len = name - pre;
1867 /* Strip off @plt and suchlike too. */
1869 suf = strchr (name, '@');
1872 alloc = (char *) bfd_malloc (suf - name + 1);
1875 memcpy (alloc, name, suf - name);
1876 alloc[suf - name] = '\0';
1880 res = cplus_demangle (name, options);
1889 size_t len = strlen (pre) + 1;
1890 alloc = (char *) bfd_malloc (len);
1893 memcpy (alloc, pre, len);
1899 /* Put back any prefix or suffix. */
1900 if (pre_len != 0 || suf != NULL)
1909 suf_len = strlen (suf) + 1;
1910 final = (char *) bfd_malloc (pre_len + len + suf_len);
1913 memcpy (final, pre, pre_len);
1914 memcpy (final + pre_len, res, len);
1915 memcpy (final + pre_len + len, suf, suf_len);
1926 bfd_update_compression_header
1929 void bfd_update_compression_header
1930 (bfd *abfd, bfd_byte *contents, asection *sec);
1933 Set the compression header at CONTENTS of SEC in ABFD and update
1934 elf_section_flags for compression.
1938 bfd_update_compression_header (bfd *abfd, bfd_byte *contents,
1941 if ((abfd->flags & BFD_COMPRESS) != 0)
1943 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1945 if ((abfd->flags & BFD_COMPRESS_GABI) != 0)
1947 const struct elf_backend_data *bed
1948 = get_elf_backend_data (abfd);
1950 /* Set the SHF_COMPRESSED bit. */
1951 elf_section_flags (sec) |= SHF_COMPRESSED;
1953 if (bed->s->elfclass == ELFCLASS32)
1955 Elf32_External_Chdr *echdr
1956 = (Elf32_External_Chdr *) contents;
1957 bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
1958 bfd_put_32 (abfd, sec->size, &echdr->ch_size);
1959 bfd_put_32 (abfd, 1 << sec->alignment_power,
1960 &echdr->ch_addralign);
1964 Elf64_External_Chdr *echdr
1965 = (Elf64_External_Chdr *) contents;
1966 bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
1967 bfd_put_32 (abfd, 0, &echdr->ch_reserved);
1968 bfd_put_64 (abfd, sec->size, &echdr->ch_size);
1969 bfd_put_64 (abfd, 1 << sec->alignment_power,
1970 &echdr->ch_addralign);
1975 /* Clear the SHF_COMPRESSED bit. */
1976 elf_section_flags (sec) &= ~SHF_COMPRESSED;
1978 /* Write the zlib header. It should be "ZLIB" followed by
1979 the uncompressed section size, 8 bytes in big-endian
1981 memcpy (contents, "ZLIB", 4);
1982 bfd_putb64 (sec->size, contents + 4);
1992 bfd_check_compression_header
1995 bfd_boolean bfd_check_compression_header
1996 (bfd *abfd, bfd_byte *contents, asection *sec,
1997 bfd_size_type *uncompressed_size);
2000 Check the compression header at CONTENTS of SEC in ABFD and
2001 store the uncompressed size in UNCOMPRESSED_SIZE if the
2002 compression header is valid.
2005 Return TRUE if the compression header is valid.
2009 bfd_check_compression_header (bfd *abfd, bfd_byte *contents,
2011 bfd_size_type *uncompressed_size)
2013 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
2014 && (elf_section_flags (sec) & SHF_COMPRESSED) != 0)
2016 Elf_Internal_Chdr chdr;
2017 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
2018 if (bed->s->elfclass == ELFCLASS32)
2020 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2021 chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2022 chdr.ch_size = bfd_get_32 (abfd, &echdr->ch_size);
2023 chdr.ch_addralign = bfd_get_32 (abfd, &echdr->ch_addralign);
2027 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2028 chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2029 chdr.ch_size = bfd_get_64 (abfd, &echdr->ch_size);
2030 chdr.ch_addralign = bfd_get_64 (abfd, &echdr->ch_addralign);
2032 if (chdr.ch_type == ELFCOMPRESS_ZLIB
2033 && chdr.ch_addralign == 1U << sec->alignment_power)
2035 *uncompressed_size = chdr.ch_size;
2045 bfd_get_compression_header_size
2048 int bfd_get_compression_header_size (bfd *abfd, asection *sec);
2051 Return the size of the compression header of SEC in ABFD.
2054 Return the size of the compression header in bytes.
2058 bfd_get_compression_header_size (bfd *abfd, asection *sec)
2060 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2064 if (!(abfd->flags & BFD_COMPRESS_GABI))
2067 else if (!(elf_section_flags (sec) & SHF_COMPRESSED))
2070 if (get_elf_backend_data (abfd)->s->elfclass == ELFCLASS32)
2071 return sizeof (Elf32_External_Chdr);
2073 return sizeof (Elf64_External_Chdr);
2081 bfd_convert_section_size
2084 bfd_size_type bfd_convert_section_size
2085 (bfd *ibfd, asection *isec, bfd *obfd, bfd_size_type size);
2088 Convert the size @var{size} of the section @var{isec} in input
2089 BFD @var{ibfd} to the section size in output BFD @var{obfd}.
2093 bfd_convert_section_size (bfd *ibfd, sec_ptr isec, bfd *obfd,
2096 bfd_size_type hdr_size;
2098 /* Do nothing if input file will be decompressed. */
2099 if ((ibfd->flags & BFD_DECOMPRESS))
2102 /* Do nothing if either input or output aren't ELF. */
2103 if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2104 || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2107 /* Do nothing if ELF classes of input and output are the same. */
2108 if (get_elf_backend_data (ibfd)->s->elfclass
2109 == get_elf_backend_data (obfd)->s->elfclass)
2112 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2113 hdr_size = bfd_get_compression_header_size (ibfd, isec);
2117 /* Adjust the size of the output SHF_COMPRESSED section. */
2118 if (hdr_size == sizeof (Elf32_External_Chdr))
2119 return (size - sizeof (Elf32_External_Chdr)
2120 + sizeof (Elf64_External_Chdr));
2122 return (size - sizeof (Elf64_External_Chdr)
2123 + sizeof (Elf32_External_Chdr));
2128 bfd_convert_section_contents
2131 bfd_boolean bfd_convert_section_contents
2132 (bfd *ibfd, asection *isec, bfd *obfd,
2133 bfd_byte **ptr, bfd_size_type *ptr_size);
2136 Convert the contents, stored in @var{*ptr}, of the section
2137 @var{isec} in input BFD @var{ibfd} to output BFD @var{obfd}
2138 if needed. The original buffer pointed to by @var{*ptr} may
2139 be freed and @var{*ptr} is returned with memory malloc'd by this
2140 function, and the new size written to @var{ptr_size}.
2144 bfd_convert_section_contents (bfd *ibfd, sec_ptr isec, bfd *obfd,
2145 bfd_byte **ptr, bfd_size_type *ptr_size)
2148 bfd_size_type ihdr_size, ohdr_size, size;
2149 Elf_Internal_Chdr chdr;
2150 bfd_boolean use_memmove;
2152 /* Do nothing if input file will be decompressed. */
2153 if ((ibfd->flags & BFD_DECOMPRESS))
2156 /* Do nothing if either input or output aren't ELF. */
2157 if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2158 || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2161 /* Do nothing if ELF classes of input and output are the same. */
2162 if (get_elf_backend_data (ibfd)->s->elfclass
2163 == get_elf_backend_data (obfd)->s->elfclass)
2166 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2167 ihdr_size = bfd_get_compression_header_size (ibfd, isec);
2173 /* Convert the contents of the input SHF_COMPRESSED section to
2174 output. Get the input compression header and the size of the
2175 output compression header. */
2176 if (ihdr_size == sizeof (Elf32_External_Chdr))
2178 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2179 chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2180 chdr.ch_size = bfd_get_32 (ibfd, &echdr->ch_size);
2181 chdr.ch_addralign = bfd_get_32 (ibfd, &echdr->ch_addralign);
2183 ohdr_size = sizeof (Elf64_External_Chdr);
2185 use_memmove = FALSE;
2189 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2190 chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2191 chdr.ch_size = bfd_get_64 (ibfd, &echdr->ch_size);
2192 chdr.ch_addralign = bfd_get_64 (ibfd, &echdr->ch_addralign);
2194 ohdr_size = sizeof (Elf32_External_Chdr);
2198 size = bfd_get_section_size (isec) - ihdr_size + ohdr_size;
2201 contents = (bfd_byte *) bfd_malloc (size);
2202 if (contents == NULL)
2206 /* Write out the output compression header. */
2207 if (ohdr_size == sizeof (Elf32_External_Chdr))
2209 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2210 bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2211 bfd_put_32 (obfd, chdr.ch_size, &echdr->ch_size);
2212 bfd_put_32 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2216 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2217 bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2218 bfd_put_32 (obfd, 0, &echdr->ch_reserved);
2219 bfd_put_64 (obfd, chdr.ch_size, &echdr->ch_size);
2220 bfd_put_64 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2223 /* Copy the compressed contents. */
2225 memmove (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);
2228 memcpy (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);