bfd/bfd.c

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