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