* bfd.c (bfd_record_phdr): New function.
[platform/upstream/binutils.git] / 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 xcoff_tdata *xcoff_obj_data;
157 .      struct ecoff_tdata *ecoff_obj_data;
158 .      struct ieee_data_struct *ieee_data;
159 .      struct ieee_ar_data_struct *ieee_ar_data;
160 .      struct srec_data_struct *srec_data;
161 .      struct tekhex_data_struct *tekhex_data;
162 .      struct elf_obj_tdata *elf_obj_data;
163 .      struct nlm_obj_tdata *nlm_obj_data;
164 .      struct bout_data_struct *bout_data;
165 .      struct sun_core_struct *sun_core_data;
166 .      struct trad_core_struct *trad_core_data;
167 .      struct som_data_struct *som_data;
168 .      struct hpux_core_struct *hpux_core_data;
169 .      struct hppabsd_core_struct *hppabsd_core_data;
170 .      struct sgi_core_struct *sgi_core_data;
171 .      struct lynx_core_struct *lynx_core_data;
172 .      struct osf_core_struct *osf_core_data;
173 .      struct cisco_core_struct *cisco_core_data;
174 .      struct versados_data_struct *versados_data;
175 .      PTR any;
176 .      } tdata;
177 .  
178 .    {* Used by the application to hold private data*}
179 .    PTR usrdata;
180 .
181 .    {* Where all the allocated stuff under this BFD goes *}
182 .    struct obstack memory;
183 .};
184 .
185 */
186
187 #include "bfd.h"
188 #include "sysdep.h"
189
190 #ifdef ANSI_PROTOTYPES
191 #include <stdarg.h>
192 #else
193 #include <varargs.h>
194 #endif
195
196 #include "bfdlink.h"
197 #include "libbfd.h"
198 #include "coff/internal.h"
199 #include "coff/sym.h"
200 #include "libcoff.h"
201 #include "libecoff.h"
202 #undef obj_symbols
203 #include "elf-bfd.h"
204
205 #include <ctype.h>
206 \f
207 /* provide storage for subsystem, stack and heap data which may have been
208    passed in on the command line.  Ld puts this data into a bfd_link_info
209    struct which ultimately gets passed in to the bfd.  When it arrives, copy
210    it to the following struct so that the data will be available in coffcode.h
211    where it is needed.  The typedef's used are defined in bfd.h */
212
213
214 \f
215 /*
216 SECTION
217         Error reporting
218
219         Most BFD functions return nonzero on success (check their
220         individual documentation for precise semantics).  On an error,
221         they call <<bfd_set_error>> to set an error condition that callers
222         can check by calling <<bfd_get_error>>.
223         If that returns <<bfd_error_system_call>>, then check
224         <<errno>>.
225
226         The easiest way to report a BFD error to the user is to
227         use <<bfd_perror>>.
228
229 SUBSECTION
230         Type <<bfd_error_type>>
231
232         The values returned by <<bfd_get_error>> are defined by the
233         enumerated type <<bfd_error_type>>.
234
235 CODE_FRAGMENT
236 .
237 .typedef enum bfd_error
238 .{
239 .  bfd_error_no_error = 0,
240 .  bfd_error_system_call,
241 .  bfd_error_invalid_target,
242 .  bfd_error_wrong_format,
243 .  bfd_error_invalid_operation,
244 .  bfd_error_no_memory,
245 .  bfd_error_no_symbols,
246 .  bfd_error_no_armap,
247 .  bfd_error_no_more_archived_files,
248 .  bfd_error_malformed_archive,
249 .  bfd_error_file_not_recognized,
250 .  bfd_error_file_ambiguously_recognized,
251 .  bfd_error_no_contents,
252 .  bfd_error_nonrepresentable_section,
253 .  bfd_error_no_debug_section,
254 .  bfd_error_bad_value,
255 .  bfd_error_file_truncated,
256 .  bfd_error_file_too_big,
257 .  bfd_error_invalid_error_code
258 .} bfd_error_type;
259 .
260 */
261
262 #undef strerror
263 extern char *strerror();
264
265 static bfd_error_type bfd_error = bfd_error_no_error;
266
267 CONST char *CONST bfd_errmsgs[] = {
268                         "No error",
269                         "System call error",
270                         "Invalid bfd target",
271                         "File in wrong format",
272                         "Invalid operation",
273                         "Memory exhausted",
274                         "No symbols",
275                         "Archive has no index; run ranlib to add one",
276                         "No more archived files",
277                         "Malformed archive",
278                         "File format not recognized",
279                         "File format is ambiguous",
280                         "Section has no contents",
281                         "Nonrepresentable section on output",
282                         "Symbol needs debug section which does not exist",
283                         "Bad value",
284                         "File truncated",
285                         "File too big",
286                         "#<Invalid error code>"
287                        };
288
289 /*
290 FUNCTION
291         bfd_get_error
292
293 SYNOPSIS
294         bfd_error_type bfd_get_error (void);
295
296 DESCRIPTION
297         Return the current BFD error condition.
298 */
299
300 bfd_error_type
301 bfd_get_error ()
302 {
303   return bfd_error;
304 }
305
306 /*
307 FUNCTION
308         bfd_set_error
309
310 SYNOPSIS
311         void bfd_set_error (bfd_error_type error_tag);
312
313 DESCRIPTION
314         Set the BFD error condition to be @var{error_tag}.
315 */
316
317 void
318 bfd_set_error (error_tag)
319      bfd_error_type error_tag;
320 {
321   bfd_error = error_tag;
322 }
323
324 /*
325 FUNCTION
326         bfd_errmsg
327
328 SYNOPSIS
329         CONST char *bfd_errmsg (bfd_error_type error_tag);
330
331 DESCRIPTION
332         Return a string describing the error @var{error_tag}, or
333         the system error if @var{error_tag} is <<bfd_error_system_call>>.
334 */
335
336 CONST char *
337 bfd_errmsg (error_tag)
338      bfd_error_type error_tag;
339 {
340 #ifndef errno
341   extern int errno;
342 #endif
343   if (error_tag == bfd_error_system_call)
344     return strerror (errno);
345
346   if ((((int)error_tag <(int) bfd_error_no_error) ||
347        ((int)error_tag > (int)bfd_error_invalid_error_code)))
348     error_tag = bfd_error_invalid_error_code;/* sanity check */
349
350   return bfd_errmsgs [(int)error_tag];
351 }
352
353 /*
354 FUNCTION
355         bfd_perror
356
357 SYNOPSIS
358         void bfd_perror (CONST char *message);
359
360 DESCRIPTION
361         Print to the standard error stream a string describing the
362         last BFD error that occurred, or the last system error if
363         the last BFD error was a system call failure.  If @var{message}
364         is non-NULL and non-empty, the error string printed is preceded
365         by @var{message}, a colon, and a space.  It is followed by a newline.
366 */
367
368 void
369 bfd_perror (message)
370      CONST char *message;
371 {
372   if (bfd_get_error () == bfd_error_system_call)
373     perror((char *)message);            /* must be system error then... */
374   else {
375     if (message == NULL || *message == '\0')
376       fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
377     else
378       fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
379   }
380 }
381
382 /*
383 SUBSECTION
384         BFD error handler
385
386         Some BFD functions want to print messages describing the
387         problem.  They call a BFD error handler function.  This
388         function may be overriden by the program.
389
390         The BFD error handler acts like printf.
391
392 CODE_FRAGMENT
393 .
394 .typedef void (*bfd_error_handler_type) PARAMS ((const char *, ...));
395 .
396 */
397
398 /* The program name used when printing BFD error messages.  */
399
400 static const char *_bfd_error_program_name;
401
402 /* This is the default routine to handle BFD error messages.  */
403
404 #ifdef ANSI_PROTOTYPES
405
406 static void _bfd_default_error_handler PARAMS ((const char *s, ...));
407
408 static void
409 _bfd_default_error_handler (const char *s, ...)
410 {
411   va_list p;
412
413   if (_bfd_error_program_name != NULL)
414     fprintf (stderr, "%s: ", _bfd_error_program_name);
415
416   va_start (p, s);
417
418   vfprintf (stderr, s, p);
419
420   va_end (p);
421
422   fprintf (stderr, "\n");
423 }
424
425 #else /* ! defined (ANSI_PROTOTYPES) */
426
427 static void _bfd_default_error_handler ();
428
429 static void
430 _bfd_default_error_handler (va_alist)
431      va_dcl
432 {
433   va_list p;
434   const char *s;
435
436   if (_bfd_error_program_name != NULL)
437     fprintf (stderr, "%s: ", _bfd_error_program_name);
438
439   va_start (p);
440
441   s = va_arg (p, const char *);
442   vfprintf (stderr, s, p);
443
444   va_end (p);
445
446   fprintf (stderr, "\n");
447 }
448
449 #endif /* ! defined (ANSI_PROTOTYPES) */
450
451 /* This is a function pointer to the routine which should handle BFD
452    error messages.  It is called when a BFD routine encounters an
453    error for which it wants to print a message.  Going through a
454    function pointer permits a program linked against BFD to intercept
455    the messages and deal with them itself.  */
456
457 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
458
459 /*
460 FUNCTION
461         bfd_set_error_handler
462
463 SYNOPSIS
464         bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
465
466 DESCRIPTION
467         Set the BFD error handler function.  Returns the previous
468         function.
469 */
470
471 bfd_error_handler_type
472 bfd_set_error_handler (pnew)
473      bfd_error_handler_type pnew;
474 {
475   bfd_error_handler_type pold;
476
477   pold = _bfd_error_handler;
478   _bfd_error_handler = pnew;
479   return pold;
480 }
481
482 /*
483 FUNCTION
484         bfd_set_error_program_name
485
486 SYNOPSIS
487         void bfd_set_error_program_name (const char *);
488
489 DESCRIPTION
490         Set the program name to use when printing a BFD error.  This
491         is printed before the error message followed by a colon and
492         space.  The string must not be changed after it is passed to
493         this function.
494 */
495
496 void
497 bfd_set_error_program_name (name)
498      const char *name;
499 {
500   _bfd_error_program_name = name;
501 }
502 \f
503 /*
504 SECTION
505         Symbols
506 */
507
508 /*
509 FUNCTION
510         bfd_get_reloc_upper_bound
511
512 SYNOPSIS
513         long bfd_get_reloc_upper_bound(bfd *abfd, asection *sect);
514
515 DESCRIPTION
516         Return the number of bytes required to store the
517         relocation information associated with section @var{sect}
518         attached to bfd @var{abfd}.  If an error occurs, return -1.
519
520 */
521
522
523 long
524 bfd_get_reloc_upper_bound (abfd, asect)
525      bfd *abfd;
526      sec_ptr asect;
527 {
528   if (abfd->format != bfd_object) {
529     bfd_set_error (bfd_error_invalid_operation);
530     return -1;
531   }
532
533   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
534 }
535
536 /*
537 FUNCTION
538         bfd_canonicalize_reloc
539
540 SYNOPSIS
541         long bfd_canonicalize_reloc
542                 (bfd *abfd,
543                 asection *sec,
544                 arelent **loc,
545                 asymbol **syms);
546
547 DESCRIPTION
548         Call the back end associated with the open BFD
549         @var{abfd} and translate the external form of the relocation
550         information attached to @var{sec} into the internal canonical
551         form.  Place the table into memory at @var{loc}, which has
552         been preallocated, usually by a call to
553         <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
554         -1 on error.
555
556         The @var{syms} table is also needed for horrible internal magic
557         reasons.
558
559
560 */
561 long
562 bfd_canonicalize_reloc (abfd, asect, location, symbols)
563      bfd *abfd;
564      sec_ptr asect;
565      arelent **location;
566      asymbol **symbols;
567 {
568   if (abfd->format != bfd_object) {
569     bfd_set_error (bfd_error_invalid_operation);
570     return -1;
571   }
572   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
573                    (abfd, asect, location, symbols));
574 }
575
576 /*
577 FUNCTION
578         bfd_set_reloc
579
580 SYNOPSIS
581         void bfd_set_reloc
582           (bfd *abfd, asection *sec, arelent **rel, unsigned int count)
583
584 DESCRIPTION
585         Set the relocation pointer and count within
586         section @var{sec} to the values @var{rel} and @var{count}.
587         The argument @var{abfd} is ignored.
588
589 */
590 /*ARGSUSED*/
591 void
592 bfd_set_reloc (ignore_abfd, asect, location, count)
593      bfd *ignore_abfd;
594      sec_ptr asect;
595      arelent **location;
596      unsigned int count;
597 {
598   asect->orelocation  = location;
599   asect->reloc_count = count;
600 }
601
602 /*
603 FUNCTION
604         bfd_set_file_flags
605
606 SYNOPSIS
607         boolean bfd_set_file_flags(bfd *abfd, flagword flags);
608
609 DESCRIPTION
610         Set the flag word in the BFD @var{abfd} to the value @var{flags}.
611
612         Possible errors are:
613         o <<bfd_error_wrong_format>> - The target bfd was not of object format.
614         o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
615         o <<bfd_error_invalid_operation>> -
616         The flag word contained a bit which was not applicable to the
617         type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
618         on a BFD format which does not support demand paging.
619
620 */
621
622 boolean
623 bfd_set_file_flags (abfd, flags)
624      bfd *abfd;
625      flagword flags;
626 {
627   if (abfd->format != bfd_object) {
628     bfd_set_error (bfd_error_wrong_format);
629     return false;
630   }
631
632   if (bfd_read_p (abfd)) {
633     bfd_set_error (bfd_error_invalid_operation);
634     return false;
635   }
636
637   bfd_get_file_flags (abfd) = flags;
638   if ((flags & bfd_applicable_file_flags (abfd)) != flags) {
639     bfd_set_error (bfd_error_invalid_operation);
640     return false;
641   }
642
643 return true;
644 }
645
646 void
647 bfd_assert (file, line)
648      const char *file;
649      int line;
650 {
651   (*_bfd_error_handler) ("bfd assertion fail %s:%d", file, line);
652 }
653
654
655 /*
656 FUNCTION
657         bfd_set_start_address
658
659 SYNOPSIS
660         boolean bfd_set_start_address(bfd *abfd, bfd_vma vma);
661
662 DESCRIPTION
663         Make @var{vma} the entry point of output BFD @var{abfd}.
664
665 RETURNS
666         Returns <<true>> on success, <<false>> otherwise.
667 */
668
669 boolean
670 bfd_set_start_address(abfd, vma)
671 bfd *abfd;
672 bfd_vma vma;
673 {
674   abfd->start_address = vma;
675   return true;
676 }
677
678
679 /*
680 FUNCTION
681         bfd_get_mtime
682
683 SYNOPSIS
684         long bfd_get_mtime(bfd *abfd);
685
686 DESCRIPTION
687         Return the file modification time (as read from the file system, or
688         from the archive header for archive members).
689
690 */
691
692 long
693 bfd_get_mtime (abfd)
694      bfd *abfd;
695 {
696   FILE *fp;
697   struct stat buf;
698
699   if (abfd->mtime_set)
700     return abfd->mtime;
701
702   fp = bfd_cache_lookup (abfd);
703   if (0 != fstat (fileno (fp), &buf))
704     return 0;
705
706   abfd->mtime = buf.st_mtime;           /* Save value in case anyone wants it */
707   return buf.st_mtime;
708 }
709
710 /*
711 FUNCTION
712         bfd_get_size
713
714 SYNOPSIS
715         long bfd_get_size(bfd *abfd);
716
717 DESCRIPTION
718         Return the file size (as read from file system) for the file
719         associated with BFD @var{abfd}.
720
721         The initial motivation for, and use of, this routine is not
722         so we can get the exact size of the object the BFD applies to, since
723         that might not be generally possible (archive members for example).
724         It would be ideal if someone could eventually modify
725         it so that such results were guaranteed.
726
727         Instead, we want to ask questions like "is this NNN byte sized
728         object I'm about to try read from file offset YYY reasonable?"
729         As as example of where we might do this, some object formats
730         use string tables for which the first <<sizeof(long)>> bytes of the
731         table contain the size of the table itself, including the size bytes.
732         If an application tries to read what it thinks is one of these
733         string tables, without some way to validate the size, and for
734         some reason the size is wrong (byte swapping error, wrong location
735         for the string table, etc.), the only clue is likely to be a read
736         error when it tries to read the table, or a "virtual memory
737         exhausted" error when it tries to allocate 15 bazillon bytes
738         of space for the 15 bazillon byte table it is about to read.
739         This function at least allows us to answer the quesion, "is the
740         size reasonable?".
741 */
742
743 long
744 bfd_get_size (abfd)
745      bfd *abfd;
746 {
747   FILE *fp;
748   struct stat buf;
749
750   fp = bfd_cache_lookup (abfd);
751   if (0 != fstat (fileno (fp), &buf))
752     return 0;
753
754   return buf.st_size;
755 }
756
757 /*
758 FUNCTION
759         bfd_get_gp_size
760
761 SYNOPSIS
762         int bfd_get_gp_size(bfd *abfd);
763
764 DESCRIPTION
765         Return the maximum size of objects to be optimized using the GP
766         register under MIPS ECOFF.  This is typically set by the <<-G>>
767         argument to the compiler, assembler or linker.
768 */
769
770 int
771 bfd_get_gp_size (abfd)
772      bfd *abfd;
773 {
774   if (abfd->format == bfd_object)
775     {
776       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
777         return ecoff_data (abfd)->gp_size;
778       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
779         return elf_gp_size (abfd);
780     }
781   return 0;
782 }
783
784 /*
785 FUNCTION
786         bfd_set_gp_size
787
788 SYNOPSIS
789         void bfd_set_gp_size(bfd *abfd, int i);
790
791 DESCRIPTION
792         Set the maximum size of objects to be optimized using the GP
793         register under ECOFF or MIPS ELF.  This is typically set by
794         the <<-G>> argument to the compiler, assembler or linker.
795 */
796
797 void
798 bfd_set_gp_size (abfd, i)
799      bfd *abfd;
800      int i;
801 {
802   /* Don't try to set GP size on an archive or core file! */
803   if (abfd->format != bfd_object)
804     return;
805   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
806     ecoff_data (abfd)->gp_size = i;
807   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
808     elf_gp_size (abfd) = i;
809 }
810
811 /*
812 FUNCTION
813         bfd_scan_vma
814
815 SYNOPSIS
816         bfd_vma bfd_scan_vma(CONST char *string, CONST char **end, int base);
817
818 DESCRIPTION
819         Convert, like <<strtoul>>, a numerical expression
820         @var{string} into a <<bfd_vma>> integer, and return that integer.
821         (Though without as many bells and whistles as <<strtoul>>.)
822         The expression is assumed to be unsigned (i.e., positive).
823         If given a @var{base}, it is used as the base for conversion.
824         A base of 0 causes the function to interpret the string
825         in hex if a leading "0x" or "0X" is found, otherwise
826         in octal if a leading zero is found, otherwise in decimal.
827
828         Overflow is not detected.
829 */
830
831 bfd_vma
832 bfd_scan_vma (string, end, base)
833      CONST char *string;
834      CONST char **end;
835      int base;
836 {
837   bfd_vma value;
838   int digit;
839
840   /* Let the host do it if possible.  */
841   if (sizeof(bfd_vma) <= sizeof(unsigned long))
842     return (bfd_vma) strtoul (string, (char **) end, base);
843
844   /* A negative base makes no sense, and we only need to go as high as hex.  */
845   if ((base < 0) || (base > 16))
846     return (bfd_vma) 0;
847
848   if (base == 0)
849     {
850       if (string[0] == '0')
851         {
852           if ((string[1] == 'x') || (string[1] == 'X'))
853             base = 16;
854           /* XXX should we also allow "0b" or "0B" to set base to 2? */
855           else
856             base = 8;
857         }
858       else
859         base = 10;
860     }
861   if ((base == 16) &&
862       (string[0] == '0') && ((string[1] == 'x') || (string[1] == 'X')))
863     string += 2;
864   /* XXX should we also skip over "0b" or "0B" if base is 2? */
865     
866 /* Speed could be improved with a table like hex_value[] in gas.  */
867 #define HEX_VALUE(c) \
868   (isxdigit(c) ?                                \
869     (isdigit(c) ?                               \
870       (c - '0') :                               \
871       (10 + c - (islower(c) ? 'a' : 'A'))) :    \
872     42)
873
874   for (value = 0; (digit = HEX_VALUE(*string)) < base; string++)
875     {
876       value = value * base + digit;
877     }
878
879   if (end)
880     *end = string;
881
882   return value;
883 }
884
885 /*
886 FUNCTION
887         bfd_copy_private_bfd_data
888
889 SYNOPSIS
890         boolean bfd_copy_private_bfd_data(bfd *ibfd, bfd *obfd);
891
892 DESCRIPTION
893         Copy private BFD information from the BFD @var{ibfd} to the 
894         the BFD @var{obfd}.  Return <<true>> on success, <<false>> on error.
895         Possible error returns are:
896
897         o <<bfd_error_no_memory>> -
898         Not enough memory exists to create private data for @var{obfd}.
899
900 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
901 .     BFD_SEND (ibfd, _bfd_copy_private_bfd_data, \
902 .               (ibfd, obfd))
903
904 */
905
906 /*
907 FUNCTION
908         bfd_merge_private_bfd_data
909
910 SYNOPSIS
911         boolean bfd_merge_private_bfd_data(bfd *ibfd, bfd *obfd);
912
913 DESCRIPTION
914         Merge private BFD information from the BFD @var{ibfd} to the 
915         the output file BFD @var{obfd} when linking.  Return <<true>>
916         on success, <<false>> on error.  Possible error returns are:
917
918         o <<bfd_error_no_memory>> -
919         Not enough memory exists to create private data for @var{obfd}.
920
921 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
922 .     BFD_SEND (ibfd, _bfd_merge_private_bfd_data, \
923 .               (ibfd, obfd))
924
925 */
926
927 /*
928 FUNCTION
929         bfd_set_private_flags
930
931 SYNOPSIS
932         boolean bfd_set_private_flags(bfd *abfd, flagword flags);
933
934 DESCRIPTION
935         Set private BFD flag information in the BFD @var{abfd}.
936         Return <<true>> on success, <<false>> on error.  Possible error
937         returns are:
938
939         o <<bfd_error_no_memory>> -
940         Not enough memory exists to create private data for @var{obfd}.
941
942 .#define bfd_set_private_flags(abfd, flags) \
943 .     BFD_SEND (abfd, _bfd_set_private_flags, \
944 .               (abfd, flags))
945
946 */
947
948 /*
949 FUNCTION
950         stuff
951
952 DESCRIPTION
953         Stuff which should be documented:
954
955 .#define bfd_sizeof_headers(abfd, reloc) \
956 .     BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
957 .
958 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
959 .     BFD_SEND (abfd, _bfd_find_nearest_line,  (abfd, sec, syms, off, file, func, line))
960 .
961 .       {* Do these three do anything useful at all, for any back end?  *}
962 .#define bfd_debug_info_start(abfd) \
963 .        BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
964 .
965 .#define bfd_debug_info_end(abfd) \
966 .        BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
967 .
968 .#define bfd_debug_info_accumulate(abfd, section) \
969 .        BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
970 .
971 .
972 .#define bfd_stat_arch_elt(abfd, stat) \
973 .        BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
974 .
975 .#define bfd_update_armap_timestamp(abfd) \
976 .        BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
977 .
978 .#define bfd_set_arch_mach(abfd, arch, mach)\
979 .        BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
980 .
981 .#define bfd_relax_section(abfd, section, link_info, again) \
982 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
983 .
984 .#define bfd_link_hash_table_create(abfd) \
985 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
986 .
987 .#define bfd_link_add_symbols(abfd, info) \
988 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
989 .
990 .#define bfd_final_link(abfd, info) \
991 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
992 .
993 .#define bfd_free_cached_info(abfd) \
994 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
995 .
996 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
997 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
998 .
999 .#define bfd_print_private_bfd_data(abfd, file)\
1000 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1001 .
1002 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1003 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1004 .
1005 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1006 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1007 .
1008 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1009 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1010 .
1011 .extern bfd_byte *bfd_get_relocated_section_contents
1012 .       PARAMS ((bfd *, struct bfd_link_info *,
1013 .                 struct bfd_link_order *, bfd_byte *,
1014 .                 boolean, asymbol **));
1015 .
1016
1017 */
1018
1019 bfd_byte *
1020 bfd_get_relocated_section_contents (abfd, link_info, link_order, data,
1021                                     relocateable, symbols)
1022      bfd *abfd;
1023      struct bfd_link_info *link_info;
1024      struct bfd_link_order *link_order;
1025      bfd_byte *data;
1026      boolean relocateable;
1027      asymbol **symbols;
1028 {
1029   bfd *abfd2;
1030   bfd_byte *(*fn) PARAMS ((bfd *, struct bfd_link_info *,
1031                            struct bfd_link_order *, bfd_byte *, boolean,
1032                            asymbol **));
1033
1034   if (link_order->type == bfd_indirect_link_order)
1035     {
1036       abfd2 = link_order->u.indirect.section->owner;
1037       if (abfd2 == 0)
1038         abfd2 = abfd;
1039     }
1040   else
1041     abfd2 = abfd;
1042   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1043
1044   return (*fn) (abfd, link_info, link_order, data, relocateable, symbols);
1045 }
1046
1047 /* Record information about an ELF program header.  */
1048
1049 boolean
1050 bfd_record_phdr (abfd, type, flags_valid, flags, at_valid, at,
1051                  includes_filehdr, includes_phdrs, count, secs)
1052      bfd *abfd;
1053      unsigned long type;
1054      boolean flags_valid;
1055      flagword flags;
1056      boolean at_valid;
1057      bfd_vma at;
1058      boolean includes_filehdr;
1059      boolean includes_phdrs;
1060      unsigned int count;
1061      asection **secs;
1062 {
1063   struct elf_segment_map *m, **pm;
1064
1065   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1066     return true;
1067
1068   m = ((struct elf_segment_map *)
1069        bfd_alloc (abfd,
1070                   (sizeof (struct elf_segment_map)
1071                    + (count - 1) * sizeof (asection *))));
1072   if (m == NULL)
1073     return false;
1074
1075   m->next = NULL;
1076   m->p_type = type;
1077   m->p_flags = flags;
1078   m->p_paddr = at;
1079   m->p_flags_valid = flags_valid;
1080   m->p_paddr_valid = at_valid;
1081   m->includes_filehdr = includes_filehdr;
1082   m->includes_phdrs = includes_phdrs;
1083   m->count = count;
1084   if (count > 0)
1085     memcpy (m->sections, secs, count * sizeof (asection *));
1086
1087   for (pm = &elf_tdata (abfd)->segment_map; *pm != NULL; pm = &(*pm)->next)
1088     ;
1089   *pm = m;
1090
1091   return true;
1092 }