bfd/bfd.c

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