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 sec *sections;
 117 .
 118 .  {* The place where we add to the section list.  *}
 119 .  struct sec **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 symbol_cache_entry  **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 overriden 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->my_archive)
 516     {
 517       static size_t curr = 0;
 518       static char *buf;
 519       size_t needed;
 520
 521       needed = (strlen (bfd_get_filename (abfd->my_archive))
 522                 + strlen (bfd_get_filename (abfd)) + 3);
 523       if (needed > curr)
 524         {
 525           if (curr)
 526             free (buf);
 527           curr = needed + (needed >> 1);
 528           buf = bfd_malloc (curr);
 529           /* If we can't malloc, fail safe by returning just the file
 530              name. This function is only used when building error
 531              messages.  */
 532           if (!buf)
 533             {
 534               curr = 0;
 535               return bfd_get_filename (abfd);
 536             }
 537         }
 538       sprintf (buf, "%s(%s)", bfd_get_filename (abfd->my_archive),
 539                bfd_get_filename (abfd));
 540       return buf;
 541     }
 542   else
 543     return bfd_get_filename (abfd);
 544 }
 545 \f
 546 /*
 547 SECTION
 548         Symbols
 549 */
 550
 551 /*
 552 FUNCTION
 553         bfd_get_reloc_upper_bound
 554
 555 SYNOPSIS
 556         long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
 557
 558 DESCRIPTION
 559         Return the number of bytes required to store the
 560         relocation information associated with section @var{sect}
 561         attached to bfd @var{abfd}.  If an error occurs, return -1.
 562
 563 */
 564
 565 long
 566 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
 567 {
 568   if (abfd->format != bfd_object)
 569     {
 570       bfd_set_error (bfd_error_invalid_operation);
 571       return -1;
 572     }
 573
 574   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
 575 }
 576
 577 /*
 578 FUNCTION
 579         bfd_canonicalize_reloc
 580
 581 SYNOPSIS
 582         long bfd_canonicalize_reloc
 583           (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
 584
 585 DESCRIPTION
 586         Call the back end associated with the open BFD
 587         @var{abfd} and translate the external form of the relocation
 588         information attached to @var{sec} into the internal canonical
 589         form.  Place the table into memory at @var{loc}, which has
 590         been preallocated, usually by a call to
 591         <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
 592         -1 on error.
 593
 594         The @var{syms} table is also needed for horrible internal magic
 595         reasons.
 596
 597 */
 598 long
 599 bfd_canonicalize_reloc (bfd *abfd,
 600                         sec_ptr asect,
 601                         arelent **location,
 602                         asymbol **symbols)
 603 {
 604   if (abfd->format != bfd_object)
 605     {
 606       bfd_set_error (bfd_error_invalid_operation);
 607       return -1;
 608     }
 609
 610   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
 611                    (abfd, asect, location, symbols));
 612 }
 613
 614 /*
 615 FUNCTION
 616         bfd_set_reloc
 617
 618 SYNOPSIS
 619         void bfd_set_reloc
 620           (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
 621
 622 DESCRIPTION
 623         Set the relocation pointer and count within
 624         section @var{sec} to the values @var{rel} and @var{count}.
 625         The argument @var{abfd} is ignored.
 626
 627 */
 628
 629 void
 630 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
 631                sec_ptr asect,
 632                arelent **location,
 633                unsigned int count)
 634 {
 635   asect->orelocation = location;
 636   asect->reloc_count = count;
 637 }
 638
 639 /*
 640 FUNCTION
 641         bfd_set_file_flags
 642
 643 SYNOPSIS
 644         bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
 645
 646 DESCRIPTION
 647         Set the flag word in the BFD @var{abfd} to the value @var{flags}.
 648
 649         Possible errors are:
 650         o <<bfd_error_wrong_format>> - The target bfd was not of object format.
 651         o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
 652         o <<bfd_error_invalid_operation>> -
 653         The flag word contained a bit which was not applicable to the
 654         type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
 655         on a BFD format which does not support demand paging.
 656
 657 */
 658
 659 bfd_boolean
 660 bfd_set_file_flags (bfd *abfd, flagword flags)
 661 {
 662   if (abfd->format != bfd_object)
 663     {
 664       bfd_set_error (bfd_error_wrong_format);
 665       return FALSE;
 666     }
 667
 668   if (bfd_read_p (abfd))
 669     {
 670       bfd_set_error (bfd_error_invalid_operation);
 671       return FALSE;
 672     }
 673
 674   bfd_get_file_flags (abfd) = flags;
 675   if ((flags & bfd_applicable_file_flags (abfd)) != flags)
 676     {
 677       bfd_set_error (bfd_error_invalid_operation);
 678       return FALSE;
 679     }
 680
 681   return TRUE;
 682 }
 683
 684 void
 685 bfd_assert (const char *file, int line)
 686 {
 687   (*_bfd_error_handler) (_("BFD %s assertion fail %s:%d"),
 688                          BFD_VERSION_STRING, file, line);
 689 }
 690
 691 /* A more or less friendly abort message.  In libbfd.h abort is
 692    defined to call this function.  */
 693
 694 #ifndef EXIT_FAILURE
 695 #define EXIT_FAILURE 1
 696 #endif
 697
 698 void
 699 _bfd_abort (const char *file, int line, const char *fn)
 700 {
 701   if (fn != NULL)
 702     (*_bfd_error_handler)
 703       (_("BFD %s internal error, aborting at %s line %d in %s\n"),
 704        BFD_VERSION_STRING, file, line, fn);
 705   else
 706     (*_bfd_error_handler)
 707       (_("BFD %s internal error, aborting at %s line %d\n"),
 708        BFD_VERSION_STRING, file, line);
 709   (*_bfd_error_handler) (_("Please report this bug.\n"));
 710   xexit (EXIT_FAILURE);
 711 }
 712
 713 /*
 714 FUNCTION
 715         bfd_get_arch_size
 716
 717 SYNOPSIS
 718         int bfd_get_arch_size (bfd *abfd);
 719
 720 DESCRIPTION
 721         Returns the architecture address size, in bits, as determined
 722         by the object file's format.  For ELF, this information is
 723         included in the header.
 724
 725 RETURNS
 726         Returns the arch size in bits if known, <<-1>> otherwise.
 727 */
 728
 729 int
 730 bfd_get_arch_size (bfd *abfd)
 731 {
 732   if (abfd->xvec->flavour == bfd_target_elf_flavour)
 733     return get_elf_backend_data (abfd)->s->arch_size;
 734
 735   return -1;
 736 }
 737
 738 /*
 739 FUNCTION
 740         bfd_get_sign_extend_vma
 741
 742 SYNOPSIS
 743         int bfd_get_sign_extend_vma (bfd *abfd);
 744
 745 DESCRIPTION
 746         Indicates if the target architecture "naturally" sign extends
 747         an address.  Some architectures implicitly sign extend address
 748         values when they are converted to types larger than the size
 749         of an address.  For instance, bfd_get_start_address() will
 750         return an address sign extended to fill a bfd_vma when this is
 751         the case.
 752
 753 RETURNS
 754         Returns <<1>> if the target architecture is known to sign
 755         extend addresses, <<0>> if the target architecture is known to
 756         not sign extend addresses, and <<-1>> otherwise.
 757 */
 758
 759 int
 760 bfd_get_sign_extend_vma (bfd *abfd)
 761 {
 762   char *name;
 763
 764   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
 765     return get_elf_backend_data (abfd)->sign_extend_vma;
 766
 767   name = bfd_get_target (abfd);
 768
 769   /* Return a proper value for DJGPP COFF (an x86 COFF variant).
 770      This function is required for DWARF2 support, but there is
 771      no place to store this information in the COFF back end.
 772      Should enough other COFF targets add support for DWARF2,
 773      a place will have to be found.  Until then, this hack will do.  */
 774   if (strncmp (name, "coff-go32", sizeof ("coff-go32") - 1) == 0)
 775     return 1;
 776
 777   bfd_set_error (bfd_error_wrong_format);
 778   return -1;
 779 }
 780
 781 /*
 782 FUNCTION
 783         bfd_set_start_address
 784
 785 SYNOPSIS
 786         bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
 787
 788 DESCRIPTION
 789         Make @var{vma} the entry point of output BFD @var{abfd}.
 790
 791 RETURNS
 792         Returns <<TRUE>> on success, <<FALSE>> otherwise.
 793 */
 794
 795 bfd_boolean
 796 bfd_set_start_address (bfd *abfd, bfd_vma vma)
 797 {
 798   abfd->start_address = vma;
 799   return TRUE;
 800 }
 801
 802 /*
 803 FUNCTION
 804         bfd_get_gp_size
 805
 806 SYNOPSIS
 807         unsigned int bfd_get_gp_size (bfd *abfd);
 808
 809 DESCRIPTION
 810         Return the maximum size of objects to be optimized using the GP
 811         register under MIPS ECOFF.  This is typically set by the <<-G>>
 812         argument to the compiler, assembler or linker.
 813 */
 814
 815 unsigned int
 816 bfd_get_gp_size (bfd *abfd)
 817 {
 818   if (abfd->format == bfd_object)
 819     {
 820       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 821         return ecoff_data (abfd)->gp_size;
 822       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 823         return elf_gp_size (abfd);
 824     }
 825   return 0;
 826 }
 827
 828 /*
 829 FUNCTION
 830         bfd_set_gp_size
 831
 832 SYNOPSIS
 833         void bfd_set_gp_size (bfd *abfd, unsigned int i);
 834
 835 DESCRIPTION
 836         Set the maximum size of objects to be optimized using the GP
 837         register under ECOFF or MIPS ELF.  This is typically set by
 838         the <<-G>> argument to the compiler, assembler or linker.
 839 */
 840
 841 void
 842 bfd_set_gp_size (bfd *abfd, unsigned int i)
 843 {
 844   /* Don't try to set GP size on an archive or core file!  */
 845   if (abfd->format != bfd_object)
 846     return;
 847
 848   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 849     ecoff_data (abfd)->gp_size = i;
 850   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 851     elf_gp_size (abfd) = i;
 852 }
 853
 854 /* Get the GP value.  This is an internal function used by some of the
 855    relocation special_function routines on targets which support a GP
 856    register.  */
 857
 858 bfd_vma
 859 _bfd_get_gp_value (bfd *abfd)
 860 {
 861   if (! abfd)
 862     return 0;
 863   if (abfd->format != bfd_object)
 864     return 0;
 865
 866   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 867     return ecoff_data (abfd)->gp;
 868   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 869     return elf_gp (abfd);
 870
 871   return 0;
 872 }
 873
 874 /* Set the GP value.  */
 875
 876 void
 877 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
 878 {
 879   if (! abfd)
 880     BFD_FAIL ();
 881   if (abfd->format != bfd_object)
 882     return;
 883
 884   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 885     ecoff_data (abfd)->gp = v;
 886   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 887     elf_gp (abfd) = v;
 888 }
 889
 890 /*
 891 FUNCTION
 892         bfd_scan_vma
 893
 894 SYNOPSIS
 895         bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
 896
 897 DESCRIPTION
 898         Convert, like <<strtoul>>, a numerical expression
 899         @var{string} into a <<bfd_vma>> integer, and return that integer.
 900         (Though without as many bells and whistles as <<strtoul>>.)
 901         The expression is assumed to be unsigned (i.e., positive).
 902         If given a @var{base}, it is used as the base for conversion.
 903         A base of 0 causes the function to interpret the string
 904         in hex if a leading "0x" or "0X" is found, otherwise
 905         in octal if a leading zero is found, otherwise in decimal.
 906
 907         If the value would overflow, the maximum <<bfd_vma>> value is
 908         returned.
 909 */
 910
 911 bfd_vma
 912 bfd_scan_vma (const char *string, const char **end, int base)
 913 {
 914   bfd_vma value;
 915   bfd_vma cutoff;
 916   unsigned int cutlim;
 917   int overflow;
 918
 919   /* Let the host do it if possible.  */
 920   if (sizeof (bfd_vma) <= sizeof (unsigned long))
 921     return strtoul (string, (char **) end, base);
 922
 923   if (base == 0)
 924     {
 925       if (string[0] == '0')
 926         {
 927           if ((string[1] == 'x') || (string[1] == 'X'))
 928             base = 16;
 929           else
 930             base = 8;
 931         }
 932     }
 933
 934   if ((base < 2) || (base > 36))
 935     base = 10;
 936
 937   if (base == 16
 938       && string[0] == '0'
 939       && (string[1] == 'x' || string[1] == 'X')
 940       && ISXDIGIT (string[2]))
 941     {
 942       string += 2;
 943     }
 944
 945   cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
 946   cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
 947   value = 0;
 948   overflow = 0;
 949   while (1)
 950     {
 951       unsigned int digit;
 952
 953       digit = *string;
 954       if (ISDIGIT (digit))
 955         digit = digit - '0';
 956       else if (ISALPHA (digit))
 957         digit = TOUPPER (digit) - 'A' + 10;
 958       else
 959         break;
 960       if (digit >= (unsigned int) base)
 961         break;
 962       if (value > cutoff || (value == cutoff && digit > cutlim))
 963         overflow = 1;
 964       value = value * base + digit;
 965       ++string;
 966     }
 967
 968   if (overflow)
 969     value = ~ (bfd_vma) 0;
 970
 971   if (end != NULL)
 972     *end = string;
 973
 974   return value;
 975 }
 976
 977 /*
 978 FUNCTION
 979         bfd_copy_private_bfd_data
 980
 981 SYNOPSIS
 982         bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
 983
 984 DESCRIPTION
 985         Copy private BFD information from the BFD @var{ibfd} to the
 986         the BFD @var{obfd}.  Return <<TRUE>> on success, <<FALSE>> on error.
 987         Possible error returns are:
 988
 989         o <<bfd_error_no_memory>> -
 990         Not enough memory exists to create private data for @var{obfd}.
 991
 992 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
 993 .     BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
 994 .               (ibfd, obfd))
 995
 996 */
 997
 998 /*
 999 FUNCTION
1000         bfd_merge_private_bfd_data
1001
1002 SYNOPSIS
1003         bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1004
1005 DESCRIPTION
1006         Merge private BFD information from the BFD @var{ibfd} to the
1007         the output file BFD @var{obfd} when linking.  Return <<TRUE>>
1008         on success, <<FALSE>> on error.  Possible error returns are:
1009
1010         o <<bfd_error_no_memory>> -
1011         Not enough memory exists to create private data for @var{obfd}.
1012
1013 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1014 .     BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1015 .               (ibfd, obfd))
1016
1017 */
1018
1019 /*
1020 FUNCTION
1021         bfd_set_private_flags
1022
1023 SYNOPSIS
1024         bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1025
1026 DESCRIPTION
1027         Set private BFD flag information in the BFD @var{abfd}.
1028         Return <<TRUE>> on success, <<FALSE>> on error.  Possible error
1029         returns are:
1030
1031         o <<bfd_error_no_memory>> -
1032         Not enough memory exists to create private data for @var{obfd}.
1033
1034 .#define bfd_set_private_flags(abfd, flags) \
1035 .     BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1036
1037 */
1038
1039 /*
1040 FUNCTION
1041         Other functions
1042
1043 DESCRIPTION
1044         The following functions exist but have not yet been documented.
1045
1046 .#define bfd_sizeof_headers(abfd, reloc) \
1047 .       BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1048 .
1049 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1050 .       BFD_SEND (abfd, _bfd_find_nearest_line, \
1051 .                 (abfd, sec, syms, off, file, func, line))
1052 .
1053 .#define bfd_debug_info_start(abfd) \
1054 .       BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1055 .
1056 .#define bfd_debug_info_end(abfd) \
1057 .       BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1058 .
1059 .#define bfd_debug_info_accumulate(abfd, section) \
1060 .       BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1061 .
1062 .#define bfd_stat_arch_elt(abfd, stat) \
1063 .       BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1064 .
1065 .#define bfd_update_armap_timestamp(abfd) \
1066 .       BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1067 .
1068 .#define bfd_set_arch_mach(abfd, arch, mach)\
1069 .       BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1070 .
1071 .#define bfd_relax_section(abfd, section, link_info, again) \
1072 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1073 .
1074 .#define bfd_gc_sections(abfd, link_info) \
1075 .       BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1076 .
1077 .#define bfd_merge_sections(abfd, link_info) \
1078 .       BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1079 .
1080 .#define bfd_discard_group(abfd, sec) \
1081 .       BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1082 .
1083 .#define bfd_link_hash_table_create(abfd) \
1084 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1085 .
1086 .#define bfd_link_hash_table_free(abfd, hash) \
1087 .       BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1088 .
1089 .#define bfd_link_add_symbols(abfd, info) \
1090 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1091 .
1092 .#define bfd_link_just_syms(sec, info) \
1093 .       BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1094 .
1095 .#define bfd_final_link(abfd, info) \
1096 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1097 .
1098 .#define bfd_free_cached_info(abfd) \
1099 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1100 .
1101 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1102 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1103 .
1104 .#define bfd_print_private_bfd_data(abfd, file)\
1105 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1106 .
1107 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1108 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1109 .
1110 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1111 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1112 .
1113 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1114 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1115 .
1116 .extern bfd_byte *bfd_get_relocated_section_contents
1117 .  (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1118 .   bfd_boolean, asymbol **);
1119 .
1120
1121 */
1122
1123 bfd_byte *
1124 bfd_get_relocated_section_contents (bfd *abfd,
1125                                     struct bfd_link_info *link_info,
1126                                     struct bfd_link_order *link_order,
1127                                     bfd_byte *data,
1128                                     bfd_boolean relocatable,
1129                                     asymbol **symbols)
1130 {
1131   bfd *abfd2;
1132   bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1133                    bfd_byte *, bfd_boolean, asymbol **);
1134
1135   if (link_order->type == bfd_indirect_link_order)
1136     {
1137       abfd2 = link_order->u.indirect.section->owner;
1138       if (abfd2 == NULL)
1139         abfd2 = abfd;
1140     }
1141   else
1142     abfd2 = abfd;
1143
1144   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1145
1146   return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1147 }
1148
1149 /* Record information about an ELF program header.  */
1150
1151 bfd_boolean
1152 bfd_record_phdr (bfd *abfd,
1153                  unsigned long type,
1154                  bfd_boolean flags_valid,
1155                  flagword flags,
1156                  bfd_boolean at_valid,
1157                  bfd_vma at,
1158                  bfd_boolean includes_filehdr,
1159                  bfd_boolean includes_phdrs,
1160                  unsigned int count,
1161                  asection **secs)
1162 {
1163   struct elf_segment_map *m, **pm;
1164   bfd_size_type amt;
1165
1166   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1167     return TRUE;
1168
1169   amt = sizeof (struct elf_segment_map);
1170   amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1171   m = bfd_alloc (abfd, amt);
1172   if (m == NULL)
1173     return FALSE;
1174
1175   m->next = NULL;
1176   m->p_type = type;
1177   m->p_flags = flags;
1178   m->p_paddr = at;
1179   m->p_flags_valid = flags_valid;
1180   m->p_paddr_valid = at_valid;
1181   m->includes_filehdr = includes_filehdr;
1182   m->includes_phdrs = includes_phdrs;
1183   m->count = count;
1184   if (count > 0)
1185     memcpy (m->sections, secs, count * sizeof (asection *));
1186
1187   for (pm = &elf_tdata (abfd)->segment_map; *pm != NULL; pm = &(*pm)->next)
1188     ;
1189   *pm = m;
1190
1191   return TRUE;
1192 }
1193
1194 void
1195 bfd_sprintf_vma (bfd *abfd, char *buf, bfd_vma value)
1196 {
1197   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1198     get_elf_backend_data (abfd)->elf_backend_sprintf_vma (abfd, buf, value);
1199   else
1200     sprintf_vma (buf, value);
1201 }
1202
1203 void
1204 bfd_fprintf_vma (bfd *abfd, void *stream, bfd_vma value)
1205 {
1206   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1207     get_elf_backend_data (abfd)->elf_backend_fprintf_vma (abfd, stream, value);
1208   else
1209     fprintf_vma ((FILE *) stream, value);
1210 }
1211
1212 /*
1213 FUNCTION
1214         bfd_alt_mach_code
1215
1216 SYNOPSIS
1217         bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1218
1219 DESCRIPTION
1220
1221         When more than one machine code number is available for the
1222         same machine type, this function can be used to switch between
1223         the preferred one (alternative == 0) and any others.  Currently,
1224         only ELF supports this feature, with up to two alternate
1225         machine codes.
1226 */
1227
1228 bfd_boolean
1229 bfd_alt_mach_code (bfd *abfd, int alternative)
1230 {
1231   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1232     {
1233       int code;
1234
1235       switch (alternative)
1236         {
1237         case 0:
1238           code = get_elf_backend_data (abfd)->elf_machine_code;
1239           break;
1240
1241         case 1:
1242           code = get_elf_backend_data (abfd)->elf_machine_alt1;
1243           if (code == 0)
1244             return FALSE;
1245           break;
1246
1247         case 2:
1248           code = get_elf_backend_data (abfd)->elf_machine_alt2;
1249           if (code == 0)
1250             return FALSE;
1251           break;
1252
1253         default:
1254           return FALSE;
1255         }
1256
1257       elf_elfheader (abfd)->e_machine = code;
1258
1259       return TRUE;
1260     }
1261
1262   return FALSE;
1263 }
1264
1265 /*
1266 CODE_FRAGMENT
1267
1268 .struct bfd_preserve
1269 .{
1270 .  void *marker;
1271 .  void *tdata;
1272 .  flagword flags;
1273 .  const struct bfd_arch_info *arch_info;
1274 .  struct sec *sections;
1275 .  struct sec **section_tail;
1276 .  unsigned int section_count;
1277 .  struct bfd_hash_table section_htab;
1278 .};
1279 .
1280 */
1281
1282 /*
1283 FUNCTION
1284         bfd_preserve_save
1285
1286 SYNOPSIS
1287         bfd_boolean bfd_preserve_save (bfd *, struct bfd_preserve *);
1288
1289 DESCRIPTION
1290         When testing an object for compatibility with a particular
1291         target back-end, the back-end object_p function needs to set
1292         up certain fields in the bfd on successfully recognizing the
1293         object.  This typically happens in a piecemeal fashion, with
1294         failures possible at many points.  On failure, the bfd is
1295         supposed to be restored to its initial state, which is
1296         virtually impossible.  However, restoring a subset of the bfd
1297         state works in practice.  This function stores the subset and
1298         reinitializes the bfd.
1299
1300 */
1301
1302 bfd_boolean
1303 bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve)
1304 {
1305   preserve->tdata = abfd->tdata.any;
1306   preserve->arch_info = abfd->arch_info;
1307   preserve->flags = abfd->flags;
1308   preserve->sections = abfd->sections;
1309   preserve->section_tail = abfd->section_tail;
1310   preserve->section_count = abfd->section_count;
1311   preserve->section_htab = abfd->section_htab;
1312
1313   if (! bfd_hash_table_init (&abfd->section_htab, bfd_section_hash_newfunc))
1314     return FALSE;
1315
1316   abfd->tdata.any = NULL;
1317   abfd->arch_info = &bfd_default_arch_struct;
1318   abfd->flags &= BFD_IN_MEMORY;
1319   abfd->sections = NULL;
1320   abfd->section_tail = &abfd->sections;
1321   abfd->section_count = 0;
1322
1323   return TRUE;
1324 }
1325
1326 /*
1327 FUNCTION
1328         bfd_preserve_restore
1329
1330 SYNOPSIS
1331         void bfd_preserve_restore (bfd *, struct bfd_preserve *);
1332
1333 DESCRIPTION
1334         This function restores bfd state saved by bfd_preserve_save.
1335         If MARKER is non-NULL in struct bfd_preserve then that block
1336         and all subsequently bfd_alloc'd memory is freed.
1337
1338 */
1339
1340 void
1341 bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
1342 {
1343   bfd_hash_table_free (&abfd->section_htab);
1344
1345   abfd->tdata.any = preserve->tdata;
1346   abfd->arch_info = preserve->arch_info;
1347   abfd->flags = preserve->flags;
1348   abfd->section_htab = preserve->section_htab;
1349   abfd->sections = preserve->sections;
1350   abfd->section_tail = preserve->section_tail;
1351   abfd->section_count = preserve->section_count;
1352
1353   /* bfd_release frees all memory more recently bfd_alloc'd than
1354      its arg, as well as its arg.  */
1355   if (preserve->marker != NULL)
1356     {
1357       bfd_release (abfd, preserve->marker);
1358       preserve->marker = NULL;
1359     }
1360 }
1361
1362 /*
1363 FUNCTION
1364         bfd_preserve_finish
1365
1366 SYNOPSIS
1367         void bfd_preserve_finish (bfd *, struct bfd_preserve *);
1368
1369 DESCRIPTION
1370         This function should be called when the bfd state saved by
1371         bfd_preserve_save is no longer needed.  ie. when the back-end
1372         object_p function returns with success.
1373
1374 */
1375
1376 void
1377 bfd_preserve_finish (bfd *abfd ATTRIBUTE_UNUSED, struct bfd_preserve *preserve)
1378 {
1379   /* It would be nice to be able to free more memory here, eg. old
1380      tdata, but that's not possible since these blocks are sitting
1381      inside bfd_alloc'd memory.  The section hash is on a separate
1382      objalloc.  */
1383   bfd_hash_table_free (&preserve->section_htab);
1384 }