bfd/bfd.c

   1 /* Generic BFD library interface and support routines.
   2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   3    2000, 2001, 2002, 2003, 2004
   4    Free Software Foundation, Inc.
   5    Written by Cygnus Support.
   6
   7    This file is part of BFD, the Binary File Descriptor library.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  22
  23 /*
  24 SECTION
  25         <<typedef bfd>>
  26
  27         A BFD has type <<bfd>>; objects of this type are the
  28         cornerstone of any application using BFD. Using BFD
  29         consists of making references though the BFD and to data in the BFD.
  30
  31         Here is the structure that defines the type <<bfd>>.  It
  32         contains the major data about the file and pointers
  33         to the rest of the data.
  34
  35 CODE_FRAGMENT
  36 .
  37 .struct bfd
  38 .{
  39 .  {* A unique identifier of the BFD  *}
  40 .  unsigned int id;
  41 .
  42 .  {* The filename the application opened the BFD with.  *}
  43 .  const char *filename;
  44 .
  45 .  {* A pointer to the target jump table.  *}
  46 .  const struct bfd_target *xvec;
  47 .
  48 .  {* The IOSTREAM, and corresponding IO vector that provide access
  49 .     to the file backing the BFD.  *}
  50 .  void *iostream;
  51 .  const struct bfd_iovec *iovec;
  52 .
  53 .  {* Is the file descriptor being cached?  That is, can it be closed as
  54 .     needed, and re-opened when accessed later?  *}
  55 .  bfd_boolean cacheable;
  56 .
  57 .  {* Marks whether there was a default target specified when the
  58 .     BFD was opened. This is used to select which matching algorithm
  59 .     to use to choose the back end.  *}
  60 .  bfd_boolean target_defaulted;
  61 .
  62 .  {* The caching routines use these to maintain a
  63 .     least-recently-used list of BFDs.  *}
  64 .  struct bfd *lru_prev, *lru_next;
  65 .
  66 .  {* When a file is closed by the caching routines, BFD retains
  67 .     state information on the file here...  *}
  68 .  ufile_ptr where;
  69 .
  70 .  {* ... and here: (``once'' means at least once).  *}
  71 .  bfd_boolean opened_once;
  72 .
  73 .  {* Set if we have a locally maintained mtime value, rather than
  74 .     getting it from the file each time.  *}
  75 .  bfd_boolean mtime_set;
  76 .
  77 .  {* File modified time, if mtime_set is TRUE.  *}
  78 .  long mtime;
  79 .
  80 .  {* Reserved for an unimplemented file locking extension.  *}
  81 .  int ifd;
  82 .
  83 .  {* The format which belongs to the BFD. (object, core, etc.)  *}
  84 .  bfd_format format;
  85 .
  86 .  {* The direction with which the BFD was opened.  *}
  87 .  enum bfd_direction
  88 .    {
  89 .      no_direction = 0,
  90 .      read_direction = 1,
  91 .      write_direction = 2,
  92 .      both_direction = 3
  93 .    }
  94 .  direction;
  95 .
  96 .  {* Format_specific flags.  *}
  97 .  flagword flags;
  98 .
  99 .  {* Currently my_archive is tested before adding origin to
 100 .     anything. I believe that this can become always an add of
 101 .     origin, with origin set to 0 for non archive files.  *}
 102 .  ufile_ptr origin;
 103 .
 104 .  {* Remember when output has begun, to stop strange things
 105 .     from happening.  *}
 106 .  bfd_boolean output_has_begun;
 107 .
 108 .  {* A hash table for section names.  *}
 109 .  struct bfd_hash_table section_htab;
 110 .
 111 .  {* Pointer to linked list of sections.  *}
 112 .  struct bfd_section *sections;
 113 .
 114 .  {* The place where we add to the section list.  *}
 115 .  struct bfd_section **section_tail;
 116 .
 117 .  {* The number of sections.  *}
 118 .  unsigned int section_count;
 119 .
 120 .  {* Stuff only useful for object files:
 121 .     The start address.  *}
 122 .  bfd_vma start_address;
 123 .
 124 .  {* Used for input and output.  *}
 125 .  unsigned int symcount;
 126 .
 127 .  {* Symbol table for output BFD (with symcount entries).  *}
 128 .  struct bfd_symbol  **outsymbols;
 129 .
 130 .  {* Used for slurped dynamic symbol tables.  *}
 131 .  unsigned int dynsymcount;
 132 .
 133 .  {* Pointer to structure which contains architecture information.  *}
 134 .  const struct bfd_arch_info *arch_info;
 135 .
 136 .  {* Stuff only useful for archives.  *}
 137 .  void *arelt_data;
 138 .  struct bfd *my_archive;      {* The containing archive BFD.  *}
 139 .  struct bfd *next;            {* The next BFD in the archive.  *}
 140 .  struct bfd *archive_head;    {* The first BFD in the archive.  *}
 141 .  bfd_boolean has_armap;
 142 .
 143 .  {* A chain of BFD structures involved in a link.  *}
 144 .  struct bfd *link_next;
 145 .
 146 .  {* A field used by _bfd_generic_link_add_archive_symbols.  This will
 147 .     be used only for archive elements.  *}
 148 .  int archive_pass;
 149 .
 150 .  {* Used by the back end to hold private data.  *}
 151 .  union
 152 .    {
 153 .      struct aout_data_struct *aout_data;
 154 .      struct artdata *aout_ar_data;
 155 .      struct _oasys_data *oasys_obj_data;
 156 .      struct _oasys_ar_data *oasys_ar_data;
 157 .      struct coff_tdata *coff_obj_data;
 158 .      struct pe_tdata *pe_obj_data;
 159 .      struct xcoff_tdata *xcoff_obj_data;
 160 .      struct ecoff_tdata *ecoff_obj_data;
 161 .      struct ieee_data_struct *ieee_data;
 162 .      struct ieee_ar_data_struct *ieee_ar_data;
 163 .      struct srec_data_struct *srec_data;
 164 .      struct ihex_data_struct *ihex_data;
 165 .      struct tekhex_data_struct *tekhex_data;
 166 .      struct elf_obj_tdata *elf_obj_data;
 167 .      struct nlm_obj_tdata *nlm_obj_data;
 168 .      struct bout_data_struct *bout_data;
 169 .      struct mmo_data_struct *mmo_data;
 170 .      struct sun_core_struct *sun_core_data;
 171 .      struct sco5_core_struct *sco5_core_data;
 172 .      struct trad_core_struct *trad_core_data;
 173 .      struct som_data_struct *som_data;
 174 .      struct hpux_core_struct *hpux_core_data;
 175 .      struct hppabsd_core_struct *hppabsd_core_data;
 176 .      struct sgi_core_struct *sgi_core_data;
 177 .      struct lynx_core_struct *lynx_core_data;
 178 .      struct osf_core_struct *osf_core_data;
 179 .      struct cisco_core_struct *cisco_core_data;
 180 .      struct versados_data_struct *versados_data;
 181 .      struct netbsd_core_struct *netbsd_core_data;
 182 .      struct mach_o_data_struct *mach_o_data;
 183 .      struct mach_o_fat_data_struct *mach_o_fat_data;
 184 .      struct bfd_pef_data_struct *pef_data;
 185 .      struct bfd_pef_xlib_data_struct *pef_xlib_data;
 186 .      struct bfd_sym_data_struct *sym_data;
 187 .      void *any;
 188 .    }
 189 .  tdata;
 190 .
 191 .  {* Used by the application to hold private data.  *}
 192 .  void *usrdata;
 193 .
 194 .  {* Where all the allocated stuff under this BFD goes.  This is a
 195 .     struct objalloc *, but we use void * to avoid requiring the inclusion
 196 .     of objalloc.h.  *}
 197 .  void *memory;
 198 .};
 199 .
 200 */
 201
 202 #include "bfd.h"
 203 #include "bfdver.h"
 204 #include "sysdep.h"
 205 #include <stdarg.h>
 206 #include "libiberty.h"
 207 #include "safe-ctype.h"
 208 #include "bfdlink.h"
 209 #include "libbfd.h"
 210 #include "coff/internal.h"
 211 #include "coff/sym.h"
 212 #include "libcoff.h"
 213 #include "libecoff.h"
 214 #undef obj_symbols
 215 #include "elf-bfd.h"
 216 \f
 217 /* provide storage for subsystem, stack and heap data which may have been
 218    passed in on the command line.  Ld puts this data into a bfd_link_info
 219    struct which ultimately gets passed in to the bfd.  When it arrives, copy
 220    it to the following struct so that the data will be available in coffcode.h
 221    where it is needed.  The typedef's used are defined in bfd.h */
 222 \f
 223 /*
 224 SECTION
 225         Error reporting
 226
 227         Most BFD functions return nonzero on success (check their
 228         individual documentation for precise semantics).  On an error,
 229         they call <<bfd_set_error>> to set an error condition that callers
 230         can check by calling <<bfd_get_error>>.
 231         If that returns <<bfd_error_system_call>>, then check
 232         <<errno>>.
 233
 234         The easiest way to report a BFD error to the user is to
 235         use <<bfd_perror>>.
 236
 237 SUBSECTION
 238         Type <<bfd_error_type>>
 239
 240         The values returned by <<bfd_get_error>> are defined by the
 241         enumerated type <<bfd_error_type>>.
 242
 243 CODE_FRAGMENT
 244 .
 245 .typedef enum bfd_error
 246 .{
 247 .  bfd_error_no_error = 0,
 248 .  bfd_error_system_call,
 249 .  bfd_error_invalid_target,
 250 .  bfd_error_wrong_format,
 251 .  bfd_error_wrong_object_format,
 252 .  bfd_error_invalid_operation,
 253 .  bfd_error_no_memory,
 254 .  bfd_error_no_symbols,
 255 .  bfd_error_no_armap,
 256 .  bfd_error_no_more_archived_files,
 257 .  bfd_error_malformed_archive,
 258 .  bfd_error_file_not_recognized,
 259 .  bfd_error_file_ambiguously_recognized,
 260 .  bfd_error_no_contents,
 261 .  bfd_error_nonrepresentable_section,
 262 .  bfd_error_no_debug_section,
 263 .  bfd_error_bad_value,
 264 .  bfd_error_file_truncated,
 265 .  bfd_error_file_too_big,
 266 .  bfd_error_invalid_error_code
 267 .}
 268 .bfd_error_type;
 269 .
 270 */
 271
 272 static bfd_error_type bfd_error = bfd_error_no_error;
 273
 274 const char *const bfd_errmsgs[] =
 275 {
 276   N_("No error"),
 277   N_("System call error"),
 278   N_("Invalid bfd target"),
 279   N_("File in wrong format"),
 280   N_("Archive object file in wrong format"),
 281   N_("Invalid operation"),
 282   N_("Memory exhausted"),
 283   N_("No symbols"),
 284   N_("Archive has no index; run ranlib to add one"),
 285   N_("No more archived files"),
 286   N_("Malformed archive"),
 287   N_("File format not recognized"),
 288   N_("File format is ambiguous"),
 289   N_("Section has no contents"),
 290   N_("Nonrepresentable section on output"),
 291   N_("Symbol needs debug section which does not exist"),
 292   N_("Bad value"),
 293   N_("File truncated"),
 294   N_("File too big"),
 295   N_("#<Invalid error code>")
 296 };
 297
 298 /*
 299 FUNCTION
 300         bfd_get_error
 301
 302 SYNOPSIS
 303         bfd_error_type bfd_get_error (void);
 304
 305 DESCRIPTION
 306         Return the current BFD error condition.
 307 */
 308
 309 bfd_error_type
 310 bfd_get_error (void)
 311 {
 312   return bfd_error;
 313 }
 314
 315 /*
 316 FUNCTION
 317         bfd_set_error
 318
 319 SYNOPSIS
 320         void bfd_set_error (bfd_error_type error_tag);
 321
 322 DESCRIPTION
 323         Set the BFD error condition to be @var{error_tag}.
 324 */
 325
 326 void
 327 bfd_set_error (bfd_error_type error_tag)
 328 {
 329   bfd_error = error_tag;
 330 }
 331
 332 /*
 333 FUNCTION
 334         bfd_errmsg
 335
 336 SYNOPSIS
 337         const char *bfd_errmsg (bfd_error_type error_tag);
 338
 339 DESCRIPTION
 340         Return a string describing the error @var{error_tag}, or
 341         the system error if @var{error_tag} is <<bfd_error_system_call>>.
 342 */
 343
 344 const char *
 345 bfd_errmsg (bfd_error_type error_tag)
 346 {
 347 #ifndef errno
 348   extern int errno;
 349 #endif
 350   if (error_tag == bfd_error_system_call)
 351     return xstrerror (errno);
 352
 353   if (error_tag > bfd_error_invalid_error_code)
 354     error_tag = bfd_error_invalid_error_code;   /* sanity check */
 355
 356   return _(bfd_errmsgs [error_tag]);
 357 }
 358
 359 /*
 360 FUNCTION
 361         bfd_perror
 362
 363 SYNOPSIS
 364         void bfd_perror (const char *message);
 365
 366 DESCRIPTION
 367         Print to the standard error stream a string describing the
 368         last BFD error that occurred, or the last system error if
 369         the last BFD error was a system call failure.  If @var{message}
 370         is non-NULL and non-empty, the error string printed is preceded
 371         by @var{message}, a colon, and a space.  It is followed by a newline.
 372 */
 373
 374 void
 375 bfd_perror (const char *message)
 376 {
 377   if (bfd_get_error () == bfd_error_system_call)
 378     /* Must be a system error then.  */
 379     perror ((char *) message);
 380   else
 381     {
 382       if (message == NULL || *message == '\0')
 383         fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
 384       else
 385         fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
 386     }
 387 }
 388
 389 /*
 390 SUBSECTION
 391         BFD error handler
 392
 393         Some BFD functions want to print messages describing the
 394         problem.  They call a BFD error handler function.  This
 395         function may be overridden by the program.
 396
 397         The BFD error handler acts like printf.
 398
 399 CODE_FRAGMENT
 400 .
 401 .typedef void (*bfd_error_handler_type) (const char *, ...);
 402 .
 403 */
 404
 405 /* The program name used when printing BFD error messages.  */
 406
 407 static const char *_bfd_error_program_name;
 408
 409 /* This is the default routine to handle BFD error messages.  */
 410
 411 static void
 412 _bfd_default_error_handler (const char *s, ...)
 413 {
 414   va_list p;
 415
 416   if (_bfd_error_program_name != NULL)
 417     fprintf (stderr, "%s: ", _bfd_error_program_name);
 418   else
 419     fprintf (stderr, "BFD: ");
 420
 421   va_start (p, s);
 422   vfprintf (stderr, s, p);
 423   va_end (p);
 424
 425   fprintf (stderr, "\n");
 426 }
 427
 428 /* This is a function pointer to the routine which should handle BFD
 429    error messages.  It is called when a BFD routine encounters an
 430    error for which it wants to print a message.  Going through a
 431    function pointer permits a program linked against BFD to intercept
 432    the messages and deal with them itself.  */
 433
 434 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
 435
 436 /*
 437 FUNCTION
 438         bfd_set_error_handler
 439
 440 SYNOPSIS
 441         bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
 442
 443 DESCRIPTION
 444         Set the BFD error handler function.  Returns the previous
 445         function.
 446 */
 447
 448 bfd_error_handler_type
 449 bfd_set_error_handler (bfd_error_handler_type pnew)
 450 {
 451   bfd_error_handler_type pold;
 452
 453   pold = _bfd_error_handler;
 454   _bfd_error_handler = pnew;
 455   return pold;
 456 }
 457
 458 /*
 459 FUNCTION
 460         bfd_set_error_program_name
 461
 462 SYNOPSIS
 463         void bfd_set_error_program_name (const char *);
 464
 465 DESCRIPTION
 466         Set the program name to use when printing a BFD error.  This
 467         is printed before the error message followed by a colon and
 468         space.  The string must not be changed after it is passed to
 469         this function.
 470 */
 471
 472 void
 473 bfd_set_error_program_name (const char *name)
 474 {
 475   _bfd_error_program_name = name;
 476 }
 477
 478 /*
 479 FUNCTION
 480         bfd_get_error_handler
 481
 482 SYNOPSIS
 483         bfd_error_handler_type bfd_get_error_handler (void);
 484
 485 DESCRIPTION
 486         Return the BFD error handler function.
 487 */
 488
 489 bfd_error_handler_type
 490 bfd_get_error_handler (void)
 491 {
 492   return _bfd_error_handler;
 493 }
 494
 495 /*
 496 FUNCTION
 497         bfd_archive_filename
 498
 499 SYNOPSIS
 500         const char *bfd_archive_filename (bfd *);
 501
 502 DESCRIPTION
 503         For a BFD that is a component of an archive, returns a string
 504         with both the archive name and file name.  For other BFDs, just
 505         returns the file name.
 506 */
 507
 508 const char *
 509 bfd_archive_filename (bfd *abfd)
 510 {
 511   if (abfd == NULL)
 512     return NULL;
 513
 514   if (abfd->my_archive)
 515     {
 516       static size_t curr = 0;
 517       static char *buf;
 518       size_t needed;
 519
 520       needed = (strlen (bfd_get_filename (abfd->my_archive))
 521                 + strlen (bfd_get_filename (abfd)) + 3);
 522       if (needed > curr)
 523         {
 524           if (curr)
 525             free (buf);
 526           curr = needed + (needed >> 1);
 527           buf = bfd_malloc (curr);
 528           /* If we can't malloc, fail safe by returning just the file
 529              name. This function is only used when building error
 530              messages.  */
 531           if (!buf)
 532             {
 533               curr = 0;
 534               return bfd_get_filename (abfd);
 535             }
 536         }
 537       sprintf (buf, "%s(%s)", bfd_get_filename (abfd->my_archive),
 538                bfd_get_filename (abfd));
 539       return buf;
 540     }
 541   else
 542     return bfd_get_filename (abfd);
 543 }
 544 \f
 545 /*
 546 SECTION
 547         Symbols
 548 */
 549
 550 /*
 551 FUNCTION
 552         bfd_get_reloc_upper_bound
 553
 554 SYNOPSIS
 555         long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
 556
 557 DESCRIPTION
 558         Return the number of bytes required to store the
 559         relocation information associated with section @var{sect}
 560         attached to bfd @var{abfd}.  If an error occurs, return -1.
 561
 562 */
 563
 564 long
 565 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
 566 {
 567   if (abfd->format != bfd_object)
 568     {
 569       bfd_set_error (bfd_error_invalid_operation);
 570       return -1;
 571     }
 572
 573   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
 574 }
 575
 576 /*
 577 FUNCTION
 578         bfd_canonicalize_reloc
 579
 580 SYNOPSIS
 581         long bfd_canonicalize_reloc
 582           (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
 583
 584 DESCRIPTION
 585         Call the back end associated with the open BFD
 586         @var{abfd} and translate the external form of the relocation
 587         information attached to @var{sec} into the internal canonical
 588         form.  Place the table into memory at @var{loc}, which has
 589         been preallocated, usually by a call to
 590         <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
 591         -1 on error.
 592
 593         The @var{syms} table is also needed for horrible internal magic
 594         reasons.
 595
 596 */
 597 long
 598 bfd_canonicalize_reloc (bfd *abfd,
 599                         sec_ptr asect,
 600                         arelent **location,
 601                         asymbol **symbols)
 602 {
 603   if (abfd->format != bfd_object)
 604     {
 605       bfd_set_error (bfd_error_invalid_operation);
 606       return -1;
 607     }
 608
 609   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
 610                    (abfd, asect, location, symbols));
 611 }
 612
 613 /*
 614 FUNCTION
 615         bfd_set_reloc
 616
 617 SYNOPSIS
 618         void bfd_set_reloc
 619           (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
 620
 621 DESCRIPTION
 622         Set the relocation pointer and count within
 623         section @var{sec} to the values @var{rel} and @var{count}.
 624         The argument @var{abfd} is ignored.
 625
 626 */
 627
 628 void
 629 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
 630                sec_ptr asect,
 631                arelent **location,
 632                unsigned int count)
 633 {
 634   asect->orelocation = location;
 635   asect->reloc_count = count;
 636 }
 637
 638 /*
 639 FUNCTION
 640         bfd_set_file_flags
 641
 642 SYNOPSIS
 643         bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
 644
 645 DESCRIPTION
 646         Set the flag word in the BFD @var{abfd} to the value @var{flags}.
 647
 648         Possible errors are:
 649         o <<bfd_error_wrong_format>> - The target bfd was not of object format.
 650         o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
 651         o <<bfd_error_invalid_operation>> -
 652         The flag word contained a bit which was not applicable to the
 653         type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
 654         on a BFD format which does not support demand paging.
 655
 656 */
 657
 658 bfd_boolean
 659 bfd_set_file_flags (bfd *abfd, flagword flags)
 660 {
 661   if (abfd->format != bfd_object)
 662     {
 663       bfd_set_error (bfd_error_wrong_format);
 664       return FALSE;
 665     }
 666
 667   if (bfd_read_p (abfd))
 668     {
 669       bfd_set_error (bfd_error_invalid_operation);
 670       return FALSE;
 671     }
 672
 673   bfd_get_file_flags (abfd) = flags;
 674   if ((flags & bfd_applicable_file_flags (abfd)) != flags)
 675     {
 676       bfd_set_error (bfd_error_invalid_operation);
 677       return FALSE;
 678     }
 679
 680   return TRUE;
 681 }
 682
 683 void
 684 bfd_assert (const char *file, int line)
 685 {
 686   (*_bfd_error_handler) (_("BFD %s assertion fail %s:%d"),
 687                          BFD_VERSION_STRING, file, line);
 688 }
 689
 690 /* A more or less friendly abort message.  In libbfd.h abort is
 691    defined to call this function.  */
 692
 693 #ifndef EXIT_FAILURE
 694 #define EXIT_FAILURE 1
 695 #endif
 696
 697 void
 698 _bfd_abort (const char *file, int line, const char *fn)
 699 {
 700   if (fn != NULL)
 701     (*_bfd_error_handler)
 702       (_("BFD %s internal error, aborting at %s line %d in %s\n"),
 703        BFD_VERSION_STRING, file, line, fn);
 704   else
 705     (*_bfd_error_handler)
 706       (_("BFD %s internal error, aborting at %s line %d\n"),
 707        BFD_VERSION_STRING, file, line);
 708   (*_bfd_error_handler) (_("Please report this bug.\n"));
 709   xexit (EXIT_FAILURE);
 710 }
 711
 712 /*
 713 FUNCTION
 714         bfd_get_arch_size
 715
 716 SYNOPSIS
 717         int bfd_get_arch_size (bfd *abfd);
 718
 719 DESCRIPTION
 720         Returns the architecture address size, in bits, as determined
 721         by the object file's format.  For ELF, this information is
 722         included in the header.
 723
 724 RETURNS
 725         Returns the arch size in bits if known, <<-1>> otherwise.
 726 */
 727
 728 int
 729 bfd_get_arch_size (bfd *abfd)
 730 {
 731   if (abfd->xvec->flavour == bfd_target_elf_flavour)
 732     return get_elf_backend_data (abfd)->s->arch_size;
 733
 734   return -1;
 735 }
 736
 737 /*
 738 FUNCTION
 739         bfd_get_sign_extend_vma
 740
 741 SYNOPSIS
 742         int bfd_get_sign_extend_vma (bfd *abfd);
 743
 744 DESCRIPTION
 745         Indicates if the target architecture "naturally" sign extends
 746         an address.  Some architectures implicitly sign extend address
 747         values when they are converted to types larger than the size
 748         of an address.  For instance, bfd_get_start_address() will
 749         return an address sign extended to fill a bfd_vma when this is
 750         the case.
 751
 752 RETURNS
 753         Returns <<1>> if the target architecture is known to sign
 754         extend addresses, <<0>> if the target architecture is known to
 755         not sign extend addresses, and <<-1>> otherwise.
 756 */
 757
 758 int
 759 bfd_get_sign_extend_vma (bfd *abfd)
 760 {
 761   char *name;
 762
 763   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
 764     return get_elf_backend_data (abfd)->sign_extend_vma;
 765
 766   name = bfd_get_target (abfd);
 767
 768   /* Return a proper value for DJGPP & PE COFF (x86 COFF variants).
 769      This function is required for DWARF2 support, but there is
 770      no place to store this information in the COFF back end.
 771      Should enough other COFF targets add support for DWARF2,
 772      a place will have to be found.  Until then, this hack will do.  */
 773   if (strncmp (name, "coff-go32", sizeof ("coff-go32") - 1) == 0
 774       || strcmp (name, "pe-i386") == 0
 775       || strcmp (name, "pei-i386") == 0)
 776     return 1;
 777
 778   bfd_set_error (bfd_error_wrong_format);
 779   return -1;
 780 }
 781
 782 /*
 783 FUNCTION
 784         bfd_set_start_address
 785
 786 SYNOPSIS
 787         bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
 788
 789 DESCRIPTION
 790         Make @var{vma} the entry point of output BFD @var{abfd}.
 791
 792 RETURNS
 793         Returns <<TRUE>> on success, <<FALSE>> otherwise.
 794 */
 795
 796 bfd_boolean
 797 bfd_set_start_address (bfd *abfd, bfd_vma vma)
 798 {
 799   abfd->start_address = vma;
 800   return TRUE;
 801 }
 802
 803 /*
 804 FUNCTION
 805         bfd_get_gp_size
 806
 807 SYNOPSIS
 808         unsigned int bfd_get_gp_size (bfd *abfd);
 809
 810 DESCRIPTION
 811         Return the maximum size of objects to be optimized using the GP
 812         register under MIPS ECOFF.  This is typically set by the <<-G>>
 813         argument to the compiler, assembler or linker.
 814 */
 815
 816 unsigned int
 817 bfd_get_gp_size (bfd *abfd)
 818 {
 819   if (abfd->format == bfd_object)
 820     {
 821       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 822         return ecoff_data (abfd)->gp_size;
 823       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 824         return elf_gp_size (abfd);
 825     }
 826   return 0;
 827 }
 828
 829 /*
 830 FUNCTION
 831         bfd_set_gp_size
 832
 833 SYNOPSIS
 834         void bfd_set_gp_size (bfd *abfd, unsigned int i);
 835
 836 DESCRIPTION
 837         Set the maximum size of objects to be optimized using the GP
 838         register under ECOFF or MIPS ELF.  This is typically set by
 839         the <<-G>> argument to the compiler, assembler or linker.
 840 */
 841
 842 void
 843 bfd_set_gp_size (bfd *abfd, unsigned int i)
 844 {
 845   /* Don't try to set GP size on an archive or core file!  */
 846   if (abfd->format != bfd_object)
 847     return;
 848
 849   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 850     ecoff_data (abfd)->gp_size = i;
 851   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 852     elf_gp_size (abfd) = i;
 853 }
 854
 855 /* Get the GP value.  This is an internal function used by some of the
 856    relocation special_function routines on targets which support a GP
 857    register.  */
 858
 859 bfd_vma
 860 _bfd_get_gp_value (bfd *abfd)
 861 {
 862   if (! abfd)
 863     return 0;
 864   if (abfd->format != bfd_object)
 865     return 0;
 866
 867   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 868     return ecoff_data (abfd)->gp;
 869   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 870     return elf_gp (abfd);
 871
 872   return 0;
 873 }
 874
 875 /* Set the GP value.  */
 876
 877 void
 878 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
 879 {
 880   if (! abfd)
 881     BFD_FAIL ();
 882   if (abfd->format != bfd_object)
 883     return;
 884
 885   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 886     ecoff_data (abfd)->gp = v;
 887   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 888     elf_gp (abfd) = v;
 889 }
 890
 891 /*
 892 FUNCTION
 893         bfd_scan_vma
 894
 895 SYNOPSIS
 896         bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
 897
 898 DESCRIPTION
 899         Convert, like <<strtoul>>, a numerical expression
 900         @var{string} into a <<bfd_vma>> integer, and return that integer.
 901         (Though without as many bells and whistles as <<strtoul>>.)
 902         The expression is assumed to be unsigned (i.e., positive).
 903         If given a @var{base}, it is used as the base for conversion.
 904         A base of 0 causes the function to interpret the string
 905         in hex if a leading "0x" or "0X" is found, otherwise
 906         in octal if a leading zero is found, otherwise in decimal.
 907
 908         If the value would overflow, the maximum <<bfd_vma>> value is
 909         returned.
 910 */
 911
 912 bfd_vma
 913 bfd_scan_vma (const char *string, const char **end, int base)
 914 {
 915   bfd_vma value;
 916   bfd_vma cutoff;
 917   unsigned int cutlim;
 918   int overflow;
 919
 920   /* Let the host do it if possible.  */
 921   if (sizeof (bfd_vma) <= sizeof (unsigned long))
 922     return strtoul (string, (char **) end, base);
 923
 924 #ifdef HAVE_STRTOULL
 925   if (sizeof (bfd_vma) <= sizeof (unsigned long long))
 926     return strtoull (string, (char **) end, base);
 927 #endif
 928
 929   if (base == 0)
 930     {
 931       if (string[0] == '0')
 932         {
 933           if ((string[1] == 'x') || (string[1] == 'X'))
 934             base = 16;
 935           else
 936             base = 8;
 937         }
 938     }
 939
 940   if ((base < 2) || (base > 36))
 941     base = 10;
 942
 943   if (base == 16
 944       && string[0] == '0'
 945       && (string[1] == 'x' || string[1] == 'X')
 946       && ISXDIGIT (string[2]))
 947     {
 948       string += 2;
 949     }
 950
 951   cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
 952   cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
 953   value = 0;
 954   overflow = 0;
 955   while (1)
 956     {
 957       unsigned int digit;
 958
 959       digit = *string;
 960       if (ISDIGIT (digit))
 961         digit = digit - '0';
 962       else if (ISALPHA (digit))
 963         digit = TOUPPER (digit) - 'A' + 10;
 964       else
 965         break;
 966       if (digit >= (unsigned int) base)
 967         break;
 968       if (value > cutoff || (value == cutoff && digit > cutlim))
 969         overflow = 1;
 970       value = value * base + digit;
 971       ++string;
 972     }
 973
 974   if (overflow)
 975     value = ~ (bfd_vma) 0;
 976
 977   if (end != NULL)
 978     *end = string;
 979
 980   return value;
 981 }
 982
 983 /*
 984 FUNCTION
 985         bfd_copy_private_bfd_data
 986
 987 SYNOPSIS
 988         bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
 989
 990 DESCRIPTION
 991         Copy private BFD information from the BFD @var{ibfd} to the
 992         the BFD @var{obfd}.  Return <<TRUE>> on success, <<FALSE>> on error.
 993         Possible error returns are:
 994
 995         o <<bfd_error_no_memory>> -
 996         Not enough memory exists to create private data for @var{obfd}.
 997
 998 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
 999 .     BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1000 .               (ibfd, obfd))
1001
1002 */
1003
1004 /*
1005 FUNCTION
1006         bfd_merge_private_bfd_data
1007
1008 SYNOPSIS
1009         bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1010
1011 DESCRIPTION
1012         Merge private BFD information from the BFD @var{ibfd} to the
1013         the output file BFD @var{obfd} when linking.  Return <<TRUE>>
1014         on success, <<FALSE>> on error.  Possible error returns are:
1015
1016         o <<bfd_error_no_memory>> -
1017         Not enough memory exists to create private data for @var{obfd}.
1018
1019 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1020 .     BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1021 .               (ibfd, obfd))
1022
1023 */
1024
1025 /*
1026 FUNCTION
1027         bfd_set_private_flags
1028
1029 SYNOPSIS
1030         bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1031
1032 DESCRIPTION
1033         Set private BFD flag information in the BFD @var{abfd}.
1034         Return <<TRUE>> on success, <<FALSE>> on error.  Possible error
1035         returns are:
1036
1037         o <<bfd_error_no_memory>> -
1038         Not enough memory exists to create private data for @var{obfd}.
1039
1040 .#define bfd_set_private_flags(abfd, flags) \
1041 .     BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1042
1043 */
1044
1045 /*
1046 FUNCTION
1047         Other functions
1048
1049 DESCRIPTION
1050         The following functions exist but have not yet been documented.
1051
1052 .#define bfd_sizeof_headers(abfd, reloc) \
1053 .       BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1054 .
1055 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1056 .       BFD_SEND (abfd, _bfd_find_nearest_line, \
1057 .                 (abfd, sec, syms, off, file, func, line))
1058 .
1059 .#define bfd_debug_info_start(abfd) \
1060 .       BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1061 .
1062 .#define bfd_debug_info_end(abfd) \
1063 .       BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1064 .
1065 .#define bfd_debug_info_accumulate(abfd, section) \
1066 .       BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1067 .
1068 .#define bfd_stat_arch_elt(abfd, stat) \
1069 .       BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1070 .
1071 .#define bfd_update_armap_timestamp(abfd) \
1072 .       BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1073 .
1074 .#define bfd_set_arch_mach(abfd, arch, mach)\
1075 .       BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1076 .
1077 .#define bfd_relax_section(abfd, section, link_info, again) \
1078 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1079 .
1080 .#define bfd_gc_sections(abfd, link_info) \
1081 .       BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1082 .
1083 .#define bfd_merge_sections(abfd, link_info) \
1084 .       BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1085 .
1086 .#define bfd_discard_group(abfd, sec) \
1087 .       BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1088 .
1089 .#define bfd_link_hash_table_create(abfd) \
1090 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1091 .
1092 .#define bfd_link_hash_table_free(abfd, hash) \
1093 .       BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1094 .
1095 .#define bfd_link_add_symbols(abfd, info) \
1096 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1097 .
1098 .#define bfd_link_just_syms(sec, info) \
1099 .       BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1100 .
1101 .#define bfd_final_link(abfd, info) \
1102 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1103 .
1104 .#define bfd_free_cached_info(abfd) \
1105 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1106 .
1107 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1108 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1109 .
1110 .#define bfd_print_private_bfd_data(abfd, file)\
1111 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1112 .
1113 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1114 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1115 .
1116 .#define bfd_get_synthetic_symtab(abfd, dynsyms, ret) \
1117 .       BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, dynsyms, ret))
1118 .
1119 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1120 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1121 .
1122 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1123 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1124 .
1125 .extern bfd_byte *bfd_get_relocated_section_contents
1126 .  (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1127 .   bfd_boolean, asymbol **);
1128 .
1129
1130 */
1131
1132 bfd_byte *
1133 bfd_get_relocated_section_contents (bfd *abfd,
1134                                     struct bfd_link_info *link_info,
1135                                     struct bfd_link_order *link_order,
1136                                     bfd_byte *data,
1137                                     bfd_boolean relocatable,
1138                                     asymbol **symbols)
1139 {
1140   bfd *abfd2;
1141   bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1142                    bfd_byte *, bfd_boolean, asymbol **);
1143
1144   if (link_order->type == bfd_indirect_link_order)
1145     {
1146       abfd2 = link_order->u.indirect.section->owner;
1147       if (abfd2 == NULL)
1148         abfd2 = abfd;
1149     }
1150   else
1151     abfd2 = abfd;
1152
1153   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1154
1155   return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1156 }
1157
1158 /* Record information about an ELF program header.  */
1159
1160 bfd_boolean
1161 bfd_record_phdr (bfd *abfd,
1162                  unsigned long type,
1163                  bfd_boolean flags_valid,
1164                  flagword flags,
1165                  bfd_boolean at_valid,
1166                  bfd_vma at,
1167                  bfd_boolean includes_filehdr,
1168                  bfd_boolean includes_phdrs,
1169                  unsigned int count,
1170                  asection **secs)
1171 {
1172   struct elf_segment_map *m, **pm;
1173   bfd_size_type amt;
1174
1175   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1176     return TRUE;
1177
1178   amt = sizeof (struct elf_segment_map);
1179   amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1180   m = bfd_alloc (abfd, amt);
1181   if (m == NULL)
1182     return FALSE;
1183
1184   m->next = NULL;
1185   m->p_type = type;
1186   m->p_flags = flags;
1187   m->p_paddr = at;
1188   m->p_flags_valid = flags_valid;
1189   m->p_paddr_valid = at_valid;
1190   m->includes_filehdr = includes_filehdr;
1191   m->includes_phdrs = includes_phdrs;
1192   m->count = count;
1193   if (count > 0)
1194     memcpy (m->sections, secs, count * sizeof (asection *));
1195
1196   for (pm = &elf_tdata (abfd)->segment_map; *pm != NULL; pm = &(*pm)->next)
1197     ;
1198   *pm = m;
1199
1200   return TRUE;
1201 }
1202
1203 void
1204 bfd_sprintf_vma (bfd *abfd, char *buf, bfd_vma value)
1205 {
1206   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1207     get_elf_backend_data (abfd)->elf_backend_sprintf_vma (abfd, buf, value);
1208   else
1209     sprintf_vma (buf, value);
1210 }
1211
1212 void
1213 bfd_fprintf_vma (bfd *abfd, void *stream, bfd_vma value)
1214 {
1215   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1216     get_elf_backend_data (abfd)->elf_backend_fprintf_vma (abfd, stream, value);
1217   else
1218     fprintf_vma ((FILE *) stream, value);
1219 }
1220
1221 /*
1222 FUNCTION
1223         bfd_alt_mach_code
1224
1225 SYNOPSIS
1226         bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1227
1228 DESCRIPTION
1229
1230         When more than one machine code number is available for the
1231         same machine type, this function can be used to switch between
1232         the preferred one (alternative == 0) and any others.  Currently,
1233         only ELF supports this feature, with up to two alternate
1234         machine codes.
1235 */
1236
1237 bfd_boolean
1238 bfd_alt_mach_code (bfd *abfd, int alternative)
1239 {
1240   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1241     {
1242       int code;
1243
1244       switch (alternative)
1245         {
1246         case 0:
1247           code = get_elf_backend_data (abfd)->elf_machine_code;
1248           break;
1249
1250         case 1:
1251           code = get_elf_backend_data (abfd)->elf_machine_alt1;
1252           if (code == 0)
1253             return FALSE;
1254           break;
1255
1256         case 2:
1257           code = get_elf_backend_data (abfd)->elf_machine_alt2;
1258           if (code == 0)
1259             return FALSE;
1260           break;
1261
1262         default:
1263           return FALSE;
1264         }
1265
1266       elf_elfheader (abfd)->e_machine = code;
1267
1268       return TRUE;
1269     }
1270
1271   return FALSE;
1272 }
1273
1274 /*
1275 CODE_FRAGMENT
1276
1277 .struct bfd_preserve
1278 .{
1279 .  void *marker;
1280 .  void *tdata;
1281 .  flagword flags;
1282 .  const struct bfd_arch_info *arch_info;
1283 .  struct bfd_section *sections;
1284 .  struct bfd_section **section_tail;
1285 .  unsigned int section_count;
1286 .  struct bfd_hash_table section_htab;
1287 .};
1288 .
1289 */
1290
1291 /*
1292 FUNCTION
1293         bfd_preserve_save
1294
1295 SYNOPSIS
1296         bfd_boolean bfd_preserve_save (bfd *, struct bfd_preserve *);
1297
1298 DESCRIPTION
1299         When testing an object for compatibility with a particular
1300         target back-end, the back-end object_p function needs to set
1301         up certain fields in the bfd on successfully recognizing the
1302         object.  This typically happens in a piecemeal fashion, with
1303         failures possible at many points.  On failure, the bfd is
1304         supposed to be restored to its initial state, which is
1305         virtually impossible.  However, restoring a subset of the bfd
1306         state works in practice.  This function stores the subset and
1307         reinitializes the bfd.
1308
1309 */
1310
1311 bfd_boolean
1312 bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve)
1313 {
1314   preserve->tdata = abfd->tdata.any;
1315   preserve->arch_info = abfd->arch_info;
1316   preserve->flags = abfd->flags;
1317   preserve->sections = abfd->sections;
1318   preserve->section_tail = abfd->section_tail;
1319   preserve->section_count = abfd->section_count;
1320   preserve->section_htab = abfd->section_htab;
1321
1322   if (! bfd_hash_table_init (&abfd->section_htab, bfd_section_hash_newfunc))
1323     return FALSE;
1324
1325   abfd->tdata.any = NULL;
1326   abfd->arch_info = &bfd_default_arch_struct;
1327   abfd->flags &= BFD_IN_MEMORY;
1328   abfd->sections = NULL;
1329   abfd->section_tail = &abfd->sections;
1330   abfd->section_count = 0;
1331
1332   return TRUE;
1333 }
1334
1335 /*
1336 FUNCTION
1337         bfd_preserve_restore
1338
1339 SYNOPSIS
1340         void bfd_preserve_restore (bfd *, struct bfd_preserve *);
1341
1342 DESCRIPTION
1343         This function restores bfd state saved by bfd_preserve_save.
1344         If MARKER is non-NULL in struct bfd_preserve then that block
1345         and all subsequently bfd_alloc'd memory is freed.
1346
1347 */
1348
1349 void
1350 bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
1351 {
1352   bfd_hash_table_free (&abfd->section_htab);
1353
1354   abfd->tdata.any = preserve->tdata;
1355   abfd->arch_info = preserve->arch_info;
1356   abfd->flags = preserve->flags;
1357   abfd->section_htab = preserve->section_htab;
1358   abfd->sections = preserve->sections;
1359   abfd->section_tail = preserve->section_tail;
1360   abfd->section_count = preserve->section_count;
1361
1362   /* bfd_release frees all memory more recently bfd_alloc'd than
1363      its arg, as well as its arg.  */
1364   if (preserve->marker != NULL)
1365     {
1366       bfd_release (abfd, preserve->marker);
1367       preserve->marker = NULL;
1368     }
1369 }
1370
1371 /*
1372 FUNCTION
1373         bfd_preserve_finish
1374
1375 SYNOPSIS
1376         void bfd_preserve_finish (bfd *, struct bfd_preserve *);
1377
1378 DESCRIPTION
1379         This function should be called when the bfd state saved by
1380         bfd_preserve_save is no longer needed.  ie. when the back-end
1381         object_p function returns with success.
1382
1383 */
1384
1385 void
1386 bfd_preserve_finish (bfd *abfd ATTRIBUTE_UNUSED, struct bfd_preserve *preserve)
1387 {
1388   /* It would be nice to be able to free more memory here, eg. old
1389      tdata, but that's not possible since these blocks are sitting
1390      inside bfd_alloc'd memory.  The section hash is on a separate
1391      objalloc.  */
1392   bfd_hash_table_free (&preserve->section_htab);
1393 }