1 /* opncls.c -- open and close a BFD.
2 Copyright (C) 1990-2023 Free Software Foundation, Inc.
4 Written by Cygnus Support.
6 This file is part of BFD, the Binary File Descriptor library.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 MA 02110-1301, USA. */
27 #include "libiberty.h"
31 #define S_IXUSR 0100 /* Execute by owner. */
34 #define S_IXGRP 0010 /* Execute by group. */
37 #define S_IXOTH 0001 /* Execute by others. */
40 /* Counters used to initialize the bfd identifier. */
42 static unsigned int bfd_id_counter
= 0;
43 static unsigned int bfd_reserved_id_counter
= 0;
47 .{* Set to N to open the next N BFDs using an alternate id space. *}
48 .extern unsigned int bfd_use_reserved_id;
50 unsigned int bfd_use_reserved_id
= 0;
52 /* fdopen is a loser -- we should use stdio exclusively. Unfortunately
53 if we do that we can't use fcntl. */
55 /* Return a new BFD. All BFD's are allocated through this routine. */
62 nbfd
= (bfd
*) bfd_zmalloc (sizeof (bfd
));
66 if (bfd_use_reserved_id
)
68 nbfd
->id
= --bfd_reserved_id_counter
;
69 --bfd_use_reserved_id
;
72 nbfd
->id
= bfd_id_counter
++;
74 nbfd
->memory
= objalloc_create ();
75 if (nbfd
->memory
== NULL
)
77 bfd_set_error (bfd_error_no_memory
);
82 nbfd
->arch_info
= &bfd_default_arch_struct
;
84 if (!bfd_hash_table_init_n (& nbfd
->section_htab
, bfd_section_hash_newfunc
,
85 sizeof (struct section_hash_entry
), 13))
87 objalloc_free ((struct objalloc
*) nbfd
->memory
);
92 nbfd
->archive_plugin_fd
= -1;
97 static const struct bfd_iovec opncls_iovec
;
99 /* Allocate a new BFD as a member of archive OBFD. */
102 _bfd_new_bfd_contained_in (bfd
*obfd
)
106 /* Nested archives in bims are unsupported. */
107 if ((obfd
->flags
& BFD_IN_MEMORY
) != 0)
109 bfd_set_error (bfd_error_malformed_archive
);
112 nbfd
= _bfd_new_bfd ();
115 nbfd
->xvec
= obfd
->xvec
;
116 nbfd
->iovec
= obfd
->iovec
;
117 if (obfd
->iovec
== &opncls_iovec
)
118 nbfd
->iostream
= obfd
->iostream
;
119 nbfd
->my_archive
= obfd
;
120 nbfd
->direction
= read_direction
;
121 nbfd
->target_defaulted
= obfd
->target_defaulted
;
122 nbfd
->lto_output
= obfd
->lto_output
;
123 nbfd
->no_export
= obfd
->no_export
;
130 _bfd_delete_bfd (bfd
*abfd
)
134 bfd_hash_table_free (&abfd
->section_htab
);
135 objalloc_free ((struct objalloc
*) abfd
->memory
);
138 free ((char *) bfd_get_filename (abfd
));
140 free (abfd
->arelt_data
);
144 /* Free objalloc memory. */
147 _bfd_free_cached_info (bfd
*abfd
)
151 const char *filename
= bfd_get_filename (abfd
);
154 /* We can't afford to lose the bfd filename when freeing
155 abfd->memory, because that would kill the cache.c scheme
156 of closing and reopening files in order to limit the
157 number of open files. To reopen, you need the filename.
158 And indeed _bfd_compute_and_write_armap calls
159 _bfd_free_cached_info to free up space used by symbols
160 and by check_format_matches. Which we want to continue
161 doing to handle very large archives. Later the archive
162 elements are copied, which might require reopening files.
163 We also want to keep using objalloc memory for the
164 filename since that allows the name to be updated
165 without either leaking memory or implementing some sort
166 of reference counted string for copies of the filename. */
167 size_t len
= strlen (filename
) + 1;
168 char *copy
= bfd_malloc (len
);
171 memcpy (copy
, filename
, len
);
172 abfd
->filename
= copy
;
174 bfd_hash_table_free (&abfd
->section_htab
);
175 objalloc_free ((struct objalloc
*) abfd
->memory
);
177 abfd
->sections
= NULL
;
178 abfd
->section_last
= NULL
;
179 abfd
->outsymbols
= NULL
;
180 abfd
->tdata
.any
= NULL
;
181 abfd
->usrdata
= NULL
;
190 Opening and closing BFDs
193 Functions for opening and closing
201 bfd *bfd_fopen (const char *filename, const char *target,
202 const char *mode, int fd);
205 Open the file @var{filename} with the target @var{target}.
206 Return a pointer to the created BFD. If @var{fd} is not -1,
207 then <<fdopen>> is used to open the file; otherwise, <<fopen>>
208 is used. @var{mode} is passed directly to <<fopen>> or
211 Calls <<bfd_find_target>>, so @var{target} is interpreted as by
214 The new BFD is marked as cacheable iff @var{fd} is -1.
216 If <<NULL>> is returned then an error has occured. Possible errors
217 are <<bfd_error_no_memory>>, <<bfd_error_invalid_target>> or
218 <<system_call>> error.
220 On error, @var{fd} is always closed.
222 A copy of the @var{filename} argument is stored in the newly created
223 BFD. It can be accessed via the bfd_get_filename() macro.
227 bfd_fopen (const char *filename
, const char *target
, const char *mode
, int fd
)
230 const bfd_target
*target_vec
;
232 nbfd
= _bfd_new_bfd ();
240 target_vec
= bfd_find_target (target
, nbfd
);
241 if (target_vec
== NULL
)
245 _bfd_delete_bfd (nbfd
);
251 nbfd
->iostream
= fdopen (fd
, mode
);
254 nbfd
->iostream
= _bfd_real_fopen (filename
, mode
);
255 if (nbfd
->iostream
== NULL
)
257 bfd_set_error (bfd_error_system_call
);
260 _bfd_delete_bfd (nbfd
);
264 /* OK, put everything where it belongs. */
266 /* PR 11983: Do not cache the original filename, but
267 rather make a copy - the original might go away. */
268 if (!bfd_set_filename (nbfd
, filename
))
270 fclose (nbfd
->iostream
);
271 _bfd_delete_bfd (nbfd
);
275 /* Figure out whether the user is opening the file for reading,
276 writing, or both, by looking at the MODE argument. */
277 if ((mode
[0] == 'r' || mode
[0] == 'w' || mode
[0] == 'a')
279 nbfd
->direction
= both_direction
;
280 else if (mode
[0] == 'r')
281 nbfd
->direction
= read_direction
;
283 nbfd
->direction
= write_direction
;
285 if (!bfd_cache_init (nbfd
))
287 fclose (nbfd
->iostream
);
288 _bfd_delete_bfd (nbfd
);
291 nbfd
->opened_once
= true;
293 /* If we opened the file by name, mark it cacheable; we can close it
294 and reopen it later. However, if a file descriptor was provided,
295 then it may have been opened with special flags that make it
296 unsafe to close and reopen the file. */
298 (void) bfd_set_cacheable (nbfd
, true);
308 bfd *bfd_openr (const char *filename, const char *target);
311 Open the file @var{filename} (using <<fopen>>) with the target
312 @var{target}. Return a pointer to the created BFD.
314 Calls <<bfd_find_target>>, so @var{target} is interpreted as by
317 If <<NULL>> is returned then an error has occured. Possible errors
318 are <<bfd_error_no_memory>>, <<bfd_error_invalid_target>> or
319 <<system_call>> error.
321 A copy of the @var{filename} argument is stored in the newly created
322 BFD. It can be accessed via the bfd_get_filename() macro.
326 bfd_openr (const char *filename
, const char *target
)
328 return bfd_fopen (filename
, target
, FOPEN_RB
, -1);
331 /* Don't try to `optimize' this function:
333 o - We lock using stack space so that interrupting the locking
334 won't cause a storage leak.
335 o - We open the file stream last, since we don't want to have to
336 close it if anything goes wrong. Closing the stream means closing
337 the file descriptor too, even though we didn't open it. */
343 bfd *bfd_fdopenr (const char *filename, const char *target, int fd);
346 <<bfd_fdopenr>> is to <<bfd_fopenr>> much like <<fdopen>> is to
347 <<fopen>>. It opens a BFD on a file already described by the
350 When the file is later <<bfd_close>>d, the file descriptor will
351 be closed. If the caller desires that this file descriptor be
352 cached by BFD (opened as needed, closed as needed to free
353 descriptors for other opens), with the supplied @var{fd} used as
354 an initial file descriptor (but subject to closure at any time),
355 call bfd_set_cacheable(bfd, 1) on the returned BFD. The default
356 is to assume no caching; the file descriptor will remain open
357 until <<bfd_close>>, and will not be affected by BFD operations
360 Possible errors are <<bfd_error_no_memory>>,
361 <<bfd_error_invalid_target>> and <<bfd_error_system_call>>.
363 On error, @var{fd} is closed.
365 A copy of the @var{filename} argument is stored in the newly created
366 BFD. It can be accessed via the bfd_get_filename() macro.
370 bfd_fdopenr (const char *filename
, const char *target
, int fd
)
373 #if defined(HAVE_FCNTL) && defined(F_GETFL)
377 #if ! defined(HAVE_FCNTL) || ! defined(F_GETFL)
378 mode
= FOPEN_RUB
; /* Assume full access. */
380 fdflags
= fcntl (fd
, F_GETFL
, NULL
);
387 bfd_set_error (bfd_error_system_call
);
391 /* (O_ACCMODE) parens are to avoid Ultrix header file bug. */
392 switch (fdflags
& (O_ACCMODE
))
394 case O_RDONLY
: mode
= FOPEN_RB
; break;
395 case O_WRONLY
: mode
= FOPEN_RUB
; break;
396 case O_RDWR
: mode
= FOPEN_RUB
; break;
401 return bfd_fopen (filename
, target
, mode
, fd
);
409 bfd *bfd_fdopenw (const char *filename, const char *target, int fd);
412 <<bfd_fdopenw>> is exactly like <<bfd_fdopenr>> with the exception that
413 the resulting BFD is suitable for output.
417 bfd_fdopenw (const char *filename
, const char *target
, int fd
)
419 bfd
*out
= bfd_fdopenr (filename
, target
, fd
);
423 if (!bfd_write_p (out
))
426 _bfd_delete_bfd (out
);
428 bfd_set_error (bfd_error_invalid_operation
);
431 out
->direction
= write_direction
;
442 bfd *bfd_openstreamr (const char * filename, const char * target,
446 Open a BFD for read access on an existing stdio stream. When
447 the BFD is passed to <<bfd_close>>, the stream will be closed.
449 A copy of the @var{filename} argument is stored in the newly created
450 BFD. It can be accessed via the bfd_get_filename() macro.
454 bfd_openstreamr (const char *filename
, const char *target
, void *streamarg
)
456 FILE *stream
= (FILE *) streamarg
;
458 const bfd_target
*target_vec
;
460 nbfd
= _bfd_new_bfd ();
464 target_vec
= bfd_find_target (target
, nbfd
);
465 if (target_vec
== NULL
)
467 _bfd_delete_bfd (nbfd
);
471 nbfd
->iostream
= stream
;
472 /* PR 11983: Do not cache the original filename, but
473 rather make a copy - the original might go away. */
474 if (!bfd_set_filename (nbfd
, filename
))
476 _bfd_delete_bfd (nbfd
);
479 nbfd
->direction
= read_direction
;
481 if (! bfd_cache_init (nbfd
))
483 _bfd_delete_bfd (nbfd
);
495 bfd *bfd_openr_iovec (const char *filename, const char *target,
496 void *(*open_func) (struct bfd *nbfd,
499 file_ptr (*pread_func) (struct bfd *nbfd,
504 int (*close_func) (struct bfd *nbfd,
506 int (*stat_func) (struct bfd *abfd,
511 Create and return a BFD backed by a read-only @var{stream}.
512 The @var{stream} is created using @var{open_func}, accessed using
513 @var{pread_func} and destroyed using @var{close_func}.
515 Calls <<bfd_find_target>>, so @var{target} is interpreted as by
518 Calls @var{open_func} (which can call <<bfd_zalloc>> and
519 <<bfd_get_filename>>) to obtain the read-only stream backing
520 the BFD. @var{open_func} either succeeds returning the
521 non-<<NULL>> @var{stream}, or fails returning <<NULL>>
522 (setting <<bfd_error>>).
524 Calls @var{pread_func} to request @var{nbytes} of data from
525 @var{stream} starting at @var{offset} (e.g., via a call to
526 <<bfd_read>>). @var{pread_func} either succeeds returning the
527 number of bytes read (which can be less than @var{nbytes} when
528 end-of-file), or fails returning -1 (setting <<bfd_error>>).
530 Calls @var{close_func} when the BFD is later closed using
531 <<bfd_close>>. @var{close_func} either succeeds returning 0, or
532 fails returning -1 (setting <<bfd_error>>).
534 Calls @var{stat_func} to fill in a stat structure for bfd_stat,
535 bfd_get_size, and bfd_get_mtime calls. @var{stat_func} returns 0
536 on success, or returns -1 on failure (setting <<bfd_error>>).
538 If <<bfd_openr_iovec>> returns <<NULL>> then an error has
539 occurred. Possible errors are <<bfd_error_no_memory>>,
540 <<bfd_error_invalid_target>> and <<bfd_error_system_call>>.
542 A copy of the @var{filename} argument is stored in the newly created
543 BFD. It can be accessed via the bfd_get_filename() macro.
549 file_ptr (*pread
) (struct bfd
*abfd
, void *stream
, void *buf
,
550 file_ptr nbytes
, file_ptr offset
);
551 int (*close
) (struct bfd
*abfd
, void *stream
);
552 int (*stat
) (struct bfd
*abfd
, void *stream
, struct stat
*sb
);
557 opncls_btell (struct bfd
*abfd
)
559 struct opncls
*vec
= (struct opncls
*) abfd
->iostream
;
564 opncls_bseek (struct bfd
*abfd
, file_ptr offset
, int whence
)
566 struct opncls
*vec
= (struct opncls
*) abfd
->iostream
;
569 case SEEK_SET
: vec
->where
= offset
; break;
570 case SEEK_CUR
: vec
->where
+= offset
; break;
571 case SEEK_END
: return -1;
577 opncls_bread (struct bfd
*abfd
, void *buf
, file_ptr nbytes
)
579 struct opncls
*vec
= (struct opncls
*) abfd
->iostream
;
580 file_ptr nread
= (vec
->pread
) (abfd
, vec
->stream
, buf
, nbytes
, vec
->where
);
589 opncls_bwrite (struct bfd
*abfd ATTRIBUTE_UNUSED
,
590 const void *where ATTRIBUTE_UNUSED
,
591 file_ptr nbytes ATTRIBUTE_UNUSED
)
597 opncls_bclose (struct bfd
*abfd
)
599 struct opncls
*vec
= (struct opncls
*) abfd
->iostream
;
600 /* Since the VEC's memory is bound to the bfd deleting the bfd will
604 if (vec
->close
!= NULL
)
605 status
= (vec
->close
) (abfd
, vec
->stream
);
606 abfd
->iostream
= NULL
;
611 opncls_bflush (struct bfd
*abfd ATTRIBUTE_UNUSED
)
617 opncls_bstat (struct bfd
*abfd
, struct stat
*sb
)
619 struct opncls
*vec
= (struct opncls
*) abfd
->iostream
;
621 memset (sb
, 0, sizeof (*sb
));
622 if (vec
->stat
== NULL
)
625 return (vec
->stat
) (abfd
, vec
->stream
, sb
);
629 opncls_bmmap (struct bfd
*abfd ATTRIBUTE_UNUSED
,
630 void *addr ATTRIBUTE_UNUSED
,
631 bfd_size_type len ATTRIBUTE_UNUSED
,
632 int prot ATTRIBUTE_UNUSED
,
633 int flags ATTRIBUTE_UNUSED
,
634 file_ptr offset ATTRIBUTE_UNUSED
,
635 void **map_addr ATTRIBUTE_UNUSED
,
636 bfd_size_type
*map_len ATTRIBUTE_UNUSED
)
641 static const struct bfd_iovec opncls_iovec
=
643 &opncls_bread
, &opncls_bwrite
, &opncls_btell
, &opncls_bseek
,
644 &opncls_bclose
, &opncls_bflush
, &opncls_bstat
, &opncls_bmmap
648 bfd_openr_iovec (const char *filename
, const char *target
,
649 void *(*open_p
) (struct bfd
*, void *),
651 file_ptr (*pread_p
) (struct bfd
*, void *, void *,
653 int (*close_p
) (struct bfd
*, void *),
654 int (*stat_p
) (struct bfd
*, void *, struct stat
*))
657 const bfd_target
*target_vec
;
661 nbfd
= _bfd_new_bfd ();
665 target_vec
= bfd_find_target (target
, nbfd
);
666 if (target_vec
== NULL
)
668 _bfd_delete_bfd (nbfd
);
672 /* PR 11983: Do not cache the original filename, but
673 rather make a copy - the original might go away. */
674 if (!bfd_set_filename (nbfd
, filename
))
676 _bfd_delete_bfd (nbfd
);
679 nbfd
->direction
= read_direction
;
681 /* `open_p (...)' would get expanded by an the open(2) syscall macro. */
682 stream
= (*open_p
) (nbfd
, open_closure
);
685 _bfd_delete_bfd (nbfd
);
689 vec
= (struct opncls
*) bfd_zalloc (nbfd
, sizeof (struct opncls
));
690 vec
->stream
= stream
;
691 vec
->pread
= pread_p
;
692 vec
->close
= close_p
;
695 nbfd
->iovec
= &opncls_iovec
;
696 nbfd
->iostream
= vec
;
701 /* bfd_openw -- open for writing.
702 Returns a pointer to a freshly-allocated BFD on success, or NULL.
704 See comment by bfd_fdopenr before you try to modify this function. */
711 bfd *bfd_openw (const char *filename, const char *target);
714 Create a BFD, associated with file @var{filename}, using the
715 file format @var{target}, and return a pointer to it.
717 Possible errors are <<bfd_error_system_call>>, <<bfd_error_no_memory>>,
718 <<bfd_error_invalid_target>>.
720 A copy of the @var{filename} argument is stored in the newly created
721 BFD. It can be accessed via the bfd_get_filename() macro.
725 bfd_openw (const char *filename
, const char *target
)
728 const bfd_target
*target_vec
;
730 /* nbfd has to point to head of malloc'ed block so that bfd_close may
731 reclaim it correctly. */
732 nbfd
= _bfd_new_bfd ();
736 target_vec
= bfd_find_target (target
, nbfd
);
737 if (target_vec
== NULL
)
739 _bfd_delete_bfd (nbfd
);
743 /* PR 11983: Do not cache the original filename, but
744 rather make a copy - the original might go away. */
745 if (!bfd_set_filename (nbfd
, filename
))
747 _bfd_delete_bfd (nbfd
);
750 nbfd
->direction
= write_direction
;
752 if (bfd_open_file (nbfd
) == NULL
)
754 /* File not writeable, etc. */
755 bfd_set_error (bfd_error_system_call
);
756 _bfd_delete_bfd (nbfd
);
764 _maybe_make_executable (bfd
* abfd
)
766 /* If the file was open for writing and is now executable,
768 if (abfd
->direction
== write_direction
769 && (abfd
->flags
& (EXEC_P
| DYNAMIC
)) != 0)
773 if (stat (bfd_get_filename (abfd
), &buf
) == 0
774 /* Do not attempt to change non-regular files. This is
775 here especially for configure scripts and kernel builds
776 which run tests with "ld [...] -o /dev/null". */
777 && S_ISREG(buf
.st_mode
))
779 unsigned int mask
= umask (0);
782 chmod (bfd_get_filename (abfd
),
784 & (buf
.st_mode
| ((S_IXUSR
| S_IXGRP
| S_IXOTH
) &~ mask
))));
794 bool bfd_close (bfd *abfd);
797 Close a BFD. If the BFD was open for writing, then pending
798 operations are completed and the file written out and closed.
799 If the created file is executable, then <<chmod>> is called
802 All memory attached to the BFD is released.
804 The file descriptor associated with the BFD is closed (even
805 if it was passed in to BFD by <<bfd_fdopenr>>).
807 <<TRUE>> is returned if all is ok, otherwise <<FALSE>>.
811 bfd_close (bfd
*abfd
)
813 bool ret
= (!bfd_write_p (abfd
)
814 || BFD_SEND_FMT (abfd
, _bfd_write_contents
, (abfd
)));
816 return bfd_close_all_done (abfd
) && ret
;
824 bool bfd_close_all_done (bfd *);
827 Close a BFD. Differs from <<bfd_close>> since it does not
828 complete any pending operations. This routine would be used
829 if the application had just used BFD for swapping and didn't
830 want to use any of the writing code.
832 If the created file is executable, then <<chmod>> is called
835 All memory attached to the BFD is released.
837 <<TRUE>> is returned if all is ok, otherwise <<FALSE>>.
841 bfd_close_all_done (bfd
*abfd
)
843 bool ret
= BFD_SEND (abfd
, _close_and_cleanup
, (abfd
));
845 if (ret
&& abfd
->iovec
!= NULL
)
847 ret
= abfd
->iovec
->bclose (abfd
) == 0;
850 _maybe_make_executable (abfd
);
853 _bfd_delete_bfd (abfd
);
863 bfd *bfd_create (const char *filename, bfd *templ);
866 Create a new BFD in the manner of <<bfd_openw>>, but without
867 opening a file. The new BFD takes the target from the target
868 used by @var{templ}. The format is always set to <<bfd_object>>.
870 A copy of the @var{filename} argument is stored in the newly created
871 BFD. It can be accessed via the bfd_get_filename() macro.
875 bfd_create (const char *filename
, bfd
*templ
)
879 nbfd
= _bfd_new_bfd ();
882 /* PR 11983: Do not cache the original filename, but
883 rather make a copy - the original might go away. */
884 if (!bfd_set_filename (nbfd
, filename
))
886 _bfd_delete_bfd (nbfd
);
890 nbfd
->xvec
= templ
->xvec
;
891 nbfd
->direction
= no_direction
;
892 bfd_set_format (nbfd
, bfd_object
);
902 bool bfd_make_writable (bfd *abfd);
905 Takes a BFD as created by <<bfd_create>> and converts it
906 into one like as returned by <<bfd_openw>>. It does this
907 by converting the BFD to BFD_IN_MEMORY. It's assumed that
908 you will call <<bfd_make_readable>> on this bfd later.
910 <<TRUE>> is returned if all is ok, otherwise <<FALSE>>.
914 bfd_make_writable (bfd
*abfd
)
916 struct bfd_in_memory
*bim
;
918 if (abfd
->direction
!= no_direction
)
920 bfd_set_error (bfd_error_invalid_operation
);
924 bim
= (struct bfd_in_memory
*) bfd_malloc (sizeof (struct bfd_in_memory
));
926 return false; /* bfd_error already set. */
927 abfd
->iostream
= bim
;
928 /* bfd_bwrite will grow these as needed. */
932 abfd
->flags
|= BFD_IN_MEMORY
;
933 abfd
->iovec
= &_bfd_memory_iovec
;
935 abfd
->direction
= write_direction
;
946 bool bfd_make_readable (bfd *abfd);
949 Takes a BFD as created by <<bfd_create>> and
950 <<bfd_make_writable>> and converts it into one like as
951 returned by <<bfd_openr>>. It does this by writing the
952 contents out to the memory buffer, then reversing the
955 <<TRUE>> is returned if all is ok, otherwise <<FALSE>>. */
958 bfd_make_readable (bfd
*abfd
)
960 if (abfd
->direction
!= write_direction
|| !(abfd
->flags
& BFD_IN_MEMORY
))
962 bfd_set_error (bfd_error_invalid_operation
);
966 if (! BFD_SEND_FMT (abfd
, _bfd_write_contents
, (abfd
)))
969 if (! BFD_SEND (abfd
, _close_and_cleanup
, (abfd
)))
972 abfd
->arch_info
= &bfd_default_arch_struct
;
975 abfd
->format
= bfd_unknown
;
976 abfd
->my_archive
= NULL
;
978 abfd
->opened_once
= false;
979 abfd
->output_has_begun
= false;
980 abfd
->section_count
= 0;
981 abfd
->usrdata
= NULL
;
982 abfd
->cacheable
= false;
983 abfd
->flags
|= BFD_IN_MEMORY
;
984 abfd
->mtime_set
= false;
986 abfd
->target_defaulted
= true;
987 abfd
->direction
= read_direction
;
990 abfd
->outsymbols
= 0;
994 bfd_section_list_clear (abfd
);
995 bfd_check_format (abfd
, bfd_object
);
1005 void *bfd_alloc (bfd *abfd, bfd_size_type wanted);
1008 Allocate a block of @var{wanted} bytes of memory attached to
1009 <<abfd>> and return a pointer to it.
1013 bfd_alloc (bfd
*abfd
, bfd_size_type size
)
1016 unsigned long ul_size
= (unsigned long) size
;
1019 /* Note - although objalloc_alloc takes an unsigned long as its
1020 argument, internally the size is treated as a signed long. This can
1021 lead to problems where, for example, a request to allocate -1 bytes
1022 can result in just 1 byte being allocated, rather than
1023 ((unsigned long) -1) bytes. Also memory checkers will often
1024 complain about attempts to allocate a negative amount of memory.
1025 So to stop these problems we fail if the size is negative. */
1026 || ((signed long) ul_size
) < 0)
1028 bfd_set_error (bfd_error_no_memory
);
1032 ret
= objalloc_alloc ((struct objalloc
*) abfd
->memory
, ul_size
);
1034 bfd_set_error (bfd_error_no_memory
);
1036 abfd
->alloc_size
+= size
;
1045 void *bfd_zalloc (bfd *abfd, bfd_size_type wanted);
1048 Allocate a block of @var{wanted} bytes of zeroed memory
1049 attached to <<abfd>> and return a pointer to it.
1053 bfd_zalloc (bfd
*abfd
, bfd_size_type size
)
1057 res
= bfd_alloc (abfd
, size
);
1059 memset (res
, 0, (size_t) size
);
1063 /* Free a block allocated for a BFD.
1064 Note: Also frees all more recently allocated blocks! */
1067 bfd_release (bfd
*abfd
, void *block
)
1069 objalloc_free_block ((struct objalloc
*) abfd
->memory
, block
);
1074 GNU Extension: separate debug-info files
1076 The idea here is that a special section called .gnu_debuglink might be
1077 embedded in a binary file, which indicates that some *other* file
1078 contains the real debugging information. This special section contains a
1079 filename and CRC32 checksum, which we read and resolve to another file,
1082 This facilitates "optional" provision of debugging information, without
1083 having to provide two complete copies of every binary object (with and
1084 without debug symbols). */
1086 #define GNU_DEBUGLINK ".gnu_debuglink"
1087 #define GNU_DEBUGALTLINK ".gnu_debugaltlink"
1091 bfd_calc_gnu_debuglink_crc32
1094 unsigned long bfd_calc_gnu_debuglink_crc32
1095 (unsigned long crc, const unsigned char *buf, bfd_size_type len);
1098 Computes a CRC value as used in the .gnu_debuglink section.
1099 Advances the previously computed @var{crc} value by computing
1100 and adding in the crc32 for @var{len} bytes of @var{buf}.
1102 Return the updated CRC32 value.
1106 bfd_calc_gnu_debuglink_crc32 (unsigned long crc
,
1107 const unsigned char *buf
,
1110 static const unsigned long crc32_table
[256] =
1112 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
1113 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
1114 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
1115 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
1116 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
1117 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
1118 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
1119 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
1120 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
1121 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
1122 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
1123 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
1124 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
1125 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
1126 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
1127 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
1128 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
1129 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
1130 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
1131 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
1132 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
1133 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
1134 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
1135 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
1136 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
1137 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
1138 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
1139 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
1140 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
1141 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
1142 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
1143 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
1144 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
1145 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
1146 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
1147 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
1148 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
1149 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
1150 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
1151 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
1152 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
1153 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
1154 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
1155 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
1156 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
1157 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
1158 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
1159 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
1160 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
1161 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
1162 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
1165 const unsigned char *end
;
1167 crc
= ~crc
& 0xffffffff;
1168 for (end
= buf
+ len
; buf
< end
; ++ buf
)
1169 crc
= crc32_table
[(crc
^ *buf
) & 0xff] ^ (crc
>> 8);
1170 return ~crc
& 0xffffffff;
1174 /* Extracts the filename and CRC32 value for any separate debug
1175 information file associated with @var{abfd}.
1177 The @var{crc32_out} parameter is an untyped pointer because
1178 this routine is used as a @code{get_func_type} function, but it
1179 is expected to be an unsigned long pointer.
1181 Returns the filename of the associated debug information file,
1182 or NULL if there is no such file. If the filename was found
1183 then the contents of @var{crc32_out} are updated to hold the
1184 corresponding CRC32 value for the file.
1186 The returned filename is allocated with @code{malloc}; freeing
1187 it is the responsibility of the caller. */
1190 bfd_get_debug_link_info_1 (bfd
*abfd
, void *crc32_out
)
1193 unsigned long *crc32
= (unsigned long *) crc32_out
;
1195 unsigned int crc_offset
;
1198 ufile_ptr file_size
;
1201 BFD_ASSERT (crc32_out
);
1203 sect
= bfd_get_section_by_name (abfd
, GNU_DEBUGLINK
);
1208 size
= bfd_section_size (sect
);
1209 file_size
= bfd_get_size (abfd
);
1211 /* PR 22794: Make sure that the section has a reasonable size. */
1212 if (size
< 8 || (file_size
!= 0 && size
>= file_size
))
1215 if (!bfd_malloc_and_get_section (abfd
, sect
, &contents
))
1221 /* CRC value is stored after the filename, aligned up to 4 bytes. */
1222 name
= (char *) contents
;
1223 /* PR 17597: Avoid reading off the end of the buffer. */
1224 crc_offset
= strnlen (name
, size
) + 1;
1225 crc_offset
= (crc_offset
+ 3) & ~3;
1226 if (crc_offset
+ 4 > size
)
1229 *crc32
= bfd_get_32 (abfd
, contents
+ crc_offset
);
1236 bfd_get_debug_link_info
1239 char *bfd_get_debug_link_info (bfd *abfd, unsigned long *crc32_out);
1242 Extracts the filename and CRC32 value for any separate debug
1243 information file associated with @var{abfd}.
1245 Returns the filename of the associated debug information file,
1246 or NULL if there is no such file. If the filename was found
1247 then the contents of @var{crc32_out} are updated to hold the
1248 corresponding CRC32 value for the file.
1250 The returned filename is allocated with @code{malloc}; freeing
1251 it is the responsibility of the caller.
1255 bfd_get_debug_link_info (bfd
*abfd
, unsigned long *crc32_out
)
1257 return bfd_get_debug_link_info_1 (abfd
, crc32_out
);
1262 bfd_get_alt_debug_link_info
1265 char *bfd_get_alt_debug_link_info (bfd * abfd,
1266 bfd_size_type *buildid_len,
1267 bfd_byte **buildid_out);
1270 Fetch the filename and BuildID value for any alternate debuginfo
1271 associated with @var{abfd}. Return NULL if no such info found,
1272 otherwise return filename and update @var{buildid_len} and
1273 @var{buildid_out}. The returned filename and build_id are
1274 allocated with @code{malloc}; freeing them is the responsibility
1279 bfd_get_alt_debug_link_info (bfd
* abfd
, bfd_size_type
*buildid_len
,
1280 bfd_byte
**buildid_out
)
1284 unsigned int buildid_offset
;
1287 ufile_ptr file_size
;
1290 BFD_ASSERT (buildid_len
);
1291 BFD_ASSERT (buildid_out
);
1293 sect
= bfd_get_section_by_name (abfd
, GNU_DEBUGALTLINK
);
1298 size
= bfd_section_size (sect
);
1299 file_size
= bfd_get_size (abfd
);
1300 if (size
< 8 || (file_size
!= 0 && size
>= file_size
))
1303 if (!bfd_malloc_and_get_section (abfd
, sect
, & contents
))
1309 /* BuildID value is stored after the filename. */
1310 name
= (char *) contents
;
1311 buildid_offset
= strnlen (name
, size
) + 1;
1312 if (buildid_offset
>= bfd_section_size (sect
))
1315 *buildid_len
= size
- buildid_offset
;
1316 *buildid_out
= bfd_malloc (*buildid_len
);
1317 memcpy (*buildid_out
, contents
+ buildid_offset
, *buildid_len
);
1322 /* Checks to see if @var{name} is a file and if its contents match
1323 @var{crc32}, which is a pointer to an @code{unsigned long}
1326 The @var{crc32_p} parameter is an untyped pointer because this
1327 routine is used as a @code{check_func_type} function. */
1330 separate_debug_file_exists (const char *name
, void *crc32_p
)
1332 unsigned char buffer
[8 * 1024];
1333 unsigned long file_crc
= 0;
1335 bfd_size_type count
;
1339 BFD_ASSERT (crc32_p
);
1341 crc
= *(unsigned long *) crc32_p
;
1343 f
= _bfd_real_fopen (name
, FOPEN_RB
);
1347 while ((count
= fread (buffer
, 1, sizeof (buffer
), f
)) > 0)
1348 file_crc
= bfd_calc_gnu_debuglink_crc32 (file_crc
, buffer
, count
);
1352 return crc
== file_crc
;
1355 /* Checks to see if @var{name} is a file. */
1358 separate_alt_debug_file_exists (const char *name
, void *unused ATTRIBUTE_UNUSED
)
1364 f
= _bfd_real_fopen (name
, FOPEN_RB
);
1373 /* Searches for a debug information file corresponding to @var{abfd}.
1375 The name of the separate debug info file is returned by the
1376 @var{get} function. This function scans various fixed locations
1377 in the filesystem, including the file tree rooted at @var{dir}.
1378 If the @var{include_dirs} parameter is true then the directory
1379 components of @var{abfd}'s filename will be included in the
1382 @var{data} is passed unmodified to the @var{get} and @var{check}
1383 functions. It is generally used to implement build-id-like
1384 matching in the callback functions.
1386 Returns the filename of the first file to be found which
1387 receives a TRUE result from the @var{check} function.
1388 Returns NULL if no valid file could be found. */
1390 typedef char * (*get_func_type
) (bfd
*, void *);
1391 typedef bool (*check_func_type
) (const char *, void *);
1394 find_separate_debug_file (bfd
*abfd
,
1395 const char *debug_file_directory
,
1397 get_func_type get_func
,
1398 check_func_type check_func
,
1406 size_t canon_dirlen
;
1409 if (debug_file_directory
== NULL
)
1410 debug_file_directory
= ".";
1412 /* BFD may have been opened from a stream. */
1413 if (bfd_get_filename (abfd
) == NULL
)
1415 bfd_set_error (bfd_error_invalid_operation
);
1419 base
= get_func (abfd
, func_data
);
1424 if (base
[0] == '\0')
1427 bfd_set_error (bfd_error_no_debug_section
);
1433 const char *fname
= bfd_get_filename (abfd
);
1434 for (dirlen
= strlen (fname
); dirlen
> 0; dirlen
--)
1435 if (IS_DIR_SEPARATOR (fname
[dirlen
- 1]))
1438 dir
= (char *) bfd_malloc (dirlen
+ 1);
1444 memcpy (dir
, fname
, dirlen
);
1449 dir
= (char *) bfd_malloc (1);
1454 /* Compute the canonical name of the bfd object with all symbolic links
1455 resolved, for use in the global debugfile directory. */
1456 canon_dir
= lrealpath (bfd_get_filename (abfd
));
1457 for (canon_dirlen
= strlen (canon_dir
); canon_dirlen
> 0; canon_dirlen
--)
1458 if (IS_DIR_SEPARATOR (canon_dir
[canon_dirlen
- 1]))
1460 canon_dir
[canon_dirlen
] = '\0';
1462 #ifndef EXTRA_DEBUG_ROOT1
1463 #define EXTRA_DEBUG_ROOT1 "/usr/lib/debug"
1465 #ifndef EXTRA_DEBUG_ROOT2
1466 #define EXTRA_DEBUG_ROOT2 "/usr/lib/debug/usr"
1469 debugfile
= (char *)
1470 bfd_malloc (strlen (debug_file_directory
) + 1
1471 + (canon_dirlen
> dirlen
? canon_dirlen
: dirlen
)
1472 + strlen (".debug/")
1473 #ifdef EXTRA_DEBUG_ROOT1
1474 + strlen (EXTRA_DEBUG_ROOT1
)
1476 #ifdef EXTRA_DEBUG_ROOT2
1477 + strlen (EXTRA_DEBUG_ROOT2
)
1481 if (debugfile
== NULL
)
1482 goto found
; /* Actually this returns NULL. */
1484 /* First try in the same directory as the original file.
1486 FIXME: Strictly speaking if we are using the build-id method,
1487 (ie include_dirs == FALSE) then we should only check absolute
1488 paths, not relative ones like this one (and the next one).
1489 The check is left in however as this allows the binutils
1490 testsuite to exercise this feature without having to install
1491 a file into the root filesystem. (See binutils/testsuite/
1492 binutils-all/objdump.exp for the test). */
1493 sprintf (debugfile
, "%s%s", dir
, base
);
1494 if (check_func (debugfile
, func_data
))
1497 /* Then try in a subdirectory called .debug. */
1498 sprintf (debugfile
, "%s.debug/%s", dir
, base
);
1499 if (check_func (debugfile
, func_data
))
1502 #ifdef EXTRA_DEBUG_ROOT1
1503 /* Try the first extra debug file root. */
1504 sprintf (debugfile
, "%s%s%s", EXTRA_DEBUG_ROOT1
,
1505 include_dirs
? canon_dir
: "/", base
);
1506 if (check_func (debugfile
, func_data
))
1510 #ifdef EXTRA_DEBUG_ROOT2
1511 /* Try the second extra debug file root. */
1512 sprintf (debugfile
, "%s%s%s", EXTRA_DEBUG_ROOT2
,
1513 include_dirs
? canon_dir
: "/", base
);
1514 if (check_func (debugfile
, func_data
))
1518 /* Then try in the global debugfile directory. */
1519 strcpy (debugfile
, debug_file_directory
);
1520 dirlen
= strlen (debug_file_directory
) - 1;
1524 && debug_file_directory
[dirlen
] != '/'
1525 && canon_dir
[0] != '/')
1526 strcat (debugfile
, "/");
1527 strcat (debugfile
, canon_dir
);
1531 if (dirlen
> 0 && debug_file_directory
[dirlen
] != '/')
1532 strcat (debugfile
, "/");
1534 strcat (debugfile
, base
);
1536 if (check_func (debugfile
, func_data
))
1539 /* Failed to find the file. */
1552 bfd_follow_gnu_debuglink
1555 char *bfd_follow_gnu_debuglink (bfd *abfd, const char *dir);
1558 Takes a BFD and searches it for a .gnu_debuglink section. If this
1559 section is found, it examines the section for the name and checksum
1560 of a '.debug' file containing auxiliary debugging information. It
1561 then searches the filesystem for this .debug file in some standard
1562 locations, including the directory tree rooted at @var{dir}, and if
1563 found returns the full filename.
1565 If @var{dir} is NULL, the search will take place starting at
1566 the current directory.
1568 Returns <<NULL>> on any errors or failure to locate the .debug
1569 file, otherwise a pointer to a heap-allocated string
1570 containing the filename. The caller is responsible for
1571 freeing this string.
1575 bfd_follow_gnu_debuglink (bfd
*abfd
, const char *dir
)
1577 unsigned long crc32
;
1579 return find_separate_debug_file (abfd
, dir
, true,
1580 bfd_get_debug_link_info_1
,
1581 separate_debug_file_exists
, &crc32
);
1584 /* Helper for bfd_follow_gnu_debugaltlink. It just returns the name
1585 of the separate debug file. */
1588 get_alt_debug_link_info_shim (bfd
* abfd
, void *unused ATTRIBUTE_UNUSED
)
1591 bfd_byte
*buildid
= NULL
;
1592 char *result
= bfd_get_alt_debug_link_info (abfd
, &len
, &buildid
);
1601 bfd_follow_gnu_debugaltlink
1604 char *bfd_follow_gnu_debugaltlink (bfd *abfd, const char *dir);
1607 Takes a BFD and searches it for a .gnu_debugaltlink section. If this
1608 section is found, it examines the section for the name of a file
1609 containing auxiliary debugging information. It then searches the
1610 filesystem for this file in a set of standard locations, including
1611 the directory tree rooted at @var{dir}, and if found returns the
1614 If @var{dir} is NULL, the search will take place starting at
1615 the current directory.
1617 Returns <<NULL>> on any errors or failure to locate the debug
1618 file, otherwise a pointer to a heap-allocated string
1619 containing the filename. The caller is responsible for
1620 freeing this string.
1624 bfd_follow_gnu_debugaltlink (bfd
*abfd
, const char *dir
)
1626 return find_separate_debug_file (abfd
, dir
, true,
1627 get_alt_debug_link_info_shim
,
1628 separate_alt_debug_file_exists
,
1634 bfd_create_gnu_debuglink_section
1637 struct bfd_section *bfd_create_gnu_debuglink_section
1638 (bfd *abfd, const char *filename);
1641 Takes a @var{BFD} and adds a .gnu_debuglink section to it. The
1642 section is sized to be big enough to contain a link to the specified
1645 A pointer to the new section is returned if all is ok. Otherwise
1646 <<NULL>> is returned and bfd_error is set.
1650 bfd_create_gnu_debuglink_section (bfd
*abfd
, const char *filename
)
1653 bfd_size_type debuglink_size
;
1656 if (abfd
== NULL
|| filename
== NULL
)
1658 bfd_set_error (bfd_error_invalid_operation
);
1662 /* Strip off any path components in filename. */
1663 filename
= lbasename (filename
);
1665 sect
= bfd_get_section_by_name (abfd
, GNU_DEBUGLINK
);
1668 /* Section already exists. */
1669 bfd_set_error (bfd_error_invalid_operation
);
1673 flags
= SEC_HAS_CONTENTS
| SEC_READONLY
| SEC_DEBUGGING
;
1674 sect
= bfd_make_section_with_flags (abfd
, GNU_DEBUGLINK
, flags
);
1678 /* Compute the size of the section. Allow for the CRC after the filename,
1679 and padding so that it will start on a 4-byte boundary. */
1680 debuglink_size
= strlen (filename
) + 1;
1681 debuglink_size
+= 3;
1682 debuglink_size
&= ~3;
1683 debuglink_size
+= 4;
1685 if (!bfd_set_section_size (sect
, debuglink_size
))
1686 /* XXX Should we delete the section from the bfd ? */
1689 /* PR 21193: Ensure that the section has 4-byte alignment for the CRC.
1690 Note - despite the name of the function being called, we are
1691 setting an alignment power, not a byte alignment value. */
1692 bfd_set_section_alignment (sect
, 2);
1700 bfd_fill_in_gnu_debuglink_section
1703 bool bfd_fill_in_gnu_debuglink_section
1704 (bfd *abfd, struct bfd_section *sect, const char *filename);
1707 Takes a @var{BFD} and containing a .gnu_debuglink section @var{SECT}
1708 and fills in the contents of the section to contain a link to the
1709 specified @var{filename}. The filename should be relative to the
1712 <<TRUE>> is returned if all is ok. Otherwise <<FALSE>> is returned
1713 and bfd_error is set.
1717 bfd_fill_in_gnu_debuglink_section (bfd
*abfd
,
1718 struct bfd_section
*sect
,
1719 const char *filename
)
1721 bfd_size_type debuglink_size
;
1722 unsigned long crc32
;
1724 bfd_size_type crc_offset
;
1726 unsigned char buffer
[8 * 1024];
1730 if (abfd
== NULL
|| sect
== NULL
|| filename
== NULL
)
1732 bfd_set_error (bfd_error_invalid_operation
);
1736 /* Make sure that we can read the file.
1737 XXX - Should we attempt to locate the debug info file using the same
1738 algorithm as gdb ? At the moment, since we are creating the
1739 .gnu_debuglink section, we insist upon the user providing us with a
1740 correct-for-section-creation-time path, but this need not conform to
1741 the gdb location algorithm. */
1742 handle
= _bfd_real_fopen (filename
, FOPEN_RB
);
1745 bfd_set_error (bfd_error_system_call
);
1750 while ((count
= fread (buffer
, 1, sizeof buffer
, handle
)) > 0)
1751 crc32
= bfd_calc_gnu_debuglink_crc32 (crc32
, buffer
, count
);
1754 /* Strip off any path components in filename,
1755 now that we no longer need them. */
1756 filename
= lbasename (filename
);
1758 filelen
= strlen (filename
);
1759 debuglink_size
= filelen
+ 1;
1760 debuglink_size
+= 3;
1761 debuglink_size
&= ~3;
1762 debuglink_size
+= 4;
1764 contents
= (char *) bfd_malloc (debuglink_size
);
1765 if (contents
== NULL
)
1767 /* XXX Should we delete the section from the bfd ? */
1771 crc_offset
= debuglink_size
- 4;
1772 memcpy (contents
, filename
, filelen
);
1773 memset (contents
+ filelen
, 0, crc_offset
- filelen
);
1775 bfd_put_32 (abfd
, crc32
, contents
+ crc_offset
);
1777 if (! bfd_set_section_contents (abfd
, sect
, contents
, 0, debuglink_size
))
1779 /* XXX Should we delete the section from the bfd ? */
1787 /* Finds the build-id associated with @var{abfd}. If the build-id is
1788 extracted from the note section then a build-id structure is built
1789 for it, using memory allocated to @var{abfd}, and this is then
1790 attached to the @var{abfd}.
1792 Returns a pointer to the build-id structure if a build-id could be
1793 found. If no build-id is found NULL is returned and error code is
1796 static struct bfd_build_id
*
1797 get_build_id (bfd
*abfd
)
1799 struct bfd_build_id
*build_id
;
1800 Elf_Internal_Note inote
;
1801 Elf_External_Note
*enote
;
1808 if (abfd
->build_id
&& abfd
->build_id
->size
> 0)
1809 /* Save some time by using the already computed build-id. */
1810 return (struct bfd_build_id
*) abfd
->build_id
;
1812 sect
= bfd_get_section_by_name (abfd
, ".note.gnu.build-id");
1815 bfd_set_error (bfd_error_no_debug_section
);
1819 size
= bfd_section_size (sect
);
1820 /* FIXME: Should we support smaller build-id notes ? */
1823 bfd_set_error (bfd_error_invalid_operation
);
1827 if (!bfd_malloc_and_get_section (abfd
, sect
, & contents
))
1833 /* FIXME: Paranoia - allow for compressed build-id sections.
1834 Maybe we should complain if this size is different from
1835 the one obtained above... */
1836 size
= bfd_section_size (sect
);
1837 if (size
< sizeof (Elf_External_Note
))
1839 bfd_set_error (bfd_error_invalid_operation
);
1844 enote
= (Elf_External_Note
*) contents
;
1845 inote
.type
= H_GET_32 (abfd
, enote
->type
);
1846 inote
.namesz
= H_GET_32 (abfd
, enote
->namesz
);
1847 inote
.namedata
= enote
->name
;
1848 inote
.descsz
= H_GET_32 (abfd
, enote
->descsz
);
1849 inote
.descdata
= inote
.namedata
+ BFD_ALIGN (inote
.namesz
, 4);
1850 /* FIXME: Should we check for extra notes in this section ? */
1852 if (inote
.descsz
<= 0
1853 || inote
.type
!= NT_GNU_BUILD_ID
1854 || inote
.namesz
!= 4 /* sizeof "GNU" */
1855 || !startswith (inote
.namedata
, "GNU")
1856 || inote
.descsz
> 0x7ffffffe
1857 || size
< (12 + BFD_ALIGN (inote
.namesz
, 4) + inote
.descsz
))
1860 bfd_set_error (bfd_error_invalid_operation
);
1864 build_id
= bfd_alloc (abfd
, sizeof (struct bfd_build_id
) + inote
.descsz
);
1865 if (build_id
== NULL
)
1871 build_id
->size
= inote
.descsz
;
1872 memcpy (build_id
->data
, inote
.descdata
, inote
.descsz
);
1873 abfd
->build_id
= build_id
;
1879 /* Searches @var{abfd} for a build-id, and then constructs a pathname
1880 from it. The path is computed as .build-id/NN/NN+NN.debug where
1881 NNNN+NN is the build-id value as a hexadecimal string.
1883 Returns the constructed filename or NULL upon error. It is the
1884 caller's responsibility to free the memory used to hold the
1885 filename. If a filename is returned then the @var{build_id_out_p}
1886 parameter (which points to a @code{struct bfd_build_id} pointer) is
1887 set to a pointer to the build_id structure. */
1890 get_build_id_name (bfd
*abfd
, void *build_id_out_p
)
1892 struct bfd_build_id
**build_id_out
= build_id_out_p
;
1893 struct bfd_build_id
*build_id
;
1899 if (abfd
== NULL
|| bfd_get_filename (abfd
) == NULL
|| build_id_out
== NULL
)
1901 bfd_set_error (bfd_error_invalid_operation
);
1905 build_id
= get_build_id (abfd
);
1906 if (build_id
== NULL
)
1909 /* Compute the debug pathname corresponding to the build-id. */
1910 name
= bfd_malloc (strlen (".build-id/") + build_id
->size
* 2 + 2 + strlen (".debug"));
1913 bfd_set_error (bfd_error_no_memory
);
1920 n
+= sprintf (n
, ".build-id/");
1921 n
+= sprintf (n
, "%02x", (unsigned) *d
++); s
--;
1922 n
+= sprintf (n
, "/");
1924 n
+= sprintf (n
, "%02x", (unsigned) *d
++);
1925 n
+= sprintf (n
, ".debug");
1927 *build_id_out
= build_id
;
1931 /* Checks to see if @var{name} is a readable file and if its build-id
1932 matches @var{buildid}.
1934 Returns TRUE if the file exists, is readable, and contains a
1935 build-id which matches the build-id pointed at by @var{build_id_p}
1936 (which is really a @code{struct bfd_build_id **}). */
1939 check_build_id_file (const char *name
, void *buildid_p
)
1941 struct bfd_build_id
*orig_build_id
;
1942 struct bfd_build_id
*build_id
;
1947 BFD_ASSERT (buildid_p
);
1949 file
= bfd_openr (name
, NULL
);
1953 /* If the file is an archive, process all of its elements. */
1954 if (! bfd_check_format (file
, bfd_object
))
1960 build_id
= get_build_id (file
);
1961 if (build_id
== NULL
)
1967 orig_build_id
= *(struct bfd_build_id
**) buildid_p
;
1969 result
= build_id
->size
== orig_build_id
->size
1970 && memcmp (build_id
->data
, orig_build_id
->data
, build_id
->size
) == 0;
1972 (void) bfd_close (file
);
1979 bfd_follow_build_id_debuglink
1982 char *bfd_follow_build_id_debuglink (bfd *abfd, const char *dir);
1985 Takes @var{abfd} and searches it for a .note.gnu.build-id section.
1986 If this section is found, it extracts the value of the NT_GNU_BUILD_ID
1987 note, which should be a hexadecimal value @var{NNNN+NN} (for
1988 32+ hex digits). It then searches the filesystem for a file named
1989 @var{.build-id/NN/NN+NN.debug} in a set of standard locations,
1990 including the directory tree rooted at @var{dir}. The filename
1991 of the first matching file to be found is returned. A matching
1992 file should contain a .note.gnu.build-id section with the same
1993 @var{NNNN+NN} note as @var{abfd}, although this check is currently
1996 If @var{dir} is NULL, the search will take place starting at
1997 the current directory.
1999 Returns <<NULL>> on any errors or failure to locate the debug
2000 file, otherwise a pointer to a heap-allocated string
2001 containing the filename. The caller is responsible for
2002 freeing this string.
2006 bfd_follow_build_id_debuglink (bfd
*abfd
, const char *dir
)
2008 struct bfd_build_id
*build_id
;
2010 return find_separate_debug_file (abfd
, dir
, false,
2012 check_build_id_file
, &build_id
);
2020 const char *bfd_set_filename (bfd *abfd, const char *filename);
2023 Set the filename of @var{abfd}, copying the FILENAME parameter to
2024 bfd_alloc'd memory owned by @var{abfd}. Returns a pointer the
2025 newly allocated name, or NULL if the allocation failed.
2029 bfd_set_filename (bfd
*abfd
, const char *filename
)
2031 size_t len
= strlen (filename
) + 1;
2032 char *n
= bfd_alloc (abfd
, len
);
2037 if (abfd
->filename
!= NULL
)
2039 /* PR 29389. If we attempt to rename a file that has been closed due
2040 to caching, then we will not be able to reopen it later on. */
2041 if (abfd
->iostream
== NULL
&& (abfd
->flags
& BFD_CLOSED_BY_CACHE
))
2043 bfd_set_error (bfd_error_invalid_operation
);
2047 /* Similarly if we attempt to close a renamed file because the
2048 cache is now full, we will not be able to reopen it later on. */
2049 if (abfd
->iostream
!= NULL
)
2050 abfd
->cacheable
= 0;
2053 memcpy (n
, filename
, len
);