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       || strcmp (name, "pe-arm-little") == 0
 888       || strcmp (name, "pei-arm-little") == 0)
 889     return 1;
 890
 891   bfd_set_error (bfd_error_wrong_format);
 892   return -1;
 893 }
 894
 895 /*
 896 FUNCTION
 897         bfd_set_start_address
 898
 899 SYNOPSIS
 900         bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
 901
 902 DESCRIPTION
 903         Make @var{vma} the entry point of output BFD @var{abfd}.
 904
 905 RETURNS
 906         Returns <<TRUE>> on success, <<FALSE>> otherwise.
 907 */
 908
 909 bfd_boolean
 910 bfd_set_start_address (bfd *abfd, bfd_vma vma)
 911 {
 912   abfd->start_address = vma;
 913   return TRUE;
 914 }
 915
 916 /*
 917 FUNCTION
 918         bfd_get_gp_size
 919
 920 SYNOPSIS
 921         unsigned int bfd_get_gp_size (bfd *abfd);
 922
 923 DESCRIPTION
 924         Return the maximum size of objects to be optimized using the GP
 925         register under MIPS ECOFF.  This is typically set by the <<-G>>
 926         argument to the compiler, assembler or linker.
 927 */
 928
 929 unsigned int
 930 bfd_get_gp_size (bfd *abfd)
 931 {
 932   if (abfd->format == bfd_object)
 933     {
 934       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 935         return ecoff_data (abfd)->gp_size;
 936       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 937         return elf_gp_size (abfd);
 938     }
 939   return 0;
 940 }
 941
 942 /*
 943 FUNCTION
 944         bfd_set_gp_size
 945
 946 SYNOPSIS
 947         void bfd_set_gp_size (bfd *abfd, unsigned int i);
 948
 949 DESCRIPTION
 950         Set the maximum size of objects to be optimized using the GP
 951         register under ECOFF or MIPS ELF.  This is typically set by
 952         the <<-G>> argument to the compiler, assembler or linker.
 953 */
 954
 955 void
 956 bfd_set_gp_size (bfd *abfd, unsigned int i)
 957 {
 958   /* Don't try to set GP size on an archive or core file!  */
 959   if (abfd->format != bfd_object)
 960     return;
 961
 962   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 963     ecoff_data (abfd)->gp_size = i;
 964   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 965     elf_gp_size (abfd) = i;
 966 }
 967
 968 /* Get the GP value.  This is an internal function used by some of the
 969    relocation special_function routines on targets which support a GP
 970    register.  */
 971
 972 bfd_vma
 973 _bfd_get_gp_value (bfd *abfd)
 974 {
 975   if (! abfd)
 976     return 0;
 977   if (abfd->format != bfd_object)
 978     return 0;
 979
 980   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 981     return ecoff_data (abfd)->gp;
 982   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 983     return elf_gp (abfd);
 984
 985   return 0;
 986 }
 987
 988 /* Set the GP value.  */
 989
 990 void
 991 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
 992 {
 993   if (! abfd)
 994     BFD_FAIL ();
 995   if (abfd->format != bfd_object)
 996     return;
 997
 998   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 999     ecoff_data (abfd)->gp = v;
1000   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1001     elf_gp (abfd) = v;
1002 }
1003
1004 /*
1005 FUNCTION
1006         bfd_scan_vma
1007
1008 SYNOPSIS
1009         bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1010
1011 DESCRIPTION
1012         Convert, like <<strtoul>>, a numerical expression
1013         @var{string} into a <<bfd_vma>> integer, and return that integer.
1014         (Though without as many bells and whistles as <<strtoul>>.)
1015         The expression is assumed to be unsigned (i.e., positive).
1016         If given a @var{base}, it is used as the base for conversion.
1017         A base of 0 causes the function to interpret the string
1018         in hex if a leading "0x" or "0X" is found, otherwise
1019         in octal if a leading zero is found, otherwise in decimal.
1020
1021         If the value would overflow, the maximum <<bfd_vma>> value is
1022         returned.
1023 */
1024
1025 bfd_vma
1026 bfd_scan_vma (const char *string, const char **end, int base)
1027 {
1028   bfd_vma value;
1029   bfd_vma cutoff;
1030   unsigned int cutlim;
1031   int overflow;
1032
1033   /* Let the host do it if possible.  */
1034   if (sizeof (bfd_vma) <= sizeof (unsigned long))
1035     return strtoul (string, (char **) end, base);
1036
1037 #ifdef HAVE_STRTOULL
1038   if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1039     return strtoull (string, (char **) end, base);
1040 #endif
1041
1042   if (base == 0)
1043     {
1044       if (string[0] == '0')
1045         {
1046           if ((string[1] == 'x') || (string[1] == 'X'))
1047             base = 16;
1048           else
1049             base = 8;
1050         }
1051     }
1052
1053   if ((base < 2) || (base > 36))
1054     base = 10;
1055
1056   if (base == 16
1057       && string[0] == '0'
1058       && (string[1] == 'x' || string[1] == 'X')
1059       && ISXDIGIT (string[2]))
1060     {
1061       string += 2;
1062     }
1063
1064   cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1065   cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1066   value = 0;
1067   overflow = 0;
1068   while (1)
1069     {
1070       unsigned int digit;
1071
1072       digit = *string;
1073       if (ISDIGIT (digit))
1074         digit = digit - '0';
1075       else if (ISALPHA (digit))
1076         digit = TOUPPER (digit) - 'A' + 10;
1077       else
1078         break;
1079       if (digit >= (unsigned int) base)
1080         break;
1081       if (value > cutoff || (value == cutoff && digit > cutlim))
1082         overflow = 1;
1083       value = value * base + digit;
1084       ++string;
1085     }
1086
1087   if (overflow)
1088     value = ~ (bfd_vma) 0;
1089
1090   if (end != NULL)
1091     *end = string;
1092
1093   return value;
1094 }
1095
1096 /*
1097 FUNCTION
1098         bfd_copy_private_header_data
1099
1100 SYNOPSIS
1101         bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1102
1103 DESCRIPTION
1104         Copy private BFD header information from the BFD @var{ibfd} to the
1105         the BFD @var{obfd}.  This copies information that may require
1106         sections to exist, but does not require symbol tables.  Return
1107         <<true>> on success, <<false>> on error.
1108         Possible error returns are:
1109
1110         o <<bfd_error_no_memory>> -
1111         Not enough memory exists to create private data for @var{obfd}.
1112
1113 .#define bfd_copy_private_header_data(ibfd, obfd) \
1114 .     BFD_SEND (obfd, _bfd_copy_private_header_data, \
1115 .               (ibfd, obfd))
1116
1117 */
1118
1119 /*
1120 FUNCTION
1121         bfd_copy_private_bfd_data
1122
1123 SYNOPSIS
1124         bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1125
1126 DESCRIPTION
1127         Copy private BFD information from the BFD @var{ibfd} to the
1128         the BFD @var{obfd}.  Return <<TRUE>> on success, <<FALSE>> on error.
1129         Possible error returns are:
1130
1131         o <<bfd_error_no_memory>> -
1132         Not enough memory exists to create private data for @var{obfd}.
1133
1134 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1135 .     BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1136 .               (ibfd, obfd))
1137
1138 */
1139
1140 /*
1141 FUNCTION
1142         bfd_merge_private_bfd_data
1143
1144 SYNOPSIS
1145         bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1146
1147 DESCRIPTION
1148         Merge private BFD information from the BFD @var{ibfd} to the
1149         the output file BFD @var{obfd} when linking.  Return <<TRUE>>
1150         on success, <<FALSE>> on error.  Possible error returns are:
1151
1152         o <<bfd_error_no_memory>> -
1153         Not enough memory exists to create private data for @var{obfd}.
1154
1155 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1156 .     BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1157 .               (ibfd, obfd))
1158
1159 */
1160
1161 /*
1162 FUNCTION
1163         bfd_set_private_flags
1164
1165 SYNOPSIS
1166         bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1167
1168 DESCRIPTION
1169         Set private BFD flag information in the BFD @var{abfd}.
1170         Return <<TRUE>> on success, <<FALSE>> on error.  Possible error
1171         returns are:
1172
1173         o <<bfd_error_no_memory>> -
1174         Not enough memory exists to create private data for @var{obfd}.
1175
1176 .#define bfd_set_private_flags(abfd, flags) \
1177 .     BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1178
1179 */
1180
1181 /*
1182 FUNCTION
1183         Other functions
1184
1185 DESCRIPTION
1186         The following functions exist but have not yet been documented.
1187
1188 .#define bfd_sizeof_headers(abfd, info) \
1189 .       BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1190 .
1191 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1192 .       BFD_SEND (abfd, _bfd_find_nearest_line, \
1193 .                 (abfd, sec, syms, off, file, func, line))
1194 .
1195 .#define bfd_find_line(abfd, syms, sym, file, line) \
1196 .       BFD_SEND (abfd, _bfd_find_line, \
1197 .                 (abfd, syms, sym, file, line))
1198 .
1199 .#define bfd_find_inliner_info(abfd, file, func, line) \
1200 .       BFD_SEND (abfd, _bfd_find_inliner_info, \
1201 .                 (abfd, file, func, line))
1202 .
1203 .#define bfd_debug_info_start(abfd) \
1204 .       BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1205 .
1206 .#define bfd_debug_info_end(abfd) \
1207 .       BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1208 .
1209 .#define bfd_debug_info_accumulate(abfd, section) \
1210 .       BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1211 .
1212 .#define bfd_stat_arch_elt(abfd, stat) \
1213 .       BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1214 .
1215 .#define bfd_update_armap_timestamp(abfd) \
1216 .       BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1217 .
1218 .#define bfd_set_arch_mach(abfd, arch, mach)\
1219 .       BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1220 .
1221 .#define bfd_relax_section(abfd, section, link_info, again) \
1222 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1223 .
1224 .#define bfd_gc_sections(abfd, link_info) \
1225 .       BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1226 .
1227 .#define bfd_merge_sections(abfd, link_info) \
1228 .       BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1229 .
1230 .#define bfd_is_group_section(abfd, sec) \
1231 .       BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1232 .
1233 .#define bfd_discard_group(abfd, sec) \
1234 .       BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1235 .
1236 .#define bfd_link_hash_table_create(abfd) \
1237 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1238 .
1239 .#define bfd_link_hash_table_free(abfd, hash) \
1240 .       BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1241 .
1242 .#define bfd_link_add_symbols(abfd, info) \
1243 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1244 .
1245 .#define bfd_link_just_syms(abfd, sec, info) \
1246 .       BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1247 .
1248 .#define bfd_final_link(abfd, info) \
1249 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1250 .
1251 .#define bfd_free_cached_info(abfd) \
1252 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1253 .
1254 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1255 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1256 .
1257 .#define bfd_print_private_bfd_data(abfd, file)\
1258 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1259 .
1260 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1261 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1262 .
1263 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1264 .       BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1265 .                                                   dyncount, dynsyms, ret))
1266 .
1267 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1268 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1269 .
1270 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1271 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1272 .
1273 .extern bfd_byte *bfd_get_relocated_section_contents
1274 .  (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1275 .   bfd_boolean, asymbol **);
1276 .
1277
1278 */
1279
1280 bfd_byte *
1281 bfd_get_relocated_section_contents (bfd *abfd,
1282                                     struct bfd_link_info *link_info,
1283                                     struct bfd_link_order *link_order,
1284                                     bfd_byte *data,
1285                                     bfd_boolean relocatable,
1286                                     asymbol **symbols)
1287 {
1288   bfd *abfd2;
1289   bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1290                    bfd_byte *, bfd_boolean, asymbol **);
1291
1292   if (link_order->type == bfd_indirect_link_order)
1293     {
1294       abfd2 = link_order->u.indirect.section->owner;
1295       if (abfd2 == NULL)
1296         abfd2 = abfd;
1297     }
1298   else
1299     abfd2 = abfd;
1300
1301   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1302
1303   return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1304 }
1305
1306 /* Record information about an ELF program header.  */
1307
1308 bfd_boolean
1309 bfd_record_phdr (bfd *abfd,
1310                  unsigned long type,
1311                  bfd_boolean flags_valid,
1312                  flagword flags,
1313                  bfd_boolean at_valid,
1314                  bfd_vma at,
1315                  bfd_boolean includes_filehdr,
1316                  bfd_boolean includes_phdrs,
1317                  unsigned int count,
1318                  asection **secs)
1319 {
1320   struct elf_segment_map *m, **pm;
1321   bfd_size_type amt;
1322
1323   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1324     return TRUE;
1325
1326   amt = sizeof (struct elf_segment_map);
1327   amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1328   m = bfd_alloc (abfd, amt);
1329   if (m == NULL)
1330     return FALSE;
1331
1332   m->next = NULL;
1333   m->p_type = type;
1334   m->p_flags = flags;
1335   m->p_paddr = at;
1336   m->p_flags_valid = flags_valid;
1337   m->p_paddr_valid = at_valid;
1338   m->includes_filehdr = includes_filehdr;
1339   m->includes_phdrs = includes_phdrs;
1340   m->count = count;
1341   m->p_align_valid = FALSE;
1342   m->p_align = 0;
1343   if (count > 0)
1344     memcpy (m->sections, secs, count * sizeof (asection *));
1345
1346   for (pm = &elf_tdata (abfd)->segment_map; *pm != NULL; pm = &(*pm)->next)
1347     ;
1348   *pm = m;
1349
1350   return TRUE;
1351 }
1352
1353 void
1354 bfd_sprintf_vma (bfd *abfd, char *buf, bfd_vma value)
1355 {
1356   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1357     get_elf_backend_data (abfd)->elf_backend_sprintf_vma (abfd, buf, value);
1358   else
1359     sprintf_vma (buf, value);
1360 }
1361
1362 void
1363 bfd_fprintf_vma (bfd *abfd, void *stream, bfd_vma value)
1364 {
1365   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1366     get_elf_backend_data (abfd)->elf_backend_fprintf_vma (abfd, stream, value);
1367   else
1368     fprintf_vma ((FILE *) stream, value);
1369 }
1370
1371 /*
1372 FUNCTION
1373         bfd_alt_mach_code
1374
1375 SYNOPSIS
1376         bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1377
1378 DESCRIPTION
1379
1380         When more than one machine code number is available for the
1381         same machine type, this function can be used to switch between
1382         the preferred one (alternative == 0) and any others.  Currently,
1383         only ELF supports this feature, with up to two alternate
1384         machine codes.
1385 */
1386
1387 bfd_boolean
1388 bfd_alt_mach_code (bfd *abfd, int alternative)
1389 {
1390   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1391     {
1392       int code;
1393
1394       switch (alternative)
1395         {
1396         case 0:
1397           code = get_elf_backend_data (abfd)->elf_machine_code;
1398           break;
1399
1400         case 1:
1401           code = get_elf_backend_data (abfd)->elf_machine_alt1;
1402           if (code == 0)
1403             return FALSE;
1404           break;
1405
1406         case 2:
1407           code = get_elf_backend_data (abfd)->elf_machine_alt2;
1408           if (code == 0)
1409             return FALSE;
1410           break;
1411
1412         default:
1413           return FALSE;
1414         }
1415
1416       elf_elfheader (abfd)->e_machine = code;
1417
1418       return TRUE;
1419     }
1420
1421   return FALSE;
1422 }
1423
1424 /*
1425 CODE_FRAGMENT
1426
1427 .struct bfd_preserve
1428 .{
1429 .  void *marker;
1430 .  void *tdata;
1431 .  flagword flags;
1432 .  const struct bfd_arch_info *arch_info;
1433 .  struct bfd_section *sections;
1434 .  struct bfd_section *section_last;
1435 .  unsigned int section_count;
1436 .  struct bfd_hash_table section_htab;
1437 .};
1438 .
1439 */
1440
1441 /*
1442 FUNCTION
1443         bfd_preserve_save
1444
1445 SYNOPSIS
1446         bfd_boolean bfd_preserve_save (bfd *, struct bfd_preserve *);
1447
1448 DESCRIPTION
1449         When testing an object for compatibility with a particular
1450         target back-end, the back-end object_p function needs to set
1451         up certain fields in the bfd on successfully recognizing the
1452         object.  This typically happens in a piecemeal fashion, with
1453         failures possible at many points.  On failure, the bfd is
1454         supposed to be restored to its initial state, which is
1455         virtually impossible.  However, restoring a subset of the bfd
1456         state works in practice.  This function stores the subset and
1457         reinitializes the bfd.
1458
1459 */
1460
1461 bfd_boolean
1462 bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve)
1463 {
1464   preserve->tdata = abfd->tdata.any;
1465   preserve->arch_info = abfd->arch_info;
1466   preserve->flags = abfd->flags;
1467   preserve->sections = abfd->sections;
1468   preserve->section_last = abfd->section_last;
1469   preserve->section_count = abfd->section_count;
1470   preserve->section_htab = abfd->section_htab;
1471
1472   if (! bfd_hash_table_init (&abfd->section_htab, bfd_section_hash_newfunc,
1473                              sizeof (struct section_hash_entry)))
1474     return FALSE;
1475
1476   abfd->tdata.any = NULL;
1477   abfd->arch_info = &bfd_default_arch_struct;
1478   abfd->flags &= BFD_IN_MEMORY;
1479   abfd->sections = NULL;
1480   abfd->section_last = NULL;
1481   abfd->section_count = 0;
1482
1483   return TRUE;
1484 }
1485
1486 /*
1487 FUNCTION
1488         bfd_preserve_restore
1489
1490 SYNOPSIS
1491         void bfd_preserve_restore (bfd *, struct bfd_preserve *);
1492
1493 DESCRIPTION
1494         This function restores bfd state saved by bfd_preserve_save.
1495         If MARKER is non-NULL in struct bfd_preserve then that block
1496         and all subsequently bfd_alloc'd memory is freed.
1497
1498 */
1499
1500 void
1501 bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
1502 {
1503   bfd_hash_table_free (&abfd->section_htab);
1504
1505   abfd->tdata.any = preserve->tdata;
1506   abfd->arch_info = preserve->arch_info;
1507   abfd->flags = preserve->flags;
1508   abfd->section_htab = preserve->section_htab;
1509   abfd->sections = preserve->sections;
1510   abfd->section_last = preserve->section_last;
1511   abfd->section_count = preserve->section_count;
1512
1513   /* bfd_release frees all memory more recently bfd_alloc'd than
1514      its arg, as well as its arg.  */
1515   if (preserve->marker != NULL)
1516     {
1517       bfd_release (abfd, preserve->marker);
1518       preserve->marker = NULL;
1519     }
1520 }
1521
1522 /*
1523 FUNCTION
1524         bfd_preserve_finish
1525
1526 SYNOPSIS
1527         void bfd_preserve_finish (bfd *, struct bfd_preserve *);
1528
1529 DESCRIPTION
1530         This function should be called when the bfd state saved by
1531         bfd_preserve_save is no longer needed.  ie. when the back-end
1532         object_p function returns with success.
1533
1534 */
1535
1536 void
1537 bfd_preserve_finish (bfd *abfd ATTRIBUTE_UNUSED, struct bfd_preserve *preserve)
1538 {
1539   /* It would be nice to be able to free more memory here, eg. old
1540      tdata, but that's not possible since these blocks are sitting
1541      inside bfd_alloc'd memory.  The section hash is on a separate
1542      objalloc.  */
1543   bfd_hash_table_free (&preserve->section_htab);
1544 }
1545
1546 /*
1547 FUNCTION
1548         bfd_emul_get_maxpagesize
1549
1550 SYNOPSIS
1551         bfd_vma bfd_emul_get_maxpagesize (const char *);
1552
1553 DESCRIPTION
1554         Returns the maximum page size, in bytes, as determined by
1555         emulation.
1556
1557 RETURNS
1558         Returns the maximum page size in bytes for ELF, abort
1559         otherwise.
1560 */
1561
1562 bfd_vma
1563 bfd_emul_get_maxpagesize (const char *emul)
1564 {
1565   const bfd_target *target;
1566
1567   target = bfd_find_target (emul, NULL);
1568   if (target != NULL
1569       && target->flavour == bfd_target_elf_flavour)
1570     return xvec_get_elf_backend_data (target)->maxpagesize;
1571
1572   abort ();
1573   return 0;
1574 }
1575
1576 static void
1577 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1578                       int offset, const bfd_target *orig_target)
1579 {
1580   if (target->flavour == bfd_target_elf_flavour)
1581     {
1582       const struct elf_backend_data *bed;
1583
1584       bed = xvec_get_elf_backend_data (target);
1585       *((bfd_vma *) ((char *) bed + offset)) = size;
1586     }
1587
1588   if (target->alternative_target
1589       && target->alternative_target != orig_target)
1590     bfd_elf_set_pagesize (target->alternative_target, size, offset,
1591                           orig_target);
1592 }
1593
1594 /*
1595 FUNCTION
1596         bfd_emul_set_maxpagesize
1597
1598 SYNOPSIS
1599         void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1600
1601 DESCRIPTION
1602         For ELF, set the maximum page size for the emulation.  It is
1603         a no-op for other formats.
1604
1605 */
1606
1607 void
1608 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1609 {
1610   const bfd_target *target;
1611
1612   target = bfd_find_target (emul, NULL);
1613   if (target)
1614     bfd_elf_set_pagesize (target, size,
1615                           offsetof (struct elf_backend_data,
1616                                     maxpagesize), target);
1617 }
1618
1619 /*
1620 FUNCTION
1621         bfd_emul_get_commonpagesize
1622
1623 SYNOPSIS
1624         bfd_vma bfd_emul_get_commonpagesize (const char *);
1625
1626 DESCRIPTION
1627         Returns the common page size, in bytes, as determined by
1628         emulation.
1629
1630 RETURNS
1631         Returns the common page size in bytes for ELF, abort otherwise.
1632 */
1633
1634 bfd_vma
1635 bfd_emul_get_commonpagesize (const char *emul)
1636 {
1637   const bfd_target *target;
1638
1639   target = bfd_find_target (emul, NULL);
1640   if (target != NULL
1641       && target->flavour == bfd_target_elf_flavour)
1642     return xvec_get_elf_backend_data (target)->commonpagesize;
1643
1644   abort ();
1645   return 0;
1646 }
1647
1648 /*
1649 FUNCTION
1650         bfd_emul_set_commonpagesize
1651
1652 SYNOPSIS
1653         void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1654
1655 DESCRIPTION
1656         For ELF, set the common page size for the emulation.  It is
1657         a no-op for other formats.
1658
1659 */
1660
1661 void
1662 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1663 {
1664   const bfd_target *target;
1665
1666   target = bfd_find_target (emul, NULL);
1667   if (target)
1668     bfd_elf_set_pagesize (target, size,
1669                           offsetof (struct elf_backend_data,
1670                                     commonpagesize), target);
1671 }