1 /* Generic BFD library interface and support routines.
2 Copyright (C) 1990-2016 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_uknown = 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 printf.
605 .typedef void (*bfd_error_handler_type) (const char *, ...);
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 _bfd_default_error_handler (const char *fmt, ...)
642 const char *new_fmt, *p;
646 /* PR 4992: Don't interrupt output being sent to stdout. */
649 if (_bfd_error_program_name != NULL)
650 fprintf (stderr, "%s: ", _bfd_error_program_name);
652 fprintf (stderr, "BFD: ");
658 /* Reserve enough space for the existing format string. */
659 avail -= strlen (fmt) + 1;
661 _exit (EXIT_FAILURE);
667 size_t len, extra, trim;
670 if (p == NULL || p[1] == '\0')
675 memcpy (bufp, fmt, len + 1);
680 if (p[1] == 'A' || p[1] == 'B')
683 memcpy (bufp, fmt, len);
688 /* If we run out of space, tough, you lose your ridiculously
689 long file or section name. It's not safe to try to alloc
690 memory here; We might be printing an out of memory message. */
701 bfd *abfd = va_arg (ap, bfd *);
704 /* Invoking %B with a null bfd pointer is an internal error. */
706 else if (abfd->my_archive
707 && !bfd_is_thin_archive (abfd->my_archive))
708 snprintf (bufp, avail, "%s(%s)",
709 abfd->my_archive->filename, abfd->filename);
711 snprintf (bufp, avail, "%s", abfd->filename);
715 asection *sec = va_arg (ap, asection *);
717 const char *group = NULL;
718 struct coff_comdat_info *ci;
721 /* Invoking %A with a null section pointer is an internal error. */
725 && bfd_get_flavour (abfd) == bfd_target_elf_flavour
726 && elf_next_in_group (sec) != NULL
727 && (sec->flags & SEC_GROUP) == 0)
728 group = elf_group_name (sec);
729 else if (abfd != NULL
730 && bfd_get_flavour (abfd) == bfd_target_coff_flavour
731 && (ci = bfd_coff_get_comdat_section (sec->owner,
735 snprintf (bufp, avail, "%s[%s]", sec->name, group);
737 snprintf (bufp, avail, "%s", sec->name);
740 avail = avail - len + 2;
742 /* We need to replace any '%' we printed by "%%".
743 First count how many. */
747 while ((q = strchr (q, '%')) != NULL)
753 /* If there isn't room, trim off the end of the string. */
758 trim = extra - avail;
771 /* Now double all '%' chars, shuffling the string as we go. */
774 while ((q[extra] = *q) != '%')
784 vfprintf (stderr, new_fmt, ap);
787 /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
788 warning, so use the fputc function to avoid it. */
789 fputc ('\n', stderr);
793 /* This is a function pointer to the routine which should handle BFD
794 error messages. It is called when a BFD routine encounters an
795 error for which it wants to print a message. Going through a
796 function pointer permits a program linked against BFD to intercept
797 the messages and deal with them itself. */
799 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
803 bfd_set_error_handler
806 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
809 Set the BFD error handler function. Returns the previous
813 bfd_error_handler_type
814 bfd_set_error_handler (bfd_error_handler_type pnew)
816 bfd_error_handler_type pold;
818 pold = _bfd_error_handler;
819 _bfd_error_handler = pnew;
825 bfd_set_error_program_name
828 void bfd_set_error_program_name (const char *);
831 Set the program name to use when printing a BFD error. This
832 is printed before the error message followed by a colon and
833 space. The string must not be changed after it is passed to
838 bfd_set_error_program_name (const char *name)
840 _bfd_error_program_name = name;
845 bfd_get_error_handler
848 bfd_error_handler_type bfd_get_error_handler (void);
851 Return the BFD error handler function.
854 bfd_error_handler_type
855 bfd_get_error_handler (void)
857 return _bfd_error_handler;
864 If BFD finds an internal inconsistency, the bfd assert
865 handler is called with information on the BFD version, BFD
866 source file and line. If this happens, most programs linked
867 against BFD are expected to want to exit with an error, or mark
868 the current BFD operation as failed, so it is recommended to
869 override the default handler, which just calls
870 _bfd_error_handler and continues.
874 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
875 . const char *bfd_version,
876 . const char *bfd_file,
881 /* Note the use of bfd_ prefix on the parameter names above: we want to
882 show which one is the message and which is the version by naming the
883 parameters, but avoid polluting the program-using-bfd namespace as
884 the typedef is visible in the exported headers that the program
885 includes. Below, it's just for consistency. */
888 _bfd_default_assert_handler (const char *bfd_formatmsg,
889 const char *bfd_version,
890 const char *bfd_file,
894 (*_bfd_error_handler) (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
897 /* Similar to _bfd_error_handler, a program can decide to exit on an
898 internal BFD error. We use a non-variadic type to simplify passing
899 on parameters to other functions, e.g. _bfd_error_handler. */
901 bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
905 bfd_set_assert_handler
908 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
911 Set the BFD assert handler function. Returns the previous
915 bfd_assert_handler_type
916 bfd_set_assert_handler (bfd_assert_handler_type pnew)
918 bfd_assert_handler_type pold;
920 pold = _bfd_assert_handler;
921 _bfd_assert_handler = pnew;
927 bfd_get_assert_handler
930 bfd_assert_handler_type bfd_get_assert_handler (void);
933 Return the BFD assert handler function.
936 bfd_assert_handler_type
937 bfd_get_assert_handler (void)
939 return _bfd_assert_handler;
944 Miscellaneous, Memory Usage, Error reporting, BFD front end
950 Miscellaneous functions
955 bfd_get_reloc_upper_bound
958 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
961 Return the number of bytes required to store the
962 relocation information associated with section @var{sect}
963 attached to bfd @var{abfd}. If an error occurs, return -1.
968 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
970 if (abfd->format != bfd_object)
972 bfd_set_error (bfd_error_invalid_operation);
976 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
981 bfd_canonicalize_reloc
984 long bfd_canonicalize_reloc
985 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
988 Call the back end associated with the open BFD
989 @var{abfd} and translate the external form of the relocation
990 information attached to @var{sec} into the internal canonical
991 form. Place the table into memory at @var{loc}, which has
992 been preallocated, usually by a call to
993 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
996 The @var{syms} table is also needed for horrible internal magic
1001 bfd_canonicalize_reloc (bfd *abfd,
1006 if (abfd->format != bfd_object)
1008 bfd_set_error (bfd_error_invalid_operation);
1012 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
1013 (abfd, asect, location, symbols));
1022 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
1025 Set the relocation pointer and count within
1026 section @var{sec} to the values @var{rel} and @var{count}.
1027 The argument @var{abfd} is ignored.
1032 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
1037 asect->orelocation = location;
1038 asect->reloc_count = count;
1046 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
1049 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1051 Possible errors are:
1052 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1053 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1054 o <<bfd_error_invalid_operation>> -
1055 The flag word contained a bit which was not applicable to the
1056 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
1057 on a BFD format which does not support demand paging.
1062 bfd_set_file_flags (bfd *abfd, flagword flags)
1064 if (abfd->format != bfd_object)
1066 bfd_set_error (bfd_error_wrong_format);
1070 if (bfd_read_p (abfd))
1072 bfd_set_error (bfd_error_invalid_operation);
1076 bfd_get_file_flags (abfd) = flags;
1077 if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1079 bfd_set_error (bfd_error_invalid_operation);
1087 bfd_assert (const char *file, int line)
1089 (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1090 BFD_VERSION_STRING, file, line);
1093 /* A more or less friendly abort message. In libbfd.h abort is
1094 defined to call this function. */
1097 _bfd_abort (const char *file, int line, const char *fn)
1100 (*_bfd_error_handler)
1101 (_("BFD %s internal error, aborting at %s:%d in %s\n"),
1102 BFD_VERSION_STRING, file, line, fn);
1104 (*_bfd_error_handler)
1105 (_("BFD %s internal error, aborting at %s:%d\n"),
1106 BFD_VERSION_STRING, file, line);
1107 (*_bfd_error_handler) (_("Please report this bug.\n"));
1108 _exit (EXIT_FAILURE);
1116 int bfd_get_arch_size (bfd *abfd);
1119 Returns the normalized architecture address size, in bits, as
1120 determined by the object file's format. By normalized, we mean
1121 either 32 or 64. For ELF, this information is included in the
1122 header. Use bfd_arch_bits_per_address for number of bits in
1123 the architecture address.
1126 Returns the arch size in bits if known, <<-1>> otherwise.
1130 bfd_get_arch_size (bfd *abfd)
1132 if (abfd->xvec->flavour == bfd_target_elf_flavour)
1133 return get_elf_backend_data (abfd)->s->arch_size;
1135 return bfd_arch_bits_per_address (abfd) > 32 ? 64 : 32;
1140 bfd_get_sign_extend_vma
1143 int bfd_get_sign_extend_vma (bfd *abfd);
1146 Indicates if the target architecture "naturally" sign extends
1147 an address. Some architectures implicitly sign extend address
1148 values when they are converted to types larger than the size
1149 of an address. For instance, bfd_get_start_address() will
1150 return an address sign extended to fill a bfd_vma when this is
1154 Returns <<1>> if the target architecture is known to sign
1155 extend addresses, <<0>> if the target architecture is known to
1156 not sign extend addresses, and <<-1>> otherwise.
1160 bfd_get_sign_extend_vma (bfd *abfd)
1164 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1165 return get_elf_backend_data (abfd)->sign_extend_vma;
1167 name = bfd_get_target (abfd);
1169 /* Return a proper value for DJGPP & PE COFF.
1170 This function is required for DWARF2 support, but there is
1171 no place to store this information in the COFF back end.
1172 Should enough other COFF targets add support for DWARF2,
1173 a place will have to be found. Until then, this hack will do. */
1174 if (CONST_STRNEQ (name, "coff-go32")
1175 || strcmp (name, "pe-i386") == 0
1176 || strcmp (name, "pei-i386") == 0
1177 || strcmp (name, "pe-x86-64") == 0
1178 || strcmp (name, "pei-x86-64") == 0
1179 || strcmp (name, "pe-arm-wince-little") == 0
1180 || strcmp (name, "pei-arm-wince-little") == 0
1181 || strcmp (name, "aixcoff-rs6000") == 0)
1184 if (CONST_STRNEQ (name, "mach-o"))
1187 bfd_set_error (bfd_error_wrong_format);
1193 bfd_set_start_address
1196 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1199 Make @var{vma} the entry point of output BFD @var{abfd}.
1202 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1206 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1208 abfd->start_address = vma;
1217 unsigned int bfd_get_gp_size (bfd *abfd);
1220 Return the maximum size of objects to be optimized using the GP
1221 register under MIPS ECOFF. This is typically set by the <<-G>>
1222 argument to the compiler, assembler or linker.
1226 bfd_get_gp_size (bfd *abfd)
1228 if (abfd->format == bfd_object)
1230 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1231 return ecoff_data (abfd)->gp_size;
1232 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1233 return elf_gp_size (abfd);
1243 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1246 Set the maximum size of objects to be optimized using the GP
1247 register under ECOFF or MIPS ELF. This is typically set by
1248 the <<-G>> argument to the compiler, assembler or linker.
1252 bfd_set_gp_size (bfd *abfd, unsigned int i)
1254 /* Don't try to set GP size on an archive or core file! */
1255 if (abfd->format != bfd_object)
1258 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1259 ecoff_data (abfd)->gp_size = i;
1260 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1261 elf_gp_size (abfd) = i;
1264 /* Get the GP value. This is an internal function used by some of the
1265 relocation special_function routines on targets which support a GP
1269 _bfd_get_gp_value (bfd *abfd)
1273 if (abfd->format != bfd_object)
1276 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1277 return ecoff_data (abfd)->gp;
1278 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1279 return elf_gp (abfd);
1284 /* Set the GP value. */
1287 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1291 if (abfd->format != bfd_object)
1294 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1295 ecoff_data (abfd)->gp = v;
1296 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1305 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1308 Convert, like <<strtoul>>, a numerical expression
1309 @var{string} into a <<bfd_vma>> integer, and return that integer.
1310 (Though without as many bells and whistles as <<strtoul>>.)
1311 The expression is assumed to be unsigned (i.e., positive).
1312 If given a @var{base}, it is used as the base for conversion.
1313 A base of 0 causes the function to interpret the string
1314 in hex if a leading "0x" or "0X" is found, otherwise
1315 in octal if a leading zero is found, otherwise in decimal.
1317 If the value would overflow, the maximum <<bfd_vma>> value is
1322 bfd_scan_vma (const char *string, const char **end, int base)
1326 unsigned int cutlim;
1329 /* Let the host do it if possible. */
1330 if (sizeof (bfd_vma) <= sizeof (unsigned long))
1331 return strtoul (string, (char **) end, base);
1333 #ifdef HAVE_STRTOULL
1334 if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1335 return strtoull (string, (char **) end, base);
1340 if (string[0] == '0')
1342 if ((string[1] == 'x') || (string[1] == 'X'))
1349 if ((base < 2) || (base > 36))
1354 && (string[1] == 'x' || string[1] == 'X')
1355 && ISXDIGIT (string[2]))
1360 cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1361 cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1369 if (ISDIGIT (digit))
1370 digit = digit - '0';
1371 else if (ISALPHA (digit))
1372 digit = TOUPPER (digit) - 'A' + 10;
1375 if (digit >= (unsigned int) base)
1377 if (value > cutoff || (value == cutoff && digit > cutlim))
1379 value = value * base + digit;
1384 value = ~ (bfd_vma) 0;
1394 bfd_copy_private_header_data
1397 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1400 Copy private BFD header information from the BFD @var{ibfd} to the
1401 the BFD @var{obfd}. This copies information that may require
1402 sections to exist, but does not require symbol tables. Return
1403 <<true>> on success, <<false>> on error.
1404 Possible error returns are:
1406 o <<bfd_error_no_memory>> -
1407 Not enough memory exists to create private data for @var{obfd}.
1409 .#define bfd_copy_private_header_data(ibfd, obfd) \
1410 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1417 bfd_copy_private_bfd_data
1420 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1423 Copy private BFD information from the BFD @var{ibfd} to the
1424 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1425 Possible error returns are:
1427 o <<bfd_error_no_memory>> -
1428 Not enough memory exists to create private data for @var{obfd}.
1430 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1431 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1438 bfd_merge_private_bfd_data
1441 bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1444 Merge private BFD information from the BFD @var{ibfd} to the
1445 the output file BFD @var{obfd} when linking. Return <<TRUE>>
1446 on success, <<FALSE>> on error. Possible error returns are:
1448 o <<bfd_error_no_memory>> -
1449 Not enough memory exists to create private data for @var{obfd}.
1451 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1452 . BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1459 bfd_set_private_flags
1462 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1465 Set private BFD flag information in the BFD @var{abfd}.
1466 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1469 o <<bfd_error_no_memory>> -
1470 Not enough memory exists to create private data for @var{obfd}.
1472 .#define bfd_set_private_flags(abfd, flags) \
1473 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1482 The following functions exist but have not yet been documented.
1484 .#define bfd_sizeof_headers(abfd, info) \
1485 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1487 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1488 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1489 . (abfd, syms, sec, off, file, func, line, NULL))
1491 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
1493 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1494 . (abfd, syms, sec, off, file, func, line, disc))
1496 .#define bfd_find_line(abfd, syms, sym, file, line) \
1497 . BFD_SEND (abfd, _bfd_find_line, \
1498 . (abfd, syms, sym, file, line))
1500 .#define bfd_find_inliner_info(abfd, file, func, line) \
1501 . BFD_SEND (abfd, _bfd_find_inliner_info, \
1502 . (abfd, file, func, line))
1504 .#define bfd_debug_info_start(abfd) \
1505 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1507 .#define bfd_debug_info_end(abfd) \
1508 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1510 .#define bfd_debug_info_accumulate(abfd, section) \
1511 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1513 .#define bfd_stat_arch_elt(abfd, stat) \
1514 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1516 .#define bfd_update_armap_timestamp(abfd) \
1517 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1519 .#define bfd_set_arch_mach(abfd, arch, mach)\
1520 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1522 .#define bfd_relax_section(abfd, section, link_info, again) \
1523 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1525 .#define bfd_gc_sections(abfd, link_info) \
1526 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1528 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
1529 . BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
1531 .#define bfd_merge_sections(abfd, link_info) \
1532 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1534 .#define bfd_is_group_section(abfd, sec) \
1535 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1537 .#define bfd_discard_group(abfd, sec) \
1538 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1540 .#define bfd_link_hash_table_create(abfd) \
1541 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1543 .#define bfd_link_add_symbols(abfd, info) \
1544 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1546 .#define bfd_link_just_syms(abfd, sec, info) \
1547 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1549 .#define bfd_final_link(abfd, info) \
1550 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1552 .#define bfd_free_cached_info(abfd) \
1553 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1555 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1556 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1558 .#define bfd_print_private_bfd_data(abfd, file)\
1559 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1561 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1562 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1564 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1565 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1566 . dyncount, dynsyms, ret))
1568 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1569 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1571 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1572 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1574 .extern bfd_byte *bfd_get_relocated_section_contents
1575 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1576 . bfd_boolean, asymbol **);
1582 bfd_get_relocated_section_contents (bfd *abfd,
1583 struct bfd_link_info *link_info,
1584 struct bfd_link_order *link_order,
1586 bfd_boolean relocatable,
1590 bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1591 bfd_byte *, bfd_boolean, asymbol **);
1593 if (link_order->type == bfd_indirect_link_order)
1595 abfd2 = link_order->u.indirect.section->owner;
1602 fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1604 return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1607 /* Record information about an ELF program header. */
1610 bfd_record_phdr (bfd *abfd,
1612 bfd_boolean flags_valid,
1614 bfd_boolean at_valid,
1616 bfd_boolean includes_filehdr,
1617 bfd_boolean includes_phdrs,
1621 struct elf_segment_map *m, **pm;
1624 if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1627 amt = sizeof (struct elf_segment_map);
1628 amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1629 m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
1636 m->p_flags_valid = flags_valid;
1637 m->p_paddr_valid = at_valid;
1638 m->includes_filehdr = includes_filehdr;
1639 m->includes_phdrs = includes_phdrs;
1642 memcpy (m->sections, secs, count * sizeof (asection *));
1644 for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
1652 /* Return true iff this target is 32-bit. */
1657 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1659 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1660 return bed->s->elfclass == ELFCLASS32;
1663 /* For non-ELF targets, use architecture information. */
1664 return bfd_arch_bits_per_address (abfd) <= 32;
1668 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1669 target's address size. */
1672 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1677 sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1681 sprintf_vma (buf, value);
1685 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1690 fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1694 fprintf_vma ((FILE *) stream, value);
1702 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1706 When more than one machine code number is available for the
1707 same machine type, this function can be used to switch between
1708 the preferred one (alternative == 0) and any others. Currently,
1709 only ELF supports this feature, with up to two alternate
1714 bfd_alt_mach_code (bfd *abfd, int alternative)
1716 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1720 switch (alternative)
1723 code = get_elf_backend_data (abfd)->elf_machine_code;
1727 code = get_elf_backend_data (abfd)->elf_machine_alt1;
1733 code = get_elf_backend_data (abfd)->elf_machine_alt2;
1742 elf_elfheader (abfd)->e_machine = code;
1752 bfd_emul_get_maxpagesize
1755 bfd_vma bfd_emul_get_maxpagesize (const char *);
1758 Returns the maximum page size, in bytes, as determined by
1762 Returns the maximum page size in bytes for ELF, 0 otherwise.
1766 bfd_emul_get_maxpagesize (const char *emul)
1768 const bfd_target *target;
1770 target = bfd_find_target (emul, NULL);
1772 && target->flavour == bfd_target_elf_flavour)
1773 return xvec_get_elf_backend_data (target)->maxpagesize;
1779 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1780 int offset, const bfd_target *orig_target)
1782 if (target->flavour == bfd_target_elf_flavour)
1784 const struct elf_backend_data *bed;
1786 bed = xvec_get_elf_backend_data (target);
1787 *((bfd_vma *) ((char *) bed + offset)) = size;
1790 if (target->alternative_target
1791 && target->alternative_target != orig_target)
1792 bfd_elf_set_pagesize (target->alternative_target, size, offset,
1798 bfd_emul_set_maxpagesize
1801 void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1804 For ELF, set the maximum page size for the emulation. It is
1805 a no-op for other formats.
1810 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1812 const bfd_target *target;
1814 target = bfd_find_target (emul, NULL);
1816 bfd_elf_set_pagesize (target, size,
1817 offsetof (struct elf_backend_data,
1818 maxpagesize), target);
1823 bfd_emul_get_commonpagesize
1826 bfd_vma bfd_emul_get_commonpagesize (const char *);
1829 Returns the common page size, in bytes, as determined by
1833 Returns the common page size in bytes for ELF, 0 otherwise.
1837 bfd_emul_get_commonpagesize (const char *emul)
1839 const bfd_target *target;
1841 target = bfd_find_target (emul, NULL);
1843 && target->flavour == bfd_target_elf_flavour)
1844 return xvec_get_elf_backend_data (target)->commonpagesize;
1851 bfd_emul_set_commonpagesize
1854 void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1857 For ELF, set the common page size for the emulation. It is
1858 a no-op for other formats.
1863 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1865 const bfd_target *target;
1867 target = bfd_find_target (emul, NULL);
1869 bfd_elf_set_pagesize (target, size,
1870 offsetof (struct elf_backend_data,
1871 commonpagesize), target);
1879 char *bfd_demangle (bfd *, const char *, int);
1882 Wrapper around cplus_demangle. Strips leading underscores and
1883 other such chars that would otherwise confuse the demangler.
1884 If passed a g++ v3 ABI mangled name, returns a buffer allocated
1885 with malloc holding the demangled name. Returns NULL otherwise
1886 and on memory alloc failure.
1890 bfd_demangle (bfd *abfd, const char *name, int options)
1893 const char *pre, *suf;
1895 bfd_boolean skip_lead;
1897 skip_lead = (abfd != NULL
1899 && bfd_get_symbol_leading_char (abfd) == *name);
1903 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1904 or the MS PE format. These formats have a number of leading '.'s
1905 on at least some symbols, so we remove all dots to avoid
1906 confusing the demangler. */
1908 while (*name == '.' || *name == '$')
1910 pre_len = name - pre;
1912 /* Strip off @plt and suchlike too. */
1914 suf = strchr (name, '@');
1917 alloc = (char *) bfd_malloc (suf - name + 1);
1920 memcpy (alloc, name, suf - name);
1921 alloc[suf - name] = '\0';
1925 res = cplus_demangle (name, options);
1934 size_t len = strlen (pre) + 1;
1935 alloc = (char *) bfd_malloc (len);
1938 memcpy (alloc, pre, len);
1944 /* Put back any prefix or suffix. */
1945 if (pre_len != 0 || suf != NULL)
1954 suf_len = strlen (suf) + 1;
1955 final = (char *) bfd_malloc (pre_len + len + suf_len);
1958 memcpy (final, pre, pre_len);
1959 memcpy (final + pre_len, res, len);
1960 memcpy (final + pre_len + len, suf, suf_len);
1971 bfd_update_compression_header
1974 void bfd_update_compression_header
1975 (bfd *abfd, bfd_byte *contents, asection *sec);
1978 Set the compression header at CONTENTS of SEC in ABFD and update
1979 elf_section_flags for compression.
1983 bfd_update_compression_header (bfd *abfd, bfd_byte *contents,
1986 if ((abfd->flags & BFD_COMPRESS) != 0)
1988 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1990 if ((abfd->flags & BFD_COMPRESS_GABI) != 0)
1992 const struct elf_backend_data *bed
1993 = get_elf_backend_data (abfd);
1995 /* Set the SHF_COMPRESSED bit. */
1996 elf_section_flags (sec) |= SHF_COMPRESSED;
1998 if (bed->s->elfclass == ELFCLASS32)
2000 Elf32_External_Chdr *echdr
2001 = (Elf32_External_Chdr *) contents;
2002 bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2003 bfd_put_32 (abfd, sec->size, &echdr->ch_size);
2004 bfd_put_32 (abfd, 1 << sec->alignment_power,
2005 &echdr->ch_addralign);
2009 Elf64_External_Chdr *echdr
2010 = (Elf64_External_Chdr *) contents;
2011 bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2012 bfd_put_32 (abfd, 0, &echdr->ch_reserved);
2013 bfd_put_64 (abfd, sec->size, &echdr->ch_size);
2014 bfd_put_64 (abfd, 1 << sec->alignment_power,
2015 &echdr->ch_addralign);
2020 /* Clear the SHF_COMPRESSED bit. */
2021 elf_section_flags (sec) &= ~SHF_COMPRESSED;
2023 /* Write the zlib header. It should be "ZLIB" followed by
2024 the uncompressed section size, 8 bytes in big-endian
2026 memcpy (contents, "ZLIB", 4);
2027 bfd_putb64 (sec->size, contents + 4);
2037 bfd_check_compression_header
2040 bfd_boolean bfd_check_compression_header
2041 (bfd *abfd, bfd_byte *contents, asection *sec,
2042 bfd_size_type *uncompressed_size);
2045 Check the compression header at CONTENTS of SEC in ABFD and
2046 store the uncompressed size in UNCOMPRESSED_SIZE if the
2047 compression header is valid.
2050 Return TRUE if the compression header is valid.
2054 bfd_check_compression_header (bfd *abfd, bfd_byte *contents,
2056 bfd_size_type *uncompressed_size)
2058 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
2059 && (elf_section_flags (sec) & SHF_COMPRESSED) != 0)
2061 Elf_Internal_Chdr chdr;
2062 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
2063 if (bed->s->elfclass == ELFCLASS32)
2065 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2066 chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2067 chdr.ch_size = bfd_get_32 (abfd, &echdr->ch_size);
2068 chdr.ch_addralign = bfd_get_32 (abfd, &echdr->ch_addralign);
2072 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2073 chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2074 chdr.ch_size = bfd_get_64 (abfd, &echdr->ch_size);
2075 chdr.ch_addralign = bfd_get_64 (abfd, &echdr->ch_addralign);
2077 if (chdr.ch_type == ELFCOMPRESS_ZLIB
2078 && chdr.ch_addralign == 1U << sec->alignment_power)
2080 *uncompressed_size = chdr.ch_size;
2090 bfd_get_compression_header_size
2093 int bfd_get_compression_header_size (bfd *abfd, asection *sec);
2096 Return the size of the compression header of SEC in ABFD.
2099 Return the size of the compression header in bytes.
2103 bfd_get_compression_header_size (bfd *abfd, asection *sec)
2105 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2109 if (!(abfd->flags & BFD_COMPRESS_GABI))
2112 else if (!(elf_section_flags (sec) & SHF_COMPRESSED))
2115 if (get_elf_backend_data (abfd)->s->elfclass == ELFCLASS32)
2116 return sizeof (Elf32_External_Chdr);
2118 return sizeof (Elf64_External_Chdr);
2126 bfd_convert_section_size
2129 bfd_size_type bfd_convert_section_size
2130 (bfd *ibfd, asection *isec, bfd *obfd, bfd_size_type size);
2133 Convert the size @var{size} of the section @var{isec} in input
2134 BFD @var{ibfd} to the section size in output BFD @var{obfd}.
2138 bfd_convert_section_size (bfd *ibfd, sec_ptr isec, bfd *obfd,
2141 bfd_size_type hdr_size;
2143 /* Do nothing if input file will be decompressed. */
2144 if ((ibfd->flags & BFD_DECOMPRESS))
2147 /* Do nothing if either input or output aren't ELF. */
2148 if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2149 || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2152 /* Do nothing if ELF classes of input and output are the same. */
2153 if (get_elf_backend_data (ibfd)->s->elfclass
2154 == get_elf_backend_data (obfd)->s->elfclass)
2157 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2158 hdr_size = bfd_get_compression_header_size (ibfd, isec);
2162 /* Adjust the size of the output SHF_COMPRESSED section. */
2163 if (hdr_size == sizeof (Elf32_External_Chdr))
2164 return (size - sizeof (Elf32_External_Chdr)
2165 + sizeof (Elf64_External_Chdr));
2167 return (size - sizeof (Elf64_External_Chdr)
2168 + sizeof (Elf32_External_Chdr));
2173 bfd_convert_section_contents
2176 bfd_boolean bfd_convert_section_contents
2177 (bfd *ibfd, asection *isec, bfd *obfd,
2178 bfd_byte **ptr, bfd_size_type *ptr_size);
2181 Convert the contents, stored in @var{*ptr}, of the section
2182 @var{isec} in input BFD @var{ibfd} to output BFD @var{obfd}
2183 if needed. The original buffer pointed to by @var{*ptr} may
2184 be freed and @var{*ptr} is returned with memory malloc'd by this
2185 function, and the new size written to @var{ptr_size}.
2189 bfd_convert_section_contents (bfd *ibfd, sec_ptr isec, bfd *obfd,
2190 bfd_byte **ptr, bfd_size_type *ptr_size)
2193 bfd_size_type ihdr_size, ohdr_size, size;
2194 Elf_Internal_Chdr chdr;
2195 bfd_boolean use_memmove;
2197 /* Do nothing if input file will be decompressed. */
2198 if ((ibfd->flags & BFD_DECOMPRESS))
2201 /* Do nothing if either input or output aren't ELF. */
2202 if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2203 || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2206 /* Do nothing if ELF classes of input and output are the same. */
2207 if (get_elf_backend_data (ibfd)->s->elfclass
2208 == get_elf_backend_data (obfd)->s->elfclass)
2211 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2212 ihdr_size = bfd_get_compression_header_size (ibfd, isec);
2218 /* Convert the contents of the input SHF_COMPRESSED section to
2219 output. Get the input compression header and the size of the
2220 output compression header. */
2221 if (ihdr_size == sizeof (Elf32_External_Chdr))
2223 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2224 chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2225 chdr.ch_size = bfd_get_32 (ibfd, &echdr->ch_size);
2226 chdr.ch_addralign = bfd_get_32 (ibfd, &echdr->ch_addralign);
2228 ohdr_size = sizeof (Elf64_External_Chdr);
2230 use_memmove = FALSE;
2234 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2235 chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2236 chdr.ch_size = bfd_get_64 (ibfd, &echdr->ch_size);
2237 chdr.ch_addralign = bfd_get_64 (ibfd, &echdr->ch_addralign);
2239 ohdr_size = sizeof (Elf32_External_Chdr);
2243 size = bfd_get_section_size (isec) - ihdr_size + ohdr_size;
2246 contents = (bfd_byte *) bfd_malloc (size);
2247 if (contents == NULL)
2251 /* Write out the output compression header. */
2252 if (ohdr_size == sizeof (Elf32_External_Chdr))
2254 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2255 bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2256 bfd_put_32 (obfd, chdr.ch_size, &echdr->ch_size);
2257 bfd_put_32 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2261 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2262 bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2263 bfd_put_32 (obfd, 0, &echdr->ch_reserved);
2264 bfd_put_64 (obfd, chdr.ch_size, &echdr->ch_size);
2265 bfd_put_64 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2268 /* Copy the compressed contents. */
2270 memmove (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);
2273 memcpy (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);