2 * The MIT License (MIT)
4 * Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 /* Output argument typemap for connection output (always appends) */
26 %typemap(in, numinputs=0)
27 (const bt_connection **)
28 (bt_connection *temp_conn = NULL) {
33 (const bt_connection **) {
35 /* SWIG_Python_AppendOutput() steals the created object */
36 $result = SWIG_Python_AppendOutput($result,
37 SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
38 SWIGTYPE_p_bt_connection, 0));
40 /* SWIG_Python_AppendOutput() steals Py_None */
42 $result = SWIG_Python_AppendOutput($result, Py_None);
46 /* Output argument typemap for component output (always appends) */
47 %typemap(in, numinputs=0)
48 (const bt_component_source **)
49 (bt_component_source *temp_comp = NULL) {
53 %typemap(in, numinputs=0)
54 (const bt_component_filter **)
55 (bt_component_filter *temp_comp = NULL) {
59 %typemap(in, numinputs=0)
60 (const bt_component_sink **)
61 (bt_component_sink *temp_comp = NULL) {
65 %typemap(argout) (const bt_component_source **) {
67 /* SWIG_Python_AppendOutput() steals the created object */
68 $result = SWIG_Python_AppendOutput($result,
69 SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
70 SWIGTYPE_p_bt_component_source, 0));
72 /* SWIG_Python_AppendOutput() steals Py_None */
74 $result = SWIG_Python_AppendOutput($result, Py_None);
78 %typemap(argout) (const bt_component_filter **) {
80 /* SWIG_Python_AppendOutput() steals the created object */
81 $result = SWIG_Python_AppendOutput($result,
82 SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
83 SWIGTYPE_p_bt_component_filter, 0));
85 /* SWIG_Python_AppendOutput() steals Py_None */
87 $result = SWIG_Python_AppendOutput($result, Py_None);
91 %typemap(argout) (const bt_component_sink **) {
93 /* SWIG_Python_AppendOutput() steals the created object */
94 $result = SWIG_Python_AppendOutput($result,
95 SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
96 SWIGTYPE_p_bt_component_sink, 0));
98 /* SWIG_Python_AppendOutput() steals Py_None */
100 $result = SWIG_Python_AppendOutput($result, Py_None);
104 %include <babeltrace2/graph/graph-const.h>
105 %include <babeltrace2/graph/graph.h>
107 /* Helper functions for Python */
111 void graph_listener_removed(void *py_callable)
113 BT_ASSERT(py_callable);
114 Py_DECREF(py_callable);
117 static bt_graph_listener_func_status port_added_listener(
118 const void *component,
119 swig_type_info *component_swig_type,
120 bt_component_class_type component_class_type,
122 swig_type_info *port_swig_type,
123 bt_port_type port_type,
126 PyObject *py_component_ptr = NULL;
127 PyObject *py_port_ptr = NULL;
128 PyObject *py_res = NULL;
129 bt_graph_listener_func_status status;
131 py_component_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(component), component_swig_type, 0);
132 if (!py_component_ptr) {
133 BT_LOGF_STR("Failed to create component SWIG pointer object.");
134 status = __BT_FUNC_STATUS_MEMORY_ERROR;
138 py_port_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(port), port_swig_type, 0);
140 BT_LOGF_STR("Failed to create port SWIG pointer object.");
141 status = __BT_FUNC_STATUS_MEMORY_ERROR;
145 py_res = PyObject_CallFunction(py_callable, "(OiOi)",
146 py_component_ptr, component_class_type, py_port_ptr, port_type);
150 status = __BT_FUNC_STATUS_ERROR;
154 BT_ASSERT(py_res == Py_None);
155 status = __BT_FUNC_STATUS_OK;
159 Py_XDECREF(py_port_ptr);
160 Py_XDECREF(py_component_ptr);
165 bt_graph_listener_func_status
166 source_component_output_port_added_listener(const bt_component_source *component_source,
167 const bt_port_output *port_output, void *py_callable)
169 return port_added_listener(
170 component_source, SWIGTYPE_p_bt_component_source, BT_COMPONENT_CLASS_TYPE_SOURCE,
171 port_output, SWIGTYPE_p_bt_port_output, BT_PORT_TYPE_OUTPUT, py_callable);
175 bt_graph_listener_func_status
176 filter_component_input_port_added_listener(const bt_component_filter *component_filter,
177 const bt_port_input *port_input, void *py_callable)
179 return port_added_listener(
180 component_filter, SWIGTYPE_p_bt_component_filter, BT_COMPONENT_CLASS_TYPE_FILTER,
181 port_input, SWIGTYPE_p_bt_port_input, BT_PORT_TYPE_INPUT, py_callable);
185 bt_graph_listener_func_status
186 filter_component_output_port_added_listener(const bt_component_filter *component_filter,
187 const bt_port_output *port_output, void *py_callable)
189 return port_added_listener(
190 component_filter, SWIGTYPE_p_bt_component_filter, BT_COMPONENT_CLASS_TYPE_FILTER,
191 port_output, SWIGTYPE_p_bt_port_output, BT_PORT_TYPE_OUTPUT, py_callable);
195 bt_graph_listener_func_status
196 sink_component_input_port_added_listener(const bt_component_sink *component_sink,
197 const bt_port_input *port_input, void *py_callable)
199 return port_added_listener(
200 component_sink, SWIGTYPE_p_bt_component_sink, BT_COMPONENT_CLASS_TYPE_SINK,
201 port_input, SWIGTYPE_p_bt_port_input, BT_PORT_TYPE_INPUT, py_callable);
205 PyObject *bt_bt2_graph_add_port_added_listener(struct bt_graph *graph,
206 PyObject *py_callable)
208 PyObject *py_listener_ids = NULL;
209 PyObject *py_listener_id = NULL;
211 bt_graph_add_listener_status status;
212 const char * const module_name =
213 "graph_add_port_added_listener() (Python)";
216 BT_ASSERT(py_callable);
219 * Behind the scene, we will be registering 4 different listeners and
220 * return all of their ids.
222 py_listener_ids = PyTuple_New(4);
223 if (!py_listener_ids) {
224 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(module_name,
225 "Failed to allocate one PyTuple.");
229 /* source output port */
230 status = bt_graph_add_source_component_output_port_added_listener(
231 graph, source_component_output_port_added_listener,
232 graph_listener_removed, py_callable, &listener_id);
233 if (status != __BT_FUNC_STATUS_OK) {
235 * bt_graph_add_source_component_output_port_added_listener has
236 * already logged/appended an error cause.
241 py_listener_id = PyLong_FromLong(listener_id);
242 if (!py_listener_id) {
243 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(module_name,
244 "Failed to allocate one PyLong.");
248 PyTuple_SET_ITEM(py_listener_ids, 0, py_listener_id);
249 py_listener_id = NULL;
251 /* filter input port */
252 status = bt_graph_add_filter_component_input_port_added_listener(
253 graph, filter_component_input_port_added_listener,
254 graph_listener_removed, py_callable, &listener_id);
255 if (status != __BT_FUNC_STATUS_OK) {
257 * bt_graph_add_filter_component_input_port_added_listener has
258 * already logged/appended an error cause.
263 py_listener_id = PyLong_FromLong(listener_id);
264 if (!py_listener_id) {
265 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(module_name,
266 "Failed to allocate one PyLong.");
270 PyTuple_SET_ITEM(py_listener_ids, 1, py_listener_id);
271 py_listener_id = NULL;
273 /* filter output port */
274 status = bt_graph_add_filter_component_output_port_added_listener(
275 graph, filter_component_output_port_added_listener,
276 graph_listener_removed, py_callable, &listener_id);
277 if (status != __BT_FUNC_STATUS_OK) {
279 * bt_graph_add_filter_component_output_port_added_listener has
280 * already logged/appended an error cause.
285 py_listener_id = PyLong_FromLong(listener_id);
286 if (!py_listener_id) {
287 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(module_name,
288 "Failed to allocate one PyLong.");
292 PyTuple_SET_ITEM(py_listener_ids, 2, py_listener_id);
293 py_listener_id = NULL;
295 /* sink input port */
296 status = bt_graph_add_sink_component_input_port_added_listener(
297 graph, sink_component_input_port_added_listener,
298 graph_listener_removed, py_callable, &listener_id);
299 if (status != __BT_FUNC_STATUS_OK) {
301 * bt_graph_add_sink_component_input_port_added_listener has
302 * already logged/appended an error cause.
307 py_listener_id = PyLong_FromLong(listener_id);
308 if (!py_listener_id) {
309 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(module_name,
310 "Failed to allocate one PyLong.");
315 PyTuple_SET_ITEM(py_listener_ids, 3, py_listener_id);
316 py_listener_id = NULL;
318 Py_INCREF(py_callable);
319 Py_INCREF(py_callable);
320 Py_INCREF(py_callable);
321 Py_INCREF(py_callable);
326 Py_XDECREF(py_listener_ids);
327 py_listener_ids = Py_None;
328 Py_INCREF(py_listener_ids);
332 Py_XDECREF(py_listener_id);
333 return py_listener_ids;
337 bt_graph_listener_func_status ports_connected_listener(
338 const void *upstream_component,
339 swig_type_info *upstream_component_swig_type,
340 bt_component_class_type upstream_component_class_type,
341 const bt_port_output *upstream_port,
342 const void *downstream_component,
343 swig_type_info *downstream_component_swig_type,
344 bt_component_class_type downstream_component_class_type,
345 const bt_port_input *downstream_port,
348 PyObject *py_upstream_component_ptr = NULL;
349 PyObject *py_upstream_port_ptr = NULL;
350 PyObject *py_downstream_component_ptr = NULL;
351 PyObject *py_downstream_port_ptr = NULL;
352 PyObject *py_res = NULL;
353 bt_graph_listener_func_status status;
355 py_upstream_component_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(upstream_component),
356 upstream_component_swig_type, 0);
357 if (!py_upstream_component_ptr) {
358 BT_LOGF_STR("Failed to create upstream component SWIG pointer object.");
359 status = __BT_FUNC_STATUS_MEMORY_ERROR;
363 py_upstream_port_ptr = SWIG_NewPointerObj(
364 SWIG_as_voidptr(upstream_port), SWIGTYPE_p_bt_port_output, 0);
365 if (!py_upstream_port_ptr) {
366 BT_LOGF_STR("Failed to create upstream port SWIG pointer object.");
367 status = __BT_FUNC_STATUS_MEMORY_ERROR;
371 py_downstream_component_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(downstream_component),
372 downstream_component_swig_type, 0);
373 if (!py_downstream_component_ptr) {
374 BT_LOGF_STR("Failed to create downstream component SWIG pointer object.");
375 status = __BT_FUNC_STATUS_MEMORY_ERROR;
379 py_downstream_port_ptr = SWIG_NewPointerObj(
380 SWIG_as_voidptr(downstream_port), SWIGTYPE_p_bt_port_input, 0);
381 if (!py_downstream_port_ptr) {
382 BT_LOGF_STR("Failed to create downstream port SWIG pointer object.");
383 status = __BT_FUNC_STATUS_MEMORY_ERROR;
387 py_res = PyObject_CallFunction(py_callable, "(OiOOiO)",
388 py_upstream_component_ptr, upstream_component_class_type,
389 py_upstream_port_ptr,
390 py_downstream_component_ptr, downstream_component_class_type,
391 py_downstream_port_ptr);
395 status = __BT_FUNC_STATUS_ERROR;
399 BT_ASSERT(py_res == Py_None);
400 status = __BT_FUNC_STATUS_OK;
403 Py_XDECREF(py_upstream_component_ptr);
404 Py_XDECREF(py_upstream_port_ptr);
405 Py_XDECREF(py_downstream_component_ptr);
406 Py_XDECREF(py_downstream_port_ptr);
412 bt_graph_listener_func_status source_filter_component_ports_connected_listener(
413 const bt_component_source *source_component,
414 const bt_component_filter *filter_component,
415 const bt_port_output *upstream_port,
416 const bt_port_input *downstream_port, void *py_callable)
418 return ports_connected_listener(
419 source_component, SWIGTYPE_p_bt_component_source, BT_COMPONENT_CLASS_TYPE_SOURCE,
421 filter_component, SWIGTYPE_p_bt_component_filter, BT_COMPONENT_CLASS_TYPE_FILTER,
427 bt_graph_listener_func_status source_sink_component_ports_connected_listener(
428 const bt_component_source *source_component,
429 const bt_component_sink *sink_component,
430 const bt_port_output *upstream_port,
431 const bt_port_input *downstream_port, void *py_callable)
433 return ports_connected_listener(
434 source_component, SWIGTYPE_p_bt_component_source, BT_COMPONENT_CLASS_TYPE_SOURCE,
436 sink_component, SWIGTYPE_p_bt_component_sink, BT_COMPONENT_CLASS_TYPE_SINK,
442 bt_graph_listener_func_status filter_filter_component_ports_connected_listener(
443 const bt_component_filter *filter_component_left,
444 const bt_component_filter *filter_component_right,
445 const bt_port_output *upstream_port,
446 const bt_port_input *downstream_port, void *py_callable)
448 return ports_connected_listener(
449 filter_component_left, SWIGTYPE_p_bt_component_filter, BT_COMPONENT_CLASS_TYPE_FILTER,
451 filter_component_right, SWIGTYPE_p_bt_component_filter, BT_COMPONENT_CLASS_TYPE_FILTER,
457 bt_graph_listener_func_status filter_sink_component_ports_connected_listener(
458 const bt_component_filter *filter_component,
459 const bt_component_sink *sink_component,
460 const bt_port_output *upstream_port,
461 const bt_port_input *downstream_port, void *py_callable)
463 return ports_connected_listener(
464 filter_component, SWIGTYPE_p_bt_component_filter, BT_COMPONENT_CLASS_TYPE_FILTER,
466 sink_component, SWIGTYPE_p_bt_component_sink, BT_COMPONENT_CLASS_TYPE_SINK,
472 PyObject *bt_bt2_graph_add_ports_connected_listener(struct bt_graph *graph,
473 PyObject *py_callable)
475 PyObject *py_listener_ids = NULL;
476 PyObject *py_listener_id = NULL;
478 bt_graph_add_listener_status status;
479 const char * const module_name =
480 "graph_add_ports_connected_listener() (Python)";
483 BT_ASSERT(py_callable);
485 /* Behind the scene, we will be registering 4 different listeners and
486 * return all of their ids. */
487 py_listener_ids = PyTuple_New(4);
488 if (!py_listener_ids) {
489 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(module_name,
490 "Failed to allocate one PyTuple.");
494 /* source -> filter connection */
495 status = bt_graph_add_source_filter_component_ports_connected_listener(
496 graph, source_filter_component_ports_connected_listener,
497 graph_listener_removed, py_callable, &listener_id);
498 if (status != __BT_FUNC_STATUS_OK) {
500 * bt_graph_add_source_filter_component_ports_connected_listener
501 * has already logged/appended an error cause.
506 py_listener_id = PyLong_FromLong(listener_id);
507 if (!py_listener_id) {
508 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(module_name,
509 "Failed to allocate one PyLong.");
513 PyTuple_SET_ITEM(py_listener_ids, 0, py_listener_id);
514 py_listener_id = NULL;
516 /* source -> sink connection */
517 status = bt_graph_add_source_sink_component_ports_connected_listener(
518 graph, source_sink_component_ports_connected_listener,
519 graph_listener_removed, py_callable, &listener_id);
520 if (status != __BT_FUNC_STATUS_OK) {
522 * bt_graph_add_source_sink_component_ports_connected_listener
523 * has already logged/appended an error cause.
528 py_listener_id = PyLong_FromLong(listener_id);
529 if (!py_listener_id) {
530 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(module_name,
531 "Failed to allocate one PyLong.");
535 PyTuple_SET_ITEM(py_listener_ids, 1, py_listener_id);
536 py_listener_id = NULL;
538 /* filter -> filter connection */
539 status = bt_graph_add_filter_filter_component_ports_connected_listener(
540 graph, filter_filter_component_ports_connected_listener,
541 graph_listener_removed, py_callable, &listener_id);
542 if (status != __BT_FUNC_STATUS_OK) {
544 * bt_graph_add_filter_filter_component_ports_connected_listener
545 * has already logged/appended an error cause.
550 py_listener_id = PyLong_FromLong(listener_id);
551 if (!py_listener_id) {
552 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(module_name,
553 "Failed to allocate one PyLong.");
557 PyTuple_SET_ITEM(py_listener_ids, 2, py_listener_id);
558 py_listener_id = NULL;
560 /* filter -> sink connection */
561 status = bt_graph_add_filter_sink_component_ports_connected_listener(
562 graph, filter_sink_component_ports_connected_listener,
563 graph_listener_removed, py_callable, &listener_id);
564 if (status != __BT_FUNC_STATUS_OK) {
566 * bt_graph_add_filter_sink_component_ports_connected_listener
567 * has already logged/appended an error cause.
572 py_listener_id = PyLong_FromLong(listener_id);
573 if (!py_listener_id) {
574 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(module_name,
575 "Failed to allocate one PyLong.");
579 PyTuple_SET_ITEM(py_listener_ids, 3, py_listener_id);
580 py_listener_id = NULL;
582 Py_INCREF(py_callable);
583 Py_INCREF(py_callable);
584 Py_INCREF(py_callable);
585 Py_INCREF(py_callable);
590 Py_XDECREF(py_listener_ids);
591 py_listener_ids = Py_None;
592 Py_INCREF(py_listener_ids);
596 Py_XDECREF(py_listener_id);
597 return py_listener_ids;
601 PyObject *bt_bt2_graph_add_port_added_listener(struct bt_graph *graph,
602 PyObject *py_callable);
603 PyObject *bt_bt2_graph_add_ports_connected_listener(struct bt_graph *graph,
604 PyObject *py_callable);