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