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, 2004, 2005, 2006
   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., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, 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 .  {* The IOSTREAM, and corresponding IO vector that provide access
  49 .     to the file backing the BFD.  *}
  50 .  void *iostream;
  51 .  const struct bfd_iovec *iovec;
  52 .
  53 .  {* Is the file descriptor being cached?  That is, can it be closed as
  54 .     needed, and re-opened when accessed later?  *}
  55 .  bfd_boolean cacheable;
  56 .
  57 .  {* Marks whether there was a default target specified when the
  58 .     BFD was opened. This is used to select which matching algorithm
  59 .     to use to choose the back end.  *}
  60 .  bfd_boolean target_defaulted;
  61 .
  62 .  {* The caching routines use these to maintain a
  63 .     least-recently-used list of BFDs.  *}
  64 .  struct bfd *lru_prev, *lru_next;
  65 .
  66 .  {* When a file is closed by the caching routines, BFD retains
  67 .     state information on the file here...  *}
  68 .  ufile_ptr where;
  69 .
  70 .  {* ... and here: (``once'' means at least once).  *}
  71 .  bfd_boolean opened_once;
  72 .
  73 .  {* Set if we have a locally maintained mtime value, rather than
  74 .     getting it from the file each time.  *}
  75 .  bfd_boolean mtime_set;
  76 .
  77 .  {* File modified time, if mtime_set is TRUE.  *}
  78 .  long mtime;
  79 .
  80 .  {* Reserved for an unimplemented file locking extension.  *}
  81 .  int ifd;
  82 .
  83 .  {* The format which belongs to the BFD. (object, core, etc.)  *}
  84 .  bfd_format format;
  85 .
  86 .  {* The direction with which the BFD was opened.  *}
  87 .  enum bfd_direction
  88 .    {
  89 .      no_direction = 0,
  90 .      read_direction = 1,
  91 .      write_direction = 2,
  92 .      both_direction = 3
  93 .    }
  94 .  direction;
  95 .
  96 .  {* Format_specific flags.  *}
  97 .  flagword flags;
  98 .
  99 .  {* Currently my_archive is tested before adding origin to
 100 .     anything. I believe that this can become always an add of
 101 .     origin, with origin set to 0 for non archive files.  *}
 102 .  ufile_ptr origin;
 103 .
 104 .  {* Remember when output has begun, to stop strange things
 105 .     from happening.  *}
 106 .  bfd_boolean output_has_begun;
 107 .
 108 .  {* A hash table for section names.  *}
 109 .  struct bfd_hash_table section_htab;
 110 .
 111 .  {* Pointer to linked list of sections.  *}
 112 .  struct bfd_section *sections;
 113 .
 114 .  {* The last section on the section list.  *}
 115 .  struct bfd_section *section_last;
 116 .
 117 .  {* The number of sections.  *}
 118 .  unsigned int section_count;
 119 .
 120 .  {* Stuff only useful for object files:
 121 .     The start address.  *}
 122 .  bfd_vma start_address;
 123 .
 124 .  {* Used for input and output.  *}
 125 .  unsigned int symcount;
 126 .
 127 .  {* Symbol table for output BFD (with symcount entries).  *}
 128 .  struct bfd_symbol  **outsymbols;
 129 .
 130 .  {* Used for slurped dynamic symbol tables.  *}
 131 .  unsigned int dynsymcount;
 132 .
 133 .  {* Pointer to structure which contains architecture information.  *}
 134 .  const struct bfd_arch_info *arch_info;
 135 .
 136 .  {* Flag set if symbols from this BFD should not be exported.  *}
 137 .  bfd_boolean no_export;
 138 .
 139 .  {* Stuff only useful for archives.  *}
 140 .  void *arelt_data;
 141 .  struct bfd *my_archive;      {* The containing archive BFD.  *}
 142 .  struct bfd *next;            {* The next BFD in the archive.  *}
 143 .  struct bfd *archive_head;    {* The first BFD in the archive.  *}
 144 .  bfd_boolean has_armap;
 145 .
 146 .  {* A chain of BFD structures involved in a link.  *}
 147 .  struct bfd *link_next;
 148 .
 149 .  {* A field used by _bfd_generic_link_add_archive_symbols.  This will
 150 .     be used only for archive elements.  *}
 151 .  int archive_pass;
 152 .
 153 .  {* Used by the back end to hold private data.  *}
 154 .  union
 155 .    {
 156 .      struct aout_data_struct *aout_data;
 157 .      struct artdata *aout_ar_data;
 158 .      struct _oasys_data *oasys_obj_data;
 159 .      struct _oasys_ar_data *oasys_ar_data;
 160 .      struct coff_tdata *coff_obj_data;
 161 .      struct pe_tdata *pe_obj_data;
 162 .      struct xcoff_tdata *xcoff_obj_data;
 163 .      struct ecoff_tdata *ecoff_obj_data;
 164 .      struct ieee_data_struct *ieee_data;
 165 .      struct ieee_ar_data_struct *ieee_ar_data;
 166 .      struct srec_data_struct *srec_data;
 167 .      struct ihex_data_struct *ihex_data;
 168 .      struct tekhex_data_struct *tekhex_data;
 169 .      struct elf_obj_tdata *elf_obj_data;
 170 .      struct nlm_obj_tdata *nlm_obj_data;
 171 .      struct bout_data_struct *bout_data;
 172 .      struct mmo_data_struct *mmo_data;
 173 .      struct sun_core_struct *sun_core_data;
 174 .      struct sco5_core_struct *sco5_core_data;
 175 .      struct trad_core_struct *trad_core_data;
 176 .      struct som_data_struct *som_data;
 177 .      struct hpux_core_struct *hpux_core_data;
 178 .      struct hppabsd_core_struct *hppabsd_core_data;
 179 .      struct sgi_core_struct *sgi_core_data;
 180 .      struct lynx_core_struct *lynx_core_data;
 181 .      struct osf_core_struct *osf_core_data;
 182 .      struct cisco_core_struct *cisco_core_data;
 183 .      struct versados_data_struct *versados_data;
 184 .      struct netbsd_core_struct *netbsd_core_data;
 185 .      struct mach_o_data_struct *mach_o_data;
 186 .      struct mach_o_fat_data_struct *mach_o_fat_data;
 187 .      struct bfd_pef_data_struct *pef_data;
 188 .      struct bfd_pef_xlib_data_struct *pef_xlib_data;
 189 .      struct bfd_sym_data_struct *sym_data;
 190 .      void *any;
 191 .    }
 192 .  tdata;
 193 .
 194 .  {* Used by the application to hold private data.  *}
 195 .  void *usrdata;
 196 .
 197 .  {* Where all the allocated stuff under this BFD goes.  This is a
 198 .     struct objalloc *, but we use void * to avoid requiring the inclusion
 199 .     of objalloc.h.  *}
 200 .  void *memory;
 201 .};
 202 .
 203 */
 204
 205 #include "bfd.h"
 206 #include "bfdver.h"
 207 #include "sysdep.h"
 208 #include <stdarg.h>
 209 #include "libiberty.h"
 210 #include "safe-ctype.h"
 211 #include "bfdlink.h"
 212 #include "libbfd.h"
 213 #include "coff/internal.h"
 214 #include "coff/sym.h"
 215 #include "libcoff.h"
 216 #include "libecoff.h"
 217 #undef obj_symbols
 218 #include "elf-bfd.h"
 219
 220 #ifndef EXIT_FAILURE
 221 #define EXIT_FAILURE 1
 222 #endif
 223
 224 \f
 225 /* provide storage for subsystem, stack and heap data which may have been
 226    passed in on the command line.  Ld puts this data into a bfd_link_info
 227    struct which ultimately gets passed in to the bfd.  When it arrives, copy
 228    it to the following struct so that the data will be available in coffcode.h
 229    where it is needed.  The typedef's used are defined in bfd.h */
 230 \f
 231 /*
 232 SECTION
 233         Error reporting
 234
 235         Most BFD functions return nonzero on success (check their
 236         individual documentation for precise semantics).  On an error,
 237         they call <<bfd_set_error>> to set an error condition that callers
 238         can check by calling <<bfd_get_error>>.
 239         If that returns <<bfd_error_system_call>>, then check
 240         <<errno>>.
 241
 242         The easiest way to report a BFD error to the user is to
 243         use <<bfd_perror>>.
 244
 245 SUBSECTION
 246         Type <<bfd_error_type>>
 247
 248         The values returned by <<bfd_get_error>> are defined by the
 249         enumerated type <<bfd_error_type>>.
 250
 251 CODE_FRAGMENT
 252 .
 253 .typedef enum bfd_error
 254 .{
 255 .  bfd_error_no_error = 0,
 256 .  bfd_error_system_call,
 257 .  bfd_error_invalid_target,
 258 .  bfd_error_wrong_format,
 259 .  bfd_error_wrong_object_format,
 260 .  bfd_error_invalid_operation,
 261 .  bfd_error_no_memory,
 262 .  bfd_error_no_symbols,
 263 .  bfd_error_no_armap,
 264 .  bfd_error_no_more_archived_files,
 265 .  bfd_error_malformed_archive,
 266 .  bfd_error_file_not_recognized,
 267 .  bfd_error_file_ambiguously_recognized,
 268 .  bfd_error_no_contents,
 269 .  bfd_error_nonrepresentable_section,
 270 .  bfd_error_no_debug_section,
 271 .  bfd_error_bad_value,
 272 .  bfd_error_file_truncated,
 273 .  bfd_error_file_too_big,
 274 .  bfd_error_invalid_error_code
 275 .}
 276 .bfd_error_type;
 277 .
 278 */
 279
 280 static bfd_error_type bfd_error = bfd_error_no_error;
 281
 282 const char *const bfd_errmsgs[] =
 283 {
 284   N_("No error"),
 285   N_("System call error"),
 286   N_("Invalid bfd target"),
 287   N_("File in wrong format"),
 288   N_("Archive object file in wrong format"),
 289   N_("Invalid operation"),
 290   N_("Memory exhausted"),
 291   N_("No symbols"),
 292   N_("Archive has no index; run ranlib to add one"),
 293   N_("No more archived files"),
 294   N_("Malformed archive"),
 295   N_("File format not recognized"),
 296   N_("File format is ambiguous"),
 297   N_("Section has no contents"),
 298   N_("Nonrepresentable section on output"),
 299   N_("Symbol needs debug section which does not exist"),
 300   N_("Bad value"),
 301   N_("File truncated"),
 302   N_("File too big"),
 303   N_("#<Invalid error code>")
 304 };
 305
 306 /*
 307 FUNCTION
 308         bfd_get_error
 309
 310 SYNOPSIS
 311         bfd_error_type bfd_get_error (void);
 312
 313 DESCRIPTION
 314         Return the current BFD error condition.
 315 */
 316
 317 bfd_error_type
 318 bfd_get_error (void)
 319 {
 320   return bfd_error;
 321 }
 322
 323 /*
 324 FUNCTION
 325         bfd_set_error
 326
 327 SYNOPSIS
 328         void bfd_set_error (bfd_error_type error_tag);
 329
 330 DESCRIPTION
 331         Set the BFD error condition to be @var{error_tag}.
 332 */
 333
 334 void
 335 bfd_set_error (bfd_error_type error_tag)
 336 {
 337   bfd_error = error_tag;
 338 }
 339
 340 /*
 341 FUNCTION
 342         bfd_errmsg
 343
 344 SYNOPSIS
 345         const char *bfd_errmsg (bfd_error_type error_tag);
 346
 347 DESCRIPTION
 348         Return a string describing the error @var{error_tag}, or
 349         the system error if @var{error_tag} is <<bfd_error_system_call>>.
 350 */
 351
 352 const char *
 353 bfd_errmsg (bfd_error_type error_tag)
 354 {
 355 #ifndef errno
 356   extern int errno;
 357 #endif
 358   if (error_tag == bfd_error_system_call)
 359     return xstrerror (errno);
 360
 361   if (error_tag > bfd_error_invalid_error_code)
 362     error_tag = bfd_error_invalid_error_code;   /* sanity check */
 363
 364   return _(bfd_errmsgs [error_tag]);
 365 }
 366
 367 /*
 368 FUNCTION
 369         bfd_perror
 370
 371 SYNOPSIS
 372         void bfd_perror (const char *message);
 373
 374 DESCRIPTION
 375         Print to the standard error stream a string describing the
 376         last BFD error that occurred, or the last system error if
 377         the last BFD error was a system call failure.  If @var{message}
 378         is non-NULL and non-empty, the error string printed is preceded
 379         by @var{message}, a colon, and a space.  It is followed by a newline.
 380 */
 381
 382 void
 383 bfd_perror (const char *message)
 384 {
 385   if (bfd_get_error () == bfd_error_system_call)
 386     /* Must be a system error then.  */
 387     perror ((char *) message);
 388   else
 389     {
 390       if (message == NULL || *message == '\0')
 391         fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
 392       else
 393         fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
 394     }
 395 }
 396
 397 /*
 398 SUBSECTION
 399         BFD error handler
 400
 401         Some BFD functions want to print messages describing the
 402         problem.  They call a BFD error handler function.  This
 403         function may be overridden by the program.
 404
 405         The BFD error handler acts like printf.
 406
 407 CODE_FRAGMENT
 408 .
 409 .typedef void (*bfd_error_handler_type) (const char *, ...);
 410 .
 411 */
 412
 413 /* The program name used when printing BFD error messages.  */
 414
 415 static const char *_bfd_error_program_name;
 416
 417 /* This is the default routine to handle BFD error messages.
 418    Like fprintf (stderr, ...), but also handles some extra format specifiers.
 419
 420    %A section name from section.  For group components, print group name too.
 421    %B file name from bfd.  For archive components, prints archive too.
 422
 423    Note - because these two extra format specifiers require special handling
 424    they are scanned for and processed in this function, before calling
 425    vfprintf.  This means that the *arguments* for these format specifiers
 426    must be the first ones in the variable argument list, regardless of where
 427    the specifiers appear in the format string.  Thus for example calling
 428    this function with a format string of:
 429
 430       "blah %s blah %A blah %d blah %B"
 431
 432    would involve passing the arguments as:
 433
 434       "blah %s blah %A blah %d blah %B",
 435         asection_for_the_%A,
 436         bfd_for_the_%B,
 437         string_for_the_%s,
 438         integer_for_the_%d);
 439  */
 440
 441 void
 442 _bfd_default_error_handler (const char *fmt, ...)
 443 {
 444   va_list ap;
 445   char *bufp;
 446   const char *new_fmt, *p;
 447   size_t avail = 1000;
 448   char buf[1000];
 449
 450   if (_bfd_error_program_name != NULL)
 451     fprintf (stderr, "%s: ", _bfd_error_program_name);
 452   else
 453     fprintf (stderr, "BFD: ");
 454
 455   va_start (ap, fmt);
 456   new_fmt = fmt;
 457   bufp = buf;
 458
 459   /* Reserve enough space for the existing format string.  */
 460   avail -= strlen (fmt) + 1;
 461   if (avail > 1000)
 462     _exit (EXIT_FAILURE);
 463
 464   p = fmt;
 465   while (1)
 466     {
 467       char *q;
 468       size_t len, extra, trim;
 469
 470       p = strchr (p, '%');
 471       if (p == NULL || p[1] == '\0')
 472         {
 473           if (new_fmt == buf)
 474             {
 475               len = strlen (fmt);
 476               memcpy (bufp, fmt, len + 1);
 477             }
 478           break;
 479         }
 480
 481       if (p[1] == 'A' || p[1] == 'B')
 482         {
 483           len = p - fmt;
 484           memcpy (bufp, fmt, len);
 485           bufp += len;
 486           fmt = p + 2;
 487           new_fmt = buf;
 488
 489           /* If we run out of space, tough, you lose your ridiculously
 490              long file or section name.  It's not safe to try to alloc
 491              memory here;  We might be printing an out of memory message.  */
 492           if (avail == 0)
 493             {
 494               *bufp++ = '*';
 495               *bufp++ = '*';
 496               *bufp = '\0';
 497             }
 498           else
 499             {
 500               if (p[1] == 'B')
 501                 {
 502                   bfd *abfd = va_arg (ap, bfd *);
 503
 504                   if (abfd == NULL)
 505                     /* Invoking %B with a null bfd pointer is an internal error.  */
 506                     abort ();
 507                   else if (abfd->my_archive)
 508                     snprintf (bufp, avail, "%s(%s)",
 509                               abfd->my_archive->filename, abfd->filename);
 510                   else
 511                     snprintf (bufp, avail, "%s", abfd->filename);
 512                 }
 513               else
 514                 {
 515                   asection *sec = va_arg (ap, asection *);
 516                   bfd *abfd;
 517                   const char *group = NULL;
 518                   struct coff_comdat_info *ci;
 519
 520                   if (sec == NULL)
 521                     /* Invoking %A with a null section pointer is an internal error.  */
 522                     abort ();
 523                   abfd = sec->owner;
 524                   if (abfd != NULL
 525                       && bfd_get_flavour (abfd) == bfd_target_elf_flavour
 526                       && elf_next_in_group (sec) != NULL
 527                       && (sec->flags & SEC_GROUP) == 0)
 528                     group = elf_group_name (sec);
 529                   else if (abfd != NULL
 530                            && bfd_get_flavour (abfd) == bfd_target_coff_flavour
 531                            && (ci = bfd_coff_get_comdat_section (sec->owner,
 532                                                                  sec)) != NULL)
 533                     group = ci->name;
 534                   if (group != NULL)
 535                     snprintf (bufp, avail, "%s[%s]", sec->name, group);
 536                   else
 537                     snprintf (bufp, avail, "%s", sec->name);
 538                 }
 539               len = strlen (bufp);
 540               avail = avail - len + 2;
 541
 542               /* We need to replace any '%' we printed by "%%".
 543                  First count how many.  */
 544               q = bufp;
 545               bufp += len;
 546               extra = 0;
 547               while ((q = strchr (q, '%')) != NULL)
 548                 {
 549                   ++q;
 550                   ++extra;
 551                 }
 552
 553               /* If there isn't room, trim off the end of the string.  */
 554               q = bufp;
 555               bufp += extra;
 556               if (extra > avail)
 557                 {
 558                   trim = extra - avail;
 559                   bufp -= trim;
 560                   do
 561                     {
 562                       if (*--q == '%')
 563                         --extra;
 564                     }
 565                   while (--trim != 0);
 566                   *q = '\0';
 567                   avail = extra;
 568                 }
 569               avail -= extra;
 570
 571               /* Now double all '%' chars, shuffling the string as we go.  */
 572               while (extra != 0)
 573                 {
 574                   while ((q[extra] = *q) != '%')
 575                     --q;
 576                   q[--extra] = '%';
 577                   --q;
 578                 }
 579             }
 580         }
 581       p = p + 2;
 582     }
 583
 584   vfprintf (stderr, new_fmt, ap);
 585   va_end (ap);
 586
 587   putc ('\n', stderr);
 588 }
 589
 590 /* This is a function pointer to the routine which should handle BFD
 591    error messages.  It is called when a BFD routine encounters an
 592    error for which it wants to print a message.  Going through a
 593    function pointer permits a program linked against BFD to intercept
 594    the messages and deal with them itself.  */
 595
 596 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
 597
 598 /*
 599 FUNCTION
 600         bfd_set_error_handler
 601
 602 SYNOPSIS
 603         bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
 604
 605 DESCRIPTION
 606         Set the BFD error handler function.  Returns the previous
 607         function.
 608 */
 609
 610 bfd_error_handler_type
 611 bfd_set_error_handler (bfd_error_handler_type pnew)
 612 {
 613   bfd_error_handler_type pold;
 614
 615   pold = _bfd_error_handler;
 616   _bfd_error_handler = pnew;
 617   return pold;
 618 }
 619
 620 /*
 621 FUNCTION
 622         bfd_set_error_program_name
 623
 624 SYNOPSIS
 625         void bfd_set_error_program_name (const char *);
 626
 627 DESCRIPTION
 628         Set the program name to use when printing a BFD error.  This
 629         is printed before the error message followed by a colon and
 630         space.  The string must not be changed after it is passed to
 631         this function.
 632 */
 633
 634 void
 635 bfd_set_error_program_name (const char *name)
 636 {
 637   _bfd_error_program_name = name;
 638 }
 639
 640 /*
 641 FUNCTION
 642         bfd_get_error_handler
 643
 644 SYNOPSIS
 645         bfd_error_handler_type bfd_get_error_handler (void);
 646
 647 DESCRIPTION
 648         Return the BFD error handler function.
 649 */
 650
 651 bfd_error_handler_type
 652 bfd_get_error_handler (void)
 653 {
 654   return _bfd_error_handler;
 655 }
 656 \f
 657 /*
 658 SECTION
 659         Miscellaneous
 660
 661 SUBSECTION
 662         Miscellaneous functions
 663 */
 664
 665 /*
 666 FUNCTION
 667         bfd_get_reloc_upper_bound
 668
 669 SYNOPSIS
 670         long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
 671
 672 DESCRIPTION
 673         Return the number of bytes required to store the
 674         relocation information associated with section @var{sect}
 675         attached to bfd @var{abfd}.  If an error occurs, return -1.
 676
 677 */
 678
 679 long
 680 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
 681 {
 682   if (abfd->format != bfd_object)
 683     {
 684       bfd_set_error (bfd_error_invalid_operation);
 685       return -1;
 686     }
 687
 688   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
 689 }
 690
 691 /*
 692 FUNCTION
 693         bfd_canonicalize_reloc
 694
 695 SYNOPSIS
 696         long bfd_canonicalize_reloc
 697           (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
 698
 699 DESCRIPTION
 700         Call the back end associated with the open BFD
 701         @var{abfd} and translate the external form of the relocation
 702         information attached to @var{sec} into the internal canonical
 703         form.  Place the table into memory at @var{loc}, which has
 704         been preallocated, usually by a call to
 705         <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
 706         -1 on error.
 707
 708         The @var{syms} table is also needed for horrible internal magic
 709         reasons.
 710
 711 */
 712 long
 713 bfd_canonicalize_reloc (bfd *abfd,
 714                         sec_ptr asect,
 715                         arelent **location,
 716                         asymbol **symbols)
 717 {
 718   if (abfd->format != bfd_object)
 719     {
 720       bfd_set_error (bfd_error_invalid_operation);
 721       return -1;
 722     }
 723
 724   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
 725                    (abfd, asect, location, symbols));
 726 }
 727
 728 /*
 729 FUNCTION
 730         bfd_set_reloc
 731
 732 SYNOPSIS
 733         void bfd_set_reloc
 734           (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
 735
 736 DESCRIPTION
 737         Set the relocation pointer and count within
 738         section @var{sec} to the values @var{rel} and @var{count}.
 739         The argument @var{abfd} is ignored.
 740
 741 */
 742
 743 void
 744 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
 745                sec_ptr asect,
 746                arelent **location,
 747                unsigned int count)
 748 {
 749   asect->orelocation = location;
 750   asect->reloc_count = count;
 751 }
 752
 753 /*
 754 FUNCTION
 755         bfd_set_file_flags
 756
 757 SYNOPSIS
 758         bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
 759
 760 DESCRIPTION
 761         Set the flag word in the BFD @var{abfd} to the value @var{flags}.
 762
 763         Possible errors are:
 764         o <<bfd_error_wrong_format>> - The target bfd was not of object format.
 765         o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
 766         o <<bfd_error_invalid_operation>> -
 767         The flag word contained a bit which was not applicable to the
 768         type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
 769         on a BFD format which does not support demand paging.
 770
 771 */
 772
 773 bfd_boolean
 774 bfd_set_file_flags (bfd *abfd, flagword flags)
 775 {
 776   if (abfd->format != bfd_object)
 777     {
 778       bfd_set_error (bfd_error_wrong_format);
 779       return FALSE;
 780     }
 781
 782   if (bfd_read_p (abfd))
 783     {
 784       bfd_set_error (bfd_error_invalid_operation);
 785       return FALSE;
 786     }
 787
 788   bfd_get_file_flags (abfd) = flags;
 789   if ((flags & bfd_applicable_file_flags (abfd)) != flags)
 790     {
 791       bfd_set_error (bfd_error_invalid_operation);
 792       return FALSE;
 793     }
 794
 795   return TRUE;
 796 }
 797
 798 void
 799 bfd_assert (const char *file, int line)
 800 {
 801   (*_bfd_error_handler) (_("BFD %s assertion fail %s:%d"),
 802                          BFD_VERSION_STRING, file, line);
 803 }
 804
 805 /* A more or less friendly abort message.  In libbfd.h abort is
 806    defined to call this function.  */
 807
 808 void
 809 _bfd_abort (const char *file, int line, const char *fn)
 810 {
 811   if (fn != NULL)
 812     (*_bfd_error_handler)
 813       (_("BFD %s internal error, aborting at %s line %d in %s\n"),
 814        BFD_VERSION_STRING, file, line, fn);
 815   else
 816     (*_bfd_error_handler)
 817       (_("BFD %s internal error, aborting at %s line %d\n"),
 818        BFD_VERSION_STRING, file, line);
 819   (*_bfd_error_handler) (_("Please report this bug.\n"));
 820   _exit (EXIT_FAILURE);
 821 }
 822
 823 /*
 824 FUNCTION
 825         bfd_get_arch_size
 826
 827 SYNOPSIS
 828         int bfd_get_arch_size (bfd *abfd);
 829
 830 DESCRIPTION
 831         Returns the architecture address size, in bits, as determined
 832         by the object file's format.  For ELF, this information is
 833         included in the header.
 834
 835 RETURNS
 836         Returns the arch size in bits if known, <<-1>> otherwise.
 837 */
 838
 839 int
 840 bfd_get_arch_size (bfd *abfd)
 841 {
 842   if (abfd->xvec->flavour == bfd_target_elf_flavour)
 843     return get_elf_backend_data (abfd)->s->arch_size;
 844
 845   return -1;
 846 }
 847
 848 /*
 849 FUNCTION
 850         bfd_get_sign_extend_vma
 851
 852 SYNOPSIS
 853         int bfd_get_sign_extend_vma (bfd *abfd);
 854
 855 DESCRIPTION
 856         Indicates if the target architecture "naturally" sign extends
 857         an address.  Some architectures implicitly sign extend address
 858         values when they are converted to types larger than the size
 859         of an address.  For instance, bfd_get_start_address() will
 860         return an address sign extended to fill a bfd_vma when this is
 861         the case.
 862
 863 RETURNS
 864         Returns <<1>> if the target architecture is known to sign
 865         extend addresses, <<0>> if the target architecture is known to
 866         not sign extend addresses, and <<-1>> otherwise.
 867 */
 868
 869 int
 870 bfd_get_sign_extend_vma (bfd *abfd)
 871 {
 872   char *name;
 873
 874   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
 875     return get_elf_backend_data (abfd)->sign_extend_vma;
 876
 877   name = bfd_get_target (abfd);
 878
 879   /* Return a proper value for DJGPP & PE COFF (x86 COFF variants).
 880      This function is required for DWARF2 support, but there is
 881      no place to store this information in the COFF back end.
 882      Should enough other COFF targets add support for DWARF2,
 883      a place will have to be found.  Until then, this hack will do.  */
 884   if (strncmp (name, "coff-go32", sizeof ("coff-go32") - 1) == 0
 885       || strcmp (name, "pe-i386") == 0
 886       || strcmp (name, "pei-i386") == 0)
 887     return 1;
 888
 889   bfd_set_error (bfd_error_wrong_format);
 890   return -1;
 891 }
 892
 893 /*
 894 FUNCTION
 895         bfd_set_start_address
 896
 897 SYNOPSIS
 898         bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
 899
 900 DESCRIPTION
 901         Make @var{vma} the entry point of output BFD @var{abfd}.
 902
 903 RETURNS
 904         Returns <<TRUE>> on success, <<FALSE>> otherwise.
 905 */
 906
 907 bfd_boolean
 908 bfd_set_start_address (bfd *abfd, bfd_vma vma)
 909 {
 910   abfd->start_address = vma;
 911   return TRUE;
 912 }
 913
 914 /*
 915 FUNCTION
 916         bfd_get_gp_size
 917
 918 SYNOPSIS
 919         unsigned int bfd_get_gp_size (bfd *abfd);
 920
 921 DESCRIPTION
 922         Return the maximum size of objects to be optimized using the GP
 923         register under MIPS ECOFF.  This is typically set by the <<-G>>
 924         argument to the compiler, assembler or linker.
 925 */
 926
 927 unsigned int
 928 bfd_get_gp_size (bfd *abfd)
 929 {
 930   if (abfd->format == bfd_object)
 931     {
 932       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 933         return ecoff_data (abfd)->gp_size;
 934       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 935         return elf_gp_size (abfd);
 936     }
 937   return 0;
 938 }
 939
 940 /*
 941 FUNCTION
 942         bfd_set_gp_size
 943
 944 SYNOPSIS
 945         void bfd_set_gp_size (bfd *abfd, unsigned int i);
 946
 947 DESCRIPTION
 948         Set the maximum size of objects to be optimized using the GP
 949         register under ECOFF or MIPS ELF.  This is typically set by
 950         the <<-G>> argument to the compiler, assembler or linker.
 951 */
 952
 953 void
 954 bfd_set_gp_size (bfd *abfd, unsigned int i)
 955 {
 956   /* Don't try to set GP size on an archive or core file!  */
 957   if (abfd->format != bfd_object)
 958     return;
 959
 960   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 961     ecoff_data (abfd)->gp_size = i;
 962   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 963     elf_gp_size (abfd) = i;
 964 }
 965
 966 /* Get the GP value.  This is an internal function used by some of the
 967    relocation special_function routines on targets which support a GP
 968    register.  */
 969
 970 bfd_vma
 971 _bfd_get_gp_value (bfd *abfd)
 972 {
 973   if (! abfd)
 974     return 0;
 975   if (abfd->format != bfd_object)
 976     return 0;
 977
 978   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 979     return ecoff_data (abfd)->gp;
 980   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 981     return elf_gp (abfd);
 982
 983   return 0;
 984 }
 985
 986 /* Set the GP value.  */
 987
 988 void
 989 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
 990 {
 991   if (! abfd)
 992     BFD_FAIL ();
 993   if (abfd->format != bfd_object)
 994     return;
 995
 996   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 997     ecoff_data (abfd)->gp = v;
 998   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 999     elf_gp (abfd) = v;
1000 }
1001
1002 /*
1003 FUNCTION
1004         bfd_scan_vma
1005
1006 SYNOPSIS
1007         bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1008
1009 DESCRIPTION
1010         Convert, like <<strtoul>>, a numerical expression
1011         @var{string} into a <<bfd_vma>> integer, and return that integer.
1012         (Though without as many bells and whistles as <<strtoul>>.)
1013         The expression is assumed to be unsigned (i.e., positive).
1014         If given a @var{base}, it is used as the base for conversion.
1015         A base of 0 causes the function to interpret the string
1016         in hex if a leading "0x" or "0X" is found, otherwise
1017         in octal if a leading zero is found, otherwise in decimal.
1018
1019         If the value would overflow, the maximum <<bfd_vma>> value is
1020         returned.
1021 */
1022
1023 bfd_vma
1024 bfd_scan_vma (const char *string, const char **end, int base)
1025 {
1026   bfd_vma value;
1027   bfd_vma cutoff;
1028   unsigned int cutlim;
1029   int overflow;
1030
1031   /* Let the host do it if possible.  */
1032   if (sizeof (bfd_vma) <= sizeof (unsigned long))
1033     return strtoul (string, (char **) end, base);
1034
1035 #ifdef HAVE_STRTOULL
1036   if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1037     return strtoull (string, (char **) end, base);
1038 #endif
1039
1040   if (base == 0)
1041     {
1042       if (string[0] == '0')
1043         {
1044           if ((string[1] == 'x') || (string[1] == 'X'))
1045             base = 16;
1046           else
1047             base = 8;
1048         }
1049     }
1050
1051   if ((base < 2) || (base > 36))
1052     base = 10;
1053
1054   if (base == 16
1055       && string[0] == '0'
1056       && (string[1] == 'x' || string[1] == 'X')
1057       && ISXDIGIT (string[2]))
1058     {
1059       string += 2;
1060     }
1061
1062   cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1063   cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1064   value = 0;
1065   overflow = 0;
1066   while (1)
1067     {
1068       unsigned int digit;
1069
1070       digit = *string;
1071       if (ISDIGIT (digit))
1072         digit = digit - '0';
1073       else if (ISALPHA (digit))
1074         digit = TOUPPER (digit) - 'A' + 10;
1075       else
1076         break;
1077       if (digit >= (unsigned int) base)
1078         break;
1079       if (value > cutoff || (value == cutoff && digit > cutlim))
1080         overflow = 1;
1081       value = value * base + digit;
1082       ++string;
1083     }
1084
1085   if (overflow)
1086     value = ~ (bfd_vma) 0;
1087
1088   if (end != NULL)
1089     *end = string;
1090
1091   return value;
1092 }
1093
1094 /*
1095 FUNCTION
1096         bfd_copy_private_header_data
1097
1098 SYNOPSIS
1099         bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1100
1101 DESCRIPTION
1102         Copy private BFD header information from the BFD @var{ibfd} to the
1103         the BFD @var{obfd}.  This copies information that may require
1104         sections to exist, but does not require symbol tables.  Return
1105         <<true>> on success, <<false>> on error.
1106         Possible error returns are:
1107
1108         o <<bfd_error_no_memory>> -
1109         Not enough memory exists to create private data for @var{obfd}.
1110
1111 .#define bfd_copy_private_header_data(ibfd, obfd) \
1112 .     BFD_SEND (obfd, _bfd_copy_private_header_data, \
1113 .               (ibfd, obfd))
1114
1115 */
1116
1117 /*
1118 FUNCTION
1119         bfd_copy_private_bfd_data
1120
1121 SYNOPSIS
1122         bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1123
1124 DESCRIPTION
1125         Copy private BFD information from the BFD @var{ibfd} to the
1126         the BFD @var{obfd}.  Return <<TRUE>> on success, <<FALSE>> on error.
1127         Possible error returns are:
1128
1129         o <<bfd_error_no_memory>> -
1130         Not enough memory exists to create private data for @var{obfd}.
1131
1132 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1133 .     BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1134 .               (ibfd, obfd))
1135
1136 */
1137
1138 /*
1139 FUNCTION
1140         bfd_merge_private_bfd_data
1141
1142 SYNOPSIS
1143         bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1144
1145 DESCRIPTION
1146         Merge private BFD information from the BFD @var{ibfd} to the
1147         the output file BFD @var{obfd} when linking.  Return <<TRUE>>
1148         on success, <<FALSE>> on error.  Possible error returns are:
1149
1150         o <<bfd_error_no_memory>> -
1151         Not enough memory exists to create private data for @var{obfd}.
1152
1153 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1154 .     BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1155 .               (ibfd, obfd))
1156
1157 */
1158
1159 /*
1160 FUNCTION
1161         bfd_set_private_flags
1162
1163 SYNOPSIS
1164         bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1165
1166 DESCRIPTION
1167         Set private BFD flag information in the BFD @var{abfd}.
1168         Return <<TRUE>> on success, <<FALSE>> on error.  Possible error
1169         returns are:
1170
1171         o <<bfd_error_no_memory>> -
1172         Not enough memory exists to create private data for @var{obfd}.
1173
1174 .#define bfd_set_private_flags(abfd, flags) \
1175 .     BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1176
1177 */
1178
1179 /*
1180 FUNCTION
1181         Other functions
1182
1183 DESCRIPTION
1184         The following functions exist but have not yet been documented.
1185
1186 .#define bfd_sizeof_headers(abfd, info) \
1187 .       BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1188 .
1189 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1190 .       BFD_SEND (abfd, _bfd_find_nearest_line, \
1191 .                 (abfd, sec, syms, off, file, func, line))
1192 .
1193 .#define bfd_find_line(abfd, syms, sym, file, line) \
1194 .       BFD_SEND (abfd, _bfd_find_line, \
1195 .                 (abfd, syms, sym, file, line))
1196 .
1197 .#define bfd_find_inliner_info(abfd, file, func, line) \
1198 .       BFD_SEND (abfd, _bfd_find_inliner_info, \
1199 .                 (abfd, file, func, line))
1200 .
1201 .#define bfd_debug_info_start(abfd) \
1202 .       BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1203 .
1204 .#define bfd_debug_info_end(abfd) \
1205 .       BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1206 .
1207 .#define bfd_debug_info_accumulate(abfd, section) \
1208 .       BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1209 .
1210 .#define bfd_stat_arch_elt(abfd, stat) \
1211 .       BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1212 .
1213 .#define bfd_update_armap_timestamp(abfd) \
1214 .       BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1215 .
1216 .#define bfd_set_arch_mach(abfd, arch, mach)\
1217 .       BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1218 .
1219 .#define bfd_relax_section(abfd, section, link_info, again) \
1220 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1221 .
1222 .#define bfd_gc_sections(abfd, link_info) \
1223 .       BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1224 .
1225 .#define bfd_merge_sections(abfd, link_info) \
1226 .       BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1227 .
1228 .#define bfd_is_group_section(abfd, sec) \
1229 .       BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1230 .
1231 .#define bfd_discard_group(abfd, sec) \
1232 .       BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1233 .
1234 .#define bfd_link_hash_table_create(abfd) \
1235 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1236 .
1237 .#define bfd_link_hash_table_free(abfd, hash) \
1238 .       BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1239 .
1240 .#define bfd_link_add_symbols(abfd, info) \
1241 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1242 .
1243 .#define bfd_link_just_syms(abfd, sec, info) \
1244 .       BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1245 .
1246 .#define bfd_final_link(abfd, info) \
1247 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1248 .
1249 .#define bfd_free_cached_info(abfd) \
1250 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1251 .
1252 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1253 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1254 .
1255 .#define bfd_print_private_bfd_data(abfd, file)\
1256 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1257 .
1258 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1259 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1260 .
1261 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1262 .       BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1263 .                                                   dyncount, dynsyms, ret))
1264 .
1265 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1266 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1267 .
1268 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1269 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1270 .
1271 .extern bfd_byte *bfd_get_relocated_section_contents
1272 .  (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1273 .   bfd_boolean, asymbol **);
1274 .
1275
1276 */
1277
1278 bfd_byte *
1279 bfd_get_relocated_section_contents (bfd *abfd,
1280                                     struct bfd_link_info *link_info,
1281                                     struct bfd_link_order *link_order,
1282                                     bfd_byte *data,
1283                                     bfd_boolean relocatable,
1284                                     asymbol **symbols)
1285 {
1286   bfd *abfd2;
1287   bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1288                    bfd_byte *, bfd_boolean, asymbol **);
1289
1290   if (link_order->type == bfd_indirect_link_order)
1291     {
1292       abfd2 = link_order->u.indirect.section->owner;
1293       if (abfd2 == NULL)
1294         abfd2 = abfd;
1295     }
1296   else
1297     abfd2 = abfd;
1298
1299   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1300
1301   return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1302 }
1303
1304 /* Record information about an ELF program header.  */
1305
1306 bfd_boolean
1307 bfd_record_phdr (bfd *abfd,
1308                  unsigned long type,
1309                  bfd_boolean flags_valid,
1310                  flagword flags,
1311                  bfd_boolean at_valid,
1312                  bfd_vma at,
1313                  bfd_boolean includes_filehdr,
1314                  bfd_boolean includes_phdrs,
1315                  unsigned int count,
1316                  asection **secs)
1317 {
1318   struct elf_segment_map *m, **pm;
1319   bfd_size_type amt;
1320
1321   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1322     return TRUE;
1323
1324   amt = sizeof (struct elf_segment_map);
1325   amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1326   m = bfd_alloc (abfd, amt);
1327   if (m == NULL)
1328     return FALSE;
1329
1330   m->next = NULL;
1331   m->p_type = type;
1332   m->p_flags = flags;
1333   m->p_paddr = at;
1334   m->p_flags_valid = flags_valid;
1335   m->p_paddr_valid = at_valid;
1336   m->includes_filehdr = includes_filehdr;
1337   m->includes_phdrs = includes_phdrs;
1338   m->count = count;
1339   m->p_align_valid = FALSE;
1340   m->p_align = 0;
1341   if (count > 0)
1342     memcpy (m->sections, secs, count * sizeof (asection *));
1343
1344   for (pm = &elf_tdata (abfd)->segment_map; *pm != NULL; pm = &(*pm)->next)
1345     ;
1346   *pm = m;
1347
1348   return TRUE;
1349 }
1350
1351 void
1352 bfd_sprintf_vma (bfd *abfd, char *buf, bfd_vma value)
1353 {
1354   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1355     get_elf_backend_data (abfd)->elf_backend_sprintf_vma (abfd, buf, value);
1356   else
1357     sprintf_vma (buf, value);
1358 }
1359
1360 void
1361 bfd_fprintf_vma (bfd *abfd, void *stream, bfd_vma value)
1362 {
1363   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1364     get_elf_backend_data (abfd)->elf_backend_fprintf_vma (abfd, stream, value);
1365   else
1366     fprintf_vma ((FILE *) stream, value);
1367 }
1368
1369 /*
1370 FUNCTION
1371         bfd_alt_mach_code
1372
1373 SYNOPSIS
1374         bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1375
1376 DESCRIPTION
1377
1378         When more than one machine code number is available for the
1379         same machine type, this function can be used to switch between
1380         the preferred one (alternative == 0) and any others.  Currently,
1381         only ELF supports this feature, with up to two alternate
1382         machine codes.
1383 */
1384
1385 bfd_boolean
1386 bfd_alt_mach_code (bfd *abfd, int alternative)
1387 {
1388   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1389     {
1390       int code;
1391
1392       switch (alternative)
1393         {
1394         case 0:
1395           code = get_elf_backend_data (abfd)->elf_machine_code;
1396           break;
1397
1398         case 1:
1399           code = get_elf_backend_data (abfd)->elf_machine_alt1;
1400           if (code == 0)
1401             return FALSE;
1402           break;
1403
1404         case 2:
1405           code = get_elf_backend_data (abfd)->elf_machine_alt2;
1406           if (code == 0)
1407             return FALSE;
1408           break;
1409
1410         default:
1411           return FALSE;
1412         }
1413
1414       elf_elfheader (abfd)->e_machine = code;
1415
1416       return TRUE;
1417     }
1418
1419   return FALSE;
1420 }
1421
1422 /*
1423 CODE_FRAGMENT
1424
1425 .struct bfd_preserve
1426 .{
1427 .  void *marker;
1428 .  void *tdata;
1429 .  flagword flags;
1430 .  const struct bfd_arch_info *arch_info;
1431 .  struct bfd_section *sections;
1432 .  struct bfd_section *section_last;
1433 .  unsigned int section_count;
1434 .  struct bfd_hash_table section_htab;
1435 .};
1436 .
1437 */
1438
1439 /*
1440 FUNCTION
1441         bfd_preserve_save
1442
1443 SYNOPSIS
1444         bfd_boolean bfd_preserve_save (bfd *, struct bfd_preserve *);
1445
1446 DESCRIPTION
1447         When testing an object for compatibility with a particular
1448         target back-end, the back-end object_p function needs to set
1449         up certain fields in the bfd on successfully recognizing the
1450         object.  This typically happens in a piecemeal fashion, with
1451         failures possible at many points.  On failure, the bfd is
1452         supposed to be restored to its initial state, which is
1453         virtually impossible.  However, restoring a subset of the bfd
1454         state works in practice.  This function stores the subset and
1455         reinitializes the bfd.
1456
1457 */
1458
1459 bfd_boolean
1460 bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve)
1461 {
1462   preserve->tdata = abfd->tdata.any;
1463   preserve->arch_info = abfd->arch_info;
1464   preserve->flags = abfd->flags;
1465   preserve->sections = abfd->sections;
1466   preserve->section_last = abfd->section_last;
1467   preserve->section_count = abfd->section_count;
1468   preserve->section_htab = abfd->section_htab;
1469
1470   if (! bfd_hash_table_init (&abfd->section_htab, bfd_section_hash_newfunc,
1471                              sizeof (struct section_hash_entry)))
1472     return FALSE;
1473
1474   abfd->tdata.any = NULL;
1475   abfd->arch_info = &bfd_default_arch_struct;
1476   abfd->flags &= BFD_IN_MEMORY;
1477   abfd->sections = NULL;
1478   abfd->section_last = NULL;
1479   abfd->section_count = 0;
1480
1481   return TRUE;
1482 }
1483
1484 /*
1485 FUNCTION
1486         bfd_preserve_restore
1487
1488 SYNOPSIS
1489         void bfd_preserve_restore (bfd *, struct bfd_preserve *);
1490
1491 DESCRIPTION
1492         This function restores bfd state saved by bfd_preserve_save.
1493         If MARKER is non-NULL in struct bfd_preserve then that block
1494         and all subsequently bfd_alloc'd memory is freed.
1495
1496 */
1497
1498 void
1499 bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
1500 {
1501   bfd_hash_table_free (&abfd->section_htab);
1502
1503   abfd->tdata.any = preserve->tdata;
1504   abfd->arch_info = preserve->arch_info;
1505   abfd->flags = preserve->flags;
1506   abfd->section_htab = preserve->section_htab;
1507   abfd->sections = preserve->sections;
1508   abfd->section_last = preserve->section_last;
1509   abfd->section_count = preserve->section_count;
1510
1511   /* bfd_release frees all memory more recently bfd_alloc'd than
1512      its arg, as well as its arg.  */
1513   if (preserve->marker != NULL)
1514     {
1515       bfd_release (abfd, preserve->marker);
1516       preserve->marker = NULL;
1517     }
1518 }
1519
1520 /*
1521 FUNCTION
1522         bfd_preserve_finish
1523
1524 SYNOPSIS
1525         void bfd_preserve_finish (bfd *, struct bfd_preserve *);
1526
1527 DESCRIPTION
1528         This function should be called when the bfd state saved by
1529         bfd_preserve_save is no longer needed.  ie. when the back-end
1530         object_p function returns with success.
1531
1532 */
1533
1534 void
1535 bfd_preserve_finish (bfd *abfd ATTRIBUTE_UNUSED, struct bfd_preserve *preserve)
1536 {
1537   /* It would be nice to be able to free more memory here, eg. old
1538      tdata, but that's not possible since these blocks are sitting
1539      inside bfd_alloc'd memory.  The section hash is on a separate
1540      objalloc.  */
1541   bfd_hash_table_free (&preserve->section_htab);
1542 }
1543
1544 /*
1545 FUNCTION
1546         bfd_emul_get_maxpagesize
1547
1548 SYNOPSIS
1549         bfd_vma bfd_emul_get_maxpagesize (const char *);
1550
1551 DESCRIPTION
1552         Returns the maximum page size, in bytes, as determined by
1553         emulation.
1554
1555 RETURNS
1556         Returns the maximum page size in bytes for ELF, abort
1557         otherwise.
1558 */
1559
1560 bfd_vma
1561 bfd_emul_get_maxpagesize (const char *emul)
1562 {
1563   const bfd_target *target;
1564
1565   target = bfd_find_target (emul, NULL);
1566   if (target != NULL
1567       && target->flavour == bfd_target_elf_flavour)
1568     return xvec_get_elf_backend_data (target)->maxpagesize;
1569
1570   abort ();
1571   return 0;
1572 }
1573
1574 static void
1575 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1576                       int offset, const bfd_target *orig_target)
1577 {
1578   if (target->flavour == bfd_target_elf_flavour)
1579     {
1580       const struct elf_backend_data *bed;
1581
1582       bed = xvec_get_elf_backend_data (target);
1583       *((bfd_vma *) ((char *) bed + offset)) = size;
1584     }
1585
1586   if (target->alternative_target
1587       && target->alternative_target != orig_target)
1588     bfd_elf_set_pagesize (target->alternative_target, size, offset,
1589                           orig_target);
1590 }
1591
1592 /*
1593 FUNCTION
1594         bfd_emul_set_maxpagesize
1595
1596 SYNOPSIS
1597         void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1598
1599 DESCRIPTION
1600         For ELF, set the maximum page size for the emulation.  It is
1601         a no-op for other formats.
1602
1603 */
1604
1605 void
1606 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1607 {
1608   const bfd_target *target;
1609
1610   target = bfd_find_target (emul, NULL);
1611   if (target)
1612     bfd_elf_set_pagesize (target, size,
1613                           offsetof (struct elf_backend_data,
1614                                     maxpagesize), target);
1615 }
1616
1617 /*
1618 FUNCTION
1619         bfd_emul_get_commonpagesize
1620
1621 SYNOPSIS
1622         bfd_vma bfd_emul_get_commonpagesize (const char *);
1623
1624 DESCRIPTION
1625         Returns the common page size, in bytes, as determined by
1626         emulation.
1627
1628 RETURNS
1629         Returns the common page size in bytes for ELF, abort otherwise.
1630 */
1631
1632 bfd_vma
1633 bfd_emul_get_commonpagesize (const char *emul)
1634 {
1635   const bfd_target *target;
1636
1637   target = bfd_find_target (emul, NULL);
1638   if (target != NULL
1639       && target->flavour == bfd_target_elf_flavour)
1640     return xvec_get_elf_backend_data (target)->commonpagesize;
1641
1642   abort ();
1643   return 0;
1644 }
1645
1646 /*
1647 FUNCTION
1648         bfd_emul_set_commonpagesize
1649
1650 SYNOPSIS
1651         void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1652
1653 DESCRIPTION
1654         For ELF, set the common page size for the emulation.  It is
1655         a no-op for other formats.
1656
1657 */
1658
1659 void
1660 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1661 {
1662   const bfd_target *target;
1663
1664   target = bfd_find_target (emul, NULL);
1665   if (target)
1666     bfd_elf_set_pagesize (target, size,
1667                           offsetof (struct elf_backend_data,
1668                                     commonpagesize), target);
1669 }