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