1 /* Definitions for BFD wrappers used by GDB.
3 Copyright (C) 2011-2014 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "filestuff.h"
34 #define MAP_FAILED ((void *) -1)
41 /* An object of this type is stored in the section's user data when
44 struct gdb_bfd_section_data
46 /* Size of the data. */
48 /* If the data was mmapped, this is the length of the map. */
49 bfd_size_type map_len
;
50 /* The data. If NULL, the section data has not been read. */
52 /* If the data was mmapped, this is the map address. */
56 /* A hash table holding every BFD that gdb knows about. This is not
57 to be confused with 'gdb_bfd_cache', which is used for sharing
58 BFDs; in contrast, this hash is used just to implement
61 static htab_t all_bfds
;
63 /* An object of this type is stored in each BFD's user data. */
67 /* The reference count. */
70 /* The mtime of the BFD at the point the cache entry was made. */
73 /* This is true if we have determined whether this BFD has any
74 sections requiring relocation. */
75 unsigned int relocation_computed
: 1;
77 /* This is true if any section needs relocation. */
78 unsigned int needs_relocations
: 1;
80 /* This is true if we have successfully computed the file's CRC. */
81 unsigned int crc_computed
: 1;
86 /* If the BFD comes from an archive, this points to the archive's
87 BFD. Otherwise, this is NULL. */
90 /* Table of all the bfds this bfd has included. */
91 VEC (bfdp
) *included_bfds
;
97 #define GDB_BFD_DATA_ACCESSOR(ABFD) \
98 ((struct gdb_bfd_data *) bfd_usrdata (ABFD))
100 DEFINE_REGISTRY (bfd
, GDB_BFD_DATA_ACCESSOR
)
102 /* A hash table storing all the BFDs maintained in the cache. */
104 static htab_t gdb_bfd_cache
;
106 /* The type of an object being looked up in gdb_bfd_cache. We use
107 htab's capability of storing one kind of object (BFD in this case)
108 and using a different sort of object for searching. */
110 struct gdb_bfd_cache_search
113 const char *filename
;
118 /* A hash function for BFDs. */
121 hash_bfd (const void *b
)
125 /* It is simplest to just hash the filename. */
126 return htab_hash_string (bfd_get_filename (abfd
));
129 /* An equality function for BFDs. Note that this expects the caller
130 to search using struct gdb_bfd_cache_search only, not BFDs. */
133 eq_bfd (const void *a
, const void *b
)
136 const struct gdb_bfd_cache_search
*s
= b
;
137 struct gdb_bfd_data
*gdata
= bfd_usrdata (abfd
);
139 return (gdata
->mtime
== s
->mtime
140 && strcmp (bfd_get_filename (abfd
), s
->filename
) == 0);
146 gdb_bfd_open (const char *name
, const char *target
, int fd
)
151 struct gdb_bfd_cache_search search
;
154 if (gdb_bfd_cache
== NULL
)
155 gdb_bfd_cache
= htab_create_alloc (1, hash_bfd
, eq_bfd
, NULL
,
160 fd
= gdb_open_cloexec (name
, O_RDONLY
| O_BINARY
, 0);
163 bfd_set_error (bfd_error_system_call
);
168 search
.filename
= name
;
169 if (fstat (fd
, &st
) < 0)
171 /* Weird situation here. */
175 search
.mtime
= st
.st_mtime
;
177 /* Note that this must compute the same result as hash_bfd. */
178 hash
= htab_hash_string (name
);
179 /* Note that we cannot use htab_find_slot_with_hash here, because
180 opening the BFD may fail; and this would violate hashtab
182 abfd
= htab_find_with_hash (gdb_bfd_cache
, &search
, hash
);
190 abfd
= bfd_fopen (name
, target
, FOPEN_RB
, fd
);
194 slot
= htab_find_slot_with_hash (gdb_bfd_cache
, &search
, hash
, INSERT
);
202 /* A helper function that releases any section data attached to the
206 free_one_bfd_section (bfd
*abfd
, asection
*sectp
, void *ignore
)
208 struct gdb_bfd_section_data
*sect
= bfd_get_section_userdata (abfd
, sectp
);
210 if (sect
!= NULL
&& sect
->data
!= NULL
)
213 if (sect
->map_addr
!= NULL
)
217 res
= munmap (sect
->map_addr
, sect
->map_len
);
218 gdb_assert (res
== 0);
226 /* Close ABFD, and warn if that fails. */
229 gdb_bfd_close_or_warn (struct bfd
*abfd
)
232 char *name
= bfd_get_filename (abfd
);
234 bfd_map_over_sections (abfd
, free_one_bfd_section
, NULL
);
236 ret
= bfd_close (abfd
);
239 warning (_("cannot close \"%s\": %s"),
240 name
, bfd_errmsg (bfd_get_error ()));
248 gdb_bfd_ref (struct bfd
*abfd
)
250 struct gdb_bfd_data
*gdata
;
256 gdata
= bfd_usrdata (abfd
);
264 /* Ask BFD to decompress sections in bfd_get_full_section_contents. */
265 abfd
->flags
|= BFD_DECOMPRESS
;
267 gdata
= bfd_zalloc (abfd
, sizeof (struct gdb_bfd_data
));
269 gdata
->mtime
= bfd_get_mtime (abfd
);
270 gdata
->archive_bfd
= NULL
;
271 bfd_usrdata (abfd
) = gdata
;
273 bfd_alloc_data (abfd
);
275 /* This is the first we've seen it, so add it to the hash table. */
276 slot
= htab_find_slot (all_bfds
, abfd
, INSERT
);
277 gdb_assert (slot
&& !*slot
);
284 gdb_bfd_unref (struct bfd
*abfd
)
287 struct gdb_bfd_data
*gdata
;
288 struct gdb_bfd_cache_search search
;
289 bfd
*archive_bfd
, *included_bfd
;
294 gdata
= bfd_usrdata (abfd
);
295 gdb_assert (gdata
->refc
>= 1);
301 archive_bfd
= gdata
->archive_bfd
;
302 search
.filename
= bfd_get_filename (abfd
);
304 if (gdb_bfd_cache
&& search
.filename
)
306 hashval_t hash
= htab_hash_string (search
.filename
);
309 search
.mtime
= gdata
->mtime
;
310 slot
= htab_find_slot_with_hash (gdb_bfd_cache
, &search
, hash
,
314 htab_clear_slot (gdb_bfd_cache
, slot
);
318 VEC_iterate (bfdp
, gdata
->included_bfds
, ix
, included_bfd
);
320 gdb_bfd_unref (included_bfd
);
321 VEC_free (bfdp
, gdata
->included_bfds
);
323 bfd_free_data (abfd
);
324 bfd_usrdata (abfd
) = NULL
; /* Paranoia. */
326 htab_remove_elt (all_bfds
, abfd
);
328 gdb_bfd_close_or_warn (abfd
);
330 gdb_bfd_unref (archive_bfd
);
333 /* A helper function that returns the section data descriptor
334 associated with SECTION. If no such descriptor exists, a new one
335 is allocated and cleared. */
337 static struct gdb_bfd_section_data
*
338 get_section_descriptor (asection
*section
)
340 struct gdb_bfd_section_data
*result
;
342 result
= bfd_get_section_userdata (section
->owner
, section
);
346 result
= bfd_zalloc (section
->owner
, sizeof (*result
));
347 bfd_set_section_userdata (section
->owner
, section
, result
);
356 gdb_bfd_map_section (asection
*sectp
, bfd_size_type
*size
)
359 struct gdb_bfd_section_data
*descriptor
;
362 gdb_assert ((sectp
->flags
& SEC_RELOC
) == 0);
363 gdb_assert (size
!= NULL
);
367 descriptor
= get_section_descriptor (sectp
);
369 /* If the data was already read for this BFD, just reuse it. */
370 if (descriptor
->data
!= NULL
)
374 if (!bfd_is_section_compressed (abfd
, sectp
))
376 /* The page size, used when mmapping. */
380 pagesize
= getpagesize ();
382 /* Only try to mmap sections which are large enough: we don't want
383 to waste space due to fragmentation. */
385 if (bfd_get_section_size (sectp
) > 4 * pagesize
)
387 descriptor
->size
= bfd_get_section_size (sectp
);
388 descriptor
->data
= bfd_mmap (abfd
, 0, descriptor
->size
, PROT_READ
,
389 MAP_PRIVATE
, sectp
->filepos
,
390 &descriptor
->map_addr
,
391 &descriptor
->map_len
);
393 if ((caddr_t
)descriptor
->data
!= MAP_FAILED
)
395 #if HAVE_POSIX_MADVISE
396 posix_madvise (descriptor
->map_addr
, descriptor
->map_len
,
397 POSIX_MADV_WILLNEED
);
402 /* On failure, clear out the section data and try again. */
403 memset (descriptor
, 0, sizeof (*descriptor
));
406 #endif /* HAVE_MMAP */
408 /* Handle compressed sections, or ordinary uncompressed sections in
411 descriptor
->size
= bfd_get_section_size (sectp
);
412 descriptor
->data
= NULL
;
415 if (!bfd_get_full_section_contents (abfd
, sectp
, &data
))
416 error (_("Can't read data for section '%s' in file '%s'"),
417 bfd_get_section_name (abfd
, sectp
),
418 bfd_get_filename (abfd
));
419 descriptor
->data
= data
;
422 gdb_assert (descriptor
->data
!= NULL
);
423 *size
= descriptor
->size
;
424 return descriptor
->data
;
427 /* Return 32-bit CRC for ABFD. If successful store it to *FILE_CRC_RETURN and
428 return 1. Otherwise print a warning and return 0. ABFD seek position is
432 get_file_crc (bfd
*abfd
, unsigned long *file_crc_return
)
434 unsigned long file_crc
= 0;
436 if (bfd_seek (abfd
, 0, SEEK_SET
) != 0)
438 warning (_("Problem reading \"%s\" for CRC: %s"),
439 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
445 gdb_byte buffer
[8 * 1024];
448 count
= bfd_bread (buffer
, sizeof (buffer
), abfd
);
449 if (count
== (bfd_size_type
) -1)
451 warning (_("Problem reading \"%s\" for CRC: %s"),
452 bfd_get_filename (abfd
), bfd_errmsg (bfd_get_error ()));
457 file_crc
= bfd_calc_gnu_debuglink_crc32 (file_crc
, buffer
, count
);
460 *file_crc_return
= file_crc
;
467 gdb_bfd_crc (struct bfd
*abfd
, unsigned long *crc_out
)
469 struct gdb_bfd_data
*gdata
= bfd_usrdata (abfd
);
471 if (!gdata
->crc_computed
)
472 gdata
->crc_computed
= get_file_crc (abfd
, &gdata
->crc
);
474 if (gdata
->crc_computed
)
475 *crc_out
= gdata
->crc
;
476 return gdata
->crc_computed
;
484 gdb_bfd_fopen (const char *filename
, const char *target
, const char *mode
,
487 bfd
*result
= bfd_fopen (filename
, target
, mode
, fd
);
490 gdb_bfd_ref (result
);
498 gdb_bfd_openr (const char *filename
, const char *target
)
500 bfd
*result
= bfd_openr (filename
, target
);
503 gdb_bfd_ref (result
);
511 gdb_bfd_openw (const char *filename
, const char *target
)
513 bfd
*result
= bfd_openw (filename
, target
);
516 gdb_bfd_ref (result
);
524 gdb_bfd_openr_iovec (const char *filename
, const char *target
,
525 void *(*open_func
) (struct bfd
*nbfd
,
528 file_ptr (*pread_func
) (struct bfd
*nbfd
,
533 int (*close_func
) (struct bfd
*nbfd
,
535 int (*stat_func
) (struct bfd
*abfd
,
539 bfd
*result
= bfd_openr_iovec (filename
, target
,
540 open_func
, open_closure
,
541 pread_func
, close_func
, stat_func
);
544 gdb_bfd_ref (result
);
552 gdb_bfd_mark_parent (bfd
*child
, bfd
*parent
)
554 struct gdb_bfd_data
*gdata
;
557 /* No need to stash the filename here, because we also keep a
558 reference on the parent archive. */
560 gdata
= bfd_usrdata (child
);
561 if (gdata
->archive_bfd
== NULL
)
563 gdata
->archive_bfd
= parent
;
564 gdb_bfd_ref (parent
);
567 gdb_assert (gdata
->archive_bfd
== parent
);
573 gdb_bfd_openr_next_archived_file (bfd
*archive
, bfd
*previous
)
575 bfd
*result
= bfd_openr_next_archived_file (archive
, previous
);
578 gdb_bfd_mark_parent (result
, archive
);
586 gdb_bfd_record_inclusion (bfd
*includer
, bfd
*includee
)
588 struct gdb_bfd_data
*gdata
;
590 gdb_bfd_ref (includee
);
591 gdata
= bfd_usrdata (includer
);
592 VEC_safe_push (bfdp
, gdata
->included_bfds
, includee
);
598 gdb_bfd_fdopenr (const char *filename
, const char *target
, int fd
)
600 bfd
*result
= bfd_fdopenr (filename
, target
, fd
);
603 gdb_bfd_ref (result
);
610 gdb_static_assert (ARRAY_SIZE (_bfd_std_section
) == 4);
615 gdb_bfd_section_index (bfd
*abfd
, asection
*section
)
619 else if (section
== bfd_com_section_ptr
)
620 return bfd_count_sections (abfd
) + 1;
621 else if (section
== bfd_und_section_ptr
)
622 return bfd_count_sections (abfd
) + 2;
623 else if (section
== bfd_abs_section_ptr
)
624 return bfd_count_sections (abfd
) + 3;
625 else if (section
== bfd_ind_section_ptr
)
626 return bfd_count_sections (abfd
) + 4;
627 return section
->index
;
633 gdb_bfd_count_sections (bfd
*abfd
)
635 return bfd_count_sections (abfd
) + 4;
641 gdb_bfd_requires_relocations (bfd
*abfd
)
643 struct gdb_bfd_data
*gdata
= bfd_usrdata (abfd
);
645 if (gdata
->relocation_computed
== 0)
649 for (sect
= abfd
->sections
; sect
!= NULL
; sect
= sect
->next
)
650 if ((sect
->flags
& SEC_RELOC
) != 0)
652 gdata
->needs_relocations
= 1;
656 gdata
->relocation_computed
= 1;
659 return gdata
->needs_relocations
;
664 /* A callback for htab_traverse that prints a single BFD. */
667 print_one_bfd (void **slot
, void *data
)
670 struct gdb_bfd_data
*gdata
= bfd_usrdata (abfd
);
671 struct ui_out
*uiout
= data
;
672 struct cleanup
*inner
;
674 inner
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
675 ui_out_field_int (uiout
, "refcount", gdata
->refc
);
676 ui_out_field_string (uiout
, "addr", host_address_to_string (abfd
));
677 ui_out_field_string (uiout
, "filename", bfd_get_filename (abfd
));
678 ui_out_text (uiout
, "\n");
684 /* Implement the 'maint info bfd' command. */
687 maintenance_info_bfds (char *arg
, int from_tty
)
689 struct cleanup
*cleanup
;
690 struct ui_out
*uiout
= current_uiout
;
692 cleanup
= make_cleanup_ui_out_table_begin_end (uiout
, 3, -1, "bfds");
693 ui_out_table_header (uiout
, 10, ui_left
, "refcount", "Refcount");
694 ui_out_table_header (uiout
, 18, ui_left
, "addr", "Address");
695 ui_out_table_header (uiout
, 40, ui_left
, "filename", "Filename");
697 ui_out_table_body (uiout
);
698 htab_traverse (all_bfds
, print_one_bfd
, uiout
);
700 do_cleanups (cleanup
);
703 /* -Wmissing-prototypes */
704 extern initialize_file_ftype _initialize_gdb_bfd
;
707 _initialize_gdb_bfd (void)
709 all_bfds
= htab_create_alloc (10, htab_hash_pointer
, htab_eq_pointer
,
710 NULL
, xcalloc
, xfree
);
712 add_cmd ("bfds", class_maintenance
, maintenance_info_bfds
, _("\
713 List the BFDs that are currently open."),
714 &maintenanceinfolist
);