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 is the default routine to handle BFD error messages.
 615    Like fprintf (stderr, ...), but also handles some extra format specifiers.
 616
 617    %A section name from section.  For group components, print group name too.
 618    %B file name from bfd.  For archive components, prints archive too.
 619
 620    Note - because these two extra format specifiers require special handling
 621    they are scanned for and processed in this function, before calling
 622    vfprintf.  This means that the *arguments* for these format specifiers
 623    must be the first ones in the variable argument list, regardless of where
 624    the specifiers appear in the format string.  Thus for example calling
 625    this function with a format string of:
 626
 627       "blah %s blah %A blah %d blah %B"
 628
 629    would involve passing the arguments as:
 630
 631       "blah %s blah %A blah %d blah %B",
 632         asection_for_the_%A,
 633         bfd_for_the_%B,
 634         string_for_the_%s,
 635         integer_for_the_%d);
 636  */
 637
 638 static void
 639 error_handler_internal (const char *fmt, va_list ap)
 640 {
 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   new_fmt = fmt;
 655   bufp = buf;
 656
 657   /* Reserve enough space for the existing format string.  */
 658   avail -= strlen (fmt) + 1;
 659   if (avail > 1000)
 660     _exit (EXIT_FAILURE);
 661
 662   p = fmt;
 663   while (1)
 664     {
 665       char *q;
 666       size_t len, extra, trim;
 667
 668       p = strchr (p, '%');
 669       if (p == NULL || p[1] == '\0')
 670         {
 671           if (new_fmt == buf)
 672             {
 673               len = strlen (fmt);
 674               memcpy (bufp, fmt, len + 1);
 675             }
 676           break;
 677         }
 678
 679       if (p[1] == 'A' || p[1] == 'B')
 680         {
 681           len = p - fmt;
 682           memcpy (bufp, fmt, len);
 683           bufp += len;
 684           fmt = p + 2;
 685           new_fmt = buf;
 686
 687           /* If we run out of space, tough, you lose your ridiculously
 688              long file or section name.  It's not safe to try to alloc
 689              memory here;  We might be printing an out of memory message.  */
 690           if (avail == 0)
 691             {
 692               *bufp++ = '*';
 693               *bufp++ = '*';
 694               *bufp = '\0';
 695             }
 696           else
 697             {
 698               if (p[1] == 'B')
 699                 {
 700                   bfd *abfd = va_arg (ap, bfd *);
 701
 702                   if (abfd == NULL)
 703                     /* Invoking %B with a null bfd pointer is an internal error.  */
 704                     abort ();
 705                   else if (abfd->my_archive
 706                            && !bfd_is_thin_archive (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
 785   /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
 786      warning, so use the fputc function to avoid it.  */
 787   fputc ('\n', stderr);
 788   fflush (stderr);
 789 }
 790
 791 /* This is a function pointer to the routine which should handle BFD
 792    error messages.  It is called when a BFD routine encounters an
 793    error for which it wants to print a message.  Going through a
 794    function pointer permits a program linked against BFD to intercept
 795    the messages and deal with them itself.  */
 796
 797 static bfd_error_handler_type _bfd_error_internal = error_handler_internal;
 798
 799 void
 800 _bfd_error_handler (const char *fmt, ...)
 801 {
 802   va_list ap;
 803
 804   va_start (ap, fmt);
 805   _bfd_error_internal (fmt, ap);
 806   va_end (ap);
 807 }
 808
 809 /*
 810 FUNCTION
 811         bfd_set_error_handler
 812
 813 SYNOPSIS
 814         bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
 815
 816 DESCRIPTION
 817         Set the BFD error handler function.  Returns the previous
 818         function.
 819 */
 820
 821 bfd_error_handler_type
 822 bfd_set_error_handler (bfd_error_handler_type pnew)
 823 {
 824   bfd_error_handler_type pold;
 825
 826   pold = _bfd_error_internal;
 827   _bfd_error_internal = pnew;
 828   return pold;
 829 }
 830
 831 /*
 832 FUNCTION
 833         bfd_set_error_program_name
 834
 835 SYNOPSIS
 836         void bfd_set_error_program_name (const char *);
 837
 838 DESCRIPTION
 839         Set the program name to use when printing a BFD error.  This
 840         is printed before the error message followed by a colon and
 841         space.  The string must not be changed after it is passed to
 842         this function.
 843 */
 844
 845 void
 846 bfd_set_error_program_name (const char *name)
 847 {
 848   _bfd_error_program_name = name;
 849 }
 850
 851 /*
 852 SUBSECTION
 853         BFD assert handler
 854
 855         If BFD finds an internal inconsistency, the bfd assert
 856         handler is called with information on the BFD version, BFD
 857         source file and line.  If this happens, most programs linked
 858         against BFD are expected to want to exit with an error, or mark
 859         the current BFD operation as failed, so it is recommended to
 860         override the default handler, which just calls
 861         _bfd_error_handler and continues.
 862
 863 CODE_FRAGMENT
 864 .
 865 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
 866 .                                         const char *bfd_version,
 867 .                                         const char *bfd_file,
 868 .                                         int bfd_line);
 869 .
 870 */
 871
 872 /* Note the use of bfd_ prefix on the parameter names above: we want to
 873    show which one is the message and which is the version by naming the
 874    parameters, but avoid polluting the program-using-bfd namespace as
 875    the typedef is visible in the exported headers that the program
 876    includes.  Below, it's just for consistency.  */
 877
 878 static void
 879 _bfd_default_assert_handler (const char *bfd_formatmsg,
 880                              const char *bfd_version,
 881                              const char *bfd_file,
 882                              int bfd_line)
 883
 884 {
 885   _bfd_error_handler (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
 886 }
 887
 888 /* Similar to _bfd_error_handler, a program can decide to exit on an
 889    internal BFD error.  We use a non-variadic type to simplify passing
 890    on parameters to other functions, e.g. _bfd_error_handler.  */
 891
 892 static bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
 893
 894 /*
 895 FUNCTION
 896         bfd_set_assert_handler
 897
 898 SYNOPSIS
 899         bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
 900
 901 DESCRIPTION
 902         Set the BFD assert handler function.  Returns the previous
 903         function.
 904 */
 905
 906 bfd_assert_handler_type
 907 bfd_set_assert_handler (bfd_assert_handler_type pnew)
 908 {
 909   bfd_assert_handler_type pold;
 910
 911   pold = _bfd_assert_handler;
 912   _bfd_assert_handler = pnew;
 913   return pold;
 914 }
 915 \f
 916 /*
 917 INODE
 918 Miscellaneous, Memory Usage, Error reporting, BFD front end
 919
 920 SECTION
 921         Miscellaneous
 922
 923 SUBSECTION
 924         Miscellaneous functions
 925 */
 926
 927 /*
 928 FUNCTION
 929         bfd_get_reloc_upper_bound
 930
 931 SYNOPSIS
 932         long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
 933
 934 DESCRIPTION
 935         Return the number of bytes required to store the
 936         relocation information associated with section @var{sect}
 937         attached to bfd @var{abfd}.  If an error occurs, return -1.
 938
 939 */
 940
 941 long
 942 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
 943 {
 944   if (abfd->format != bfd_object)
 945     {
 946       bfd_set_error (bfd_error_invalid_operation);
 947       return -1;
 948     }
 949
 950   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
 951 }
 952
 953 /*
 954 FUNCTION
 955         bfd_canonicalize_reloc
 956
 957 SYNOPSIS
 958         long bfd_canonicalize_reloc
 959           (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
 960
 961 DESCRIPTION
 962         Call the back end associated with the open BFD
 963         @var{abfd} and translate the external form of the relocation
 964         information attached to @var{sec} into the internal canonical
 965         form.  Place the table into memory at @var{loc}, which has
 966         been preallocated, usually by a call to
 967         <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
 968         -1 on error.
 969
 970         The @var{syms} table is also needed for horrible internal magic
 971         reasons.
 972
 973 */
 974 long
 975 bfd_canonicalize_reloc (bfd *abfd,
 976                         sec_ptr asect,
 977                         arelent **location,
 978                         asymbol **symbols)
 979 {
 980   if (abfd->format != bfd_object)
 981     {
 982       bfd_set_error (bfd_error_invalid_operation);
 983       return -1;
 984     }
 985
 986   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
 987                    (abfd, asect, location, symbols));
 988 }
 989
 990 /*
 991 FUNCTION
 992         bfd_set_reloc
 993
 994 SYNOPSIS
 995         void bfd_set_reloc
 996           (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
 997
 998 DESCRIPTION
 999         Set the relocation pointer and count within
1000         section @var{sec} to the values @var{rel} and @var{count}.
1001         The argument @var{abfd} is ignored.
1002
1003 */
1004
1005 void
1006 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
1007                sec_ptr asect,
1008                arelent **location,
1009                unsigned int count)
1010 {
1011   asect->orelocation = location;
1012   asect->reloc_count = count;
1013 }
1014
1015 /*
1016 FUNCTION
1017         bfd_set_file_flags
1018
1019 SYNOPSIS
1020         bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
1021
1022 DESCRIPTION
1023         Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1024
1025         Possible errors are:
1026         o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1027         o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1028         o <<bfd_error_invalid_operation>> -
1029         The flag word contained a bit which was not applicable to the
1030         type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
1031         on a BFD format which does not support demand paging.
1032
1033 */
1034
1035 bfd_boolean
1036 bfd_set_file_flags (bfd *abfd, flagword flags)
1037 {
1038   if (abfd->format != bfd_object)
1039     {
1040       bfd_set_error (bfd_error_wrong_format);
1041       return FALSE;
1042     }
1043
1044   if (bfd_read_p (abfd))
1045     {
1046       bfd_set_error (bfd_error_invalid_operation);
1047       return FALSE;
1048     }
1049
1050   bfd_get_file_flags (abfd) = flags;
1051   if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1052     {
1053       bfd_set_error (bfd_error_invalid_operation);
1054       return FALSE;
1055     }
1056
1057   return TRUE;
1058 }
1059
1060 void
1061 bfd_assert (const char *file, int line)
1062 {
1063   /* xgettext:c-format */
1064   (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1065                           BFD_VERSION_STRING, file, line);
1066 }
1067
1068 /* A more or less friendly abort message.  In libbfd.h abort is
1069    defined to call this function.  */
1070
1071 void
1072 _bfd_abort (const char *file, int line, const char *fn)
1073 {
1074   if (fn != NULL)
1075     _bfd_error_handler
1076       /* xgettext:c-format */
1077       (_("BFD %s internal error, aborting at %s:%d in %s\n"),
1078        BFD_VERSION_STRING, file, line, fn);
1079   else
1080     _bfd_error_handler
1081       /* xgettext:c-format */
1082       (_("BFD %s internal error, aborting at %s:%d\n"),
1083        BFD_VERSION_STRING, file, line);
1084   _bfd_error_handler (_("Please report this bug.\n"));
1085   _exit (EXIT_FAILURE);
1086 }
1087
1088 /*
1089 FUNCTION
1090         bfd_get_arch_size
1091
1092 SYNOPSIS
1093         int bfd_get_arch_size (bfd *abfd);
1094
1095 DESCRIPTION
1096         Returns the normalized architecture address size, in bits, as
1097         determined by the object file's format.  By normalized, we mean
1098         either 32 or 64.  For ELF, this information is included in the
1099         header.  Use bfd_arch_bits_per_address for number of bits in
1100         the architecture address.
1101
1102 RETURNS
1103         Returns the arch size in bits if known, <<-1>> otherwise.
1104 */
1105
1106 int
1107 bfd_get_arch_size (bfd *abfd)
1108 {
1109   if (abfd->xvec->flavour == bfd_target_elf_flavour)
1110     return get_elf_backend_data (abfd)->s->arch_size;
1111
1112   return bfd_arch_bits_per_address (abfd) > 32 ? 64 : 32;
1113 }
1114
1115 /*
1116 FUNCTION
1117         bfd_get_sign_extend_vma
1118
1119 SYNOPSIS
1120         int bfd_get_sign_extend_vma (bfd *abfd);
1121
1122 DESCRIPTION
1123         Indicates if the target architecture "naturally" sign extends
1124         an address.  Some architectures implicitly sign extend address
1125         values when they are converted to types larger than the size
1126         of an address.  For instance, bfd_get_start_address() will
1127         return an address sign extended to fill a bfd_vma when this is
1128         the case.
1129
1130 RETURNS
1131         Returns <<1>> if the target architecture is known to sign
1132         extend addresses, <<0>> if the target architecture is known to
1133         not sign extend addresses, and <<-1>> otherwise.
1134 */
1135
1136 int
1137 bfd_get_sign_extend_vma (bfd *abfd)
1138 {
1139   char *name;
1140
1141   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1142     return get_elf_backend_data (abfd)->sign_extend_vma;
1143
1144   name = bfd_get_target (abfd);
1145
1146   /* Return a proper value for DJGPP & PE COFF.
1147      This function is required for DWARF2 support, but there is
1148      no place to store this information in the COFF back end.
1149      Should enough other COFF targets add support for DWARF2,
1150      a place will have to be found.  Until then, this hack will do.  */
1151   if (CONST_STRNEQ (name, "coff-go32")
1152       || strcmp (name, "pe-i386") == 0
1153       || strcmp (name, "pei-i386") == 0
1154       || strcmp (name, "pe-x86-64") == 0
1155       || strcmp (name, "pei-x86-64") == 0
1156       || strcmp (name, "pe-arm-wince-little") == 0
1157       || strcmp (name, "pei-arm-wince-little") == 0
1158       || strcmp (name, "aixcoff-rs6000") == 0)
1159     return 1;
1160
1161   if (CONST_STRNEQ (name, "mach-o"))
1162     return 0;
1163
1164   bfd_set_error (bfd_error_wrong_format);
1165   return -1;
1166 }
1167
1168 /*
1169 FUNCTION
1170         bfd_set_start_address
1171
1172 SYNOPSIS
1173         bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1174
1175 DESCRIPTION
1176         Make @var{vma} the entry point of output BFD @var{abfd}.
1177
1178 RETURNS
1179         Returns <<TRUE>> on success, <<FALSE>> otherwise.
1180 */
1181
1182 bfd_boolean
1183 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1184 {
1185   abfd->start_address = vma;
1186   return TRUE;
1187 }
1188
1189 /*
1190 FUNCTION
1191         bfd_get_gp_size
1192
1193 SYNOPSIS
1194         unsigned int bfd_get_gp_size (bfd *abfd);
1195
1196 DESCRIPTION
1197         Return the maximum size of objects to be optimized using the GP
1198         register under MIPS ECOFF.  This is typically set by the <<-G>>
1199         argument to the compiler, assembler or linker.
1200 */
1201
1202 unsigned int
1203 bfd_get_gp_size (bfd *abfd)
1204 {
1205   if (abfd->format == bfd_object)
1206     {
1207       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1208         return ecoff_data (abfd)->gp_size;
1209       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1210         return elf_gp_size (abfd);
1211     }
1212   return 0;
1213 }
1214
1215 /*
1216 FUNCTION
1217         bfd_set_gp_size
1218
1219 SYNOPSIS
1220         void bfd_set_gp_size (bfd *abfd, unsigned int i);
1221
1222 DESCRIPTION
1223         Set the maximum size of objects to be optimized using the GP
1224         register under ECOFF or MIPS ELF.  This is typically set by
1225         the <<-G>> argument to the compiler, assembler or linker.
1226 */
1227
1228 void
1229 bfd_set_gp_size (bfd *abfd, unsigned int i)
1230 {
1231   /* Don't try to set GP size on an archive or core file!  */
1232   if (abfd->format != bfd_object)
1233     return;
1234
1235   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1236     ecoff_data (abfd)->gp_size = i;
1237   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1238     elf_gp_size (abfd) = i;
1239 }
1240
1241 /* Get the GP value.  This is an internal function used by some of the
1242    relocation special_function routines on targets which support a GP
1243    register.  */
1244
1245 bfd_vma
1246 _bfd_get_gp_value (bfd *abfd)
1247 {
1248   if (! abfd)
1249     return 0;
1250   if (abfd->format != bfd_object)
1251     return 0;
1252
1253   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1254     return ecoff_data (abfd)->gp;
1255   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1256     return elf_gp (abfd);
1257
1258   return 0;
1259 }
1260
1261 /* Set the GP value.  */
1262
1263 void
1264 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1265 {
1266   if (! abfd)
1267     abort ();
1268   if (abfd->format != bfd_object)
1269     return;
1270
1271   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1272     ecoff_data (abfd)->gp = v;
1273   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1274     elf_gp (abfd) = v;
1275 }
1276
1277 /*
1278 FUNCTION
1279         bfd_scan_vma
1280
1281 SYNOPSIS
1282         bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1283
1284 DESCRIPTION
1285         Convert, like <<strtoul>>, a numerical expression
1286         @var{string} into a <<bfd_vma>> integer, and return that integer.
1287         (Though without as many bells and whistles as <<strtoul>>.)
1288         The expression is assumed to be unsigned (i.e., positive).
1289         If given a @var{base}, it is used as the base for conversion.
1290         A base of 0 causes the function to interpret the string
1291         in hex if a leading "0x" or "0X" is found, otherwise
1292         in octal if a leading zero is found, otherwise in decimal.
1293
1294         If the value would overflow, the maximum <<bfd_vma>> value is
1295         returned.
1296 */
1297
1298 bfd_vma
1299 bfd_scan_vma (const char *string, const char **end, int base)
1300 {
1301   bfd_vma value;
1302   bfd_vma cutoff;
1303   unsigned int cutlim;
1304   int overflow;
1305
1306   /* Let the host do it if possible.  */
1307   if (sizeof (bfd_vma) <= sizeof (unsigned long))
1308     return strtoul (string, (char **) end, base);
1309
1310 #ifdef HAVE_STRTOULL
1311   if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1312     return strtoull (string, (char **) end, base);
1313 #endif
1314
1315   if (base == 0)
1316     {
1317       if (string[0] == '0')
1318         {
1319           if ((string[1] == 'x') || (string[1] == 'X'))
1320             base = 16;
1321           else
1322             base = 8;
1323         }
1324     }
1325
1326   if ((base < 2) || (base > 36))
1327     base = 10;
1328
1329   if (base == 16
1330       && string[0] == '0'
1331       && (string[1] == 'x' || string[1] == 'X')
1332       && ISXDIGIT (string[2]))
1333     {
1334       string += 2;
1335     }
1336
1337   cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1338   cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1339   value = 0;
1340   overflow = 0;
1341   while (1)
1342     {
1343       unsigned int digit;
1344
1345       digit = *string;
1346       if (ISDIGIT (digit))
1347         digit = digit - '0';
1348       else if (ISALPHA (digit))
1349         digit = TOUPPER (digit) - 'A' + 10;
1350       else
1351         break;
1352       if (digit >= (unsigned int) base)
1353         break;
1354       if (value > cutoff || (value == cutoff && digit > cutlim))
1355         overflow = 1;
1356       value = value * base + digit;
1357       ++string;
1358     }
1359
1360   if (overflow)
1361     value = ~ (bfd_vma) 0;
1362
1363   if (end != NULL)
1364     *end = string;
1365
1366   return value;
1367 }
1368
1369 /*
1370 FUNCTION
1371         bfd_copy_private_header_data
1372
1373 SYNOPSIS
1374         bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1375
1376 DESCRIPTION
1377         Copy private BFD header information from the BFD @var{ibfd} to the
1378         the BFD @var{obfd}.  This copies information that may require
1379         sections to exist, but does not require symbol tables.  Return
1380         <<true>> on success, <<false>> on error.
1381         Possible error returns are:
1382
1383         o <<bfd_error_no_memory>> -
1384         Not enough memory exists to create private data for @var{obfd}.
1385
1386 .#define bfd_copy_private_header_data(ibfd, obfd) \
1387 .     BFD_SEND (obfd, _bfd_copy_private_header_data, \
1388 .               (ibfd, obfd))
1389
1390 */
1391
1392 /*
1393 FUNCTION
1394         bfd_copy_private_bfd_data
1395
1396 SYNOPSIS
1397         bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1398
1399 DESCRIPTION
1400         Copy private BFD information from the BFD @var{ibfd} to the
1401         the BFD @var{obfd}.  Return <<TRUE>> on success, <<FALSE>> on error.
1402         Possible error returns are:
1403
1404         o <<bfd_error_no_memory>> -
1405         Not enough memory exists to create private data for @var{obfd}.
1406
1407 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1408 .     BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1409 .               (ibfd, obfd))
1410
1411 */
1412
1413 /*
1414 FUNCTION
1415         bfd_set_private_flags
1416
1417 SYNOPSIS
1418         bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1419
1420 DESCRIPTION
1421         Set private BFD flag information in the BFD @var{abfd}.
1422         Return <<TRUE>> on success, <<FALSE>> on error.  Possible error
1423         returns are:
1424
1425         o <<bfd_error_no_memory>> -
1426         Not enough memory exists to create private data for @var{obfd}.
1427
1428 .#define bfd_set_private_flags(abfd, flags) \
1429 .     BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1430
1431 */
1432
1433 /*
1434 FUNCTION
1435         Other functions
1436
1437 DESCRIPTION
1438         The following functions exist but have not yet been documented.
1439
1440 .#define bfd_sizeof_headers(abfd, info) \
1441 .       BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1442 .
1443 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1444 .       BFD_SEND (abfd, _bfd_find_nearest_line, \
1445 .                 (abfd, syms, sec, off, file, func, line, NULL))
1446 .
1447 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
1448 .                                            line, disc) \
1449 .       BFD_SEND (abfd, _bfd_find_nearest_line, \
1450 .                 (abfd, syms, sec, off, file, func, line, disc))
1451 .
1452 .#define bfd_find_line(abfd, syms, sym, file, line) \
1453 .       BFD_SEND (abfd, _bfd_find_line, \
1454 .                 (abfd, syms, sym, file, line))
1455 .
1456 .#define bfd_find_inliner_info(abfd, file, func, line) \
1457 .       BFD_SEND (abfd, _bfd_find_inliner_info, \
1458 .                 (abfd, file, func, line))
1459 .
1460 .#define bfd_debug_info_start(abfd) \
1461 .       BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1462 .
1463 .#define bfd_debug_info_end(abfd) \
1464 .       BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1465 .
1466 .#define bfd_debug_info_accumulate(abfd, section) \
1467 .       BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1468 .
1469 .#define bfd_stat_arch_elt(abfd, stat) \
1470 .       BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1471 .
1472 .#define bfd_update_armap_timestamp(abfd) \
1473 .       BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1474 .
1475 .#define bfd_set_arch_mach(abfd, arch, mach)\
1476 .       BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1477 .
1478 .#define bfd_relax_section(abfd, section, link_info, again) \
1479 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1480 .
1481 .#define bfd_gc_sections(abfd, link_info) \
1482 .       BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1483 .
1484 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
1485 .       BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
1486 .
1487 .#define bfd_merge_sections(abfd, link_info) \
1488 .       BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1489 .
1490 .#define bfd_is_group_section(abfd, sec) \
1491 .       BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1492 .
1493 .#define bfd_discard_group(abfd, sec) \
1494 .       BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1495 .
1496 .#define bfd_link_hash_table_create(abfd) \
1497 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1498 .
1499 .#define bfd_link_add_symbols(abfd, info) \
1500 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1501 .
1502 .#define bfd_link_just_syms(abfd, sec, info) \
1503 .       BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1504 .
1505 .#define bfd_final_link(abfd, info) \
1506 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1507 .
1508 .#define bfd_free_cached_info(abfd) \
1509 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1510 .
1511 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1512 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1513 .
1514 .#define bfd_print_private_bfd_data(abfd, file)\
1515 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1516 .
1517 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1518 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1519 .
1520 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1521 .       BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1522 .                                                   dyncount, dynsyms, ret))
1523 .
1524 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1525 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1526 .
1527 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1528 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1529 .
1530 .extern bfd_byte *bfd_get_relocated_section_contents
1531 .  (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1532 .   bfd_boolean, asymbol **);
1533 .
1534
1535 */
1536
1537 bfd_byte *
1538 bfd_get_relocated_section_contents (bfd *abfd,
1539                                     struct bfd_link_info *link_info,
1540                                     struct bfd_link_order *link_order,
1541                                     bfd_byte *data,
1542                                     bfd_boolean relocatable,
1543                                     asymbol **symbols)
1544 {
1545   bfd *abfd2;
1546   bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1547                    bfd_byte *, bfd_boolean, asymbol **);
1548
1549   if (link_order->type == bfd_indirect_link_order)
1550     {
1551       abfd2 = link_order->u.indirect.section->owner;
1552       if (abfd2 == NULL)
1553         abfd2 = abfd;
1554     }
1555   else
1556     abfd2 = abfd;
1557
1558   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1559
1560   return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1561 }
1562
1563 /* Record information about an ELF program header.  */
1564
1565 bfd_boolean
1566 bfd_record_phdr (bfd *abfd,
1567                  unsigned long type,
1568                  bfd_boolean flags_valid,
1569                  flagword flags,
1570                  bfd_boolean at_valid,
1571                  bfd_vma at,
1572                  bfd_boolean includes_filehdr,
1573                  bfd_boolean includes_phdrs,
1574                  unsigned int count,
1575                  asection **secs)
1576 {
1577   struct elf_segment_map *m, **pm;
1578   bfd_size_type amt;
1579
1580   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1581     return TRUE;
1582
1583   amt = sizeof (struct elf_segment_map);
1584   amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1585   m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
1586   if (m == NULL)
1587     return FALSE;
1588
1589   m->p_type = type;
1590   m->p_flags = flags;
1591   m->p_paddr = at;
1592   m->p_flags_valid = flags_valid;
1593   m->p_paddr_valid = at_valid;
1594   m->includes_filehdr = includes_filehdr;
1595   m->includes_phdrs = includes_phdrs;
1596   m->count = count;
1597   if (count > 0)
1598     memcpy (m->sections, secs, count * sizeof (asection *));
1599
1600   for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
1601     ;
1602   *pm = m;
1603
1604   return TRUE;
1605 }
1606
1607 #ifdef BFD64
1608 /* Return true iff this target is 32-bit.  */
1609
1610 static bfd_boolean
1611 is32bit (bfd *abfd)
1612 {
1613   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1614     {
1615       const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1616       return bed->s->elfclass == ELFCLASS32;
1617     }
1618
1619   /* For non-ELF targets, use architecture information.  */
1620   return bfd_arch_bits_per_address (abfd) <= 32;
1621 }
1622 #endif
1623
1624 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1625    target's address size.  */
1626
1627 void
1628 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1629 {
1630 #ifdef BFD64
1631   if (is32bit (abfd))
1632     {
1633       sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1634       return;
1635     }
1636 #endif
1637   sprintf_vma (buf, value);
1638 }
1639
1640 void
1641 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1642 {
1643 #ifdef BFD64
1644   if (is32bit (abfd))
1645     {
1646       fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1647       return;
1648     }
1649 #endif
1650   fprintf_vma ((FILE *) stream, value);
1651 }
1652
1653 /*
1654 FUNCTION
1655         bfd_alt_mach_code
1656
1657 SYNOPSIS
1658         bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1659
1660 DESCRIPTION
1661
1662         When more than one machine code number is available for the
1663         same machine type, this function can be used to switch between
1664         the preferred one (alternative == 0) and any others.  Currently,
1665         only ELF supports this feature, with up to two alternate
1666         machine codes.
1667 */
1668
1669 bfd_boolean
1670 bfd_alt_mach_code (bfd *abfd, int alternative)
1671 {
1672   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1673     {
1674       int code;
1675
1676       switch (alternative)
1677         {
1678         case 0:
1679           code = get_elf_backend_data (abfd)->elf_machine_code;
1680           break;
1681
1682         case 1:
1683           code = get_elf_backend_data (abfd)->elf_machine_alt1;
1684           if (code == 0)
1685             return FALSE;
1686           break;
1687
1688         case 2:
1689           code = get_elf_backend_data (abfd)->elf_machine_alt2;
1690           if (code == 0)
1691             return FALSE;
1692           break;
1693
1694         default:
1695           return FALSE;
1696         }
1697
1698       elf_elfheader (abfd)->e_machine = code;
1699
1700       return TRUE;
1701     }
1702
1703   return FALSE;
1704 }
1705
1706 /*
1707 FUNCTION
1708         bfd_emul_get_maxpagesize
1709
1710 SYNOPSIS
1711         bfd_vma bfd_emul_get_maxpagesize (const char *);
1712
1713 DESCRIPTION
1714         Returns the maximum page size, in bytes, as determined by
1715         emulation.
1716
1717 RETURNS
1718         Returns the maximum page size in bytes for ELF, 0 otherwise.
1719 */
1720
1721 bfd_vma
1722 bfd_emul_get_maxpagesize (const char *emul)
1723 {
1724   const bfd_target *target;
1725
1726   target = bfd_find_target (emul, NULL);
1727   if (target != NULL
1728       && target->flavour == bfd_target_elf_flavour)
1729     return xvec_get_elf_backend_data (target)->maxpagesize;
1730
1731   return 0;
1732 }
1733
1734 static void
1735 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1736                       int offset, const bfd_target *orig_target)
1737 {
1738   if (target->flavour == bfd_target_elf_flavour)
1739     {
1740       const struct elf_backend_data *bed;
1741
1742       bed = xvec_get_elf_backend_data (target);
1743       *((bfd_vma *) ((char *) bed + offset)) = size;
1744     }
1745
1746   if (target->alternative_target
1747       && target->alternative_target != orig_target)
1748     bfd_elf_set_pagesize (target->alternative_target, size, offset,
1749                           orig_target);
1750 }
1751
1752 /*
1753 FUNCTION
1754         bfd_emul_set_maxpagesize
1755
1756 SYNOPSIS
1757         void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1758
1759 DESCRIPTION
1760         For ELF, set the maximum page size for the emulation.  It is
1761         a no-op for other formats.
1762
1763 */
1764
1765 void
1766 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1767 {
1768   const bfd_target *target;
1769
1770   target = bfd_find_target (emul, NULL);
1771   if (target)
1772     bfd_elf_set_pagesize (target, size,
1773                           offsetof (struct elf_backend_data,
1774                                     maxpagesize), target);
1775 }
1776
1777 /*
1778 FUNCTION
1779         bfd_emul_get_commonpagesize
1780
1781 SYNOPSIS
1782         bfd_vma bfd_emul_get_commonpagesize (const char *);
1783
1784 DESCRIPTION
1785         Returns the common page size, in bytes, as determined by
1786         emulation.
1787
1788 RETURNS
1789         Returns the common page size in bytes for ELF, 0 otherwise.
1790 */
1791
1792 bfd_vma
1793 bfd_emul_get_commonpagesize (const char *emul)
1794 {
1795   const bfd_target *target;
1796
1797   target = bfd_find_target (emul, NULL);
1798   if (target != NULL
1799       && target->flavour == bfd_target_elf_flavour)
1800     return xvec_get_elf_backend_data (target)->commonpagesize;
1801
1802   return 0;
1803 }
1804
1805 /*
1806 FUNCTION
1807         bfd_emul_set_commonpagesize
1808
1809 SYNOPSIS
1810         void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1811
1812 DESCRIPTION
1813         For ELF, set the common page size for the emulation.  It is
1814         a no-op for other formats.
1815
1816 */
1817
1818 void
1819 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1820 {
1821   const bfd_target *target;
1822
1823   target = bfd_find_target (emul, NULL);
1824   if (target)
1825     bfd_elf_set_pagesize (target, size,
1826                           offsetof (struct elf_backend_data,
1827                                     commonpagesize), target);
1828 }
1829
1830 /*
1831 FUNCTION
1832         bfd_demangle
1833
1834 SYNOPSIS
1835         char *bfd_demangle (bfd *, const char *, int);
1836
1837 DESCRIPTION
1838         Wrapper around cplus_demangle.  Strips leading underscores and
1839         other such chars that would otherwise confuse the demangler.
1840         If passed a g++ v3 ABI mangled name, returns a buffer allocated
1841         with malloc holding the demangled name.  Returns NULL otherwise
1842         and on memory alloc failure.
1843 */
1844
1845 char *
1846 bfd_demangle (bfd *abfd, const char *name, int options)
1847 {
1848   char *res, *alloc;
1849   const char *pre, *suf;
1850   size_t pre_len;
1851   bfd_boolean skip_lead;
1852
1853   skip_lead = (abfd != NULL
1854                && *name != '\0'
1855                && bfd_get_symbol_leading_char (abfd) == *name);
1856   if (skip_lead)
1857     ++name;
1858
1859   /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1860      or the MS PE format.  These formats have a number of leading '.'s
1861      on at least some symbols, so we remove all dots to avoid
1862      confusing the demangler.  */
1863   pre = name;
1864   while (*name == '.' || *name == '$')
1865     ++name;
1866   pre_len = name - pre;
1867
1868   /* Strip off @plt and suchlike too.  */
1869   alloc = NULL;
1870   suf = strchr (name, '@');
1871   if (suf != NULL)
1872     {
1873       alloc = (char *) bfd_malloc (suf - name + 1);
1874       if (alloc == NULL)
1875         return NULL;
1876       memcpy (alloc, name, suf - name);
1877       alloc[suf - name] = '\0';
1878       name = alloc;
1879     }
1880
1881   res = cplus_demangle (name, options);
1882
1883   if (alloc != NULL)
1884     free (alloc);
1885
1886   if (res == NULL)
1887     {
1888       if (skip_lead)
1889         {
1890           size_t len = strlen (pre) + 1;
1891           alloc = (char *) bfd_malloc (len);
1892           if (alloc == NULL)
1893             return NULL;
1894           memcpy (alloc, pre, len);
1895           return alloc;
1896         }
1897       return NULL;
1898     }
1899
1900   /* Put back any prefix or suffix.  */
1901   if (pre_len != 0 || suf != NULL)
1902     {
1903       size_t len;
1904       size_t suf_len;
1905       char *final;
1906
1907       len = strlen (res);
1908       if (suf == NULL)
1909         suf = res + len;
1910       suf_len = strlen (suf) + 1;
1911       final = (char *) bfd_malloc (pre_len + len + suf_len);
1912       if (final != NULL)
1913         {
1914           memcpy (final, pre, pre_len);
1915           memcpy (final + pre_len, res, len);
1916           memcpy (final + pre_len + len, suf, suf_len);
1917         }
1918       free (res);
1919       res = final;
1920     }
1921
1922   return res;
1923 }
1924
1925 /*
1926 FUNCTION
1927         bfd_update_compression_header
1928
1929 SYNOPSIS
1930         void bfd_update_compression_header
1931           (bfd *abfd, bfd_byte *contents, asection *sec);
1932
1933 DESCRIPTION
1934         Set the compression header at CONTENTS of SEC in ABFD and update
1935         elf_section_flags for compression.
1936 */
1937
1938 void
1939 bfd_update_compression_header (bfd *abfd, bfd_byte *contents,
1940                                asection *sec)
1941 {
1942   if ((abfd->flags & BFD_COMPRESS) != 0)
1943     {
1944       if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1945         {
1946           if ((abfd->flags & BFD_COMPRESS_GABI) != 0)
1947             {
1948               const struct elf_backend_data *bed
1949                 = get_elf_backend_data (abfd);
1950
1951               /* Set the SHF_COMPRESSED bit.  */
1952               elf_section_flags (sec) |= SHF_COMPRESSED;
1953
1954               if (bed->s->elfclass == ELFCLASS32)
1955                 {
1956                   Elf32_External_Chdr *echdr
1957                     = (Elf32_External_Chdr *) contents;
1958                   bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
1959                   bfd_put_32 (abfd, sec->size, &echdr->ch_size);
1960                   bfd_put_32 (abfd, 1 << sec->alignment_power,
1961                               &echdr->ch_addralign);
1962                 }
1963               else
1964                 {
1965                   Elf64_External_Chdr *echdr
1966                     = (Elf64_External_Chdr *) contents;
1967                   bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
1968                   bfd_put_32 (abfd, 0, &echdr->ch_reserved);
1969                   bfd_put_64 (abfd, sec->size, &echdr->ch_size);
1970                   bfd_put_64 (abfd, 1 << sec->alignment_power,
1971                               &echdr->ch_addralign);
1972                 }
1973             }
1974           else
1975             {
1976               /* Clear the SHF_COMPRESSED bit.  */
1977               elf_section_flags (sec) &= ~SHF_COMPRESSED;
1978
1979               /* Write the zlib header.  It should be "ZLIB" followed by
1980                  the uncompressed section size, 8 bytes in big-endian
1981                  order.  */
1982               memcpy (contents, "ZLIB", 4);
1983               bfd_putb64 (sec->size, contents + 4);
1984             }
1985         }
1986     }
1987   else
1988     abort ();
1989 }
1990
1991 /*
1992    FUNCTION
1993    bfd_check_compression_header
1994
1995    SYNOPSIS
1996         bfd_boolean bfd_check_compression_header
1997           (bfd *abfd, bfd_byte *contents, asection *sec,
1998           bfd_size_type *uncompressed_size);
1999
2000 DESCRIPTION
2001         Check the compression header at CONTENTS of SEC in ABFD and
2002         store the uncompressed size in UNCOMPRESSED_SIZE if the
2003         compression header is valid.
2004
2005 RETURNS
2006         Return TRUE if the compression header is valid.
2007 */
2008
2009 bfd_boolean
2010 bfd_check_compression_header (bfd *abfd, bfd_byte *contents,
2011                               asection *sec,
2012                               bfd_size_type *uncompressed_size)
2013 {
2014   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
2015       && (elf_section_flags (sec) & SHF_COMPRESSED) != 0)
2016     {
2017       Elf_Internal_Chdr chdr;
2018       const struct elf_backend_data *bed = get_elf_backend_data (abfd);
2019       if (bed->s->elfclass == ELFCLASS32)
2020         {
2021           Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2022           chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2023           chdr.ch_size = bfd_get_32 (abfd, &echdr->ch_size);
2024           chdr.ch_addralign = bfd_get_32 (abfd, &echdr->ch_addralign);
2025         }
2026       else
2027         {
2028           Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2029           chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2030           chdr.ch_size = bfd_get_64 (abfd, &echdr->ch_size);
2031           chdr.ch_addralign = bfd_get_64 (abfd, &echdr->ch_addralign);
2032         }
2033       if (chdr.ch_type == ELFCOMPRESS_ZLIB
2034           && chdr.ch_addralign == 1U << sec->alignment_power)
2035         {
2036           *uncompressed_size = chdr.ch_size;
2037           return TRUE;
2038         }
2039     }
2040
2041   return FALSE;
2042 }
2043
2044 /*
2045 FUNCTION
2046         bfd_get_compression_header_size
2047
2048 SYNOPSIS
2049         int bfd_get_compression_header_size (bfd *abfd, asection *sec);
2050
2051 DESCRIPTION
2052         Return the size of the compression header of SEC in ABFD.
2053
2054 RETURNS
2055         Return the size of the compression header in bytes.
2056 */
2057
2058 int
2059 bfd_get_compression_header_size (bfd *abfd, asection *sec)
2060 {
2061   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2062     {
2063       if (sec == NULL)
2064         {
2065           if (!(abfd->flags & BFD_COMPRESS_GABI))
2066             return 0;
2067         }
2068       else if (!(elf_section_flags (sec) & SHF_COMPRESSED))
2069         return 0;
2070
2071       if (get_elf_backend_data (abfd)->s->elfclass == ELFCLASS32)
2072         return sizeof (Elf32_External_Chdr);
2073       else
2074         return sizeof (Elf64_External_Chdr);
2075     }
2076
2077   return 0;
2078 }
2079
2080 /*
2081 FUNCTION
2082         bfd_convert_section_size
2083
2084 SYNOPSIS
2085         bfd_size_type bfd_convert_section_size
2086           (bfd *ibfd, asection *isec, bfd *obfd, bfd_size_type size);
2087
2088 DESCRIPTION
2089         Convert the size @var{size} of the section @var{isec} in input
2090         BFD @var{ibfd} to the section size in output BFD @var{obfd}.
2091 */
2092
2093 bfd_size_type
2094 bfd_convert_section_size (bfd *ibfd, sec_ptr isec, bfd *obfd,
2095                           bfd_size_type size)
2096 {
2097   bfd_size_type hdr_size;
2098
2099   /* Do nothing if input file will be decompressed.  */
2100   if ((ibfd->flags & BFD_DECOMPRESS))
2101     return size;
2102
2103   /* Do nothing if either input or output aren't ELF.  */
2104   if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2105       || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2106     return size;
2107
2108   /* Do nothing if ELF classes of input and output are the same. */
2109   if (get_elf_backend_data (ibfd)->s->elfclass
2110       == get_elf_backend_data (obfd)->s->elfclass)
2111     return size;
2112
2113   /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2114   hdr_size = bfd_get_compression_header_size (ibfd, isec);
2115   if (hdr_size == 0)
2116     return size;
2117
2118   /* Adjust the size of the output SHF_COMPRESSED section.  */
2119   if (hdr_size == sizeof (Elf32_External_Chdr))
2120     return (size - sizeof (Elf32_External_Chdr)
2121             + sizeof (Elf64_External_Chdr));
2122   else
2123     return (size - sizeof (Elf64_External_Chdr)
2124             + sizeof (Elf32_External_Chdr));
2125 }
2126
2127 /*
2128 FUNCTION
2129         bfd_convert_section_contents
2130
2131 SYNOPSIS
2132         bfd_boolean bfd_convert_section_contents
2133           (bfd *ibfd, asection *isec, bfd *obfd,
2134            bfd_byte **ptr, bfd_size_type *ptr_size);
2135
2136 DESCRIPTION
2137         Convert the contents, stored in @var{*ptr}, of the section
2138         @var{isec} in input BFD @var{ibfd} to output BFD @var{obfd}
2139         if needed.  The original buffer pointed to by @var{*ptr} may
2140         be freed and @var{*ptr} is returned with memory malloc'd by this
2141         function, and the new size written to @var{ptr_size}.
2142 */
2143
2144 bfd_boolean
2145 bfd_convert_section_contents (bfd *ibfd, sec_ptr isec, bfd *obfd,
2146                               bfd_byte **ptr, bfd_size_type *ptr_size)
2147 {
2148   bfd_byte *contents;
2149   bfd_size_type ihdr_size, ohdr_size, size;
2150   Elf_Internal_Chdr chdr;
2151   bfd_boolean use_memmove;
2152
2153   /* Do nothing if input file will be decompressed.  */
2154   if ((ibfd->flags & BFD_DECOMPRESS))
2155     return TRUE;
2156
2157   /* Do nothing if either input or output aren't ELF.  */
2158   if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2159       || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2160     return TRUE;
2161
2162   /* Do nothing if ELF classes of input and output are the same. */
2163   if (get_elf_backend_data (ibfd)->s->elfclass
2164       == get_elf_backend_data (obfd)->s->elfclass)
2165     return TRUE;
2166
2167   /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2168   ihdr_size = bfd_get_compression_header_size (ibfd, isec);
2169   if (ihdr_size == 0)
2170     return TRUE;
2171
2172   contents = *ptr;
2173
2174   /* Convert the contents of the input SHF_COMPRESSED section to
2175      output.  Get the input compression header and the size of the
2176      output compression header.  */
2177   if (ihdr_size == sizeof (Elf32_External_Chdr))
2178     {
2179       Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2180       chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2181       chdr.ch_size = bfd_get_32 (ibfd, &echdr->ch_size);
2182       chdr.ch_addralign = bfd_get_32 (ibfd, &echdr->ch_addralign);
2183
2184       ohdr_size = sizeof (Elf64_External_Chdr);
2185
2186       use_memmove = FALSE;
2187     }
2188   else
2189     {
2190       Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2191       chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2192       chdr.ch_size = bfd_get_64 (ibfd, &echdr->ch_size);
2193       chdr.ch_addralign = bfd_get_64 (ibfd, &echdr->ch_addralign);
2194
2195       ohdr_size = sizeof (Elf32_External_Chdr);
2196       use_memmove = TRUE;
2197     }
2198
2199   size = bfd_get_section_size (isec) - ihdr_size + ohdr_size;
2200   if (!use_memmove)
2201     {
2202       contents = (bfd_byte *) bfd_malloc (size);
2203       if (contents == NULL)
2204         return FALSE;
2205     }
2206
2207   /* Write out the output compression header.  */
2208   if (ohdr_size == sizeof (Elf32_External_Chdr))
2209     {
2210       Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2211       bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2212       bfd_put_32 (obfd, chdr.ch_size, &echdr->ch_size);
2213       bfd_put_32 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2214     }
2215   else
2216     {
2217       Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2218       bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2219       bfd_put_32 (obfd, 0, &echdr->ch_reserved);
2220       bfd_put_64 (obfd, chdr.ch_size, &echdr->ch_size);
2221       bfd_put_64 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2222     }
2223
2224   /* Copy the compressed contents.  */
2225   if (use_memmove)
2226     memmove (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);
2227   else
2228     {
2229       memcpy (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);
2230       free (*ptr);
2231       *ptr = contents;
2232     }
2233
2234   *ptr_size = size;
2235   return TRUE;
2236 }