X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fnative_bt_component_class.i.h;h=b2c616226e6afc323a1db765aaac56dd262665b5;hp=9b1e7d279292564fd9935a1ee79ab00ce9cda876;hb=0235b0db7de5bcacdb3650c92461f2ce5eb2143d;hpb=66964f3f7b0b7e3b774ddb043b0f197018d23730 diff --git a/src/bindings/python/bt2/bt2/native_bt_component_class.i.h b/src/bindings/python/bt2/bt2/native_bt_component_class.i.h index 9b1e7d27..b2c61622 100644 --- a/src/bindings/python/bt2/bt2/native_bt_component_class.i.h +++ b/src/bindings/python/bt2/bt2/native_bt_component_class.i.h @@ -1,25 +1,7 @@ /* - * The MIT License (MIT) + * SPDX-License-Identifier: MIT * * Copyright (c) 2017 Philippe Proulx - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - * THE SOFTWARE. */ #include "logging/comp-logging.h" @@ -43,6 +25,8 @@ * a BT component object instance. */ +#define BT_FMT_SWIG_ALLOC_FAILED "Failed to create a SWIG pointer object." + static GHashTable *bt_cc_ptr_to_py_cls; static @@ -104,15 +88,17 @@ void native_comp_class_dtor(void) { } static inline -int py_exc_to_status(bt_self_component_class *self_component_class, +int py_exc_to_status_clear( + bt_self_component_class *self_component_class, bt_self_component *self_component, bt_self_message_iterator *self_message_iterator, const char *module_name, int active_log_level) { - int status = __BT_FUNC_STATUS_OK; + int status; PyObject *exc = PyErr_Occurred(); if (!exc) { + status = __BT_FUNC_STATUS_OK; goto end; } @@ -144,7 +130,7 @@ int py_exc_to_status(bt_self_component_class *self_component_class, } BT_ASSERT(active_log_level != -1); - log_exception_and_maybe_append_error(BT_LOG_WARNING, + log_exception_and_maybe_append_cause(BT_LOG_WARNING, active_log_level, true, self_component_class, self_component, self_message_iterator, module_name); @@ -163,25 +149,25 @@ end: } static -int py_exc_to_status_component_class( +int py_exc_to_status_component_class_clear( bt_self_component_class *self_component_class, int active_log_level) { - return py_exc_to_status(self_component_class, NULL, NULL, NULL, + return py_exc_to_status_clear(self_component_class, NULL, NULL, NULL, active_log_level); } static -int py_exc_to_status_component(bt_self_component *self_component) +int py_exc_to_status_component_clear(bt_self_component *self_component) { - return py_exc_to_status(NULL, self_component, NULL, NULL, -1); + return py_exc_to_status_clear(NULL, self_component, NULL, NULL, -1); } static -int py_exc_to_status_message_iterator( +int py_exc_to_status_message_iterator_clear( bt_self_message_iterator *self_message_iterator) { - return py_exc_to_status(NULL, NULL, self_message_iterator, NULL, -1); + return py_exc_to_status_clear(NULL, NULL, self_message_iterator, NULL, -1); } static @@ -193,7 +179,7 @@ bool bt_bt2_is_python_component_class(const bt_component_class *comp_cls) /* Component class proxy methods (delegate to the attached Python object) */ static -bt_component_class_init_method_status component_class_init( +bt_component_class_initialize_method_status component_class_init( bt_self_component *self_component, void *self_component_v, swig_type_info *self_comp_cls_type_swig_type, @@ -202,7 +188,7 @@ bt_component_class_init_method_status component_class_init( { const bt_component *component = bt_self_component_as_component(self_component); const bt_component_class *component_class = bt_component_borrow_class_const(component); - bt_component_class_init_method_status status = __BT_FUNC_STATUS_OK; + bt_component_class_initialize_method_status status; PyObject *py_cls = NULL; PyObject *py_comp = NULL; PyObject *py_params_ptr = NULL; @@ -214,14 +200,6 @@ bt_component_class_init_method_status component_class_init( BT_ASSERT(self_component_v); BT_ASSERT(self_comp_cls_type_swig_type); - /* - * If there's any `init_method_data`, assume this component is - * getting initialized from Python, so that `init_method_data` - * is a Python object to pass to the user's __init__() method. - */ - BT_ASSERT(!init_method_data || - bt_bt2_is_python_component_class(component_class)); - /* * Get the user-defined Python class which created this * component's class in the first place (borrowed @@ -240,7 +218,7 @@ bt_component_class_init_method_status component_class_init( SWIGTYPE_p_bt_value, 0); if (!py_params_ptr) { BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component, - "Failed to create a SWIG pointer object."); + BT_FMT_SWIG_ALLOC_FAILED); goto error; } @@ -248,7 +226,7 @@ bt_component_class_init_method_status component_class_init( self_comp_cls_type_swig_type, 0); if (!py_comp_ptr) { BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component, - "Failed to create a SWIG pointer object."); + BT_FMT_SWIG_ALLOC_FAILED); goto error; } @@ -274,7 +252,7 @@ bt_component_class_init_method_status component_class_init( BT_COMP_LOG_CUR_LVL(BT_LOG_WARNING, log_level, self_component, "Failed to call Python class's _bt_init_from_native() method: " "py-cls-addr=%p", py_cls); - status = py_exc_to_status_component(self_component); + status = py_exc_to_status_component_clear(self_component); goto end; } @@ -285,34 +263,180 @@ bt_component_class_init_method_status component_class_init( */ bt_self_component_set_data(self_component, py_comp); py_comp = NULL; + + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; + goto end; error: - status = __BT_FUNC_STATUS_ERROR; + /* This error path is for non-Python errors only. */ + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; + +end: + BT_ASSERT(!PyErr_Occurred()); + Py_XDECREF(py_comp); + Py_XDECREF(py_params_ptr); + Py_XDECREF(py_comp_ptr); + return status; +} + +static +bt_component_class_get_supported_mip_versions_method_status +component_class_get_supported_mip_versions( + const bt_component_class *component_class, + bt_self_component_class *self_component_class, + const bt_value *params, void *init_method_data, + bt_logging_level log_level, + bt_integer_range_set_unsigned *supported_versions) +{ + uint64_t i; + PyObject *py_cls = NULL; + PyObject *py_params_ptr = NULL; + PyObject *py_range_set_addr = NULL; + bt_integer_range_set_unsigned *ret_range_set = NULL; + bt_component_class_get_supported_mip_versions_method_status status; + + py_cls = lookup_cc_ptr_to_py_cls(component_class); + if (!py_cls) { + BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG, + "Cannot find Python class associated to native component class: " + "comp-cls-addr=%p", component_class); + goto error; + } + + py_params_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(params), + SWIGTYPE_p_bt_value, 0); + if (!py_params_ptr) { + BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG, + BT_FMT_SWIG_ALLOC_FAILED); + goto error; + } /* - * Clear any exception: we're returning a bad status anyway. If - * this call originated from Python (creation from a plugin's - * component class, for example), then the user gets an - * appropriate creation error. + * We don't take any reference on `init_method_data` which, if + * not `NULL`, is assumed to be a `PyObject *`: the user's + * _user_get_supported_mip_versions() function will eventually + * take a reference if needed. If `init_method_data` is `NULL`, + * then we pass `Py_None` as the initialization's Python object. */ - PyErr_Clear(); + py_range_set_addr = PyObject_CallMethod(py_cls, + "_bt_get_supported_mip_versions_from_native", "(OOi)", + py_params_ptr, init_method_data ? init_method_data : Py_None, + (int) log_level); + if (!py_range_set_addr) { + BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING, log_level, BT_LOG_TAG, + "Failed to call Python class's _bt_get_supported_mip_versions_from_native() method: " + "py-cls-addr=%p", py_cls); + status = py_exc_to_status_component_class_clear(self_component_class, + log_level); + goto end; + } + + /* + * The returned object, on success, is an integer object + * (PyLong) containing the address of a BT unsigned integer + * range set object (new reference). + */ + ret_range_set = PyLong_AsVoidPtr(py_range_set_addr); + BT_ASSERT(!PyErr_Occurred()); + BT_ASSERT(ret_range_set); + + /* Copy returned ranges to input range set */ + for (i = 0; i < bt_integer_range_set_get_range_count( + bt_integer_range_set_unsigned_as_range_set_const(ret_range_set)); + i++) { + const bt_integer_range_unsigned *range = + bt_integer_range_set_unsigned_borrow_range_by_index_const( + ret_range_set, i); + bt_integer_range_set_add_range_status add_range_status; + + add_range_status = bt_integer_range_set_unsigned_add_range( + supported_versions, + bt_integer_range_unsigned_get_lower(range), + bt_integer_range_unsigned_get_upper(range)); + if (add_range_status) { + BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG, + "Failed to add range to supported MIP versions range set."); + goto error; + } + } + + status = BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_OK; + + goto end; + +error: + /* This error path is for non-Python errors only. */ + status = BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_ERROR; end: - Py_XDECREF(py_comp); + BT_ASSERT(!PyErr_Occurred()); Py_XDECREF(py_params_ptr); - Py_XDECREF(py_comp_ptr); + Py_XDECREF(py_range_set_addr); + bt_integer_range_set_unsigned_put_ref(ret_range_set); return status; } +static +bt_component_class_get_supported_mip_versions_method_status +component_class_source_get_supported_mip_versions( + bt_self_component_class_source *self_component_class_source, + const bt_value *params, void *init_method_data, + bt_logging_level log_level, + bt_integer_range_set_unsigned *supported_versions) +{ + const bt_component_class_source *component_class_source = bt_self_component_class_source_as_component_class_source(self_component_class_source); + const bt_component_class *component_class = bt_component_class_source_as_component_class_const(component_class_source); + bt_self_component_class *self_component_class = bt_self_component_class_source_as_self_component_class(self_component_class_source); + + return component_class_get_supported_mip_versions( + component_class, self_component_class, + params, init_method_data, log_level, supported_versions); +} + +static +bt_component_class_get_supported_mip_versions_method_status +component_class_filter_get_supported_mip_versions( + bt_self_component_class_filter *self_component_class_filter, + const bt_value *params, void *init_method_data, + bt_logging_level log_level, + bt_integer_range_set_unsigned *supported_versions) +{ + const bt_component_class_filter *component_class_filter = bt_self_component_class_filter_as_component_class_filter(self_component_class_filter); + const bt_component_class *component_class = bt_component_class_filter_as_component_class_const(component_class_filter); + bt_self_component_class *self_component_class = bt_self_component_class_filter_as_self_component_class(self_component_class_filter); + + return component_class_get_supported_mip_versions( + component_class, self_component_class, + params, init_method_data, log_level, supported_versions); +} + +static +bt_component_class_get_supported_mip_versions_method_status +component_class_sink_get_supported_mip_versions( + bt_self_component_class_sink *self_component_class_sink, + const bt_value *params, void *init_method_data, + bt_logging_level log_level, + bt_integer_range_set_unsigned *supported_versions) +{ + const bt_component_class_sink *component_class_sink = bt_self_component_class_sink_as_component_class_sink(self_component_class_sink); + const bt_component_class *component_class = bt_component_class_sink_as_component_class_const(component_class_sink); + bt_self_component_class *self_component_class = bt_self_component_class_sink_as_self_component_class(self_component_class_sink); + + return component_class_get_supported_mip_versions( + component_class, self_component_class, + params, init_method_data, log_level, supported_versions); +} + /* * Method of bt_component_class_source to initialize a bt_self_component_source * of that class. */ static -bt_component_class_init_method_status component_class_source_init( +bt_component_class_initialize_method_status component_class_source_init( bt_self_component_source *self_component_source, + bt_self_component_source_configuration *config, const bt_value *params, void *init_method_data) { bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source); @@ -324,8 +448,9 @@ bt_component_class_init_method_status component_class_source_init( } static -bt_component_class_init_method_status component_class_filter_init( +bt_component_class_initialize_method_status component_class_filter_init( bt_self_component_filter *self_component_filter, + bt_self_component_filter_configuration *config, const bt_value *params, void *init_method_data) { bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter); @@ -337,8 +462,9 @@ bt_component_class_init_method_status component_class_filter_init( } static -bt_component_class_init_method_status component_class_sink_init( +bt_component_class_initialize_method_status component_class_sink_init( bt_self_component_sink *self_component_sink, + bt_self_component_sink_configuration *config, const bt_value *params, void *init_method_data) { bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink); @@ -353,98 +479,275 @@ static void component_class_finalize(bt_self_component *self_component) { PyObject *py_comp = bt_self_component_get_data(self_component); + PyObject *py_method_result; + BT_ASSERT(py_comp); /* Call user's _user_finalize() method */ - PyObject *py_method_result = PyObject_CallMethod(py_comp, - "_user_finalize", NULL); - - if (PyErr_Occurred()) { + py_method_result = PyObject_CallMethod(py_comp, "_user_finalize", NULL); + if (!py_method_result) { bt_logging_level log_level = get_self_component_log_level( self_component); + /* + * Ignore any exception raised by the _user_finalize() method + * because it won't change anything at this point: the component + * is being destroyed anyway. + */ BT_COMP_LOG_CUR_LVL(BT_LOG_WARNING, log_level, self_component, "User component's _user_finalize() method raised an exception: ignoring:"); - logw_exception(log_level); + logw_exception_clear(log_level); + + goto end; } - /* - * Ignore any exception raised by the _user_finalize() method - * because it won't change anything at this point: the component - * is being destroyed anyway. - */ - PyErr_Clear(); + BT_ASSERT(py_method_result == Py_None); + +end: Py_XDECREF(py_method_result); Py_DECREF(py_comp); } +/* Decref the Python object in the user data associated to `port`. */ + +static +void delete_port_user_data(bt_self_component_port *port) +{ + Py_DECREF(bt_self_component_port_get_data(port)); +} + +static +void delete_port_input_user_data(bt_self_component_port_input *port_input) +{ + bt_self_component_port *port = + bt_self_component_port_input_as_self_component_port(port_input); + + delete_port_user_data(port); +} + +static +void delete_port_output_user_data(bt_self_component_port_output *port_output) +{ + bt_self_component_port *port = + bt_self_component_port_output_as_self_component_port(port_output); + + delete_port_user_data(port); +} + static void component_class_source_finalize(bt_self_component_source *self_component_source) { - bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source); + uint64_t i; + bt_self_component *self_component; + const bt_component_source *component_source; + + self_component = bt_self_component_source_as_self_component( + self_component_source); + component_source = bt_self_component_source_as_component_source( + self_component_source); + component_class_finalize(self_component); + + /* + * Free the user data Python object attached to the port. The + * corresponding incref was done by the `void *` typemap in + * native_bt_port.i. + */ + for (i = 0; i < bt_component_source_get_output_port_count(component_source); i++) { + bt_self_component_port_output *port_output; + + port_output = bt_self_component_source_borrow_output_port_by_index( + self_component_source, i); + + delete_port_output_user_data(port_output); + } } static void component_class_filter_finalize(bt_self_component_filter *self_component_filter) { - bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter); + uint64_t i; + bt_self_component *self_component; + const bt_component_filter *component_filter; + + self_component = bt_self_component_filter_as_self_component( + self_component_filter); + component_filter = bt_self_component_filter_as_component_filter( + self_component_filter); + component_class_finalize(self_component); + + /* + * Free the user data Python object attached to the port. The + * corresponding incref was done by the `void *` typemap in + * native_bt_port.i. + */ + for (i = 0; i < bt_component_filter_get_input_port_count(component_filter); i++) { + bt_self_component_port_input *port_input; + + port_input = bt_self_component_filter_borrow_input_port_by_index( + self_component_filter, i); + + delete_port_input_user_data(port_input); + } + + for (i = 0; i < bt_component_filter_get_output_port_count(component_filter); i++) { + bt_self_component_port_output *port_output; + + port_output = bt_self_component_filter_borrow_output_port_by_index( + self_component_filter, i); + + delete_port_output_user_data(port_output); + } } static void component_class_sink_finalize(bt_self_component_sink *self_component_sink) { - bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink); + uint64_t i; + bt_self_component *self_component; + const bt_component_sink *component_sink; + + self_component = bt_self_component_sink_as_self_component( + self_component_sink); + component_sink = bt_self_component_sink_as_component_sink( + self_component_sink); + component_class_finalize(self_component); + + /* + * Free the user data Python object attached to the port. The + * corresponding incref was done by the `void *` typemap in + * native_bt_port.i. + */ + for (i = 0; i < bt_component_sink_get_input_port_count(component_sink); i++) { + bt_self_component_port_input *port_input; + + port_input = bt_self_component_sink_borrow_input_port_by_index( + self_component_sink, i); + + delete_port_input_user_data(port_input); + } } static -bt_bool component_class_can_seek_beginning( - bt_self_message_iterator *self_message_iterator) +bt_message_iterator_class_can_seek_beginning_method_status +component_class_can_seek_beginning( + bt_self_message_iterator *self_message_iterator, bt_bool *can_seek) { PyObject *py_iter; PyObject *py_result = NULL; - bt_bool can_seek_beginning = false; - + bt_message_iterator_class_can_seek_beginning_method_status status; py_iter = bt_self_message_iterator_get_data(self_message_iterator); + BT_ASSERT(py_iter); - py_result = PyObject_GetAttrString(py_iter, "_bt_can_seek_beginning_from_native"); + py_result = PyObject_CallMethod(py_iter, + "_bt_can_seek_beginning_from_native", NULL); + if (!py_result) { + status = py_exc_to_status_message_iterator_clear(self_message_iterator); + goto end; + } - BT_ASSERT(!py_result || PyBool_Check(py_result)); + BT_ASSERT(PyBool_Check(py_result)); + *can_seek = PyObject_IsTrue(py_result); - if (py_result) { - can_seek_beginning = PyObject_IsTrue(py_result); - } else { - /* - * Once can_seek_beginning can report errors, convert the - * exception to a status. For now, log and return false; - */ - loge_exception_message_iterator(self_message_iterator); - PyErr_Clear(); - } + status = BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_BEGINNING_METHOD_STATUS_OK; +end: Py_XDECREF(py_result); - return can_seek_beginning; + return status; } static -bt_component_class_message_iterator_seek_beginning_method_status +bt_message_iterator_class_seek_beginning_method_status component_class_seek_beginning(bt_self_message_iterator *self_message_iterator) { PyObject *py_iter; PyObject *py_result; - bt_component_class_message_iterator_seek_beginning_method_status status; + bt_message_iterator_class_seek_beginning_method_status status; py_iter = bt_self_message_iterator_get_data(self_message_iterator); BT_ASSERT(py_iter); - py_result = PyObject_CallMethod(py_iter, "_bt_seek_beginning_from_native", + + py_result = PyObject_CallMethod(py_iter, + "_bt_seek_beginning_from_native", NULL); - BT_ASSERT(!py_result || py_result == Py_None); - status = py_exc_to_status_message_iterator(self_message_iterator); + if (!py_result) { + status = py_exc_to_status_message_iterator_clear(self_message_iterator); + goto end; + } + + BT_ASSERT(py_result == Py_None); + + status = BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK; + +end: + Py_XDECREF(py_result); + + return status; +} + +static +bt_message_iterator_class_can_seek_ns_from_origin_method_status +component_class_can_seek_ns_from_origin( + bt_self_message_iterator *self_message_iterator, + int64_t ns_from_origin, bt_bool *can_seek) +{ + PyObject *py_iter; + PyObject *py_result = NULL; + bt_message_iterator_class_can_seek_ns_from_origin_method_status status; + + py_iter = bt_self_message_iterator_get_data(self_message_iterator); + BT_ASSERT(py_iter); + + py_result = PyObject_CallMethod(py_iter, + "_bt_can_seek_ns_from_origin_from_native", "L", ns_from_origin); + if (!py_result) { + status = py_exc_to_status_message_iterator_clear(self_message_iterator); + goto end; + } + + BT_ASSERT(PyBool_Check(py_result)); + *can_seek = PyObject_IsTrue(py_result); + + status = BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK; + +end: Py_XDECREF(py_result); + + return status; +} + +static +bt_message_iterator_class_seek_ns_from_origin_method_status +component_class_seek_ns_from_origin( + bt_self_message_iterator *self_message_iterator, + int64_t ns_from_origin) +{ + PyObject *py_iter; + PyObject *py_result; + bt_message_iterator_class_seek_ns_from_origin_method_status status; + + py_iter = bt_self_message_iterator_get_data(self_message_iterator); + BT_ASSERT(py_iter); + + py_result = PyObject_CallMethod(py_iter, + "_bt_seek_ns_from_origin_from_native", "L", ns_from_origin); + if (!py_result) { + status = py_exc_to_status_message_iterator_clear(self_message_iterator); + goto end; + } + + + BT_ASSERT(py_result == Py_None); + + status = BT_MESSAGE_ITERATOR_CLASS_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK; + +end: + Py_XDECREF(py_result); + return status; } @@ -471,7 +774,7 @@ bt_component_class_port_connected_method_status component_class_port_connected( self_component_port_swig_type, 0); if (!py_self_port_ptr) { BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component, - "Failed to create a SWIG pointer object."); + BT_FMT_SWIG_ALLOC_FAILED); status = __BT_FUNC_STATUS_MEMORY_ERROR; goto end; } @@ -480,20 +783,28 @@ bt_component_class_port_connected_method_status component_class_port_connected( other_port_swig_type, 0); if (!py_other_port_ptr) { BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component, - "Failed to create a SWIG pointer object."); + BT_FMT_SWIG_ALLOC_FAILED); status = __BT_FUNC_STATUS_MEMORY_ERROR; - goto end; } + goto end; + } py_method_result = PyObject_CallMethod(py_comp, "_bt_port_connected_from_native", "(OiO)", py_self_port_ptr, self_component_port_type, py_other_port_ptr); - BT_ASSERT(!py_method_result || py_method_result == Py_None); - status = py_exc_to_status_component(self_component); + if (!py_method_result) { + status = py_exc_to_status_component_clear(self_component); + goto end; + } + + BT_ASSERT(py_method_result == Py_None); + + status = BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_OK; end: Py_XDECREF(py_self_port_ptr); Py_XDECREF(py_other_port_ptr); Py_XDECREF(py_method_result); + return status; } @@ -576,14 +887,23 @@ component_class_sink_graph_is_configured( { PyObject *py_comp = NULL; PyObject *py_method_result = NULL; - bt_component_class_sink_graph_is_configured_method_status status = __BT_FUNC_STATUS_OK; + bt_component_class_sink_graph_is_configured_method_status status; bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink); py_comp = bt_self_component_get_data(self_component); + py_method_result = PyObject_CallMethod(py_comp, "_bt_graph_is_configured_from_native", NULL); - BT_ASSERT(!py_method_result || py_method_result == Py_None); - status = py_exc_to_status_component(self_component); + if (!py_method_result) { + status = py_exc_to_status_component_clear(self_component); + goto end; + } + + BT_ASSERT(py_method_result == Py_None); + + status = BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK;; + +end: Py_XDECREF(py_method_result); return status; } @@ -593,7 +913,7 @@ bt_component_class_query_method_status component_class_query( const bt_component_class *component_class, bt_self_component_class *self_component_class, bt_private_query_executor *priv_query_executor, - const char *object, const bt_value *params, + const char *object, const bt_value *params, void *method_data, const bt_value **result) { PyObject *py_cls = NULL; @@ -609,6 +929,14 @@ bt_component_class_query_method_status component_class_query( bt_logging_level log_level = bt_query_executor_get_logging_level(query_exec); + /* + * If there's any `method_data`, assume this component class is + * getting queried from Python, so that `method_data` is a + * Python object to pass to the user's _user_query() method. + */ + BT_ASSERT(!method_data || + bt_bt2_is_python_component_class(component_class)); + py_cls = lookup_cc_ptr_to_py_cls(component_class); if (!py_cls) { BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG, @@ -621,7 +949,7 @@ bt_component_class_query_method_status component_class_query( SWIGTYPE_p_bt_value, 0); if (!py_params_ptr) { BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG, - "Failed to create a SWIG pointer object."); + BT_FMT_SWIG_ALLOC_FAILED); goto error; } @@ -630,7 +958,7 @@ bt_component_class_query_method_status component_class_query( SWIGTYPE_p_bt_private_query_executor, 0); if (!py_priv_query_exec_ptr) { BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG, - "Failed to create a SWIG pointer object."); + BT_FMT_SWIG_ALLOC_FAILED); goto error; } @@ -641,15 +969,28 @@ bt_component_class_query_method_status component_class_query( goto error; } + /* + * We don't take any reference on `method_data` which, if not + * `NULL`, is assumed to be a `PyObject *`: the user's + * _user_query() function will eventually take a reference if + * needed. If `method_data` is `NULL`, then we pass `Py_None` as + * the initialization's Python object. + */ py_results_addr = PyObject_CallMethod(py_cls, - "_bt_query_from_native", "(OOO)", py_priv_query_exec_ptr, - py_object, py_params_ptr); + "_bt_query_from_native", "(OOOO)", py_priv_query_exec_ptr, + py_object, py_params_ptr, + method_data ? method_data : Py_None); if (!py_results_addr) { - BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING, log_level, BT_LOG_TAG, - "Failed to call Python class's _bt_query_from_native() method: " - "py-cls-addr=%p", py_cls); - status = py_exc_to_status_component_class(self_component_class, + status = py_exc_to_status_component_class_clear(self_component_class, log_level); + if (status < 0) { + static const char *fmt = + "Failed to call Python class's _bt_query_from_native() method: py-cls-addr=%p"; + BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING, log_level, BT_LOG_TAG, + fmt, py_cls); + BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT_CLASS( + self_component_class, fmt, py_cls); + } goto end; } @@ -680,7 +1021,7 @@ static bt_component_class_query_method_status component_class_source_query( bt_self_component_class_source *self_component_class_source, bt_private_query_executor *priv_query_executor, - const char *object, const bt_value *params, + const char *object, const bt_value *params, void *method_data, const bt_value **result) { const bt_component_class_source *component_class_source = bt_self_component_class_source_as_component_class_source(self_component_class_source); @@ -688,14 +1029,14 @@ bt_component_class_query_method_status component_class_source_query( bt_self_component_class *self_component_class = bt_self_component_class_source_as_self_component_class(self_component_class_source); return component_class_query(component_class, self_component_class, - priv_query_executor, object, params, result); + priv_query_executor, object, params, method_data, result); } static bt_component_class_query_method_status component_class_filter_query( bt_self_component_class_filter *self_component_class_filter, bt_private_query_executor *priv_query_executor, - const char *object, const bt_value *params, + const char *object, const bt_value *params, void *method_data, const bt_value **result) { const bt_component_class_filter *component_class_filter = bt_self_component_class_filter_as_component_class_filter(self_component_class_filter); @@ -703,14 +1044,14 @@ bt_component_class_query_method_status component_class_filter_query( bt_self_component_class *self_component_class = bt_self_component_class_filter_as_self_component_class(self_component_class_filter); return component_class_query(component_class, self_component_class, - priv_query_executor, object, params, result); + priv_query_executor, object, params, method_data, result); } static bt_component_class_query_method_status component_class_sink_query( bt_self_component_class_sink *self_component_class_sink, bt_private_query_executor *priv_query_executor, - const char *object, const bt_value *params, + const char *object, const bt_value *params, void *method_data, const bt_value **result) { const bt_component_class_sink *component_class_sink = bt_self_component_class_sink_as_component_class_sink(self_component_class_sink); @@ -718,24 +1059,28 @@ bt_component_class_query_method_status component_class_sink_query( bt_self_component_class *self_component_class = bt_self_component_class_sink_as_self_component_class(self_component_class_sink); return component_class_query(component_class, self_component_class, - priv_query_executor, object, params, result); + priv_query_executor, object, params, method_data, result); } static -bt_component_class_message_iterator_init_method_status +bt_message_iterator_class_initialize_method_status component_class_message_iterator_init( bt_self_message_iterator *self_message_iterator, - bt_self_component *self_component, + bt_self_message_iterator_configuration *config, bt_self_component_port_output *self_component_port_output) { - bt_component_class_message_iterator_init_method_status status = __BT_FUNC_STATUS_OK; + bt_message_iterator_class_initialize_method_status status = __BT_FUNC_STATUS_OK; PyObject *py_comp_cls = NULL; PyObject *py_iter_cls = NULL; PyObject *py_iter_ptr = NULL; + PyObject *py_config_ptr = NULL; PyObject *py_component_port_output_ptr = NULL; PyObject *py_init_method_result = NULL; PyObject *py_iter = NULL; PyObject *py_comp; + bt_self_component *self_component = + bt_self_message_iterator_borrow_component( + self_message_iterator); bt_logging_level log_level = get_self_component_log_level( self_component); @@ -759,12 +1104,10 @@ component_class_message_iterator_init( py_iter_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(self_message_iterator), SWIGTYPE_p_bt_self_message_iterator, 0); if (!py_iter_ptr) { - const char *err = "Failed to create a SWIG pointer object."; - BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component, - "%s", err); + BT_FMT_SWIG_ALLOC_FAILED); BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR( - self_message_iterator, err); + self_message_iterator, BT_FMT_SWIG_ALLOC_FAILED); goto error; } @@ -786,30 +1129,39 @@ component_class_message_iterator_init( /* * Initialize object: * - * py_iter.__init__(self_output_port) + * py_iter.__init__(config, self_output_port) * - * through the _init_for_native helper static method. + * through the _init_from_native helper static method. * * At this point, py_iter._ptr is set, so this initialization * function has access to self._component (which gives it the * user Python component object from which the iterator was * created). */ + py_config_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(config), + SWIGTYPE_p_bt_self_message_iterator_configuration, 0); + if (!py_config_ptr) { + BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component, + BT_FMT_SWIG_ALLOC_FAILED); + BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR( + self_message_iterator, BT_FMT_SWIG_ALLOC_FAILED); + goto error; + } + py_component_port_output_ptr = SWIG_NewPointerObj( SWIG_as_voidptr(self_component_port_output), SWIGTYPE_p_bt_self_component_port_output, 0); if (!py_component_port_output_ptr) { - const char *err = "Failed to create a SWIG pointer object."; - BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component, - "%s", err); + "%s", BT_FMT_SWIG_ALLOC_FAILED); BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR( - self_message_iterator, err); + self_message_iterator, BT_FMT_SWIG_ALLOC_FAILED); goto error; } py_init_method_result = PyObject_CallMethod(py_iter, - "_bt_init_from_native", "O", py_component_port_output_ptr); + "_bt_init_from_native", "OO", py_config_ptr, + py_component_port_output_ptr); if (!py_init_method_result) { BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component, "User's __init__() method failed:"); @@ -840,8 +1192,7 @@ component_class_message_iterator_init( python_error: /* Handling of errors that cause a Python exception to be set. */ - status = py_exc_to_status_message_iterator(self_message_iterator); - BT_ASSERT(status != __BT_FUNC_STATUS_OK); + status = py_exc_to_status_message_iterator_clear(self_message_iterator); goto end; error: @@ -860,30 +1211,6 @@ end: return status; } -static -bt_component_class_message_iterator_init_method_status -component_class_source_message_iterator_init( - bt_self_message_iterator *self_message_iterator, - bt_self_component_source *self_component_source, - bt_self_component_port_output *self_component_port_output) -{ - bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source); - - return component_class_message_iterator_init(self_message_iterator, self_component, self_component_port_output); -} - -static -bt_component_class_message_iterator_init_method_status -component_class_filter_message_iterator_init( - bt_self_message_iterator *self_message_iterator, - bt_self_component_filter *self_component_filter, - bt_self_component_port_output *self_component_port_output) -{ - bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter); - - return component_class_message_iterator_init(self_message_iterator, self_component, self_component_port_output); -} - static void component_class_message_iterator_finalize( bt_self_message_iterator *message_iterator) @@ -897,26 +1224,24 @@ void component_class_message_iterator_finalize( /* Call user's _user_finalize() method */ py_method_result = PyObject_CallMethod(py_message_iter, "_user_finalize", NULL); - - if (PyErr_Occurred()) { + if (!py_method_result) { bt_self_component *self_comp = bt_self_message_iterator_borrow_component( message_iterator); bt_logging_level log_level = get_self_component_log_level( self_comp); + /* + * Ignore any exception raised by the _user_finalize() method + * because it won't change anything at this point: the component + * is being destroyed anyway. + */ BT_COMP_LOG_CUR_LVL(BT_LOG_WARNING, log_level, self_comp, "User's _user_finalize() method raised an exception: ignoring:"); - logw_exception(get_self_message_iterator_log_level( + logw_exception_clear(get_self_message_iterator_log_level( message_iterator)); } - /* - * Ignore any exception raised by the _user_finalize() method - * because it won't change anything at this point: the component - * is being destroyed anyway. - */ - PyErr_Clear(); Py_XDECREF(py_method_result); Py_DECREF(py_message_iter); } @@ -924,22 +1249,21 @@ void component_class_message_iterator_finalize( /* Valid for both sources and filters. */ static -bt_component_class_message_iterator_next_method_status +bt_message_iterator_class_next_method_status component_class_message_iterator_next( bt_self_message_iterator *message_iterator, bt_message_array_const msgs, uint64_t capacity, uint64_t *count) { - bt_component_class_message_iterator_next_method_status status = __BT_FUNC_STATUS_OK; + bt_message_iterator_class_next_method_status status; PyObject *py_message_iter = bt_self_message_iterator_get_data(message_iterator); PyObject *py_method_result = NULL; - BT_ASSERT(py_message_iter); + BT_ASSERT_DBG(py_message_iter); py_method_result = PyObject_CallMethod(py_message_iter, "_bt_next_from_native", NULL); if (!py_method_result) { - status = py_exc_to_status_message_iterator(message_iterator); - BT_ASSERT(status != __BT_FUNC_STATUS_OK); + status = py_exc_to_status_message_iterator_clear(message_iterator); goto end; } @@ -951,9 +1275,10 @@ component_class_message_iterator_next( msgs[0] = PyLong_AsVoidPtr(py_method_result); *count = 1; - /* Clear potential overflow error; should never happen */ - BT_ASSERT(!PyErr_Occurred()); - goto end; + /* Overflow errors should never happen. */ + BT_ASSERT_DBG(!PyErr_Occurred()); + + status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK; end: Py_XDECREF(py_method_result); @@ -969,11 +1294,18 @@ component_class_sink_consume(bt_self_component_sink *self_component_sink) PyObject *py_method_result = NULL; bt_component_class_sink_consume_method_status status; - BT_ASSERT(py_comp); + BT_ASSERT_DBG(py_comp); + py_method_result = PyObject_CallMethod(py_comp, "_user_consume", NULL); - status = py_exc_to_status_component(self_component); - BT_ASSERT(py_method_result || status != __BT_FUNC_STATUS_OK); + if (!py_method_result) { + status = py_exc_to_status_component_clear(self_component); + goto end; + } + + status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK; + +end: Py_XDECREF(py_method_result); return status; } @@ -1009,18 +1341,57 @@ end: return ret; } +static +bt_message_iterator_class *create_message_iterator_class(void) +{ + bt_message_iterator_class *message_iterator_class; + bt_message_iterator_class_set_method_status ret; + + message_iterator_class = bt_message_iterator_class_create( + component_class_message_iterator_next); + if (!message_iterator_class) { + BT_LOGE_STR("Cannot create message iterator class."); + goto end; + } + + ret = bt_message_iterator_class_set_seek_beginning_methods( + message_iterator_class, component_class_seek_beginning, + component_class_can_seek_beginning); + BT_ASSERT(ret == 0); + ret = bt_message_iterator_class_set_seek_ns_from_origin_methods( + message_iterator_class, component_class_seek_ns_from_origin, + component_class_can_seek_ns_from_origin); + BT_ASSERT(ret == 0); + ret = bt_message_iterator_class_set_initialize_method( + message_iterator_class, component_class_message_iterator_init); + BT_ASSERT(ret == 0); + ret = bt_message_iterator_class_set_finalize_method( + message_iterator_class, component_class_message_iterator_finalize); + BT_ASSERT(ret == 0); + +end: + return message_iterator_class; +} + static bt_component_class_source *bt_bt2_component_class_source_create( PyObject *py_cls, const char *name, const char *description, const char *help) { - bt_component_class_source *component_class_source; + bt_component_class_source *component_class_source = NULL; + bt_message_iterator_class *message_iterator_class; bt_component_class *component_class; int ret; BT_ASSERT(py_cls); + + message_iterator_class = create_message_iterator_class(); + if (!message_iterator_class) { + goto end; + } + component_class_source = bt_component_class_source_create(name, - component_class_message_iterator_next); + message_iterator_class); if (!component_class_source) { BT_LOGE_STR("Cannot create source component class."); goto end; @@ -1032,30 +1403,21 @@ bt_component_class_source *bt_bt2_component_class_source_create( goto end; } - ret = bt_component_class_source_set_init_method(component_class_source, component_class_source_init); + ret = bt_component_class_source_set_initialize_method(component_class_source, component_class_source_init); BT_ASSERT(ret == 0); ret = bt_component_class_source_set_finalize_method(component_class_source, component_class_source_finalize); BT_ASSERT(ret == 0); - ret = bt_component_class_source_set_message_iterator_can_seek_beginning_method(component_class_source, - component_class_can_seek_beginning); - BT_ASSERT(ret == 0); - ret = bt_component_class_source_set_message_iterator_seek_beginning_method(component_class_source, - component_class_seek_beginning); - BT_ASSERT(ret == 0); ret = bt_component_class_source_set_output_port_connected_method(component_class_source, component_class_source_output_port_connected); BT_ASSERT(ret == 0); ret = bt_component_class_source_set_query_method(component_class_source, component_class_source_query); BT_ASSERT(ret == 0); - ret = bt_component_class_source_set_message_iterator_init_method( - component_class_source, component_class_source_message_iterator_init); - BT_ASSERT(ret == 0); - ret = bt_component_class_source_set_message_iterator_finalize_method( - component_class_source, component_class_message_iterator_finalize); + ret = bt_component_class_source_set_get_supported_mip_versions_method(component_class_source, component_class_source_get_supported_mip_versions); BT_ASSERT(ret == 0); register_cc_ptr_to_py_cls(component_class, py_cls); end: + bt_message_iterator_class_put_ref(message_iterator_class); return component_class_source; } @@ -1064,13 +1426,20 @@ bt_component_class_filter *bt_bt2_component_class_filter_create( PyObject *py_cls, const char *name, const char *description, const char *help) { + bt_component_class_filter *component_class_filter = NULL; + bt_message_iterator_class *message_iterator_class; bt_component_class *component_class; - bt_component_class_filter *component_class_filter; int ret; BT_ASSERT(py_cls); + + message_iterator_class = create_message_iterator_class(); + if (!message_iterator_class) { + goto end; + } + component_class_filter = bt_component_class_filter_create(name, - component_class_message_iterator_next); + message_iterator_class); if (!component_class_filter) { BT_LOGE_STR("Cannot create filter component class."); goto end; @@ -1082,16 +1451,10 @@ bt_component_class_filter *bt_bt2_component_class_filter_create( goto end; } - ret = bt_component_class_filter_set_init_method(component_class_filter, component_class_filter_init); + ret = bt_component_class_filter_set_initialize_method(component_class_filter, component_class_filter_init); BT_ASSERT(ret == 0); ret = bt_component_class_filter_set_finalize_method (component_class_filter, component_class_filter_finalize); BT_ASSERT(ret == 0); - ret = bt_component_class_filter_set_message_iterator_can_seek_beginning_method(component_class_filter, - component_class_can_seek_beginning); - BT_ASSERT(ret == 0); - ret = bt_component_class_filter_set_message_iterator_seek_beginning_method(component_class_filter, - component_class_seek_beginning); - BT_ASSERT(ret == 0); ret = bt_component_class_filter_set_input_port_connected_method(component_class_filter, component_class_filter_input_port_connected); BT_ASSERT(ret == 0); @@ -1100,15 +1463,12 @@ bt_component_class_filter *bt_bt2_component_class_filter_create( BT_ASSERT(ret == 0); ret = bt_component_class_filter_set_query_method(component_class_filter, component_class_filter_query); BT_ASSERT(ret == 0); - ret = bt_component_class_filter_set_message_iterator_init_method( - component_class_filter, component_class_filter_message_iterator_init); - BT_ASSERT(ret == 0); - ret = bt_component_class_filter_set_message_iterator_finalize_method( - component_class_filter, component_class_message_iterator_finalize); + ret = bt_component_class_filter_set_get_supported_mip_versions_method(component_class_filter, component_class_filter_get_supported_mip_versions); BT_ASSERT(ret == 0); register_cc_ptr_to_py_cls(component_class, py_cls); end: + bt_message_iterator_class_put_ref(message_iterator_class); return component_class_filter; } @@ -1135,7 +1495,7 @@ bt_component_class_sink *bt_bt2_component_class_sink_create( goto end; } - ret = bt_component_class_sink_set_init_method(component_class_sink, component_class_sink_init); + ret = bt_component_class_sink_set_initialize_method(component_class_sink, component_class_sink_init); BT_ASSERT(ret == 0); ret = bt_component_class_sink_set_finalize_method(component_class_sink, component_class_sink_finalize); BT_ASSERT(ret == 0); @@ -1147,6 +1507,8 @@ bt_component_class_sink *bt_bt2_component_class_sink_create( BT_ASSERT(ret == 0); ret = bt_component_class_sink_set_query_method(component_class_sink, component_class_sink_query); BT_ASSERT(ret == 0); + ret = bt_component_class_sink_set_get_supported_mip_versions_method(component_class_sink, component_class_sink_get_supported_mip_versions); + BT_ASSERT(ret == 0); register_cc_ptr_to_py_cls(component_class, py_cls); end: