bfd/bfd.c

   1 /* Generic BFD library interface and support routines.
   2    Copyright (C) 1990, 91, 92, 93, 94 Free Software Foundation, Inc.
   3    Written by Cygnus Support.
   4
   5 This file is part of BFD, the Binary File Descriptor library.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  20
  21 /*
  22 SECTION
  23         <<typedef bfd>>
  24
  25         A BFD has type <<bfd>>; objects of this type are the
  26         cornerstone of any application using BFD. Using BFD
  27         consists of making references though the BFD and to data in the BFD.
  28
  29         Here is the structure that defines the type <<bfd>>.  It
  30         contains the major data about the file and pointers
  31         to the rest of the data.
  32
  33 CODE_FRAGMENT
  34 .
  35 .struct _bfd
  36 .{
  37 .    {* The filename the application opened the BFD with.  *}
  38 .    CONST char *filename;
  39 .
  40 .    {* A pointer to the target jump table.             *}
  41 .    const struct bfd_target *xvec;
  42 .
  43 .    {* To avoid dragging too many header files into every file that
  44 .       includes `<<bfd.h>>', IOSTREAM has been declared as a "char
  45 .       *", and MTIME as a "long".  Their correct types, to which they
  46 .       are cast when used, are "FILE *" and "time_t".    The iostream
  47 .       is the result of an fopen on the filename. *}
  48 .    char *iostream;
  49 .
  50 .    {* Is the file descriptor being cached?  That is, can it be closed as
  51 .       needed, and re-opened when accessed later?  *}
  52 .
  53 .    boolean cacheable;
  54 .
  55 .    {* Marks whether there was a default target specified when the
  56 .       BFD was opened. This is used to select which matching algorithm
  57 .       to use to choose the back end. *}
  58 .
  59 .    boolean target_defaulted;
  60 .
  61 .    {* The caching routines use these to maintain a
  62 .       least-recently-used list of BFDs *}
  63 .
  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 .
  69 .    file_ptr where;
  70 .
  71 .    {* and here: (``once'' means at least once) *}
  72 .
  73 .    boolean opened_once;
  74 .
  75 .    {* Set if we have a locally maintained mtime value, rather than
  76 .       getting it from the file each time: *}
  77 .
  78 .    boolean mtime_set;
  79 .
  80 .    {* File modified time, if mtime_set is true: *}
  81 .
  82 .    long mtime;
  83 .
  84 .    {* Reserved for an unimplemented file locking extension.*}
  85 .
  86 .    int ifd;
  87 .
  88 .    {* The format which belongs to the BFD. (object, core, etc.) *}
  89 .
  90 .    bfd_format format;
  91 .
  92 .    {* The direction the BFD was opened with*}
  93 .
  94 .    enum bfd_direction {no_direction = 0,
  95 .                        read_direction = 1,
  96 .                        write_direction = 2,
  97 .                        both_direction = 3} direction;
  98 .
  99 .    {* Format_specific flags*}
 100 .
 101 .    flagword flags;
 102 .
 103 .    {* Currently my_archive is tested before adding origin to
 104 .       anything. I believe that this can become always an add of
 105 .       origin, with origin set to 0 for non archive files.   *}
 106 .
 107 .    file_ptr origin;
 108 .
 109 .    {* Remember when output has begun, to stop strange things
 110 .       from happening. *}
 111 .    boolean output_has_begun;
 112 .
 113 .    {* Pointer to linked list of sections*}
 114 .    struct sec  *sections;
 115 .
 116 .    {* The number of sections *}
 117 .    unsigned int section_count;
 118 .
 119 .    {* Stuff only useful for object files:
 120 .       The start address. *}
 121 .    bfd_vma start_address;
 122 .
 123 .    {* Used for input and output*}
 124 .    unsigned int symcount;
 125 .
 126 .    {* Symbol table for output BFD (with symcount entries) *}
 127 .    struct symbol_cache_entry  **outsymbols;
 128 .
 129 .    {* Pointer to structure which contains architecture information*}
 130 .    const struct bfd_arch_info *arch_info;
 131 .
 132 .    {* Stuff only useful for archives:*}
 133 .    PTR arelt_data;
 134 .    struct _bfd *my_archive;     {* The containing archive BFD.  *}
 135 .    struct _bfd *next;           {* The next BFD in the archive.  *}
 136 .    struct _bfd *archive_head;   {* The first BFD in the archive.  *}
 137 .    boolean has_armap;
 138 .
 139 .    {* A chain of BFD structures involved in a link.  *}
 140 .    struct _bfd *link_next;
 141 .
 142 .    {* A field used by _bfd_generic_link_add_archive_symbols.  This will
 143 .       be used only for archive elements.  *}
 144 .    int archive_pass;
 145 .
 146 .    {* Used by the back end to hold private data. *}
 147 .
 148 .    union
 149 .      {
 150 .      struct aout_data_struct *aout_data;
 151 .      struct artdata *aout_ar_data;
 152 .      struct _oasys_data *oasys_obj_data;
 153 .      struct _oasys_ar_data *oasys_ar_data;
 154 .      struct coff_tdata *coff_obj_data;
 155 .      struct pe_tdata *pe_obj_data;
 156 .      struct ecoff_tdata *ecoff_obj_data;
 157 .      struct ieee_data_struct *ieee_data;
 158 .      struct ieee_ar_data_struct *ieee_ar_data;
 159 .      struct srec_data_struct *srec_data;
 160 .      struct tekhex_data_struct *tekhex_data;
 161 .      struct elf_obj_tdata *elf_obj_data;
 162 .      struct nlm_obj_tdata *nlm_obj_data;
 163 .      struct bout_data_struct *bout_data;
 164 .      struct sun_core_struct *sun_core_data;
 165 .      struct trad_core_struct *trad_core_data;
 166 .      struct som_data_struct *som_data;
 167 .      struct hpux_core_struct *hpux_core_data;
 168 .      struct hppabsd_core_struct *hppabsd_core_data;
 169 .      struct sgi_core_struct *sgi_core_data;
 170 .      struct lynx_core_struct *lynx_core_data;
 171 .      struct osf_core_struct *osf_core_data;
 172 .      struct cisco_core_struct *cisco_core_data;
 173 .      struct versados_data_struct *versados_data;
 174 .      PTR any;
 175 .      } tdata;
 176 .
 177 .    {* Used by the application to hold private data*}
 178 .    PTR usrdata;
 179 .
 180 .    {* Where all the allocated stuff under this BFD goes *}
 181 .    struct obstack memory;
 182 .};
 183 .
 184 */
 185
 186 #include "bfd.h"
 187 #include "sysdep.h"
 188
 189 #ifdef ANSI_PROTOTYPES
 190 #include <stdarg.h>
 191 #else
 192 #include <varargs.h>
 193 #endif
 194
 195 #include "bfdlink.h"
 196 #include "libbfd.h"
 197 #include "coff/internal.h"
 198 #include "coff/sym.h"
 199 #include "libcoff.h"
 200 #include "libecoff.h"
 201 #undef obj_symbols
 202 #include "libelf.h"
 203
 204 #include <ctype.h>
 205 \f
 206 /* provide storage for subsystem, stack and heap data which may have been
 207    passed in on the command line.  Ld puts this data into a bfd_link_info
 208    struct which ultimately gets passed in to the bfd.  When it arrives, copy
 209    it to the following struct so that the data will be available in coffcode.h
 210    where it is needed.  The typedef's used are defined in bfd.h */
 211
 212
 213 \f
 214 /*
 215 SECTION
 216         Error reporting
 217
 218         Most BFD functions return nonzero on success (check their
 219         individual documentation for precise semantics).  On an error,
 220         they call <<bfd_set_error>> to set an error condition that callers
 221         can check by calling <<bfd_get_error>>.
 222         If that returns <<bfd_error_system_call>>, then check
 223         <<errno>>.
 224
 225         The easiest way to report a BFD error to the user is to
 226         use <<bfd_perror>>.
 227
 228 SUBSECTION
 229         Type <<bfd_error_type>>
 230
 231         The values returned by <<bfd_get_error>> are defined by the
 232         enumerated type <<bfd_error_type>>.
 233
 234 CODE_FRAGMENT
 235 .
 236 .typedef enum bfd_error
 237 .{
 238 .  bfd_error_no_error = 0,
 239 .  bfd_error_system_call,
 240 .  bfd_error_invalid_target,
 241 .  bfd_error_wrong_format,
 242 .  bfd_error_invalid_operation,
 243 .  bfd_error_no_memory,
 244 .  bfd_error_no_symbols,
 245 .  bfd_error_no_armap,
 246 .  bfd_error_no_more_archived_files,
 247 .  bfd_error_malformed_archive,
 248 .  bfd_error_file_not_recognized,
 249 .  bfd_error_file_ambiguously_recognized,
 250 .  bfd_error_no_contents,
 251 .  bfd_error_nonrepresentable_section,
 252 .  bfd_error_no_debug_section,
 253 .  bfd_error_bad_value,
 254 .  bfd_error_file_truncated,
 255 .  bfd_error_file_too_big,
 256 .  bfd_error_invalid_error_code
 257 .} bfd_error_type;
 258 .
 259 */
 260
 261 #undef strerror
 262 extern char *strerror();
 263
 264 static bfd_error_type bfd_error = bfd_error_no_error;
 265
 266 CONST char *CONST bfd_errmsgs[] = {
 267                         "No error",
 268                         "System call error",
 269                         "Invalid bfd target",
 270                         "File in wrong format",
 271                         "Invalid operation",
 272                         "Memory exhausted",
 273                         "No symbols",
 274                         "Archive has no index; run ranlib to add one",
 275                         "No more archived files",
 276                         "Malformed archive",
 277                         "File format not recognized",
 278                         "File format is ambiguous",
 279                         "Section has no contents",
 280                         "Nonrepresentable section on output",
 281                         "Symbol needs debug section which does not exist",
 282                         "Bad value",
 283                         "File truncated",
 284                         "File too big",
 285                         "#<Invalid error code>"
 286                        };
 287
 288 /*
 289 FUNCTION
 290         bfd_get_error
 291
 292 SYNOPSIS
 293         bfd_error_type bfd_get_error (void);
 294
 295 DESCRIPTION
 296         Return the current BFD error condition.
 297 */
 298
 299 bfd_error_type
 300 bfd_get_error ()
 301 {
 302   return bfd_error;
 303 }
 304
 305 /*
 306 FUNCTION
 307         bfd_set_error
 308
 309 SYNOPSIS
 310         void bfd_set_error (bfd_error_type error_tag);
 311
 312 DESCRIPTION
 313         Set the BFD error condition to be @var{error_tag}.
 314 */
 315
 316 void
 317 bfd_set_error (error_tag)
 318      bfd_error_type error_tag;
 319 {
 320   bfd_error = error_tag;
 321 }
 322
 323 /*
 324 FUNCTION
 325         bfd_errmsg
 326
 327 SYNOPSIS
 328         CONST char *bfd_errmsg (bfd_error_type error_tag);
 329
 330 DESCRIPTION
 331         Return a string describing the error @var{error_tag}, or
 332         the system error if @var{error_tag} is <<bfd_error_system_call>>.
 333 */
 334
 335 CONST char *
 336 bfd_errmsg (error_tag)
 337      bfd_error_type error_tag;
 338 {
 339 #ifndef errno
 340   extern int errno;
 341 #endif
 342   if (error_tag == bfd_error_system_call)
 343     return strerror (errno);
 344
 345   if ((((int)error_tag <(int) bfd_error_no_error) ||
 346        ((int)error_tag > (int)bfd_error_invalid_error_code)))
 347     error_tag = bfd_error_invalid_error_code;/* sanity check */
 348
 349   return bfd_errmsgs [(int)error_tag];
 350 }
 351
 352 /*
 353 FUNCTION
 354         bfd_perror
 355
 356 SYNOPSIS
 357         void bfd_perror (CONST char *message);
 358
 359 DESCRIPTION
 360         Print to the standard error stream a string describing the
 361         last BFD error that occurred, or the last system error if
 362         the last BFD error was a system call failure.  If @var{message}
 363         is non-NULL and non-empty, the error string printed is preceded
 364         by @var{message}, a colon, and a space.  It is followed by a newline.
 365 */
 366
 367 void
 368 bfd_perror (message)
 369      CONST char *message;
 370 {
 371   if (bfd_get_error () == bfd_error_system_call)
 372     perror((char *)message);            /* must be system error then... */
 373   else {
 374     if (message == NULL || *message == '\0')
 375       fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
 376     else
 377       fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
 378   }
 379 }
 380
 381 /*
 382 SUBSECTION
 383         BFD error handler
 384
 385         Some BFD functions want to print messages describing the
 386         problem.  They call a BFD error handler function.  This
 387         function may be overriden by the program.
 388
 389         The BFD error handler acts like printf.
 390
 391 CODE_FRAGMENT
 392 .
 393 .typedef void (*bfd_error_handler_type) PARAMS ((const char *, ...));
 394 .
 395 */
 396
 397 /* The program name used when printing BFD error messages.  */
 398
 399 static const char *_bfd_error_program_name;
 400
 401 /* This is the default routine to handle BFD error messages.  */
 402
 403 #ifdef ANSI_PROTOTYPES
 404
 405 static void _bfd_default_error_handler PARAMS ((const char *s, ...));
 406
 407 static void
 408 _bfd_default_error_handler (const char *s, ...)
 409 {
 410   va_list p;
 411
 412   if (_bfd_error_program_name != NULL)
 413     fprintf (stderr, "%s: ", _bfd_error_program_name);
 414
 415   va_start (p, s);
 416
 417   vfprintf (stderr, s, p);
 418
 419   va_end (p);
 420
 421   fprintf (stderr, "\n");
 422 }
 423
 424 #else /* ! defined (ANSI_PROTOTYPES) */
 425
 426 static void _bfd_default_error_handler ();
 427
 428 static void
 429 _bfd_default_error_handler (va_alist)
 430      va_dcl
 431 {
 432   va_list p;
 433   const char *s;
 434
 435   if (_bfd_error_program_name != NULL)
 436     fprintf (stderr, "%s: ", _bfd_error_program_name);
 437
 438   va_start (p);
 439
 440   s = va_arg (p, const char *);
 441   vfprintf (stderr, s, p);
 442
 443   va_end (p);
 444
 445   fprintf (stderr, "\n");
 446 }
 447
 448 #endif /* ! defined (ANSI_PROTOTYPES) */
 449
 450 /* This is a function pointer to the routine which should handle BFD
 451    error messages.  It is called when a BFD routine encounters an
 452    error for which it wants to print a message.  Going through a
 453    function pointer permits a program linked against BFD to intercept
 454    the messages and deal with them itself.  */
 455
 456 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
 457
 458 /*
 459 FUNCTION
 460         bfd_set_error_handler
 461
 462 SYNOPSIS
 463         bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
 464
 465 DESCRIPTION
 466         Set the BFD error handler function.  Returns the previous
 467         function.
 468 */
 469
 470 bfd_error_handler_type
 471 bfd_set_error_handler (pnew)
 472      bfd_error_handler_type pnew;
 473 {
 474   bfd_error_handler_type pold;
 475
 476   pold = _bfd_error_handler;
 477   _bfd_error_handler = pnew;
 478   return pold;
 479 }
 480
 481 /*
 482 FUNCTION
 483         bfd_set_error_program_name
 484
 485 SYNOPSIS
 486         void bfd_set_error_program_name (const char *);
 487
 488 DESCRIPTION
 489         Set the program name to use when printing a BFD error.  This
 490         is printed before the error message followed by a colon and
 491         space.  The string must not be changed after it is passed to
 492         this function.
 493 */
 494
 495 void
 496 bfd_set_error_program_name (name)
 497      const char *name;
 498 {
 499   _bfd_error_program_name = name;
 500 }
 501 \f
 502 /*
 503 SECTION
 504         Symbols
 505 */
 506
 507 /*
 508 FUNCTION
 509         bfd_get_reloc_upper_bound
 510
 511 SYNOPSIS
 512         long bfd_get_reloc_upper_bound(bfd *abfd, asection *sect);
 513
 514 DESCRIPTION
 515         Return the number of bytes required to store the
 516         relocation information associated with section @var{sect}
 517         attached to bfd @var{abfd}.  If an error occurs, return -1.
 518
 519 */
 520
 521
 522 long
 523 bfd_get_reloc_upper_bound (abfd, asect)
 524      bfd *abfd;
 525      sec_ptr asect;
 526 {
 527   if (abfd->format != bfd_object) {
 528     bfd_set_error (bfd_error_invalid_operation);
 529     return -1;
 530   }
 531
 532   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
 533 }
 534
 535 /*
 536 FUNCTION
 537         bfd_canonicalize_reloc
 538
 539 SYNOPSIS
 540         long bfd_canonicalize_reloc
 541                 (bfd *abfd,
 542                 asection *sec,
 543                 arelent **loc,
 544                 asymbol **syms);
 545
 546 DESCRIPTION
 547         Call the back end associated with the open BFD
 548         @var{abfd} and translate the external form of the relocation
 549         information attached to @var{sec} into the internal canonical
 550         form.  Place the table into memory at @var{loc}, which has
 551         been preallocated, usually by a call to
 552         <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
 553         -1 on error.
 554
 555         The @var{syms} table is also needed for horrible internal magic
 556         reasons.
 557
 558
 559 */
 560 long
 561 bfd_canonicalize_reloc (abfd, asect, location, symbols)
 562      bfd *abfd;
 563      sec_ptr asect;
 564      arelent **location;
 565      asymbol **symbols;
 566 {
 567   if (abfd->format != bfd_object) {
 568     bfd_set_error (bfd_error_invalid_operation);
 569     return -1;
 570   }
 571   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
 572                    (abfd, asect, location, symbols));
 573 }
 574
 575 /*
 576 FUNCTION
 577         bfd_set_reloc
 578
 579 SYNOPSIS
 580         void bfd_set_reloc
 581           (bfd *abfd, asection *sec, arelent **rel, unsigned int count)
 582
 583 DESCRIPTION
 584         Set the relocation pointer and count within
 585         section @var{sec} to the values @var{rel} and @var{count}.
 586         The argument @var{abfd} is ignored.
 587
 588 */
 589 /*ARGSUSED*/
 590 void
 591 bfd_set_reloc (ignore_abfd, asect, location, count)
 592      bfd *ignore_abfd;
 593      sec_ptr asect;
 594      arelent **location;
 595      unsigned int count;
 596 {
 597   asect->orelocation  = location;
 598   asect->reloc_count = count;
 599 }
 600
 601 /*
 602 FUNCTION
 603         bfd_set_file_flags
 604
 605 SYNOPSIS
 606         boolean bfd_set_file_flags(bfd *abfd, flagword flags);
 607
 608 DESCRIPTION
 609         Set the flag word in the BFD @var{abfd} to the value @var{flags}.
 610
 611         Possible errors are:
 612         o <<bfd_error_wrong_format>> - The target bfd was not of object format.
 613         o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
 614         o <<bfd_error_invalid_operation>> -
 615         The flag word contained a bit which was not applicable to the
 616         type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
 617         on a BFD format which does not support demand paging.
 618
 619 */
 620
 621 boolean
 622 bfd_set_file_flags (abfd, flags)
 623      bfd *abfd;
 624      flagword flags;
 625 {
 626   if (abfd->format != bfd_object) {
 627     bfd_set_error (bfd_error_wrong_format);
 628     return false;
 629   }
 630
 631   if (bfd_read_p (abfd)) {
 632     bfd_set_error (bfd_error_invalid_operation);
 633     return false;
 634   }
 635
 636   bfd_get_file_flags (abfd) = flags;
 637   if ((flags & bfd_applicable_file_flags (abfd)) != flags) {
 638     bfd_set_error (bfd_error_invalid_operation);
 639     return false;
 640   }
 641
 642 return true;
 643 }
 644
 645 void
 646 bfd_assert (file, line)
 647      const char *file;
 648      int line;
 649 {
 650   (*_bfd_error_handler) ("bfd assertion fail %s:%d\n", file, line);
 651 }
 652
 653
 654 /*
 655 FUNCTION
 656         bfd_set_start_address
 657
 658 SYNOPSIS
 659         boolean bfd_set_start_address(bfd *abfd, bfd_vma vma);
 660
 661 DESCRIPTION
 662         Make @var{vma} the entry point of output BFD @var{abfd}.
 663
 664 RETURNS
 665         Returns <<true>> on success, <<false>> otherwise.
 666 */
 667
 668 boolean
 669 bfd_set_start_address(abfd, vma)
 670 bfd *abfd;
 671 bfd_vma vma;
 672 {
 673   abfd->start_address = vma;
 674   return true;
 675 }
 676
 677
 678 /*
 679 FUNCTION
 680         bfd_get_mtime
 681
 682 SYNOPSIS
 683         long bfd_get_mtime(bfd *abfd);
 684
 685 DESCRIPTION
 686         Return the file modification time (as read from the file system, or
 687         from the archive header for archive members).
 688
 689 */
 690
 691 long
 692 bfd_get_mtime (abfd)
 693      bfd *abfd;
 694 {
 695   FILE *fp;
 696   struct stat buf;
 697
 698   if (abfd->mtime_set)
 699     return abfd->mtime;
 700
 701   fp = bfd_cache_lookup (abfd);
 702   if (0 != fstat (fileno (fp), &buf))
 703     return 0;
 704
 705   abfd->mtime = buf.st_mtime;           /* Save value in case anyone wants it */
 706   return buf.st_mtime;
 707 }
 708
 709 /*
 710 FUNCTION
 711         bfd_get_size
 712
 713 SYNOPSIS
 714         long bfd_get_size(bfd *abfd);
 715
 716 DESCRIPTION
 717         Return the file size (as read from file system) for the file
 718         associated with BFD @var{abfd}.
 719
 720         The initial motivation for, and use of, this routine is not
 721         so we can get the exact size of the object the BFD applies to, since
 722         that might not be generally possible (archive members for example).
 723         It would be ideal if someone could eventually modify
 724         it so that such results were guaranteed.
 725
 726         Instead, we want to ask questions like "is this NNN byte sized
 727         object I'm about to try read from file offset YYY reasonable?"
 728         As as example of where we might do this, some object formats
 729         use string tables for which the first <<sizeof(long)>> bytes of the
 730         table contain the size of the table itself, including the size bytes.
 731         If an application tries to read what it thinks is one of these
 732         string tables, without some way to validate the size, and for
 733         some reason the size is wrong (byte swapping error, wrong location
 734         for the string table, etc.), the only clue is likely to be a read
 735         error when it tries to read the table, or a "virtual memory
 736         exhausted" error when it tries to allocate 15 bazillon bytes
 737         of space for the 15 bazillon byte table it is about to read.
 738         This function at least allows us to answer the quesion, "is the
 739         size reasonable?".
 740 */
 741
 742 long
 743 bfd_get_size (abfd)
 744      bfd *abfd;
 745 {
 746   FILE *fp;
 747   struct stat buf;
 748
 749   fp = bfd_cache_lookup (abfd);
 750   if (0 != fstat (fileno (fp), &buf))
 751     return 0;
 752
 753   return buf.st_size;
 754 }
 755
 756 /*
 757 FUNCTION
 758         bfd_get_gp_size
 759
 760 SYNOPSIS
 761         int bfd_get_gp_size(bfd *abfd);
 762
 763 DESCRIPTION
 764         Return the maximum size of objects to be optimized using the GP
 765         register under MIPS ECOFF.  This is typically set by the <<-G>>
 766         argument to the compiler, assembler or linker.
 767 */
 768
 769 int
 770 bfd_get_gp_size (abfd)
 771      bfd *abfd;
 772 {
 773   if (abfd->format == bfd_object)
 774     {
 775       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 776         return ecoff_data (abfd)->gp_size;
 777       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 778         return elf_gp_size (abfd);
 779     }
 780   return 0;
 781 }
 782
 783 /*
 784 FUNCTION
 785         bfd_set_gp_size
 786
 787 SYNOPSIS
 788         void bfd_set_gp_size(bfd *abfd, int i);
 789
 790 DESCRIPTION
 791         Set the maximum size of objects to be optimized using the GP
 792         register under ECOFF or MIPS ELF.  This is typically set by
 793         the <<-G>> argument to the compiler, assembler or linker.
 794 */
 795
 796 void
 797 bfd_set_gp_size (abfd, i)
 798      bfd *abfd;
 799      int i;
 800 {
 801   /* Don't try to set GP size on an archive or core file! */
 802   if (abfd->format != bfd_object)
 803     return;
 804   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
 805     ecoff_data (abfd)->gp_size = i;
 806   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
 807     elf_gp_size (abfd) = i;
 808 }
 809
 810 /*
 811 FUNCTION
 812         bfd_scan_vma
 813
 814 SYNOPSIS
 815         bfd_vma bfd_scan_vma(CONST char *string, CONST char **end, int base);
 816
 817 DESCRIPTION
 818         Convert, like <<strtoul>>, a numerical expression
 819         @var{string} into a <<bfd_vma>> integer, and return that integer.
 820         (Though without as many bells and whistles as <<strtoul>>.)
 821         The expression is assumed to be unsigned (i.e., positive).
 822         If given a @var{base}, it is used as the base for conversion.
 823         A base of 0 causes the function to interpret the string
 824         in hex if a leading "0x" or "0X" is found, otherwise
 825         in octal if a leading zero is found, otherwise in decimal.
 826
 827         Overflow is not detected.
 828 */
 829
 830 bfd_vma
 831 bfd_scan_vma (string, end, base)
 832      CONST char *string;
 833      CONST char **end;
 834      int base;
 835 {
 836   bfd_vma value;
 837   int digit;
 838
 839   /* Let the host do it if possible.  */
 840   if (sizeof(bfd_vma) <= sizeof(unsigned long))
 841     return (bfd_vma) strtoul (string, (char **) end, base);
 842
 843   /* A negative base makes no sense, and we only need to go as high as hex.  */
 844   if ((base < 0) || (base > 16))
 845     return (bfd_vma) 0;
 846
 847   if (base == 0)
 848     {
 849       if (string[0] == '0')
 850         {
 851           if ((string[1] == 'x') || (string[1] == 'X'))
 852             base = 16;
 853           /* XXX should we also allow "0b" or "0B" to set base to 2? */
 854           else
 855             base = 8;
 856         }
 857       else
 858         base = 10;
 859     }
 860   if ((base == 16) &&
 861       (string[0] == '0') && ((string[1] == 'x') || (string[1] == 'X')))
 862     string += 2;
 863   /* XXX should we also skip over "0b" or "0B" if base is 2? */
 864
 865 /* Speed could be improved with a table like hex_value[] in gas.  */
 866 #define HEX_VALUE(c) \
 867   (isxdigit(c) ?                                \
 868     (isdigit(c) ?                               \
 869       (c - '0') :                               \
 870       (10 + c - (islower(c) ? 'a' : 'A'))) :    \
 871     42)
 872
 873   for (value = 0; (digit = HEX_VALUE(*string)) < base; string++)
 874     {
 875       value = value * base + digit;
 876     }
 877
 878   if (end)
 879     *end = string;
 880
 881   return value;
 882 }
 883
 884 /*
 885 FUNCTION
 886         bfd_copy_private_bfd_data
 887
 888 SYNOPSIS
 889         boolean bfd_copy_private_bfd_data(bfd *ibfd, bfd *obfd);
 890
 891 DESCRIPTION
 892         Copy private BFD information from the BFD @var{ibfd} to the
 893         the BFD @var{obfd}.  Return <<true>> on success, <<false>> on error.
 894         Possible error returns are:
 895
 896         o <<bfd_error_no_memory>> -
 897         Not enough memory exists to create private data for @var{obfd}.
 898
 899 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
 900 .     BFD_SEND (ibfd, _bfd_copy_private_bfd_data, \
 901 .               (ibfd, obfd))
 902
 903 */
 904
 905 /*
 906 FUNCTION
 907         bfd_merge_private_bfd_data
 908
 909 SYNOPSIS
 910         boolean bfd_merge_private_bfd_data(bfd *ibfd, bfd *obfd);
 911
 912 DESCRIPTION
 913         Merge private BFD information from the BFD @var{ibfd} to the
 914         the output file BFD @var{obfd} when linking.  Return <<true>>
 915         on success, <<false>> on error.  Possible error returns are:
 916
 917         o <<bfd_error_no_memory>> -
 918         Not enough memory exists to create private data for @var{obfd}.
 919
 920 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
 921 .     BFD_SEND (ibfd, _bfd_merge_private_bfd_data, \
 922 .               (ibfd, obfd))
 923
 924 */
 925
 926 /*
 927 FUNCTION
 928         bfd_set_private_flags
 929
 930 SYNOPSIS
 931         boolean bfd_set_private_flags(bfd *abfd, flagword flags);
 932
 933 DESCRIPTION
 934         Set private BFD flag information in the BFD @var{abfd}.
 935         Return <<true>> on success, <<false>> on error.  Possible error
 936         returns are:
 937
 938         o <<bfd_error_no_memory>> -
 939         Not enough memory exists to create private data for @var{obfd}.
 940
 941 .#define bfd_set_private_flags(abfd, flags) \
 942 .     BFD_SEND (abfd, _bfd_set_private_flags, \
 943 .               (abfd, flags))
 944
 945 */
 946
 947 /*
 948 FUNCTION
 949         stuff
 950
 951 DESCRIPTION
 952         Stuff which should be documented:
 953
 954 .#define bfd_sizeof_headers(abfd, reloc) \
 955 .     BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
 956 .
 957 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
 958 .     BFD_SEND (abfd, _bfd_find_nearest_line,  (abfd, sec, syms, off, file, func, line))
 959 .
 960 .       {* Do these three do anything useful at all, for any back end?  *}
 961 .#define bfd_debug_info_start(abfd) \
 962 .        BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
 963 .
 964 .#define bfd_debug_info_end(abfd) \
 965 .        BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
 966 .
 967 .#define bfd_debug_info_accumulate(abfd, section) \
 968 .        BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
 969 .
 970 .
 971 .#define bfd_stat_arch_elt(abfd, stat) \
 972 .        BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
 973 .
 974 .#define bfd_update_armap_timestamp(abfd) \
 975 .        BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
 976 .
 977 .#define bfd_set_arch_mach(abfd, arch, mach)\
 978 .        BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
 979 .
 980 .#define bfd_relax_section(abfd, section, link_info, again) \
 981 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
 982 .
 983 .#define bfd_link_hash_table_create(abfd) \
 984 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
 985 .
 986 .#define bfd_link_add_symbols(abfd, info) \
 987 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
 988 .
 989 .#define bfd_final_link(abfd, info) \
 990 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
 991 .
 992 .#define bfd_free_cached_info(abfd) \
 993 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
 994 .
 995 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
 996 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
 997 .
 998 .#define bfd_print_private_bfd_data(abfd, file)\
 999 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1000 .
1001 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1002 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1003 .
1004 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1005 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1006 .
1007 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1008 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1009 .
1010 .extern bfd_byte *bfd_get_relocated_section_contents
1011 .       PARAMS ((bfd *, struct bfd_link_info *,
1012 .                 struct bfd_link_order *, bfd_byte *,
1013 .                 boolean, asymbol **));
1014 .
1015
1016 */
1017
1018 bfd_byte *
1019 bfd_get_relocated_section_contents (abfd, link_info, link_order, data,
1020                                     relocateable, symbols)
1021      bfd *abfd;
1022      struct bfd_link_info *link_info;
1023      struct bfd_link_order *link_order;
1024      bfd_byte *data;
1025      boolean relocateable;
1026      asymbol **symbols;
1027 {
1028   bfd *abfd2;
1029   bfd_byte *(*fn) PARAMS ((bfd *, struct bfd_link_info *,
1030                            struct bfd_link_order *, bfd_byte *, boolean,
1031                            asymbol **));
1032
1033   if (link_order->type == bfd_indirect_link_order)
1034     {
1035       abfd2 = link_order->u.indirect.section->owner;
1036       if (abfd2 == 0)
1037         abfd2 = abfd;
1038     }
1039   else
1040     abfd2 = abfd;
1041   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1042
1043   return (*fn) (abfd, link_info, link_order, data, relocateable, symbols);
1044 }
1045
1046
1047