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