bfd/bfd.c

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