Put Python plugin support in a separate shared object
[babeltrace.git] / lib / component / component-class.c
1 /*
2 * component-class.c
3 *
4 * Babeltrace Plugin Component Class
5 *
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * SOFTWARE.
27 */
28
29 #include <babeltrace/compiler.h>
30 #include <babeltrace/component/component-class-internal.h>
31 #include <babeltrace/ref.h>
32 #include <stdbool.h>
33 #include <glib.h>
34
35 static
36 void bt_component_class_destroy(struct bt_object *obj)
37 {
38 struct bt_component_class *class;
39 int i;
40
41 assert(obj);
42 class = container_of(obj, struct bt_component_class, base);
43
44 /* Call destroy listeners in reverse registration order */
45 for (i = class->destroy_listeners->len - 1; i >= 0; i--) {
46 struct bt_component_class_destroy_listener *listener =
47 &g_array_index(class->destroy_listeners,
48 struct bt_component_class_destroy_listener,
49 i);
50
51 listener->func(class, listener->data);
52 }
53
54 if (class->name) {
55 g_string_free(class->name, TRUE);
56 }
57 if (class->description) {
58 g_string_free(class->description, TRUE);
59 }
60 if (class->help) {
61 g_string_free(class->help, TRUE);
62 }
63 if (class->destroy_listeners) {
64 g_array_free(class->destroy_listeners, TRUE);
65 }
66
67 g_free(class);
68 }
69
70 static
71 int bt_component_class_init(struct bt_component_class *class,
72 enum bt_component_class_type type, const char *name)
73 {
74 int ret = 0;
75
76 bt_object_init(class, bt_component_class_destroy);
77 class->type = type;
78 class->name = g_string_new(name);
79 if (!class->name) {
80 goto error;
81 }
82
83 class->description = g_string_new(NULL);
84 if (!class->description) {
85 goto error;
86 }
87
88 class->help = g_string_new(NULL);
89 if (!class->help) {
90 goto error;
91 }
92
93 class->destroy_listeners = g_array_new(FALSE, TRUE,
94 sizeof(struct bt_component_class_destroy_listener));
95 if (!class->destroy_listeners) {
96 goto error;
97 }
98
99 goto end;
100
101 error:
102 BT_PUT(class);
103 ret = -1;
104
105 end:
106 return ret;
107 }
108
109 struct bt_component_class *bt_component_class_source_create(const char *name,
110 bt_component_class_notification_iterator_get_method notification_iterator_get_method,
111 bt_component_class_notification_iterator_next_method notification_iterator_next_method)
112 {
113 struct bt_component_class_source *source_class = NULL;
114 int ret;
115
116 if (!name || !notification_iterator_get_method ||
117 !notification_iterator_next_method) {
118 goto end;
119 }
120
121 source_class = g_new0(struct bt_component_class_source, 1);
122 if (!source_class) {
123 goto end;
124 }
125
126 ret = bt_component_class_init(&source_class->parent,
127 BT_COMPONENT_CLASS_TYPE_SOURCE, name);
128 if (ret) {
129 /*
130 * If bt_component_class_init() fails, the component
131 * class is put, therefore its memory is already
132 * freed.
133 */
134 source_class = NULL;
135 goto end;
136 }
137
138 source_class->methods.iterator.get = notification_iterator_get_method;
139 source_class->methods.iterator.next = notification_iterator_next_method;
140
141 end:
142 return &source_class->parent;
143 }
144
145 struct bt_component_class *bt_component_class_filter_create(const char *name,
146 bt_component_class_notification_iterator_get_method notification_iterator_get_method,
147 bt_component_class_notification_iterator_next_method notification_iterator_next_method)
148 {
149 struct bt_component_class_filter *filter_class = NULL;
150 int ret;
151
152 if (!name || !notification_iterator_get_method ||
153 !notification_iterator_next_method) {
154 goto end;
155 }
156
157 filter_class = g_new0(struct bt_component_class_filter, 1);
158 if (!filter_class) {
159 goto end;
160 }
161
162 ret = bt_component_class_init(&filter_class->parent,
163 BT_COMPONENT_CLASS_TYPE_FILTER, name);
164 if (ret) {
165 /*
166 * If bt_component_class_init() fails, the component
167 * class is put, therefore its memory is already
168 * freed.
169 */
170 filter_class = NULL;
171 goto end;
172 }
173
174 filter_class->methods.iterator.get = notification_iterator_get_method;
175 filter_class->methods.iterator.next = notification_iterator_next_method;
176
177 end:
178 return &filter_class->parent;
179 }
180
181 struct bt_component_class *bt_component_class_sink_create(const char *name,
182 bt_component_class_sink_consume_method consume_method)
183 {
184 struct bt_component_class_sink *sink_class = NULL;
185 int ret;
186
187 if (!name || !consume_method) {
188 goto end;
189 }
190
191 sink_class = g_new0(struct bt_component_class_sink, 1);
192 if (!sink_class) {
193 goto end;
194 }
195
196 ret = bt_component_class_init(&sink_class->parent,
197 BT_COMPONENT_CLASS_TYPE_SINK, name);
198 if (ret) {
199 /*
200 * If bt_component_class_init() fails, the component
201 * class is put, therefore its memory is already
202 * freed.
203 */
204 sink_class = NULL;
205 goto end;
206 }
207
208 sink_class->methods.consume = consume_method;
209
210 end:
211 return &sink_class->parent;
212 }
213
214 int bt_component_class_set_init_method(
215 struct bt_component_class *component_class,
216 bt_component_class_init_method init_method)
217 {
218 int ret = 0;
219
220 if (!component_class || component_class->frozen || !init_method) {
221 ret = -1;
222 goto end;
223 }
224
225 component_class->methods.init = init_method;
226
227 end:
228 return ret;
229 }
230
231 int bt_component_class_set_query_method(
232 struct bt_component_class *component_class,
233 bt_component_class_query_method query_method)
234 {
235 int ret = 0;
236
237 if (!component_class || component_class->frozen || !query_method) {
238 ret = -1;
239 goto end;
240 }
241
242 component_class->methods.query = query_method;
243
244 end:
245 return ret;
246 }
247
248 int bt_component_class_set_new_connection_method(
249 struct bt_component_class *component_class,
250 bt_component_class_new_connection_method new_connection_method)
251 {
252 int ret = 0;
253
254 if (!component_class || component_class->frozen ||
255 !new_connection_method) {
256 ret = -1;
257 goto end;
258 }
259
260 component_class->methods.new_connection_method = new_connection_method;
261
262 end:
263 return ret;
264 }
265
266 int bt_component_class_set_destroy_method(
267 struct bt_component_class *component_class,
268 bt_component_class_destroy_method destroy_method)
269 {
270 int ret = 0;
271
272 if (!component_class || component_class->frozen || !destroy_method) {
273 ret = -1;
274 goto end;
275 }
276
277 component_class->methods.destroy = destroy_method;
278
279 end:
280 return ret;
281 }
282
283 int bt_component_class_source_set_notification_iterator_init_method(
284 struct bt_component_class *component_class,
285 bt_component_class_notification_iterator_init_method notification_iterator_init_method)
286 {
287 struct bt_component_class_source *source_class;
288 int ret = 0;
289
290 if (!component_class || component_class->frozen ||
291 !notification_iterator_init_method ||
292 component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
293 ret = -1;
294 goto end;
295 }
296
297 source_class = container_of(component_class,
298 struct bt_component_class_source, parent);
299 source_class->methods.iterator.init = notification_iterator_init_method;
300
301 end:
302 return ret;
303 }
304
305 int bt_component_class_source_set_notification_iterator_destroy_method(
306 struct bt_component_class *component_class,
307 bt_component_class_notification_iterator_destroy_method notification_iterator_destroy_method)
308 {
309 struct bt_component_class_source *source_class;
310 int ret = 0;
311
312 if (!component_class || component_class->frozen ||
313 !notification_iterator_destroy_method ||
314 component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
315 ret = -1;
316 goto end;
317 }
318
319 source_class = container_of(component_class,
320 struct bt_component_class_source, parent);
321 source_class->methods.iterator.destroy =
322 notification_iterator_destroy_method;
323
324 end:
325 return ret;
326 }
327
328 int bt_component_class_source_set_notification_iterator_seek_time_method(
329 struct bt_component_class *component_class,
330 bt_component_class_notification_iterator_seek_time_method notification_iterator_seek_time_method)
331 {
332 struct bt_component_class_source *source_class;
333 int ret = 0;
334
335 if (!component_class || component_class->frozen ||
336 !notification_iterator_seek_time_method ||
337 component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
338 ret = -1;
339 goto end;
340 }
341
342 source_class = container_of(component_class,
343 struct bt_component_class_source, parent);
344 source_class->methods.iterator.seek_time =
345 notification_iterator_seek_time_method;
346
347 end:
348 return ret;
349 }
350
351 int bt_component_class_filter_set_notification_iterator_init_method(
352 struct bt_component_class *component_class,
353 bt_component_class_notification_iterator_init_method notification_iterator_init_method)
354 {
355 struct bt_component_class_filter *filter_class;
356 int ret = 0;
357
358 if (!component_class || component_class->frozen ||
359 !notification_iterator_init_method ||
360 component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
361 ret = -1;
362 goto end;
363 }
364
365 filter_class = container_of(component_class,
366 struct bt_component_class_filter, parent);
367 filter_class->methods.iterator.init = notification_iterator_init_method;
368
369 end:
370 return ret;
371 }
372
373 int bt_component_class_filter_set_notification_iterator_destroy_method(
374 struct bt_component_class *component_class,
375 bt_component_class_notification_iterator_destroy_method notification_iterator_destroy_method)
376 {
377 struct bt_component_class_filter *filter_class;
378 int ret = 0;
379
380 if (!component_class || component_class->frozen ||
381 !notification_iterator_destroy_method ||
382 component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
383 ret = -1;
384 goto end;
385 }
386
387 filter_class = container_of(component_class,
388 struct bt_component_class_filter, parent);
389 filter_class->methods.iterator.destroy =
390 notification_iterator_destroy_method;
391
392 end:
393 return ret;
394 }
395
396 int bt_component_class_filter_set_notification_iterator_seek_time_method(
397 struct bt_component_class *component_class,
398 bt_component_class_notification_iterator_seek_time_method notification_iterator_seek_time_method)
399 {
400 struct bt_component_class_filter *filter_class;
401 int ret = 0;
402
403 if (!component_class || component_class->frozen ||
404 !notification_iterator_seek_time_method ||
405 component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
406 ret = -1;
407 goto end;
408 }
409
410 filter_class = container_of(component_class,
411 struct bt_component_class_filter, parent);
412 filter_class->methods.iterator.seek_time =
413 notification_iterator_seek_time_method;
414
415 end:
416 return ret;
417 }
418
419 int bt_component_class_set_description(
420 struct bt_component_class *component_class,
421 const char *description)
422 {
423 int ret = 0;
424
425 if (!component_class || component_class->frozen || !description) {
426 ret = -1;
427 goto end;
428 }
429
430 g_string_assign(component_class->description, description);
431
432 end:
433 return ret;
434 }
435
436 int bt_component_class_set_help(
437 struct bt_component_class *component_class,
438 const char *help)
439 {
440 int ret = 0;
441
442 if (!component_class || component_class->frozen || !help) {
443 ret = -1;
444 goto end;
445 }
446
447 g_string_assign(component_class->help, help);
448
449 end:
450 return ret;
451 }
452
453 const char *bt_component_class_get_name(
454 struct bt_component_class *component_class)
455 {
456 return component_class ? component_class->name->str : NULL;
457 }
458
459 enum bt_component_class_type bt_component_class_get_type(
460 struct bt_component_class *component_class)
461 {
462 return component_class ? component_class->type :
463 BT_COMPONENT_CLASS_TYPE_UNKNOWN;
464 }
465
466 const char *bt_component_class_get_description(
467 struct bt_component_class *component_class)
468 {
469 return component_class && component_class->description &&
470 component_class->description->str[0] != '\0' ?
471 component_class->description->str : NULL;
472 }
473
474 const char *bt_component_class_get_help(
475 struct bt_component_class *component_class)
476 {
477 return component_class && component_class->help &&
478 component_class->help->str[0] != '\0' ?
479 component_class->help->str : NULL;
480 }
481
482 BT_HIDDEN
483 int bt_component_class_add_destroy_listener(struct bt_component_class *class,
484 bt_component_class_destroy_listener_func func, void *data)
485 {
486 int ret = 0;
487 struct bt_component_class_destroy_listener listener;
488
489 if (!class || class->frozen || !func) {
490 ret = -1;
491 goto end;
492 }
493
494 listener.func = func;
495 listener.data = data;
496 g_array_append_val(class->destroy_listeners, listener);
497
498 end:
499 return ret;
500 }
501
502 int bt_component_class_freeze(
503 struct bt_component_class *component_class)
504 {
505 int ret = 0;
506
507 if (!component_class) {
508 ret = -1;
509 goto end;
510 }
511
512 component_class->frozen = true;
513
514 end:
515 return ret;
516 }
517
518 struct bt_value *bt_component_class_query(
519 struct bt_component_class *component_class,
520 const char *object, struct bt_value *params)
521 {
522 struct bt_value *results = NULL;
523
524 if (!component_class || !object || !params ||
525 !component_class->methods.query) {
526 goto end;
527 }
528
529 results = component_class->methods.query(component_class,
530 object, params);
531
532 end:
533 return results;
534 }
This page took 0.04112 seconds and 5 git commands to generate.