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