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