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 | 29 | #include <babeltrace2/graph/component-class.h> |
43c59509 | 30 | #include <babeltrace2/graph/component.h> |
91d81473 | 31 | #include "common/macros.h" |
578e048b MJ |
32 | #include "lib/object.h" |
33 | #include "common/list.h" | |
3fadfbc0 | 34 | #include <babeltrace2/types.h> |
c4f23e30 | 35 | #include <stdbool.h> |
33b34c43 PP |
36 | #include <glib.h> |
37 | ||
38 | struct bt_component_class; | |
bfa9a4be | 39 | struct bt_plugin_so_shared_lib_handle; |
33b34c43 PP |
40 | |
41 | typedef void (*bt_component_class_destroy_listener_func)( | |
42 | struct bt_component_class *class, void *data); | |
43 | ||
d3e4dcd8 | 44 | struct bt_component_class_destroy_listener { |
33b34c43 PP |
45 | bt_component_class_destroy_listener_func func; |
46 | void *data; | |
47 | }; | |
fb2dcc52 JG |
48 | |
49 | struct bt_component_class { | |
b8a06801 | 50 | struct bt_object base; |
d3e4dcd8 | 51 | enum bt_component_class_type type; |
fb2dcc52 | 52 | GString *name; |
7c7c0433 | 53 | GString *description; |
5536d9a6 | 54 | GString *help; |
2ce06c9e | 55 | GString *plugin_name; |
d94d92ac | 56 | |
d3e4dcd8 | 57 | /* Array of struct bt_component_class_destroy_listener */ |
33b34c43 | 58 | GArray *destroy_listeners; |
d94d92ac | 59 | bool frozen; |
bfa9a4be MD |
60 | struct bt_list_head node; |
61 | struct bt_plugin_so_shared_lib_handle *so_handle; | |
33b34c43 | 62 | }; |
92893b7b | 63 | |
41a3efcd | 64 | struct bt_component_class_with_iterator_class { |
d3e4dcd8 | 65 | struct bt_component_class parent; |
41a3efcd SM |
66 | bt_message_iterator_class *msg_iter_cls; |
67 | }; | |
68 | ||
69 | struct bt_component_class_source { | |
70 | struct bt_component_class_with_iterator_class parent; | |
d3e4dcd8 | 71 | struct { |
2b55df78 | 72 | bt_component_class_source_get_supported_mip_versions_method get_supported_mip_versions; |
21a9f056 | 73 | bt_component_class_source_initialize_method init; |
0d72b8c3 | 74 | bt_component_class_source_finalize_method finalize; |
0d72b8c3 | 75 | bt_component_class_source_query_method query; |
0d72b8c3 | 76 | bt_component_class_source_output_port_connected_method output_port_connected; |
d3e4dcd8 | 77 | } methods; |
41a3efcd SM |
78 | }; |
79 | ||
80 | struct bt_component_class_filter { | |
81 | struct bt_component_class_with_iterator_class parent; | |
82 | struct { | |
83 | bt_component_class_filter_get_supported_mip_versions_method get_supported_mip_versions; | |
84 | bt_component_class_filter_initialize_method init; | |
85 | bt_component_class_filter_finalize_method finalize; | |
86 | bt_component_class_filter_query_method query; | |
87 | bt_component_class_filter_input_port_connected_method input_port_connected; | |
88 | bt_component_class_filter_output_port_connected_method output_port_connected; | |
89 | } methods; | |
d3e4dcd8 PP |
90 | }; |
91 | ||
92 | struct bt_component_class_sink { | |
93 | struct bt_component_class parent; | |
94 | struct { | |
2b55df78 | 95 | bt_component_class_sink_get_supported_mip_versions_method get_supported_mip_versions; |
21a9f056 | 96 | bt_component_class_sink_initialize_method init; |
0d72b8c3 PP |
97 | bt_component_class_sink_finalize_method finalize; |
98 | bt_component_class_sink_query_method query; | |
0d72b8c3 | 99 | bt_component_class_sink_input_port_connected_method input_port_connected; |
5badd463 | 100 | bt_component_class_sink_graph_is_configured_method graph_is_configured; |
0d72b8c3 | 101 | bt_component_class_sink_consume_method consume; |
d3e4dcd8 PP |
102 | } methods; |
103 | }; | |
104 | ||
92893b7b | 105 | BT_HIDDEN |
3230ee6b | 106 | void bt_component_class_add_destroy_listener(struct bt_component_class *class, |
33b34c43 | 107 | bt_component_class_destroy_listener_func func, void *data); |
fb2dcc52 | 108 | |
d94d92ac | 109 | BT_HIDDEN |
0d72b8c3 PP |
110 | void _bt_component_class_freeze( |
111 | const struct bt_component_class *component_class); | |
d94d92ac PP |
112 | |
113 | #ifdef BT_DEV_MODE | |
114 | # define bt_component_class_freeze _bt_component_class_freeze | |
115 | #else | |
116 | # define bt_component_class_freeze(_cc) | |
117 | #endif | |
118 | ||
ab0d387b PP |
119 | static inline |
120 | const char *bt_component_class_type_string(enum bt_component_class_type type) | |
121 | { | |
122 | switch (type) { | |
ab0d387b | 123 | case BT_COMPONENT_CLASS_TYPE_SOURCE: |
8a432889 | 124 | return "SOURCE"; |
ab0d387b | 125 | case BT_COMPONENT_CLASS_TYPE_SINK: |
8a432889 | 126 | return "SINK"; |
ab0d387b | 127 | case BT_COMPONENT_CLASS_TYPE_FILTER: |
8a432889 | 128 | return "FILTER"; |
ab0d387b PP |
129 | default: |
130 | return "(unknown)"; | |
131 | } | |
132 | } | |
133 | ||
41a3efcd SM |
134 | static inline |
135 | bool bt_component_class_has_message_iterator_class( | |
136 | struct bt_component_class *component_class) | |
137 | { | |
138 | return component_class->type == BT_COMPONENT_CLASS_TYPE_SOURCE || | |
139 | component_class->type == BT_COMPONENT_CLASS_TYPE_FILTER; | |
140 | } | |
141 | ||
6ac74c0c | 142 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H */ |