Commit | Line | Data |
---|---|---|
fb2dcc52 | 1 | /* |
e2f7325d | 2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
3310b217 | 3 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
fb2dcc52 | 4 | * |
fb2dcc52 JG |
5 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
6 | * of this software and associated documentation files (the "Software"), to deal | |
7 | * in the Software without restriction, including without limitation the rights | |
8 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
9 | * copies of the Software, and to permit persons to whom the Software is | |
10 | * furnished to do so, subject to the following conditions: | |
11 | * | |
12 | * The above copyright notice and this permission notice shall be included in | |
13 | * all copies or substantial portions of the Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
18 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
20 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
21 | * SOFTWARE. | |
22 | */ | |
23 | ||
350ad6c1 | 24 | #define BT_LOG_TAG "LIB/COMPONENT-CLASS" |
c2d9d9cf | 25 | #include "lib/logging.h" |
a3aacb6f | 26 | |
578e048b MJ |
27 | #include "common/assert.h" |
28 | #include "lib/assert-pre.h" | |
29 | #include "compat/compiler.h" | |
3fadfbc0 MJ |
30 | #include <babeltrace2/graph/component-class.h> |
31 | #include <babeltrace2/graph/component-class-const.h> | |
32 | #include <babeltrace2/graph/component-class-source.h> | |
33 | #include <babeltrace2/graph/component-class-source-const.h> | |
34 | #include <babeltrace2/graph/component-class-filter.h> | |
35 | #include <babeltrace2/graph/component-class-filter-const.h> | |
36 | #include <babeltrace2/graph/component-class-sink.h> | |
37 | #include <babeltrace2/graph/component-class-sink-const.h> | |
3fadfbc0 | 38 | #include <babeltrace2/types.h> |
fb2dcc52 JG |
39 | #include <glib.h> |
40 | ||
578e048b MJ |
41 | #include "component-class.h" |
42 | ||
d94d92ac | 43 | #define BT_ASSERT_PRE_COMP_CLS_HOT(_cc) \ |
0d72b8c3 | 44 | BT_ASSERT_PRE_HOT(((const struct bt_component_class *) (_cc)), \ |
d94d92ac PP |
45 | "Component class", ": %!+C", (_cc)) |
46 | ||
fb2dcc52 | 47 | static |
d94d92ac | 48 | void destroy_component_class(struct bt_object *obj) |
fb2dcc52 JG |
49 | { |
50 | struct bt_component_class *class; | |
33b34c43 | 51 | int i; |
fb2dcc52 | 52 | |
f6ccaed9 | 53 | BT_ASSERT(obj); |
b8a06801 | 54 | class = container_of(obj, struct bt_component_class, base); |
33b34c43 | 55 | |
3f7d4d90 | 56 | BT_LIB_LOGI("Destroying component class: %!+C", class); |
a3aacb6f | 57 | |
33b34c43 PP |
58 | /* Call destroy listeners in reverse registration order */ |
59 | for (i = class->destroy_listeners->len - 1; i >= 0; i--) { | |
d3e4dcd8 | 60 | struct bt_component_class_destroy_listener *listener = |
33b34c43 | 61 | &g_array_index(class->destroy_listeners, |
d3e4dcd8 | 62 | struct bt_component_class_destroy_listener, |
33b34c43 PP |
63 | i); |
64 | ||
a3aacb6f PP |
65 | BT_LOGD("Calling destroy listener: func-addr=%p, data-addr=%p", |
66 | listener->func, listener->data); | |
33b34c43 PP |
67 | listener->func(class, listener->data); |
68 | } | |
69 | ||
fb2dcc52 JG |
70 | if (class->name) { |
71 | g_string_free(class->name, TRUE); | |
d94d92ac | 72 | class->name = NULL; |
fb2dcc52 | 73 | } |
d94d92ac | 74 | |
7c7c0433 JG |
75 | if (class->description) { |
76 | g_string_free(class->description, TRUE); | |
d94d92ac | 77 | class->description = NULL; |
7c7c0433 | 78 | } |
d94d92ac | 79 | |
5536d9a6 PP |
80 | if (class->help) { |
81 | g_string_free(class->help, TRUE); | |
d94d92ac | 82 | class->help = NULL; |
5536d9a6 | 83 | } |
d94d92ac | 84 | |
33b34c43 PP |
85 | if (class->destroy_listeners) { |
86 | g_array_free(class->destroy_listeners, TRUE); | |
d94d92ac | 87 | class->destroy_listeners = NULL; |
33b34c43 | 88 | } |
b8a06801 | 89 | |
fb2dcc52 JG |
90 | g_free(class); |
91 | } | |
92 | ||
d3e4dcd8 PP |
93 | static |
94 | int bt_component_class_init(struct bt_component_class *class, | |
95 | enum bt_component_class_type type, const char *name) | |
fb2dcc52 | 96 | { |
d3e4dcd8 PP |
97 | int ret = 0; |
98 | ||
d94d92ac | 99 | bt_object_init_shared(&class->base, destroy_component_class); |
d3e4dcd8 PP |
100 | class->type = type; |
101 | class->name = g_string_new(name); | |
102 | if (!class->name) { | |
a3aacb6f | 103 | BT_LOGE_STR("Failed to allocate a GString."); |
d3e4dcd8 PP |
104 | goto error; |
105 | } | |
106 | ||
107 | class->description = g_string_new(NULL); | |
108 | if (!class->description) { | |
a3aacb6f | 109 | BT_LOGE_STR("Failed to allocate a GString."); |
d3e4dcd8 PP |
110 | goto error; |
111 | } | |
112 | ||
5536d9a6 PP |
113 | class->help = g_string_new(NULL); |
114 | if (!class->help) { | |
a3aacb6f | 115 | BT_LOGE_STR("Failed to allocate a GString."); |
5536d9a6 PP |
116 | goto error; |
117 | } | |
118 | ||
d3e4dcd8 PP |
119 | class->destroy_listeners = g_array_new(FALSE, TRUE, |
120 | sizeof(struct bt_component_class_destroy_listener)); | |
121 | if (!class->destroy_listeners) { | |
a3aacb6f | 122 | BT_LOGE_STR("Failed to allocate a GArray."); |
d3e4dcd8 PP |
123 | goto error; |
124 | } | |
125 | ||
126 | goto end; | |
6ba0b073 | 127 | |
d3e4dcd8 | 128 | error: |
65300d60 | 129 | BT_OBJECT_PUT_REF_AND_RESET(class); |
d3e4dcd8 PP |
130 | ret = -1; |
131 | ||
132 | end: | |
133 | return ret; | |
134 | } | |
135 | ||
0d72b8c3 | 136 | struct bt_component_class_source *bt_component_class_source_create( |
d94d92ac | 137 | const char *name, |
d6e69534 | 138 | bt_component_class_source_message_iterator_next_method method) |
d3e4dcd8 PP |
139 | { |
140 | struct bt_component_class_source *source_class = NULL; | |
141 | int ret; | |
142 | ||
d94d92ac | 143 | BT_ASSERT_PRE_NON_NULL(name, "Name"); |
d6e69534 | 144 | BT_ASSERT_PRE_NON_NULL(method, "Message iterator next method"); |
3f7d4d90 | 145 | BT_LOGI("Creating source component class: " |
d6e69534 | 146 | "name=\"%s\", msg-iter-next-method-addr=%p", |
90157d89 | 147 | name, method); |
d3e4dcd8 PP |
148 | source_class = g_new0(struct bt_component_class_source, 1); |
149 | if (!source_class) { | |
a3aacb6f | 150 | BT_LOGE_STR("Failed to allocate one source component class."); |
fb2dcc52 JG |
151 | goto end; |
152 | } | |
153 | ||
a3aacb6f | 154 | /* bt_component_class_init() logs errors */ |
d3e4dcd8 PP |
155 | ret = bt_component_class_init(&source_class->parent, |
156 | BT_COMPONENT_CLASS_TYPE_SOURCE, name); | |
157 | if (ret) { | |
158 | /* | |
159 | * If bt_component_class_init() fails, the component | |
160 | * class is put, therefore its memory is already | |
161 | * freed. | |
162 | */ | |
163 | source_class = NULL; | |
164 | goto end; | |
165 | } | |
166 | ||
d6e69534 | 167 | source_class->methods.msg_iter_next = method; |
3f7d4d90 | 168 | BT_LIB_LOGI("Created source component class: %!+C", source_class); |
d3e4dcd8 PP |
169 | |
170 | end: | |
d94d92ac | 171 | return (void *) source_class; |
d3e4dcd8 PP |
172 | } |
173 | ||
0d72b8c3 PP |
174 | struct bt_component_class_filter *bt_component_class_filter_create( |
175 | const char *name, | |
d6e69534 | 176 | bt_component_class_filter_message_iterator_next_method method) |
d3e4dcd8 PP |
177 | { |
178 | struct bt_component_class_filter *filter_class = NULL; | |
179 | int ret; | |
180 | ||
d94d92ac | 181 | BT_ASSERT_PRE_NON_NULL(name, "Name"); |
d6e69534 | 182 | BT_ASSERT_PRE_NON_NULL(method, "Message iterator next method"); |
3f7d4d90 | 183 | BT_LOGI("Creating filter component class: " |
d6e69534 | 184 | "name=\"%s\", msg-iter-next-method-addr=%p", |
90157d89 | 185 | name, method); |
d3e4dcd8 PP |
186 | filter_class = g_new0(struct bt_component_class_filter, 1); |
187 | if (!filter_class) { | |
a3aacb6f | 188 | BT_LOGE_STR("Failed to allocate one filter component class."); |
d3e4dcd8 | 189 | goto end; |
6ba0b073 PP |
190 | } |
191 | ||
a3aacb6f | 192 | /* bt_component_class_init() logs errors */ |
d3e4dcd8 PP |
193 | ret = bt_component_class_init(&filter_class->parent, |
194 | BT_COMPONENT_CLASS_TYPE_FILTER, name); | |
195 | if (ret) { | |
196 | /* | |
197 | * If bt_component_class_init() fails, the component | |
198 | * class is put, therefore its memory is already | |
199 | * freed. | |
200 | */ | |
201 | filter_class = NULL; | |
33b34c43 PP |
202 | goto end; |
203 | } | |
d3e4dcd8 | 204 | |
d6e69534 | 205 | filter_class->methods.msg_iter_next = method; |
3f7d4d90 | 206 | BT_LIB_LOGI("Created filter component class: %!+C", filter_class); |
d3e4dcd8 | 207 | |
fb2dcc52 | 208 | end: |
d94d92ac | 209 | return (void *) filter_class; |
d3e4dcd8 PP |
210 | } |
211 | ||
0d72b8c3 PP |
212 | struct bt_component_class_sink *bt_component_class_sink_create( |
213 | const char *name, bt_component_class_sink_consume_method method) | |
d3e4dcd8 PP |
214 | { |
215 | struct bt_component_class_sink *sink_class = NULL; | |
216 | int ret; | |
217 | ||
d94d92ac PP |
218 | BT_ASSERT_PRE_NON_NULL(name, "Name"); |
219 | BT_ASSERT_PRE_NON_NULL(method, "Consume next method"); | |
3f7d4d90 | 220 | BT_LOGI("Creating sink component class: " |
a3aacb6f | 221 | "name=\"%s\", consume-method-addr=%p", |
90157d89 | 222 | name, method); |
d3e4dcd8 PP |
223 | sink_class = g_new0(struct bt_component_class_sink, 1); |
224 | if (!sink_class) { | |
a3aacb6f | 225 | BT_LOGE_STR("Failed to allocate one sink component class."); |
d3e4dcd8 PP |
226 | goto end; |
227 | } | |
228 | ||
a3aacb6f | 229 | /* bt_component_class_init() logs errors */ |
d3e4dcd8 PP |
230 | ret = bt_component_class_init(&sink_class->parent, |
231 | BT_COMPONENT_CLASS_TYPE_SINK, name); | |
232 | if (ret) { | |
233 | /* | |
234 | * If bt_component_class_init() fails, the component | |
235 | * class is put, therefore its memory is already | |
236 | * freed. | |
237 | */ | |
238 | sink_class = NULL; | |
239 | goto end; | |
240 | } | |
241 | ||
90157d89 | 242 | sink_class->methods.consume = method; |
3f7d4d90 | 243 | BT_LIB_LOGI("Created sink component class: %!+C", sink_class); |
d3e4dcd8 PP |
244 | |
245 | end: | |
d94d92ac | 246 | return (void *) sink_class; |
d3e4dcd8 PP |
247 | } |
248 | ||
5badd463 | 249 | enum bt_component_class_status |
7474e7d3 | 250 | bt_component_class_source_set_init_method( |
0d72b8c3 PP |
251 | struct bt_component_class_source *comp_cls, |
252 | bt_component_class_source_init_method method) | |
d3e4dcd8 | 253 | { |
d94d92ac PP |
254 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
255 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
256 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
257 | comp_cls->methods.init = method; | |
3f7d4d90 | 258 | BT_LIB_LOGD("Set source component class's initialization method: " |
d94d92ac | 259 | "%!+C", comp_cls); |
d0cf29ee | 260 | return BT_COMPONENT_CLASS_STATUS_OK; |
d3e4dcd8 PP |
261 | } |
262 | ||
5badd463 | 263 | enum bt_component_class_status |
7474e7d3 | 264 | bt_component_class_filter_set_init_method( |
0d72b8c3 PP |
265 | struct bt_component_class_filter *comp_cls, |
266 | bt_component_class_filter_init_method method) | |
efa96d5d | 267 | { |
d94d92ac PP |
268 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
269 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
270 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
271 | comp_cls->methods.init = method; | |
3f7d4d90 | 272 | BT_LIB_LOGD("Set filter component class's initialization method: " |
d94d92ac | 273 | "%!+C", comp_cls); |
d0cf29ee | 274 | return BT_COMPONENT_CLASS_STATUS_OK; |
efa96d5d PP |
275 | } |
276 | ||
5badd463 | 277 | enum bt_component_class_status |
7474e7d3 | 278 | bt_component_class_sink_set_init_method( |
0d72b8c3 PP |
279 | struct bt_component_class_sink *comp_cls, |
280 | bt_component_class_sink_init_method method) | |
2d41b99e | 281 | { |
d94d92ac PP |
282 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
283 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
284 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
285 | comp_cls->methods.init = method; | |
3f7d4d90 | 286 | BT_LIB_LOGD("Set sink component class's initialization method: " |
d94d92ac | 287 | "%!+C", comp_cls); |
d0cf29ee | 288 | return BT_COMPONENT_CLASS_STATUS_OK; |
72b913fb PP |
289 | } |
290 | ||
5badd463 | 291 | enum bt_component_class_status |
7474e7d3 | 292 | bt_component_class_source_set_finalize_method( |
0d72b8c3 PP |
293 | struct bt_component_class_source *comp_cls, |
294 | bt_component_class_source_finalize_method method) | |
0d8b4d8e | 295 | { |
d94d92ac PP |
296 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
297 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
298 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
299 | comp_cls->methods.finalize = method; | |
3f7d4d90 | 300 | BT_LIB_LOGD("Set source component class's finalization method: " |
d94d92ac | 301 | "%!+C", comp_cls); |
d0cf29ee | 302 | return BT_COMPONENT_CLASS_STATUS_OK; |
0d8b4d8e PP |
303 | } |
304 | ||
5badd463 | 305 | enum bt_component_class_status |
7474e7d3 | 306 | bt_component_class_filter_set_finalize_method( |
0d72b8c3 PP |
307 | struct bt_component_class_filter *comp_cls, |
308 | bt_component_class_filter_finalize_method method) | |
72b913fb | 309 | { |
d94d92ac PP |
310 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
311 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
312 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
313 | comp_cls->methods.finalize = method; | |
3f7d4d90 | 314 | BT_LIB_LOGD("Set filter component class's finalization method: " |
d94d92ac | 315 | "%!+C", comp_cls); |
d0cf29ee | 316 | return BT_COMPONENT_CLASS_STATUS_OK; |
2d41b99e JG |
317 | } |
318 | ||
5badd463 | 319 | enum bt_component_class_status |
7474e7d3 | 320 | bt_component_class_sink_set_finalize_method( |
0d72b8c3 PP |
321 | struct bt_component_class_sink *comp_cls, |
322 | bt_component_class_sink_finalize_method method) | |
d3e4dcd8 | 323 | { |
d94d92ac PP |
324 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
325 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
326 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
327 | comp_cls->methods.finalize = method; | |
3f7d4d90 | 328 | BT_LIB_LOGD("Set sink component class's finalization method: " |
d94d92ac | 329 | "%!+C", comp_cls); |
d0cf29ee | 330 | return BT_COMPONENT_CLASS_STATUS_OK; |
d3e4dcd8 PP |
331 | } |
332 | ||
5badd463 | 333 | enum bt_component_class_status |
7474e7d3 | 334 | bt_component_class_source_set_query_method( |
0d72b8c3 PP |
335 | struct bt_component_class_source *comp_cls, |
336 | bt_component_class_source_query_method method) | |
d3eb6e8f | 337 | { |
d94d92ac PP |
338 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
339 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
340 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
341 | comp_cls->methods.query = method; | |
3f7d4d90 | 342 | BT_LIB_LOGD("Set source component class's query method: " |
d94d92ac | 343 | "%!+C", comp_cls); |
d0cf29ee | 344 | return BT_COMPONENT_CLASS_STATUS_OK; |
d3eb6e8f PP |
345 | } |
346 | ||
5badd463 | 347 | enum bt_component_class_status |
7474e7d3 | 348 | bt_component_class_filter_set_query_method( |
0d72b8c3 PP |
349 | struct bt_component_class_filter *comp_cls, |
350 | bt_component_class_filter_query_method method) | |
d3eb6e8f | 351 | { |
d94d92ac PP |
352 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
353 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
354 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
355 | comp_cls->methods.query = method; | |
3f7d4d90 | 356 | BT_LIB_LOGD("Set filter component class's query method: " |
d94d92ac | 357 | "%!+C", comp_cls); |
d0cf29ee | 358 | return BT_COMPONENT_CLASS_STATUS_OK; |
d94d92ac | 359 | } |
a3aacb6f | 360 | |
5badd463 | 361 | enum bt_component_class_status |
7474e7d3 | 362 | bt_component_class_sink_set_query_method( |
0d72b8c3 PP |
363 | struct bt_component_class_sink *comp_cls, |
364 | bt_component_class_sink_query_method method) | |
d94d92ac | 365 | { |
d94d92ac PP |
366 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
367 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
368 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
369 | comp_cls->methods.query = method; | |
3f7d4d90 | 370 | BT_LIB_LOGD("Set sink component class's query method: " |
d94d92ac | 371 | "%!+C", comp_cls); |
d0cf29ee | 372 | return BT_COMPONENT_CLASS_STATUS_OK; |
d94d92ac | 373 | } |
d3eb6e8f | 374 | |
5badd463 | 375 | enum bt_component_class_status |
7474e7d3 | 376 | bt_component_class_filter_set_input_port_connected_method( |
0d72b8c3 PP |
377 | struct bt_component_class_filter *comp_cls, |
378 | bt_component_class_filter_input_port_connected_method method) | |
d94d92ac | 379 | { |
d94d92ac PP |
380 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
381 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
382 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
383 | comp_cls->methods.input_port_connected = method; | |
3f7d4d90 | 384 | BT_LIB_LOGD("Set filter component class's \"input port connected\" method" |
d94d92ac | 385 | ": %!+C", comp_cls); |
d0cf29ee | 386 | return BT_COMPONENT_CLASS_STATUS_OK; |
d94d92ac | 387 | } |
a3aacb6f | 388 | |
5badd463 | 389 | enum bt_component_class_status |
7474e7d3 | 390 | bt_component_class_sink_set_input_port_connected_method( |
0d72b8c3 PP |
391 | struct bt_component_class_sink *comp_cls, |
392 | bt_component_class_sink_input_port_connected_method method) | |
d94d92ac | 393 | { |
d94d92ac PP |
394 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
395 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
396 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
397 | comp_cls->methods.input_port_connected = method; | |
3f7d4d90 | 398 | BT_LIB_LOGD("Set sink component class's \"input port connected\" method" |
d94d92ac | 399 | ": %!+C", comp_cls); |
d0cf29ee | 400 | return BT_COMPONENT_CLASS_STATUS_OK; |
d94d92ac | 401 | } |
a3aacb6f | 402 | |
5badd463 | 403 | enum bt_component_class_status |
7474e7d3 | 404 | bt_component_class_source_set_output_port_connected_method( |
0d72b8c3 PP |
405 | struct bt_component_class_source *comp_cls, |
406 | bt_component_class_source_output_port_connected_method method) | |
d94d92ac | 407 | { |
d94d92ac PP |
408 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
409 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
410 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
411 | comp_cls->methods.output_port_connected = method; | |
3f7d4d90 | 412 | BT_LIB_LOGD("Set source component class's \"output port connected\" method" |
d94d92ac | 413 | ": %!+C", comp_cls); |
d0cf29ee | 414 | return BT_COMPONENT_CLASS_STATUS_OK; |
d94d92ac | 415 | } |
d3eb6e8f | 416 | |
5badd463 | 417 | enum bt_component_class_status |
7474e7d3 | 418 | bt_component_class_filter_set_output_port_connected_method( |
0d72b8c3 PP |
419 | struct bt_component_class_filter *comp_cls, |
420 | bt_component_class_filter_output_port_connected_method method) | |
d94d92ac | 421 | { |
d94d92ac PP |
422 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
423 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
424 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
425 | comp_cls->methods.output_port_connected = method; | |
3f7d4d90 | 426 | BT_LIB_LOGD("Set filter component class's \"output port connected\" method" |
d94d92ac | 427 | ": %!+C", comp_cls); |
d0cf29ee | 428 | return BT_COMPONENT_CLASS_STATUS_OK; |
d94d92ac | 429 | } |
d3eb6e8f | 430 | |
5badd463 PP |
431 | enum bt_component_class_status |
432 | bt_component_class_sink_set_graph_is_configured_method( | |
433 | struct bt_component_class_sink *comp_cls, | |
434 | bt_component_class_sink_graph_is_configured_method method) | |
435 | { | |
436 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
437 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
438 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
439 | comp_cls->methods.graph_is_configured = method; | |
3f7d4d90 | 440 | BT_LIB_LOGD("Set sink component class's \"graph is configured\" method" |
5badd463 PP |
441 | ": %!+C", comp_cls); |
442 | return BT_COMPONENT_CLASS_STATUS_OK; | |
443 | } | |
444 | ||
d6e69534 | 445 | int bt_component_class_source_set_message_iterator_init_method( |
0d72b8c3 | 446 | struct bt_component_class_source *comp_cls, |
d6e69534 | 447 | bt_component_class_source_message_iterator_init_method method) |
d94d92ac | 448 | { |
d94d92ac PP |
449 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
450 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
451 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
d6e69534 | 452 | comp_cls->methods.msg_iter_init = method; |
3f7d4d90 | 453 | BT_LIB_LOGD("Set source component class's message iterator initialization method" |
d94d92ac | 454 | ": %!+C", comp_cls); |
d0cf29ee | 455 | return BT_COMPONENT_CLASS_STATUS_OK; |
d94d92ac | 456 | } |
a3aacb6f | 457 | |
5badd463 | 458 | enum bt_component_class_status |
7474e7d3 | 459 | bt_component_class_filter_set_message_iterator_init_method( |
0d72b8c3 | 460 | struct bt_component_class_filter *comp_cls, |
d6e69534 | 461 | bt_component_class_filter_message_iterator_init_method method) |
d94d92ac | 462 | { |
d94d92ac PP |
463 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
464 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
465 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
d6e69534 | 466 | comp_cls->methods.msg_iter_init = method; |
3f7d4d90 | 467 | BT_LIB_LOGD("Set filter component class's message iterator initialization method" |
d94d92ac | 468 | ": %!+C", comp_cls); |
d0cf29ee | 469 | return BT_COMPONENT_CLASS_STATUS_OK; |
d94d92ac | 470 | } |
d3eb6e8f | 471 | |
5badd463 | 472 | enum bt_component_class_status |
7474e7d3 | 473 | bt_component_class_source_set_message_iterator_finalize_method( |
0d72b8c3 | 474 | struct bt_component_class_source *comp_cls, |
d6e69534 | 475 | bt_component_class_source_message_iterator_finalize_method method) |
d94d92ac | 476 | { |
d94d92ac PP |
477 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
478 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
479 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
d6e69534 | 480 | comp_cls->methods.msg_iter_finalize = method; |
3f7d4d90 | 481 | BT_LIB_LOGD("Set source component class's message iterator finalization method" |
d94d92ac | 482 | ": %!+C", comp_cls); |
d0cf29ee | 483 | return BT_COMPONENT_CLASS_STATUS_OK; |
d94d92ac | 484 | } |
d3eb6e8f | 485 | |
5badd463 | 486 | enum bt_component_class_status |
7474e7d3 | 487 | bt_component_class_filter_set_message_iterator_finalize_method( |
0d72b8c3 | 488 | struct bt_component_class_filter *comp_cls, |
d6e69534 | 489 | bt_component_class_filter_message_iterator_finalize_method method) |
d94d92ac | 490 | { |
d94d92ac PP |
491 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
492 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
493 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
d6e69534 | 494 | comp_cls->methods.msg_iter_finalize = method; |
3f7d4d90 | 495 | BT_LIB_LOGD("Set filter component class's message iterator finalization method" |
d94d92ac | 496 | ": %!+C", comp_cls); |
d0cf29ee | 497 | return BT_COMPONENT_CLASS_STATUS_OK; |
d3eb6e8f PP |
498 | } |
499 | ||
7474e7d3 PP |
500 | enum bt_component_class_status |
501 | bt_component_class_filter_set_message_iterator_seek_ns_from_origin_method( | |
502 | struct bt_component_class_filter *comp_cls, | |
503 | bt_component_class_filter_message_iterator_seek_ns_from_origin_method method) | |
504 | { | |
505 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
506 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
507 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
508 | comp_cls->methods.msg_iter_seek_ns_from_origin = method; | |
3f7d4d90 | 509 | BT_LIB_LOGD("Set filter component class's message iterator \"seek nanoseconds from origin\" method" |
7474e7d3 PP |
510 | ": %!+C", comp_cls); |
511 | return BT_COMPONENT_CLASS_STATUS_OK; | |
512 | } | |
513 | ||
514 | enum bt_component_class_status | |
515 | bt_component_class_source_set_message_iterator_seek_ns_from_origin_method( | |
516 | struct bt_component_class_source *comp_cls, | |
517 | bt_component_class_source_message_iterator_seek_ns_from_origin_method method) | |
518 | { | |
519 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
520 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
521 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
522 | comp_cls->methods.msg_iter_seek_ns_from_origin = method; | |
3f7d4d90 | 523 | BT_LIB_LOGD("Set source component class's message iterator \"seek nanoseconds from origin\" method" |
7474e7d3 PP |
524 | ": %!+C", comp_cls); |
525 | return BT_COMPONENT_CLASS_STATUS_OK; | |
526 | } | |
527 | ||
528 | enum bt_component_class_status | |
529 | bt_component_class_filter_set_message_iterator_seek_beginning_method( | |
530 | struct bt_component_class_filter *comp_cls, | |
531 | bt_component_class_filter_message_iterator_seek_beginning_method method) | |
532 | { | |
533 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
534 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
535 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
536 | comp_cls->methods.msg_iter_seek_beginning = method; | |
3f7d4d90 | 537 | BT_LIB_LOGD("Set filter component class's message iterator \"seek beginning\" method" |
7474e7d3 PP |
538 | ": %!+C", comp_cls); |
539 | return BT_COMPONENT_CLASS_STATUS_OK; | |
540 | } | |
541 | ||
542 | enum bt_component_class_status | |
543 | bt_component_class_source_set_message_iterator_seek_beginning_method( | |
544 | struct bt_component_class_source *comp_cls, | |
545 | bt_component_class_source_message_iterator_seek_beginning_method method) | |
546 | { | |
547 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
548 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
549 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
550 | comp_cls->methods.msg_iter_seek_beginning = method; | |
3f7d4d90 | 551 | BT_LIB_LOGD("Set source component class's message iterator \"seek beginning\" method" |
7474e7d3 PP |
552 | ": %!+C", comp_cls); |
553 | return BT_COMPONENT_CLASS_STATUS_OK; | |
554 | } | |
555 | ||
556 | enum bt_component_class_status | |
557 | bt_component_class_filter_set_message_iterator_can_seek_beginning_method( | |
558 | struct bt_component_class_filter *comp_cls, | |
559 | bt_component_class_filter_message_iterator_can_seek_beginning_method method) | |
560 | { | |
561 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
562 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
563 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
564 | comp_cls->methods.msg_iter_can_seek_beginning = method; | |
3f7d4d90 | 565 | BT_LIB_LOGD("Set filter component class's message iterator \"can seek beginning\" method" |
7474e7d3 PP |
566 | ": %!+C", comp_cls); |
567 | return BT_COMPONENT_CLASS_STATUS_OK; | |
568 | } | |
569 | ||
570 | enum bt_component_class_status | |
571 | bt_component_class_source_set_message_iterator_can_seek_beginning_method( | |
572 | struct bt_component_class_source *comp_cls, | |
573 | bt_component_class_source_message_iterator_can_seek_beginning_method method) | |
574 | { | |
575 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
576 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
577 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
578 | comp_cls->methods.msg_iter_can_seek_beginning = method; | |
3f7d4d90 | 579 | BT_LIB_LOGD("Set source component class's message iterator \"can seek beginning\" method" |
7474e7d3 PP |
580 | ": %!+C", comp_cls); |
581 | return BT_COMPONENT_CLASS_STATUS_OK; | |
582 | } | |
583 | ||
584 | enum bt_component_class_status | |
585 | bt_component_class_filter_set_message_iterator_can_seek_ns_from_origin_method( | |
586 | struct bt_component_class_filter *comp_cls, | |
587 | bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method method) | |
588 | { | |
589 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
590 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
591 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
592 | comp_cls->methods.msg_iter_can_seek_ns_from_origin = method; | |
3f7d4d90 | 593 | BT_LIB_LOGD("Set filter component class's message iterator \"can seek nanoseconds from origin\" method" |
7474e7d3 PP |
594 | ": %!+C", comp_cls); |
595 | return BT_COMPONENT_CLASS_STATUS_OK; | |
596 | } | |
597 | ||
598 | enum bt_component_class_status | |
599 | bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method( | |
600 | struct bt_component_class_source *comp_cls, | |
601 | bt_component_class_source_message_iterator_can_seek_ns_from_origin_method method) | |
602 | { | |
603 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
604 | BT_ASSERT_PRE_NON_NULL(method, "Method"); | |
605 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
606 | comp_cls->methods.msg_iter_can_seek_ns_from_origin = method; | |
3f7d4d90 | 607 | BT_LIB_LOGD("Set source component class's message iterator \"can seek nanoseconds from origin\" method" |
7474e7d3 PP |
608 | ": %!+C", comp_cls); |
609 | return BT_COMPONENT_CLASS_STATUS_OK; | |
610 | } | |
611 | ||
d0cf29ee | 612 | bt_component_class_status bt_component_class_set_description( |
0d72b8c3 | 613 | struct bt_component_class *comp_cls, |
d3e4dcd8 PP |
614 | const char *description) |
615 | { | |
d94d92ac PP |
616 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
617 | BT_ASSERT_PRE_NON_NULL(description, "Description"); | |
618 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
619 | g_string_assign(comp_cls->description, description); | |
3f7d4d90 | 620 | BT_LIB_LOGD("Set component class's description: " |
a3aacb6f | 621 | "addr=%p, name=\"%s\", type=%s", |
d94d92ac PP |
622 | comp_cls, |
623 | bt_component_class_get_name(comp_cls), | |
624 | bt_component_class_type_string(comp_cls->type)); | |
d0cf29ee | 625 | return BT_COMPONENT_CLASS_STATUS_OK; |
fb2dcc52 | 626 | } |
38b48196 | 627 | |
d0cf29ee | 628 | bt_component_class_status bt_component_class_set_help( |
0d72b8c3 | 629 | struct bt_component_class *comp_cls, |
5536d9a6 PP |
630 | const char *help) |
631 | { | |
d94d92ac PP |
632 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
633 | BT_ASSERT_PRE_NON_NULL(help, "Help"); | |
634 | BT_ASSERT_PRE_COMP_CLS_HOT(comp_cls); | |
635 | g_string_assign(comp_cls->help, help); | |
3f7d4d90 | 636 | BT_LIB_LOGD("Set component class's help text: %!+C", comp_cls); |
d0cf29ee | 637 | return BT_COMPONENT_CLASS_STATUS_OK; |
5536d9a6 PP |
638 | } |
639 | ||
0d72b8c3 | 640 | const char *bt_component_class_get_name(const struct bt_component_class *comp_cls) |
38b48196 | 641 | { |
d94d92ac PP |
642 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
643 | return comp_cls->name->str; | |
38b48196 JG |
644 | } |
645 | ||
d3e4dcd8 | 646 | enum bt_component_class_type bt_component_class_get_type( |
0d72b8c3 | 647 | const struct bt_component_class *comp_cls) |
38b48196 | 648 | { |
d94d92ac PP |
649 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
650 | return comp_cls->type; | |
38b48196 JG |
651 | } |
652 | ||
33b34c43 | 653 | const char *bt_component_class_get_description( |
0d72b8c3 | 654 | const struct bt_component_class *comp_cls) |
38b48196 | 655 | { |
d94d92ac PP |
656 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
657 | return comp_cls->description && | |
658 | comp_cls->description->str[0] != '\0' ? | |
659 | comp_cls->description->str : NULL; | |
38b48196 | 660 | } |
7c7c0433 | 661 | |
5536d9a6 | 662 | const char *bt_component_class_get_help( |
0d72b8c3 | 663 | const struct bt_component_class *comp_cls) |
5536d9a6 | 664 | { |
d94d92ac PP |
665 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
666 | return comp_cls->help && | |
667 | comp_cls->help->str[0] != '\0' ? comp_cls->help->str : NULL; | |
5536d9a6 PP |
668 | } |
669 | ||
33b34c43 | 670 | BT_HIDDEN |
d94d92ac PP |
671 | void bt_component_class_add_destroy_listener( |
672 | struct bt_component_class *comp_cls, | |
33b34c43 | 673 | bt_component_class_destroy_listener_func func, void *data) |
7c7c0433 | 674 | { |
d3e4dcd8 | 675 | struct bt_component_class_destroy_listener listener; |
33b34c43 | 676 | |
d94d92ac | 677 | BT_ASSERT(comp_cls); |
f6ccaed9 | 678 | BT_ASSERT(func); |
33b34c43 PP |
679 | listener.func = func; |
680 | listener.data = data; | |
d94d92ac | 681 | g_array_append_val(comp_cls->destroy_listeners, listener); |
3f7d4d90 | 682 | BT_LIB_LOGD("Added destroy listener to component class: " |
d94d92ac | 683 | "%![cc-]+C, listener-func-addr=%p", comp_cls, func); |
7c7c0433 | 684 | } |
d3e4dcd8 | 685 | |
d94d92ac | 686 | BT_HIDDEN |
0d72b8c3 | 687 | void _bt_component_class_freeze(const struct bt_component_class *comp_cls) |
1e4d8103 | 688 | { |
d94d92ac PP |
689 | BT_ASSERT(comp_cls); |
690 | BT_LIB_LOGD("Freezing component class: %!+C", comp_cls); | |
0d72b8c3 | 691 | ((struct bt_component_class *) comp_cls)->frozen = true; |
1e4d8103 | 692 | } |
c5b9b441 PP |
693 | |
694 | void bt_component_class_get_ref( | |
695 | const struct bt_component_class *component_class) | |
696 | { | |
697 | bt_object_get_ref(component_class); | |
698 | } | |
699 | ||
700 | void bt_component_class_put_ref( | |
701 | const struct bt_component_class *component_class) | |
702 | { | |
703 | bt_object_put_ref(component_class); | |
704 | } | |
705 | ||
706 | void bt_component_class_source_get_ref( | |
707 | const struct bt_component_class_source *component_class_source) | |
708 | { | |
709 | bt_object_get_ref(component_class_source); | |
710 | } | |
711 | ||
712 | void bt_component_class_source_put_ref( | |
713 | const struct bt_component_class_source *component_class_source) | |
714 | { | |
715 | bt_object_put_ref(component_class_source); | |
716 | } | |
717 | ||
718 | void bt_component_class_filter_get_ref( | |
719 | const struct bt_component_class_filter *component_class_filter) | |
720 | { | |
721 | bt_object_get_ref(component_class_filter); | |
722 | } | |
723 | ||
724 | void bt_component_class_filter_put_ref( | |
725 | const struct bt_component_class_filter *component_class_filter) | |
726 | { | |
727 | bt_object_put_ref(component_class_filter); | |
728 | } | |
729 | ||
730 | void bt_component_class_sink_get_ref( | |
731 | const struct bt_component_class_sink *component_class_sink) | |
732 | { | |
733 | bt_object_get_ref(component_class_sink); | |
734 | } | |
735 | ||
736 | void bt_component_class_sink_put_ref( | |
737 | const struct bt_component_class_sink *component_class_sink) | |
738 | { | |
739 | bt_object_put_ref(component_class_sink); | |
740 | } |