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