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