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
 533 /*
 534 FUNCTION
 535         bfd_archive_filename
 536
 537 SYNOPSIS
 538         const char *bfd_archive_filename (bfd *);
 539
 540 DESCRIPTION
 541         For a BFD that is a component of an archive, returns a string
 542         with both the archive name and file name.  For other BFDs, just
 543         returns the file name.
 544 */
 545
 546 const char *
 547 bfd_archive_filename (abfd)
 548      bfd *abfd;
 549 {
 550   if (abfd->my_archive)
 551     {
 552       static size_t curr = 0;
 553       static char *buf;
 554       size_t needed;
 555
 556       needed = (strlen (bfd_get_filename (abfd->my_archive))
 557                 + strlen (bfd_get_filename (abfd)) + 3);
 558       if (needed > curr)
 559         {
 560           if (curr)
 561             free (buf);
 562           curr = needed + (needed >> 1);
 563           buf = bfd_malloc (curr);
 564           /* If we can't malloc, fail safe by returning just the file
 565              name. This function is only used when building error
 566              messages.  */
 567           if (!buf)
 568             {
 569               curr = 0;
 570               return bfd_get_filename (abfd);
 571             }
 572         }
 573       sprintf (buf, "%s(%s)", bfd_get_filename (abfd->my_archive),
 574                bfd_get_filename (abfd));
 575       return buf;
 576     }
 577   else
 578     return bfd_get_filename (abfd);
 579 }
 580 \f
 581 /*
 582 SECTION
 583         Symbols
 584 */
 585
 586 /*
 587 FUNCTION
 588         bfd_get_reloc_upper_bound
 589
 590 SYNOPSIS
 591         long bfd_get_reloc_upper_bound(bfd *abfd, asection *sect);
 592
 593 DESCRIPTION
 594         Return the number of bytes required to store the
 595         relocation information associated with section @var{sect}
 596         attached to bfd @var{abfd}.  If an error occurs, return -1.
 597
 598 */
 599
 600 long
 601 bfd_get_reloc_upper_bound (abfd, asect)
 602      bfd *abfd;
 603      sec_ptr asect;
 604 {
 605   if (abfd->format != bfd_object)
 606     {
 607       bfd_set_error (bfd_error_invalid_operation);
 608       return -1;
 609     }
 610
 611   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
 612 }
 613
 614 /*
 615 FUNCTION
 616         bfd_canonicalize_reloc
 617
 618 SYNOPSIS
 619         long bfd_canonicalize_reloc
 620                 (bfd *abfd,
 621                 asection *sec,
 622                 arelent **loc,
 623                 asymbol **syms);
 624
 625 DESCRIPTION
 626         Call the back end associated with the open BFD
 627         @var{abfd} and translate the external form of the relocation
 628         information attached to @var{sec} into the internal canonical
 629         form.  Place the table into memory at @var{loc}, which has
 630         been preallocated, usually by a call to
 631         <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
 632         -1 on error.
 633
 634         The @var{syms} table is also needed for horrible internal magic
 635         reasons.
 636
 637 */
 638 long
 639 bfd_canonicalize_reloc (abfd, asect, location, symbols)
 640      bfd *abfd;
 641      sec_ptr asect;
 642      arelent **location;
 643      asymbol **symbols;
 644 {
 645   if (abfd->format != bfd_object)
 646     {
 647       bfd_set_error (bfd_error_invalid_operation);
 648       return -1;
 649     }
 650
 651   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
 652                    (abfd, asect, location, symbols));
 653 }
 654
 655 /*
 656 FUNCTION
 657         bfd_set_reloc
 658
 659 SYNOPSIS
 660         void bfd_set_reloc
 661           (bfd *abfd, asection *sec, arelent **rel, unsigned int count)
 662
 663 DESCRIPTION
 664         Set the relocation pointer and count within
 665         section @var{sec} to the values @var{rel} and @var{count}.
 666         The argument @var{abfd} is ignored.
 667
 668 */
 669
 670 void
 671 bfd_set_reloc (ignore_abfd, asect, location, count)
 672      bfd *ignore_abfd ATTRIBUTE_UNUSED;
 673      sec_ptr asect;
 674      arelent **location;
 675      unsigned int count;
 676 {
 677   asect->orelocation = location;
 678   asect->reloc_count = count;
 679 }
 680
 681 /*
 682 FUNCTION
 683         bfd_set_file_flags
 684
 685 SYNOPSIS
 686         boolean bfd_set_file_flags(bfd *abfd, flagword flags);
 687
 688 DESCRIPTION
 689         Set the flag word in the BFD @var{abfd} to the value @var{flags}.
 690
 691         Possible errors are:
 692         o <<bfd_error_wrong_format>> - The target bfd was not of object format.
 693         o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
 694         o <<bfd_error_invalid_operation>> -
 695         The flag word contained a bit which was not applicable to the
 696         type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
 697         on a BFD format which does not support demand paging.
 698
 699 */
 700
 701 boolean
 702 bfd_set_file_flags (abfd, flags)
 703      bfd *abfd;
 704      flagword flags;
 705 {
 706   if (abfd->format != bfd_object)
 707     {
 708       bfd_set_error (bfd_error_wrong_format);
 709       return false;
 710     }
 711
 712   if (bfd_read_p (abfd))
 713     {
 714       bfd_set_error (bfd_error_invalid_operation);
 715       return false;
 716     }
 717
 718   bfd_get_file_flags (abfd) = flags;
 719   if ((flags & bfd_applicable_file_flags (abfd)) != flags)
 720     {
 721       bfd_set_error (bfd_error_invalid_operation);
 722       return false;
 723     }
 724
 725   return true;
 726 }
 727
 728 void
 729 bfd_assert (file, line)
 730      const char *file;
 731      int line;
 732 {
 733   (*_bfd_error_handler) (_("bfd assertion fail %s:%d"), file, line);
 734 }
 735
 736 /* A more or less friendly abort message.  In libbfd.h abort is
 737    defined to call this function.  */
 738
 739 #ifndef EXIT_FAILURE
 740 #define EXIT_FAILURE 1
 741 #endif
 742
 743 void
 744 _bfd_abort (file, line, fn)
 745      const char *file;
 746      int line;
 747      const char *fn;
 748 {
 749   if (fn != NULL)
 750     (*_bfd_error_handler)
 751       (_("BFD internal error, aborting at %s line %d in %s\n"),
 752        file, line, fn);
 753   else
 754     (*_bfd_error_handler)
 755       (_("BFD internal error, aborting at %s line %d\n"),
 756        file, line);
 757   (*_bfd_error_handler) (_("Please report this bug.\n"));
 758   xexit (EXIT_FAILURE);
 759 }
 760
 761 /*
 762 FUNCTION
 763         bfd_get_arch_size
 764
 765 SYNOPSIS
 766         int bfd_get_arch_size (bfd *abfd);
 767
 768 DESCRIPTION
 769         Returns the architecture address size, in bits, as determined
 770         by the object file's format.  For ELF, this information is
 771         included in the header.
 772
 773 RETURNS
 774         Returns the arch size in bits if known, <<-1>> otherwise.
 775 */
 776
 777 int
 778 bfd_get_arch_size (abfd)
 779      bfd *abfd;
 780 {
 781   if (abfd->xvec->flavour == bfd_target_elf_flavour)
 782     return (get_elf_backend_data (abfd))->s->arch_size;
 783
 784   bfd_set_error (bfd_error_wrong_format);
 785   return -1;
 786 }
 787
 788 /*
 789 FUNCTION
 790         bfd_get_sign_extend_vma
 791
 792 SYNOPSIS
 793         int bfd_get_sign_extend_vma (bfd *abfd);
 794
 795 DESCRIPTION
 796         Indicates if the target architecture "naturally" sign extends
 797         an address.  Some architectures implicitly sign extend address
 798         values when they are converted to types larger than the size
 799         of an address.  For instance, bfd_get_start_address() will
 800         return an address sign extended to fill a bfd_vma when this is
 801         the case.
 802
 803 RETURNS
 804         Returns <<1>> if the target architecture is known to sign
 805         extend addresses, <<0>> if the target architecture is known to
 806         not sign extend addresses, and <<-1>> otherwise.
 807 */
 808
 809 int
 810 bfd_get_sign_extend_vma (abfd)
 811      bfd *abfd;
 812 {
 813   char *name;
 814
 815   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
 816     return (get_elf_backend_data (abfd)->sign_extend_vma);
 817
 818   name = bfd_get_target (abfd);
 819
 820   /* Return a proper value for DJGPP COFF (an x86 COFF variant).
 821      This function is required for DWARF2 support, but there is
 822      no place to store this information in the COFF back end.
 823      Should enough other COFF targets add support for DWARF2,
 824      a place will have to be found.  Until then, this hack will do.  */
 825   if (strncmp (name, "coff-go32", sizeof ("coff-go32") - 1) == 0)
 826     return 1;
 827
 828   bfd_set_error (bfd_error_wrong_format);
 829   return -1;
 830 }
 831
 832 /*
 833 FUNCTION
 834         bfd_set_start_address
 835
 836 SYNOPSIS
 837         boolean bfd_set_start_address(bfd *abfd, bfd_vma vma);
 838
 839 DESCRIPTION
 840         Make @var{vma} the entry point of output BFD @var{abfd}.
 841
 842 RETURNS
 843         Returns <<true>> on success, <<false>> otherwise.
 844 */
 845
 846 boolean
 847 bfd_set_start_address (abfd, vma)
 848      bfd *abfd;
 849      bfd_vma vma;
 850 {
 851   abfd->start_address = vma;
 852   return true;
 853 }
 854
 855 /*
 856 FUNCTION
 857         bfd_get_mtime
 858
 859 SYNOPSIS
 860         long bfd_get_mtime(bfd *abfd);
 861
 862 DESCRIPTION
 863         Return the file modification time (as read from the file system, or
 864         from the archive header for archive members).
 865
 866 */
 867
 868 long
 869 bfd_get_mtime (abfd)
 870      bfd *abfd;
 871 {
 872   FILE *fp;
 873   struct stat buf;
 874
 875   if (abfd->mtime_set)
 876     return abfd->mtime;
 877
 878   fp = bfd_cache_lookup (abfd);
 879   if (0 != fstat (fileno (fp), &buf))
 880     return 0;
 881
 882   abfd->mtime = buf.st_mtime;           /* Save value in case anyone wants it */
 883   return buf.st_mtime;
 884 }
 885
 886 /*
 887 FUNCTION
 888         bfd_get_size
 889
 890 SYNOPSIS
 891         long bfd_get_size(bfd *abfd);
 892
 893 DESCRIPTION
 894         Return the file size (as read from file system) for the file
 895         associated with BFD @var{abfd}.
 896
 897         The initial motivation for, and use of, this routine is not
 898         so we can get the exact size of the object the BFD applies to, since
 899         that might not be generally possible (archive members for example).
 900         It would be ideal if someone could eventually modify
 901         it so that such results were guaranteed.
 902
 903         Instead, we want to ask questions like "is this NNN byte sized
 904         object I'm about to try read from file offset YYY reasonable?"
 905         As as example of where we might do this, some object formats
 906         use string tables for which the first <<sizeof (long)>> bytes of the
 907         table contain the size of the table itself, including the size bytes.
 908         If an application tries to read what it thinks is one of these
 909         string tables, without some way to validate the size, and for
 910         some reason the size is wrong (byte swapping error, wrong location
 911         for the string table, etc.), the only clue is likely to be a read
 912         error when it tries to read the table, or a "virtual memory
 913         exhausted" error when it tries to allocate 15 bazillon bytes
 914         of space for the 15 bazillon byte table it is about to read.
 915         This function at least allows us to answer the quesion, "is the
 916         size reasonable?".
 917 */
 918
 919 long
 920 bfd_get_size (abfd)
 921      bfd *abfd;
 922 {
 923   FILE *fp;
 924   struct stat buf;
 925
 926   if ((abfd->flags & BFD_IN_MEMORY) != 0)
 927     return ((struct bfd_in_memory *) abfd->iostream)->size;
 928
 929   fp = bfd_cache_lookup (abfd);
 930   if (0 != fstat (fileno (fp), & buf))
 931     return 0;
 932
 933   return buf.st_size;
 934 }
 935
 936 /*
 937 FUNCTION
 938         bfd_get_gp_size
 939
 940 SYNOPSIS
 941         unsigned int bfd_get_gp_size(bfd *abfd);
 942
 943 DESCRIPTION
 944         Return the maximum size of objects to be optimized using the GP
 945         register under MIPS ECOFF.  This is typically set by the <<-G>>
 946         argument to the compiler, assembler or linker.
 947 */
 948
 949 unsigned int
 950 bfd_get_gp_size (abfd)
 951      bfd *abfd;
 952 {
 953   if (abfd->format == bfd_object)
 954     {
 955       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 956         return ecoff_data (abfd)->gp_size;
 957       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 958         return elf_gp_size (abfd);
 959     }
 960   return 0;
 961 }
 962
 963 /*
 964 FUNCTION
 965         bfd_set_gp_size
 966
 967 SYNOPSIS
 968         void bfd_set_gp_size(bfd *abfd, unsigned int i);
 969
 970 DESCRIPTION
 971         Set the maximum size of objects to be optimized using the GP
 972         register under ECOFF or MIPS ELF.  This is typically set by
 973         the <<-G>> argument to the compiler, assembler or linker.
 974 */
 975
 976 void
 977 bfd_set_gp_size (abfd, i)
 978      bfd *abfd;
 979      unsigned int i;
 980 {
 981   /* Don't try to set GP size on an archive or core file!  */
 982   if (abfd->format != bfd_object)
 983     return;
 984
 985   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 986     ecoff_data (abfd)->gp_size = i;
 987   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 988     elf_gp_size (abfd) = i;
 989 }
 990
 991 /* Get the GP value.  This is an internal function used by some of the
 992    relocation special_function routines on targets which support a GP
 993    register.  */
 994
 995 bfd_vma
 996 _bfd_get_gp_value (abfd)
 997      bfd *abfd;
 998 {
 999   if (abfd->format != bfd_object)
1000     return 0;
1001
1002   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1003     return ecoff_data (abfd)->gp;
1004   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1005     return elf_gp (abfd);
1006
1007   return 0;
1008 }
1009
1010 /* Set the GP value.  */
1011
1012 void
1013 _bfd_set_gp_value (abfd, v)
1014      bfd *abfd;
1015      bfd_vma v;
1016 {
1017   if (abfd->format != bfd_object)
1018     return;
1019
1020   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1021     ecoff_data (abfd)->gp = v;
1022   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1023     elf_gp (abfd) = v;
1024 }
1025
1026 /*
1027 FUNCTION
1028         bfd_scan_vma
1029
1030 SYNOPSIS
1031         bfd_vma bfd_scan_vma(const char *string, const char **end, int base);
1032
1033 DESCRIPTION
1034         Convert, like <<strtoul>>, a numerical expression
1035         @var{string} into a <<bfd_vma>> integer, and return that integer.
1036         (Though without as many bells and whistles as <<strtoul>>.)
1037         The expression is assumed to be unsigned (i.e., positive).
1038         If given a @var{base}, it is used as the base for conversion.
1039         A base of 0 causes the function to interpret the string
1040         in hex if a leading "0x" or "0X" is found, otherwise
1041         in octal if a leading zero is found, otherwise in decimal.
1042
1043         Overflow is not detected.
1044 */
1045
1046 bfd_vma
1047 bfd_scan_vma (string, end, base)
1048      const char *string;
1049      const char **end;
1050      int base;
1051 {
1052   bfd_vma value;
1053   int digit;
1054
1055   /* Let the host do it if possible.  */
1056   if (sizeof (bfd_vma) <= sizeof (unsigned long))
1057     return (bfd_vma) strtoul (string, (char **) end, base);
1058
1059   /* A negative base makes no sense, and we only need to go as high as hex.  */
1060   if ((base < 0) || (base > 16))
1061     return (bfd_vma) 0;
1062
1063   if (base == 0)
1064     {
1065       if (string[0] == '0')
1066         {
1067           if ((string[1] == 'x') || (string[1] == 'X'))
1068             base = 16;
1069           /* XXX should we also allow "0b" or "0B" to set base to 2?  */
1070           else
1071             base = 8;
1072         }
1073       else
1074         base = 10;
1075     }
1076
1077   if ((base == 16) &&
1078       (string[0] == '0') && ((string[1] == 'x') || (string[1] == 'X')))
1079     string += 2;
1080   /* XXX should we also skip over "0b" or "0B" if base is 2?  */
1081
1082 /* Speed could be improved with a table like hex_value[] in gas.  */
1083 #define HEX_VALUE(c) \
1084   (ISXDIGIT (c)                                                 \
1085    ? (ISDIGIT (c)                                               \
1086       ? (c - '0')                                               \
1087       : (10 + c - (ISLOWER (c) ? 'a' : 'A')))                   \
1088    : 42)
1089
1090   for (value = 0; (digit = HEX_VALUE (* string)) < base; string ++)
1091     value = value * base + digit;
1092
1093   if (end)
1094     * end = string;
1095
1096   return value;
1097 }
1098
1099 /*
1100 FUNCTION
1101         bfd_copy_private_bfd_data
1102
1103 SYNOPSIS
1104         boolean bfd_copy_private_bfd_data(bfd *ibfd, bfd *obfd);
1105
1106 DESCRIPTION
1107         Copy private BFD information from the BFD @var{ibfd} to the
1108         the BFD @var{obfd}.  Return <<true>> on success, <<false>> on error.
1109         Possible error returns are:
1110
1111         o <<bfd_error_no_memory>> -
1112         Not enough memory exists to create private data for @var{obfd}.
1113
1114 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1115 .     BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1116 .               (ibfd, obfd))
1117
1118 */
1119
1120 /*
1121 FUNCTION
1122         bfd_merge_private_bfd_data
1123
1124 SYNOPSIS
1125         boolean bfd_merge_private_bfd_data(bfd *ibfd, bfd *obfd);
1126
1127 DESCRIPTION
1128         Merge private BFD information from the BFD @var{ibfd} to the
1129         the output file BFD @var{obfd} when linking.  Return <<true>>
1130         on success, <<false>> on error.  Possible error returns are:
1131
1132         o <<bfd_error_no_memory>> -
1133         Not enough memory exists to create private data for @var{obfd}.
1134
1135 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1136 .     BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1137 .               (ibfd, obfd))
1138
1139 */
1140
1141 /*
1142 FUNCTION
1143         bfd_set_private_flags
1144
1145 SYNOPSIS
1146         boolean bfd_set_private_flags(bfd *abfd, flagword flags);
1147
1148 DESCRIPTION
1149         Set private BFD flag information in the BFD @var{abfd}.
1150         Return <<true>> on success, <<false>> on error.  Possible error
1151         returns are:
1152
1153         o <<bfd_error_no_memory>> -
1154         Not enough memory exists to create private data for @var{obfd}.
1155
1156 .#define bfd_set_private_flags(abfd, flags) \
1157 .     BFD_SEND (abfd, _bfd_set_private_flags, \
1158 .               (abfd, flags))
1159
1160 */
1161
1162 /*
1163 FUNCTION
1164         stuff
1165
1166 DESCRIPTION
1167         Stuff which should be documented:
1168
1169 .#define bfd_sizeof_headers(abfd, reloc) \
1170 .     BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1171 .
1172 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1173 .     BFD_SEND (abfd, _bfd_find_nearest_line,  (abfd, sec, syms, off, file, func, line))
1174 .
1175 .       {* Do these three do anything useful at all, for any back end?  *}
1176 .#define bfd_debug_info_start(abfd) \
1177 .        BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1178 .
1179 .#define bfd_debug_info_end(abfd) \
1180 .        BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1181 .
1182 .#define bfd_debug_info_accumulate(abfd, section) \
1183 .        BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1184 .
1185 .
1186 .#define bfd_stat_arch_elt(abfd, stat) \
1187 .        BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1188 .
1189 .#define bfd_update_armap_timestamp(abfd) \
1190 .        BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1191 .
1192 .#define bfd_set_arch_mach(abfd, arch, mach)\
1193 .        BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1194 .
1195 .#define bfd_relax_section(abfd, section, link_info, again) \
1196 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1197 .
1198 .#define bfd_gc_sections(abfd, link_info) \
1199 .       BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1200 .
1201 .#define bfd_merge_sections(abfd, link_info) \
1202 .       BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1203 .
1204 .#define bfd_link_hash_table_create(abfd) \
1205 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1206 .
1207 .#define bfd_link_add_symbols(abfd, info) \
1208 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1209 .
1210 .#define bfd_final_link(abfd, info) \
1211 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1212 .
1213 .#define bfd_free_cached_info(abfd) \
1214 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1215 .
1216 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1217 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1218 .
1219 .#define bfd_print_private_bfd_data(abfd, file)\
1220 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1221 .
1222 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1223 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1224 .
1225 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1226 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1227 .
1228 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1229 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1230 .
1231 .extern bfd_byte *bfd_get_relocated_section_contents
1232 .       PARAMS ((bfd *, struct bfd_link_info *,
1233 .                 struct bfd_link_order *, bfd_byte *,
1234 .                 boolean, asymbol **));
1235 .
1236
1237 */
1238
1239 bfd_byte *
1240 bfd_get_relocated_section_contents (abfd, link_info, link_order, data,
1241                                     relocateable, symbols)
1242      bfd *abfd;
1243      struct bfd_link_info *link_info;
1244      struct bfd_link_order *link_order;
1245      bfd_byte *data;
1246      boolean relocateable;
1247      asymbol **symbols;
1248 {
1249   bfd *abfd2;
1250   bfd_byte *(*fn) PARAMS ((bfd *, struct bfd_link_info *,
1251                            struct bfd_link_order *, bfd_byte *, boolean,
1252                            asymbol **));
1253
1254   if (link_order->type == bfd_indirect_link_order)
1255     {
1256       abfd2 = link_order->u.indirect.section->owner;
1257       if (abfd2 == NULL)
1258         abfd2 = abfd;
1259     }
1260   else
1261     abfd2 = abfd;
1262
1263   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1264
1265   return (*fn) (abfd, link_info, link_order, data, relocateable, symbols);
1266 }
1267
1268 /* Record information about an ELF program header.  */
1269
1270 boolean
1271 bfd_record_phdr (abfd, type, flags_valid, flags, at_valid, at,
1272                  includes_filehdr, includes_phdrs, count, secs)
1273      bfd *abfd;
1274      unsigned long type;
1275      boolean flags_valid;
1276      flagword flags;
1277      boolean at_valid;
1278      bfd_vma at;
1279      boolean includes_filehdr;
1280      boolean includes_phdrs;
1281      unsigned int count;
1282      asection **secs;
1283 {
1284   struct elf_segment_map *m, **pm;
1285   bfd_size_type amt;
1286
1287   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1288     return true;
1289
1290   amt = sizeof (struct elf_segment_map);
1291   amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1292   m = (struct elf_segment_map *) bfd_alloc (abfd, amt);
1293   if (m == NULL)
1294     return false;
1295
1296   m->next = NULL;
1297   m->p_type = type;
1298   m->p_flags = flags;
1299   m->p_paddr = at;
1300   m->p_flags_valid = flags_valid;
1301   m->p_paddr_valid = at_valid;
1302   m->includes_filehdr = includes_filehdr;
1303   m->includes_phdrs = includes_phdrs;
1304   m->count = count;
1305   if (count > 0)
1306     memcpy (m->sections, secs, count * sizeof (asection *));
1307
1308   for (pm = &elf_tdata (abfd)->segment_map; *pm != NULL; pm = &(*pm)->next)
1309     ;
1310   *pm = m;
1311
1312   return true;
1313 }
1314
1315 void
1316 bfd_sprintf_vma (abfd, buf, value)
1317      bfd *abfd;
1318      char *buf;
1319      bfd_vma value;
1320 {
1321   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1322     get_elf_backend_data (abfd)->elf_backend_sprintf_vma (abfd, buf, value);
1323   else
1324     sprintf_vma (buf, value);
1325 }
1326
1327 void
1328 bfd_fprintf_vma (abfd, stream, value)
1329      bfd *abfd;
1330      PTR stream;
1331      bfd_vma value;
1332 {
1333   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1334     get_elf_backend_data (abfd)->elf_backend_fprintf_vma (abfd, stream, value);
1335   else
1336     fprintf_vma ((FILE *) stream, value);
1337 }
1338
1339 /*
1340 FUNCTION
1341         bfd_alt_mach_code
1342
1343 SYNOPSIS
1344         boolean bfd_alt_mach_code(bfd *abfd, int index);
1345
1346 DESCRIPTION
1347
1348         When more than one machine code number is available for the
1349         same machine type, this function can be used to switch between
1350         the preferred one (index == 0) and any others.  Currently,
1351         only ELF supports this feature, with up to two alternate
1352         machine codes.
1353 */
1354
1355 boolean
1356 bfd_alt_mach_code (abfd, index)
1357      bfd *abfd;
1358      int index;
1359 {
1360   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1361     {
1362       int code;
1363
1364       switch (index)
1365         {
1366         case 0:
1367           code = get_elf_backend_data (abfd)->elf_machine_code;
1368           break;
1369
1370         case 1:
1371           code = get_elf_backend_data (abfd)->elf_machine_alt1;
1372           if (code == 0)
1373             return false;
1374           break;
1375
1376         case 2:
1377           code = get_elf_backend_data (abfd)->elf_machine_alt2;
1378           if (code == 0)
1379             return false;
1380           break;
1381
1382         default:
1383           return false;
1384         }
1385
1386       elf_elfheader (abfd)->e_machine = code;
1387
1388       return true;
1389     }
1390
1391   return false;
1392 }