daily update
[binutils.git] / bfd / bfd.c
blob1ffd7d05b1d54c69c47dc444f87bfaa8e63bcf4b
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
4 Free Software Foundation, Inc.
5 Written by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
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.
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.
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. */
25 SECTION
26 <<typedef bfd>>
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.
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.
36 CODE_FRAGMENT
38 .struct bfd
40 . {* A unique identifier of the BFD *}
41 . unsigned int id;
43 . {* The filename the application opened the BFD with. *}
44 . const char *filename;
46 . {* A pointer to the target jump table. *}
47 . const struct bfd_target *xvec;
49 . {* The IOSTREAM, and corresponding IO vector that provide access
50 . to the file backing the BFD. *}
51 . void *iostream;
52 . const struct bfd_iovec *iovec;
54 . {* The caching routines use these to maintain a
55 . least-recently-used list of BFDs. *}
56 . struct bfd *lru_prev, *lru_next;
58 . {* When a file is closed by the caching routines, BFD retains
59 . state information on the file here... *}
60 . ufile_ptr where;
62 . {* File modified time, if mtime_set is TRUE. *}
63 . long mtime;
65 . {* Reserved for an unimplemented file locking extension. *}
66 . int ifd;
68 . {* The format which belongs to the BFD. (object, core, etc.) *}
69 . bfd_format format;
71 . {* The direction with which the BFD was opened. *}
72 . enum bfd_direction
73 . {
74 . no_direction = 0,
75 . read_direction = 1,
76 . write_direction = 2,
77 . both_direction = 3
78 . }
79 . direction;
81 . {* Format_specific flags. *}
82 . flagword flags;
84 . {* Values that may appear in the flags field of a BFD. These also
85 . appear in the object_flags field of the bfd_target structure, where
86 . they indicate the set of flags used by that backend (not all flags
87 . are meaningful for all object file formats) (FIXME: at the moment,
88 . the object_flags values have mostly just been copied from backend
89 . to another, and are not necessarily correct). *}
91 .#define BFD_NO_FLAGS 0x00
93 . {* BFD contains relocation entries. *}
94 .#define HAS_RELOC 0x01
96 . {* BFD is directly executable. *}
97 .#define EXEC_P 0x02
99 . {* BFD has line number information (basically used for F_LNNO in a
100 . COFF header). *}
101 .#define HAS_LINENO 0x04
103 . {* BFD has debugging information. *}
104 .#define HAS_DEBUG 0x08
106 . {* BFD has symbols. *}
107 .#define HAS_SYMS 0x10
109 . {* BFD has local symbols (basically used for F_LSYMS in a COFF
110 . header). *}
111 .#define HAS_LOCALS 0x20
113 . {* BFD is a dynamic object. *}
114 .#define DYNAMIC 0x40
116 . {* Text section is write protected (if D_PAGED is not set, this is
117 . like an a.out NMAGIC file) (the linker sets this by default, but
118 . clears it for -r or -N). *}
119 .#define WP_TEXT 0x80
121 . {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
122 . linker sets this by default, but clears it for -r or -n or -N). *}
123 .#define D_PAGED 0x100
125 . {* BFD is relaxable (this means that bfd_relax_section may be able to
126 . do something) (sometimes bfd_relax_section can do something even if
127 . this is not set). *}
128 .#define BFD_IS_RELAXABLE 0x200
130 . {* This may be set before writing out a BFD to request using a
131 . traditional format. For example, this is used to request that when
132 . writing out an a.out object the symbols not be hashed to eliminate
133 . duplicates. *}
134 .#define BFD_TRADITIONAL_FORMAT 0x400
136 . {* This flag indicates that the BFD contents are actually cached
137 . in memory. If this is set, iostream points to a bfd_in_memory
138 . struct. *}
139 .#define BFD_IN_MEMORY 0x800
141 . {* The sections in this BFD specify a memory page. *}
142 .#define HAS_LOAD_PAGE 0x1000
144 . {* This BFD has been created by the linker and doesn't correspond
145 . to any input file. *}
146 .#define BFD_LINKER_CREATED 0x2000
148 . {* Currently my_archive is tested before adding origin to
149 . anything. I believe that this can become always an add of
150 . origin, with origin set to 0 for non archive files. *}
151 . ufile_ptr origin;
153 . {* The origin in the archive of the proxy entry. This will
154 . normally be the same as origin, except for thin archives,
155 . when it will contain the current offset of the proxy in the
156 . thin archive rather than the offset of the bfd in its actual
157 . container. *}
158 . ufile_ptr proxy_origin;
160 . {* A hash table for section names. *}
161 . struct bfd_hash_table section_htab;
163 . {* Pointer to linked list of sections. *}
164 . struct bfd_section *sections;
166 . {* The last section on the section list. *}
167 . struct bfd_section *section_last;
169 . {* The number of sections. *}
170 . unsigned int section_count;
172 . {* Stuff only useful for object files:
173 . The start address. *}
174 . bfd_vma start_address;
176 . {* Used for input and output. *}
177 . unsigned int symcount;
179 . {* Symbol table for output BFD (with symcount entries).
180 . Also used by the linker to cache input BFD symbols. *}
181 . struct bfd_symbol **outsymbols;
183 . {* Used for slurped dynamic symbol tables. *}
184 . unsigned int dynsymcount;
186 . {* Pointer to structure which contains architecture information. *}
187 . const struct bfd_arch_info *arch_info;
189 . {* Stuff only useful for archives. *}
190 . void *arelt_data;
191 . struct bfd *my_archive; {* The containing archive BFD. *}
192 . struct bfd *archive_next; {* The next BFD in the archive. *}
193 . struct bfd *archive_head; {* The first BFD in the archive. *}
194 . struct bfd *nested_archives; {* List of nested archive in a flattened
195 . thin archive. *}
197 . {* A chain of BFD structures involved in a link. *}
198 . struct bfd *link_next;
200 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
201 . be used only for archive elements. *}
202 . int archive_pass;
204 . {* Used by the back end to hold private data. *}
205 . union
207 . struct aout_data_struct *aout_data;
208 . struct artdata *aout_ar_data;
209 . struct _oasys_data *oasys_obj_data;
210 . struct _oasys_ar_data *oasys_ar_data;
211 . struct coff_tdata *coff_obj_data;
212 . struct pe_tdata *pe_obj_data;
213 . struct xcoff_tdata *xcoff_obj_data;
214 . struct ecoff_tdata *ecoff_obj_data;
215 . struct ieee_data_struct *ieee_data;
216 . struct ieee_ar_data_struct *ieee_ar_data;
217 . struct srec_data_struct *srec_data;
218 . struct ihex_data_struct *ihex_data;
219 . struct tekhex_data_struct *tekhex_data;
220 . struct elf_obj_tdata *elf_obj_data;
221 . struct nlm_obj_tdata *nlm_obj_data;
222 . struct bout_data_struct *bout_data;
223 . struct mmo_data_struct *mmo_data;
224 . struct sun_core_struct *sun_core_data;
225 . struct sco5_core_struct *sco5_core_data;
226 . struct trad_core_struct *trad_core_data;
227 . struct som_data_struct *som_data;
228 . struct hpux_core_struct *hpux_core_data;
229 . struct hppabsd_core_struct *hppabsd_core_data;
230 . struct sgi_core_struct *sgi_core_data;
231 . struct lynx_core_struct *lynx_core_data;
232 . struct osf_core_struct *osf_core_data;
233 . struct cisco_core_struct *cisco_core_data;
234 . struct versados_data_struct *versados_data;
235 . struct netbsd_core_struct *netbsd_core_data;
236 . struct mach_o_data_struct *mach_o_data;
237 . struct mach_o_fat_data_struct *mach_o_fat_data;
238 . struct bfd_pef_data_struct *pef_data;
239 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
240 . struct bfd_sym_data_struct *sym_data;
241 . void *any;
243 . tdata;
245 . {* Used by the application to hold private data. *}
246 . void *usrdata;
248 . {* Where all the allocated stuff under this BFD goes. This is a
249 . struct objalloc *, but we use void * to avoid requiring the inclusion
250 . of objalloc.h. *}
251 . void *memory;
253 . {* Is the file descriptor being cached? That is, can it be closed as
254 . needed, and re-opened when accessed later? *}
255 . unsigned int cacheable : 1;
257 . {* Marks whether there was a default target specified when the
258 . BFD was opened. This is used to select which matching algorithm
259 . to use to choose the back end. *}
260 . unsigned int target_defaulted : 1;
262 . {* ... and here: (``once'' means at least once). *}
263 . unsigned int opened_once : 1;
265 . {* Set if we have a locally maintained mtime value, rather than
266 . getting it from the file each time. *}
267 . unsigned int mtime_set : 1;
269 . {* Flag set if symbols from this BFD should not be exported. *}
270 . unsigned int no_export : 1;
272 . {* Remember when output has begun, to stop strange things
273 . from happening. *}
274 . unsigned int output_has_begun : 1;
276 . {* Have archive map. *}
277 . unsigned int has_armap : 1;
279 . {* Set if this is a thin archive. *}
280 . unsigned int is_thin_archive : 1;
285 #include "sysdep.h"
286 #include <stdarg.h>
287 #include "bfd.h"
288 #include "bfdver.h"
289 #include "libiberty.h"
290 #include "demangle.h"
291 #include "safe-ctype.h"
292 #include "bfdlink.h"
293 #include "libbfd.h"
294 #include "coff/internal.h"
295 #include "coff/sym.h"
296 #include "libcoff.h"
297 #include "libecoff.h"
298 #undef obj_symbols
299 #include "elf-bfd.h"
301 #ifndef EXIT_FAILURE
302 #define EXIT_FAILURE 1
303 #endif
306 /* provide storage for subsystem, stack and heap data which may have been
307 passed in on the command line. Ld puts this data into a bfd_link_info
308 struct which ultimately gets passed in to the bfd. When it arrives, copy
309 it to the following struct so that the data will be available in coffcode.h
310 where it is needed. The typedef's used are defined in bfd.h */
313 SECTION
314 Error reporting
316 Most BFD functions return nonzero on success (check their
317 individual documentation for precise semantics). On an error,
318 they call <<bfd_set_error>> to set an error condition that callers
319 can check by calling <<bfd_get_error>>.
320 If that returns <<bfd_error_system_call>>, then check
321 <<errno>>.
323 The easiest way to report a BFD error to the user is to
324 use <<bfd_perror>>.
326 SUBSECTION
327 Type <<bfd_error_type>>
329 The values returned by <<bfd_get_error>> are defined by the
330 enumerated type <<bfd_error_type>>.
332 CODE_FRAGMENT
334 .typedef enum bfd_error
336 . bfd_error_no_error = 0,
337 . bfd_error_system_call,
338 . bfd_error_invalid_target,
339 . bfd_error_wrong_format,
340 . bfd_error_wrong_object_format,
341 . bfd_error_invalid_operation,
342 . bfd_error_no_memory,
343 . bfd_error_no_symbols,
344 . bfd_error_no_armap,
345 . bfd_error_no_more_archived_files,
346 . bfd_error_malformed_archive,
347 . bfd_error_file_not_recognized,
348 . bfd_error_file_ambiguously_recognized,
349 . bfd_error_no_contents,
350 . bfd_error_nonrepresentable_section,
351 . bfd_error_no_debug_section,
352 . bfd_error_bad_value,
353 . bfd_error_file_truncated,
354 . bfd_error_file_too_big,
355 . bfd_error_on_input,
356 . bfd_error_invalid_error_code
358 .bfd_error_type;
362 static bfd_error_type bfd_error = bfd_error_no_error;
363 static bfd *input_bfd = NULL;
364 static bfd_error_type input_error = bfd_error_no_error;
366 const char *const bfd_errmsgs[] =
368 N_("No error"),
369 N_("System call error"),
370 N_("Invalid bfd target"),
371 N_("File in wrong format"),
372 N_("Archive object file in wrong format"),
373 N_("Invalid operation"),
374 N_("Memory exhausted"),
375 N_("No symbols"),
376 N_("Archive has no index; run ranlib to add one"),
377 N_("No more archived files"),
378 N_("Malformed archive"),
379 N_("File format not recognized"),
380 N_("File format is ambiguous"),
381 N_("Section has no contents"),
382 N_("Nonrepresentable section on output"),
383 N_("Symbol needs debug section which does not exist"),
384 N_("Bad value"),
385 N_("File truncated"),
386 N_("File too big"),
387 N_("Error reading %s: %s"),
388 N_("#<Invalid error code>")
392 FUNCTION
393 bfd_get_error
395 SYNOPSIS
396 bfd_error_type bfd_get_error (void);
398 DESCRIPTION
399 Return the current BFD error condition.
402 bfd_error_type
403 bfd_get_error (void)
405 return bfd_error;
409 FUNCTION
410 bfd_set_error
412 SYNOPSIS
413 void bfd_set_error (bfd_error_type error_tag, ...);
415 DESCRIPTION
416 Set the BFD error condition to be @var{error_tag}.
417 If @var{error_tag} is bfd_error_on_input, then this function
418 takes two more parameters, the input bfd where the error
419 occurred, and the bfd_error_type error.
422 void
423 bfd_set_error (bfd_error_type error_tag, ...)
425 bfd_error = error_tag;
426 if (error_tag == bfd_error_on_input)
428 /* This is an error that occurred during bfd_close when
429 writing an archive, but on one of the input files. */
430 va_list ap;
432 va_start (ap, error_tag);
433 input_bfd = va_arg (ap, bfd *);
434 input_error = va_arg (ap, int);
435 if (input_error >= bfd_error_on_input)
436 abort ();
437 va_end (ap);
442 FUNCTION
443 bfd_errmsg
445 SYNOPSIS
446 const char *bfd_errmsg (bfd_error_type error_tag);
448 DESCRIPTION
449 Return a string describing the error @var{error_tag}, or
450 the system error if @var{error_tag} is <<bfd_error_system_call>>.
453 const char *
454 bfd_errmsg (bfd_error_type error_tag)
456 #ifndef errno
457 extern int errno;
458 #endif
459 if (error_tag == bfd_error_on_input)
461 char *buf;
462 const char *msg = bfd_errmsg (input_error);
464 if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
465 != -1)
466 return buf;
468 /* Ick, what to do on out of memory? */
469 return msg;
472 if (error_tag == bfd_error_system_call)
473 return xstrerror (errno);
475 if (error_tag > bfd_error_invalid_error_code)
476 error_tag = bfd_error_invalid_error_code; /* sanity check */
478 return _(bfd_errmsgs [error_tag]);
482 FUNCTION
483 bfd_perror
485 SYNOPSIS
486 void bfd_perror (const char *message);
488 DESCRIPTION
489 Print to the standard error stream a string describing the
490 last BFD error that occurred, or the last system error if
491 the last BFD error was a system call failure. If @var{message}
492 is non-NULL and non-empty, the error string printed is preceded
493 by @var{message}, a colon, and a space. It is followed by a newline.
496 void
497 bfd_perror (const char *message)
499 if (message == NULL || *message == '\0')
500 fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
501 else
502 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
506 SUBSECTION
507 BFD error handler
509 Some BFD functions want to print messages describing the
510 problem. They call a BFD error handler function. This
511 function may be overridden by the program.
513 The BFD error handler acts like printf.
515 CODE_FRAGMENT
517 .typedef void (*bfd_error_handler_type) (const char *, ...);
521 /* The program name used when printing BFD error messages. */
523 static const char *_bfd_error_program_name;
525 /* This is the default routine to handle BFD error messages.
526 Like fprintf (stderr, ...), but also handles some extra format specifiers.
528 %A section name from section. For group components, print group name too.
529 %B file name from bfd. For archive components, prints archive too.
531 Note - because these two extra format specifiers require special handling
532 they are scanned for and processed in this function, before calling
533 vfprintf. This means that the *arguments* for these format specifiers
534 must be the first ones in the variable argument list, regardless of where
535 the specifiers appear in the format string. Thus for example calling
536 this function with a format string of:
538 "blah %s blah %A blah %d blah %B"
540 would involve passing the arguments as:
542 "blah %s blah %A blah %d blah %B",
543 asection_for_the_%A,
544 bfd_for_the_%B,
545 string_for_the_%s,
546 integer_for_the_%d);
549 void
550 _bfd_default_error_handler (const char *fmt, ...)
552 va_list ap;
553 char *bufp;
554 const char *new_fmt, *p;
555 size_t avail = 1000;
556 char buf[1000];
558 /* PR 4992: Don't interrupt output being sent to stdout. */
559 fflush (stdout);
561 if (_bfd_error_program_name != NULL)
562 fprintf (stderr, "%s: ", _bfd_error_program_name);
563 else
564 fprintf (stderr, "BFD: ");
566 va_start (ap, fmt);
567 new_fmt = fmt;
568 bufp = buf;
570 /* Reserve enough space for the existing format string. */
571 avail -= strlen (fmt) + 1;
572 if (avail > 1000)
573 _exit (EXIT_FAILURE);
575 p = fmt;
576 while (1)
578 char *q;
579 size_t len, extra, trim;
581 p = strchr (p, '%');
582 if (p == NULL || p[1] == '\0')
584 if (new_fmt == buf)
586 len = strlen (fmt);
587 memcpy (bufp, fmt, len + 1);
589 break;
592 if (p[1] == 'A' || p[1] == 'B')
594 len = p - fmt;
595 memcpy (bufp, fmt, len);
596 bufp += len;
597 fmt = p + 2;
598 new_fmt = buf;
600 /* If we run out of space, tough, you lose your ridiculously
601 long file or section name. It's not safe to try to alloc
602 memory here; We might be printing an out of memory message. */
603 if (avail == 0)
605 *bufp++ = '*';
606 *bufp++ = '*';
607 *bufp = '\0';
609 else
611 if (p[1] == 'B')
613 bfd *abfd = va_arg (ap, bfd *);
615 if (abfd == NULL)
616 /* Invoking %B with a null bfd pointer is an internal error. */
617 abort ();
618 else if (abfd->my_archive)
619 snprintf (bufp, avail, "%s(%s)",
620 abfd->my_archive->filename, abfd->filename);
621 else
622 snprintf (bufp, avail, "%s", abfd->filename);
624 else
626 asection *sec = va_arg (ap, asection *);
627 bfd *abfd;
628 const char *group = NULL;
629 struct coff_comdat_info *ci;
631 if (sec == NULL)
632 /* Invoking %A with a null section pointer is an internal error. */
633 abort ();
634 abfd = sec->owner;
635 if (abfd != NULL
636 && bfd_get_flavour (abfd) == bfd_target_elf_flavour
637 && elf_next_in_group (sec) != NULL
638 && (sec->flags & SEC_GROUP) == 0)
639 group = elf_group_name (sec);
640 else if (abfd != NULL
641 && bfd_get_flavour (abfd) == bfd_target_coff_flavour
642 && (ci = bfd_coff_get_comdat_section (sec->owner,
643 sec)) != NULL)
644 group = ci->name;
645 if (group != NULL)
646 snprintf (bufp, avail, "%s[%s]", sec->name, group);
647 else
648 snprintf (bufp, avail, "%s", sec->name);
650 len = strlen (bufp);
651 avail = avail - len + 2;
653 /* We need to replace any '%' we printed by "%%".
654 First count how many. */
655 q = bufp;
656 bufp += len;
657 extra = 0;
658 while ((q = strchr (q, '%')) != NULL)
660 ++q;
661 ++extra;
664 /* If there isn't room, trim off the end of the string. */
665 q = bufp;
666 bufp += extra;
667 if (extra > avail)
669 trim = extra - avail;
670 bufp -= trim;
673 if (*--q == '%')
674 --extra;
676 while (--trim != 0);
677 *q = '\0';
678 avail = extra;
680 avail -= extra;
682 /* Now double all '%' chars, shuffling the string as we go. */
683 while (extra != 0)
685 while ((q[extra] = *q) != '%')
686 --q;
687 q[--extra] = '%';
688 --q;
692 p = p + 2;
695 vfprintf (stderr, new_fmt, ap);
696 va_end (ap);
698 putc ('\n', stderr);
701 /* This is a function pointer to the routine which should handle BFD
702 error messages. It is called when a BFD routine encounters an
703 error for which it wants to print a message. Going through a
704 function pointer permits a program linked against BFD to intercept
705 the messages and deal with them itself. */
707 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
710 FUNCTION
711 bfd_set_error_handler
713 SYNOPSIS
714 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
716 DESCRIPTION
717 Set the BFD error handler function. Returns the previous
718 function.
721 bfd_error_handler_type
722 bfd_set_error_handler (bfd_error_handler_type pnew)
724 bfd_error_handler_type pold;
726 pold = _bfd_error_handler;
727 _bfd_error_handler = pnew;
728 return pold;
732 FUNCTION
733 bfd_set_error_program_name
735 SYNOPSIS
736 void bfd_set_error_program_name (const char *);
738 DESCRIPTION
739 Set the program name to use when printing a BFD error. This
740 is printed before the error message followed by a colon and
741 space. The string must not be changed after it is passed to
742 this function.
745 void
746 bfd_set_error_program_name (const char *name)
748 _bfd_error_program_name = name;
752 FUNCTION
753 bfd_get_error_handler
755 SYNOPSIS
756 bfd_error_handler_type bfd_get_error_handler (void);
758 DESCRIPTION
759 Return the BFD error handler function.
762 bfd_error_handler_type
763 bfd_get_error_handler (void)
765 return _bfd_error_handler;
769 SECTION
770 Miscellaneous
772 SUBSECTION
773 Miscellaneous functions
777 FUNCTION
778 bfd_get_reloc_upper_bound
780 SYNOPSIS
781 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
783 DESCRIPTION
784 Return the number of bytes required to store the
785 relocation information associated with section @var{sect}
786 attached to bfd @var{abfd}. If an error occurs, return -1.
790 long
791 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
793 if (abfd->format != bfd_object)
795 bfd_set_error (bfd_error_invalid_operation);
796 return -1;
799 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
803 FUNCTION
804 bfd_canonicalize_reloc
806 SYNOPSIS
807 long bfd_canonicalize_reloc
808 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
810 DESCRIPTION
811 Call the back end associated with the open BFD
812 @var{abfd} and translate the external form of the relocation
813 information attached to @var{sec} into the internal canonical
814 form. Place the table into memory at @var{loc}, which has
815 been preallocated, usually by a call to
816 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
817 -1 on error.
819 The @var{syms} table is also needed for horrible internal magic
820 reasons.
823 long
824 bfd_canonicalize_reloc (bfd *abfd,
825 sec_ptr asect,
826 arelent **location,
827 asymbol **symbols)
829 if (abfd->format != bfd_object)
831 bfd_set_error (bfd_error_invalid_operation);
832 return -1;
835 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
836 (abfd, asect, location, symbols));
840 FUNCTION
841 bfd_set_reloc
843 SYNOPSIS
844 void bfd_set_reloc
845 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
847 DESCRIPTION
848 Set the relocation pointer and count within
849 section @var{sec} to the values @var{rel} and @var{count}.
850 The argument @var{abfd} is ignored.
854 void
855 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
856 sec_ptr asect,
857 arelent **location,
858 unsigned int count)
860 asect->orelocation = location;
861 asect->reloc_count = count;
865 FUNCTION
866 bfd_set_file_flags
868 SYNOPSIS
869 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
871 DESCRIPTION
872 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
874 Possible errors are:
875 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
876 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
877 o <<bfd_error_invalid_operation>> -
878 The flag word contained a bit which was not applicable to the
879 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
880 on a BFD format which does not support demand paging.
884 bfd_boolean
885 bfd_set_file_flags (bfd *abfd, flagword flags)
887 if (abfd->format != bfd_object)
889 bfd_set_error (bfd_error_wrong_format);
890 return FALSE;
893 if (bfd_read_p (abfd))
895 bfd_set_error (bfd_error_invalid_operation);
896 return FALSE;
899 bfd_get_file_flags (abfd) = flags;
900 if ((flags & bfd_applicable_file_flags (abfd)) != flags)
902 bfd_set_error (bfd_error_invalid_operation);
903 return FALSE;
906 return TRUE;
909 void
910 bfd_assert (const char *file, int line)
912 (*_bfd_error_handler) (_("BFD %s assertion fail %s:%d"),
913 BFD_VERSION_STRING, file, line);
916 /* A more or less friendly abort message. In libbfd.h abort is
917 defined to call this function. */
919 void
920 _bfd_abort (const char *file, int line, const char *fn)
922 if (fn != NULL)
923 (*_bfd_error_handler)
924 (_("BFD %s internal error, aborting at %s line %d in %s\n"),
925 BFD_VERSION_STRING, file, line, fn);
926 else
927 (*_bfd_error_handler)
928 (_("BFD %s internal error, aborting at %s line %d\n"),
929 BFD_VERSION_STRING, file, line);
930 (*_bfd_error_handler) (_("Please report this bug.\n"));
931 _exit (EXIT_FAILURE);
935 FUNCTION
936 bfd_get_arch_size
938 SYNOPSIS
939 int bfd_get_arch_size (bfd *abfd);
941 DESCRIPTION
942 Returns the architecture address size, in bits, as determined
943 by the object file's format. For ELF, this information is
944 included in the header.
946 RETURNS
947 Returns the arch size in bits if known, <<-1>> otherwise.
951 bfd_get_arch_size (bfd *abfd)
953 if (abfd->xvec->flavour == bfd_target_elf_flavour)
954 return get_elf_backend_data (abfd)->s->arch_size;
956 return -1;
960 FUNCTION
961 bfd_get_sign_extend_vma
963 SYNOPSIS
964 int bfd_get_sign_extend_vma (bfd *abfd);
966 DESCRIPTION
967 Indicates if the target architecture "naturally" sign extends
968 an address. Some architectures implicitly sign extend address
969 values when they are converted to types larger than the size
970 of an address. For instance, bfd_get_start_address() will
971 return an address sign extended to fill a bfd_vma when this is
972 the case.
974 RETURNS
975 Returns <<1>> if the target architecture is known to sign
976 extend addresses, <<0>> if the target architecture is known to
977 not sign extend addresses, and <<-1>> otherwise.
981 bfd_get_sign_extend_vma (bfd *abfd)
983 char *name;
985 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
986 return get_elf_backend_data (abfd)->sign_extend_vma;
988 name = bfd_get_target (abfd);
990 /* Return a proper value for DJGPP & PE COFF.
991 This function is required for DWARF2 support, but there is
992 no place to store this information in the COFF back end.
993 Should enough other COFF targets add support for DWARF2,
994 a place will have to be found. Until then, this hack will do. */
995 if (CONST_STRNEQ (name, "coff-go32")
996 || strcmp (name, "pe-i386") == 0
997 || strcmp (name, "pei-i386") == 0
998 || strcmp (name, "pe-x86-64") == 0
999 || strcmp (name, "pei-x86-64") == 0
1000 || strcmp (name, "pe-arm-wince-little") == 0
1001 || strcmp (name, "pei-arm-wince-little") == 0)
1002 return 1;
1004 bfd_set_error (bfd_error_wrong_format);
1005 return -1;
1009 FUNCTION
1010 bfd_set_start_address
1012 SYNOPSIS
1013 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1015 DESCRIPTION
1016 Make @var{vma} the entry point of output BFD @var{abfd}.
1018 RETURNS
1019 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1022 bfd_boolean
1023 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1025 abfd->start_address = vma;
1026 return TRUE;
1030 FUNCTION
1031 bfd_get_gp_size
1033 SYNOPSIS
1034 unsigned int bfd_get_gp_size (bfd *abfd);
1036 DESCRIPTION
1037 Return the maximum size of objects to be optimized using the GP
1038 register under MIPS ECOFF. This is typically set by the <<-G>>
1039 argument to the compiler, assembler or linker.
1042 unsigned int
1043 bfd_get_gp_size (bfd *abfd)
1045 if (abfd->format == bfd_object)
1047 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1048 return ecoff_data (abfd)->gp_size;
1049 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1050 return elf_gp_size (abfd);
1052 return 0;
1056 FUNCTION
1057 bfd_set_gp_size
1059 SYNOPSIS
1060 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1062 DESCRIPTION
1063 Set the maximum size of objects to be optimized using the GP
1064 register under ECOFF or MIPS ELF. This is typically set by
1065 the <<-G>> argument to the compiler, assembler or linker.
1068 void
1069 bfd_set_gp_size (bfd *abfd, unsigned int i)
1071 /* Don't try to set GP size on an archive or core file! */
1072 if (abfd->format != bfd_object)
1073 return;
1075 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1076 ecoff_data (abfd)->gp_size = i;
1077 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1078 elf_gp_size (abfd) = i;
1081 /* Get the GP value. This is an internal function used by some of the
1082 relocation special_function routines on targets which support a GP
1083 register. */
1085 bfd_vma
1086 _bfd_get_gp_value (bfd *abfd)
1088 if (! abfd)
1089 return 0;
1090 if (abfd->format != bfd_object)
1091 return 0;
1093 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1094 return ecoff_data (abfd)->gp;
1095 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1096 return elf_gp (abfd);
1098 return 0;
1101 /* Set the GP value. */
1103 void
1104 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1106 if (! abfd)
1107 abort ();
1108 if (abfd->format != bfd_object)
1109 return;
1111 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1112 ecoff_data (abfd)->gp = v;
1113 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1114 elf_gp (abfd) = v;
1118 FUNCTION
1119 bfd_scan_vma
1121 SYNOPSIS
1122 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1124 DESCRIPTION
1125 Convert, like <<strtoul>>, a numerical expression
1126 @var{string} into a <<bfd_vma>> integer, and return that integer.
1127 (Though without as many bells and whistles as <<strtoul>>.)
1128 The expression is assumed to be unsigned (i.e., positive).
1129 If given a @var{base}, it is used as the base for conversion.
1130 A base of 0 causes the function to interpret the string
1131 in hex if a leading "0x" or "0X" is found, otherwise
1132 in octal if a leading zero is found, otherwise in decimal.
1134 If the value would overflow, the maximum <<bfd_vma>> value is
1135 returned.
1138 bfd_vma
1139 bfd_scan_vma (const char *string, const char **end, int base)
1141 bfd_vma value;
1142 bfd_vma cutoff;
1143 unsigned int cutlim;
1144 int overflow;
1146 /* Let the host do it if possible. */
1147 if (sizeof (bfd_vma) <= sizeof (unsigned long))
1148 return strtoul (string, (char **) end, base);
1150 #ifdef HAVE_STRTOULL
1151 if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1152 return strtoull (string, (char **) end, base);
1153 #endif
1155 if (base == 0)
1157 if (string[0] == '0')
1159 if ((string[1] == 'x') || (string[1] == 'X'))
1160 base = 16;
1161 else
1162 base = 8;
1166 if ((base < 2) || (base > 36))
1167 base = 10;
1169 if (base == 16
1170 && string[0] == '0'
1171 && (string[1] == 'x' || string[1] == 'X')
1172 && ISXDIGIT (string[2]))
1174 string += 2;
1177 cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1178 cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1179 value = 0;
1180 overflow = 0;
1181 while (1)
1183 unsigned int digit;
1185 digit = *string;
1186 if (ISDIGIT (digit))
1187 digit = digit - '0';
1188 else if (ISALPHA (digit))
1189 digit = TOUPPER (digit) - 'A' + 10;
1190 else
1191 break;
1192 if (digit >= (unsigned int) base)
1193 break;
1194 if (value > cutoff || (value == cutoff && digit > cutlim))
1195 overflow = 1;
1196 value = value * base + digit;
1197 ++string;
1200 if (overflow)
1201 value = ~ (bfd_vma) 0;
1203 if (end != NULL)
1204 *end = string;
1206 return value;
1210 FUNCTION
1211 bfd_copy_private_header_data
1213 SYNOPSIS
1214 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1216 DESCRIPTION
1217 Copy private BFD header information from the BFD @var{ibfd} to the
1218 the BFD @var{obfd}. This copies information that may require
1219 sections to exist, but does not require symbol tables. Return
1220 <<true>> on success, <<false>> on error.
1221 Possible error returns are:
1223 o <<bfd_error_no_memory>> -
1224 Not enough memory exists to create private data for @var{obfd}.
1226 .#define bfd_copy_private_header_data(ibfd, obfd) \
1227 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1228 . (ibfd, obfd))
1233 FUNCTION
1234 bfd_copy_private_bfd_data
1236 SYNOPSIS
1237 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1239 DESCRIPTION
1240 Copy private BFD information from the BFD @var{ibfd} to the
1241 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1242 Possible error returns are:
1244 o <<bfd_error_no_memory>> -
1245 Not enough memory exists to create private data for @var{obfd}.
1247 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1248 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1249 . (ibfd, obfd))
1254 FUNCTION
1255 bfd_merge_private_bfd_data
1257 SYNOPSIS
1258 bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1260 DESCRIPTION
1261 Merge private BFD information from the BFD @var{ibfd} to the
1262 the output file BFD @var{obfd} when linking. Return <<TRUE>>
1263 on success, <<FALSE>> on error. Possible error returns are:
1265 o <<bfd_error_no_memory>> -
1266 Not enough memory exists to create private data for @var{obfd}.
1268 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1269 . BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1270 . (ibfd, obfd))
1275 FUNCTION
1276 bfd_set_private_flags
1278 SYNOPSIS
1279 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1281 DESCRIPTION
1282 Set private BFD flag information in the BFD @var{abfd}.
1283 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1284 returns are:
1286 o <<bfd_error_no_memory>> -
1287 Not enough memory exists to create private data for @var{obfd}.
1289 .#define bfd_set_private_flags(abfd, flags) \
1290 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1295 FUNCTION
1296 Other functions
1298 DESCRIPTION
1299 The following functions exist but have not yet been documented.
1301 .#define bfd_sizeof_headers(abfd, info) \
1302 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1304 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1305 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1306 . (abfd, sec, syms, off, file, func, line))
1308 .#define bfd_find_line(abfd, syms, sym, file, line) \
1309 . BFD_SEND (abfd, _bfd_find_line, \
1310 . (abfd, syms, sym, file, line))
1312 .#define bfd_find_inliner_info(abfd, file, func, line) \
1313 . BFD_SEND (abfd, _bfd_find_inliner_info, \
1314 . (abfd, file, func, line))
1316 .#define bfd_debug_info_start(abfd) \
1317 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1319 .#define bfd_debug_info_end(abfd) \
1320 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1322 .#define bfd_debug_info_accumulate(abfd, section) \
1323 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1325 .#define bfd_stat_arch_elt(abfd, stat) \
1326 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1328 .#define bfd_update_armap_timestamp(abfd) \
1329 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1331 .#define bfd_set_arch_mach(abfd, arch, mach)\
1332 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1334 .#define bfd_relax_section(abfd, section, link_info, again) \
1335 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1337 .#define bfd_gc_sections(abfd, link_info) \
1338 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1340 .#define bfd_merge_sections(abfd, link_info) \
1341 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1343 .#define bfd_is_group_section(abfd, sec) \
1344 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1346 .#define bfd_discard_group(abfd, sec) \
1347 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1349 .#define bfd_link_hash_table_create(abfd) \
1350 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1352 .#define bfd_link_hash_table_free(abfd, hash) \
1353 . BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1355 .#define bfd_link_add_symbols(abfd, info) \
1356 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1358 .#define bfd_link_just_syms(abfd, sec, info) \
1359 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1361 .#define bfd_final_link(abfd, info) \
1362 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1364 .#define bfd_free_cached_info(abfd) \
1365 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1367 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1368 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1370 .#define bfd_print_private_bfd_data(abfd, file)\
1371 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1373 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1374 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1376 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1377 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1378 . dyncount, dynsyms, ret))
1380 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1381 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1383 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1384 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1386 .extern bfd_byte *bfd_get_relocated_section_contents
1387 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1388 . bfd_boolean, asymbol **);
1393 bfd_byte *
1394 bfd_get_relocated_section_contents (bfd *abfd,
1395 struct bfd_link_info *link_info,
1396 struct bfd_link_order *link_order,
1397 bfd_byte *data,
1398 bfd_boolean relocatable,
1399 asymbol **symbols)
1401 bfd *abfd2;
1402 bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1403 bfd_byte *, bfd_boolean, asymbol **);
1405 if (link_order->type == bfd_indirect_link_order)
1407 abfd2 = link_order->u.indirect.section->owner;
1408 if (abfd2 == NULL)
1409 abfd2 = abfd;
1411 else
1412 abfd2 = abfd;
1414 fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1416 return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1419 /* Record information about an ELF program header. */
1421 bfd_boolean
1422 bfd_record_phdr (bfd *abfd,
1423 unsigned long type,
1424 bfd_boolean flags_valid,
1425 flagword flags,
1426 bfd_boolean at_valid,
1427 bfd_vma at,
1428 bfd_boolean includes_filehdr,
1429 bfd_boolean includes_phdrs,
1430 unsigned int count,
1431 asection **secs)
1433 struct elf_segment_map *m, **pm;
1434 bfd_size_type amt;
1436 if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1437 return TRUE;
1439 amt = sizeof (struct elf_segment_map);
1440 amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1441 m = bfd_zalloc (abfd, amt);
1442 if (m == NULL)
1443 return FALSE;
1445 m->p_type = type;
1446 m->p_flags = flags;
1447 m->p_paddr = at;
1448 m->p_flags_valid = flags_valid;
1449 m->p_paddr_valid = at_valid;
1450 m->includes_filehdr = includes_filehdr;
1451 m->includes_phdrs = includes_phdrs;
1452 m->count = count;
1453 if (count > 0)
1454 memcpy (m->sections, secs, count * sizeof (asection *));
1456 for (pm = &elf_tdata (abfd)->segment_map; *pm != NULL; pm = &(*pm)->next)
1458 *pm = m;
1460 return TRUE;
1463 #ifdef BFD64
1464 /* Return true iff this target is 32-bit. */
1466 static bfd_boolean
1467 is32bit (bfd *abfd)
1469 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1471 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1472 return bed->s->elfclass == ELFCLASS32;
1475 /* For non-ELF, make a guess based on the target name. */
1476 return (strstr (bfd_get_target (abfd), "64") == NULL
1477 && strcmp (bfd_get_target (abfd), "mmo") != 0);
1479 #endif
1481 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1482 target's address size. */
1484 void
1485 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1487 #ifdef BFD64
1488 if (is32bit (abfd))
1490 sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1491 return;
1493 #endif
1494 sprintf_vma (buf, value);
1497 void
1498 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1500 #ifdef BFD64
1501 if (is32bit (abfd))
1503 fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1504 return;
1506 #endif
1507 fprintf_vma ((FILE *) stream, value);
1511 FUNCTION
1512 bfd_alt_mach_code
1514 SYNOPSIS
1515 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1517 DESCRIPTION
1519 When more than one machine code number is available for the
1520 same machine type, this function can be used to switch between
1521 the preferred one (alternative == 0) and any others. Currently,
1522 only ELF supports this feature, with up to two alternate
1523 machine codes.
1526 bfd_boolean
1527 bfd_alt_mach_code (bfd *abfd, int alternative)
1529 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1531 int code;
1533 switch (alternative)
1535 case 0:
1536 code = get_elf_backend_data (abfd)->elf_machine_code;
1537 break;
1539 case 1:
1540 code = get_elf_backend_data (abfd)->elf_machine_alt1;
1541 if (code == 0)
1542 return FALSE;
1543 break;
1545 case 2:
1546 code = get_elf_backend_data (abfd)->elf_machine_alt2;
1547 if (code == 0)
1548 return FALSE;
1549 break;
1551 default:
1552 return FALSE;
1555 elf_elfheader (abfd)->e_machine = code;
1557 return TRUE;
1560 return FALSE;
1564 CODE_FRAGMENT
1566 .struct bfd_preserve
1568 . void *marker;
1569 . void *tdata;
1570 . flagword flags;
1571 . const struct bfd_arch_info *arch_info;
1572 . struct bfd_section *sections;
1573 . struct bfd_section *section_last;
1574 . unsigned int section_count;
1575 . struct bfd_hash_table section_htab;
1581 FUNCTION
1582 bfd_preserve_save
1584 SYNOPSIS
1585 bfd_boolean bfd_preserve_save (bfd *, struct bfd_preserve *);
1587 DESCRIPTION
1588 When testing an object for compatibility with a particular
1589 target back-end, the back-end object_p function needs to set
1590 up certain fields in the bfd on successfully recognizing the
1591 object. This typically happens in a piecemeal fashion, with
1592 failures possible at many points. On failure, the bfd is
1593 supposed to be restored to its initial state, which is
1594 virtually impossible. However, restoring a subset of the bfd
1595 state works in practice. This function stores the subset and
1596 reinitializes the bfd.
1600 bfd_boolean
1601 bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve)
1603 preserve->tdata = abfd->tdata.any;
1604 preserve->arch_info = abfd->arch_info;
1605 preserve->flags = abfd->flags;
1606 preserve->sections = abfd->sections;
1607 preserve->section_last = abfd->section_last;
1608 preserve->section_count = abfd->section_count;
1609 preserve->section_htab = abfd->section_htab;
1611 if (! bfd_hash_table_init (&abfd->section_htab, bfd_section_hash_newfunc,
1612 sizeof (struct section_hash_entry)))
1613 return FALSE;
1615 abfd->tdata.any = NULL;
1616 abfd->arch_info = &bfd_default_arch_struct;
1617 abfd->flags &= BFD_IN_MEMORY;
1618 abfd->sections = NULL;
1619 abfd->section_last = NULL;
1620 abfd->section_count = 0;
1622 return TRUE;
1626 FUNCTION
1627 bfd_preserve_restore
1629 SYNOPSIS
1630 void bfd_preserve_restore (bfd *, struct bfd_preserve *);
1632 DESCRIPTION
1633 This function restores bfd state saved by bfd_preserve_save.
1634 If MARKER is non-NULL in struct bfd_preserve then that block
1635 and all subsequently bfd_alloc'd memory is freed.
1639 void
1640 bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
1642 bfd_hash_table_free (&abfd->section_htab);
1644 abfd->tdata.any = preserve->tdata;
1645 abfd->arch_info = preserve->arch_info;
1646 abfd->flags = preserve->flags;
1647 abfd->section_htab = preserve->section_htab;
1648 abfd->sections = preserve->sections;
1649 abfd->section_last = preserve->section_last;
1650 abfd->section_count = preserve->section_count;
1652 /* bfd_release frees all memory more recently bfd_alloc'd than
1653 its arg, as well as its arg. */
1654 if (preserve->marker != NULL)
1656 bfd_release (abfd, preserve->marker);
1657 preserve->marker = NULL;
1662 FUNCTION
1663 bfd_preserve_finish
1665 SYNOPSIS
1666 void bfd_preserve_finish (bfd *, struct bfd_preserve *);
1668 DESCRIPTION
1669 This function should be called when the bfd state saved by
1670 bfd_preserve_save is no longer needed. ie. when the back-end
1671 object_p function returns with success.
1675 void
1676 bfd_preserve_finish (bfd *abfd ATTRIBUTE_UNUSED, struct bfd_preserve *preserve)
1678 /* It would be nice to be able to free more memory here, eg. old
1679 tdata, but that's not possible since these blocks are sitting
1680 inside bfd_alloc'd memory. The section hash is on a separate
1681 objalloc. */
1682 bfd_hash_table_free (&preserve->section_htab);
1686 FUNCTION
1687 bfd_emul_get_maxpagesize
1689 SYNOPSIS
1690 bfd_vma bfd_emul_get_maxpagesize (const char *);
1692 DESCRIPTION
1693 Returns the maximum page size, in bytes, as determined by
1694 emulation.
1696 RETURNS
1697 Returns the maximum page size in bytes for ELF, abort
1698 otherwise.
1701 bfd_vma
1702 bfd_emul_get_maxpagesize (const char *emul)
1704 const bfd_target *target;
1706 target = bfd_find_target (emul, NULL);
1707 if (target != NULL
1708 && target->flavour == bfd_target_elf_flavour)
1709 return xvec_get_elf_backend_data (target)->maxpagesize;
1711 abort ();
1712 return 0;
1715 static void
1716 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1717 int offset, const bfd_target *orig_target)
1719 if (target->flavour == bfd_target_elf_flavour)
1721 const struct elf_backend_data *bed;
1723 bed = xvec_get_elf_backend_data (target);
1724 *((bfd_vma *) ((char *) bed + offset)) = size;
1727 if (target->alternative_target
1728 && target->alternative_target != orig_target)
1729 bfd_elf_set_pagesize (target->alternative_target, size, offset,
1730 orig_target);
1734 FUNCTION
1735 bfd_emul_set_maxpagesize
1737 SYNOPSIS
1738 void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1740 DESCRIPTION
1741 For ELF, set the maximum page size for the emulation. It is
1742 a no-op for other formats.
1746 void
1747 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1749 const bfd_target *target;
1751 target = bfd_find_target (emul, NULL);
1752 if (target)
1753 bfd_elf_set_pagesize (target, size,
1754 offsetof (struct elf_backend_data,
1755 maxpagesize), target);
1759 FUNCTION
1760 bfd_emul_get_commonpagesize
1762 SYNOPSIS
1763 bfd_vma bfd_emul_get_commonpagesize (const char *);
1765 DESCRIPTION
1766 Returns the common page size, in bytes, as determined by
1767 emulation.
1769 RETURNS
1770 Returns the common page size in bytes for ELF, abort otherwise.
1773 bfd_vma
1774 bfd_emul_get_commonpagesize (const char *emul)
1776 const bfd_target *target;
1778 target = bfd_find_target (emul, NULL);
1779 if (target != NULL
1780 && target->flavour == bfd_target_elf_flavour)
1781 return xvec_get_elf_backend_data (target)->commonpagesize;
1783 abort ();
1784 return 0;
1788 FUNCTION
1789 bfd_emul_set_commonpagesize
1791 SYNOPSIS
1792 void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1794 DESCRIPTION
1795 For ELF, set the common page size for the emulation. It is
1796 a no-op for other formats.
1800 void
1801 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1803 const bfd_target *target;
1805 target = bfd_find_target (emul, NULL);
1806 if (target)
1807 bfd_elf_set_pagesize (target, size,
1808 offsetof (struct elf_backend_data,
1809 commonpagesize), target);
1813 FUNCTION
1814 bfd_demangle
1816 SYNOPSIS
1817 char *bfd_demangle (bfd *, const char *, int);
1819 DESCRIPTION
1820 Wrapper around cplus_demangle. Strips leading underscores and
1821 other such chars that would otherwise confuse the demangler.
1822 If passed a g++ v3 ABI mangled name, returns a buffer allocated
1823 with malloc holding the demangled name. Returns NULL otherwise
1824 and on memory alloc failure.
1827 char *
1828 bfd_demangle (bfd *abfd, const char *name, int options)
1830 char *res, *alloc;
1831 const char *pre, *suf;
1832 size_t pre_len;
1833 bfd_boolean skip_lead;
1835 skip_lead = (abfd != NULL
1836 && *name != '\0'
1837 && bfd_get_symbol_leading_char (abfd) == *name);
1838 if (skip_lead)
1839 ++name;
1841 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1842 or the MS PE format. These formats have a number of leading '.'s
1843 on at least some symbols, so we remove all dots to avoid
1844 confusing the demangler. */
1845 pre = name;
1846 while (*name == '.' || *name == '$')
1847 ++name;
1848 pre_len = name - pre;
1850 /* Strip off @plt and suchlike too. */
1851 alloc = NULL;
1852 suf = strchr (name, '@');
1853 if (suf != NULL)
1855 alloc = bfd_malloc (suf - name + 1);
1856 if (alloc == NULL)
1857 return NULL;
1858 memcpy (alloc, name, suf - name);
1859 alloc[suf - name] = '\0';
1860 name = alloc;
1863 res = cplus_demangle (name, options);
1865 if (alloc != NULL)
1866 free (alloc);
1868 if (res == NULL)
1870 if (skip_lead)
1872 size_t len = strlen (pre) + 1;
1873 alloc = bfd_malloc (len);
1874 if (alloc == NULL)
1875 return NULL;
1876 memcpy (alloc, pre, len);
1877 return alloc;
1879 return NULL;
1882 /* Put back any prefix or suffix. */
1883 if (pre_len != 0 || suf != NULL)
1885 size_t len;
1886 size_t suf_len;
1887 char *final;
1889 len = strlen (res);
1890 if (suf == NULL)
1891 suf = res + len;
1892 suf_len = strlen (suf) + 1;
1893 final = bfd_malloc (pre_len + len + suf_len);
1894 if (final != NULL)
1896 memcpy (final, pre, pre_len);
1897 memcpy (final + pre_len, res, len);
1898 memcpy (final + pre_len + len, suf, suf_len);
1900 free (res);
1901 res = final;
1904 return res;