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