bfd/bfd.c

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