bfd/bfd.c

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