Add compressed debug section support to binutils and ld.
[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, 2003, 2004, 2005, 2006, 2007, 2008, 2009
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 3 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
22    MA 02110-1301, USA.  */
23
24 /*
25 SECTION
26         <<typedef bfd>>
27
28         A BFD has type <<bfd>>; objects of this type are the
29         cornerstone of any application using BFD. Using BFD
30         consists of making references though the BFD and to data in the BFD.
31
32         Here is the structure that defines the type <<bfd>>.  It
33         contains the major data about the file and pointers
34         to the rest of the data.
35
36 CODE_FRAGMENT
37 .
38 .enum bfd_direction
39 .  {
40 .    no_direction = 0,
41 .    read_direction = 1,
42 .    write_direction = 2,
43 .    both_direction = 3
44 .  };
45 .
46 .struct bfd
47 .{
48 .  {* A unique identifier of the BFD  *}
49 .  unsigned int id;
50 .
51 .  {* The filename the application opened the BFD with.  *}
52 .  const char *filename;
53 .
54 .  {* A pointer to the target jump table.  *}
55 .  const struct bfd_target *xvec;
56 .
57 .  {* The IOSTREAM, and corresponding IO vector that provide access
58 .     to the file backing the BFD.  *}
59 .  void *iostream;
60 .  const struct bfd_iovec *iovec;
61 .
62 .  {* The caching routines use these to maintain a
63 .     least-recently-used list of BFDs.  *}
64 .  struct bfd *lru_prev, *lru_next;
65 .
66 .  {* When a file is closed by the caching routines, BFD retains
67 .     state information on the file here...  *}
68 .  ufile_ptr where;
69 .
70 .  {* File modified time, if mtime_set is TRUE.  *}
71 .  long mtime;
72 .
73 .  {* Reserved for an unimplemented file locking extension.  *}
74 .  int ifd;
75 .
76 .  {* The format which belongs to the BFD. (object, core, etc.)  *}
77 .  bfd_format format;
78 .
79 .  {* The direction with which the BFD was opened.  *}
80 .  enum bfd_direction direction;
81 .
82 .  {* Format_specific flags.  *}
83 .  flagword flags;
84 .
85 .  {* Values that may appear in the flags field of a BFD.  These also
86 .     appear in the object_flags field of the bfd_target structure, where
87 .     they indicate the set of flags used by that backend (not all flags
88 .     are meaningful for all object file formats) (FIXME: at the moment,
89 .     the object_flags values have mostly just been copied from backend
90 .     to another, and are not necessarily correct).  *}
91 .
92 .#define BFD_NO_FLAGS   0x00
93 .
94 .  {* BFD contains relocation entries.  *}
95 .#define HAS_RELOC      0x01
96 .
97 .  {* BFD is directly executable.  *}
98 .#define EXEC_P         0x02
99 .
100 .  {* BFD has line number information (basically used for F_LNNO in a
101 .     COFF header).  *}
102 .#define HAS_LINENO     0x04
103 .
104 .  {* BFD has debugging information.  *}
105 .#define HAS_DEBUG      0x08
106 .
107 .  {* BFD has symbols.  *}
108 .#define HAS_SYMS       0x10
109 .
110 .  {* BFD has local symbols (basically used for F_LSYMS in a COFF
111 .     header).  *}
112 .#define HAS_LOCALS     0x20
113 .
114 .  {* BFD is a dynamic object.  *}
115 .#define DYNAMIC        0x40
116 .
117 .  {* Text section is write protected (if D_PAGED is not set, this is
118 .     like an a.out NMAGIC file) (the linker sets this by default, but
119 .     clears it for -r or -N).  *}
120 .#define WP_TEXT        0x80
121 .
122 .  {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
123 .     linker sets this by default, but clears it for -r or -n or -N).  *}
124 .#define D_PAGED        0x100
125 .
126 .  {* BFD is relaxable (this means that bfd_relax_section may be able to
127 .     do something) (sometimes bfd_relax_section can do something even if
128 .     this is not set).  *}
129 .#define BFD_IS_RELAXABLE 0x200
130 .
131 .  {* This may be set before writing out a BFD to request using a
132 .     traditional format.  For example, this is used to request that when
133 .     writing out an a.out object the symbols not be hashed to eliminate
134 .     duplicates.  *}
135 .#define BFD_TRADITIONAL_FORMAT 0x400
136 .
137 .  {* This flag indicates that the BFD contents are actually cached
138 .     in memory.  If this is set, iostream points to a bfd_in_memory
139 .     struct.  *}
140 .#define BFD_IN_MEMORY 0x800
141 .
142 .  {* The sections in this BFD specify a memory page.  *}
143 .#define HAS_LOAD_PAGE 0x1000
144 .
145 .  {* This BFD has been created by the linker and doesn't correspond
146 .     to any input file.  *}
147 .#define BFD_LINKER_CREATED 0x2000
148 .
149 .  {* This may be set before writing out a BFD to request that it
150 .     be written using values for UIDs, GIDs, timestamps, etc. that
151 .     will be consistent from run to run.  *}
152 .#define BFD_DETERMINISTIC_OUTPUT 0x4000
153 .
154 .  {* Compress sections in this BFD.  *}
155 .#define BFD_COMPRESS 0x8000
156 .
157 .  {* Decompress sections in this BFD.  *}
158 .#define BFD_DECOMPRESS 0x10000
159 .
160 .  {* Flags bits to be saved in bfd_preserve_save.  *}
161 .#define BFD_FLAGS_SAVED \
162 .  (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS)
163 .
164 .  {* Currently my_archive is tested before adding origin to
165 .     anything. I believe that this can become always an add of
166 .     origin, with origin set to 0 for non archive files.  *}
167 .  ufile_ptr origin;
168 .
169 .  {* The origin in the archive of the proxy entry.  This will
170 .     normally be the same as origin, except for thin archives,
171 .     when it will contain the current offset of the proxy in the
172 .     thin archive rather than the offset of the bfd in its actual
173 .     container.  *}
174 .  ufile_ptr proxy_origin;
175 .
176 .  {* A hash table for section names.  *}
177 .  struct bfd_hash_table section_htab;
178 .
179 .  {* Pointer to linked list of sections.  *}
180 .  struct bfd_section *sections;
181 .
182 .  {* The last section on the section list.  *}
183 .  struct bfd_section *section_last;
184 .
185 .  {* The number of sections.  *}
186 .  unsigned int section_count;
187 .
188 .  {* Stuff only useful for object files:
189 .     The start address.  *}
190 .  bfd_vma start_address;
191 .
192 .  {* Used for input and output.  *}
193 .  unsigned int symcount;
194 .
195 .  {* Symbol table for output BFD (with symcount entries).
196 .     Also used by the linker to cache input BFD symbols.  *}
197 .  struct bfd_symbol  **outsymbols;
198 .
199 .  {* Used for slurped dynamic symbol tables.  *}
200 .  unsigned int dynsymcount;
201 .
202 .  {* Pointer to structure which contains architecture information.  *}
203 .  const struct bfd_arch_info *arch_info;
204 .
205 .  {* Stuff only useful for archives.  *}
206 .  void *arelt_data;
207 .  struct bfd *my_archive;      {* The containing archive BFD.  *}
208 .  struct bfd *archive_next;    {* The next BFD in the archive.  *}
209 .  struct bfd *archive_head;    {* The first BFD in the archive.  *}
210 .  struct bfd *nested_archives; {* List of nested archive in a flattened
211 .                                  thin archive.  *}
212 .
213 .  {* A chain of BFD structures involved in a link.  *}
214 .  struct bfd *link_next;
215 .
216 .  {* A field used by _bfd_generic_link_add_archive_symbols.  This will
217 .     be used only for archive elements.  *}
218 .  int archive_pass;
219 .
220 .  {* Used by the back end to hold private data.  *}
221 .  union
222 .    {
223 .      struct aout_data_struct *aout_data;
224 .      struct artdata *aout_ar_data;
225 .      struct _oasys_data *oasys_obj_data;
226 .      struct _oasys_ar_data *oasys_ar_data;
227 .      struct coff_tdata *coff_obj_data;
228 .      struct pe_tdata *pe_obj_data;
229 .      struct xcoff_tdata *xcoff_obj_data;
230 .      struct ecoff_tdata *ecoff_obj_data;
231 .      struct ieee_data_struct *ieee_data;
232 .      struct ieee_ar_data_struct *ieee_ar_data;
233 .      struct srec_data_struct *srec_data;
234 .      struct verilog_data_struct *verilog_data;
235 .      struct ihex_data_struct *ihex_data;
236 .      struct tekhex_data_struct *tekhex_data;
237 .      struct elf_obj_tdata *elf_obj_data;
238 .      struct nlm_obj_tdata *nlm_obj_data;
239 .      struct bout_data_struct *bout_data;
240 .      struct mmo_data_struct *mmo_data;
241 .      struct sun_core_struct *sun_core_data;
242 .      struct sco5_core_struct *sco5_core_data;
243 .      struct trad_core_struct *trad_core_data;
244 .      struct som_data_struct *som_data;
245 .      struct hpux_core_struct *hpux_core_data;
246 .      struct hppabsd_core_struct *hppabsd_core_data;
247 .      struct sgi_core_struct *sgi_core_data;
248 .      struct lynx_core_struct *lynx_core_data;
249 .      struct osf_core_struct *osf_core_data;
250 .      struct cisco_core_struct *cisco_core_data;
251 .      struct versados_data_struct *versados_data;
252 .      struct netbsd_core_struct *netbsd_core_data;
253 .      struct mach_o_data_struct *mach_o_data;
254 .      struct mach_o_fat_data_struct *mach_o_fat_data;
255 .      struct plugin_data_struct *plugin_data;
256 .      struct bfd_pef_data_struct *pef_data;
257 .      struct bfd_pef_xlib_data_struct *pef_xlib_data;
258 .      struct bfd_sym_data_struct *sym_data;
259 .      void *any;
260 .    }
261 .  tdata;
262 .
263 .  {* Used by the application to hold private data.  *}
264 .  void *usrdata;
265 .
266 .  {* Where all the allocated stuff under this BFD goes.  This is a
267 .     struct objalloc *, but we use void * to avoid requiring the inclusion
268 .     of objalloc.h.  *}
269 .  void *memory;
270 .
271 .  {* Is the file descriptor being cached?  That is, can it be closed as
272 .     needed, and re-opened when accessed later?  *}
273 .  unsigned int cacheable : 1;
274 .
275 .  {* Marks whether there was a default target specified when the
276 .     BFD was opened. This is used to select which matching algorithm
277 .     to use to choose the back end.  *}
278 .  unsigned int target_defaulted : 1;
279 .
280 .  {* ... and here: (``once'' means at least once).  *}
281 .  unsigned int opened_once : 1;
282 .
283 .  {* Set if we have a locally maintained mtime value, rather than
284 .     getting it from the file each time.  *}
285 .  unsigned int mtime_set : 1;
286 .
287 .  {* Flag set if symbols from this BFD should not be exported.  *}
288 .  unsigned int no_export : 1;
289 .
290 .  {* Remember when output has begun, to stop strange things
291 .     from happening.  *}
292 .  unsigned int output_has_begun : 1;
293 .
294 .  {* Have archive map.  *}
295 .  unsigned int has_armap : 1;
296 .
297 .  {* Set if this is a thin archive.  *}
298 .  unsigned int is_thin_archive : 1;
299 .
300 .  {* Set if only required symbols should be added in the link hash table for
301 .     this object.  Used by VMS linkers.  *}
302 .  unsigned int selective_search : 1;
303 .};
304 .
305 */
306
307 #include "sysdep.h"
308 #include <stdarg.h>
309 #include "bfd.h"
310 #include "bfdver.h"
311 #include "libiberty.h"
312 #include "demangle.h"
313 #include "safe-ctype.h"
314 #include "bfdlink.h"
315 #include "libbfd.h"
316 #include "coff/internal.h"
317 #include "coff/sym.h"
318 #include "libcoff.h"
319 #include "libecoff.h"
320 #undef obj_symbols
321 #include "elf-bfd.h"
322
323 #ifndef EXIT_FAILURE
324 #define EXIT_FAILURE 1
325 #endif
326
327 \f
328 /* provide storage for subsystem, stack and heap data which may have been
329    passed in on the command line.  Ld puts this data into a bfd_link_info
330    struct which ultimately gets passed in to the bfd.  When it arrives, copy
331    it to the following struct so that the data will be available in coffcode.h
332    where it is needed.  The typedef's used are defined in bfd.h */
333 \f
334 /*
335 SECTION
336         Error reporting
337
338         Most BFD functions return nonzero on success (check their
339         individual documentation for precise semantics).  On an error,
340         they call <<bfd_set_error>> to set an error condition that callers
341         can check by calling <<bfd_get_error>>.
342         If that returns <<bfd_error_system_call>>, then check
343         <<errno>>.
344
345         The easiest way to report a BFD error to the user is to
346         use <<bfd_perror>>.
347
348 SUBSECTION
349         Type <<bfd_error_type>>
350
351         The values returned by <<bfd_get_error>> are defined by the
352         enumerated type <<bfd_error_type>>.
353
354 CODE_FRAGMENT
355 .
356 .typedef enum bfd_error
357 .{
358 .  bfd_error_no_error = 0,
359 .  bfd_error_system_call,
360 .  bfd_error_invalid_target,
361 .  bfd_error_wrong_format,
362 .  bfd_error_wrong_object_format,
363 .  bfd_error_invalid_operation,
364 .  bfd_error_no_memory,
365 .  bfd_error_no_symbols,
366 .  bfd_error_no_armap,
367 .  bfd_error_no_more_archived_files,
368 .  bfd_error_malformed_archive,
369 .  bfd_error_file_not_recognized,
370 .  bfd_error_file_ambiguously_recognized,
371 .  bfd_error_no_contents,
372 .  bfd_error_nonrepresentable_section,
373 .  bfd_error_no_debug_section,
374 .  bfd_error_bad_value,
375 .  bfd_error_file_truncated,
376 .  bfd_error_file_too_big,
377 .  bfd_error_on_input,
378 .  bfd_error_invalid_error_code
379 .}
380 .bfd_error_type;
381 .
382 */
383
384 static bfd_error_type bfd_error = bfd_error_no_error;
385 static bfd *input_bfd = NULL;
386 static bfd_error_type input_error = bfd_error_no_error;
387
388 const char *const bfd_errmsgs[] =
389 {
390   N_("No error"),
391   N_("System call error"),
392   N_("Invalid bfd target"),
393   N_("File in wrong format"),
394   N_("Archive object file in wrong format"),
395   N_("Invalid operation"),
396   N_("Memory exhausted"),
397   N_("No symbols"),
398   N_("Archive has no index; run ranlib to add one"),
399   N_("No more archived files"),
400   N_("Malformed archive"),
401   N_("File format not recognized"),
402   N_("File format is ambiguous"),
403   N_("Section has no contents"),
404   N_("Nonrepresentable section on output"),
405   N_("Symbol needs debug section which does not exist"),
406   N_("Bad value"),
407   N_("File truncated"),
408   N_("File too big"),
409   N_("Error reading %s: %s"),
410   N_("#<Invalid error code>")
411 };
412
413 /*
414 FUNCTION
415         bfd_get_error
416
417 SYNOPSIS
418         bfd_error_type bfd_get_error (void);
419
420 DESCRIPTION
421         Return the current BFD error condition.
422 */
423
424 bfd_error_type
425 bfd_get_error (void)
426 {
427   return bfd_error;
428 }
429
430 /*
431 FUNCTION
432         bfd_set_error
433
434 SYNOPSIS
435         void bfd_set_error (bfd_error_type error_tag, ...);
436
437 DESCRIPTION
438         Set the BFD error condition to be @var{error_tag}.
439         If @var{error_tag} is bfd_error_on_input, then this function
440         takes two more parameters, the input bfd where the error
441         occurred, and the bfd_error_type error.
442 */
443
444 void
445 bfd_set_error (bfd_error_type error_tag, ...)
446 {
447   bfd_error = error_tag;
448   if (error_tag == bfd_error_on_input)
449     {
450       /* This is an error that occurred during bfd_close when
451          writing an archive, but on one of the input files.  */
452       va_list ap;
453
454       va_start (ap, error_tag);
455       input_bfd = va_arg (ap, bfd *);
456       input_error = (bfd_error_type) va_arg (ap, int);
457       if (input_error >= bfd_error_on_input)
458         abort ();
459       va_end (ap);
460     }
461 }
462
463 /*
464 FUNCTION
465         bfd_errmsg
466
467 SYNOPSIS
468         const char *bfd_errmsg (bfd_error_type error_tag);
469
470 DESCRIPTION
471         Return a string describing the error @var{error_tag}, or
472         the system error if @var{error_tag} is <<bfd_error_system_call>>.
473 */
474
475 const char *
476 bfd_errmsg (bfd_error_type error_tag)
477 {
478 #ifndef errno
479   extern int errno;
480 #endif
481   if (error_tag == bfd_error_on_input)
482     {
483       char *buf;
484       const char *msg = bfd_errmsg (input_error);
485
486       if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
487           != -1)
488         return buf;
489
490       /* Ick, what to do on out of memory?  */
491       return msg;
492     }
493
494   if (error_tag == bfd_error_system_call)
495     return xstrerror (errno);
496
497   if (error_tag > bfd_error_invalid_error_code)
498     error_tag = bfd_error_invalid_error_code;   /* sanity check */
499
500   return _(bfd_errmsgs [error_tag]);
501 }
502
503 /*
504 FUNCTION
505         bfd_perror
506
507 SYNOPSIS
508         void bfd_perror (const char *message);
509
510 DESCRIPTION
511         Print to the standard error stream a string describing the
512         last BFD error that occurred, or the last system error if
513         the last BFD error was a system call failure.  If @var{message}
514         is non-NULL and non-empty, the error string printed is preceded
515         by @var{message}, a colon, and a space.  It is followed by a newline.
516 */
517
518 void
519 bfd_perror (const char *message)
520 {
521   if (message == NULL || *message == '\0')
522     fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
523   else
524     fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
525 }
526
527 /*
528 SUBSECTION
529         BFD error handler
530
531         Some BFD functions want to print messages describing the
532         problem.  They call a BFD error handler function.  This
533         function may be overridden by the program.
534
535         The BFD error handler acts like printf.
536
537 CODE_FRAGMENT
538 .
539 .typedef void (*bfd_error_handler_type) (const char *, ...);
540 .
541 */
542
543 /* The program name used when printing BFD error messages.  */
544
545 static const char *_bfd_error_program_name;
546
547 /* This is the default routine to handle BFD error messages.
548    Like fprintf (stderr, ...), but also handles some extra format specifiers.
549
550    %A section name from section.  For group components, print group name too.
551    %B file name from bfd.  For archive components, prints archive too.
552
553    Note - because these two extra format specifiers require special handling
554    they are scanned for and processed in this function, before calling
555    vfprintf.  This means that the *arguments* for these format specifiers
556    must be the first ones in the variable argument list, regardless of where
557    the specifiers appear in the format string.  Thus for example calling
558    this function with a format string of:
559
560       "blah %s blah %A blah %d blah %B"
561
562    would involve passing the arguments as:
563
564       "blah %s blah %A blah %d blah %B",
565         asection_for_the_%A,
566         bfd_for_the_%B,
567         string_for_the_%s,
568         integer_for_the_%d);
569  */
570
571 void
572 _bfd_default_error_handler (const char *fmt, ...)
573 {
574   va_list ap;
575   char *bufp;
576   const char *new_fmt, *p;
577   size_t avail = 1000;
578   char buf[1000];
579
580   /* PR 4992: Don't interrupt output being sent to stdout.  */
581   fflush (stdout);
582
583   if (_bfd_error_program_name != NULL)
584     fprintf (stderr, "%s: ", _bfd_error_program_name);
585   else
586     fprintf (stderr, "BFD: ");
587
588   va_start (ap, fmt);
589   new_fmt = fmt;
590   bufp = buf;
591
592   /* Reserve enough space for the existing format string.  */
593   avail -= strlen (fmt) + 1;
594   if (avail > 1000)
595     _exit (EXIT_FAILURE);
596
597   p = fmt;
598   while (1)
599     {
600       char *q;
601       size_t len, extra, trim;
602
603       p = strchr (p, '%');
604       if (p == NULL || p[1] == '\0')
605         {
606           if (new_fmt == buf)
607             {
608               len = strlen (fmt);
609               memcpy (bufp, fmt, len + 1);
610             }
611           break;
612         }
613
614       if (p[1] == 'A' || p[1] == 'B')
615         {
616           len = p - fmt;
617           memcpy (bufp, fmt, len);
618           bufp += len;
619           fmt = p + 2;
620           new_fmt = buf;
621
622           /* If we run out of space, tough, you lose your ridiculously
623              long file or section name.  It's not safe to try to alloc
624              memory here;  We might be printing an out of memory message.  */
625           if (avail == 0)
626             {
627               *bufp++ = '*';
628               *bufp++ = '*';
629               *bufp = '\0';
630             }
631           else
632             {
633               if (p[1] == 'B')
634                 {
635                   bfd *abfd = va_arg (ap, bfd *);
636
637                   if (abfd == NULL)
638                     /* Invoking %B with a null bfd pointer is an internal error.  */
639                     abort ();
640                   else if (abfd->my_archive)
641                     snprintf (bufp, avail, "%s(%s)",
642                               abfd->my_archive->filename, abfd->filename);
643                   else
644                     snprintf (bufp, avail, "%s", abfd->filename);
645                 }
646               else
647                 {
648                   asection *sec = va_arg (ap, asection *);
649                   bfd *abfd;
650                   const char *group = NULL;
651                   struct coff_comdat_info *ci;
652
653                   if (sec == NULL)
654                     /* Invoking %A with a null section pointer is an internal error.  */
655                     abort ();
656                   abfd = sec->owner;
657                   if (abfd != NULL
658                       && bfd_get_flavour (abfd) == bfd_target_elf_flavour
659                       && elf_next_in_group (sec) != NULL
660                       && (sec->flags & SEC_GROUP) == 0)
661                     group = elf_group_name (sec);
662                   else if (abfd != NULL
663                            && bfd_get_flavour (abfd) == bfd_target_coff_flavour
664                            && (ci = bfd_coff_get_comdat_section (sec->owner,
665                                                                  sec)) != NULL)
666                     group = ci->name;
667                   if (group != NULL)
668                     snprintf (bufp, avail, "%s[%s]", sec->name, group);
669                   else
670                     snprintf (bufp, avail, "%s", sec->name);
671                 }
672               len = strlen (bufp);
673               avail = avail - len + 2;
674
675               /* We need to replace any '%' we printed by "%%".
676                  First count how many.  */
677               q = bufp;
678               bufp += len;
679               extra = 0;
680               while ((q = strchr (q, '%')) != NULL)
681                 {
682                   ++q;
683                   ++extra;
684                 }
685
686               /* If there isn't room, trim off the end of the string.  */
687               q = bufp;
688               bufp += extra;
689               if (extra > avail)
690                 {
691                   trim = extra - avail;
692                   bufp -= trim;
693                   do
694                     {
695                       if (*--q == '%')
696                         --extra;
697                     }
698                   while (--trim != 0);
699                   *q = '\0';
700                   avail = extra;
701                 }
702               avail -= extra;
703
704               /* Now double all '%' chars, shuffling the string as we go.  */
705               while (extra != 0)
706                 {
707                   while ((q[extra] = *q) != '%')
708                     --q;
709                   q[--extra] = '%';
710                   --q;
711                 }
712             }
713         }
714       p = p + 2;
715     }
716
717   vfprintf (stderr, new_fmt, ap);
718   va_end (ap);
719
720   putc ('\n', stderr);
721 }
722
723 /* This is a function pointer to the routine which should handle BFD
724    error messages.  It is called when a BFD routine encounters an
725    error for which it wants to print a message.  Going through a
726    function pointer permits a program linked against BFD to intercept
727    the messages and deal with them itself.  */
728
729 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
730
731 /*
732 FUNCTION
733         bfd_set_error_handler
734
735 SYNOPSIS
736         bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
737
738 DESCRIPTION
739         Set the BFD error handler function.  Returns the previous
740         function.
741 */
742
743 bfd_error_handler_type
744 bfd_set_error_handler (bfd_error_handler_type pnew)
745 {
746   bfd_error_handler_type pold;
747
748   pold = _bfd_error_handler;
749   _bfd_error_handler = pnew;
750   return pold;
751 }
752
753 /*
754 FUNCTION
755         bfd_set_error_program_name
756
757 SYNOPSIS
758         void bfd_set_error_program_name (const char *);
759
760 DESCRIPTION
761         Set the program name to use when printing a BFD error.  This
762         is printed before the error message followed by a colon and
763         space.  The string must not be changed after it is passed to
764         this function.
765 */
766
767 void
768 bfd_set_error_program_name (const char *name)
769 {
770   _bfd_error_program_name = name;
771 }
772
773 /*
774 FUNCTION
775         bfd_get_error_handler
776
777 SYNOPSIS
778         bfd_error_handler_type bfd_get_error_handler (void);
779
780 DESCRIPTION
781         Return the BFD error handler function.
782 */
783
784 bfd_error_handler_type
785 bfd_get_error_handler (void)
786 {
787   return _bfd_error_handler;
788 }
789 \f
790 /*
791 SECTION
792         Miscellaneous
793
794 SUBSECTION
795         Miscellaneous functions
796 */
797
798 /*
799 FUNCTION
800         bfd_get_reloc_upper_bound
801
802 SYNOPSIS
803         long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
804
805 DESCRIPTION
806         Return the number of bytes required to store the
807         relocation information associated with section @var{sect}
808         attached to bfd @var{abfd}.  If an error occurs, return -1.
809
810 */
811
812 long
813 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
814 {
815   if (abfd->format != bfd_object)
816     {
817       bfd_set_error (bfd_error_invalid_operation);
818       return -1;
819     }
820
821   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
822 }
823
824 /*
825 FUNCTION
826         bfd_canonicalize_reloc
827
828 SYNOPSIS
829         long bfd_canonicalize_reloc
830           (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
831
832 DESCRIPTION
833         Call the back end associated with the open BFD
834         @var{abfd} and translate the external form of the relocation
835         information attached to @var{sec} into the internal canonical
836         form.  Place the table into memory at @var{loc}, which has
837         been preallocated, usually by a call to
838         <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
839         -1 on error.
840
841         The @var{syms} table is also needed for horrible internal magic
842         reasons.
843
844 */
845 long
846 bfd_canonicalize_reloc (bfd *abfd,
847                         sec_ptr asect,
848                         arelent **location,
849                         asymbol **symbols)
850 {
851   if (abfd->format != bfd_object)
852     {
853       bfd_set_error (bfd_error_invalid_operation);
854       return -1;
855     }
856
857   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
858                    (abfd, asect, location, symbols));
859 }
860
861 /*
862 FUNCTION
863         bfd_set_reloc
864
865 SYNOPSIS
866         void bfd_set_reloc
867           (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
868
869 DESCRIPTION
870         Set the relocation pointer and count within
871         section @var{sec} to the values @var{rel} and @var{count}.
872         The argument @var{abfd} is ignored.
873
874 */
875
876 void
877 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
878                sec_ptr asect,
879                arelent **location,
880                unsigned int count)
881 {
882   asect->orelocation = location;
883   asect->reloc_count = count;
884 }
885
886 /*
887 FUNCTION
888         bfd_set_file_flags
889
890 SYNOPSIS
891         bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
892
893 DESCRIPTION
894         Set the flag word in the BFD @var{abfd} to the value @var{flags}.
895
896         Possible errors are:
897         o <<bfd_error_wrong_format>> - The target bfd was not of object format.
898         o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
899         o <<bfd_error_invalid_operation>> -
900         The flag word contained a bit which was not applicable to the
901         type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
902         on a BFD format which does not support demand paging.
903
904 */
905
906 bfd_boolean
907 bfd_set_file_flags (bfd *abfd, flagword flags)
908 {
909   if (abfd->format != bfd_object)
910     {
911       bfd_set_error (bfd_error_wrong_format);
912       return FALSE;
913     }
914
915   if (bfd_read_p (abfd))
916     {
917       bfd_set_error (bfd_error_invalid_operation);
918       return FALSE;
919     }
920
921   bfd_get_file_flags (abfd) = flags;
922   if ((flags & bfd_applicable_file_flags (abfd)) != flags)
923     {
924       bfd_set_error (bfd_error_invalid_operation);
925       return FALSE;
926     }
927
928   return TRUE;
929 }
930
931 void
932 bfd_assert (const char *file, int line)
933 {
934   (*_bfd_error_handler) (_("BFD %s assertion fail %s:%d"),
935                          BFD_VERSION_STRING, file, line);
936 }
937
938 /* A more or less friendly abort message.  In libbfd.h abort is
939    defined to call this function.  */
940
941 void
942 _bfd_abort (const char *file, int line, const char *fn)
943 {
944   if (fn != NULL)
945     (*_bfd_error_handler)
946       (_("BFD %s internal error, aborting at %s line %d in %s\n"),
947        BFD_VERSION_STRING, file, line, fn);
948   else
949     (*_bfd_error_handler)
950       (_("BFD %s internal error, aborting at %s line %d\n"),
951        BFD_VERSION_STRING, file, line);
952   (*_bfd_error_handler) (_("Please report this bug.\n"));
953   _exit (EXIT_FAILURE);
954 }
955
956 /*
957 FUNCTION
958         bfd_get_arch_size
959
960 SYNOPSIS
961         int bfd_get_arch_size (bfd *abfd);
962
963 DESCRIPTION
964         Returns the architecture address size, in bits, as determined
965         by the object file's format.  For ELF, this information is
966         included in the header.
967
968 RETURNS
969         Returns the arch size in bits if known, <<-1>> otherwise.
970 */
971
972 int
973 bfd_get_arch_size (bfd *abfd)
974 {
975   if (abfd->xvec->flavour == bfd_target_elf_flavour)
976     return get_elf_backend_data (abfd)->s->arch_size;
977
978   return -1;
979 }
980
981 /*
982 FUNCTION
983         bfd_get_sign_extend_vma
984
985 SYNOPSIS
986         int bfd_get_sign_extend_vma (bfd *abfd);
987
988 DESCRIPTION
989         Indicates if the target architecture "naturally" sign extends
990         an address.  Some architectures implicitly sign extend address
991         values when they are converted to types larger than the size
992         of an address.  For instance, bfd_get_start_address() will
993         return an address sign extended to fill a bfd_vma when this is
994         the case.
995
996 RETURNS
997         Returns <<1>> if the target architecture is known to sign
998         extend addresses, <<0>> if the target architecture is known to
999         not sign extend addresses, and <<-1>> otherwise.
1000 */
1001
1002 int
1003 bfd_get_sign_extend_vma (bfd *abfd)
1004 {
1005   char *name;
1006
1007   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1008     return get_elf_backend_data (abfd)->sign_extend_vma;
1009
1010   name = bfd_get_target (abfd);
1011
1012   /* Return a proper value for DJGPP & PE COFF.
1013      This function is required for DWARF2 support, but there is
1014      no place to store this information in the COFF back end.
1015      Should enough other COFF targets add support for DWARF2,
1016      a place will have to be found.  Until then, this hack will do.  */
1017   if (CONST_STRNEQ (name, "coff-go32")
1018       || strcmp (name, "pe-i386") == 0
1019       || strcmp (name, "pei-i386") == 0
1020       || strcmp (name, "pe-x86-64") == 0
1021       || strcmp (name, "pei-x86-64") == 0
1022       || strcmp (name, "pe-arm-wince-little") == 0
1023       || strcmp (name, "pei-arm-wince-little") == 0)
1024     return 1;
1025
1026   if (CONST_STRNEQ (name, "mach-o"))
1027     return 0;
1028
1029   bfd_set_error (bfd_error_wrong_format);
1030   return -1;
1031 }
1032
1033 /*
1034 FUNCTION
1035         bfd_set_start_address
1036
1037 SYNOPSIS
1038         bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1039
1040 DESCRIPTION
1041         Make @var{vma} the entry point of output BFD @var{abfd}.
1042
1043 RETURNS
1044         Returns <<TRUE>> on success, <<FALSE>> otherwise.
1045 */
1046
1047 bfd_boolean
1048 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1049 {
1050   abfd->start_address = vma;
1051   return TRUE;
1052 }
1053
1054 /*
1055 FUNCTION
1056         bfd_get_gp_size
1057
1058 SYNOPSIS
1059         unsigned int bfd_get_gp_size (bfd *abfd);
1060
1061 DESCRIPTION
1062         Return the maximum size of objects to be optimized using the GP
1063         register under MIPS ECOFF.  This is typically set by the <<-G>>
1064         argument to the compiler, assembler or linker.
1065 */
1066
1067 unsigned int
1068 bfd_get_gp_size (bfd *abfd)
1069 {
1070   if (abfd->format == bfd_object)
1071     {
1072       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1073         return ecoff_data (abfd)->gp_size;
1074       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1075         return elf_gp_size (abfd);
1076     }
1077   return 0;
1078 }
1079
1080 /*
1081 FUNCTION
1082         bfd_set_gp_size
1083
1084 SYNOPSIS
1085         void bfd_set_gp_size (bfd *abfd, unsigned int i);
1086
1087 DESCRIPTION
1088         Set the maximum size of objects to be optimized using the GP
1089         register under ECOFF or MIPS ELF.  This is typically set by
1090         the <<-G>> argument to the compiler, assembler or linker.
1091 */
1092
1093 void
1094 bfd_set_gp_size (bfd *abfd, unsigned int i)
1095 {
1096   /* Don't try to set GP size on an archive or core file!  */
1097   if (abfd->format != bfd_object)
1098     return;
1099
1100   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1101     ecoff_data (abfd)->gp_size = i;
1102   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1103     elf_gp_size (abfd) = i;
1104 }
1105
1106 /* Get the GP value.  This is an internal function used by some of the
1107    relocation special_function routines on targets which support a GP
1108    register.  */
1109
1110 bfd_vma
1111 _bfd_get_gp_value (bfd *abfd)
1112 {
1113   if (! abfd)
1114     return 0;
1115   if (abfd->format != bfd_object)
1116     return 0;
1117
1118   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1119     return ecoff_data (abfd)->gp;
1120   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1121     return elf_gp (abfd);
1122
1123   return 0;
1124 }
1125
1126 /* Set the GP value.  */
1127
1128 void
1129 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1130 {
1131   if (! abfd)
1132     abort ();
1133   if (abfd->format != bfd_object)
1134     return;
1135
1136   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1137     ecoff_data (abfd)->gp = v;
1138   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1139     elf_gp (abfd) = v;
1140 }
1141
1142 /*
1143 FUNCTION
1144         bfd_scan_vma
1145
1146 SYNOPSIS
1147         bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1148
1149 DESCRIPTION
1150         Convert, like <<strtoul>>, a numerical expression
1151         @var{string} into a <<bfd_vma>> integer, and return that integer.
1152         (Though without as many bells and whistles as <<strtoul>>.)
1153         The expression is assumed to be unsigned (i.e., positive).
1154         If given a @var{base}, it is used as the base for conversion.
1155         A base of 0 causes the function to interpret the string
1156         in hex if a leading "0x" or "0X" is found, otherwise
1157         in octal if a leading zero is found, otherwise in decimal.
1158
1159         If the value would overflow, the maximum <<bfd_vma>> value is
1160         returned.
1161 */
1162
1163 bfd_vma
1164 bfd_scan_vma (const char *string, const char **end, int base)
1165 {
1166   bfd_vma value;
1167   bfd_vma cutoff;
1168   unsigned int cutlim;
1169   int overflow;
1170
1171   /* Let the host do it if possible.  */
1172   if (sizeof (bfd_vma) <= sizeof (unsigned long))
1173     return strtoul (string, (char **) end, base);
1174
1175 #ifdef HAVE_STRTOULL
1176   if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1177     return strtoull (string, (char **) end, base);
1178 #endif
1179
1180   if (base == 0)
1181     {
1182       if (string[0] == '0')
1183         {
1184           if ((string[1] == 'x') || (string[1] == 'X'))
1185             base = 16;
1186           else
1187             base = 8;
1188         }
1189     }
1190
1191   if ((base < 2) || (base > 36))
1192     base = 10;
1193
1194   if (base == 16
1195       && string[0] == '0'
1196       && (string[1] == 'x' || string[1] == 'X')
1197       && ISXDIGIT (string[2]))
1198     {
1199       string += 2;
1200     }
1201
1202   cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1203   cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1204   value = 0;
1205   overflow = 0;
1206   while (1)
1207     {
1208       unsigned int digit;
1209
1210       digit = *string;
1211       if (ISDIGIT (digit))
1212         digit = digit - '0';
1213       else if (ISALPHA (digit))
1214         digit = TOUPPER (digit) - 'A' + 10;
1215       else
1216         break;
1217       if (digit >= (unsigned int) base)
1218         break;
1219       if (value > cutoff || (value == cutoff && digit > cutlim))
1220         overflow = 1;
1221       value = value * base + digit;
1222       ++string;
1223     }
1224
1225   if (overflow)
1226     value = ~ (bfd_vma) 0;
1227
1228   if (end != NULL)
1229     *end = string;
1230
1231   return value;
1232 }
1233
1234 /*
1235 FUNCTION
1236         bfd_copy_private_header_data
1237
1238 SYNOPSIS
1239         bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1240
1241 DESCRIPTION
1242         Copy private BFD header information from the BFD @var{ibfd} to the
1243         the BFD @var{obfd}.  This copies information that may require
1244         sections to exist, but does not require symbol tables.  Return
1245         <<true>> on success, <<false>> on error.
1246         Possible error returns are:
1247
1248         o <<bfd_error_no_memory>> -
1249         Not enough memory exists to create private data for @var{obfd}.
1250
1251 .#define bfd_copy_private_header_data(ibfd, obfd) \
1252 .     BFD_SEND (obfd, _bfd_copy_private_header_data, \
1253 .               (ibfd, obfd))
1254
1255 */
1256
1257 /*
1258 FUNCTION
1259         bfd_copy_private_bfd_data
1260
1261 SYNOPSIS
1262         bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1263
1264 DESCRIPTION
1265         Copy private BFD information from the BFD @var{ibfd} to the
1266         the BFD @var{obfd}.  Return <<TRUE>> on success, <<FALSE>> on error.
1267         Possible error returns are:
1268
1269         o <<bfd_error_no_memory>> -
1270         Not enough memory exists to create private data for @var{obfd}.
1271
1272 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1273 .     BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1274 .               (ibfd, obfd))
1275
1276 */
1277
1278 /*
1279 FUNCTION
1280         bfd_merge_private_bfd_data
1281
1282 SYNOPSIS
1283         bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1284
1285 DESCRIPTION
1286         Merge private BFD information from the BFD @var{ibfd} to the
1287         the output file BFD @var{obfd} when linking.  Return <<TRUE>>
1288         on success, <<FALSE>> on error.  Possible error returns are:
1289
1290         o <<bfd_error_no_memory>> -
1291         Not enough memory exists to create private data for @var{obfd}.
1292
1293 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1294 .     BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1295 .               (ibfd, obfd))
1296
1297 */
1298
1299 /*
1300 FUNCTION
1301         bfd_set_private_flags
1302
1303 SYNOPSIS
1304         bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1305
1306 DESCRIPTION
1307         Set private BFD flag information in the BFD @var{abfd}.
1308         Return <<TRUE>> on success, <<FALSE>> on error.  Possible error
1309         returns are:
1310
1311         o <<bfd_error_no_memory>> -
1312         Not enough memory exists to create private data for @var{obfd}.
1313
1314 .#define bfd_set_private_flags(abfd, flags) \
1315 .     BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1316
1317 */
1318
1319 /*
1320 FUNCTION
1321         Other functions
1322
1323 DESCRIPTION
1324         The following functions exist but have not yet been documented.
1325
1326 .#define bfd_sizeof_headers(abfd, info) \
1327 .       BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1328 .
1329 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1330 .       BFD_SEND (abfd, _bfd_find_nearest_line, \
1331 .                 (abfd, sec, syms, off, file, func, line))
1332 .
1333 .#define bfd_find_line(abfd, syms, sym, file, line) \
1334 .       BFD_SEND (abfd, _bfd_find_line, \
1335 .                 (abfd, syms, sym, file, line))
1336 .
1337 .#define bfd_find_inliner_info(abfd, file, func, line) \
1338 .       BFD_SEND (abfd, _bfd_find_inliner_info, \
1339 .                 (abfd, file, func, line))
1340 .
1341 .#define bfd_debug_info_start(abfd) \
1342 .       BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1343 .
1344 .#define bfd_debug_info_end(abfd) \
1345 .       BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1346 .
1347 .#define bfd_debug_info_accumulate(abfd, section) \
1348 .       BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1349 .
1350 .#define bfd_stat_arch_elt(abfd, stat) \
1351 .       BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1352 .
1353 .#define bfd_update_armap_timestamp(abfd) \
1354 .       BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1355 .
1356 .#define bfd_set_arch_mach(abfd, arch, mach)\
1357 .       BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1358 .
1359 .#define bfd_relax_section(abfd, section, link_info, again) \
1360 .       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1361 .
1362 .#define bfd_gc_sections(abfd, link_info) \
1363 .       BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1364 .
1365 .#define bfd_merge_sections(abfd, link_info) \
1366 .       BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1367 .
1368 .#define bfd_is_group_section(abfd, sec) \
1369 .       BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1370 .
1371 .#define bfd_discard_group(abfd, sec) \
1372 .       BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1373 .
1374 .#define bfd_link_hash_table_create(abfd) \
1375 .       BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1376 .
1377 .#define bfd_link_hash_table_free(abfd, hash) \
1378 .       BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1379 .
1380 .#define bfd_link_add_symbols(abfd, info) \
1381 .       BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1382 .
1383 .#define bfd_link_just_syms(abfd, sec, info) \
1384 .       BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1385 .
1386 .#define bfd_final_link(abfd, info) \
1387 .       BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1388 .
1389 .#define bfd_free_cached_info(abfd) \
1390 .       BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1391 .
1392 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1393 .       BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1394 .
1395 .#define bfd_print_private_bfd_data(abfd, file)\
1396 .       BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1397 .
1398 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1399 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1400 .
1401 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1402 .       BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1403 .                                                   dyncount, dynsyms, ret))
1404 .
1405 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1406 .       BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1407 .
1408 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1409 .       BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1410 .
1411 .extern bfd_byte *bfd_get_relocated_section_contents
1412 .  (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1413 .   bfd_boolean, asymbol **);
1414 .
1415
1416 */
1417
1418 bfd_byte *
1419 bfd_get_relocated_section_contents (bfd *abfd,
1420                                     struct bfd_link_info *link_info,
1421                                     struct bfd_link_order *link_order,
1422                                     bfd_byte *data,
1423                                     bfd_boolean relocatable,
1424                                     asymbol **symbols)
1425 {
1426   bfd *abfd2;
1427   bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1428                    bfd_byte *, bfd_boolean, asymbol **);
1429
1430   if (link_order->type == bfd_indirect_link_order)
1431     {
1432       abfd2 = link_order->u.indirect.section->owner;
1433       if (abfd2 == NULL)
1434         abfd2 = abfd;
1435     }
1436   else
1437     abfd2 = abfd;
1438
1439   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1440
1441   return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1442 }
1443
1444 /* Record information about an ELF program header.  */
1445
1446 bfd_boolean
1447 bfd_record_phdr (bfd *abfd,
1448                  unsigned long type,
1449                  bfd_boolean flags_valid,
1450                  flagword flags,
1451                  bfd_boolean at_valid,
1452                  bfd_vma at,
1453                  bfd_boolean includes_filehdr,
1454                  bfd_boolean includes_phdrs,
1455                  unsigned int count,
1456                  asection **secs)
1457 {
1458   struct elf_segment_map *m, **pm;
1459   bfd_size_type amt;
1460
1461   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1462     return TRUE;
1463
1464   amt = sizeof (struct elf_segment_map);
1465   amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1466   m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
1467   if (m == NULL)
1468     return FALSE;
1469
1470   m->p_type = type;
1471   m->p_flags = flags;
1472   m->p_paddr = at;
1473   m->p_flags_valid = flags_valid;
1474   m->p_paddr_valid = at_valid;
1475   m->includes_filehdr = includes_filehdr;
1476   m->includes_phdrs = includes_phdrs;
1477   m->count = count;
1478   if (count > 0)
1479     memcpy (m->sections, secs, count * sizeof (asection *));
1480
1481   for (pm = &elf_tdata (abfd)->segment_map; *pm != NULL; pm = &(*pm)->next)
1482     ;
1483   *pm = m;
1484
1485   return TRUE;
1486 }
1487
1488 #ifdef BFD64
1489 /* Return true iff this target is 32-bit.  */
1490
1491 static bfd_boolean
1492 is32bit (bfd *abfd)
1493 {
1494   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1495     {
1496       const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1497       return bed->s->elfclass == ELFCLASS32;
1498     }
1499
1500   /* For non-ELF targets, use architecture information.  */
1501   return bfd_arch_bits_per_address (abfd) <= 32;
1502 }
1503 #endif
1504
1505 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1506    target's address size.  */
1507
1508 void
1509 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1510 {
1511 #ifdef BFD64
1512   if (is32bit (abfd))
1513     {
1514       sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1515       return;
1516     }
1517 #endif
1518   sprintf_vma (buf, value);
1519 }
1520
1521 void
1522 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1523 {
1524 #ifdef BFD64
1525   if (is32bit (abfd))
1526     {
1527       fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1528       return;
1529     }
1530 #endif
1531   fprintf_vma ((FILE *) stream, value);
1532 }
1533
1534 /*
1535 FUNCTION
1536         bfd_alt_mach_code
1537
1538 SYNOPSIS
1539         bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1540
1541 DESCRIPTION
1542
1543         When more than one machine code number is available for the
1544         same machine type, this function can be used to switch between
1545         the preferred one (alternative == 0) and any others.  Currently,
1546         only ELF supports this feature, with up to two alternate
1547         machine codes.
1548 */
1549
1550 bfd_boolean
1551 bfd_alt_mach_code (bfd *abfd, int alternative)
1552 {
1553   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1554     {
1555       int code;
1556
1557       switch (alternative)
1558         {
1559         case 0:
1560           code = get_elf_backend_data (abfd)->elf_machine_code;
1561           break;
1562
1563         case 1:
1564           code = get_elf_backend_data (abfd)->elf_machine_alt1;
1565           if (code == 0)
1566             return FALSE;
1567           break;
1568
1569         case 2:
1570           code = get_elf_backend_data (abfd)->elf_machine_alt2;
1571           if (code == 0)
1572             return FALSE;
1573           break;
1574
1575         default:
1576           return FALSE;
1577         }
1578
1579       elf_elfheader (abfd)->e_machine = code;
1580
1581       return TRUE;
1582     }
1583
1584   return FALSE;
1585 }
1586
1587 /*
1588 CODE_FRAGMENT
1589
1590 .struct bfd_preserve
1591 .{
1592 .  void *marker;
1593 .  void *tdata;
1594 .  flagword flags;
1595 .  const struct bfd_arch_info *arch_info;
1596 .  struct bfd_section *sections;
1597 .  struct bfd_section *section_last;
1598 .  unsigned int section_count;
1599 .  struct bfd_hash_table section_htab;
1600 .};
1601 .
1602 */
1603
1604 /*
1605 FUNCTION
1606         bfd_preserve_save
1607
1608 SYNOPSIS
1609         bfd_boolean bfd_preserve_save (bfd *, struct bfd_preserve *);
1610
1611 DESCRIPTION
1612         When testing an object for compatibility with a particular
1613         target back-end, the back-end object_p function needs to set
1614         up certain fields in the bfd on successfully recognizing the
1615         object.  This typically happens in a piecemeal fashion, with
1616         failures possible at many points.  On failure, the bfd is
1617         supposed to be restored to its initial state, which is
1618         virtually impossible.  However, restoring a subset of the bfd
1619         state works in practice.  This function stores the subset and
1620         reinitializes the bfd.
1621
1622 */
1623
1624 bfd_boolean
1625 bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve)
1626 {
1627   preserve->tdata = abfd->tdata.any;
1628   preserve->arch_info = abfd->arch_info;
1629   preserve->flags = abfd->flags;
1630   preserve->sections = abfd->sections;
1631   preserve->section_last = abfd->section_last;
1632   preserve->section_count = abfd->section_count;
1633   preserve->section_htab = abfd->section_htab;
1634
1635   if (! bfd_hash_table_init (&abfd->section_htab, bfd_section_hash_newfunc,
1636                              sizeof (struct section_hash_entry)))
1637     return FALSE;
1638
1639   abfd->tdata.any = NULL;
1640   abfd->arch_info = &bfd_default_arch_struct;
1641   abfd->flags &= BFD_FLAGS_SAVED;
1642   abfd->sections = NULL;
1643   abfd->section_last = NULL;
1644   abfd->section_count = 0;
1645
1646   return TRUE;
1647 }
1648
1649 /*
1650 FUNCTION
1651         bfd_preserve_restore
1652
1653 SYNOPSIS
1654         void bfd_preserve_restore (bfd *, struct bfd_preserve *);
1655
1656 DESCRIPTION
1657         This function restores bfd state saved by bfd_preserve_save.
1658         If MARKER is non-NULL in struct bfd_preserve then that block
1659         and all subsequently bfd_alloc'd memory is freed.
1660
1661 */
1662
1663 void
1664 bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
1665 {
1666   bfd_hash_table_free (&abfd->section_htab);
1667
1668   abfd->tdata.any = preserve->tdata;
1669   abfd->arch_info = preserve->arch_info;
1670   abfd->flags = preserve->flags;
1671   abfd->section_htab = preserve->section_htab;
1672   abfd->sections = preserve->sections;
1673   abfd->section_last = preserve->section_last;
1674   abfd->section_count = preserve->section_count;
1675
1676   /* bfd_release frees all memory more recently bfd_alloc'd than
1677      its arg, as well as its arg.  */
1678   if (preserve->marker != NULL)
1679     {
1680       bfd_release (abfd, preserve->marker);
1681       preserve->marker = NULL;
1682     }
1683 }
1684
1685 /*
1686 FUNCTION
1687         bfd_preserve_finish
1688
1689 SYNOPSIS
1690         void bfd_preserve_finish (bfd *, struct bfd_preserve *);
1691
1692 DESCRIPTION
1693         This function should be called when the bfd state saved by
1694         bfd_preserve_save is no longer needed.  ie. when the back-end
1695         object_p function returns with success.
1696
1697 */
1698
1699 void
1700 bfd_preserve_finish (bfd *abfd ATTRIBUTE_UNUSED, struct bfd_preserve *preserve)
1701 {
1702   /* It would be nice to be able to free more memory here, eg. old
1703      tdata, but that's not possible since these blocks are sitting
1704      inside bfd_alloc'd memory.  The section hash is on a separate
1705      objalloc.  */
1706   bfd_hash_table_free (&preserve->section_htab);
1707 }
1708
1709 /*
1710 FUNCTION
1711         bfd_emul_get_maxpagesize
1712
1713 SYNOPSIS
1714         bfd_vma bfd_emul_get_maxpagesize (const char *);
1715
1716 DESCRIPTION
1717         Returns the maximum page size, in bytes, as determined by
1718         emulation.
1719
1720 RETURNS
1721         Returns the maximum page size in bytes for ELF, 0 otherwise.
1722 */
1723
1724 bfd_vma
1725 bfd_emul_get_maxpagesize (const char *emul)
1726 {
1727   const bfd_target *target;
1728
1729   target = bfd_find_target (emul, NULL);
1730   if (target != NULL
1731       && target->flavour == bfd_target_elf_flavour)
1732     return xvec_get_elf_backend_data (target)->maxpagesize;
1733
1734   return 0;
1735 }
1736
1737 static void
1738 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1739                       int offset, const bfd_target *orig_target)
1740 {
1741   if (target->flavour == bfd_target_elf_flavour)
1742     {
1743       const struct elf_backend_data *bed;
1744
1745       bed = xvec_get_elf_backend_data (target);
1746       *((bfd_vma *) ((char *) bed + offset)) = size;
1747     }
1748
1749   if (target->alternative_target
1750       && target->alternative_target != orig_target)
1751     bfd_elf_set_pagesize (target->alternative_target, size, offset,
1752                           orig_target);
1753 }
1754
1755 /*
1756 FUNCTION
1757         bfd_emul_set_maxpagesize
1758
1759 SYNOPSIS
1760         void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1761
1762 DESCRIPTION
1763         For ELF, set the maximum page size for the emulation.  It is
1764         a no-op for other formats.
1765
1766 */
1767
1768 void
1769 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1770 {
1771   const bfd_target *target;
1772
1773   target = bfd_find_target (emul, NULL);
1774   if (target)
1775     bfd_elf_set_pagesize (target, size,
1776                           offsetof (struct elf_backend_data,
1777                                     maxpagesize), target);
1778 }
1779
1780 /*
1781 FUNCTION
1782         bfd_emul_get_commonpagesize
1783
1784 SYNOPSIS
1785         bfd_vma bfd_emul_get_commonpagesize (const char *);
1786
1787 DESCRIPTION
1788         Returns the common page size, in bytes, as determined by
1789         emulation.
1790
1791 RETURNS
1792         Returns the common page size in bytes for ELF, 0 otherwise.
1793 */
1794
1795 bfd_vma
1796 bfd_emul_get_commonpagesize (const char *emul)
1797 {
1798   const bfd_target *target;
1799
1800   target = bfd_find_target (emul, NULL);
1801   if (target != NULL
1802       && target->flavour == bfd_target_elf_flavour)
1803     return xvec_get_elf_backend_data (target)->commonpagesize;
1804
1805   return 0;
1806 }
1807
1808 /*
1809 FUNCTION
1810         bfd_emul_set_commonpagesize
1811
1812 SYNOPSIS
1813         void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1814
1815 DESCRIPTION
1816         For ELF, set the common page size for the emulation.  It is
1817         a no-op for other formats.
1818
1819 */
1820
1821 void
1822 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1823 {
1824   const bfd_target *target;
1825
1826   target = bfd_find_target (emul, NULL);
1827   if (target)
1828     bfd_elf_set_pagesize (target, size,
1829                           offsetof (struct elf_backend_data,
1830                                     commonpagesize), target);
1831 }
1832
1833 /*
1834 FUNCTION
1835         bfd_demangle
1836
1837 SYNOPSIS
1838         char *bfd_demangle (bfd *, const char *, int);
1839
1840 DESCRIPTION
1841         Wrapper around cplus_demangle.  Strips leading underscores and
1842         other such chars that would otherwise confuse the demangler.
1843         If passed a g++ v3 ABI mangled name, returns a buffer allocated
1844         with malloc holding the demangled name.  Returns NULL otherwise
1845         and on memory alloc failure.
1846 */
1847
1848 char *
1849 bfd_demangle (bfd *abfd, const char *name, int options)
1850 {
1851   char *res, *alloc;
1852   const char *pre, *suf;
1853   size_t pre_len;
1854   bfd_boolean skip_lead;
1855
1856   skip_lead = (abfd != NULL
1857                && *name != '\0'
1858                && bfd_get_symbol_leading_char (abfd) == *name);
1859   if (skip_lead)
1860     ++name;
1861
1862   /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1863      or the MS PE format.  These formats have a number of leading '.'s
1864      on at least some symbols, so we remove all dots to avoid
1865      confusing the demangler.  */
1866   pre = name;
1867   while (*name == '.' || *name == '$')
1868     ++name;
1869   pre_len = name - pre;
1870
1871   /* Strip off @plt and suchlike too.  */
1872   alloc = NULL;
1873   suf = strchr (name, '@');
1874   if (suf != NULL)
1875     {
1876       alloc = (char *) bfd_malloc (suf - name + 1);
1877       if (alloc == NULL)
1878         return NULL;
1879       memcpy (alloc, name, suf - name);
1880       alloc[suf - name] = '\0';
1881       name = alloc;
1882     }
1883
1884   res = cplus_demangle (name, options);
1885
1886   if (alloc != NULL)
1887     free (alloc);
1888
1889   if (res == NULL)
1890     {
1891       if (skip_lead)
1892         {
1893           size_t len = strlen (pre) + 1;
1894           alloc = (char *) bfd_malloc (len);
1895           if (alloc == NULL)
1896             return NULL;
1897           memcpy (alloc, pre, len);
1898           return alloc;
1899         }
1900       return NULL;
1901     }
1902
1903   /* Put back any prefix or suffix.  */
1904   if (pre_len != 0 || suf != NULL)
1905     {
1906       size_t len;
1907       size_t suf_len;
1908       char *final;
1909
1910       len = strlen (res);
1911       if (suf == NULL)
1912         suf = res + len;
1913       suf_len = strlen (suf) + 1;
1914       final = (char *) bfd_malloc (pre_len + len + suf_len);
1915       if (final != NULL)
1916         {
1917           memcpy (final, pre, pre_len);
1918           memcpy (final + pre_len, res, len);
1919           memcpy (final + pre_len + len, suf, suf_len);
1920         }
1921       free (res);
1922       res = final;
1923     }
1924
1925   return res;
1926 }