Commit | Line | Data |
---|---|---|
6ac74c0c PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H | |
fb2dcc52 JG |
3 | |
4 | /* | |
e2f7325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
fb2dcc52 JG |
6 | * Copyright 2015 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 | ||
3fadfbc0 MJ |
29 | #include <babeltrace2/graph/component-const.h> |
30 | #include <babeltrace2/graph/component-class.h> | |
31 | #include <babeltrace2/graph/component-class-source.h> | |
32 | #include <babeltrace2/graph/component-class-filter.h> | |
33 | #include <babeltrace2/graph/component-class-sink.h> | |
91d81473 | 34 | #include "common/macros.h" |
578e048b MJ |
35 | #include "lib/object.h" |
36 | #include "common/list.h" | |
3fadfbc0 | 37 | #include <babeltrace2/types.h> |
33b34c43 PP |
38 | #include <glib.h> |
39 | ||
40 | struct bt_component_class; | |
bfa9a4be | 41 | struct bt_plugin_so_shared_lib_handle; |
33b34c43 PP |
42 | |
43 | typedef void (*bt_component_class_destroy_listener_func)( | |
44 | struct bt_component_class *class, void *data); | |
45 | ||
d3e4dcd8 | 46 | struct bt_component_class_destroy_listener { |
33b34c43 PP |
47 | bt_component_class_destroy_listener_func func; |
48 | void *data; | |
49 | }; | |
fb2dcc52 JG |
50 | |
51 | struct bt_component_class { | |
b8a06801 | 52 | struct bt_object base; |
d3e4dcd8 | 53 | enum bt_component_class_type type; |
fb2dcc52 | 54 | GString *name; |
7c7c0433 | 55 | GString *description; |
5536d9a6 | 56 | GString *help; |
2ce06c9e | 57 | GString *plugin_name; |
d94d92ac | 58 | |
d3e4dcd8 | 59 | /* Array of struct bt_component_class_destroy_listener */ |
33b34c43 | 60 | GArray *destroy_listeners; |
d94d92ac | 61 | bool frozen; |
bfa9a4be MD |
62 | struct bt_list_head node; |
63 | struct bt_plugin_so_shared_lib_handle *so_handle; | |
33b34c43 | 64 | }; |
92893b7b | 65 | |
d3e4dcd8 PP |
66 | struct bt_component_class_source { |
67 | struct bt_component_class parent; | |
68 | struct { | |
0d72b8c3 PP |
69 | bt_component_class_source_init_method init; |
70 | bt_component_class_source_finalize_method finalize; | |
d6e69534 PP |
71 | bt_component_class_source_message_iterator_init_method msg_iter_init; |
72 | bt_component_class_source_message_iterator_finalize_method msg_iter_finalize; | |
73 | bt_component_class_source_message_iterator_next_method msg_iter_next; | |
7474e7d3 PP |
74 | bt_component_class_source_message_iterator_seek_ns_from_origin_method msg_iter_seek_ns_from_origin; |
75 | bt_component_class_source_message_iterator_seek_beginning_method msg_iter_seek_beginning; | |
76 | bt_component_class_source_message_iterator_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin; | |
77 | bt_component_class_source_message_iterator_can_seek_beginning_method msg_iter_can_seek_beginning; | |
0d72b8c3 | 78 | bt_component_class_source_query_method query; |
0d72b8c3 | 79 | bt_component_class_source_output_port_connected_method output_port_connected; |
d3e4dcd8 PP |
80 | } methods; |
81 | }; | |
82 | ||
83 | struct bt_component_class_sink { | |
84 | struct bt_component_class parent; | |
85 | struct { | |
0d72b8c3 PP |
86 | bt_component_class_sink_init_method init; |
87 | bt_component_class_sink_finalize_method finalize; | |
88 | bt_component_class_sink_query_method query; | |
0d72b8c3 | 89 | bt_component_class_sink_input_port_connected_method input_port_connected; |
5badd463 | 90 | bt_component_class_sink_graph_is_configured_method graph_is_configured; |
0d72b8c3 | 91 | bt_component_class_sink_consume_method consume; |
d3e4dcd8 PP |
92 | } methods; |
93 | }; | |
94 | ||
95 | struct bt_component_class_filter { | |
96 | struct bt_component_class parent; | |
97 | struct { | |
0d72b8c3 PP |
98 | bt_component_class_filter_init_method init; |
99 | bt_component_class_filter_finalize_method finalize; | |
d6e69534 PP |
100 | bt_component_class_filter_message_iterator_init_method msg_iter_init; |
101 | bt_component_class_filter_message_iterator_finalize_method msg_iter_finalize; | |
102 | bt_component_class_filter_message_iterator_next_method msg_iter_next; | |
7474e7d3 PP |
103 | bt_component_class_filter_message_iterator_seek_ns_from_origin_method msg_iter_seek_ns_from_origin; |
104 | bt_component_class_filter_message_iterator_seek_beginning_method msg_iter_seek_beginning; | |
105 | bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin; | |
106 | bt_component_class_filter_message_iterator_can_seek_beginning_method msg_iter_can_seek_beginning; | |
0d72b8c3 | 107 | bt_component_class_filter_query_method query; |
0d72b8c3 PP |
108 | bt_component_class_filter_input_port_connected_method input_port_connected; |
109 | bt_component_class_filter_output_port_connected_method output_port_connected; | |
d3e4dcd8 PP |
110 | } methods; |
111 | }; | |
112 | ||
92893b7b | 113 | BT_HIDDEN |
3230ee6b | 114 | void bt_component_class_add_destroy_listener(struct bt_component_class *class, |
33b34c43 | 115 | bt_component_class_destroy_listener_func func, void *data); |
fb2dcc52 | 116 | |
d94d92ac | 117 | BT_HIDDEN |
0d72b8c3 PP |
118 | void _bt_component_class_freeze( |
119 | const struct bt_component_class *component_class); | |
d94d92ac PP |
120 | |
121 | #ifdef BT_DEV_MODE | |
122 | # define bt_component_class_freeze _bt_component_class_freeze | |
123 | #else | |
124 | # define bt_component_class_freeze(_cc) | |
125 | #endif | |
126 | ||
ab0d387b PP |
127 | static inline |
128 | const char *bt_component_class_type_string(enum bt_component_class_type type) | |
129 | { | |
130 | switch (type) { | |
ab0d387b | 131 | case BT_COMPONENT_CLASS_TYPE_SOURCE: |
8a432889 | 132 | return "SOURCE"; |
ab0d387b | 133 | case BT_COMPONENT_CLASS_TYPE_SINK: |
8a432889 | 134 | return "SINK"; |
ab0d387b | 135 | case BT_COMPONENT_CLASS_TYPE_FILTER: |
8a432889 | 136 | return "FILTER"; |
ab0d387b PP |
137 | default: |
138 | return "(unknown)"; | |
139 | } | |
140 | } | |
141 | ||
6ac74c0c | 142 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H */ |