1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
/* Definitions for BFD wrappers used by GDB.
Copyright (C) 2011-2023 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef GDB_BFD_H
#define GDB_BFD_H
#include "registry.h"
#include "gdbsupport/byte-vector.h"
#include "gdbsupport/function-view.h"
#include "gdbsupport/gdb_ref_ptr.h"
#include "gdbsupport/iterator-range.h"
#include "gdbsupport/next-iterator.h"
/* A registry adaptor for BFD. This arranges to store the registry in
gdb's per-BFD data, which is stored as the bfd_usrdata. */
template<>
struct registry_accessor<bfd>
{
static registry<bfd> *get (bfd *abfd);
};
/* If supplied a path starting with this sequence, gdb_bfd_open will
open BFDs using target fileio operations. */
#define TARGET_SYSROOT_PREFIX "target:"
/* Returns nonzero if NAME starts with TARGET_SYSROOT_PREFIX, zero
otherwise. */
int is_target_filename (const char *name);
/* Returns nonzero if the filename associated with ABFD starts with
TARGET_SYSROOT_PREFIX, zero otherwise. */
int gdb_bfd_has_target_filename (struct bfd *abfd);
/* Increment the reference count of ABFD. It is fine for ABFD to be
NULL; in this case the function does nothing. */
void gdb_bfd_ref (struct bfd *abfd);
/* Decrement the reference count of ABFD. If this is the last
reference, ABFD will be freed. If ABFD is NULL, this function does
nothing. */
void gdb_bfd_unref (struct bfd *abfd);
/* A policy class for gdb::ref_ptr for BFD reference counting. */
struct gdb_bfd_ref_policy
{
static void incref (struct bfd *abfd)
{
gdb_bfd_ref (abfd);
}
static void decref (struct bfd *abfd)
{
gdb_bfd_unref (abfd);
}
};
/* A gdb::ref_ptr that has been specialized for BFD objects. */
typedef gdb::ref_ptr<struct bfd, gdb_bfd_ref_policy> gdb_bfd_ref_ptr;
/* Open a read-only (FOPEN_RB) BFD given arguments like bfd_fopen.
If NAME starts with TARGET_SYSROOT_PREFIX then the BFD will be
opened using target fileio operations if necessary. Returns NULL
on error. On success, returns a new reference to the BFD. BFDs
returned by this call are shared among all callers opening the same
file. If FD is not -1, then after this call it is owned by BFD.
If the BFD was not accessed using target fileio operations then the
filename associated with the BFD and accessible with
bfd_get_filename will not be exactly NAME but rather NAME with
TARGET_SYSROOT_PREFIX stripped. If WARN_IF_SLOW is true, print a
warning message if the file is being accessed over a link that may
be slow. */
gdb_bfd_ref_ptr gdb_bfd_open (const char *name, const char *target,
int fd = -1, bool warn_if_slow = true);
/* Mark the CHILD BFD as being a member of PARENT. Also, increment
the reference count of CHILD. Calling this function ensures that
as along as CHILD remains alive, PARENT will as well. Both CHILD
and PARENT must be non-NULL. This can be called more than once
with the same arguments; but it is not allowed to call it for a
single CHILD with different values for PARENT. */
void gdb_bfd_mark_parent (bfd *child, bfd *parent);
/* Mark INCLUDEE as being included by INCLUDER.
This is used to associate the life time of INCLUDEE with INCLUDER.
For example, with Fission, one file can refer to debug info in another
file, and internal tables we build for the main file (INCLUDER) may refer
to data contained in INCLUDEE. Therefore we want to keep INCLUDEE around
at least as long as INCLUDER exists.
Note that this is different than gdb_bfd_mark_parent because in our case
lifetime tracking is based on the "parent" whereas in gdb_bfd_mark_parent
lifetime tracking is based on the "child". Plus in our case INCLUDEE could
have multiple different "parents". */
void gdb_bfd_record_inclusion (bfd *includer, bfd *includee);
/* Try to read or map the contents of the section SECT. If successful, the
section data is returned and *SIZE is set to the size of the section data;
this may not be the same as the size according to bfd_section_size if the
section was compressed. The returned section data is associated with the BFD
and will be destroyed when the BFD is destroyed. There is no other way to
free it; for temporary uses of section data, see bfd_malloc_and_get_section.
SECT may not have relocations. If there is an error reading the section,
this issues a warning, sets *SIZE to 0, and returns NULL. */
const gdb_byte *gdb_bfd_map_section (asection *section, bfd_size_type *size);
/* Compute the CRC for ABFD. The CRC is used to find and verify
separate debug files. When successful, this fills in *CRC_OUT and
returns 1. Otherwise, this issues a warning and returns 0. */
int gdb_bfd_crc (struct bfd *abfd, unsigned long *crc_out);
/* A wrapper for bfd_fopen that initializes the gdb-specific reference
count. */
gdb_bfd_ref_ptr gdb_bfd_fopen (const char *, const char *, const char *, int);
/* A wrapper for bfd_openr that initializes the gdb-specific reference
count. */
gdb_bfd_ref_ptr gdb_bfd_openr (const char *, const char *);
/* A wrapper for bfd_openw that initializes the gdb-specific reference
count. */
gdb_bfd_ref_ptr gdb_bfd_openw (const char *, const char *);
/* The base class for BFD "iovec" implementations. This is used by
gdb_bfd_openr_iovec and enables better type safety. */
class gdb_bfd_iovec_base
{
protected:
gdb_bfd_iovec_base () = default;
public:
virtual ~gdb_bfd_iovec_base () = default;
/* The "read" callback. */
virtual file_ptr read (bfd *abfd, void *buffer, file_ptr nbytes,
file_ptr offset) = 0;
/* The "stat" callback. */
virtual int stat (struct bfd *abfd, struct stat *sb) = 0;
};
/* The type of the function used to open a new iovec-based BFD. */
using gdb_iovec_opener_ftype
= gdb::function_view<gdb_bfd_iovec_base * (bfd *)>;
/* A type-safe wrapper for bfd_openr_iovec. */
gdb_bfd_ref_ptr gdb_bfd_openr_iovec (const char *filename, const char *target,
gdb_iovec_opener_ftype open_fn);
/* A wrapper for bfd_openr_next_archived_file that initializes the
gdb-specific reference count. */
gdb_bfd_ref_ptr gdb_bfd_openr_next_archived_file (bfd *archive, bfd *previous);
/* Return the index of the BFD section SECTION. Ordinarily this is
just the section's index, but for some special sections, like
bfd_com_section_ptr, it will be a synthesized value. */
int gdb_bfd_section_index (bfd *abfd, asection *section);
/* Like bfd_count_sections, but include any possible global sections,
like bfd_com_section_ptr. */
int gdb_bfd_count_sections (bfd *abfd);
/* Return true if any section requires relocations, false
otherwise. */
int gdb_bfd_requires_relocations (bfd *abfd);
/* Alternative to bfd_get_full_section_contents that returns the section
contents in *CONTENTS, instead of an allocated buffer.
Return true on success, false otherwise. */
bool gdb_bfd_get_full_section_contents (bfd *abfd, asection *section,
gdb::byte_vector *contents);
/* Create and initialize a BFD handle from a target in-memory range. The
BFD starts at ADDR and is SIZE bytes long. TARGET is the BFD target
name as used in bfd_find_target. */
gdb_bfd_ref_ptr gdb_bfd_open_from_target_memory (CORE_ADDR addr, ULONGEST size,
const char *target);
/* Range adapter for a BFD's sections.
To be used as:
for (asection *sect : gdb_bfd_all_sections (bfd))
... use SECT ...
*/
using gdb_bfd_section_range = next_range<asection>;
static inline gdb_bfd_section_range
gdb_bfd_sections (bfd *abfd)
{
return gdb_bfd_section_range (abfd->sections);
}
static inline gdb_bfd_section_range
gdb_bfd_sections (const gdb_bfd_ref_ptr &abfd)
{
return gdb_bfd_section_range (abfd->sections);
};
/* A wrapper for bfd_errmsg to produce a more helpful error message
in the case of bfd_error_file_ambiguously recognized.
MATCHING, if non-NULL, is the corresponding argument to
bfd_check_format_matches, and will be freed. */
extern std::string gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
#endif /* GDB_BFD_H */
|
