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