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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
/* Macros for general registry objects.
Copyright (C) 2011-2019 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 REGISTRY_H
#define REGISTRY_H
#include <type_traits>
/* The macros here implement a template type and functions for
associating some user data with a container object.
A registry is associated with a struct tag name. To attach a
registry to a structure, use DEFINE_REGISTRY. This takes the
structure tag and an access method as arguments. In the usual
case, where the registry fields appear directly in the struct, you
can use the 'REGISTRY_FIELDS' macro to declare the fields in the
struct definition, and you can pass 'REGISTRY_ACCESS_FIELD' as the
access argument to DEFINE_REGISTRY. In other cases, use
REGISTRY_FIELDS to define the fields in the appropriate spot, and
then define your own accessor to find the registry field structure
given an instance of your type.
The API user requests a key from a registry during gdb
initialization. Later this key can be used to associate some
module-specific data with a specific container object.
The exported API is best used via the wrapper macros:
- register_TAG_data(TAG)
Get a new key for the container type TAG.
- register_TAG_data_with_cleanup(TAG, SAVE, FREE)
Get a new key for the container type TAG.
SAVE and FREE are defined as void (*) (struct TAG *object, void *data)
When the container object OBJECT is destroyed, first all registered SAVE
functions are called.
Then all FREE functions are called.
Either or both may be NULL. DATA is the data associated with the
container object OBJECT.
- clear_TAG_data(TAG, OBJECT)
Clear all the data associated with OBJECT. Should be called by the
container implementation when a container object is destroyed.
- set_TAG_data(TAG, OBJECT, KEY, DATA)
Set the data on an object.
- TAG_data(TAG, OBJECT, KEY)
Fetch the data for an object; returns NULL if it has not been set.
*/
/* This structure is used in a container to hold the data that the
registry uses. */
struct registry_fields
{
void **data;
unsigned num_data;
};
/* This macro is used in a container struct definition to define the
fields used by the registry code. */
#define REGISTRY_FIELDS \
struct registry_fields registry_data
/* A convenience macro for the typical case where the registry data is
kept as fields of the object. This can be passed as the ACCESS
method to DEFINE_REGISTRY. */
#define REGISTRY_ACCESS_FIELD(CONTAINER) \
(CONTAINER)
/* Opaque type representing a container type with a registry. This
type is never defined. This is used to factor out common
functionality of all struct tag names into common code. IOW,
"struct tag name" pointers are cast to and from "struct
registry_container" pointers when calling the common registry
"backend" functions. */
struct registry_container;
/* Registry callbacks have this type. */
typedef void (*registry_data_callback) (struct registry_container *, void *);
struct registry_data
{
unsigned index;
registry_data_callback save;
registry_data_callback free;
};
struct registry_data_registration
{
struct registry_data *data;
struct registry_data_registration *next;
};
struct registry_data_registry
{
struct registry_data_registration *registrations;
unsigned num_registrations;
};
/* Registry backend functions. Client code uses the frontend
functions defined by DEFINE_REGISTRY below instead. */
const struct registry_data *register_data_with_cleanup
(struct registry_data_registry *registry,
registry_data_callback save,
registry_data_callback free);
void registry_alloc_data (struct registry_data_registry *registry,
struct registry_fields *registry_fields);
/* Cast FUNC and CONTAINER to the real types, and call FUNC, also
passing DATA. */
typedef void (*registry_callback_adaptor) (registry_data_callback func,
struct registry_container *container,
void *data);
void registry_clear_data (struct registry_data_registry *data_registry,
registry_callback_adaptor adaptor,
struct registry_container *container,
struct registry_fields *fields);
void registry_container_free_data (struct registry_data_registry *data_registry,
registry_callback_adaptor adaptor,
struct registry_container *container,
struct registry_fields *fields);
void registry_set_data (struct registry_fields *fields,
const struct registry_data *data,
void *value);
void *registry_data (struct registry_fields *fields,
const struct registry_data *data);
/* Define a new registry implementation. */
#define DEFINE_REGISTRY(TAG, ACCESS) \
struct registry_data_registry TAG ## _data_registry = { NULL, 0 }; \
\
const struct TAG ## _data * \
register_ ## TAG ## _data_with_cleanup (void (*save) (struct TAG *, void *), \
void (*free) (struct TAG *, void *)) \
{ \
return (struct TAG ## _data *) \
register_data_with_cleanup (&TAG ## _data_registry, \
(registry_data_callback) save, \
(registry_data_callback) free); \
} \
\
const struct TAG ## _data * \
register_ ## TAG ## _data (void) \
{ \
return register_ ## TAG ## _data_with_cleanup (NULL, NULL); \
} \
\
static void \
TAG ## _alloc_data (struct TAG *container) \
{ \
struct registry_fields *rdata = &ACCESS (container)->registry_data; \
\
registry_alloc_data (&TAG ## _data_registry, rdata); \
} \
\
static void \
TAG ## registry_callback_adaptor (registry_data_callback func, \
struct registry_container *container, \
void *data) \
{ \
struct TAG *tagged_container = (struct TAG *) container; \
\
registry_ ## TAG ## _callback tagged_func \
= (registry_ ## TAG ## _callback) func; \
\
tagged_func (tagged_container, data); \
} \
\
void \
clear_ ## TAG ## _data (struct TAG *container) \
{ \
struct registry_fields *rdata = &ACCESS (container)->registry_data; \
\
registry_clear_data (&TAG ## _data_registry, \
TAG ## registry_callback_adaptor, \
(struct registry_container *) container, \
rdata); \
} \
\
static void \
TAG ## _free_data (struct TAG *container) \
{ \
struct registry_fields *rdata = &ACCESS (container)->registry_data; \
\
registry_container_free_data (&TAG ## _data_registry, \
TAG ## registry_callback_adaptor, \
(struct registry_container *) container, \
rdata); \
} \
\
void \
set_ ## TAG ## _data (struct TAG *container, \
const struct TAG ## _data *data, \
void *value) \
{ \
struct registry_fields *rdata = &ACCESS (container)->registry_data; \
\
registry_set_data (rdata, \
(struct registry_data *) data, \
value); \
} \
\
void * \
TAG ## _data (struct TAG *container, const struct TAG ## _data *data) \
{ \
struct registry_fields *rdata = &ACCESS (container)->registry_data; \
\
return registry_data (rdata, \
(struct registry_data *) data); \
}
/* External declarations for the registry functions. */
#define DECLARE_REGISTRY(TAG) \
struct TAG ## _data; \
typedef void (*registry_ ## TAG ## _callback) (struct TAG *, void *); \
extern const struct TAG ## _data *register_ ## TAG ## _data (void); \
extern const struct TAG ## _data *register_ ## TAG ## _data_with_cleanup \
(registry_ ## TAG ## _callback save, registry_ ## TAG ## _callback free); \
extern void clear_ ## TAG ## _data (struct TAG *); \
extern void set_ ## TAG ## _data (struct TAG *, \
const struct TAG ## _data *data, \
void *value); \
extern void *TAG ## _data (struct TAG *, \
const struct TAG ## _data *data); \
\
template<typename DATA, typename Deleter = std::default_delete<DATA>> \
class TAG ## _key \
{ \
public: \
\
TAG ## _key () \
: m_key (register_ ## TAG ## _data_with_cleanup (nullptr, \
cleanup)) \
{ \
} \
\
DATA *get (struct TAG *obj) const \
{ \
return (DATA *) TAG ## _data (obj, m_key); \
} \
\
void set (struct TAG *obj, DATA *data) const \
{ \
set_ ## TAG ## _data (obj, m_key, data); \
} \
\
template<typename Dummy = DATA *, typename... Args> \
typename std::enable_if<std::is_same<Deleter, \
std::default_delete<DATA>>::value, \
Dummy>::type \
emplace (struct TAG *obj, Args &&...args) const \
{ \
DATA *result = new DATA (std::forward<Args> (args)...); \
set (obj, result); \
return result; \
} \
\
void clear (struct TAG *obj) const \
{ \
DATA *datum = get (obj); \
if (datum != nullptr) \
{ \
cleanup (obj, datum); \
set (obj, nullptr); \
} \
} \
\
private: \
\
static void cleanup (struct TAG *obj, void *arg) \
{ \
DATA *datum = (DATA *) arg; \
Deleter d; \
d (datum); \
} \
\
const struct TAG ## _data *m_key; \
};
#endif /* REGISTRY_H */
|
