GDB (xrefs)
/tmp/gdb-7.10/gdb/gdb_bfd.h
Go to the documentation of this file.
1 /* Definitions for BFD wrappers used by GDB.
2 
3  Copyright (C) 2011-2015 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 /* If supplied a path starting with this sequence, gdb_bfd_open will
28  open BFDs using target fileio operations. */
29 
30 #define TARGET_SYSROOT_PREFIX "target:"
31 
32 /* Returns nonzero if NAME starts with TARGET_SYSROOT_PREFIX, zero
33  otherwise. */
34 
35 int is_target_filename (const char *name);
36 
37 /* Returns nonzero if the filename associated with ABFD starts with
38  TARGET_SYSROOT_PREFIX, zero otherwise. */
39 
40 int gdb_bfd_has_target_filename (struct bfd *abfd);
41 
42 /* Open a read-only (FOPEN_RB) BFD given arguments like bfd_fopen.
43  If NAME starts with TARGET_SYSROOT_PREFIX then the BFD will be
44  opened using target fileio operations if necessary. Returns NULL
45  on error. On success, returns a new reference to the BFD, which
46  must be freed with gdb_bfd_unref. BFDs returned by this call are
47  shared among all callers opening the same file. If FD is not -1,
48  then after this call it is owned by BFD. If the BFD was not
49  accessed using target fileio operations then the filename
50  associated with the BFD and accessible with bfd_get_filename will
51  not be exactly NAME but rather NAME with TARGET_SYSROOT_PREFIX
52  stripped. */
53 
54 struct bfd *gdb_bfd_open (const char *name, const char *target, int fd);
55 
56 /* Increment the reference count of ABFD. It is fine for ABFD to be
57  NULL; in this case the function does nothing. */
58 
59 void gdb_bfd_ref (struct bfd *abfd);
60 
61 /* Decrement the reference count of ABFD. If this is the last
62  reference, ABFD will be freed. If ABFD is NULL, this function does
63  nothing. */
64 
65 void gdb_bfd_unref (struct bfd *abfd);
66 
67 /* Mark the CHILD BFD as being a member of PARENT. Also, increment
68  the reference count of CHILD. Calling this function ensures that
69  as along as CHILD remains alive, PARENT will as well. Both CHILD
70  and PARENT must be non-NULL. This can be called more than once
71  with the same arguments; but it is not allowed to call it for a
72  single CHILD with different values for PARENT. */
73 
74 void gdb_bfd_mark_parent (bfd *child, bfd *parent);
75 
76 /* Mark INCLUDEE as being included by INCLUDER.
77  This is used to associate the life time of INCLUDEE with INCLUDER.
78  For example, with Fission, one file can refer to debug info in another
79  file, and internal tables we build for the main file (INCLUDER) may refer
80  to data contained in INCLUDEE. Therefore we want to keep INCLUDEE around
81  at least as long as INCLUDER exists.
82 
83  Note that this is different than gdb_bfd_mark_parent because in our case
84  lifetime tracking is based on the "parent" whereas in gdb_bfd_mark_parent
85  lifetime tracking is based on the "child". Plus in our case INCLUDEE could
86  have multiple different "parents". */
87 
88 void gdb_bfd_record_inclusion (bfd *includer, bfd *includee);
89 
90 /* Try to read or map the contents of the section SECT. If
91  successful, the section data is returned and *SIZE is set to the
92  size of the section data; this may not be the same as the size
93  according to bfd_get_section_size if the section was compressed.
94  The returned section data is associated with the BFD and will be
95  destroyed when the BFD is destroyed. There is no other way to free
96  it; for temporary uses of section data, see
97  bfd_malloc_and_get_section. SECT may not have relocations. This
98  function will throw on error. */
99 
100 const gdb_byte *gdb_bfd_map_section (asection *section, bfd_size_type *size);
101 
102 /* Compute the CRC for ABFD. The CRC is used to find and verify
103  separate debug files. When successful, this fills in *CRC_OUT and
104  returns 1. Otherwise, this issues a warning and returns 0. */
105 
106 int gdb_bfd_crc (struct bfd *abfd, unsigned long *crc_out);
107 
108 
109 
110 /* A wrapper for bfd_fopen that initializes the gdb-specific reference
111  count. */
112 
113 bfd *gdb_bfd_fopen (const char *, const char *, const char *, int);
114 
115 /* A wrapper for bfd_openr that initializes the gdb-specific reference
116  count. */
117 
118 bfd *gdb_bfd_openr (const char *, const char *);
119 
120 /* A wrapper for bfd_openw that initializes the gdb-specific reference
121  count. */
122 
123 bfd *gdb_bfd_openw (const char *, const char *);
124 
125 /* A wrapper for bfd_openr_iovec that initializes the gdb-specific
126  reference count. */
127 
128 bfd *gdb_bfd_openr_iovec (const char *filename, const char *target,
129  void *(*open_func) (struct bfd *nbfd,
130  void *open_closure),
131  void *open_closure,
132  file_ptr (*pread_func) (struct bfd *nbfd,
133  void *stream,
134  void *buf,
135  file_ptr nbytes,
136  file_ptr offset),
137  int (*close_func) (struct bfd *nbfd,
138  void *stream),
139  int (*stat_func) (struct bfd *abfd,
140  void *stream,
141  struct stat *sb));
142 
143 /* A wrapper for bfd_openr_next_archived_file that initializes the
144  gdb-specific reference count. */
145 
146 bfd *gdb_bfd_openr_next_archived_file (bfd *archive, bfd *previous);
147 
148 /* A wrapper for bfd_fdopenr that initializes the gdb-specific
149  reference count. */
150 
151 bfd *gdb_bfd_fdopenr (const char *filename, const char *target, int fd);
152 
153 
154 
155 /* Return the index of the BFD section SECTION. Ordinarily this is
156  just the section's index, but for some special sections, like
157  bfd_com_section_ptr, it will be a synthesized value. */
158 
159 int gdb_bfd_section_index (bfd *abfd, asection *section);
160 
161 
162 /* Like bfd_count_sections, but include any possible global sections,
163  like bfd_com_section_ptr. */
164 
165 int gdb_bfd_count_sections (bfd *abfd);
166 
167 /* Return true if any section requires relocations, false
168  otherwise. */
169 
170 int gdb_bfd_requires_relocations (bfd *abfd);
171 
172 #endif /* GDB_BFD_H */
int gdb_bfd_has_target_filename(struct bfd *abfd)
Definition: gdb_bfd.c:153
void gdb_bfd_mark_parent(bfd *child, bfd *parent)
Definition: gdb_bfd.c:743
int gdb_bfd_section_index(bfd *abfd, asection *section)
Definition: gdb_bfd.c:806
const gdb_byte * gdb_bfd_map_section(asection *section, bfd_size_type *size)
Definition: gdb_bfd.c:547
int gdb_bfd_crc(struct bfd *abfd, unsigned long *crc_out)
Definition: gdb_bfd.c:658
void gdb_bfd_record_inclusion(bfd *includer, bfd *includee)
Definition: gdb_bfd.c:777
void gdb_bfd_ref(struct bfd *abfd)
Definition: gdb_bfd.c:439
bfd * gdb_bfd_openr_iovec(const char *filename, const char *target, void *(*open_func)(struct bfd *nbfd, void *open_closure), void *open_closure, file_ptr(*pread_func)(struct bfd *nbfd, void *stream, void *buf, file_ptr nbytes, file_ptr offset), int(*close_func)(struct bfd *nbfd, void *stream), int(*stat_func)(struct bfd *abfd, void *stream, struct stat *sb))
bfd * gdb_bfd_openr_next_archived_file(bfd *archive, bfd *previous)
Definition: gdb_bfd.c:764
const char *const name
Definition: aarch64-tdep.c:68
bfd * gdb_bfd_fdopenr(const char *filename, const char *target, int fd)
Definition: gdb_bfd.c:789
struct bfd * gdb_bfd_open(const char *name, const char *target, int fd)
Definition: gdb_bfd.c:320
DECLARE_REGISTRY(bfd)
void gdb_bfd_unref(struct bfd *abfd)
Definition: gdb_bfd.c:475
bfd * gdb_bfd_openr(const char *, const char *)
Definition: gdb_bfd.c:689
bfd_byte gdb_byte
Definition: common-types.h:38
bfd * gdb_bfd_fopen(const char *, const char *, const char *, int)
Definition: gdb_bfd.c:675
int gdb_bfd_requires_relocations(bfd *abfd)
Definition: gdb_bfd.c:832
int is_target_filename(const char *name)
Definition: gdb_bfd.c:145
bfd * gdb_bfd_openw(const char *, const char *)
Definition: gdb_bfd.c:702
size_t size
Definition: go32-nat.c:242
int gdb_bfd_count_sections(bfd *abfd)
Definition: gdb_bfd.c:824