| 1 | /* Definitions for BFD wrappers used by GDB. |
| 2 | |
| 3 | Copyright (C) 2011-2013 Free Software Foundation, Inc. |
| 4 | |
| 5 | This file is part of GDB. |
| 6 | |
| 7 | This program is free software; you can redistribute it and/or modify |
| 8 | it under the terms of the GNU General Public License as published by |
| 9 | the Free Software Foundation; either version 3 of the License, or |
| 10 | (at your option) any later version. |
| 11 | |
| 12 | This program is distributed in the hope that it will be useful, |
| 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | GNU General Public License for more details. |
| 16 | |
| 17 | You should have received a copy of the GNU General Public License |
| 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
| 19 | |
| 20 | #ifndef GDB_BFD_H |
| 21 | #define GDB_BFD_H |
| 22 | |
| 23 | #include "registry.h" |
| 24 | |
| 25 | DECLARE_REGISTRY (bfd); |
| 26 | |
| 27 | /* Make a copy ABFD's filename using bfd_alloc, and reassign it to the |
| 28 | BFD. This ensures that the BFD's filename has the same lifetime as |
| 29 | the BFD itself. */ |
| 30 | |
| 31 | void gdb_bfd_stash_filename (struct bfd *abfd); |
| 32 | |
| 33 | /* Open a read-only (FOPEN_RB) BFD given arguments like bfd_fopen. |
| 34 | Returns NULL on error. On success, returns a new reference to the |
| 35 | BFD, which must be freed with gdb_bfd_unref. BFDs returned by this |
| 36 | call are shared among all callers opening the same file. If FD is |
| 37 | not -1, then after this call it is owned by BFD. */ |
| 38 | |
| 39 | struct bfd *gdb_bfd_open (const char *name, const char *target, int fd); |
| 40 | |
| 41 | /* Increment the reference count of ABFD. It is fine for ABFD to be |
| 42 | NULL; in this case the function does nothing. */ |
| 43 | |
| 44 | void gdb_bfd_ref (struct bfd *abfd); |
| 45 | |
| 46 | /* Decrement the reference count of ABFD. If this is the last |
| 47 | reference, ABFD will be freed. If ABFD is NULL, this function does |
| 48 | nothing. */ |
| 49 | |
| 50 | void gdb_bfd_unref (struct bfd *abfd); |
| 51 | |
| 52 | /* Mark the CHILD BFD as being a member of PARENT. Also, increment |
| 53 | the reference count of CHILD. Calling this function ensures that |
| 54 | as along as CHILD remains alive, PARENT will as well. Both CHILD |
| 55 | and PARENT must be non-NULL. This can be called more than once |
| 56 | with the same arguments; but it is not allowed to call it for a |
| 57 | single CHILD with different values for PARENT. */ |
| 58 | |
| 59 | void gdb_bfd_mark_parent (bfd *child, bfd *parent); |
| 60 | |
| 61 | /* Try to read or map the contents of the section SECT. If |
| 62 | successful, the section data is returned and *SIZE is set to the |
| 63 | size of the section data; this may not be the same as the size |
| 64 | according to bfd_get_section_size if the section was compressed. |
| 65 | The returned section data is associated with the BFD and will be |
| 66 | destroyed when the BFD is destroyed. There is no other way to free |
| 67 | it; for temporary uses of section data, see |
| 68 | bfd_malloc_and_get_section. SECT may not have relocations. This |
| 69 | function will throw on error. */ |
| 70 | |
| 71 | const gdb_byte *gdb_bfd_map_section (asection *section, bfd_size_type *size); |
| 72 | |
| 73 | /* Compute the CRC for ABFD. The CRC is used to find and verify |
| 74 | separate debug files. When successful, this fills in *CRC_OUT and |
| 75 | returns 1. Otherwise, this issues a warning and returns 0. */ |
| 76 | |
| 77 | int gdb_bfd_crc (struct bfd *abfd, unsigned long *crc_out); |
| 78 | |
| 79 | \f |
| 80 | |
| 81 | /* A wrapper for bfd_fopen that initializes the gdb-specific reference |
| 82 | count and calls gdb_bfd_stash_filename. */ |
| 83 | |
| 84 | bfd *gdb_bfd_fopen (const char *, const char *, const char *, int); |
| 85 | |
| 86 | /* A wrapper for bfd_openr that initializes the gdb-specific reference |
| 87 | count and calls gdb_bfd_stash_filename. */ |
| 88 | |
| 89 | bfd *gdb_bfd_openr (const char *, const char *); |
| 90 | |
| 91 | /* A wrapper for bfd_openw that initializes the gdb-specific reference |
| 92 | count and calls gdb_bfd_stash_filename. */ |
| 93 | |
| 94 | bfd *gdb_bfd_openw (const char *, const char *); |
| 95 | |
| 96 | /* A wrapper for bfd_openr_iovec that initializes the gdb-specific |
| 97 | reference count and calls gdb_bfd_stash_filename. */ |
| 98 | |
| 99 | bfd *gdb_bfd_openr_iovec (const char *filename, const char *target, |
| 100 | void *(*open_func) (struct bfd *nbfd, |
| 101 | void *open_closure), |
| 102 | void *open_closure, |
| 103 | file_ptr (*pread_func) (struct bfd *nbfd, |
| 104 | void *stream, |
| 105 | void *buf, |
| 106 | file_ptr nbytes, |
| 107 | file_ptr offset), |
| 108 | int (*close_func) (struct bfd *nbfd, |
| 109 | void *stream), |
| 110 | int (*stat_func) (struct bfd *abfd, |
| 111 | void *stream, |
| 112 | struct stat *sb)); |
| 113 | |
| 114 | /* A wrapper for bfd_openr_next_archived_file that initializes the |
| 115 | gdb-specific reference count and calls gdb_bfd_stash_filename. */ |
| 116 | |
| 117 | bfd *gdb_bfd_openr_next_archived_file (bfd *archive, bfd *previous); |
| 118 | |
| 119 | /* A wrapper for bfd_fdopenr that initializes the gdb-specific |
| 120 | reference count and calls gdb_bfd_stash_filename. */ |
| 121 | |
| 122 | bfd *gdb_bfd_fdopenr (const char *filename, const char *target, int fd); |
| 123 | |
| 124 | \f |
| 125 | |
| 126 | /* Return the index of the BFD section SECTION. Ordinarily this is |
| 127 | just the section's index, but for some special sections, like |
| 128 | bfd_com_section_ptr, it will be a synthesized value. */ |
| 129 | |
| 130 | int gdb_bfd_section_index (bfd *abfd, asection *section); |
| 131 | |
| 132 | |
| 133 | /* Like bfd_count_sections, but include any possible global sections, |
| 134 | like bfd_com_section_ptr. */ |
| 135 | |
| 136 | int gdb_bfd_count_sections (bfd *abfd); |
| 137 | |
| 138 | /* Return true if any section requires relocations, false |
| 139 | otherwise. */ |
| 140 | |
| 141 | int gdb_bfd_requires_relocations (bfd *abfd); |
| 142 | |
| 143 | #endif /* GDB_BFD_H */ |