projects / deliverable / binutils-gdb.git / blame
| Commit | Line | Data |
|---|---|---|
| cbb099e8 TT |
1 | /* Definitions for BFD wrappers used by GDB. |
| 2 | ||
| 4bf44c1c | 3 | Copyright (C) 2011, 2012 |
| cbb099e8 TT |
4 | Free Software Foundation, Inc. |
| 5 | ||
| 6 | This file is part of GDB. | |
| 7 | ||
| 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. | |
| 12 | ||
| 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. | |
| 17 | ||
| 18 | You should have received a copy of the GNU General Public License | |
| 19 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ | |
| 20 | ||
| 21 | #ifndef GDB_BFD_H | |
| 22 | #define GDB_BFD_H | |
| 23 | ||
| e992eda4 TT |
24 | #include "registry.h" |
| 25 | ||
| 26 | DECLARE_REGISTRY (bfd); | |
| 27 | ||
| a4453b7e TT |
28 | /* Make a copy ABFD's filename using bfd_alloc, and reassign it to the |
| 29 | BFD. This ensures that the BFD's filename has the same lifetime as | |
| 30 | the BFD itself. */ | |
| 31 | ||
| 32 | void gdb_bfd_stash_filename (struct bfd *abfd); | |
| 33 | ||
| 6ec53d05 TT |
34 | /* Open a read-only (FOPEN_RB) BFD given arguments like bfd_fopen. |
| 35 | Returns NULL on error. On success, returns a new reference to the | |
| 36 | BFD, which must be freed with gdb_bfd_unref. BFDs returned by this | |
| 37 | call are shared among all callers opening the same file. If FD is | |
| 38 | not -1, then after this call it is owned by BFD. */ | |
| 39 | ||
| 40 | struct bfd *gdb_bfd_open (const char *name, const char *target, int fd); | |
| 41 | ||
| 520b0001 TT |
42 | /* Increment the reference count of ABFD. It is fine for ABFD to be |
| 43 | NULL; in this case the function does nothing. */ | |
| cbb099e8 | 44 | |
| 520b0001 | 45 | void gdb_bfd_ref (struct bfd *abfd); |
| cbb099e8 | 46 | |
| 520b0001 TT |
47 | /* Decrement the reference count of ABFD. If this is the last |
| 48 | reference, ABFD will be freed. If ABFD is NULL, this function does | |
| 49 | nothing. */ | |
| cbb099e8 TT |
50 | |
| 51 | void gdb_bfd_unref (struct bfd *abfd); | |
| 52 | ||
| 0cd61f44 TT |
53 | /* Mark the CHILD BFD as being a member of PARENT. Also, increment |
| 54 | the reference count of CHILD. Calling this function ensures that | |
| 55 | as along as CHILD remains alive, PARENT will as well. Both CHILD | |
| 56 | and PARENT must be non-NULL. This can be called more than once | |
| 57 | with the same arguments; but it is not allowed to call it for a | |
| 58 | single CHILD with different values for PARENT. */ | |
| 59 | ||
| 60 | void gdb_bfd_mark_parent (bfd *child, bfd *parent); | |
| 61 | ||
| 4bf44c1c TT |
62 | /* Try to read or map the contents of the section SECT. If |
| 63 | successful, the section data is returned and *SIZE is set to the | |
| 64 | size of the section data; this may not be the same as the size | |
| 65 | according to bfd_get_section_size if the section was compressed. | |
| 66 | The returned section data is associated with the BFD and will be | |
| 67 | destroyed when the BFD is destroyed. There is no other way to free | |
| 68 | it; for temporary uses of section data, see | |
| 69 | bfd_malloc_and_get_section. SECT may not have relocations. This | |
| 70 | function will throw on error. */ | |
| 71 | ||
| 72 | const gdb_byte *gdb_bfd_map_section (asection *section, bfd_size_type *size); | |
| 73 | ||
| 64c31149 TT |
74 | \f |
| 75 | ||
| 76 | /* A wrapper for bfd_fopen that initializes the gdb-specific reference | |
| 77 | count and calls gdb_bfd_stash_filename. */ | |
| 78 | ||
| 79 | bfd *gdb_bfd_fopen (const char *, const char *, const char *, int); | |
| 80 | ||
| 81 | /* A wrapper for bfd_openr that initializes the gdb-specific reference | |
| 82 | count and calls gdb_bfd_stash_filename. */ | |
| 83 | ||
| 84 | bfd *gdb_bfd_openr (const char *, const char *); | |
| 85 | ||
| 86 | /* A wrapper for bfd_openw that initializes the gdb-specific reference | |
| 87 | count and calls gdb_bfd_stash_filename. */ | |
| 88 | ||
| 89 | bfd *gdb_bfd_openw (const char *, const char *); | |
| 90 | ||
| 91 | /* A wrapper for bfd_openr_iovec that initializes the gdb-specific | |
| 92 | reference count and calls gdb_bfd_stash_filename. */ | |
| 93 | ||
| 94 | bfd *gdb_bfd_openr_iovec (const char *filename, const char *target, | |
| 95 | void *(*open_func) (struct bfd *nbfd, | |
| 96 | void *open_closure), | |
| 97 | void *open_closure, | |
| 98 | file_ptr (*pread_func) (struct bfd *nbfd, | |
| 99 | void *stream, | |
| 100 | void *buf, | |
| 101 | file_ptr nbytes, | |
| 102 | file_ptr offset), | |
| 103 | int (*close_func) (struct bfd *nbfd, | |
| 104 | void *stream), | |
| 105 | int (*stat_func) (struct bfd *abfd, | |
| 106 | void *stream, | |
| 107 | struct stat *sb)); | |
| 108 | ||
| 109 | /* A wrapper for bfd_openr_next_archived_file that initializes the | |
| 110 | gdb-specific reference count and calls gdb_bfd_stash_filename. */ | |
| 111 | ||
| 112 | bfd *gdb_bfd_openr_next_archived_file (bfd *archive, bfd *previous); | |
| 113 | ||
| 114 | /* A wrapper for bfd_fdopenr that initializes the gdb-specific | |
| 115 | reference count and calls gdb_bfd_stash_filename. */ | |
| 116 | ||
| 117 | bfd *gdb_bfd_fdopenr (const char *filename, const char *target, int fd); | |
| 118 | ||
| cbb099e8 | 119 | #endif /* GDB_BFD_H */ |