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