bfd/bfd.c

   1 /* Generic BFD library interface and support routines.
   2    Copyright (C) 1990-2014 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 .struct bfd
  48 .{
  49 .  {* A unique identifier of the BFD  *}
  50 .  unsigned int id;
  51 .
  52 .  {* The filename the application opened the BFD with.  *}
  53 .  const char *filename;
  54 .
  55 .  {* A pointer to the target jump table.  *}
  56 .  const struct bfd_target *xvec;
  57 .
  58 .  {* The IOSTREAM, and corresponding IO vector that provide access
  59 .     to the file backing the BFD.  *}
  60 .  void *iostream;
  61 .  const struct bfd_iovec *iovec;
  62 .
  63 .  {* The caching routines use these to maintain a
  64 .     least-recently-used list of BFDs.  *}
  65 .  struct bfd *lru_prev, *lru_next;
  66 .
  67 .  {* When a file is closed by the caching routines, BFD retains
  68 .     state information on the file here...  *}
  69 .  ufile_ptr where;
  70 .
  71 .  {* File modified time, if mtime_set is TRUE.  *}
  72 .  long mtime;
  73 .
  74 .  {* Reserved for an unimplemented file locking extension.  *}
  75 .  int ifd;
  76 .
  77 .  {* The format which belongs to the BFD. (object, core, etc.)  *}
  78 .  bfd_format format;
  79 .
  80 .  {* The direction with which the BFD was opened.  *}
  81 .  enum bfd_direction direction;
  82 .
  83 .  {* Format_specific flags.  *}
  84 .  flagword flags;
  85 .
  86 .  {* Values that may appear in the flags field of a BFD.  These also
  87 .     appear in the object_flags field of the bfd_target structure, where
  88 .     they indicate the set of flags used by that backend (not all flags
  89 .     are meaningful for all object file formats) (FIXME: at the moment,
  90 .     the object_flags values have mostly just been copied from backend
  91 .     to another, and are not necessarily correct).  *}
  92 .
  93 .#define BFD_NO_FLAGS   0x00
  94 .
  95 .  {* BFD contains relocation entries.  *}
  96 .#define HAS_RELOC      0x01
  97 .
  98 .  {* BFD is directly executable.  *}
  99 .#define EXEC_P         0x02
 100 .
 101 .  {* BFD has line number information (basically used for F_LNNO in a
 102 .     COFF header).  *}
 103 .#define HAS_LINENO     0x04
 104 .
 105 .  {* BFD has debugging information.  *}
 106 .#define HAS_DEBUG      0x08
 107 .
 108 .  {* BFD has symbols.  *}
 109 .#define HAS_SYMS       0x10
 110 .
 111 .  {* BFD has local symbols (basically used for F_LSYMS in a COFF
 112 .     header).  *}
 113 .#define HAS_LOCALS     0x20
 114 .
 115 .  {* BFD is a dynamic object.  *}
 116 .#define DYNAMIC        0x40
 117 .
 118 .  {* Text section is write protected (if D_PAGED is not set, this is
 119 .     like an a.out NMAGIC file) (the linker sets this by default, but
 120 .     clears it for -r or -N).  *}
 121 .#define WP_TEXT        0x80
 122 .
 123 .  {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
 124 .     linker sets this by default, but clears it for -r or -n or -N).  *}
 125 .#define D_PAGED        0x100
 126 .
 127 .  {* BFD is relaxable (this means that bfd_relax_section may be able to
 128 .     do something) (sometimes bfd_relax_section can do something even if
 129 .     this is not set).  *}
 130 .#define BFD_IS_RELAXABLE 0x200
 131 .
 132 .  {* This may be set before writing out a BFD to request using a
 133 .     traditional format.  For example, this is used to request that when
 134 .     writing out an a.out object the symbols not be hashed to eliminate
 135 .     duplicates.  *}
 136 .#define BFD_TRADITIONAL_FORMAT 0x400
 137 .
 138 .  {* This flag indicates that the BFD contents are actually cached
 139 .     in memory.  If this is set, iostream points to a bfd_in_memory
 140 .     struct.  *}
 141 .#define BFD_IN_MEMORY 0x800
 142 .
 143 .  {* The sections in this BFD specify a memory page.  *}
 144 .#define HAS_LOAD_PAGE 0x1000
 145 .
 146 .  {* This BFD has been created by the linker and doesn't correspond
 147 .     to any input file.  *}
 148 .#define BFD_LINKER_CREATED 0x2000
 149 .
 150 .  {* This may be set before writing out a BFD to request that it
 151 .     be written using values for UIDs, GIDs, timestamps, etc. that
 152 .     will be consistent from run to run.  *}
 153 .#define BFD_DETERMINISTIC_OUTPUT 0x4000
 154 .
 155 .  {* Compress sections in this BFD.  *}
 156 .#define BFD_COMPRESS 0x8000
 157 .
 158 .  {* Decompress sections in this BFD.  *}
 159 .#define BFD_DECOMPRESS 0x10000
 160 .
 161 .  {* BFD is a dummy, for plugins.  *}
 162 .#define BFD_PLUGIN 0x20000
 163 .
 164 .  {* Flags bits to be saved in bfd_preserve_save.  *}
 165 .#define BFD_FLAGS_SAVED \
 166 .  (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_PLUGIN)
 167 .
 168 .  {* Flags bits which are for BFD use only.  *}
 169 .#define BFD_FLAGS_FOR_BFD_USE_MASK \
 170 .  (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
 171 .   | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT)
 172 .
 173 .  {* Currently my_archive is tested before adding origin to
 174 .     anything. I believe that this can become always an add of
 175 .     origin, with origin set to 0 for non archive files.  *}
 176 .  ufile_ptr origin;
 177 .
 178 .  {* The origin in the archive of the proxy entry.  This will
 179 .     normally be the same as origin, except for thin archives,
 180 .     when it will contain the current offset of the proxy in the
 181 .     thin archive rather than the offset of the bfd in its actual
 182 .     container.  *}
 183 .  ufile_ptr proxy_origin;
 184 .
 185 .  {* A hash table for section names.  *}
 186 .  struct bfd_hash_table section_htab;
 187 .
 188 .  {* Pointer to linked list of sections.  *}
 189 .  struct bfd_section *sections;
 190 .
 191 .  {* The last section on the section list.  *}
 192 .  struct bfd_section *section_last;
 193 .
 194 .  {* The number of sections.  *}
 195 .  unsigned int section_count;
 196 .
 197 .  {* Stuff only useful for object files:
 198 .     The start address.  *}
 199 .  bfd_vma start_address;
 200 .
 201 .  {* Used for input and output.  *}
 202 .  unsigned int symcount;
 203 .
 204 .  {* Symbol table for output BFD (with symcount entries).
 205 .     Also used by the linker to cache input BFD symbols.  *}
 206 .  struct bfd_symbol  **outsymbols;
 207 .
 208 .  {* Used for slurped dynamic symbol tables.  *}
 209 .  unsigned int dynsymcount;
 210 .
 211 .  {* Pointer to structure which contains architecture information.  *}
 212 .  const struct bfd_arch_info *arch_info;
 213 .
 214 .  {* Stuff only useful for archives.  *}
 215 .  void *arelt_data;
 216 .  struct bfd *my_archive;      {* The containing archive BFD.  *}
 217 .  struct bfd *archive_next;    {* The next BFD in the archive.  *}
 218 .  struct bfd *archive_head;    {* The first BFD in the archive.  *}
 219 .  struct bfd *nested_archives; {* List of nested archive in a flattened
 220 .                                  thin archive.  *}
 221 .
 222 .  union {
 223 .    {* For input BFDs, a chain of BFDs involved in a link.  *}
 224 .    struct bfd *next;
 225 .    {* For output BFD, the linker hash table.  *}
 226 .    struct bfd_link_hash_table *hash;
 227 .  } link;
 228 .
 229 .  {* A field used by _bfd_generic_link_add_archive_symbols.  This will
 230 .     be used only for archive elements.  *}
 231 .  int archive_pass;
 232 .
 233 .  {* Used by the back end to hold private data.  *}
 234 .  union
 235 .    {
 236 .      struct aout_data_struct *aout_data;
 237 .      struct artdata *aout_ar_data;
 238 .      struct _oasys_data *oasys_obj_data;
 239 .      struct _oasys_ar_data *oasys_ar_data;
 240 .      struct coff_tdata *coff_obj_data;
 241 .      struct pe_tdata *pe_obj_data;
 242 .      struct xcoff_tdata *xcoff_obj_data;
 243 .      struct ecoff_tdata *ecoff_obj_data;
 244 .      struct ieee_data_struct *ieee_data;
 245 .      struct ieee_ar_data_struct *ieee_ar_data;
 246 .      struct srec_data_struct *srec_data;
 247 .      struct verilog_data_struct *verilog_data;
 248 .      struct ihex_data_struct *ihex_data;
 249 .      struct tekhex_data_struct *tekhex_data;
 250 .      struct elf_obj_tdata *elf_obj_data;
 251 .      struct nlm_obj_tdata *nlm_obj_data;
 252 .      struct bout_data_struct *bout_data;
 253 .      struct mmo_data_struct *mmo_data;
 254 .      struct sun_core_struct *sun_core_data;
 255 .      struct sco5_core_struct *sco5_core_data;
 256 .      struct trad_core_struct *trad_core_data;
 257 .      struct som_data_struct *som_data;
 258 .      struct hpux_core_struct *hpux_core_data;
 259 .      struct hppabsd_core_struct *hppabsd_core_data;
 260 .      struct sgi_core_struct *sgi_core_data;
 261 .      struct lynx_core_struct *lynx_core_data;
 262 .      struct osf_core_struct *osf_core_data;
 263 .      struct cisco_core_struct *cisco_core_data;
 264 .      struct versados_data_struct *versados_data;
 265 .      struct netbsd_core_struct *netbsd_core_data;
 266 .      struct mach_o_data_struct *mach_o_data;
 267 .      struct mach_o_fat_data_struct *mach_o_fat_data;
 268 .      struct plugin_data_struct *plugin_data;
 269 .      struct bfd_pef_data_struct *pef_data;
 270 .      struct bfd_pef_xlib_data_struct *pef_xlib_data;
 271 .      struct bfd_sym_data_struct *sym_data;
 272 .      void *any;
 273 .    }
 274 .  tdata;
 275 .
 276 .  {* Used by the application to hold private data.  *}
 277 .  void *usrdata;
 278 .
 279 .  {* Where all the allocated stuff under this BFD goes.  This is a
 280 .     struct objalloc *, but we use void * to avoid requiring the inclusion
 281 .     of objalloc.h.  *}
 282 .  void *memory;
 283 .
 284 .  {* Is the file descriptor being cached?  That is, can it be closed as
 285 .     needed, and re-opened when accessed later?  *}
 286 .  unsigned int cacheable : 1;
 287 .
 288 .  {* Marks whether there was a default target specified when the
 289 .     BFD was opened. This is used to select which matching algorithm
 290 .     to use to choose the back end.  *}
 291 .  unsigned int target_defaulted : 1;
 292 .
 293 .  {* ... and here: (``once'' means at least once).  *}
 294 .  unsigned int opened_once : 1;
 295 .
 296 .  {* Set if we have a locally maintained mtime value, rather than
 297 .     getting it from the file each time.  *}
 298 .  unsigned int mtime_set : 1;
 299 .
 300 .  {* Flag set if symbols from this BFD should not be exported.  *}
 301 .  unsigned int no_export : 1;
 302 .
 303 .  {* Remember when output has begun, to stop strange things
 304 .     from happening.  *}
 305 .  unsigned int output_has_begun : 1;
 306 .
 307 .  {* Have archive map.  *}
 308 .  unsigned int has_armap : 1;
 309 .
 310 .  {* Set if this is a thin archive.  *}
 311 .  unsigned int is_thin_archive : 1;
 312 .
 313 .  {* Set if only required symbols should be added in the link hash table for
 314 .     this object.  Used by VMS linkers.  *}
 315 .  unsigned int selective_search : 1;
 316 .
 317 .  {* Set if this is the linker output BFD.  *}
 318 .  unsigned int is_linker_output : 1;
 319 .};
 320 .
 321 .{* See note beside bfd_set_section_userdata.  *}
 322 .static inline bfd_boolean
 323 .bfd_set_cacheable (bfd * abfd, bfd_boolean val)
 324 .{
 325 .  abfd->cacheable = val;
 326 .  return TRUE;
 327 .}
 328 .
 329 */
 330
 331 #include "sysdep.h"
 332 #include <stdarg.h>
 333 #include "bfd.h"
 334 #include "bfdver.h"
 335 #include "libiberty.h"
 336 #include "demangle.h"
 337 #include "safe-ctype.h"
 338 #include "bfdlink.h"
 339 #include "libbfd.h"
 340 #include "coff/internal.h"
 341 #include "coff/sym.h"
 342 #include "libcoff.h"
 343 #include "libecoff.h"
 344 #undef obj_symbols
 345 #include "elf-bfd.h"
 346
 347 #ifndef EXIT_FAILURE
 348 #define EXIT_FAILURE 1
 349 #endif
 350
 351 \f
 352 /* provide storage for subsystem, stack and heap data which may have been
 353    passed in on the command line.  Ld puts this data into a bfd_link_info
 354    struct which ultimately gets passed in to the bfd.  When it arrives, copy
 355    it to the following struct so that the data will be available in coffcode.h
 356    where it is needed.  The typedef's used are defined in bfd.h */
 357 \f
 358 /*
 359 INODE
 360 Error reporting, Miscellaneous, typedef bfd, BFD front end
 361
 362 SECTION
 363         Error reporting
 364
 365         Most BFD functions return nonzero on success (check their
 366         individual documentation for precise semantics).  On an error,
 367         they call <<bfd_set_error>> to set an error condition that callers
 368         can check by calling <<bfd_get_error>>.
 369         If that returns <<bfd_error_system_call>>, then check
 370         <<errno>>.
 371
 372         The easiest way to report a BFD error to the user is to
 373         use <<bfd_perror>>.
 374
 375 SUBSECTION
 376         Type <<bfd_error_type>>
 377
 378         The values returned by <<bfd_get_error>> are defined by the
 379         enumerated type <<bfd_error_type>>.
 380
 381 CODE_FRAGMENT
 382 .
 383 .typedef enum bfd_error
 384 .{
 385 .  bfd_error_no_error = 0,
 386 .  bfd_error_system_call,
 387 .  bfd_error_invalid_target,
 388 .  bfd_error_wrong_format,
 389 .  bfd_error_wrong_object_format,
 390 .  bfd_error_invalid_operation,
 391 .  bfd_error_no_memory,
 392 .  bfd_error_no_symbols,
 393 .  bfd_error_no_armap,
 394 .  bfd_error_no_more_archived_files,
 395 .  bfd_error_malformed_archive,
 396 .  bfd_error_missing_dso,
 397 .  bfd_error_file_not_recognized,
 398 .  bfd_error_file_ambiguously_recognized,
 399 .  bfd_error_no_contents,
 400 .  bfd_error_nonrepresentable_section,
 401 .  bfd_error_no_debug_section,
 402 .  bfd_error_bad_value,
 403 .  bfd_error_file_truncated,
 404 .  bfd_error_file_too_big,
 405 .  bfd_error_on_input,
 406 .  bfd_error_invalid_error_code
 407 .}
 408 .bfd_error_type;
 409 .
 410 */
 411
 412 static bfd_error_type bfd_error = bfd_error_no_error;
 413 static bfd *input_bfd = NULL;
 414 static bfd_error_type input_error = bfd_error_no_error;
 415
 416 const char *const bfd_errmsgs[] =
 417 {
 418   N_("No error"),
 419   N_("System call error"),
 420   N_("Invalid bfd target"),
 421   N_("File in wrong format"),
 422   N_("Archive object file in wrong format"),
 423   N_("Invalid operation"),
 424   N_("Memory exhausted"),
 425   N_("No symbols"),
 426   N_("Archive has no index; run ranlib to add one"),
 427   N_("No more archived files"),
 428   N_("Malformed archive"),
 429   N_("DSO missing from command line"),
 430   N_("File format not recognized"),
 431   N_("File format is ambiguous"),
 432   N_("Section has no contents"),
 433   N_("Nonrepresentable section on output"),
 434   N_("Symbol needs debug section which does not exist"),
 435   N_("Bad value"),
 436   N_("File truncated"),
 437   N_("File too big"),
 438   N_("Error reading %s: %s"),
 439   N_("#<Invalid error code>")
 440 };
 441
 442 /*
 443 FUNCTION
 444         bfd_get_error
 445
 446 SYNOPSIS
 447         bfd_error_type bfd_get_error (void);
 448
 449 DESCRIPTION
 450         Return the current BFD error condition.
 451 */
 452
 453 bfd_error_type
 454 bfd_get_error (void)
 455 {
 456   return bfd_error;
 457 }
 458
 459 /*
 460 FUNCTION
 461         bfd_set_error
 462
 463 SYNOPSIS
 464         void bfd_set_error (bfd_error_type error_tag, ...);
 465
 466 DESCRIPTION
 467         Set the BFD error condition to be @var{error_tag}.
 468         If @var{error_tag} is bfd_error_on_input, then this function
 469         takes two more parameters, the input bfd where the error
 470         occurred, and the bfd_error_type error.
 471 */
 472
 473 void
 474 bfd_set_error (bfd_error_type error_tag, ...)
 475 {
 476   bfd_error = error_tag;
 477   if (error_tag == bfd_error_on_input)
 478     {
 479       /* This is an error that occurred during bfd_close when
 480          writing an archive, but on one of the input files.  */
 481       va_list ap;
 482
 483       va_start (ap, error_tag);
 484       input_bfd = va_arg (ap, bfd *);
 485       input_error = (bfd_error_type) va_arg (ap, int);
 486       if (input_error >= bfd_error_on_input)
 487         abort ();
 488       va_end (ap);
 489     }
 490 }
 491
 492 /*
 493 FUNCTION
 494         bfd_errmsg
 495
 496 SYNOPSIS
 497         const char *bfd_errmsg (bfd_error_type error_tag);
 498
 499 DESCRIPTION
 500         Return a string describing the error @var{error_tag}, or
 501         the system error if @var{error_tag} is <<bfd_error_system_call>>.
 502 */
 503
 504 const char *
 505 bfd_errmsg (bfd_error_type error_tag)
 506 {
 507 #ifndef errno
 508   extern int errno;
 509 #endif
 510   if (error_tag == bfd_error_on_input)
 511     {
 512       char *buf;
 513       const char *msg = bfd_errmsg (input_error);
 514
 515       if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
 516           != -1)
 517         return buf;
 518
 519       /* Ick, what to do on out of memory?  */
 520       return msg;
 521     }
 522
 523   if (error_tag == bfd_error_system_call)
 524     return xstrerror (errno);
 525
 526   if (error_tag > bfd_error_invalid_error_code)
 527     error_tag = bfd_error_invalid_error_code;   /* sanity check */
 528
 529   return _(bfd_errmsgs [error_tag]);
 530 }
 531
 532 /*
 533 FUNCTION
 534         bfd_perror
 535
 536 SYNOPSIS
 537         void bfd_perror (const char *message);
 538
 539 DESCRIPTION
 540         Print to the standard error stream a string describing the
 541         last BFD error that occurred, or the last system error if
 542         the last BFD error was a system call failure.  If @var{message}
 543         is non-NULL and non-empty, the error string printed is preceded
 544         by @var{message}, a colon, and a space.  It is followed by a newline.
 545 */
 546
 547 void
 548 bfd_perror (const char *message)
 549 {
 550   fflush (stdout);
 551   if (message == NULL || *message == '\0')
 552     fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
 553   else
 554     fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
 555   fflush (stderr);
 556 }
 557
 558 /*
 559 SUBSECTION
 560         BFD error handler
 561
 562         Some BFD functions want to print messages describing the
 563         problem.  They call a BFD error handler function.  This
 564         function may be overridden by the program.
 565
 566         The BFD error handler acts like printf.
 567
 568 CODE_FRAGMENT
 569 .
 570 .typedef void (*bfd_error_handler_type) (const char *, ...);
 571 .
 572 */
 573
 574 /* The program name used when printing BFD error messages.  */
 575
 576 static const char *_bfd_error_program_name;
 577
 578 /* This is the default routine to handle BFD error messages.
 579    Like fprintf (stderr, ...), but also handles some extra format specifiers.
 580
 581    %A section name from section.  For group components, print group name too.
 582    %B file name from bfd.  For archive components, prints archive too.
 583
 584    Note - because these two extra format specifiers require special handling
 585    they are scanned for and processed in this function, before calling
 586    vfprintf.  This means that the *arguments* for these format specifiers
 587    must be the first ones in the variable argument list, regardless of where
 588    the specifiers appear in the format string.  Thus for example calling
 589    this function with a format string of:
 590
 591       "blah %s blah %A blah %d blah %B"
 592
 593    would involve passing the arguments as:
 594
 595       "blah %s blah %A blah %d blah %B",
 596         asection_for_the_%A,
 597         bfd_for_the_%B,
 598         string_for_the_%s,
 599         integer_for_the_%d);
 600  */
 601
 602 void
 603 _bfd_default_error_handler (const char *fmt, ...)
 604 {
 605   va_list ap;
 606   char *bufp;
 607   const char *new_fmt, *p;
 608   size_t avail = 1000;
 609   char buf[1000];
 610
 611   /* PR 4992: Don't interrupt output being sent to stdout.  */
 612   fflush (stdout);
 613
 614   if (_bfd_error_program_name != NULL)
 615     fprintf (stderr, "%s: ", _bfd_error_program_name);
 616   else
 617     fprintf (stderr, "BFD: ");
 618
 619   va_start (ap, fmt);
 620   new_fmt = fmt;
 621   bufp = buf;
 622
 623   /* Reserve enough space for the existing format string.  */
 624   avail -= strlen (fmt) + 1;
 625   if (avail > 1000)
 626     _exit (EXIT_FAILURE);
 627
 628   p = fmt;
 629   while (1)
 630     {
 631       char *q;
 632       size_t len, extra, trim;
 633
 634       p = strchr (p, '%');
 635       if (p == NULL || p[1] == '\0')
 636         {
 637           if (new_fmt == buf)
 638             {
 639               len = strlen (fmt);
 640               memcpy (bufp, fmt, len + 1);
 641             }
 642           break;
 643         }
 644
 645       if (p[1] == 'A' || p[1] == 'B')
 646         {
 647           len = p - fmt;
 648           memcpy (bufp, fmt, len);
 649           bufp += len;
 650           fmt = p + 2;
 651           new_fmt = buf;
 652
 653           /* If we run out of space, tough, you lose your ridiculously
 654              long file or section name.  It's not safe to try to alloc
 655              memory here;  We might be printing an out of memory message.  */
 656           if (avail == 0)
 657             {
 658               *bufp++ = '*';
 659               *bufp++ = '*';
 660               *bufp = '\0';
 661             }
 662           else
 663             {
 664               if (p[1] == 'B')
 665                 {
 666                   bfd *abfd = va_arg (ap, bfd *);
 667
 668                   if (abfd == NULL)
 669                     /* Invoking %B with a null bfd pointer is an internal error.  */
 670                     abort ();
 671                   else if (abfd->my_archive)
 672                     snprintf (bufp, avail, "%s(%s)",
 673                               abfd->my_archive->filename, abfd->filename);
 674                   else
 675                     snprintf (bufp, avail, "%s", abfd->filename);
 676                 }
 677               else
 678                 {
 679                   asection *sec = va_arg (ap, asection *);
 680                   bfd *abfd;
 681                   const char *group = NULL;
 682                   struct coff_comdat_info *ci;
 683
 684                   if (sec == NULL)
 685                     /* Invoking %A with a null section pointer is an internal error.  */
 686                     abort ();
 687                   abfd = sec->owner;
 688                   if (abfd != NULL
 689                       && bfd_get_flavour (abfd) == bfd_target_elf_flavour
 690                       && elf_next_in_group (sec) != NULL
 691                       && (sec->flags & SEC_GROUP) == 0)
 692                     group = elf_group_name (sec);
 693                   else if (abfd != NULL
 694                            && bfd_get_flavour (abfd) == bfd_target_coff_flavour
 695                            && (ci = bfd_coff_get_comdat_section (sec->owner,
 696                                                                  sec)) != NULL)
 697                     group = ci->name;
 698                   if (group != NULL)
 699                     snprintf (bufp, avail, "%s[%s]", sec->name, group);
 700                   else
 701                     snprintf (bufp, avail, "%s", sec->name);
 702                 }
 703               len = strlen (bufp);
 704               avail = avail - len + 2;
 705
 706               /* We need to replace any '%' we printed by "%%".
 707                  First count how many.  */
 708               q = bufp;
 709               bufp += len;
 710               extra = 0;
 711               while ((q = strchr (q, '%')) != NULL)
 712                 {
 713                   ++q;
 714                   ++extra;
 715                 }
 716
 717               /* If there isn't room, trim off the end of the string.  */
 718               q = bufp;
 719               bufp += extra;
 720               if (extra > avail)
 721                 {
 722                   trim = extra - avail;
 723                   bufp -= trim;
 724                   do
 725                     {
 726                       if (*--q == '%')
 727                         --extra;
 728                     }
 729                   while (--trim != 0);
 730                   *q = '\0';
 731                   avail = extra;
 732                 }
 733               avail -= extra;
 734
 735               /* Now double all '%' chars, shuffling the string as we go.  */
 736               while (extra != 0)
 737                 {
 738                   while ((q[extra] = *q) != '%')
 739                     --q;
 740                   q[--extra] = '%';
 741                   --q;
 742                 }
 743             }
 744         }
 745       p = p + 2;
 746     }
 747
 748   vfprintf (stderr, new_fmt, ap);
 749   va_end (ap);
 750
 751   /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
 752      warning, so use the fputc function to avoid it.  */
 753   fputc ('\n', stderr);
 754   fflush (stderr);
 755 }
 756
 757 /* This is a function pointer to the routine which should handle BFD
 758    error messages.  It is called when a BFD routine encounters an
 759    error for which it wants to print a message.  Going through a
 760    function pointer permits a program linked against BFD to intercept
 761    the messages and deal with them itself.  */
 762
 763 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
 764
 765 /*
 766 FUNCTION
 767         bfd_set_error_handler
 768
 769 SYNOPSIS
 770         bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
 771
 772 DESCRIPTION
 773         Set the BFD error handler function.  Returns the previous
 774         function.
 775 */
 776
 777 bfd_error_handler_type
 778 bfd_set_error_handler (bfd_error_handler_type pnew)
 779 {
 780   bfd_error_handler_type pold;
 781
 782   pold = _bfd_error_handler;
 783   _bfd_error_handler = pnew;
 784   return pold;
 785 }
 786
 787 /*
 788 FUNCTION
 789         bfd_set_error_program_name
 790
 791 SYNOPSIS
 792         void bfd_set_error_program_name (const char *);
 793
 794 DESCRIPTION
 795         Set the program name to use when printing a BFD error.  This
 796         is printed before the error message followed by a colon and
 797         space.  The string must not be changed after it is passed to
 798         this function.
 799 */
 800
 801 void
 802 bfd_set_error_program_name (const char *name)
 803 {
 804   _bfd_error_program_name = name;
 805 }
 806
 807 /*
 808 FUNCTION
 809         bfd_get_error_handler
 810
 811 SYNOPSIS
 812         bfd_error_handler_type bfd_get_error_handler (void);
 813
 814 DESCRIPTION
 815         Return the BFD error handler function.
 816 */
 817
 818 bfd_error_handler_type
 819 bfd_get_error_handler (void)
 820 {
 821   return _bfd_error_handler;
 822 }
 823
 824 /*
 825 SUBSECTION
 826         BFD assert handler
 827
 828         If BFD finds an internal inconsistency, the bfd assert
 829         handler is called with information on the BFD version, BFD
 830         source file and line.  If this happens, most programs linked
 831         against BFD are expected to want to exit with an error, or mark
 832         the current BFD operation as failed, so it is recommended to
 833         override the default handler, which just calls
 834         _bfd_error_handler and continues.
 835
 836 CODE_FRAGMENT
 837 .
 838 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
 839 .                                         const char *bfd_version,
 840 .                                         const char *bfd_file,
 841 .                                         int bfd_line);
 842 .
 843 */
 844
 845 /* Note the use of bfd_ prefix on the parameter names above: we want to
 846    show which one is the message and which is the version by naming the
 847    parameters, but avoid polluting the program-using-bfd namespace as
 848    the typedef is visible in the exported headers that the program
 849    includes.  Below, it's just for consistency.  */
 850
 851 static void
 852 _bfd_default_assert_handler (const char *bfd_formatmsg,
 853                              const char *bfd_version,
 854                              const char *bfd_file,
 855                              int bfd_line)
 856
 857 {
 858   (*_bfd_error_handler) (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
 859 }
 860
 861 /* Similar to _bfd_error_handler, a program can decide to exit on an
 862    internal BFD error.  We use a non-variadic type to simplify passing
 863    on parameters to other functions, e.g. _bfd_error_handler.  */
 864
 865 bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
 866
 867 /*
 868 FUNCTION
 869         bfd_set_assert_handler
 870
 871 SYNOPSIS
 872         bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
 873
 874 DESCRIPTION
 875         Set the BFD assert handler function.  Returns the previous
 876         function.
 877 */
 878
 879 bfd_assert_handler_type
 880 bfd_set_assert_handler (bfd_assert_handler_type pnew)
 881 {
 882   bfd_assert_handler_type pold;
 883
 884   pold = _bfd_assert_handler;
 885   _bfd_assert_handler = pnew;
 886   return pold;
 887 }
 888
 889 /*
 890 FUNCTION
 891         bfd_get_assert_handler
 892
 893 SYNOPSIS
 894         bfd_assert_handler_type bfd_get_assert_handler (void);
 895
 896 DESCRIPTION
 897         Return the BFD assert handler function.
 898 */
 899
 900 bfd_assert_handler_type
 901 bfd_get_assert_handler (void)
 902 {
 903   return _bfd_assert_handler;
 904 }
 905 \f
 906 /*
 907 INODE
 908 Miscellaneous, Memory Usage, Error reporting, BFD front end
 909
 910 SECTION
 911         Miscellaneous
 912
 913 SUBSECTION
 914         Miscellaneous functions
 915 */
 916
 917 /*
 918 FUNCTION
 919         bfd_get_reloc_upper_bound
 920
 921 SYNOPSIS
 922         long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
 923
 924 DESCRIPTION
 925         Return the number of bytes required to store the
 926         relocation information associated with section @var{sect}
 927         attached to bfd @var{abfd}.  If an error occurs, return -1.
 928
 929 */
 930
 931 long
 932 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
 933 {
 934   if (abfd->format != bfd_object)
 935     {
 936       bfd_set_error (bfd_error_invalid_operation);
 937       return -1;
 938     }
 939
 940   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
 941 }
 942
 943 /*
 944 FUNCTION
 945         bfd_canonicalize_reloc
 946
 947 SYNOPSIS
 948         long bfd_canonicalize_reloc
 949           (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
 950
 951 DESCRIPTION
 952         Call the back end associated with the open BFD
 953         @var{abfd} and translate the external form of the relocation
 954         information attached to @var{sec} into the internal canonical
 955         form.  Place the table into memory at @var{loc}, which has
 956         been preallocated, usually by a call to
 957         <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
 958         -1 on error.
 959
 960         The @var{syms} table is also needed for horrible internal magic
 961         reasons.
 962
 963 */
 964 long
 965 bfd_canonicalize_reloc (bfd *abfd,
 966                         sec_ptr asect,
 967                         arelent **location,
 968                         asymbol **symbols)
 969 {
 970   if (abfd->format != bfd_object)
 971     {
 972       bfd_set_error (bfd_error_invalid_operation);
 973       return -1;
 974     }
 975
 976   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
 977                    (abfd, asect, location, symbols));
 978 }
 979
 980 /*
 981 FUNCTION
 982         bfd_set_reloc
 983
 984 SYNOPSIS
 985         void bfd_set_reloc
 986           (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
 987
 988 DESCRIPTION
 989         Set the relocation pointer and count within
 990         section @var{sec} to the values @var{rel} and @var{count}.
 991         The argument @var{abfd} is ignored.
 992
 993 */
 994
 995 void
 996 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
 997                sec_ptr asect,
 998                arelent **location,
 999                unsigned int count)
