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