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