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