Rewrite bfd error handler
[external/binutils.git] / bfd / bfd.c
1 /* Generic BFD library interface and support routines.
2    Copyright (C) 1990-2017 Free Software Foundation, Inc.
3    Written by Cygnus Support.
4
5    This file is part of BFD, the Binary File Descriptor library.
6
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.
11
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.
16
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.  */
21
22 /*
23 INODE
24 typedef bfd, Error reporting, BFD front end, BFD front end
25
26 SECTION
27         <<typedef bfd>>
28
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.
32
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.
36
37 CODE_FRAGMENT
38 .
39 .enum bfd_direction
40 .  {
41 .    no_direction = 0,
42 .    read_direction = 1,
43 .    write_direction = 2,
44 .    both_direction = 3
45 .  };
46 .
47 .enum bfd_plugin_format
48 .  {
49 .    bfd_plugin_unknown = 0,
50 .    bfd_plugin_yes = 1,
51 .    bfd_plugin_no = 2
52 .  };
53 .
54 .struct bfd_build_id
55 .  {
56 .    bfd_size_type size;
57 .    bfd_byte data[1];
58 .  };
59 .
60 .struct bfd
61 .{
62 .  {* The filename the application opened the BFD with.  *}
63 .  const char *filename;
64 .
65 .  {* A pointer to the target jump table.  *}
66 .  const struct bfd_target *xvec;
67 .
68 .  {* The IOSTREAM, and corresponding IO vector that provide access
69 .     to the file backing the BFD.  *}
70 .  void *iostream;
71 .  const struct bfd_iovec *iovec;
72 .
73 .  {* The caching routines use these to maintain a
74 .     least-recently-used list of BFDs.  *}
75 .  struct bfd *lru_prev, *lru_next;
76 .
77 .  {* When a file is closed by the caching routines, BFD retains
78 .     state information on the file here...  *}
79 .  ufile_ptr where;
80 .
81 .  {* File modified time, if mtime_set is TRUE.  *}
82 .  long mtime;
83 .
84 .  {* A unique identifier of the BFD  *}
85 .  unsigned int id;
86 .
87 .  {* The format which belongs to the BFD. (object, core, etc.)  *}
88 .  ENUM_BITFIELD (bfd_format) format : 3;
89 .
90 .  {* The direction with which the BFD was opened.  *}
91 .  ENUM_BITFIELD (bfd_direction) direction : 2;
92 .
93 .  {* Format_specific flags.  *}
94 .  flagword flags : 20;
95 .
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).  *}
102 .
103 .#define BFD_NO_FLAGS   0x00
104 .
105 .  {* BFD contains relocation entries.  *}
106 .#define HAS_RELOC      0x01
107 .
108 .  {* BFD is directly executable.  *}
109 .#define EXEC_P         0x02
110 .
111 .  {* BFD has line number information (basically used for F_LNNO in a
112 .     COFF header).  *}
113 .#define HAS_LINENO     0x04
114 .
115 .  {* BFD has debugging information.  *}
116 .#define HAS_DEBUG      0x08
117 .
118 .  {* BFD has symbols.  *}
119 .#define HAS_SYMS       0x10
120 .
121 .  {* BFD has local symbols (basically used for F_LSYMS in a COFF
122 .     header).  *}
123 .#define HAS_LOCALS     0x20
124 .
125 .  {* BFD is a dynamic object.  *}
126 .#define DYNAMIC        0x40
127 .
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
132 .
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
136 .
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
141 .
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
145 .     duplicates.  *}
146 .#define BFD_TRADITIONAL_FORMAT 0x400
147 .
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
150 .     struct.  *}
151 .#define BFD_IN_MEMORY 0x800
152 .
153 .  {* This BFD has been created by the linker and doesn't correspond
154 .     to any input file.  *}
155 .#define BFD_LINKER_CREATED 0x1000
156 .
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
161 .
162 .  {* Compress sections in this BFD.  *}
163 .#define BFD_COMPRESS 0x4000
164 .
165 .  {* Decompress sections in this BFD.  *}
166 .#define BFD_DECOMPRESS 0x8000
167 .
168 .  {* BFD is a dummy, for plugins.  *}
169 .#define BFD_PLUGIN 0x10000
170 .
171 .  {* Compress sections in this BFD with SHF_COMPRESSED from gABI.  *}
172 .#define BFD_COMPRESS_GABI 0x20000
173 .
174 .  {* Convert ELF common symbol type to STT_COMMON or STT_OBJECT in this
175 .     BFD.  *}
176 .#define BFD_CONVERT_ELF_COMMON 0x40000
177 .
178 .  {* Use the ELF STT_COMMON type in this BFD.  *}
179 .#define BFD_USE_ELF_STT_COMMON 0x80000
180 .
181 .  {* Flags bits to be saved in bfd_preserve_save.  *}
182 .#define BFD_FLAGS_SAVED \
183 .  (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
184 .   | BFD_PLUGIN | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON \
185 .   | BFD_USE_ELF_STT_COMMON)
186 .
187 .  {* Flags bits which are for BFD use only.  *}
188 .#define BFD_FLAGS_FOR_BFD_USE_MASK \
189 .  (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
190 .   | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT \
191 .   | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON)
192 .
193 .  {* Is the file descriptor being cached?  That is, can it be closed as
194 .     needed, and re-opened when accessed later?  *}
195 .  unsigned int cacheable : 1;
196 .
197 .  {* Marks whether there was a default target specified when the
198 .     BFD was opened. This is used to select which matching algorithm
199 .     to use to choose the back end.  *}
200 .  unsigned int target_defaulted : 1;
201 .
202 .  {* ... and here: (``once'' means at least once).  *}
203 .  unsigned int opened_once : 1;
204 .
205 .  {* Set if we have a locally maintained mtime value, rather than
206 .     getting it from the file each time.  *}
207 .  unsigned int mtime_set : 1;
208 .
209 .  {* Flag set if symbols from this BFD should not be exported.  *}
210 .  unsigned int no_export : 1;
211 .
212 .  {* Remember when output has begun, to stop strange things
213 .     from happening.  *}
214 .  unsigned int output_has_begun : 1;
215 .
216 .  {* Have archive map.  *}
217 .  unsigned int has_armap : 1;
218 .
219 .  {* Set if this is a thin archive.  *}
220 .  unsigned int is_thin_archive : 1;
221 .
222 .  {* Set if only required symbols should be added in the link hash table for
223 .     this object.  Used by VMS linkers.  *}
224 .  unsigned int selective_search : 1;
225 .
226 .  {* Set if this is the linker output BFD.  *}
227 .  unsigned int is_linker_output : 1;
228 .
229 .  {* Set if this is the linker input BFD.  *}
230 .  unsigned int is_linker_input : 1;
231 .
232 .  {* If this is an input for a compiler plug-in library.  *}
233 .  ENUM_BITFIELD (bfd_plugin_format) plugin_format : 2;
234 .
235 .  {* Set if this is a plugin output file.  *}
236 .  unsigned int lto_output : 1;
237 .
238 .  {* Set to dummy BFD created when claimed by a compiler plug-in
239 .     library.  *}
240 .  bfd *plugin_dummy_bfd;
241 .
242 .  {* Currently my_archive is tested before adding origin to
243 .     anything. I believe that this can become always an add of
244 .     origin, with origin set to 0 for non archive files.  *}
245 .  ufile_ptr origin;
246 .
247 .  {* The origin in the archive of the proxy entry.  This will
248 .     normally be the same as origin, except for thin archives,
249 .     when it will contain the current offset of the proxy in the
250 .     thin archive rather than the offset of the bfd in its actual
251 .     container.  *}
252 .  ufile_ptr proxy_origin;
253 .
254 .  {* A hash table for section names.  *}
255 .  struct bfd_hash_table section_htab;
256 .
257 .  {* Pointer to linked list of sections.  *}
258 .  struct bfd_section *sections;
259 .
260 .  {* The last section on the section list.  *}
261 .  struct bfd_section *section_last;
262 .
263 .  {* The number of sections.  *}
264 .  unsigned int section_count;
265 .
266 .  {* A field used by _bfd_generic_link_add_archive_symbols.  This will
267 .     be used only for archive elements.  *}
268 .  int archive_pass;
269 .
270 .  {* Stuff only useful for object files:
271 .     The start address.  *}
272 .  bfd_vma start_address;
273 .
274 .  {* Symbol table for output BFD (with symcount entries).
275 .     Also used by the linker to cache input BFD symbols.  *}
276 .  struct bfd_symbol  **outsymbols;
277 .
278 .  {* Used for input and output.  *}
279 .  unsigned int symcount;
280 .
281 .  {* Used for slurped dynamic symbol tables.  *}
282 .  unsigned int dynsymcount;
283 .
284 .  {* Pointer to structure which contains architecture information.  *}
285 .  const struct bfd_arch_info *arch_info;
286 .
287 .  {* Stuff only useful for archives.  *}
288 .  void *arelt_data;
289 .  struct bfd *my_archive;      {* The containing archive BFD.  *}
290 .  struct bfd *archive_next;    {* The next BFD in the archive.  *}
291 .  struct bfd *archive_head;    {* The first BFD in the archive.  *}
292 .  struct bfd *nested_archives; {* List of nested archive in a flattened
293 .                                  thin archive.  *}
294 .
295 .  union {
296 .    {* For input BFDs, a chain of BFDs involved in a link.  *}
297 .    struct bfd *next;
298 .    {* For output BFD, the linker hash table.  *}
299 .    struct bfd_link_hash_table *hash;
300 .  } link;
301 .
302 .  {* Used by the back end to hold private data.  *}
303 .  union
304 .    {
305 .      struct aout_data_struct *aout_data;
306 .      struct artdata *aout_ar_data;
307 .      struct _oasys_data *oasys_obj_data;
308 .      struct _oasys_ar_data *oasys_ar_data;
309 .      struct coff_tdata *coff_obj_data;
310 .      struct pe_tdata *pe_obj_data;
311 .      struct xcoff_tdata *xcoff_obj_data;
312 .      struct ecoff_tdata *ecoff_obj_data;
313 .      struct ieee_data_struct *ieee_data;
314 .      struct ieee_ar_data_struct *ieee_ar_data;
315 .      struct srec_data_struct *srec_data;
316 .      struct verilog_data_struct *verilog_data;
317 .      struct ihex_data_struct *ihex_data;
318 .      struct tekhex_data_struct *tekhex_data;
319 .      struct elf_obj_tdata *elf_obj_data;
320 .      struct nlm_obj_tdata *nlm_obj_data;
321 .      struct bout_data_struct *bout_data;
322 .      struct mmo_data_struct *mmo_data;
323 .      struct sun_core_struct *sun_core_data;
324 .      struct sco5_core_struct *sco5_core_data;
325 .      struct trad_core_struct *trad_core_data;
326 .      struct som_data_struct *som_data;
327 .      struct hpux_core_struct *hpux_core_data;
328 .      struct hppabsd_core_struct *hppabsd_core_data;
329 .      struct sgi_core_struct *sgi_core_data;
330 .      struct lynx_core_struct *lynx_core_data;
331 .      struct osf_core_struct *osf_core_data;
332 .      struct cisco_core_struct *cisco_core_data;
333 .      struct versados_data_struct *versados_data;
334 .      struct netbsd_core_struct *netbsd_core_data;
335 .      struct mach_o_data_struct *mach_o_data;
336 .      struct mach_o_fat_data_struct *mach_o_fat_data;
337 .      struct plugin_data_struct *plugin_data;
338 .      struct bfd_pef_data_struct *pef_data;
339 .      struct bfd_pef_xlib_data_struct *pef_xlib_data;
340 .      struct bfd_sym_data_struct *sym_data;
341 .      void *any;
342 .    }
343 .  tdata;
344 .
345 .  {* Used by the application to hold private data.  *}
346 .  void *usrdata;
347 .
348 .  {* Where all the allocated stuff under this BFD goes.  This is a
349 .     struct objalloc *, but we use void * to avoid requiring the inclusion
350 .     of objalloc.h.  *}
351 .  void *memory;
352 .
353 .  {* For input BFDs, the build ID, if the object has one. *}
354 .  const struct bfd_build_id *build_id;
355 .};
356 .
357 .{* See note beside bfd_set_section_userdata.  *}
358 .static inline bfd_boolean
359 .bfd_set_cacheable (bfd * abfd, bfd_boolean val)
360 .{
361 .  abfd->cacheable = val;
362 .  return TRUE;
363 .}
364 .
365 */
366
367 #include "sysdep.h"
368 #include <stdarg.h>
369 #include "bfd.h"
370 #include "bfdver.h"
371 #include "libiberty.h"
372 #include "demangle.h"
373 #include "safe-ctype.h"
374 #include "bfdlink.h"
375 #include "libbfd.h"
376 #include "coff/internal.h"
377 #include "coff/sym.h"
378 #include "libcoff.h"
379 #include "libecoff.h"
380 #undef obj_symbols
381 #include "elf-bfd.h"
382
383 #ifndef EXIT_FAILURE
384 #define EXIT_FAILURE 1
385 #endif
386
387 \f
388 /* provide storage for subsystem, stack and heap data which may have been
389    passed in on the command line.  Ld puts this data into a bfd_link_info
390    struct which ultimately gets passed in to the bfd.  When it arrives, copy
391    it to the following struct so that the data will be available in coffcode.h
392    where it is needed.  The typedef's used are defined in bfd.h */
393 \f
394 /*
395 INODE
396 Error reporting, Miscellaneous, typedef bfd, BFD front end
397
398 SECTION
399         Error reporting
400
401         Most BFD functions return nonzero on success (check their
402         individual documentation for precise semantics).  On an error,
403         they call <<bfd_set_error>> to set an error condition that callers
404         can check by calling <<bfd_get_error>>.
405         If that returns <<bfd_error_system_call>>, then check
406         <<errno>>.
407
408         The easiest way to report a BFD error to the user is to
409         use <<bfd_perror>>.
410
411 SUBSECTION
412         Type <<bfd_error_type>>
413
414         The values returned by <<bfd_get_error>> are defined by the
415         enumerated type <<bfd_error_type>>.
416
417 CODE_FRAGMENT
418 .
419 .typedef enum bfd_error
420 .{
421 .  bfd_error_no_error = 0,
422 .  bfd_error_system_call,
423 .  bfd_error_invalid_target,
424 .  bfd_error_wrong_format,
425 .  bfd_error_wrong_object_format,
426 .  bfd_error_invalid_operation,
427 .  bfd_error_no_memory,
428 .  bfd_error_no_symbols,
429 .  bfd_error_no_armap,
430 .  bfd_error_no_more_archived_files,
431 .  bfd_error_malformed_archive,
432 .  bfd_error_missing_dso,
433 .  bfd_error_file_not_recognized,
434 .  bfd_error_file_ambiguously_recognized,
435 .  bfd_error_no_contents,
436 .  bfd_error_nonrepresentable_section,
437 .  bfd_error_no_debug_section,
438 .  bfd_error_bad_value,
439 .  bfd_error_file_truncated,
440 .  bfd_error_file_too_big,
441 .  bfd_error_on_input,
442 .  bfd_error_invalid_error_code
443 .}
444 .bfd_error_type;
445 .
446 */
447
448 static bfd_error_type bfd_error = bfd_error_no_error;
449 static bfd *input_bfd = NULL;
450 static bfd_error_type input_error = bfd_error_no_error;
451
452 const char *const bfd_errmsgs[] =
453 {
454   N_("No error"),
455   N_("System call error"),
456   N_("Invalid bfd target"),
457   N_("File in wrong format"),
458   N_("Archive object file in wrong format"),
459   N_("Invalid operation"),
460   N_("Memory exhausted"),
461   N_("No symbols"),
462   N_("Archive has no index; run ranlib to add one"),
463   N_("No more archived files"),
464   N_("Malformed archive"),
465   N_("DSO missing from command line"),
466   N_("File format not recognized"),
467   N_("File format is ambiguous"),
468   N_("Section has no contents"),
469   N_("Nonrepresentable section on output"),
470   N_("Symbol needs debug section which does not exist"),
471   N_("Bad value"),
472   N_("File truncated"),
473   N_("File too big"),
474   N_("Error reading %s: %s"),
475   N_("#<Invalid error code>")
476 };
477
478 /*
479 FUNCTION
480         bfd_get_error
481
482 SYNOPSIS
483         bfd_error_type bfd_get_error (void);
484
485 DESCRIPTION
486         Return the current BFD error condition.
487 */
488
489 bfd_error_type
490 bfd_get_error (void)
491 {
492   return bfd_error;
493 }
494
495 /*
496 FUNCTION
497         bfd_set_error
498
499 SYNOPSIS
500         void bfd_set_error (bfd_error_type error_tag, ...);
501
502 DESCRIPTION
503         Set the BFD error condition to be @var{error_tag}.
504         If @var{error_tag} is bfd_error_on_input, then this function
505         takes two more parameters, the input bfd where the error
506         occurred, and the bfd_error_type error.
507 */
508
509 void
510 bfd_set_error (bfd_error_type error_tag, ...)
511 {
512   bfd_error = error_tag;
513   if (error_tag == bfd_error_on_input)
514     {
515       /* This is an error that occurred during bfd_close when
516          writing an archive, but on one of the input files.  */
517       va_list ap;
518
519       va_start (ap, error_tag);
520       input_bfd = va_arg (ap, bfd *);
521       input_error = (bfd_error_type) va_arg (ap, int);
522       if (input_error >= bfd_error_on_input)
523         abort ();
524       va_end (ap);
525     }
526 }
527
528 /*
529 FUNCTION
530         bfd_errmsg
531
532 SYNOPSIS
533         const char *bfd_errmsg (bfd_error_type error_tag);
534
535 DESCRIPTION
536         Return a string describing the error @var{error_tag}, or
537         the system error if @var{error_tag} is <<bfd_error_system_call>>.
538 */
539
540 const char *
541 bfd_errmsg (bfd_error_type error_tag)
542 {
543 #ifndef errno
544   extern int errno;
545 #endif
546   if (error_tag == bfd_error_on_input)
547     {
548       char *buf;
549       const char *msg = bfd_errmsg (input_error);
550
551       if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
552           != -1)
553         return buf;
554
555       /* Ick, what to do on out of memory?  */
556       return msg;
557     }
558
559   if (error_tag == bfd_error_system_call)
560     return xstrerror (errno);
561
562   if (error_tag > bfd_error_invalid_error_code)
563     error_tag = bfd_error_invalid_error_code;   /* sanity check */
564
565   return _(bfd_errmsgs [error_tag]);
566 }
567
568 /*
569 FUNCTION
570         bfd_perror
571
572 SYNOPSIS
573         void bfd_perror (const char *message);
574
575 DESCRIPTION
576         Print to the standard error stream a string describing the
577         last BFD error that occurred, or the last system error if
578         the last BFD error was a system call failure.  If @var{message}
579         is non-NULL and non-empty, the error string printed is preceded
580         by @var{message}, a colon, and a space.  It is followed by a newline.
581 */
582
583 void
584 bfd_perror (const char *message)
585 {
586   fflush (stdout);
587   if (message == NULL || *message == '\0')
588     fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
589   else
590     fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
591   fflush (stderr);
592 }
593
594 /*
595 SUBSECTION
596         BFD error handler
597
598         Some BFD functions want to print messages describing the
599         problem.  They call a BFD error handler function.  This
600         function may be overridden by the program.
601
602         The BFD error handler acts like vprintf.
603
604 CODE_FRAGMENT
605 .
606 .typedef void (*bfd_error_handler_type) (const char *, va_list);
607 .
608 */
609
610 /* The program name used when printing BFD error messages.  */
611
612 static const char *_bfd_error_program_name;
613
614 /* This macro and _doprnt taken from libiberty _doprnt.c, tidied a
615    little and extended to handle '%A' and '%B'.  */
616
617 #define PRINT_TYPE(TYPE) \
618   do                                                            \
619     {                                                           \
620       TYPE value = va_arg (ap, TYPE);                           \
621       result = fprintf (stream, specifier, value);              \
622     } while (0)
623
624 static int
625 _doprnt (FILE *stream, const char *format, va_list ap)
626 {
627   const char *ptr = format;
628   char specifier[128];
629   int total_printed = 0;
630
631   while (*ptr != '\0')
632     {
633       int result;
634
635       if (*ptr != '%')
636         {
637           /* While we have regular characters, print them.  */
638           char *end = strchr (ptr, '%');
639           if (end != NULL)
640             result = fprintf (stream, "%.*s", (int) (end - ptr), ptr);
641           else
642             result = fprintf (stream, "%s", ptr);
643           ptr += result;
644         }
645       else
646         {
647           /* We have a format specifier!  */
648           char *sptr = specifier;
649           int wide_width = 0, short_width = 0;
650
651           /* Copy the % and move forward.  */
652           *sptr++ = *ptr++;
653
654           /* Move past flags.  */
655           while (strchr ("-+ #0", *ptr))
656             *sptr++ = *ptr++;
657
658           if (*ptr == '*')
659             {
660               int value = abs (va_arg (ap, int));
661               sptr += sprintf (sptr, "%d", value);
662               ptr++;
663             }
664           else
665             /* Handle explicit numeric value.  */
666             while (ISDIGIT (*ptr))
667               *sptr++ = *ptr++;
668
669           if (*ptr == '.')
670             {
671               /* Copy and go past the period.  */
672               *sptr++ = *ptr++;
673               if (*ptr == '*')
674                 {
675                   int value = abs (va_arg (ap, int));
676                   sptr += sprintf (sptr, "%d", value);
677                   ptr++;
678                 }
679               else
680                 /* Handle explicit numeric value.  */
681                 while (ISDIGIT (*ptr))
682                   *sptr++ = *ptr++;
683             }
684           while (strchr ("hlL", *ptr))
685             {
686               switch (*ptr)
687                 {
688                 case 'h':
689                   short_width = 1;
690                   break;
691                 case 'l':
692                   wide_width++;
693                   break;
694                 case 'L':
695                   wide_width = 2;
696                   break;
697                 default:
698                   abort();
699                 }
700               *sptr++ = *ptr++;
701             }
702
703           /* Copy the type specifier, and NULL terminate.  */
704           *sptr++ = *ptr++;
705           *sptr = '\0';
706
707           switch (ptr[-1])
708             {
709             case 'd':
710             case 'i':
711             case 'o':
712             case 'u':
713             case 'x':
714             case 'X':
715             case 'c':
716               {
717                 /* Short values are promoted to int, so just copy it
718                    as an int and trust the C library printf to cast it
719                    to the right width.  */
720                 if (short_width)
721                   PRINT_TYPE (int);
722                 else
723                   {
724                     switch (wide_width)
725                       {
726                       case 0:
727                         PRINT_TYPE (int);
728                         break;
729                       case 1:
730                         PRINT_TYPE (long);
731                         break;
732                       case 2:
733                       default:
734 #if defined(__GNUC__) || defined(HAVE_LONG_LONG)
735                         PRINT_TYPE (long long);
736 #else
737                         /* Fake it and hope for the best.  */
738                         PRINT_TYPE (long);
739 #endif
740                         break;
741                       }
742                   }
743               }
744               break;
745             case 'f':
746             case 'e':
747             case 'E':
748             case 'g':
749             case 'G':
750               {
751                 if (wide_width == 0)
752                   PRINT_TYPE (double);
753                 else
754                   {
755 #if defined(__GNUC__) || defined(HAVE_LONG_DOUBLE)
756                     PRINT_TYPE (long double);
757 #else
758                     /* Fake it and hope for the best.  */
759                     PRINT_TYPE (double);
760 #endif
761                   }
762               }
763               break;
764             case 's':
765               PRINT_TYPE (char *);
766               break;
767             case 'p':
768               PRINT_TYPE (void *);
769               break;
770             case '%':
771               fputc ('%', stream);
772               result = 1;
773               break;
774             case 'A':
775               {
776                 asection *sec = va_arg (ap, asection *);
777                 bfd *abfd;
778                 const char *group = NULL;
779                 struct coff_comdat_info *ci;
780
781                 if (sec == NULL)
782                   /* Invoking %A with a null section pointer is an
783                      internal error.  */
784                   abort ();
785                 abfd = sec->owner;
786                 if (abfd != NULL
787                     && bfd_get_flavour (abfd) == bfd_target_elf_flavour
788                     && elf_next_in_group (sec) != NULL
789                     && (sec->flags & SEC_GROUP) == 0)
790                   group = elf_group_name (sec);
791                 else if (abfd != NULL
792                          && bfd_get_flavour (abfd) == bfd_target_coff_flavour
793                          && (ci = bfd_coff_get_comdat_section (sec->owner,
794                                                                sec)) != NULL)
795                   group = ci->name;
796                 if (group != NULL)
797                   result = fprintf (stream, "%s[%s]", sec->name, group);
798                 else
799                   result = fprintf (stream, "%s", sec->name);
800               }
801               break;
802             case 'B':
803               {
804                 bfd *abfd = va_arg (ap, bfd *);
805
806                 if (abfd == NULL)
807                   /* Invoking %B with a null bfd pointer is an
808                      internal error.  */
809                   abort ();
810                 else if (abfd->my_archive
811                          && !bfd_is_thin_archive (abfd->my_archive))
812                   result = fprintf (stream, "%s(%s)",
813                                     abfd->my_archive->filename, abfd->filename);
814                 else
815                   result = fprintf (stream, "%s", abfd->filename);
816               }
817               break;
818             default:
819               abort();
820             }
821         }
822       if (result == -1)
823         return -1;
824       total_printed += result;
825     }
826
827   return total_printed;
828 }
829
830 /* This is the default routine to handle BFD error messages.
831    Like fprintf (stderr, ...), but also handles some extra format specifiers.
832
833    %A section name from section.  For group components, print group name too.
834    %B file name from bfd.  For archive components, prints archive too.  */
835
836 static void
837 error_handler_internal (const char *fmt, va_list ap)
838 {
839   /* PR 4992: Don't interrupt output being sent to stdout.  */
840   fflush (stdout);
841
842   if (_bfd_error_program_name != NULL)
843     fprintf (stderr, "%s: ", _bfd_error_program_name);
844   else
845     fprintf (stderr, "BFD: ");
846
847   _doprnt (stderr, fmt, ap);
848
849   /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
850      warning, so use the fputc function to avoid it.  */
851   fputc ('\n', stderr);
852   fflush (stderr);
853 }
854
855 /* This is a function pointer to the routine which should handle BFD
856    error messages.  It is called when a BFD routine encounters an
857    error for which it wants to print a message.  Going through a
858    function pointer permits a program linked against BFD to intercept
859    the messages and deal with them itself.  */
860
861 static bfd_error_handler_type _bfd_error_internal = error_handler_internal;
862
863 void
864 _bfd_error_handler (const char *fmt, ...)
865 {
866   va_list ap;
867
868   va_start (ap, fmt);
869   _bfd_error_internal (fmt, ap);
870   va_end (ap);
871 }
872
873 /*
874 FUNCTION
875         bfd_set_error_handler
876
877 SYNOPSIS
878         bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
879
880 DESCRIPTION
881         Set the BFD error handler function.  Returns the previous
882         function.
883 */
884
885 bfd_error_handler_type
886 bfd_set_error_handler (bfd_error_handler_type pnew)
887 {
888   bfd_error_handler_type pold;
889
890   pold = _bfd_error_internal;
891   _bfd_error_internal = pnew;
892   return pold;
893 }
894
895 /*
896 FUNCTION
897         bfd_set_error_program_name
898
899 SYNOPSIS
900         void bfd_set_error_program_name (const char *);
901
902 DESCRIPTION
903         Set the program name to use when printing a BFD error.  This
904         is printed before the error message followed by a colon and
905         space.  The string must not be changed after it is passed to
906         this function.
907 */
908
909 void
910 bfd_set_error_program_name (const char *name)
911 {
912   _bfd_error_program_name = name;
913 }
914
915 /*
916 SUBSECTION
917         BFD assert handler
918
919         If BFD finds an internal inconsistency, the bfd assert
920         handler is called with information on the BFD version, BFD
921         source file and line.  If this happens, most programs linked
922         against BFD are expected to want to exit with an error, or mark
923         the current BFD operation as failed, so it is recommended to
924         override the default handler, which just calls
925         _bfd_error_handler and continues.
926
927 CODE_FRAGMENT
928 .
929 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
930 .                                         const char *bfd_version,
931 .                                         const char *bfd_file,
932 .                                         int bfd_line);
933 .
934 */
935
936 /* Note the use of bfd_ prefix on the parameter names above: we want to
937    show which one is the message and which is the version by naming the
938    parameters, but avoid polluting the program-using-bfd namespace as
939    the typedef is visible in the exported headers that the program
940    includes.  Below, it's just for consistency.  */
941
942 static void
943 _bfd_default_assert_handler (const char *bfd_formatmsg,
944                              const char *bfd_version,
945                              const char *bfd_file,
946                              int bfd_line)
947
948 {
949   _bfd_error_handler (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
950 }
951
952 /* Similar to _bfd_error_handler, a program can decide to exit on an
953    internal BFD error.  We use a non-variadic type to simplify passing
954    on parameters to other functions, e.g. _bfd_error_handler.  */
955
956 static bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
957
958 /*
959 FUNCTION
960         bfd_set_assert_handler
961
962 SYNOPSIS
963         bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
964
965 DESCRIPTION
966         Set the BFD assert handler function.  Returns the previous
967         function.
968 */
969
970 bfd_assert_handler_type
971 bfd_set_assert_handler (bfd_assert_handler_type pnew)
972 {
973   bfd_assert_handler_type pold;
974
975   pold = _bfd_assert_handler;
976   _bfd_assert_handler = pnew;
977   return pold;
978 }
979 \f
980 /*
981 INODE
982 Miscellaneous, Memory Usage, Error reporting, BFD front end
983
984 SECTION
985         Miscellaneous
986
987 SUBSECTION
988         Miscellaneous functions
989 */
990
991 /*
992 FUNCTION
993         bfd_get_reloc_upper_bound
994
995 SYNOPSIS
996         long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
997
998 DESCRIPTION
999         Return the number of bytes required to store the
1000         relocation information associated with section @var{sect}
1001         attached to bfd @var{abfd}.  If an error occurs, return -1.
1002
1003 */
1004
1005 long
1006 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
1007 {
1008   if (abfd->format != bfd_object)
1009     {
1010       bfd_set_error (bfd_error_invalid_operation);
1011       return -1;
1012     }
1013
1014   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
1015 }
1016
1017 /*
1018 FUNCTION
1019         bfd_canonicalize_reloc
1020
1021 SYNOPSIS
1022         long bfd_canonicalize_reloc
1023           (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
1024
1025 DESCRIPTION
1026         Call the back end associated with the open BFD
1027         @var{abfd} and translate the external form of the relocation
1028         information attached to @var{sec} into the internal canonical
1029         form.  Place the table into memory at @var{loc}, which has
1030         been preallocated, usually by a call to
1031         <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
1032         -1 on error.
1033
1034         The @var{syms} table is also needed for horrible internal magic
1035         reasons.
1036
1037 */
1038 long
1039 bfd_canonicalize_reloc (bfd *abfd,
1040                         sec_ptr asect,
1041                         arelent **location,
1042                         asymbol **symbols)
1043 {
1044   if (abfd->format != bfd_object)
1045     {
1046       bfd_set_error (bfd_error_invalid_operation);
1047       return -1;
1048     }
1049
1050   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
1051                    (abfd, asect, location, symbols));
1052 }
1053
1054 /*
1055 FUNCTION
1056         bfd_set_reloc
1057
1058 SYNOPSIS
1059         void bfd_set_reloc
1060           (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
1061
1062 DESCRIPTION
1063         Set the relocation pointer and count within
1064         section @var{sec} to the values @var{rel} and @var{count}.
1065         The argument @var{abfd} is ignored.
1066
1067 */
1068
1069 void
1070 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
1071                sec_ptr asect,
1072                arelent **location,
1073                unsigned int count)
1074 {
1075   asect->orelocation = location;
1076   asect->reloc_count = count;
1077 }
1078
1079 /*
1080 FUNCTION
1081         bfd_set_file_flags
1082
1083 SYNOPSIS
1084         bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
1085
1086 DESCRIPTION
1087         Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1088
1089         Possible errors are:
1090         o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1091         o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1092         o <<bfd_error_invalid_operation>> -
1093         The flag word contained a bit which was not applicable to the
1094         type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
1095         on a BFD format which does not support demand paging.
1096
1097 */
1098
1099 bfd_boolean
1100 bfd_set_file_flags (bfd *abfd, flagword flags)
1101 {
1102   if (abfd->format != bfd_object)
1103     {
1104       bfd_set_error (bfd_error_wrong_format);
1105       return FALSE;
1106     }
1107
1108   if (bfd_read_p (abfd))
1109     {
1110       bfd_set_error (bfd_error_invalid_operation);
1111       return FALSE;
1112     }
1113
1114   bfd_get_file_flags (abfd) = flags;
1115   if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1116     {
1117       bfd_set_error (bfd_error_invalid_operation);
1118       return FALSE;
1119     }
1120
1121   return TRUE;
1122 }
1123
1124 void
1125 bfd_assert (const char *file, int line)
1126 {
1127   /* xgettext:c-format */
1128   (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1129                           BFD_VERSION_STRING, file, line);
1130 }
1131
1132 /* A more or less friendly abort message.  In libbfd.h abort is
1133    defined to call this function.  */
1134
1135 void
1136 _bfd_abort (const char *file, int line, const char *fn)
1137 {
1138   if (fn != NULL)
1139     _bfd_error_handler
1140       /* xgettext:c-format */
1141       (_("BFD %s internal error, aborting at %s:%d in %s\n"),
1142        BFD_VERSION_STRING, file, line, fn);
1143   else
1144     _bfd_error_handler
1145       /* xgettext:c-format */
1146       (_("BFD %s internal error, aborting at %s:%d\n"),
1147        BFD_VERSION_STRING, file, line);
1148   _bfd_error_handler (_("Please report this bug.\n"));
1149   _exit (EXIT_FAILURE);
1150 }
1151
1152 /*
1153 FUNCTION
1154         bfd_get_arch_size
1155
1156 SYNOPSIS
1157         int bfd_get_arch_size (bfd *abfd);
1158
1159 DESCRIPTION
1160         Returns the normalized architecture address size, in bits, as
1161         determined by the object file's format.  By normalized, we mean
1162         either 32 or 64.  For ELF, this information is included in the
1163         header.  Use bfd_arch_bits_per_address for number of bits in
1164         the architecture address.
1165
1166 RETURNS
1167         Returns the arch size in bits if known, <<-1>> otherwise.
1168 */
1169
1170 int
1171 bfd_get_arch_size (bfd *abfd)
1172 {
1173   if (abfd->xvec->flavour == bfd_target_elf_flavour)
1174     return get_elf_backend_data (abfd)->s->arch_size;
1175
1176   return bfd_arch_bits_per_address (abfd) > 32 ? 64 : 32;
1177 }
1178
1179 /*
1180 FUNCTION
1181         bfd_get_sign_extend_vma
1182
1183 SYNOPSIS
1184         int bfd_get_sign_extend_vma (bfd *abfd);
1185
1186 DESCRIPTION
1187         Indicates if the target architecture "naturally" sign extends
1188         an address.  Some architectures implicitly sign extend address
1189         values when they are converted to types larger than the size
1190         of an address.  For instance, bfd_get_start_address() will
1191         return an address sign extended to fill a bfd_vma when this is
1192         the case.
1193
1194 RETURNS
1195         Returns <<1>> if the target architecture is known to sign
1196         extend addresses, <<0>> if the target architecture is known to
1197         not sign extend addresses, and <<-1>> otherwise.
1198 */
1199
1200 int
1201 bfd_get_sign_extend_vma (bfd *abfd)
1202 {
1203   char *name;
1204
1205   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1206     return get_elf_backend_data (abfd)->sign_extend_vma;
1207
1208   name = bfd_get_target (abfd);
1209
1210   /* Return a proper value for DJGPP & PE COFF.
1211      This function is required for DWARF2 support, but there is
1212      no place to store this information in the COFF back end.
1213      Should enough other COFF targets add support for DWARF2,
1214      a place will have to be found.  Until then, this hack will do.  */
1215   if (CONST_STRNEQ (name, "coff-go32")
1216       || strcmp (name, "pe-i386") == 0
1217       || strcmp (name, "pei-i386") == 0
1218       || strcmp (name, "pe-x86-64") == 0
1219       || strcmp (name, "pei-x86-64") == 0
1220       || strcmp (name, "pe-arm-wince-little") == 0
1221       || strcmp (name, "pei-arm-wince-little") == 0
1222       || strcmp (name, "aixcoff-rs6000") == 0)
1223     return 1;
1224
1225   if (CONST_STRNEQ (name, "mach-o"))
1226     return 0;
1227
1228   bfd_set_error (bfd_error_wrong_format);
1229   return -1;
1230 }
1231
1232 /*
1233 FUNCTION
1234         bfd_set_start_address
1235
1236 SYNOPSIS
1237         bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1238
1239 DESCRIPTION
1240         Make @var{vma} the entry point of output BFD @var{abfd}.
1241
1242 RETURNS
1243         Returns <<TRUE>> on success, <<FALSE>> otherwise.
1244 */
1245
1246 bfd_boolean
1247 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1248 {
1249   abfd->start_address = vma;
1250   return TRUE;
1251 }
1252
1253 /*
1254 FUNCTION
1255         bfd_get_gp_size
1256
1257 SYNOPSIS
1258         unsigned int bfd_get_gp_size (bfd *abfd);
1259
1260 DESCRIPTION
1261         Return the maximum size of objects to be optimized using the GP
1262         register under MIPS ECOFF.  This is typically set by the <<-G>>
1263         argument to the compiler, assembler or linker.
1264 */
1265
1266 unsigned int
1267 bfd_get_gp_size (bfd *abfd)
1268 {
1269   if (abfd->format == bfd_object)
1270     {
1271       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1272         return ecoff_data (abfd)->gp_size;
1273       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1274         return elf_gp_size (abfd);
1275     }
1276   return 0;
1277 }
1278
1279 /*
1280 FUNCTION
1281         bfd_set_gp_size
1282
1283 SYNOPSIS
1284         void bfd_set_gp_size (bfd *abfd, unsigned int i);
1285
1286 DESCRIPTION
1287         Set the maximum size of objects to be optimized using the GP
1288         register under ECOFF or MIPS ELF.  This is typically set by
1289         the <<-G>> argument to the compiler, assembler or linker.
1290 */
1291
1292 void
1293 bfd_set_gp_size (bfd *abfd, unsigned int i)
1294 {
1295   /* Don't try to set GP size on an archive or core file!  */
1296   if (abfd->format != bfd_object)
1297     return;
1298
1299   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1300     ecoff_data (abfd)->gp_size = i;
1301   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1302     elf_gp_size (abfd) = i;
1303 }
1304
1305 /* Get the GP value.  This is an internal function used by some of the
1306    relocation special_function routines on targets which support a GP
1307    register.  */
1308
1309 bfd_vma
1310 _bfd_get_gp_value (bfd *abfd)
1311 {
1312   if (! abfd)
1313     return 0;
1314   if (abfd->format != bfd_object)
1315     return 0;
1316
1317   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1318     return ecoff_data (abfd)->gp;
1319   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1320     return elf_gp (abfd);
1321
1322   return 0;
1323 }
1324
1325 /* Set the GP value.  */
1326
1327 void
1328 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1329 {
1330   if (! abfd)
1331     abort ();
1332   if (abfd->format != bfd_object)
1333     return;
1334
1335   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1336     ecoff_data (abfd)->gp = v;
1337   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1338     elf_gp (abfd) = v;
1339 }
1340
1341 /*
1342 FUNCTION
1343         bfd_scan_vma
1344
1345 SYNOPSIS
1346         bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1347
1348 DESCRIPTION
1349         Convert, like <<strtoul>>, a numerical expression
1350         @var{string} into a <<bfd_vma>> integer, and return that integer.
1351         (Though without as many bells and whistles as <<strtoul>>.)
1352         The expression is assumed to be unsigned (i.e., positive).
1353         If given a @var{base}, it is used as the base for conversion.
1354         A base of 0 causes the function to interpret the string
1355         in hex if a leading "0x" or "0X" is found, otherwise
1356         in octal if a leading zero is found, otherwise in decimal.
1357
1358         If the value would overflow, the maximum <<bfd_vma>> value is
1359         returned.
1360 */
1361
1362 bfd_vma
1363 bfd_scan_vma (const char *string, const char **end, int base)
1364 {
1365   bfd_vma value;
1366   bfd_vma cutoff;
1367   unsigned int cutlim;
1368   int overflow;
1369
1370   /* Let the host do it if possible.  */
1371   if (sizeof (bfd_vma) <= sizeof (unsigned long))
1372     return strtoul (string, (char **) end, base);
1373
1374 #ifdef HAVE_STRTOULL
1375   if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1376     return strtoull (string, (char **) end, base);
1377 #endif
1378
1379   if (base == 0)
1380     {
1381       if (string[0] == '0')
1382         {
1383           if ((string[1] == 'x') || (string[1] == 'X'))
1384             base = 16;
1385           else
1386             base = 8;
1387         }
1388     }
1389
1390   if ((base < 2) || (base > 36))
1391     base = 10;
1392
1393   if (base == 16
1394       && string[0] == '0'
1395       && (string[1] == 'x' || string[1] == 'X')
1396       && ISXDIGIT (string[2]))
1397     {
1398       string += 2;
1399     }
1400
1401   cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1402   cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1403   value = 0;
1404   overflow = 0;
1405   while (1)
1406     {
1407       unsigned int digit;
1408
1409       digit = *string;
1410       if (ISDIGIT (digit))
1411         digit = digit - '0';
1412       else if (ISALPHA (digit))
1413         digit = TOUPPER (digit) - 'A' + 10;
1414       else
1415         break;
1416       if (digit >= (unsigned int) base)
1417         break;
1418       if (value > cutoff || (value == cutoff && digit > cutlim))
1419         overflow = 1;
1420       value = value * base + digit;
1421       ++string;
1422     }
1423
1424   if (overflow)
1425     value = ~ (bfd_vma) 0;
1426
1427   if (end != NULL)
1428     *end = string;
1429
1430   return value;
1431 }
1432
1433 /*
1434 FUNCTION
1435         bfd_copy_private_header_data
1436
1437 SYNOPSIS
1438         bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1439
1440 DESCRIPTION
1441         Copy private BFD header information from the BFD @var{ibfd} to the
1442         the BFD @var{obfd}.  This copies information that may require
1443         sections to exist, but does not require symbol tables.  Return
1444         <<true>> on success, <<false>> on error.
1445         Possible error returns are:
1446
1447         o <<bfd_error_no_memory>> -
1448         Not enough memory exists to create private data for @var{obfd}.
1449
1450 .#define bfd_copy_private_header_data(ibfd, obfd) \
1451 .     BFD_SEND (obfd, _bfd_copy_private_header_data, \
1452 .               (ibfd, obfd))
1453
1454 */
1455
1456 /*
1457 FUNCTION
1458         bfd_copy_private_bfd_data
1459
1460 SYNOPSIS
1461         bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1462
1463 DESCRIPTION
1464         Copy private BFD information from the BFD @var{ibfd} to the
1465         the BFD @var{obfd}.  Return <<TRUE>> on success, <<FALSE>> on error.
1466         Possible error returns are:
1467
1468         o <<bfd_error_no_memory>> -
1469         Not enough memory exists to create private data for @var{obfd}.
1470
1471 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1472 .     BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1473 .               (ibfd, obfd))
1474
1475 */
1476
1477 /*
1478 FUNCTION
1479         bfd_set_private_flags
1480
1481 SYNOPSIS
1482         bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1483
1484 DESCRIPTION
1485         Set private BFD flag information in the BFD @var{abfd}.
1486         Return <<TRUE>> on success, <<FALSE>> on error.  Possible error
1487         returns are:
1488
1489         o <<bfd_error_no_memory>> -
1490         Not enough memory exists to create private data for @var{obfd}.
1491
1492 .#define bfd_set_private_flags(abfd, flags) \
1493 .     BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1494
1495 */
1496
1497 /*
1498 FUNCTION
1499         Other functions
1500
1501 DESCRIPTION
1502         The following functions exist but have not yet been documented.
1503
1504 .#define bfd_sizeof_headers(abfd, info) \
1505 .       BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1506 .
1507 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1508 .       BFD_SEND (abfd, _bfd_find_nearest_line, \
1509 .                 (abfd, syms, sec, off, file, func, line, NULL))
1510 .
1511 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
1512 .                                            line, disc) \
1513 .       BFD_SEND (abfd, _bfd_find_nearest_line, \
1514 .                 (abfd, syms, sec, off, file, func, line, disc))
1515 .
1516 .#define bfd_find_line(abfd, syms, sym, file, line) \
1517 .       BFD_SEND (abfd, _bfd_find_line, \
1518 .                 (abfd, syms, sym, file, line))
1519 .
1520 .#define bfd_find_inliner_info(abfd, file, func, line) \
1521 .       BFD_SEND (abfd, _bfd_find_inliner_info, \
1522 .                 (abfd, file, func, line))
1523 .
1524 .#define bfd_debug_info_start(abfd) \
1525 .       BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1526 .
1527 .#define bfd_debug_info_end(abfd) \
1528 .       BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1529 .
1530 .#define bfd_debug_info_accumulate(abfd, section) \
1531 .       BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1532 .
1533 .#define bfd_stat_arch_elt(abfd, stat) \
1534 .       BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1535 .
1536 .#define bfd_update_armap_timestamp(abfd) \
1537 .       BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1538 .
1539 .#define bfd_set_arch_mach(abfd, arch, mach)\
1540 .       BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1541 .
1542 .#define bfd_relax_section(abfd, section, link_info, again) \
1543 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1544 .
1545 .#define bfd_gc_sections(abfd, link_info) \
1546 .       BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1547 .
1548 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
1549 .       BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
1550 .
1551 .#define bfd_merge_sections(abfd, link_info) \
1552 .       BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1553 .
1554 .#define bfd_is_group_section(abfd, sec) \
1555 .       BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1556 .
1557 .#define bfd_discard_group(abfd, sec) \
1558 .       BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1559 .
1560 .#define bfd_link_hash_table_create(abfd) \
1561 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1562 .
1563 .#define bfd_link_add_symbols(abfd, info) \
1564 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1565 .
1566 .#define bfd_link_just_syms(abfd, sec, info) \
1567 .       BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1568 .
1569 .#define bfd_final_link(abfd, info) \
1570 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1571 .
1572 .#define bfd_free_cached_info(abfd) \
1573 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1574 .
1575 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1576 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1577 .
1578 .#define bfd_print_private_bfd_data(abfd, file)\
1579 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1580 .
1581 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1582 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1583 .
1584 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1585 .       BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1586 .                                                   dyncount, dynsyms, ret))
1587 .
1588 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1589 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1590 .
1591 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1592 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1593 .
1594 .extern bfd_byte *bfd_get_relocated_section_contents
1595 .  (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1596 .   bfd_boolean, asymbol **);
1597 .
1598
1599 */
1600
1601 bfd_byte *
1602 bfd_get_relocated_section_contents (bfd *abfd,
1603                                     struct bfd_link_info *link_info,
1604                                     struct bfd_link_order *link_order,
1605                                     bfd_byte *data,
1606                                     bfd_boolean relocatable,
1607                                     asymbol **symbols)
1608 {
1609   bfd *abfd2;
1610   bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1611                    bfd_byte *, bfd_boolean, asymbol **);
1612
1613   if (link_order->type == bfd_indirect_link_order)
1614     {
1615       abfd2 = link_order->u.indirect.section->owner;
1616       if (abfd2 == NULL)
1617         abfd2 = abfd;
1618     }
1619   else
1620     abfd2 = abfd;
1621
1622   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1623
1624   return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1625 }
1626
1627 /* Record information about an ELF program header.  */
1628
1629 bfd_boolean
1630 bfd_record_phdr (bfd *abfd,
1631                  unsigned long type,
1632                  bfd_boolean flags_valid,
1633                  flagword flags,
1634                  bfd_boolean at_valid,
1635                  bfd_vma at,
1636                  bfd_boolean includes_filehdr,
1637                  bfd_boolean includes_phdrs,
1638                  unsigned int count,
1639                  asection **secs)
1640 {
1641   struct elf_segment_map *m, **pm;
1642   bfd_size_type amt;
1643
1644   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1645     return TRUE;
1646
1647   amt = sizeof (struct elf_segment_map);
1648   amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1649   m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
1650   if (m == NULL)
1651     return FALSE;
1652
1653   m->p_type = type;
1654   m->p_flags = flags;
1655   m->p_paddr = at;
1656   m->p_flags_valid = flags_valid;
1657   m->p_paddr_valid = at_valid;
1658   m->includes_filehdr = includes_filehdr;
1659   m->includes_phdrs = includes_phdrs;
1660   m->count = count;
1661   if (count > 0)
1662     memcpy (m->sections, secs, count * sizeof (asection *));
1663
1664   for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
1665     ;
1666   *pm = m;
1667
1668   return TRUE;
1669 }
1670
1671 #ifdef BFD64
1672 /* Return true iff this target is 32-bit.  */
1673
1674 static bfd_boolean
1675 is32bit (bfd *abfd)
1676 {
1677   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1678     {
1679       const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1680       return bed->s->elfclass == ELFCLASS32;
1681     }
1682
1683   /* For non-ELF targets, use architecture information.  */
1684   return bfd_arch_bits_per_address (abfd) <= 32;
1685 }
1686 #endif
1687
1688 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1689    target's address size.  */
1690
1691 void
1692 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1693 {
1694 #ifdef BFD64
1695   if (is32bit (abfd))
1696     {
1697       sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1698       return;
1699     }
1700 #endif
1701   sprintf_vma (buf, value);
1702 }
1703
1704 void
1705 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1706 {
1707 #ifdef BFD64
1708   if (is32bit (abfd))
1709     {
1710       fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1711       return;
1712     }
1713 #endif
1714   fprintf_vma ((FILE *) stream, value);
1715 }
1716
1717 /*
1718 FUNCTION
1719         bfd_alt_mach_code
1720
1721 SYNOPSIS
1722         bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1723
1724 DESCRIPTION
1725
1726         When more than one machine code number is available for the
1727         same machine type, this function can be used to switch between
1728         the preferred one (alternative == 0) and any others.  Currently,
1729         only ELF supports this feature, with up to two alternate
1730         machine codes.
1731 */
1732
1733 bfd_boolean
1734 bfd_alt_mach_code (bfd *abfd, int alternative)
1735 {
1736   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1737     {
1738       int code;
1739
1740       switch (alternative)
1741         {
1742         case 0:
1743           code = get_elf_backend_data (abfd)->elf_machine_code;
1744           break;
1745
1746         case 1:
1747           code = get_elf_backend_data (abfd)->elf_machine_alt1;
1748           if (code == 0)
1749             return FALSE;
1750           break;
1751
1752         case 2:
1753           code = get_elf_backend_data (abfd)->elf_machine_alt2;
1754           if (code == 0)
1755             return FALSE;
1756           break;
1757
1758         default:
1759           return FALSE;
1760         }
1761
1762       elf_elfheader (abfd)->e_machine = code;
1763
1764       return TRUE;
1765     }
1766
1767   return FALSE;
1768 }
1769
1770 /*
1771 FUNCTION
1772         bfd_emul_get_maxpagesize
1773
1774 SYNOPSIS
1775         bfd_vma bfd_emul_get_maxpagesize (const char *);
1776
1777 DESCRIPTION
1778         Returns the maximum page size, in bytes, as determined by
1779         emulation.
1780
1781 RETURNS
1782         Returns the maximum page size in bytes for ELF, 0 otherwise.
1783 */
1784
1785 bfd_vma
1786 bfd_emul_get_maxpagesize (const char *emul)
1787 {
1788   const bfd_target *target;
1789
1790   target = bfd_find_target (emul, NULL);
1791   if (target != NULL
1792       && target->flavour == bfd_target_elf_flavour)
1793     return xvec_get_elf_backend_data (target)->maxpagesize;
1794
1795   return 0;
1796 }
1797
1798 static void
1799 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1800                       int offset, const bfd_target *orig_target)
1801 {
1802   if (target->flavour == bfd_target_elf_flavour)
1803     {
1804       const struct elf_backend_data *bed;
1805
1806       bed = xvec_get_elf_backend_data (target);
1807       *((bfd_vma *) ((char *) bed + offset)) = size;
1808     }
1809
1810   if (target->alternative_target
1811       && target->alternative_target != orig_target)
1812     bfd_elf_set_pagesize (target->alternative_target, size, offset,
1813                           orig_target);
1814 }
1815
1816 /*
1817 FUNCTION
1818         bfd_emul_set_maxpagesize
1819
1820 SYNOPSIS
1821         void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1822
1823 DESCRIPTION
1824         For ELF, set the maximum page size for the emulation.  It is
1825         a no-op for other formats.
1826
1827 */
1828
1829 void
1830 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1831 {
1832   const bfd_target *target;
1833
1834   target = bfd_find_target (emul, NULL);
1835   if (target)
1836     bfd_elf_set_pagesize (target, size,
1837                           offsetof (struct elf_backend_data,
1838                                     maxpagesize), target);
1839 }
1840
1841 /*
1842 FUNCTION
1843         bfd_emul_get_commonpagesize
1844
1845 SYNOPSIS
1846         bfd_vma bfd_emul_get_commonpagesize (const char *);
1847
1848 DESCRIPTION
1849         Returns the common page size, in bytes, as determined by
1850         emulation.
1851
1852 RETURNS
1853         Returns the common page size in bytes for ELF, 0 otherwise.
1854 */
1855
1856 bfd_vma
1857 bfd_emul_get_commonpagesize (const char *emul)
1858 {
1859   const bfd_target *target;
1860
1861   target = bfd_find_target (emul, NULL);
1862   if (target != NULL
1863       && target->flavour == bfd_target_elf_flavour)
1864     return xvec_get_elf_backend_data (target)->commonpagesize;
1865
1866   return 0;
1867 }
1868
1869 /*
1870 FUNCTION
1871         bfd_emul_set_commonpagesize
1872
1873 SYNOPSIS
1874         void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1875
1876 DESCRIPTION
1877         For ELF, set the common page size for the emulation.  It is
1878         a no-op for other formats.
1879
1880 */
1881
1882 void
1883 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1884 {
1885   const bfd_target *target;
1886
1887   target = bfd_find_target (emul, NULL);
1888   if (target)
1889     bfd_elf_set_pagesize (target, size,
1890                           offsetof (struct elf_backend_data,
1891                                     commonpagesize), target);
1892 }
1893
1894 /*
1895 FUNCTION
1896         bfd_demangle
1897
1898 SYNOPSIS
1899         char *bfd_demangle (bfd *, const char *, int);
1900
1901 DESCRIPTION
1902         Wrapper around cplus_demangle.  Strips leading underscores and
1903         other such chars that would otherwise confuse the demangler.
1904         If passed a g++ v3 ABI mangled name, returns a buffer allocated
1905         with malloc holding the demangled name.  Returns NULL otherwise
1906         and on memory alloc failure.
1907 */
1908
1909 char *
1910 bfd_demangle (bfd *abfd, const char *name, int options)
1911 {
1912   char *res, *alloc;
1913   const char *pre, *suf;
1914   size_t pre_len;
1915   bfd_boolean skip_lead;
1916
1917   skip_lead = (abfd != NULL
1918                && *name != '\0'
1919                && bfd_get_symbol_leading_char (abfd) == *name);
1920   if (skip_lead)
1921     ++name;
1922
1923   /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1924      or the MS PE format.  These formats have a number of leading '.'s
1925      on at least some symbols, so we remove all dots to avoid
1926      confusing the demangler.  */
1927   pre = name;
1928   while (*name == '.' || *name == '$')
1929     ++name;
1930   pre_len = name - pre;
1931
1932   /* Strip off @plt and suchlike too.  */
1933   alloc = NULL;
1934   suf = strchr (name, '@');
1935   if (suf != NULL)
1936     {
1937       alloc = (char *) bfd_malloc (suf - name + 1);
1938       if (alloc == NULL)
1939         return NULL;
1940       memcpy (alloc, name, suf - name);
1941       alloc[suf - name] = '\0';
1942       name = alloc;
1943     }
1944
1945   res = cplus_demangle (name, options);
1946
1947   if (alloc != NULL)
1948     free (alloc);
1949
1950   if (res == NULL)
1951     {
1952       if (skip_lead)
1953         {
1954           size_t len = strlen (pre) + 1;
1955           alloc = (char *) bfd_malloc (len);
1956           if (alloc == NULL)
1957             return NULL;
1958           memcpy (alloc, pre, len);
1959           return alloc;
1960         }
1961       return NULL;
1962     }
1963
1964   /* Put back any prefix or suffix.  */
1965   if (pre_len != 0 || suf != NULL)
1966     {
1967       size_t len;
1968       size_t suf_len;
1969       char *final;
1970
1971       len = strlen (res);
1972       if (suf == NULL)
1973         suf = res + len;
1974       suf_len = strlen (suf) + 1;
1975       final = (char *) bfd_malloc (pre_len + len + suf_len);
1976       if (final != NULL)
1977         {
1978           memcpy (final, pre, pre_len);
1979           memcpy (final + pre_len, res, len);
1980           memcpy (final + pre_len + len, suf, suf_len);
1981         }
1982       free (res);
1983       res = final;
1984     }
1985
1986   return res;
1987 }
1988
1989 /*
1990 FUNCTION
1991         bfd_update_compression_header
1992
1993 SYNOPSIS
1994         void bfd_update_compression_header
1995           (bfd *abfd, bfd_byte *contents, asection *sec);
1996
1997 DESCRIPTION
1998         Set the compression header at CONTENTS of SEC in ABFD and update
1999         elf_section_flags for compression.
2000 */
2001
2002 void
2003 bfd_update_compression_header (bfd *abfd, bfd_byte *contents,
2004                                asection *sec)
2005 {
2006   if ((abfd->flags & BFD_COMPRESS) != 0)
2007     {
2008       if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2009         {
2010           if ((abfd->flags & BFD_COMPRESS_GABI) != 0)
2011             {
2012               const struct elf_backend_data *bed
2013                 = get_elf_backend_data (abfd);
2014
2015               /* Set the SHF_COMPRESSED bit.  */
2016               elf_section_flags (sec) |= SHF_COMPRESSED;
2017
2018               if (bed->s->elfclass == ELFCLASS32)
2019                 {
2020                   Elf32_External_Chdr *echdr
2021                     = (Elf32_External_Chdr *) contents;
2022                   bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2023                   bfd_put_32 (abfd, sec->size, &echdr->ch_size);
2024                   bfd_put_32 (abfd, 1 << sec->alignment_power,
2025                               &echdr->ch_addralign);
2026                 }
2027               else
2028                 {
2029                   Elf64_External_Chdr *echdr
2030                     = (Elf64_External_Chdr *) contents;
2031                   bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2032                   bfd_put_32 (abfd, 0, &echdr->ch_reserved);
2033                   bfd_put_64 (abfd, sec->size, &echdr->ch_size);
2034                   bfd_put_64 (abfd, 1 << sec->alignment_power,
2035                               &echdr->ch_addralign);
2036                 }
2037             }
2038           else
2039             {
2040               /* Clear the SHF_COMPRESSED bit.  */
2041               elf_section_flags (sec) &= ~SHF_COMPRESSED;
2042
2043               /* Write the zlib header.  It should be "ZLIB" followed by
2044                  the uncompressed section size, 8 bytes in big-endian
2045                  order.  */
2046               memcpy (contents, "ZLIB", 4);
2047               bfd_putb64 (sec->size, contents + 4);
2048             }
2049         }
2050     }
2051   else
2052     abort ();
2053 }
2054
2055 /*
2056    FUNCTION
2057    bfd_check_compression_header
2058
2059    SYNOPSIS
2060         bfd_boolean bfd_check_compression_header
2061           (bfd *abfd, bfd_byte *contents, asection *sec,
2062           bfd_size_type *uncompressed_size);
2063
2064 DESCRIPTION
2065         Check the compression header at CONTENTS of SEC in ABFD and
2066         store the uncompressed size in UNCOMPRESSED_SIZE if the
2067         compression header is valid.
2068
2069 RETURNS
2070         Return TRUE if the compression header is valid.
2071 */
2072
2073 bfd_boolean
2074 bfd_check_compression_header (bfd *abfd, bfd_byte *contents,
2075                               asection *sec,
2076                               bfd_size_type *uncompressed_size)
2077 {
2078   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
2079       && (elf_section_flags (sec) & SHF_COMPRESSED) != 0)
2080     {
2081       Elf_Internal_Chdr chdr;
2082       const struct elf_backend_data *bed = get_elf_backend_data (abfd);
2083       if (bed->s->elfclass == ELFCLASS32)
2084         {
2085           Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2086           chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2087           chdr.ch_size = bfd_get_32 (abfd, &echdr->ch_size);
2088           chdr.ch_addralign = bfd_get_32 (abfd, &echdr->ch_addralign);
2089         }
2090       else
2091         {
2092           Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2093           chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2094           chdr.ch_size = bfd_get_64 (abfd, &echdr->ch_size);
2095           chdr.ch_addralign = bfd_get_64 (abfd, &echdr->ch_addralign);
2096         }
2097       if (chdr.ch_type == ELFCOMPRESS_ZLIB
2098           && chdr.ch_addralign == 1U << sec->alignment_power)
2099         {
2100           *uncompressed_size = chdr.ch_size;
2101           return TRUE;
2102         }
2103     }
2104
2105   return FALSE;
2106 }
2107
2108 /*
2109 FUNCTION
2110         bfd_get_compression_header_size
2111
2112 SYNOPSIS
2113         int bfd_get_compression_header_size (bfd *abfd, asection *sec);
2114
2115 DESCRIPTION
2116         Return the size of the compression header of SEC in ABFD.
2117
2118 RETURNS
2119         Return the size of the compression header in bytes.
2120 */
2121
2122 int
2123 bfd_get_compression_header_size (bfd *abfd, asection *sec)
2124 {
2125   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2126     {
2127       if (sec == NULL)
2128         {
2129           if (!(abfd->flags & BFD_COMPRESS_GABI))
2130             return 0;
2131         }
2132       else if (!(elf_section_flags (sec) & SHF_COMPRESSED))
2133         return 0;
2134
2135       if (get_elf_backend_data (abfd)->s->elfclass == ELFCLASS32)
2136         return sizeof (Elf32_External_Chdr);
2137       else
2138         return sizeof (Elf64_External_Chdr);
2139     }
2140
2141   return 0;
2142 }
2143
2144 /*
2145 FUNCTION
2146         bfd_convert_section_size
2147
2148 SYNOPSIS
2149         bfd_size_type bfd_convert_section_size
2150           (bfd *ibfd, asection *isec, bfd *obfd, bfd_size_type size);
2151
2152 DESCRIPTION
2153         Convert the size @var{size} of the section @var{isec} in input
2154         BFD @var{ibfd} to the section size in output BFD @var{obfd}.
2155 */
2156
2157 bfd_size_type
2158 bfd_convert_section_size (bfd *ibfd, sec_ptr isec, bfd *obfd,
2159                           bfd_size_type size)
2160 {
2161   bfd_size_type hdr_size;
2162
2163   /* Do nothing if input file will be decompressed.  */
2164   if ((ibfd->flags & BFD_DECOMPRESS))
2165     return size;
2166
2167   /* Do nothing if either input or output aren't ELF.  */
2168   if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2169       || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2170     return size;
2171
2172   /* Do nothing if ELF classes of input and output are the same. */
2173   if (get_elf_backend_data (ibfd)->s->elfclass
2174       == get_elf_backend_data (obfd)->s->elfclass)
2175     return size;
2176
2177   /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2178   hdr_size = bfd_get_compression_header_size (ibfd, isec);
2179   if (hdr_size == 0)
2180     return size;
2181
2182   /* Adjust the size of the output SHF_COMPRESSED section.  */
2183   if (hdr_size == sizeof (Elf32_External_Chdr))
2184     return (size - sizeof (Elf32_External_Chdr)
2185             + sizeof (Elf64_External_Chdr));
2186   else
2187     return (size - sizeof (Elf64_External_Chdr)
2188             + sizeof (Elf32_External_Chdr));
2189 }
2190
2191 /*
2192 FUNCTION
2193         bfd_convert_section_contents
2194
2195 SYNOPSIS
2196         bfd_boolean bfd_convert_section_contents
2197           (bfd *ibfd, asection *isec, bfd *obfd,
2198            bfd_byte **ptr, bfd_size_type *ptr_size);
2199
2200 DESCRIPTION
2201         Convert the contents, stored in @var{*ptr}, of the section
2202         @var{isec} in input BFD @var{ibfd} to output BFD @var{obfd}
2203         if needed.  The original buffer pointed to by @var{*ptr} may
2204         be freed and @var{*ptr} is returned with memory malloc'd by this
2205         function, and the new size written to @var{ptr_size}.
2206 */
2207
2208 bfd_boolean
2209 bfd_convert_section_contents (bfd *ibfd, sec_ptr isec, bfd *obfd,
2210                               bfd_byte **ptr, bfd_size_type *ptr_size)
2211 {
2212   bfd_byte *contents;
2213   bfd_size_type ihdr_size, ohdr_size, size;
2214   Elf_Internal_Chdr chdr;
2215   bfd_boolean use_memmove;
2216
2217   /* Do nothing if input file will be decompressed.  */
2218   if ((ibfd->flags & BFD_DECOMPRESS))
2219     return TRUE;
2220
2221   /* Do nothing if either input or output aren't ELF.  */
2222   if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2223       || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2224     return TRUE;
2225
2226   /* Do nothing if ELF classes of input and output are the same. */
2227   if (get_elf_backend_data (ibfd)->s->elfclass
2228       == get_elf_backend_data (obfd)->s->elfclass)
2229     return TRUE;
2230
2231   /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2232   ihdr_size = bfd_get_compression_header_size (ibfd, isec);
2233   if (ihdr_size == 0)
2234     return TRUE;
2235
2236   contents = *ptr;
2237
2238   /* Convert the contents of the input SHF_COMPRESSED section to
2239      output.  Get the input compression header and the size of the
2240      output compression header.  */
2241   if (ihdr_size == sizeof (Elf32_External_Chdr))
2242     {
2243       Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2244       chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2245       chdr.ch_size = bfd_get_32 (ibfd, &echdr->ch_size);
2246       chdr.ch_addralign = bfd_get_32 (ibfd, &echdr->ch_addralign);
2247
2248       ohdr_size = sizeof (Elf64_External_Chdr);
2249
2250       use_memmove = FALSE;
2251     }
2252   else
2253     {
2254       Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2255       chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2256       chdr.ch_size = bfd_get_64 (ibfd, &echdr->ch_size);
2257       chdr.ch_addralign = bfd_get_64 (ibfd, &echdr->ch_addralign);
2258
2259       ohdr_size = sizeof (Elf32_External_Chdr);
2260       use_memmove = TRUE;
2261     }
2262
2263   size = bfd_get_section_size (isec) - ihdr_size + ohdr_size;
2264   if (!use_memmove)
2265     {
2266       contents = (bfd_byte *) bfd_malloc (size);
2267       if (contents == NULL)
2268         return FALSE;
2269     }
2270
2271   /* Write out the output compression header.  */
2272   if (ohdr_size == sizeof (Elf32_External_Chdr))
2273     {
2274       Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2275       bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2276       bfd_put_32 (obfd, chdr.ch_size, &echdr->ch_size);
2277       bfd_put_32 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2278     }
2279   else
2280     {
2281       Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2282       bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2283       bfd_put_32 (obfd, 0, &echdr->ch_reserved);
2284       bfd_put_64 (obfd, chdr.ch_size, &echdr->ch_size);
2285       bfd_put_64 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2286     }
2287
2288   /* Copy the compressed contents.  */
2289   if (use_memmove)
2290     memmove (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);
2291   else
2292     {
2293       memcpy (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);
2294       free (*ptr);
2295       *ptr = contents;
2296     }
2297
2298   *ptr_size = size;
2299   return TRUE;
2300 }