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 %include <babeltrace2/graph/component-class.h>
26 %include <babeltrace2/graph/component-class-const.h>
27 %include <babeltrace2/graph/component-class-source-const.h>
28 %include <babeltrace2/graph/component-class-source.h>
29 %include <babeltrace2/graph/component-class-filter-const.h>
30 %include <babeltrace2/graph/component-class-filter.h>
31 %include <babeltrace2/graph/component-class-sink-const.h>
32 %include <babeltrace2/graph/component-class-sink.h>
33 %include <babeltrace2/graph/self-component-class-source.h>
34 %include <babeltrace2/graph/self-component-class-filter.h>
35 %include <babeltrace2/graph/self-component-class-sink.h>
39 * This hash table associates a BT component class object address to a
40 * user-defined Python class (PyObject *). The keys and values are NOT
41 * owned by this hash table. The Python class objects are owned by the
42 * Python module, which should not be unloaded until it is not possible
43 * to create a user Python component anyway.
45 * This hash table is written to when a user-defined Python component
46 * class is created by one of the bt_bt2_component_class_*_create()
49 * This function is read from when a user calls bt_component_create()
50 * with a component class pointer created by one of the functions above.
51 * In this case, the original Python class needs to be found to
52 * instantiate it and associate the created Python component object with
53 * a BT component object instance.
56 static GHashTable *bt_cc_ptr_to_py_cls;
59 void register_cc_ptr_to_py_cls(struct bt_component_class *bt_cc,
62 if (!bt_cc_ptr_to_py_cls) {
64 * Lazy-initializing this GHashTable because GLib
65 * might not be initialized yet and it needs to be
66 * before we call g_hash_table_new()
68 BT_LOGD_STR("Creating native component class to Python component class hash table.");
69 bt_cc_ptr_to_py_cls = g_hash_table_new(g_direct_hash, g_direct_equal);
70 BT_ASSERT(bt_cc_ptr_to_py_cls);
73 g_hash_table_insert(bt_cc_ptr_to_py_cls, (gpointer) bt_cc,
78 PyObject *lookup_cc_ptr_to_py_cls(const bt_component_class *bt_cc)
80 if (!bt_cc_ptr_to_py_cls) {
81 BT_LOGW("Cannot look up Python component class because hash table is NULL: "
82 "comp-cls-addr=%p", bt_cc);
86 return (PyObject *) g_hash_table_lookup(bt_cc_ptr_to_py_cls,
87 (gconstpointer) bt_cc);
92 * Useful Python objects.
95 static PyObject *py_mod_bt2 = NULL;
96 static PyObject *py_mod_bt2_exc_error_type = NULL;
97 static PyObject *py_mod_bt2_exc_try_again_type = NULL;
98 static PyObject *py_mod_bt2_exc_stop_type = NULL;
99 static PyObject *py_mod_bt2_exc_msg_iter_canceled_type = NULL;
100 static PyObject *py_mod_bt2_exc_invalid_object_type = NULL;
101 static PyObject *py_mod_bt2_exc_invalid_params_type = NULL;
102 static PyObject *py_mod_bt2_exc_unsupported_type = NULL;
105 void bt_bt2_cc_init_from_bt2(void)
108 * This is called once the bt2 package is loaded.
110 * Those modules and functions are needed while the package is
111 * used. Loading them here is safe because we know the bt2
112 * package is imported, and we know that the user cannot use the
113 * code here without importing bt2 first.
115 py_mod_bt2 = PyImport_ImportModule("bt2");
116 BT_ASSERT(py_mod_bt2);
117 py_mod_bt2_exc_error_type =
118 PyObject_GetAttrString(py_mod_bt2, "Error");
119 BT_ASSERT(py_mod_bt2_exc_error_type);
120 py_mod_bt2_exc_try_again_type =
121 PyObject_GetAttrString(py_mod_bt2, "TryAgain");
122 BT_ASSERT(py_mod_bt2_exc_try_again_type);
123 py_mod_bt2_exc_stop_type =
124 PyObject_GetAttrString(py_mod_bt2, "Stop");
125 BT_ASSERT(py_mod_bt2_exc_stop_type);
126 py_mod_bt2_exc_invalid_object_type =
127 PyObject_GetAttrString(py_mod_bt2, "InvalidObject");
128 BT_ASSERT(py_mod_bt2_exc_invalid_object_type);
129 py_mod_bt2_exc_invalid_params_type =
130 PyObject_GetAttrString(py_mod_bt2, "InvalidParams");
131 BT_ASSERT(py_mod_bt2_exc_invalid_params_type);
132 py_mod_bt2_exc_unsupported_type =
133 PyObject_GetAttrString(py_mod_bt2, "Unsupported");
134 BT_ASSERT(py_mod_bt2_exc_unsupported_type);
138 void bt_bt2_cc_exit_handler(void)
141 * This is an exit handler (set by the bt2 package).
143 * We only give back the references that we took in
144 * bt_bt2_cc_init_from_bt2() here. The global variables continue
145 * to exist for the code of this file, but they are now borrowed
146 * references. If this code is executed, it means that somehow
147 * the modules are still loaded, so it should be safe to use
148 * them even without a strong reference.
150 * We cannot do this in the library's destructor because it
151 * gets executed once Python is already finalized.
153 Py_XDECREF(py_mod_bt2);
154 Py_XDECREF(py_mod_bt2_exc_error_type);
155 Py_XDECREF(py_mod_bt2_exc_try_again_type);
156 Py_XDECREF(py_mod_bt2_exc_stop_type);
157 Py_XDECREF(py_mod_bt2_exc_msg_iter_canceled_type);
158 Py_XDECREF(py_mod_bt2_exc_invalid_object_type);
159 Py_XDECREF(py_mod_bt2_exc_invalid_params_type);
163 /* Library destructor */
165 __attribute__((destructor))
167 void native_comp_class_dtor(void) {
168 /* Destroy component class association hash table */
169 if (bt_cc_ptr_to_py_cls) {
170 BT_LOGD_STR("Destroying native component class to Python component class hash table.");
171 g_hash_table_destroy(bt_cc_ptr_to_py_cls);
176 void restore_current_thread_error_and_append_exception_chain_recursive(
177 PyObject *py_exc_value,
178 bt_self_component_class *self_component_class,
179 bt_self_component *self_component,
180 bt_self_message_iterator *self_message_iterator,
181 const char *module_name)
183 PyObject *py_exc_cause_value;
184 PyObject *py_exc_type = NULL;
185 PyObject *py_exc_tb = NULL;
186 GString *gstr = NULL;
188 /* If this exception has a cause, handle that one first. */
189 py_exc_cause_value = PyException_GetCause(py_exc_value);
190 if (py_exc_cause_value) {
191 restore_current_thread_error_and_append_exception_chain_recursive(
192 py_exc_cause_value, self_component_class,
193 self_component, self_message_iterator, module_name);
197 * If the raised exception is a bt2.Error, restore the wrapped error.
199 if (PyErr_GivenExceptionMatches(py_exc_value, py_mod_bt2_exc_error_type)) {
200 PyObject *py_error_swig_ptr;
201 const bt_error *error;
205 * We never raise a bt2.Error with a cause: it should be the
208 BT_ASSERT(!py_exc_cause_value);
211 * We steal the error object from the exception, to move
212 * it back as the current thread's error.
214 py_error_swig_ptr = PyObject_GetAttrString(py_exc_value, "_ptr");
215 BT_ASSERT(py_error_swig_ptr);
217 ret = PyObject_SetAttrString(py_exc_value, "_ptr", Py_None);
220 ret = SWIG_ConvertPtr(py_error_swig_ptr, (void **) &error,
221 SWIGTYPE_p_bt_error, 0);
224 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(error);
226 Py_DECREF(py_error_swig_ptr);
229 py_exc_type = PyObject_Type(py_exc_value);
230 py_exc_tb = PyException_GetTraceback(py_exc_value);
232 gstr = bt_py_common_format_exception(py_exc_type, py_exc_value,
233 py_exc_tb, BT_LOG_OUTPUT_LEVEL, false);
235 /* bt_py_common_format_exception has already warned. */
239 if (self_component_class) {
240 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT_CLASS(
241 self_component_class, "%s", gstr->str);
242 } else if (self_component) {
243 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(
244 self_component, "%s", gstr->str);
245 } else if (self_message_iterator) {
246 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR(
247 self_message_iterator, "%s", gstr->str);
249 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
250 module_name, "%s", gstr->str);
255 g_string_free(gstr, TRUE);
258 Py_XDECREF(py_exc_cause_value);
259 Py_XDECREF(py_exc_type);
260 Py_XDECREF(py_exc_tb);
264 * If you have the following code:
268 * something_that_raises_bt2_error()
269 * except bt2.Error as e1:
270 * raise ValueError from e1
271 * except ValueError as e2:
272 * raise TypeError from e2
274 * We will have the following exception chain:
276 * TypeError -> ValueError -> bt2.Error
278 * Where the TypeError is the current exception (obtained from PyErr_Fetch).
280 * The bt2.Error contains a `struct bt_error *` that used to be the current
281 * thread's error, at the moment the exception was raised.
283 * This function gets to the bt2.Error and restores the wrapped
284 * `struct bt_error *` as the current thread's error.
286 * Then, for each exception in the chain, starting with the oldest one, it adds
287 * an error cause to the current thread's error.
290 void restore_bt_error_and_append_current_exception_chain(
291 bt_self_component_class *self_component_class,
292 bt_self_component *self_component,
293 bt_self_message_iterator *self_message_iterator,
294 const char *module_name)
296 BT_ASSERT(PyErr_Occurred());
298 /* Used to access and restore the current exception. */
299 PyObject *py_exc_type;
300 PyObject *py_exc_value;
303 /* Fetch and normalize the Python exception. */
304 PyErr_Fetch(&py_exc_type, &py_exc_value, &py_exc_tb);
305 PyErr_NormalizeException(&py_exc_type, &py_exc_value, &py_exc_tb);
306 BT_ASSERT(py_exc_type);
307 BT_ASSERT(py_exc_value);
308 BT_ASSERT(py_exc_tb);
311 * Set the exception's traceback so it's possible to get it using
312 * PyException_GetTraceback in
313 * restore_current_thread_error_and_append_exception_chain_recursive.
315 PyException_SetTraceback(py_exc_value, py_exc_tb);
317 restore_current_thread_error_and_append_exception_chain_recursive(py_exc_value,
318 self_component_class, self_component, self_message_iterator,
321 PyErr_Restore(py_exc_type, py_exc_value, py_exc_tb);
325 void log_exception_and_maybe_append_error(int log_level,
327 bt_self_component_class *self_component_class,
328 bt_self_component *self_component,
329 bt_self_message_iterator *self_message_iterator,
330 const char *module_name)
334 BT_ASSERT(PyErr_Occurred());
335 gstr = bt_py_common_format_current_exception(BT_LOG_OUTPUT_LEVEL);
337 /* bt_py_common_format_current_exception() logs errors */
341 BT_LOG_WRITE(log_level, BT_LOG_TAG, "%s", gstr->str);
344 restore_bt_error_and_append_current_exception_chain(
345 self_component_class, self_component,
346 self_message_iterator, module_name);
352 g_string_free(gstr, TRUE);
357 void loge_exception(const char *module_name)
359 log_exception_and_maybe_append_error(BT_LOG_ERROR, true, NULL, NULL,
364 void loge_exception_message_iterator(
365 bt_self_message_iterator *self_message_iterator)
367 log_exception_and_maybe_append_error(BT_LOG_ERROR, true, NULL, NULL,
368 self_message_iterator, NULL);
372 void logw_exception(void)
374 log_exception_and_maybe_append_error(BT_LOG_WARNING, false, NULL, NULL,
379 int py_exc_to_status(bt_self_component_class *self_component_class,
380 bt_self_component *self_component,
381 bt_self_message_iterator *self_message_iterator,
382 const char *module_name)
384 int status = __BT_FUNC_STATUS_OK;
385 PyObject *exc = PyErr_Occurred();
391 if (PyErr_GivenExceptionMatches(exc,
392 py_mod_bt2_exc_try_again_type)) {
393 status = __BT_FUNC_STATUS_AGAIN;
394 } else if (PyErr_GivenExceptionMatches(exc,
395 py_mod_bt2_exc_stop_type)) {
396 status = __BT_FUNC_STATUS_END;
397 } else if (PyErr_GivenExceptionMatches(exc,
398 py_mod_bt2_exc_invalid_object_type)) {
399 status = __BT_FUNC_STATUS_INVALID_OBJECT;
400 } else if (PyErr_GivenExceptionMatches(exc,
401 py_mod_bt2_exc_invalid_params_type)) {
402 status = __BT_FUNC_STATUS_INVALID_PARAMS;
403 } else if (PyErr_GivenExceptionMatches(exc,
404 py_mod_bt2_exc_unsupported_type)) {
405 status = __BT_FUNC_STATUS_UNSUPPORTED;
407 /* Unknown exception: convert to general error */
408 log_exception_and_maybe_append_error(BT_LOG_WARNING, true,
409 self_component_class, self_component,
410 self_message_iterator, module_name);
411 status = __BT_FUNC_STATUS_ERROR;
420 int py_exc_to_status_component_class(bt_self_component_class *self_component_class)
422 return py_exc_to_status(self_component_class, NULL, NULL, NULL);
426 int py_exc_to_status_component(bt_self_component *self_component)
428 return py_exc_to_status(NULL, self_component, NULL, NULL);
432 int py_exc_to_status_message_iterator(
433 bt_self_message_iterator *self_message_iterator)
435 return py_exc_to_status(NULL, NULL, self_message_iterator, NULL);
438 /* Component class proxy methods (delegate to the attached Python object) */
441 bt_component_class_init_method_status component_class_init(
442 bt_self_component *self_component,
443 void *self_component_v,
444 swig_type_info *self_comp_cls_type_swig_type,
445 const bt_value *params,
446 void *init_method_data)
448 const bt_component *component = bt_self_component_as_component(self_component);
449 const bt_component_class *component_class = bt_component_borrow_class_const(component);
450 bt_component_class_init_method_status status = __BT_FUNC_STATUS_OK;
451 PyObject *py_cls = NULL;
452 PyObject *py_comp = NULL;
453 PyObject *py_params_ptr = NULL;
454 PyObject *py_comp_ptr = NULL;
456 (void) init_method_data;
458 BT_ASSERT(self_component);
459 BT_ASSERT(self_component_v);
460 BT_ASSERT(self_comp_cls_type_swig_type);
463 * Get the user-defined Python class which created this
464 * component's class in the first place (borrowed
467 py_cls = lookup_cc_ptr_to_py_cls(component_class);
469 BT_LOGE("Cannot find Python class associated to native component class: "
470 "comp-cls-addr=%p", component_class);
474 /* Parameters pointer -> SWIG pointer Python object */
475 py_params_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(params),
476 SWIGTYPE_p_bt_value, 0);
477 if (!py_params_ptr) {
478 BT_LOGE_STR("Failed to create a SWIG pointer object.");
482 py_comp_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(self_component_v),
483 self_comp_cls_type_swig_type, 0);
485 BT_LOGE_STR("Failed to create a SWIG pointer object.");
490 * Do the equivalent of this:
492 * py_comp = py_cls._bt_init_from_native(py_comp_ptr, py_params_ptr)
494 * _UserComponentType._bt_init_from_native() calls the Python
495 * component object's __init__() function.
497 py_comp = PyObject_CallMethod(py_cls,
498 "_bt_init_from_native", "(OO)", py_comp_ptr, py_params_ptr);
500 BT_LOGW("Failed to call Python class's _bt_init_from_native() method: "
501 "py-cls-addr=%p", py_cls);
502 status = py_exc_to_status_component(self_component);
507 * Our user Python component object is now fully created and
508 * initialized by the user. Since we just created it, this
509 * native component is its only (persistent) owner.
511 bt_self_component_set_data(self_component, py_comp);
516 status = __BT_FUNC_STATUS_ERROR;
519 * Clear any exception: we're returning a bad status anyway. If
520 * this call originated from Python (creation from a plugin's
521 * component class, for example), then the user gets an
522 * appropriate creation error.
528 Py_XDECREF(py_params_ptr);
529 Py_XDECREF(py_comp_ptr);
534 * Method of bt_component_class_source to initialize a bt_self_component_source
539 bt_component_class_init_method_status component_class_source_init(
540 bt_self_component_source *self_component_source,
541 const bt_value *params, void *init_method_data)
543 bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source);
544 return component_class_init(
546 self_component_source,
547 SWIGTYPE_p_bt_self_component_source,
548 params, init_method_data);
552 bt_component_class_init_method_status component_class_filter_init(
553 bt_self_component_filter *self_component_filter,
554 const bt_value *params, void *init_method_data)
556 bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter);
557 return component_class_init(
559 self_component_filter,
560 SWIGTYPE_p_bt_self_component_filter,
561 params, init_method_data);
565 bt_component_class_init_method_status component_class_sink_init(
566 bt_self_component_sink *self_component_sink,
567 const bt_value *params, void *init_method_data)
569 bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink);
570 return component_class_init(
573 SWIGTYPE_p_bt_self_component_sink,
574 params, init_method_data);
578 void component_class_finalize(bt_self_component *self_component)
580 PyObject *py_comp = bt_self_component_get_data(self_component);
583 /* Call user's _finalize() method */
584 PyObject *py_method_result = PyObject_CallMethod(py_comp,
587 if (PyErr_Occurred()) {
588 BT_LOGW("User component's _finalize() method raised an exception: ignoring:");
593 * Ignore any exception raised by the _finalize() method because
594 * it won't change anything at this point: the component is
595 * being destroyed anyway.
598 Py_XDECREF(py_method_result);
603 void component_class_source_finalize(bt_self_component_source *self_component_source)
605 bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source);
606 component_class_finalize(self_component);
610 void component_class_filter_finalize(bt_self_component_filter *self_component_filter)
612 bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter);
613 component_class_finalize(self_component);
617 void component_class_sink_finalize(bt_self_component_sink *self_component_sink)
619 bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink);
620 component_class_finalize(self_component);
624 bt_bool component_class_can_seek_beginning(
625 bt_self_message_iterator *self_message_iterator)
628 PyObject *py_result = NULL;
629 bt_bool can_seek_beginning = false;
631 py_iter = bt_self_message_iterator_get_data(self_message_iterator);
634 py_result = PyObject_GetAttrString(py_iter, "_bt_can_seek_beginning_from_native");
636 BT_ASSERT(!py_result || PyBool_Check(py_result));
639 can_seek_beginning = PyObject_IsTrue(py_result);
642 * Once can_seek_beginning can report errors, convert the
643 * exception to a status. For now, log and return false;
645 loge_exception_message_iterator(self_message_iterator);
649 Py_XDECREF(py_result);
651 return can_seek_beginning;
655 bt_component_class_message_iterator_seek_beginning_method_status
656 component_class_seek_beginning(bt_self_message_iterator *self_message_iterator)
660 bt_component_class_message_iterator_seek_beginning_method_status status;
662 py_iter = bt_self_message_iterator_get_data(self_message_iterator);
664 py_result = PyObject_CallMethod(py_iter, "_bt_seek_beginning_from_native",
666 BT_ASSERT(!py_result || py_result == Py_None);
667 status = py_exc_to_status_message_iterator(self_message_iterator);
668 Py_XDECREF(py_result);
673 bt_component_class_port_connected_method_status component_class_port_connected(
674 bt_self_component *self_component,
675 void *self_component_port,
676 swig_type_info *self_component_port_swig_type,
677 bt_port_type self_component_port_type,
678 const void *other_port,
679 swig_type_info *other_port_swig_type)
681 bt_component_class_port_connected_method_status status;
682 PyObject *py_comp = NULL;
683 PyObject *py_self_port_ptr = NULL;
684 PyObject *py_other_port_ptr = NULL;
685 PyObject *py_method_result = NULL;
687 py_comp = bt_self_component_get_data(self_component);
689 py_self_port_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(self_component_port),
690 self_component_port_swig_type, 0);
691 if (!py_self_port_ptr) {
692 BT_LOGF_STR("Failed to create a SWIG pointer object.");
693 status = __BT_FUNC_STATUS_MEMORY_ERROR;
697 py_other_port_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(other_port),
698 other_port_swig_type, 0);
699 if (!py_other_port_ptr) {
700 BT_LOGF_STR("Failed to create a SWIG pointer object.");
701 status = __BT_FUNC_STATUS_MEMORY_ERROR;
704 py_method_result = PyObject_CallMethod(py_comp,
705 "_bt_port_connected_from_native", "(OiO)", py_self_port_ptr,
706 self_component_port_type, py_other_port_ptr);
707 BT_ASSERT(!py_method_result || py_method_result == Py_None);
708 status = py_exc_to_status_component(self_component);
711 Py_XDECREF(py_self_port_ptr);
712 Py_XDECREF(py_other_port_ptr);
713 Py_XDECREF(py_method_result);
718 bt_component_class_port_connected_method_status
719 component_class_source_output_port_connected(
720 bt_self_component_source *self_component_source,
721 bt_self_component_port_output *self_component_port_output,
722 const bt_port_input *other_port_input)
724 bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source);
726 return component_class_port_connected(
728 self_component_port_output,
729 SWIGTYPE_p_bt_self_component_port_output,
732 SWIGTYPE_p_bt_port_input);
736 bt_component_class_port_connected_method_status
737 component_class_filter_input_port_connected(
738 bt_self_component_filter *self_component_filter,
739 bt_self_component_port_input *self_component_port_input,
740 const bt_port_output *other_port_output)
742 bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter);
744 return component_class_port_connected(
746 self_component_port_input,
747 SWIGTYPE_p_bt_self_component_port_input,
750 SWIGTYPE_p_bt_port_output);
754 bt_component_class_port_connected_method_status
755 component_class_filter_output_port_connected(
756 bt_self_component_filter *self_component_filter,
757 bt_self_component_port_output *self_component_port_output,
758 const bt_port_input *other_port_input)
760 bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter);
762 return component_class_port_connected(
764 self_component_port_output,
765 SWIGTYPE_p_bt_self_component_port_output,
768 SWIGTYPE_p_bt_port_input);
772 bt_component_class_port_connected_method_status
773 component_class_sink_input_port_connected(
774 bt_self_component_sink *self_component_sink,
775 bt_self_component_port_input *self_component_port_input,
776 const bt_port_output *other_port_output)
778 bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink);
780 return component_class_port_connected(
782 self_component_port_input,
783 SWIGTYPE_p_bt_self_component_port_input,
786 SWIGTYPE_p_bt_port_output);
790 bt_component_class_sink_graph_is_configured_method_status
791 component_class_sink_graph_is_configured(
792 bt_self_component_sink *self_component_sink)
794 PyObject *py_comp = NULL;
795 PyObject *py_method_result = NULL;
796 bt_component_class_sink_graph_is_configured_method_status status = __BT_FUNC_STATUS_OK;
797 bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink);
799 py_comp = bt_self_component_get_data(self_component);
800 py_method_result = PyObject_CallMethod(py_comp,
801 "_bt_graph_is_configured_from_native", NULL);
802 BT_ASSERT(!py_method_result || py_method_result == Py_None);
803 status = py_exc_to_status_component(self_component);
804 Py_XDECREF(py_method_result);
809 bt_component_class_query_method_status component_class_query(
810 const bt_component_class *component_class,
811 bt_self_component_class *self_component_class,
812 const bt_query_executor *query_executor,
813 const char *object, const bt_value *params,
814 bt_logging_level log_level,
815 const bt_value **result)
817 PyObject *py_cls = NULL;
818 PyObject *py_params_ptr = NULL;
819 PyObject *py_query_exec_ptr = NULL;
820 PyObject *py_query_func = NULL;
821 PyObject *py_object = NULL;
822 PyObject *py_results_addr = NULL;
823 bt_component_class_query_method_status status = __BT_FUNC_STATUS_OK;
825 py_cls = lookup_cc_ptr_to_py_cls(component_class);
827 BT_LOGE("Cannot find Python class associated to native component class: "
828 "comp-cls-addr=%p", component_class);
832 py_params_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(params),
833 SWIGTYPE_p_bt_value, 0);
834 if (!py_params_ptr) {
835 BT_LOGE_STR("Failed to create a SWIG pointer object.");
839 py_query_exec_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(query_executor),
840 SWIGTYPE_p_bt_query_executor, 0);
841 if (!py_query_exec_ptr) {
842 BT_LOGE_STR("Failed to create a SWIG pointer object.");
846 py_object = SWIG_FromCharPtr(object);
848 BT_LOGE_STR("Failed to create a Python string.");
852 py_results_addr = PyObject_CallMethod(py_cls,
853 "_bt_query_from_native", "(OOOi)", py_query_exec_ptr,
854 py_object, py_params_ptr, (int) log_level);
855 if (!py_results_addr) {
856 BT_LOGW("Failed to call Python class's _bt_query_from_native() method: "
857 "py-cls-addr=%p", py_cls);
858 status = py_exc_to_status_component_class(self_component_class);
863 * The returned object, on success, is an integer object
864 * (PyLong) containing the address of a BT value object (new
867 *result = PyLong_AsVoidPtr(py_results_addr);
868 BT_ASSERT(!PyErr_Occurred());
874 status = __BT_FUNC_STATUS_ERROR;
877 Py_XDECREF(py_params_ptr);
878 Py_XDECREF(py_query_exec_ptr);
879 Py_XDECREF(py_query_func);
880 Py_XDECREF(py_object);
881 Py_XDECREF(py_results_addr);
886 bt_component_class_query_method_status component_class_source_query(
887 bt_self_component_class_source *self_component_class_source,
888 const bt_query_executor *query_executor,
889 const char *object, const bt_value *params,
890 bt_logging_level log_level,
891 const bt_value **result)
893 const bt_component_class_source *component_class_source = bt_self_component_class_source_as_component_class_source(self_component_class_source);
894 const bt_component_class *component_class = bt_component_class_source_as_component_class_const(component_class_source);
895 bt_self_component_class *self_component_class = bt_self_component_class_source_as_self_component_class(self_component_class_source);
897 return component_class_query(component_class, self_component_class, query_executor, object, params, log_level, result);
901 bt_component_class_query_method_status component_class_filter_query(
902 bt_self_component_class_filter *self_component_class_filter,
903 const bt_query_executor *query_executor,
904 const char *object, const bt_value *params,
905 bt_logging_level log_level,
906 const bt_value **result)
908 const bt_component_class_filter *component_class_filter = bt_self_component_class_filter_as_component_class_filter(self_component_class_filter);
909 const bt_component_class *component_class = bt_component_class_filter_as_component_class_const(component_class_filter);
910 bt_self_component_class *self_component_class = bt_self_component_class_filter_as_self_component_class(self_component_class_filter);
912 return component_class_query(component_class, self_component_class, query_executor, object, params, log_level, result);
916 bt_component_class_query_method_status component_class_sink_query(
917 bt_self_component_class_sink *self_component_class_sink,
918 const bt_query_executor *query_executor,
919 const char *object, const bt_value *params,
920 bt_logging_level log_level,
921 const bt_value **result)
923 const bt_component_class_sink *component_class_sink = bt_self_component_class_sink_as_component_class_sink(self_component_class_sink);
924 const bt_component_class *component_class = bt_component_class_sink_as_component_class_const(component_class_sink);
925 bt_self_component_class *self_component_class = bt_self_component_class_sink_as_self_component_class(self_component_class_sink);
927 return component_class_query(component_class, self_component_class, query_executor, object, params, log_level, result);
931 bt_component_class_message_iterator_init_method_status
932 component_class_message_iterator_init(
933 bt_self_message_iterator *self_message_iterator,
934 bt_self_component *self_component,
935 bt_self_component_port_output *self_component_port_output)
937 bt_component_class_message_iterator_init_method_status status = __BT_FUNC_STATUS_OK;
938 PyObject *py_comp_cls = NULL;
939 PyObject *py_iter_cls = NULL;
940 PyObject *py_iter_ptr = NULL;
941 PyObject *py_component_port_output_ptr = NULL;
942 PyObject *py_init_method_result = NULL;
943 PyObject *py_iter = NULL;
946 py_comp = bt_self_component_get_data(self_component);
948 /* Find user's Python message iterator class */
949 py_comp_cls = PyObject_GetAttrString(py_comp, "__class__");
951 BT_LOGE_STR("Cannot get Python object's `__class__` attribute.");
955 py_iter_cls = PyObject_GetAttrString(py_comp_cls, "_iter_cls");
957 BT_LOGE_STR("Cannot get Python class's `_iter_cls` attribute.");
961 py_iter_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(self_message_iterator),
962 SWIGTYPE_p_bt_self_message_iterator, 0);
964 const char *err = "Failed to create a SWIG pointer object.";
967 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR(
968 self_message_iterator, err);
973 * Create object with borrowed native message iterator
976 * py_iter = py_iter_cls.__new__(py_iter_cls, py_iter_ptr)
978 py_iter = PyObject_CallMethod(py_iter_cls, "__new__",
979 "(OO)", py_iter_cls, py_iter_ptr);
981 BT_LOGE("Failed to call Python class's __new__() method: "
982 "py-cls-addr=%p", py_iter_cls);
989 * py_iter.__init__(self_output_port)
991 * through the _init_for_native helper static method.
993 * At this point, py_iter._ptr is set, so this initialization
994 * function has access to self._component (which gives it the
995 * user Python component object from which the iterator was
998 py_component_port_output_ptr = SWIG_NewPointerObj(
999 SWIG_as_voidptr(self_component_port_output),
1000 SWIGTYPE_p_bt_self_component_port_output, 0);
1001 if (!py_component_port_output_ptr) {
1002 const char *err = "Failed to create a SWIG pointer object.";
1005 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR(
1006 self_message_iterator, err);
1010 py_init_method_result = PyObject_CallMethod(py_iter,
1011 "_bt_init_from_native", "O", py_component_port_output_ptr);
1012 if (!py_init_method_result) {
1013 BT_LOGE_STR("User's __init__() method failed:");
1018 * Since the Python code can never instantiate a user-defined
1019 * message iterator class, the native message iterator
1020 * object does NOT belong to a user Python message iterator
1021 * object (borrowed reference). However this Python object is
1022 * owned by this native message iterator object.
1024 * In the Python world, the lifetime of the native message
1025 * iterator is managed by a _GenericMessageIterator
1028 * _GenericMessageIterator instance:
1029 * owns a native bt_message_iterator object (iter)
1030 * owns a _UserMessageIterator instance (py_iter)
1031 * self._ptr is a borrowed reference to the
1032 * native bt_private_connection_private_message_iterator
1035 bt_self_message_iterator_set_data(self_message_iterator, py_iter);
1040 /* Handling of errors that cause a Python exception to be set. */
1041 status = py_exc_to_status_message_iterator(self_message_iterator);
1042 BT_ASSERT(status != __BT_FUNC_STATUS_OK);
1046 /* Handling of errors that don't cause a Python exception to be set. */
1047 status = __BT_FUNC_STATUS_ERROR;
1050 BT_ASSERT(!PyErr_Occurred());
1052 Py_XDECREF(py_comp_cls);
1053 Py_XDECREF(py_iter_cls);
1054 Py_XDECREF(py_iter_ptr);
1055 Py_XDECREF(py_component_port_output_ptr);
1056 Py_XDECREF(py_init_method_result);
1057 Py_XDECREF(py_iter);
1062 bt_component_class_message_iterator_init_method_status
1063 component_class_source_message_iterator_init(
1064 bt_self_message_iterator *self_message_iterator,
1065 bt_self_component_source *self_component_source,
1066 bt_self_component_port_output *self_component_port_output)
1068 bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source);
1070 return component_class_message_iterator_init(self_message_iterator, self_component, self_component_port_output);
1074 bt_component_class_message_iterator_init_method_status
1075 component_class_filter_message_iterator_init(
1076 bt_self_message_iterator *self_message_iterator,
1077 bt_self_component_filter *self_component_filter,
1078 bt_self_component_port_output *self_component_port_output)
1080 bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter);
1082 return component_class_message_iterator_init(self_message_iterator, self_component, self_component_port_output);
1086 void component_class_message_iterator_finalize(
1087 bt_self_message_iterator *message_iterator)
1089 PyObject *py_message_iter = bt_self_message_iterator_get_data(message_iterator);
1090 PyObject *py_method_result = NULL;
1092 BT_ASSERT(py_message_iter);
1094 /* Call user's _finalize() method */
1095 py_method_result = PyObject_CallMethod(py_message_iter,
1098 if (PyErr_Occurred()) {
1099 BT_LOGW("User's _finalize() method raised an exception: ignoring:");
1104 * Ignore any exception raised by the _finalize() method because
1105 * it won't change anything at this point: the component is
1106 * being destroyed anyway.
1109 Py_XDECREF(py_method_result);
1110 Py_DECREF(py_message_iter);
1113 /* Valid for both sources and filters. */
1116 bt_component_class_message_iterator_next_method_status
1117 component_class_message_iterator_next(
1118 bt_self_message_iterator *message_iterator,
1119 bt_message_array_const msgs, uint64_t capacity,
1122 bt_component_class_message_iterator_next_method_status status = __BT_FUNC_STATUS_OK;
1123 PyObject *py_message_iter = bt_self_message_iterator_get_data(message_iterator);
1124 PyObject *py_method_result = NULL;
1126 BT_ASSERT(py_message_iter);
1127 py_method_result = PyObject_CallMethod(py_message_iter,
1128 "_bt_next_from_native", NULL);
1129 if (!py_method_result) {
1130 status = py_exc_to_status_message_iterator(message_iterator);
1131 BT_ASSERT(status != __BT_FUNC_STATUS_OK);
1136 * The returned object, on success, is an integer object
1137 * (PyLong) containing the address of a native message
1138 * object (which is now ours).
1140 msgs[0] = PyLong_AsVoidPtr(py_method_result);
1143 /* Clear potential overflow error; should never happen */
1144 BT_ASSERT(!PyErr_Occurred());
1148 Py_XDECREF(py_method_result);
1153 bt_component_class_sink_consume_method_status
1154 component_class_sink_consume(bt_self_component_sink *self_component_sink)
1156 bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink);
1157 PyObject *py_comp = bt_self_component_get_data(self_component);
1158 PyObject *py_method_result = NULL;
1159 bt_component_class_sink_consume_method_status status;
1162 py_method_result = PyObject_CallMethod(py_comp,
1164 status = py_exc_to_status_component(self_component);
1165 if (!py_method_result && status == __BT_FUNC_STATUS_OK) {
1166 /* Pretty sure this should never happen, but just in case */
1167 BT_LOGE("User's _consume() method failed without raising an exception: "
1168 "status=%d", status);
1169 status = __BT_FUNC_STATUS_ERROR;
1172 Py_XDECREF(py_method_result);
1177 int component_class_set_help_and_desc(
1178 bt_component_class *component_class,
1179 const char *description, const char *help)
1184 ret = bt_component_class_set_description(component_class, description);
1186 BT_LOGE("Cannot set component class's description: "
1187 "comp-cls-addr=%p", component_class);
1193 ret = bt_component_class_set_help(component_class, help);
1195 BT_LOGE("Cannot set component class's help text: "
1196 "comp-cls-addr=%p", component_class);
1208 bt_component_class_source *bt_bt2_component_class_source_create(
1209 PyObject *py_cls, const char *name, const char *description,
1212 bt_component_class_source *component_class_source;
1213 bt_component_class *component_class;
1217 component_class_source = bt_component_class_source_create(name,
1218 component_class_message_iterator_next);
1219 if (!component_class_source) {
1220 BT_LOGE_STR("Cannot create source component class.");
1224 component_class = bt_component_class_source_as_component_class(component_class_source);
1226 if (component_class_set_help_and_desc(component_class, description, help)) {
1230 ret = bt_component_class_source_set_init_method(component_class_source, component_class_source_init);
1231 BT_ASSERT(ret == 0);
1232 ret = bt_component_class_source_set_finalize_method(component_class_source, component_class_source_finalize);
1233 BT_ASSERT(ret == 0);
1234 ret = bt_component_class_source_set_message_iterator_can_seek_beginning_method(component_class_source,
1235 component_class_can_seek_beginning);
1236 BT_ASSERT(ret == 0);
1237 ret = bt_component_class_source_set_message_iterator_seek_beginning_method(component_class_source,
1238 component_class_seek_beginning);
1239 BT_ASSERT(ret == 0);
1240 ret = bt_component_class_source_set_output_port_connected_method(component_class_source,
1241 component_class_source_output_port_connected);
1242 BT_ASSERT(ret == 0);
1243 ret = bt_component_class_source_set_query_method(component_class_source, component_class_source_query);
1244 BT_ASSERT(ret == 0);
1245 ret = bt_component_class_source_set_message_iterator_init_method(
1246 component_class_source, component_class_source_message_iterator_init);
1247 BT_ASSERT(ret == 0);
1248 ret = bt_component_class_source_set_message_iterator_finalize_method(
1249 component_class_source, component_class_message_iterator_finalize);
1250 BT_ASSERT(ret == 0);
1251 register_cc_ptr_to_py_cls(component_class, py_cls);
1254 return component_class_source;
1258 bt_component_class_filter *bt_bt2_component_class_filter_create(
1259 PyObject *py_cls, const char *name, const char *description,
1262 bt_component_class *component_class;
1263 bt_component_class_filter *component_class_filter;
1267 component_class_filter = bt_component_class_filter_create(name,
1268 component_class_message_iterator_next);
1269 if (!component_class_filter) {
1270 BT_LOGE_STR("Cannot create filter component class.");
1274 component_class = bt_component_class_filter_as_component_class(component_class_filter);
1276 if (component_class_set_help_and_desc(component_class, description, help)) {
1280 ret = bt_component_class_filter_set_init_method(component_class_filter, component_class_filter_init);
1281 BT_ASSERT(ret == 0);
1282 ret = bt_component_class_filter_set_finalize_method (component_class_filter, component_class_filter_finalize);
1283 BT_ASSERT(ret == 0);
1284 ret = bt_component_class_filter_set_message_iterator_can_seek_beginning_method(component_class_filter,
1285 component_class_can_seek_beginning);
1286 BT_ASSERT(ret == 0);
1287 ret = bt_component_class_filter_set_message_iterator_seek_beginning_method(component_class_filter,
1288 component_class_seek_beginning);
1289 BT_ASSERT(ret == 0);
1290 ret = bt_component_class_filter_set_input_port_connected_method(component_class_filter,
1291 component_class_filter_input_port_connected);
1292 BT_ASSERT(ret == 0);
1293 ret = bt_component_class_filter_set_output_port_connected_method(component_class_filter,
1294 component_class_filter_output_port_connected);
1295 BT_ASSERT(ret == 0);
1296 ret = bt_component_class_filter_set_query_method(component_class_filter, component_class_filter_query);
1297 BT_ASSERT(ret == 0);
1298 ret = bt_component_class_filter_set_message_iterator_init_method(
1299 component_class_filter, component_class_filter_message_iterator_init);
1300 BT_ASSERT(ret == 0);
1301 ret = bt_component_class_filter_set_message_iterator_finalize_method(
1302 component_class_filter, component_class_message_iterator_finalize);
1303 BT_ASSERT(ret == 0);
1304 register_cc_ptr_to_py_cls(component_class, py_cls);
1307 return component_class_filter;
1311 bt_component_class_sink *bt_bt2_component_class_sink_create(
1312 PyObject *py_cls, const char *name, const char *description,
1315 bt_component_class_sink *component_class_sink;
1316 bt_component_class *component_class;
1320 component_class_sink = bt_component_class_sink_create(name, component_class_sink_consume);
1322 if (!component_class_sink) {
1323 BT_LOGE_STR("Cannot create sink component class.");
1327 component_class = bt_component_class_sink_as_component_class(component_class_sink);
1329 if (component_class_set_help_and_desc(component_class, description, help)) {
1333 ret = bt_component_class_sink_set_init_method(component_class_sink, component_class_sink_init);
1334 BT_ASSERT(ret == 0);
1335 ret = bt_component_class_sink_set_finalize_method(component_class_sink, component_class_sink_finalize);
1336 BT_ASSERT(ret == 0);
1337 ret = bt_component_class_sink_set_input_port_connected_method(component_class_sink,
1338 component_class_sink_input_port_connected);
1339 BT_ASSERT(ret == 0);
1340 ret = bt_component_class_sink_set_graph_is_configured_method(component_class_sink,
1341 component_class_sink_graph_is_configured);
1342 BT_ASSERT(ret == 0);
1343 ret = bt_component_class_sink_set_query_method(component_class_sink, component_class_sink_query);
1344 BT_ASSERT(ret == 0);
1345 register_cc_ptr_to_py_cls(component_class, py_cls);
1348 return component_class_sink;
1352 struct bt_component_class_source *bt_bt2_component_class_source_create(
1353 PyObject *py_cls, const char *name, const char *description,
1355 struct bt_component_class_filter *bt_bt2_component_class_filter_create(
1356 PyObject *py_cls, const char *name, const char *description,
1358 struct bt_component_class_sink *bt_bt2_component_class_sink_create(
1359 PyObject *py_cls, const char *name, const char *description,
1361 void bt_bt2_cc_init_from_bt2(void);
1362 void bt_bt2_cc_exit_handler(void);