1000 {
1001   asect->orelocation = location;
1002   asect->reloc_count = count;
1003 }
1004
1005 /*
1006 FUNCTION
1007         bfd_set_file_flags
1008
1009 SYNOPSIS
1010         bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
1011
1012 DESCRIPTION
1013         Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1014
1015         Possible errors are:
1016         o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1017         o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1018         o <<bfd_error_invalid_operation>> -
1019         The flag word contained a bit which was not applicable to the
1020         type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
1021         on a BFD format which does not support demand paging.
1022
1023 */
1024
1025 bfd_boolean
1026 bfd_set_file_flags (bfd *abfd, flagword flags)
1027 {
1028   if (abfd->format != bfd_object)
1029     {
1030       bfd_set_error (bfd_error_wrong_format);
1031       return FALSE;
1032     }
1033
1034   if (bfd_read_p (abfd))
1035     {
1036       bfd_set_error (bfd_error_invalid_operation);
1037       return FALSE;
1038     }
1039
1040   bfd_get_file_flags (abfd) = flags;
1041   if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1042     {
1043       bfd_set_error (bfd_error_invalid_operation);
1044       return FALSE;
1045     }
1046
1047   return TRUE;
1048 }
1049
1050 void
1051 bfd_assert (const char *file, int line)
1052 {
1053   (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1054                           BFD_VERSION_STRING, file, line);
1055 }
1056
1057 /* A more or less friendly abort message.  In libbfd.h abort is
1058    defined to call this function.  */
1059
1060 void
1061 _bfd_abort (const char *file, int line, const char *fn)
1062 {
1063   if (fn != NULL)
1064     (*_bfd_error_handler)
1065       (_("BFD %s internal error, aborting at %s line %d in %s\n"),
1066        BFD_VERSION_STRING, file, line, fn);
1067   else
1068     (*_bfd_error_handler)
1069       (_("BFD %s internal error, aborting at %s line %d\n"),
1070        BFD_VERSION_STRING, file, line);
1071   (*_bfd_error_handler) (_("Please report this bug.\n"));
1072   _exit (EXIT_FAILURE);
1073 }
1074
1075 /*
1076 FUNCTION
1077         bfd_get_arch_size
1078
1079 SYNOPSIS
1080         int bfd_get_arch_size (bfd *abfd);
1081
1082 DESCRIPTION
1083         Returns the normalized architecture address size, in bits, as
1084         determined by the object file's format.  By normalized, we mean
1085         either 32 or 64.  For ELF, this information is included in the
1086         header.  Use bfd_arch_bits_per_address for number of bits in
1087         the architecture address.
1088
1089 RETURNS
1090         Returns the arch size in bits if known, <<-1>> otherwise.
1091 */
1092
1093 int
1094 bfd_get_arch_size (bfd *abfd)
1095 {
1096   if (abfd->xvec->flavour == bfd_target_elf_flavour)
1097     return get_elf_backend_data (abfd)->s->arch_size;
1098
1099   return bfd_arch_bits_per_address (abfd) > 32 ? 64 : 32;
1100 }
1101
1102 /*
1103 FUNCTION
1104         bfd_get_sign_extend_vma
1105
1106 SYNOPSIS
1107         int bfd_get_sign_extend_vma (bfd *abfd);
1108
1109 DESCRIPTION
1110         Indicates if the target architecture "naturally" sign extends
1111         an address.  Some architectures implicitly sign extend address
1112         values when they are converted to types larger than the size
1113         of an address.  For instance, bfd_get_start_address() will
1114         return an address sign extended to fill a bfd_vma when this is
1115         the case.
1116
1117 RETURNS
1118         Returns <<1>> if the target architecture is known to sign
1119         extend addresses, <<0>> if the target architecture is known to
1120         not sign extend addresses, and <<-1>> otherwise.
1121 */
1122
1123 int
1124 bfd_get_sign_extend_vma (bfd *abfd)
1125 {
1126   char *name;
1127
1128   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1129     return get_elf_backend_data (abfd)->sign_extend_vma;
1130
1131   name = bfd_get_target (abfd);
1132
1133   /* Return a proper value for DJGPP & PE COFF.
1134      This function is required for DWARF2 support, but there is
1135      no place to store this information in the COFF back end.
1136      Should enough other COFF targets add support for DWARF2,
1137      a place will have to be found.  Until then, this hack will do.  */
1138   if (CONST_STRNEQ (name, "coff-go32")
1139       || strcmp (name, "pe-i386") == 0
1140       || strcmp (name, "pei-i386") == 0
1141       || strcmp (name, "pe-x86-64") == 0
1142       || strcmp (name, "pei-x86-64") == 0
1143       || strcmp (name, "pe-arm-wince-little") == 0
1144       || strcmp (name, "pei-arm-wince-little") == 0
1145       || strcmp (name, "aixcoff-rs6000") == 0)
1146     return 1;
1147
1148   if (CONST_STRNEQ (name, "mach-o"))
1149     return 0;
1150
1151   bfd_set_error (bfd_error_wrong_format);
1152   return -1;
1153 }
1154
1155 /*
1156 FUNCTION
1157         bfd_set_start_address
1158
1159 SYNOPSIS
1160         bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1161
1162 DESCRIPTION
1163         Make @var{vma} the entry point of output BFD @var{abfd}.
1164
1165 RETURNS
1166         Returns <<TRUE>> on success, <<FALSE>> otherwise.
1167 */
1168
1169 bfd_boolean
1170 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1171 {
1172   abfd->start_address = vma;
1173   return TRUE;
1174 }
1175
1176 /*
1177 FUNCTION
1178         bfd_get_gp_size
1179
1180 SYNOPSIS
1181         unsigned int bfd_get_gp_size (bfd *abfd);
1182
1183 DESCRIPTION
1184         Return the maximum size of objects to be optimized using the GP
1185         register under MIPS ECOFF.  This is typically set by the <<-G>>
1186         argument to the compiler, assembler or linker.
1187 */
1188
1189 unsigned int
1190 bfd_get_gp_size (bfd *abfd)
1191 {
1192   if (abfd->format == bfd_object)
1193     {
1194       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1195         return ecoff_data (abfd)->gp_size;
1196       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1197         return elf_gp_size (abfd);
1198     }
1199   return 0;
1200 }
1201
1202 /*
1203 FUNCTION
1204         bfd_set_gp_size
1205
1206 SYNOPSIS
1207         void bfd_set_gp_size (bfd *abfd, unsigned int i);
1208
1209 DESCRIPTION
1210         Set the maximum size of objects to be optimized using the GP
1211         register under ECOFF or MIPS ELF.  This is typically set by
1212         the <<-G>> argument to the compiler, assembler or linker.
1213 */
1214
1215 void
1216 bfd_set_gp_size (bfd *abfd, unsigned int i)
1217 {
1218   /* Don't try to set GP size on an archive or core file!  */
1219   if (abfd->format != bfd_object)
1220     return;
1221
1222   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1223     ecoff_data (abfd)->gp_size = i;
1224   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1225     elf_gp_size (abfd) = i;
1226 }
1227
1228 /* Get the GP value.  This is an internal function used by some of the
1229    relocation special_function routines on targets which support a GP
1230    register.  */
1231
1232 bfd_vma
1233 _bfd_get_gp_value (bfd *abfd)
1234 {
1235   if (! abfd)
1236     return 0;
1237   if (abfd->format != bfd_object)
1238     return 0;
1239
1240   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1241     return ecoff_data (abfd)->gp;
1242   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1243     return elf_gp (abfd);
1244
1245   return 0;
1246 }
1247
1248 /* Set the GP value.  */
1249
1250 void
1251 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1252 {
1253   if (! abfd)
1254     abort ();
1255   if (abfd->format != bfd_object)
1256     return;
1257
1258   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1259     ecoff_data (abfd)->gp = v;
1260   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1261     elf_gp (abfd) = v;
1262 }
1263
1264 /*
1265 FUNCTION
1266         bfd_scan_vma
1267
1268 SYNOPSIS
1269         bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1270
1271 DESCRIPTION
1272         Convert, like <<strtoul>>, a numerical expression
1273         @var{string} into a <<bfd_vma>> integer, and return that integer.
1274         (Though without as many bells and whistles as <<strtoul>>.)
1275         The expression is assumed to be unsigned (i.e., positive).
1276         If given a @var{base}, it is used as the base for conversion.
1277         A base of 0 causes the function to interpret the string
1278         in hex if a leading "0x" or "0X" is found, otherwise
1279         in octal if a leading zero is found, otherwise in decimal.
1280
1281         If the value would overflow, the maximum <<bfd_vma>> value is
1282         returned.
1283 */
1284
1285 bfd_vma
1286 bfd_scan_vma (const char *string, const char **end, int base)
1287 {
1288   bfd_vma value;
1289   bfd_vma cutoff;
1290   unsigned int cutlim;
1291   int overflow;
1292
1293   /* Let the host do it if possible.  */
1294   if (sizeof (bfd_vma) <= sizeof (unsigned long))
1295     return strtoul (string, (char **) end, base);
1296
1297 #ifdef HAVE_STRTOULL
1298   if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1299     return strtoull (string, (char **) end, base);
1300 #endif
1301
1302   if (base == 0)
1303     {
1304       if (string[0] == '0')
1305         {
1306           if ((string[1] == 'x') || (string[1] == 'X'))
1307             base = 16;
1308           else
1309             base = 8;
1310         }
1311     }
1312
1313   if ((base < 2) || (base > 36))
1314     base = 10;
1315
1316   if (base == 16
1317       && string[0] == '0'
1318       && (string[1] == 'x' || string[1] == 'X')
1319       && ISXDIGIT (string[2]))
1320     {
1321       string += 2;
1322     }
1323
1324   cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1325   cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1326   value = 0;
1327   overflow = 0;
1328   while (1)
1329     {
1330       unsigned int digit;
1331
1332       digit = *string;
1333       if (ISDIGIT (digit))
1334         digit = digit - '0';
1335       else if (ISALPHA (digit))
1336         digit = TOUPPER (digit) - 'A' + 10;
1337       else
1338         break;
1339       if (digit >= (unsigned int) base)
1340         break;
1341       if (value > cutoff || (value == cutoff && digit > cutlim))
1342         overflow = 1;
1343       value = value * base + digit;
1344       ++string;
1345     }
1346
1347   if (overflow)
1348     value = ~ (bfd_vma) 0;
1349
1350   if (end != NULL)
1351     *end = string;
1352
1353   return value;
1354 }
1355
1356 /*
1357 FUNCTION
1358         bfd_copy_private_header_data
1359
1360 SYNOPSIS
1361         bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1362
1363 DESCRIPTION
1364         Copy private BFD header information from the BFD @var{ibfd} to the
1365         the BFD @var{obfd}.  This copies information that may require
1366         sections to exist, but does not require symbol tables.  Return
1367         <<true>> on success, <<false>> on error.
1368         Possible error returns are:
1369
1370         o <<bfd_error_no_memory>> -
1371         Not enough memory exists to create private data for @var{obfd}.
1372
1373 .#define bfd_copy_private_header_data(ibfd, obfd) \
1374 .     BFD_SEND (obfd, _bfd_copy_private_header_data, \
1375 .               (ibfd, obfd))
1376
1377 */
1378
1379 /*
1380 FUNCTION
1381         bfd_copy_private_bfd_data
1382
1383 SYNOPSIS
1384         bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1385
1386 DESCRIPTION
1387         Copy private BFD information from the BFD @var{ibfd} to the
1388         the BFD @var{obfd}.  Return <<TRUE>> on success, <<FALSE>> on error.
1389         Possible error returns are:
1390
1391         o <<bfd_error_no_memory>> -
1392         Not enough memory exists to create private data for @var{obfd}.
1393
1394 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1395 .     BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1396 .               (ibfd, obfd))
1397
1398 */
1399
1400 /*
1401 FUNCTION
1402         bfd_merge_private_bfd_data
1403
1404 SYNOPSIS
1405         bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1406
1407 DESCRIPTION
1408         Merge private BFD information from the BFD @var{ibfd} to the
1409         the output file BFD @var{obfd} when linking.  Return <<TRUE>>
1410         on success, <<FALSE>> on error.  Possible error returns are:
1411
1412         o <<bfd_error_no_memory>> -
1413         Not enough memory exists to create private data for @var{obfd}.
1414
1415 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1416 .     BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1417 .               (ibfd, obfd))
1418
1419 */
1420
1421 /*
1422 FUNCTION
1423         bfd_set_private_flags
1424
1425 SYNOPSIS
1426         bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1427
1428 DESCRIPTION
1429         Set private BFD flag information in the BFD @var{abfd}.
1430         Return <<TRUE>> on success, <<FALSE>> on error.  Possible error
1431         returns are:
1432
1433         o <<bfd_error_no_memory>> -
1434         Not enough memory exists to create private data for @var{obfd}.
1435
1436 .#define bfd_set_private_flags(abfd, flags) \
1437 .     BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1438
1439 */
1440
1441 /*
1442 FUNCTION
1443         Other functions
1444
1445 DESCRIPTION
1446         The following functions exist but have not yet been documented.
1447
1448 .#define bfd_sizeof_headers(abfd, info) \
1449 .       BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1450 .
1451 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1452 .       BFD_SEND (abfd, _bfd_find_nearest_line, \
1453 .                 (abfd, sec, syms, off, file, func, line))
1454 .
1455 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
1456 .                                            line, disc) \
1457 .       BFD_SEND (abfd, _bfd_find_nearest_line_discriminator, \
1458 .                 (abfd, sec, syms, off, file, func, line, disc))
1459 .
1460 .#define bfd_find_line(abfd, syms, sym, file, line) \
1461 .       BFD_SEND (abfd, _bfd_find_line, \
1462 .                 (abfd, syms, sym, file, line))
1463 .
1464 .#define bfd_find_inliner_info(abfd, file, func, line) \
1465 .       BFD_SEND (abfd, _bfd_find_inliner_info, \
1466 .                 (abfd, file, func, line))
1467 .
1468 .#define bfd_debug_info_start(abfd) \
1469 .       BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1470 .
1471 .#define bfd_debug_info_end(abfd) \
1472 .       BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1473 .
1474 .#define bfd_debug_info_accumulate(abfd, section) \
1475 .       BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1476 .
1477 .#define bfd_stat_arch_elt(abfd, stat) \
1478 .       BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1479 .
1480 .#define bfd_update_armap_timestamp(abfd) \
1481 .       BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1482 .
1483 .#define bfd_set_arch_mach(abfd, arch, mach)\
1484 .       BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1485 .
1486 .#define bfd_relax_section(abfd, section, link_info, again) \
1487 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1488 .
1489 .#define bfd_gc_sections(abfd, link_info) \
1490 .       BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1491 .
1492 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
1493 .       BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
1494 .
1495 .#define bfd_merge_sections(abfd, link_info) \
1496 .       BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1497 .
1498 .#define bfd_is_group_section(abfd, sec) \
1499 .       BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1500 .
1501 .#define bfd_discard_group(abfd, sec) \
1502 .       BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1503 .
1504 .#define bfd_link_hash_table_create(abfd) \
1505 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1506 .
1507 .#define bfd_link_add_symbols(abfd, info) \
1508 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1509 .
1510 .#define bfd_link_just_syms(abfd, sec, info) \
1511 .       BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1512 .
1513 .#define bfd_final_link(abfd, info) \
1514 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1515 .
1516 .#define bfd_free_cached_info(abfd) \
1517 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1518 .
1519 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1520 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1521 .
1522 .#define bfd_print_private_bfd_data(abfd, file)\
1523 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1524 .
1525 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1526 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1527 .
1528 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1529 .       BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1530 .                                                   dyncount, dynsyms, ret))
1531 .
1532 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1533 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1534 .
1535 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1536 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1537 .
1538 .extern bfd_byte *bfd_get_relocated_section_contents
1539 .  (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1540 .   bfd_boolean, asymbol **);
1541 .
1542
1543 */
1544
1545 bfd_byte *
1546 bfd_get_relocated_section_contents (bfd *abfd,
1547                                     struct bfd_link_info *link_info,
1548                                     struct bfd_link_order *link_order,
1549                                     bfd_byte *data,
1550                                     bfd_boolean relocatable,
1551                                     asymbol **symbols)
1552 {
1553   bfd *abfd2;
1554   bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1555                    bfd_byte *, bfd_boolean, asymbol **);
1556
1557   if (link_order->type == bfd_indirect_link_order)
1558     {
1559       abfd2 = link_order->u.indirect.section->owner;
1560       if (abfd2 == NULL)
1561         abfd2 = abfd;
1562     }
1563   else
1564     abfd2 = abfd;
1565
1566   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1567
1568   return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1569 }
1570
1571 /* Record information about an ELF program header.  */
1572
1573 bfd_boolean
1574 bfd_record_phdr (bfd *abfd,
1575                  unsigned long type,
1576                  bfd_boolean flags_valid,
1577                  flagword flags,
1578                  bfd_boolean at_valid,
1579                  bfd_vma at,
1580                  bfd_boolean includes_filehdr,
1581                  bfd_boolean includes_phdrs,
1582                  unsigned int count,
1583                  asection **secs)
1584 {
1585   struct elf_segment_map *m, **pm;
1586   bfd_size_type amt;
1587
1588   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1589     return TRUE;
1590
1591   amt = sizeof (struct elf_segment_map);
1592   amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1593   m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
1594   if (m == NULL)
1595     return FALSE;
1596
1597   m->p_type = type;
1598   m->p_flags = flags;
1599   m->p_paddr = at;
1600   m->p_flags_valid = flags_valid;
1601   m->p_paddr_valid = at_valid;
1602   m->includes_filehdr = includes_filehdr;
1603   m->includes_phdrs = includes_phdrs;
1604   m->count = count;
1605   if (count > 0)
1606     memcpy (m->sections, secs, count * sizeof (asection *));
1607
1608   for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
1609     ;
1610   *pm = m;
1611
1612   return TRUE;
1613 }
1614
1615 #ifdef BFD64
1616 /* Return true iff this target is 32-bit.  */
1617
1618 static bfd_boolean
1619 is32bit (bfd *abfd)
1620 {
1621   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1622     {
1623       const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1624       return bed->s->elfclass == ELFCLASS32;
1625     }
1626
1627   /* For non-ELF targets, use architecture information.  */
1628   return bfd_arch_bits_per_address (abfd) <= 32;
1629 }
1630 #endif
1631
1632 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1633    target's address size.  */
1634
1635 void
1636 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1637 {
1638 #ifdef BFD64
1639   if (is32bit (abfd))
1640     {
1641       sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1642       return;
1643     }
1644 #endif
1645   sprintf_vma (buf, value);
1646 }
1647
1648 void
1649 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1650 {
1651 #ifdef BFD64
1652   if (is32bit (abfd))
1653     {
1654       fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1655       return;
1656     }
1657 #endif
1658   fprintf_vma ((FILE *) stream, value);
1659 }
1660
1661 /*
1662 FUNCTION
1663         bfd_alt_mach_code
1664
1665 SYNOPSIS
1666         bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1667
1668 DESCRIPTION
1669
1670         When more than one machine code number is available for the
1671         same machine type, this function can be used to switch between
1672         the preferred one (alternative == 0) and any others.  Currently,
1673         only ELF supports this feature, with up to two alternate
1674         machine codes.
1675 */
1676
1677 bfd_boolean
1678 bfd_alt_mach_code (bfd *abfd, int alternative)
1679 {
1680   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1681     {
1682       int code;
1683
1684       switch (alternative)
1685         {
1686         case 0:
1687           code = get_elf_backend_data (abfd)->elf_machine_code;
1688           break;
1689
1690         case 1:
1691           code = get_elf_backend_data (abfd)->elf_machine_alt1;
1692           if (code == 0)
1693             return FALSE;
1694           break;
1695
1696         case 2:
1697           code = get_elf_backend_data (abfd)->elf_machine_alt2;
1698           if (code == 0)
1699             return FALSE;
1700           break;
1701
1702         default:
1703           return FALSE;
1704         }
1705
1706       elf_elfheader (abfd)->e_machine = code;
1707
1708       return TRUE;
1709     }
1710
1711   return FALSE;
1712 }
1713
1714 /*
1715 FUNCTION
1716         bfd_emul_get_maxpagesize
1717
1718 SYNOPSIS
1719         bfd_vma bfd_emul_get_maxpagesize (const char *);
1720
1721 DESCRIPTION
1722         Returns the maximum page size, in bytes, as determined by
1723         emulation.
1724
1725 RETURNS
1726         Returns the maximum page size in bytes for ELF, 0 otherwise.
1727 */
1728
1729 bfd_vma
1730 bfd_emul_get_maxpagesize (const char *emul)
1731 {
1732   const bfd_target *target;
1733
1734   target = bfd_find_target (emul, NULL);
1735   if (target != NULL
1736       && target->flavour == bfd_target_elf_flavour)
1737     return xvec_get_elf_backend_data (target)->maxpagesize;
1738
1739   return 0;
1740 }
1741
1742 static void
1743 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1744                       int offset, const bfd_target *orig_target)
1745 {
1746   if (target->flavour == bfd_target_elf_flavour)
1747     {
1748       const struct elf_backend_data *bed;
1749
1750       bed = xvec_get_elf_backend_data (target);
1751       *((bfd_vma *) ((char *) bed + offset)) = size;
1752     }
1753
1754   if (target->alternative_target
1755       && target->alternative_target != orig_target)
1756     bfd_elf_set_pagesize (target->alternative_target, size, offset,
1757                           orig_target);
1758 }
1759
1760 /*
1761 FUNCTION
1762         bfd_emul_set_maxpagesize
1763
1764 SYNOPSIS
1765         void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1766
1767 DESCRIPTION
1768         For ELF, set the maximum page size for the emulation.  It is
1769         a no-op for other formats.
1770
1771 */
1772
1773 void
1774 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1775 {
1776   const bfd_target *target;
1777
1778   target = bfd_find_target (emul, NULL);
1779   if (target)
1780     bfd_elf_set_pagesize (target, size,
1781                           offsetof (struct elf_backend_data,
1782                                     maxpagesize), target);
1783 }
1784
1785 /*
1786 FUNCTION
1787         bfd_emul_get_commonpagesize
1788
1789 SYNOPSIS
1790         bfd_vma bfd_emul_get_commonpagesize (const char *);
1791
1792 DESCRIPTION
1793         Returns the common page size, in bytes, as determined by
1794         emulation.
1795
1796 RETURNS
1797         Returns the common page size in bytes for ELF, 0 otherwise.
1798 */
1799
1800 bfd_vma
1801 bfd_emul_get_commonpagesize (const char *emul)
1802 {
1803   const bfd_target *target;
1804
1805   target = bfd_find_target (emul, NULL);
1806   if (target != NULL
1807       && target->flavour == bfd_target_elf_flavour)
1808     return xvec_get_elf_backend_data (target)->commonpagesize;
1809
1810   return 0;
1811 }
1812
1813 /*
1814 FUNCTION
1815         bfd_emul_set_commonpagesize
1816
1817 SYNOPSIS
1818         void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1819
1820 DESCRIPTION
1821         For ELF, set the common page size for the emulation.  It is
1822         a no-op for other formats.
1823
1824 */
1825
1826 void
1827 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1828 {
1829   const bfd_target *target;
1830
1831   target = bfd_find_target (emul, NULL);
1832   if (target)
1833     bfd_elf_set_pagesize (target, size,
1834                           offsetof (struct elf_backend_data,
1835                                     commonpagesize), target);
1836 }
1837
1838 /*
1839 FUNCTION
1840         bfd_demangle
1841
1842 SYNOPSIS
1843         char *bfd_demangle (bfd *, const char *, int);
1844
1845 DESCRIPTION
1846         Wrapper around cplus_demangle.  Strips leading underscores and
1847         other such chars that would otherwise confuse the demangler.
1848         If passed a g++ v3 ABI mangled name, returns a buffer allocated
1849         with malloc holding the demangled name.  Returns NULL otherwise
1850         and on memory alloc failure.
1851 */
1852
1853 char *
1854 bfd_demangle (bfd *abfd, const char *name, int options)
1855 {
1856   char *res, *alloc;
1857   const char *pre, *suf;
1858   size_t pre_len;
1859   bfd_boolean skip_lead;
1860
1861   skip_lead = (abfd != NULL
1862                && *name != '\0'
1863                && bfd_get_symbol_leading_char (abfd) == *name);
1864   if (skip_lead)
1865     ++name;
1866
1867   /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1868      or the MS PE format.  These formats have a number of leading '.'s
1869      on at least some symbols, so we remove all dots to avoid
1870      confusing the demangler.  */
1871   pre = name;
1872   while (*name == '.' || *name == '$')
1873     ++name;
1874   pre_len = name - pre;
1875
1876   /* Strip off @plt and suchlike too.  */
1877   alloc = NULL;
1878   suf = strchr (name, '@');
1879   if (suf != NULL)
1880     {
1881       alloc = (char *) bfd_malloc (suf - name + 1);
1882       if (alloc == NULL)
1883         return NULL;
1884       memcpy (alloc, name, suf - name);
1885       alloc[suf - name] = '\0';
1886       name = alloc;
1887     }
1888
1889   res = cplus_demangle (name, options);
1890
1891   if (alloc != NULL)
1892     free (alloc);
1893
1894   if (res == NULL)
1895     {
1896       if (skip_lead)
1897         {
1898           size_t len = strlen (pre) + 1;
1899           alloc = (char *) bfd_malloc (len);
1900           if (alloc == NULL)
1901             return NULL;
1902           memcpy (alloc, pre, len);
1903           return alloc;
1904         }
1905       return NULL;
1906     }
1907
1908   /* Put back any prefix or suffix.  */
1909   if (pre_len != 0 || suf != NULL)
1910     {
1911       size_t len;
1912       size_t suf_len;
1913       char *final;
1914
1915       len = strlen (res);
1916       if (suf == NULL)
1917         suf = res + len;
1918       suf_len = strlen (suf) + 1;
1919       final = (char *) bfd_malloc (pre_len + len + suf_len);
1920       if (final != NULL)
1921         {
1922           memcpy (final, pre, pre_len);
1923           memcpy (final + pre_len, res, len);
1924           memcpy (final + pre_len + len, suf, suf_len);
1925         }
1926       free (res);
1927       res = final;
1928     }
1929
1930   return res;
1931 }