Commit | Line | Data |
---|---|---|
33b34c43 PP |
1 | #ifndef BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H |
2 | #define BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H | |
fb2dcc52 JG |
3 | |
4 | /* | |
fb2dcc52 JG |
5 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
6 | * | |
7 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
8 | * | |
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
10 | * of this software and associated documentation files (the "Software"), to deal | |
11 | * in the Software without restriction, including without limitation the rights | |
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
13 | * copies of the Software, and to permit persons to whom the Software is | |
14 | * furnished to do so, subject to the following conditions: | |
15 | * | |
16 | * The above copyright notice and this permission notice shall be included in | |
17 | * all copies or substantial portions of the Software. | |
18 | * | |
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
25 | * SOFTWARE. | |
26 | */ | |
27 | ||
28 | #include <babeltrace/babeltrace-internal.h> | |
d94d92ac | 29 | #include <babeltrace/graph/component-class-internal.h> |
3fe0bf43 | 30 | #include <babeltrace/plugin/plugin.h> |
33b34c43 | 31 | #include <babeltrace/plugin/plugin-dev.h> |
d94d92ac | 32 | #include <babeltrace/plugin/plugin-so-internal.h> |
b8a06801 | 33 | #include <babeltrace/object-internal.h> |
d94d92ac | 34 | #include <babeltrace/object.h> |
c55a9f58 | 35 | #include <babeltrace/types.h> |
f6ccaed9 | 36 | #include <babeltrace/assert-internal.h> |
55bb57e0 | 37 | #include <glib.h> |
fb2dcc52 | 38 | |
55bb57e0 PP |
39 | enum bt_plugin_type { |
40 | BT_PLUGIN_TYPE_SO = 0, | |
41 | BT_PLUGIN_TYPE_PYTHON = 1, | |
fb2dcc52 JG |
42 | }; |
43 | ||
33b34c43 PP |
44 | struct bt_plugin { |
45 | struct bt_object base; | |
55bb57e0 | 46 | enum bt_plugin_type type; |
cba174d5 | 47 | |
d94d92ac PP |
48 | /* Arrays of `struct bt_component_class *` (owned by this) */ |
49 | GPtrArray *src_comp_classes; | |
50 | GPtrArray *flt_comp_classes; | |
51 | GPtrArray *sink_comp_classes; | |
6ba0b073 | 52 | |
55bb57e0 PP |
53 | /* Info (owned by this) */ |
54 | struct { | |
55 | GString *path; | |
56 | GString *name; | |
57 | GString *author; | |
58 | GString *license; | |
59 | GString *description; | |
60 | struct { | |
61 | unsigned int major; | |
62 | unsigned int minor; | |
63 | unsigned int patch; | |
64 | GString *extra; | |
65 | } version; | |
d94d92ac PP |
66 | bool path_set; |
67 | bool name_set; | |
68 | bool author_set; | |
69 | bool license_set; | |
70 | bool description_set; | |
71 | bool version_set; | |
55bb57e0 PP |
72 | } info; |
73 | ||
74 | /* Value depends on the specific plugin type */ | |
75 | void *spec_data; | |
6fbd4105 | 76 | void (*destroy_spec_data)(struct bt_plugin *); |
33b34c43 | 77 | }; |
fb2dcc52 | 78 | |
a8ff38ef PP |
79 | struct bt_plugin_set { |
80 | struct bt_object base; | |
81 | ||
82 | /* Array of struct bt_plugin * */ | |
83 | GPtrArray *plugins; | |
84 | }; | |
85 | ||
3fe0bf43 PP |
86 | static inline |
87 | const char *bt_plugin_status_string(enum bt_plugin_status status) | |
88 | { | |
89 | switch (status) { | |
90 | case BT_PLUGIN_STATUS_OK: | |
91 | return "BT_PLUGIN_STATUS_OK"; | |
92 | case BT_PLUGIN_STATUS_ERROR: | |
93 | return "BT_PLUGIN_STATUS_ERROR"; | |
94 | case BT_PLUGIN_STATUS_NOMEM: | |
95 | return "BT_PLUGIN_STATUS_NOMEM"; | |
96 | default: | |
97 | return "(unknown)"; | |
98 | } | |
99 | } | |
100 | ||
101 | static inline | |
102 | const char *bt_plugin_type_string(enum bt_plugin_type type) | |
103 | { | |
104 | switch (type) { | |
105 | case BT_PLUGIN_TYPE_SO: | |
106 | return "BT_PLUGIN_TYPE_SO"; | |
107 | case BT_PLUGIN_TYPE_PYTHON: | |
108 | return "BT_PLUGIN_TYPE_PYTHON"; | |
109 | default: | |
110 | return "(unknown)"; | |
111 | } | |
112 | } | |
113 | ||
6fbd4105 PP |
114 | static inline |
115 | void bt_plugin_destroy(struct bt_object *obj) | |
116 | { | |
117 | struct bt_plugin *plugin; | |
118 | ||
f6ccaed9 | 119 | BT_ASSERT(obj); |
6fbd4105 | 120 | plugin = container_of(obj, struct bt_plugin, base); |
d94d92ac | 121 | BT_LIB_LOGD("Destroying plugin object: %!+l", plugin); |
6fbd4105 PP |
122 | |
123 | if (plugin->destroy_spec_data) { | |
124 | plugin->destroy_spec_data(plugin); | |
125 | } | |
126 | ||
d94d92ac PP |
127 | if (plugin->src_comp_classes) { |
128 | BT_LOGD_STR("Putting source component classes."); | |
129 | g_ptr_array_free(plugin->src_comp_classes, TRUE); | |
130 | } | |
131 | ||
132 | if (plugin->flt_comp_classes) { | |
133 | BT_LOGD_STR("Putting filter component classes."); | |
134 | g_ptr_array_free(plugin->flt_comp_classes, TRUE); | |
135 | } | |
136 | ||
137 | if (plugin->sink_comp_classes) { | |
138 | BT_LOGD_STR("Putting sink component classes."); | |
139 | g_ptr_array_free(plugin->sink_comp_classes, TRUE); | |
6fbd4105 PP |
140 | } |
141 | ||
142 | if (plugin->info.name) { | |
143 | g_string_free(plugin->info.name, TRUE); | |
144 | } | |
145 | ||
146 | if (plugin->info.path) { | |
147 | g_string_free(plugin->info.path, TRUE); | |
148 | } | |
149 | ||
150 | if (plugin->info.description) { | |
151 | g_string_free(plugin->info.description, TRUE); | |
152 | } | |
153 | ||
154 | if (plugin->info.author) { | |
155 | g_string_free(plugin->info.author, TRUE); | |
156 | } | |
157 | ||
158 | if (plugin->info.license) { | |
159 | g_string_free(plugin->info.license, TRUE); | |
160 | } | |
161 | ||
162 | if (plugin->info.version.extra) { | |
163 | g_string_free(plugin->info.version.extra, TRUE); | |
164 | } | |
165 | ||
166 | g_free(plugin); | |
167 | } | |
168 | ||
169 | static inline | |
170 | struct bt_plugin *bt_plugin_create_empty(enum bt_plugin_type type) | |
171 | { | |
172 | struct bt_plugin *plugin = NULL; | |
173 | ||
3fe0bf43 PP |
174 | BT_LOGD("Creating empty plugin object: type=%s", |
175 | bt_plugin_type_string(type)); | |
176 | ||
6fbd4105 PP |
177 | plugin = g_new0(struct bt_plugin, 1); |
178 | if (!plugin) { | |
3fe0bf43 | 179 | BT_LOGE_STR("Failed to allocate one plugin."); |
6fbd4105 PP |
180 | goto error; |
181 | } | |
182 | ||
3fea54f6 | 183 | bt_object_init_shared(&plugin->base, bt_plugin_destroy); |
6fbd4105 PP |
184 | plugin->type = type; |
185 | ||
d94d92ac PP |
186 | /* Create empty arrays of component classes */ |
187 | plugin->src_comp_classes = | |
188 | g_ptr_array_new_with_free_func( | |
189 | (GDestroyNotify) bt_object_put_ref); | |
190 | if (!plugin->src_comp_classes) { | |
191 | BT_LOGE_STR("Failed to allocate a GPtrArray."); | |
192 | goto error; | |
193 | } | |
194 | ||
195 | plugin->flt_comp_classes = | |
196 | g_ptr_array_new_with_free_func( | |
197 | (GDestroyNotify) bt_object_put_ref); | |
198 | if (!plugin->flt_comp_classes) { | |
199 | BT_LOGE_STR("Failed to allocate a GPtrArray."); | |
200 | goto error; | |
201 | } | |
202 | ||
203 | plugin->sink_comp_classes = | |
204 | g_ptr_array_new_with_free_func( | |
205 | (GDestroyNotify) bt_object_put_ref); | |
206 | if (!plugin->sink_comp_classes) { | |
3fe0bf43 | 207 | BT_LOGE_STR("Failed to allocate a GPtrArray."); |
6fbd4105 PP |
208 | goto error; |
209 | } | |
210 | ||
211 | /* Create empty info */ | |
212 | plugin->info.name = g_string_new(NULL); | |
213 | if (!plugin->info.name) { | |
3fe0bf43 | 214 | BT_LOGE_STR("Failed to allocate a GString."); |
6fbd4105 PP |
215 | goto error; |
216 | } | |
217 | ||
218 | plugin->info.path = g_string_new(NULL); | |
219 | if (!plugin->info.path) { | |
3fe0bf43 | 220 | BT_LOGE_STR("Failed to allocate a GString."); |
6fbd4105 PP |
221 | goto error; |
222 | } | |
223 | ||
224 | plugin->info.description = g_string_new(NULL); | |
225 | if (!plugin->info.description) { | |
3fe0bf43 | 226 | BT_LOGE_STR("Failed to allocate a GString."); |
6fbd4105 PP |
227 | goto error; |
228 | } | |
229 | ||
230 | plugin->info.author = g_string_new(NULL); | |
231 | if (!plugin->info.author) { | |
3fe0bf43 | 232 | BT_LOGE_STR("Failed to allocate a GString."); |
6fbd4105 PP |
233 | goto error; |
234 | } | |
235 | ||
236 | plugin->info.license = g_string_new(NULL); | |
237 | if (!plugin->info.license) { | |
3fe0bf43 | 238 | BT_LOGE_STR("Failed to allocate a GString."); |
6fbd4105 PP |
239 | goto error; |
240 | } | |
241 | ||
242 | plugin->info.version.extra = g_string_new(NULL); | |
243 | if (!plugin->info.version.extra) { | |
3fe0bf43 | 244 | BT_LOGE_STR("Failed to allocate a GString."); |
6fbd4105 PP |
245 | goto error; |
246 | } | |
247 | ||
d94d92ac | 248 | BT_LIB_LOGD("Created empty plugin object: %!+l", plugin); |
6fbd4105 PP |
249 | goto end; |
250 | ||
251 | error: | |
65300d60 | 252 | BT_OBJECT_PUT_REF_AND_RESET(plugin); |
6fbd4105 PP |
253 | |
254 | end: | |
255 | return plugin; | |
256 | } | |
55bb57e0 PP |
257 | |
258 | static inline | |
259 | void bt_plugin_set_path(struct bt_plugin *plugin, const char *path) | |
260 | { | |
f6ccaed9 PP |
261 | BT_ASSERT(plugin); |
262 | BT_ASSERT(path); | |
55bb57e0 | 263 | g_string_assign(plugin->info.path, path); |
c55a9f58 | 264 | plugin->info.path_set = BT_TRUE; |
d94d92ac PP |
265 | BT_LIB_LOGV("Set plugin's path: %![plugin-]+l, path=\"%s\"", |
266 | plugin, path); | |
55bb57e0 PP |
267 | } |
268 | ||
269 | static inline | |
270 | void bt_plugin_set_name(struct bt_plugin *plugin, const char *name) | |
271 | { | |
f6ccaed9 PP |
272 | BT_ASSERT(plugin); |
273 | BT_ASSERT(name); | |
55bb57e0 | 274 | g_string_assign(plugin->info.name, name); |
c55a9f58 | 275 | plugin->info.name_set = BT_TRUE; |
d94d92ac | 276 | BT_LIB_LOGV("Set plugin's name: %![plugin-]+l, name=\"%s\"", |
3fe0bf43 | 277 | plugin, name); |
55bb57e0 PP |
278 | } |
279 | ||
280 | static inline | |
281 | void bt_plugin_set_description(struct bt_plugin *plugin, | |
282 | const char *description) | |
283 | { | |
f6ccaed9 PP |
284 | BT_ASSERT(plugin); |
285 | BT_ASSERT(description); | |
55bb57e0 | 286 | g_string_assign(plugin->info.description, description); |
c55a9f58 | 287 | plugin->info.description_set = BT_TRUE; |
d94d92ac | 288 | BT_LIB_LOGV("Set plugin's description: %![plugin-]+l", plugin); |
55bb57e0 PP |
289 | } |
290 | ||
291 | static inline | |
292 | void bt_plugin_set_author(struct bt_plugin *plugin, const char *author) | |
293 | { | |
f6ccaed9 PP |
294 | BT_ASSERT(plugin); |
295 | BT_ASSERT(author); | |
55bb57e0 | 296 | g_string_assign(plugin->info.author, author); |
c55a9f58 | 297 | plugin->info.author_set = BT_TRUE; |
d94d92ac PP |
298 | BT_LIB_LOGV("Set plugin's author: %![plugin-]+l, author=\"%s\"", |
299 | plugin, author); | |
55bb57e0 PP |
300 | } |
301 | ||
302 | static inline | |
303 | void bt_plugin_set_license(struct bt_plugin *plugin, const char *license) | |
304 | { | |
f6ccaed9 PP |
305 | BT_ASSERT(plugin); |
306 | BT_ASSERT(license); | |
55bb57e0 | 307 | g_string_assign(plugin->info.license, license); |
c55a9f58 | 308 | plugin->info.license_set = BT_TRUE; |
d94d92ac PP |
309 | BT_LIB_LOGV("Set plugin's path: %![plugin-]+l, license=\"%s\"", |
310 | plugin, license); | |
55bb57e0 PP |
311 | } |
312 | ||
313 | static inline | |
314 | void bt_plugin_set_version(struct bt_plugin *plugin, unsigned int major, | |
315 | unsigned int minor, unsigned int patch, const char *extra) | |
316 | { | |
f6ccaed9 | 317 | BT_ASSERT(plugin); |
55bb57e0 PP |
318 | plugin->info.version.major = major; |
319 | plugin->info.version.minor = minor; | |
320 | plugin->info.version.patch = patch; | |
321 | ||
322 | if (extra) { | |
323 | g_string_assign(plugin->info.version.extra, extra); | |
324 | } | |
325 | ||
c55a9f58 | 326 | plugin->info.version_set = BT_TRUE; |
d94d92ac | 327 | BT_LIB_LOGV("Set plugin's version: %![plugin-]+l, " |
3fe0bf43 | 328 | "major=%u, minor=%u, patch=%u, extra=\"%s\"", |
d94d92ac | 329 | plugin, major, minor, patch, extra); |
55bb57e0 PP |
330 | } |
331 | ||
332 | static inline | |
d94d92ac PP |
333 | enum bt_plugin_status bt_plugin_add_component_class( |
334 | struct bt_plugin *plugin, struct bt_component_class *comp_class) | |
55bb57e0 | 335 | { |
d94d92ac PP |
336 | GPtrArray *comp_classes; |
337 | ||
f6ccaed9 | 338 | BT_ASSERT(plugin); |
d94d92ac PP |
339 | BT_ASSERT(comp_class); |
340 | ||
341 | switch (comp_class->type) { | |
342 | case BT_COMPONENT_CLASS_TYPE_SOURCE: | |
343 | comp_classes = plugin->src_comp_classes; | |
344 | break; | |
345 | case BT_COMPONENT_CLASS_TYPE_FILTER: | |
346 | comp_classes = plugin->flt_comp_classes; | |
347 | break; | |
348 | case BT_COMPONENT_CLASS_TYPE_SINK: | |
349 | comp_classes = plugin->sink_comp_classes; | |
350 | break; | |
351 | default: | |
352 | abort(); | |
353 | } | |
3fe0bf43 | 354 | |
d94d92ac PP |
355 | /* Add new component class */ |
356 | g_ptr_array_add(comp_classes, bt_object_get_ref(comp_class)); | |
357 | ||
358 | /* Special case for a shared object plugin */ | |
359 | if (plugin->type == BT_PLUGIN_TYPE_SO) { | |
360 | bt_plugin_so_on_add_component_class(plugin, comp_class); | |
3fe0bf43 PP |
361 | } |
362 | ||
d94d92ac PP |
363 | BT_LIB_LOGD("Added component class to plugin: " |
364 | "%![plugin-]+l, %![cc-]+C", plugin, comp_class); | |
365 | return BT_PLUGIN_STATUS_OK; | |
55bb57e0 PP |
366 | } |
367 | ||
a8ff38ef PP |
368 | static |
369 | void bt_plugin_set_destroy(struct bt_object *obj) | |
370 | { | |
371 | struct bt_plugin_set *plugin_set = | |
372 | container_of(obj, struct bt_plugin_set, base); | |
373 | ||
374 | if (!plugin_set) { | |
375 | return; | |
376 | } | |
377 | ||
3fe0bf43 PP |
378 | BT_LOGD("Destroying plugin set: addr=%p", plugin_set); |
379 | ||
a8ff38ef | 380 | if (plugin_set->plugins) { |
3fe0bf43 | 381 | BT_LOGD_STR("Putting plugins."); |
a8ff38ef PP |
382 | g_ptr_array_free(plugin_set->plugins, TRUE); |
383 | } | |
384 | ||
385 | g_free(plugin_set); | |
386 | } | |
387 | ||
388 | static inline | |
389 | struct bt_plugin_set *bt_plugin_set_create(void) | |
390 | { | |
391 | struct bt_plugin_set *plugin_set = g_new0(struct bt_plugin_set, 1); | |
392 | ||
393 | if (!plugin_set) { | |
394 | goto end; | |
395 | } | |
396 | ||
3fe0bf43 | 397 | BT_LOGD_STR("Creating empty plugin set."); |
3fea54f6 | 398 | bt_object_init_shared(&plugin_set->base, bt_plugin_set_destroy); |
a8ff38ef PP |
399 | |
400 | plugin_set->plugins = g_ptr_array_new_with_free_func( | |
65300d60 | 401 | (GDestroyNotify) bt_object_put_ref); |
a8ff38ef | 402 | if (!plugin_set->plugins) { |
3fe0bf43 | 403 | BT_LOGE_STR("Failed to allocate a GPtrArray."); |
65300d60 | 404 | BT_OBJECT_PUT_REF_AND_RESET(plugin_set); |
a8ff38ef PP |
405 | goto end; |
406 | } | |
407 | ||
3fe0bf43 PP |
408 | BT_LOGD("Created empty plugin set: addr=%p", plugin_set); |
409 | ||
a8ff38ef PP |
410 | end: |
411 | return plugin_set; | |
412 | } | |
413 | ||
414 | static inline | |
415 | void bt_plugin_set_add_plugin(struct bt_plugin_set *plugin_set, | |
416 | struct bt_plugin *plugin) | |
417 | { | |
f6ccaed9 PP |
418 | BT_ASSERT(plugin_set); |
419 | BT_ASSERT(plugin); | |
65300d60 | 420 | g_ptr_array_add(plugin_set->plugins, bt_object_get_ref(plugin)); |
d94d92ac PP |
421 | BT_LIB_LOGV("Added plugin to plugin set: " |
422 | "plugin-set-addr=%p, %![plugin-]+l", | |
423 | plugin_set, plugin); | |
8c1a3187 PP |
424 | } |
425 | ||
33b34c43 | 426 | #endif /* BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H */ |