src/bindings/python/bt2/bt2/native_bt_component_class.i.h

   1 /*
   2  * The MIT License (MIT)
   3  *
   4  * Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   5  *
   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:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  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
  22  * THE SOFTWARE.
  23  */
  24
  25 #include "logging/comp-logging.h"
  26 #include "compat/glib.h"
  27
  28 /*
  29  * This hash table associates a BT component class object address to a
  30  * user-defined Python class (PyObject *). The keys and values are NOT
  31  * owned by this hash table. The Python class objects are owned by the
  32  * Python module, which should not be unloaded until it is not possible
  33  * to create a user Python component anyway.
  34  *
  35  * This hash table is written to when a user-defined Python component
  36  * class is created by one of the bt_bt2_component_class_*_create()
  37  * functions.
  38  *
  39  * This function is read from when a user calls bt_component_create()
  40  * with a component class pointer created by one of the functions above.
  41  * In this case, the original Python class needs to be found to
  42  * instantiate it and associate the created Python component object with
  43  * a BT component object instance.
  44  */
  45
  46 static GHashTable *bt_cc_ptr_to_py_cls;
  47
  48 static
  49 void bt_bt2_unregister_cc_ptr_to_py_cls(const bt_component_class *comp_cls)
  50 {
  51         gboolean existed;
  52
  53         if (!bt_cc_ptr_to_py_cls) {
  54                 return;
  55         }
  56
  57         existed = g_hash_table_remove(bt_cc_ptr_to_py_cls, comp_cls);
  58         BT_ASSERT(existed);
  59 }
  60
  61 static
  62 void register_cc_ptr_to_py_cls(struct bt_component_class *bt_cc,
  63                 PyObject *py_cls)
  64 {
  65         if (!bt_cc_ptr_to_py_cls) {
  66                 /*
  67                  * Lazy-initializing this GHashTable because GLib
  68                  * might not be initialized yet and it needs to be
  69                  * before we call g_hash_table_new()
  70                  */
  71                 BT_LOGD_STR("Creating native component class to Python component class hash table.");
  72                 bt_cc_ptr_to_py_cls = g_hash_table_new(g_direct_hash, g_direct_equal);
  73                 BT_ASSERT(bt_cc_ptr_to_py_cls);
  74         }
  75
  76         g_hash_table_insert(bt_cc_ptr_to_py_cls, (gpointer) bt_cc,
  77                 (gpointer) py_cls);
  78 }
  79
  80 static
  81 PyObject *lookup_cc_ptr_to_py_cls(const bt_component_class *bt_cc)
  82 {
  83         if (!bt_cc_ptr_to_py_cls) {
  84                 BT_LOGW("Cannot look up Python component class because hash table is NULL: "
  85                         "comp-cls-addr=%p", bt_cc);
  86                 return NULL;
  87         }
  88
  89         return (PyObject *) g_hash_table_lookup(bt_cc_ptr_to_py_cls,
  90                 (gconstpointer) bt_cc);
  91 }
  92
  93 /* Library destructor */
  94
  95 __attribute__((destructor))
  96 static
  97 void native_comp_class_dtor(void) {
  98         /* Destroy component class association hash table */
  99         if (bt_cc_ptr_to_py_cls) {
 100                 BT_LOGD_STR("Destroying native component class to Python component class hash table.");
 101                 g_hash_table_destroy(bt_cc_ptr_to_py_cls);
 102                 bt_cc_ptr_to_py_cls = NULL;
 103         }
 104 }
 105
 106 static inline
 107 int py_exc_to_status(bt_self_component_class *self_component_class,
 108                 bt_self_component *self_component,
 109                 bt_self_message_iterator *self_message_iterator,
 110                 const char *module_name, int active_log_level)
 111 {
 112         int status = __BT_FUNC_STATUS_OK;
 113         PyObject *exc = PyErr_Occurred();
 114
 115         if (!exc) {
 116                 goto end;
 117         }
 118
 119         if (PyErr_GivenExceptionMatches(exc,
 120                         py_mod_bt2_exc_try_again_type)) {
 121                 status = __BT_FUNC_STATUS_AGAIN;
 122         } else if (PyErr_GivenExceptionMatches(exc,
 123                         py_mod_bt2_exc_stop_type)) {
 124                 status = __BT_FUNC_STATUS_END;
 125         } else if (PyErr_GivenExceptionMatches(exc,
 126                         py_mod_bt2_exc_unknown_object_type)) {
 127                 status = __BT_FUNC_STATUS_UNKNOWN_OBJECT;
 128         } else {
 129                 /*
 130                  * Unknown exception: convert to general error.
 131                  *
 132                  * Because we only want to fetch the log level when
 133                  * we actually get an exception, and not systematically
 134                  * when we call py_exc_to_status() (as py_exc_to_status()
 135                  * can return `__BT_FUNC_STATUS_OK`), we get it here
 136                  * depending on the actor's type.
 137                  */
 138                 if (self_component) {
 139                         active_log_level = get_self_component_log_level(
 140                                 self_component);
 141                 } else if (self_message_iterator) {
 142                         active_log_level = get_self_message_iterator_log_level(
 143                                 self_message_iterator);
 144                 }
 145
 146                 BT_ASSERT(active_log_level != -1);
 147                 log_exception_and_maybe_append_error(BT_LOG_WARNING,
 148                         active_log_level, true,
 149                         self_component_class, self_component,
 150                         self_message_iterator, module_name);
 151
 152                 if (PyErr_GivenExceptionMatches(exc,
 153                                 py_mod_bt2_exc_memory_error)) {
 154                         status = __BT_FUNC_STATUS_MEMORY_ERROR;
 155                 } else {
 156                         status = __BT_FUNC_STATUS_ERROR;
 157                 }
 158         }
 159
 160 end:
 161         PyErr_Clear();
 162         return status;
 163 }
 164
 165 static
 166 int py_exc_to_status_component_class(
 167                 bt_self_component_class *self_component_class,
 168                 int active_log_level)
 169 {
 170         return py_exc_to_status(self_component_class, NULL, NULL, NULL,
 171                 active_log_level);
 172 }
 173
 174 static
 175 int py_exc_to_status_component(bt_self_component *self_component)
 176 {
 177         return py_exc_to_status(NULL, self_component, NULL, NULL, -1);
 178 }
 179
 180 static
 181 int py_exc_to_status_message_iterator(
 182                 bt_self_message_iterator *self_message_iterator)
 183 {
 184         return py_exc_to_status(NULL, NULL, self_message_iterator, NULL, -1);
 185 }
 186
 187 static
 188 bool bt_bt2_is_python_component_class(const bt_component_class *comp_cls)
 189 {
 190         return bt_g_hash_table_contains(bt_cc_ptr_to_py_cls, comp_cls);
 191 }
 192
 193 /* Component class proxy methods (delegate to the attached Python object) */
 194
 195 static
 196 bt_component_class_init_method_status component_class_init(
 197                 bt_self_component *self_component,
 198                 void *self_component_v,
 199                 swig_type_info *self_comp_cls_type_swig_type,
 200                 const bt_value *params,
 201                 void *init_method_data)
 202 {
 203         const bt_component *component = bt_self_component_as_component(self_component);
 204         const bt_component_class *component_class = bt_component_borrow_class_const(component);
 205         bt_component_class_init_method_status status = __BT_FUNC_STATUS_OK;
 206         PyObject *py_cls = NULL;
 207         PyObject *py_comp = NULL;
 208         PyObject *py_params_ptr = NULL;
 209         PyObject *py_comp_ptr = NULL;
 210         bt_logging_level log_level = get_self_component_log_level(
 211                 self_component);
 212
 213         BT_ASSERT(self_component);
 214         BT_ASSERT(self_component_v);
 215         BT_ASSERT(self_comp_cls_type_swig_type);
 216
 217         /*
 218          * Get the user-defined Python class which created this
 219          * component's class in the first place (borrowed
 220          * reference).
 221          */
 222         py_cls = lookup_cc_ptr_to_py_cls(component_class);
 223         if (!py_cls) {
 224                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
 225                         "Cannot find Python class associated to native component class: "
 226                         "comp-cls-addr=%p", component_class);
 227                 goto error;
 228         }
 229
 230         /* Parameters pointer -> SWIG pointer Python object */
 231         py_params_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(params),
 232                 SWIGTYPE_p_bt_value, 0);
 233         if (!py_params_ptr) {
 234                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
 235                         "Failed to create a SWIG pointer object.");
 236                 goto error;
 237         }
 238
 239         py_comp_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(self_component_v),
 240                 self_comp_cls_type_swig_type, 0);
 241         if (!py_comp_ptr) {
 242                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
 243                         "Failed to create a SWIG pointer object.");
 244                 goto error;
 245         }
 246
 247         /*
 248          * Do the equivalent of this:
 249          *
 250          *     py_comp = py_cls._bt_init_from_native(py_comp_ptr,
 251          *         py_params_ptr, init_method_data ? init_method_data : Py_None)
 252          *
 253          * _UserComponentType._bt_init_from_native() calls the Python
 254          * component object's __init__() function.
 255          *
 256          * We don't take any reference on `init_method_data` which, if
 257          * not `NULL`, is assumed to be a `PyObject *`: the user's
 258          * __init__() function will eventually take a reference if
 259          * needed. If `init_method_data` is `NULL`, then we pass
 260          * `Py_None` as the initialization's Python object.
 261          */
 262         py_comp = PyObject_CallMethod(py_cls,
 263                 "_bt_init_from_native", "(OOO)", py_comp_ptr, py_params_ptr,
 264                 init_method_data ? init_method_data : Py_None);
 265         if (!py_comp) {
 266                 BT_COMP_LOG_CUR_LVL(BT_LOG_WARNING, log_level, self_component,
 267                         "Failed to call Python class's _bt_init_from_native() method: "
 268                         "py-cls-addr=%p", py_cls);
 269                 status = py_exc_to_status_component(self_component);
 270                 goto end;
 271         }
 272
 273         /*
 274          * Our user Python component object is now fully created and
 275          * initialized by the user. Since we just created it, this
 276          * native component is its only (persistent) owner.
 277          */
 278         bt_self_component_set_data(self_component, py_comp);
 279         py_comp = NULL;
 280         goto end;
 281
 282 error:
 283         status = __BT_FUNC_STATUS_ERROR;
 284
 285         /*
 286          * Clear any exception: we're returning a bad status anyway. If
 287          * this call originated from Python (creation from a plugin's
 288          * component class, for example), then the user gets an
 289          * appropriate creation error.
 290          */
 291         PyErr_Clear();
 292
 293 end:
 294         Py_XDECREF(py_comp);
 295         Py_XDECREF(py_params_ptr);
 296         Py_XDECREF(py_comp_ptr);
 297         return status;
 298 }
 299
 300 static
 301 bt_component_class_get_supported_mip_versions_method_status
 302 component_class_get_supported_mip_versions(
 303                 const bt_component_class *component_class,
 304                 bt_self_component_class *self_component_class,
 305                 const bt_value *params, void *init_method_data,
 306                 bt_logging_level log_level,
 307                 bt_integer_range_set_unsigned *supported_versions)
 308 {
 309         uint64_t i;
 310         PyObject *py_cls = NULL;
 311         PyObject *py_params_ptr = NULL;
 312         PyObject *py_range_set_addr = NULL;
 313         bt_integer_range_set_unsigned *ret_range_set = NULL;
 314         bt_component_class_get_supported_mip_versions_method_status status =
 315                 __BT_FUNC_STATUS_OK;
 316
 317         py_cls = lookup_cc_ptr_to_py_cls(component_class);
 318         if (!py_cls) {
 319                 BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
 320                         "Cannot find Python class associated to native component class: "
 321                         "comp-cls-addr=%p", component_class);
 322                 goto error;
 323         }
 324
 325         py_params_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(params),
 326                 SWIGTYPE_p_bt_value, 0);
 327         if (!py_params_ptr) {
 328                 BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
 329                         "Failed to create a SWIG pointer object.");
 330                 goto error;
 331         }
 332
 333         /*
 334          * We don't take any reference on `init_method_data` which, if
 335          * not `NULL`, is assumed to be a `PyObject *`: the user's
 336          * _user_get_supported_mip_versions() function will eventually
 337          * take a reference if needed. If `init_method_data` is `NULL`,
 338          * then we pass `Py_None` as the initialization's Python object.
 339          */
 340         py_range_set_addr = PyObject_CallMethod(py_cls,
 341                 "_bt_get_supported_mip_versions_from_native", "(OOi)",
 342                 py_params_ptr, init_method_data ? init_method_data : Py_None,
 343                 (int) log_level);
 344         if (!py_range_set_addr) {
 345                 BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING, log_level, BT_LOG_TAG,
 346                         "Failed to call Python class's _bt_get_supported_mip_versions_from_native() method: "
 347                         "py-cls-addr=%p", py_cls);
 348                 status = py_exc_to_status_component_class(self_component_class,
 349                         log_level);
 350                 goto end;
 351         }
 352
 353         /*
 354          * The returned object, on success, is an integer object
 355          * (PyLong) containing the address of a BT unsigned integer
 356          * range set object (new reference).
 357          */
 358         ret_range_set = PyLong_AsVoidPtr(py_range_set_addr);
 359         BT_ASSERT(!PyErr_Occurred());
 360         BT_ASSERT(ret_range_set);
 361
 362         /* Copy returned ranges to input range set */
 363         for (i = 0; i < bt_integer_range_set_get_range_count(
 364                         bt_integer_range_set_unsigned_as_range_set_const(ret_range_set));
 365                         i++) {
 366                 const bt_integer_range_unsigned *range =
 367                         bt_integer_range_set_unsigned_borrow_range_by_index_const(
 368                                 ret_range_set, i);
 369                 bt_integer_range_set_add_range_status add_range_status;
 370
 371                 add_range_status = bt_integer_range_set_unsigned_add_range(
 372                         supported_versions,
 373                         bt_integer_range_unsigned_get_lower(range),
 374                         bt_integer_range_unsigned_get_upper(range));
 375                 if (add_range_status) {
 376                         BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
 377                                 "Failed to add range to supported MIP versions range set.");
 378                         goto error;
 379                 }
 380         }
 381
 382         goto end;
 383
 384 error:
 385         PyErr_Clear();
 386         status = __BT_FUNC_STATUS_ERROR;
 387
 388 end:
 389         Py_XDECREF(py_params_ptr);
 390         Py_XDECREF(py_range_set_addr);
 391         bt_integer_range_set_unsigned_put_ref(ret_range_set);
 392         return status;
 393 }
 394
 395 static
 396 bt_component_class_get_supported_mip_versions_method_status
 397 component_class_source_get_supported_mip_versions(
 398                 bt_self_component_class_source *self_component_class_source,
 399                 const bt_value *params, void *init_method_data,
 400                 bt_logging_level log_level,
 401                 bt_integer_range_set_unsigned *supported_versions)
 402 {
 403         const bt_component_class_source *component_class_source = bt_self_component_class_source_as_component_class_source(self_component_class_source);
 404         const bt_component_class *component_class = bt_component_class_source_as_component_class_const(component_class_source);
 405         bt_self_component_class *self_component_class = bt_self_component_class_source_as_self_component_class(self_component_class_source);
 406
 407         return component_class_get_supported_mip_versions(
 408                 component_class, self_component_class,
 409                 params, init_method_data, log_level, supported_versions);
 410 }
 411
 412 static
 413 bt_component_class_get_supported_mip_versions_method_status
 414 component_class_filter_get_supported_mip_versions(
 415                 bt_self_component_class_filter *self_component_class_filter,
 416                 const bt_value *params, void *init_method_data,
 417                 bt_logging_level log_level,
 418                 bt_integer_range_set_unsigned *supported_versions)
 419 {
 420         const bt_component_class_filter *component_class_filter = bt_self_component_class_filter_as_component_class_filter(self_component_class_filter);
 421         const bt_component_class *component_class = bt_component_class_filter_as_component_class_const(component_class_filter);
 422         bt_self_component_class *self_component_class = bt_self_component_class_filter_as_self_component_class(self_component_class_filter);
 423
 424         return component_class_get_supported_mip_versions(
 425                 component_class, self_component_class,
 426                 params, init_method_data, log_level, supported_versions);
 427 }
 428
 429 static
 430 bt_component_class_get_supported_mip_versions_method_status
 431 component_class_sink_get_supported_mip_versions(
 432                 bt_self_component_class_sink *self_component_class_sink,
 433                 const bt_value *params, void *init_method_data,
 434                 bt_logging_level log_level,
 435                 bt_integer_range_set_unsigned *supported_versions)
 436 {
 437         const bt_component_class_sink *component_class_sink = bt_self_component_class_sink_as_component_class_sink(self_component_class_sink);
 438         const bt_component_class *component_class = bt_component_class_sink_as_component_class_const(component_class_sink);
 439         bt_self_component_class *self_component_class = bt_self_component_class_sink_as_self_component_class(self_component_class_sink);
 440
 441         return component_class_get_supported_mip_versions(
 442                 component_class, self_component_class,
 443                 params, init_method_data, log_level, supported_versions);
 444 }
 445
 446 /*
 447  * Method of bt_component_class_source to initialize a bt_self_component_source
 448  * of that class.
 449  */
 450
 451 static
 452 bt_component_class_init_method_status component_class_source_init(
 453                 bt_self_component_source *self_component_source,
 454                 const bt_value *params, void *init_method_data)
 455 {
 456         bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source);
 457         return component_class_init(
 458                 self_component,
 459                 self_component_source,
 460                 SWIGTYPE_p_bt_self_component_source,
 461                 params, init_method_data);
 462 }
 463
 464 static
 465 bt_component_class_init_method_status component_class_filter_init(
 466                 bt_self_component_filter *self_component_filter,
 467                 const bt_value *params, void *init_method_data)
 468 {
 469         bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter);
 470         return component_class_init(
 471                 self_component,
 472                 self_component_filter,
 473                 SWIGTYPE_p_bt_self_component_filter,
 474                 params, init_method_data);
 475 }
 476
 477 static
 478 bt_component_class_init_method_status component_class_sink_init(
 479                 bt_self_component_sink *self_component_sink,
 480                 const bt_value *params, void *init_method_data)
 481 {
 482         bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink);
 483         return component_class_init(
 484                 self_component,
 485                 self_component_sink,
 486                 SWIGTYPE_p_bt_self_component_sink,
 487                 params, init_method_data);
 488 }
 489
 490 static
 491 void component_class_finalize(bt_self_component *self_component)
 492 {
 493         PyObject *py_comp = bt_self_component_get_data(self_component);
 494         BT_ASSERT(py_comp);
 495
 496         /* Call user's _user_finalize() method */
 497         PyObject *py_method_result = PyObject_CallMethod(py_comp,
 498                 "_user_finalize", NULL);
 499
 500         if (PyErr_Occurred()) {
 501                 bt_logging_level log_level = get_self_component_log_level(
 502                         self_component);
 503
 504                 BT_COMP_LOG_CUR_LVL(BT_LOG_WARNING, log_level, self_component,
 505                         "User component's _user_finalize() method raised an exception: ignoring:");
 506                 logw_exception(log_level);
 507         }
 508
 509         /*
 510          * Ignore any exception raised by the _user_finalize() method
 511          * because it won't change anything at this point: the component
 512          * is being destroyed anyway.
 513          */
 514         PyErr_Clear();
 515         Py_XDECREF(py_method_result);
 516         Py_DECREF(py_comp);
 517 }
 518
 519 static
 520 void component_class_source_finalize(bt_self_component_source *self_component_source)
 521 {
 522         bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source);
 523         component_class_finalize(self_component);
 524 }
 525
 526 static
 527 void component_class_filter_finalize(bt_self_component_filter *self_component_filter)
 528 {
 529         bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter);
 530         component_class_finalize(self_component);
 531 }
 532
 533 static
 534 void component_class_sink_finalize(bt_self_component_sink *self_component_sink)
 535 {
 536         bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink);
 537         component_class_finalize(self_component);
 538 }
 539
 540 static
 541 bt_component_class_message_iterator_can_seek_beginning_method_status
 542 component_class_can_seek_beginning(
 543                 bt_self_message_iterator *self_message_iterator, bt_bool *can_seek)
 544 {
 545         PyObject *py_iter;
 546         PyObject *py_result = NULL;
 547         bt_component_class_message_iterator_can_seek_beginning_method_status status;
 548         py_iter = bt_self_message_iterator_get_data(self_message_iterator);
 549         BT_ASSERT(py_iter);
 550
 551         py_result = PyObject_CallMethod(py_iter,
 552                 "_bt_can_seek_beginning_from_native", NULL);
 553
 554         BT_ASSERT(!py_result || PyBool_Check(py_result));
 555
 556         if (py_result) {
 557                 *can_seek = PyObject_IsTrue(py_result);
 558                 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_METHOD_STATUS_OK;
 559         } else {
 560                 status = py_exc_to_status_message_iterator(self_message_iterator);
 561                 BT_ASSERT(status != __BT_FUNC_STATUS_OK);
 562         }
 563
 564         Py_XDECREF(py_result);
 565
 566         return status;
 567 }
 568
 569 static
 570 bt_component_class_message_iterator_seek_beginning_method_status
 571 component_class_seek_beginning(bt_self_message_iterator *self_message_iterator)
 572 {
 573         PyObject *py_iter;
 574         PyObject *py_result;
 575         bt_component_class_message_iterator_seek_beginning_method_status status;
 576
 577         py_iter = bt_self_message_iterator_get_data(self_message_iterator);
 578         BT_ASSERT(py_iter);
 579         py_result = PyObject_CallMethod(py_iter, "_bt_seek_beginning_from_native",
 580                 NULL);
 581         BT_ASSERT(!py_result || py_result == Py_None);
 582         status = py_exc_to_status_message_iterator(self_message_iterator);
 583         Py_XDECREF(py_result);
 584         return status;
 585 }
 586
 587 static
 588 bt_component_class_message_iterator_can_seek_ns_from_origin_method_status
 589 component_class_can_seek_ns_from_origin(
 590                 bt_self_message_iterator *self_message_iterator,
 591                 int64_t ns_from_origin, bt_bool *can_seek)
 592 {
 593         PyObject *py_iter;
 594         PyObject *py_result = NULL;
 595         bt_component_class_message_iterator_can_seek_ns_from_origin_method_status status;
 596         py_iter = bt_self_message_iterator_get_data(self_message_iterator);
 597         BT_ASSERT(py_iter);
 598
 599         py_result = PyObject_CallMethod(py_iter,
 600                 "_bt_can_seek_ns_from_origin_from_native", "L", ns_from_origin);
 601
 602         BT_ASSERT(!py_result || PyBool_Check(py_result));
 603
 604         if (py_result) {
 605                 *can_seek = PyObject_IsTrue(py_result);
 606                 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK;
 607         } else {
 608                 status = py_exc_to_status_message_iterator(self_message_iterator);
 609                 BT_ASSERT(status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK);
 610         }
 611
 612         Py_XDECREF(py_result);
 613
 614         return status;
 615 }
 616
 617 static
 618 bt_component_class_message_iterator_seek_ns_from_origin_method_status
 619 component_class_seek_ns_from_origin(
 620                 bt_self_message_iterator *self_message_iterator,
 621                 int64_t ns_from_origin)
 622 {
 623         PyObject *py_iter;
 624         PyObject *py_result;
 625         bt_component_class_message_iterator_seek_ns_from_origin_method_status status;
 626
 627         py_iter = bt_self_message_iterator_get_data(self_message_iterator);
 628         BT_ASSERT(py_iter);
 629         py_result = PyObject_CallMethod(py_iter,
 630                 "_bt_seek_ns_from_origin_from_native", "L", ns_from_origin);
 631         BT_ASSERT(!py_result || py_result == Py_None);
 632         status = py_exc_to_status_message_iterator(self_message_iterator);
 633         Py_XDECREF(py_result);
 634         return status;
 635 }
 636
 637 static
 638 bt_component_class_port_connected_method_status component_class_port_connected(
 639                 bt_self_component *self_component,
 640                 void *self_component_port,
 641                 swig_type_info *self_component_port_swig_type,
 642                 bt_port_type self_component_port_type,
 643                 const void *other_port,
 644                 swig_type_info *other_port_swig_type)
 645 {
 646         bt_component_class_port_connected_method_status status;
 647         PyObject *py_comp = NULL;
 648         PyObject *py_self_port_ptr = NULL;
 649         PyObject *py_other_port_ptr = NULL;
 650         PyObject *py_method_result = NULL;
 651         bt_logging_level log_level = get_self_component_log_level(
 652                 self_component);
 653
 654         py_comp = bt_self_component_get_data(self_component);
 655         BT_ASSERT(py_comp);
 656         py_self_port_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(self_component_port),
 657                 self_component_port_swig_type, 0);
 658         if (!py_self_port_ptr) {
 659                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
 660                         "Failed to create a SWIG pointer object.");
 661                 status = __BT_FUNC_STATUS_MEMORY_ERROR;
 662                 goto end;
 663         }
 664
 665         py_other_port_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(other_port),
 666                 other_port_swig_type, 0);
 667         if (!py_other_port_ptr) {
 668                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
 669                         "Failed to create a SWIG pointer object.");
 670                 status = __BT_FUNC_STATUS_MEMORY_ERROR;
 671                 goto end;       }
 672
 673         py_method_result = PyObject_CallMethod(py_comp,
 674                 "_bt_port_connected_from_native", "(OiO)", py_self_port_ptr,
 675                 self_component_port_type, py_other_port_ptr);
 676         BT_ASSERT(!py_method_result || py_method_result == Py_None);
 677         status = py_exc_to_status_component(self_component);
 678
 679 end:
 680         Py_XDECREF(py_self_port_ptr);
 681         Py_XDECREF(py_other_port_ptr);
 682         Py_XDECREF(py_method_result);
 683         return status;
 684 }
 685
 686 static
 687 bt_component_class_port_connected_method_status
 688 component_class_source_output_port_connected(
 689                 bt_self_component_source *self_component_source,
 690                 bt_self_component_port_output *self_component_port_output,
 691                 const bt_port_input *other_port_input)
 692 {
 693         bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source);
 694
 695         return component_class_port_connected(
 696                 self_component,
 697                 self_component_port_output,
 698                 SWIGTYPE_p_bt_self_component_port_output,
 699                 BT_PORT_TYPE_OUTPUT,
 700                 other_port_input,
 701                 SWIGTYPE_p_bt_port_input);
 702 }
 703
 704 static
 705 bt_component_class_port_connected_method_status
 706 component_class_filter_input_port_connected(
 707                 bt_self_component_filter *self_component_filter,
 708                 bt_self_component_port_input *self_component_port_input,
 709                 const bt_port_output *other_port_output)
 710 {
 711         bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter);
 712
 713         return component_class_port_connected(
 714                 self_component,
 715                 self_component_port_input,
 716                 SWIGTYPE_p_bt_self_component_port_input,
 717                 BT_PORT_TYPE_INPUT,
 718                 other_port_output,
 719                 SWIGTYPE_p_bt_port_output);
 720 }
 721
 722 static
 723 bt_component_class_port_connected_method_status
 724 component_class_filter_output_port_connected(
 725                 bt_self_component_filter *self_component_filter,
 726                 bt_self_component_port_output *self_component_port_output,
 727                 const bt_port_input *other_port_input)
 728 {
 729         bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter);
 730
 731         return component_class_port_connected(
 732                 self_component,
 733                 self_component_port_output,
 734                 SWIGTYPE_p_bt_self_component_port_output,
 735                 BT_PORT_TYPE_OUTPUT,
 736                 other_port_input,
 737                 SWIGTYPE_p_bt_port_input);
 738 }
 739
 740 static
 741 bt_component_class_port_connected_method_status
 742 component_class_sink_input_port_connected(
 743                 bt_self_component_sink *self_component_sink,
 744                 bt_self_component_port_input *self_component_port_input,
 745                 const bt_port_output *other_port_output)
 746 {
 747         bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink);
 748
 749         return component_class_port_connected(
 750                 self_component,
 751                 self_component_port_input,
 752                 SWIGTYPE_p_bt_self_component_port_input,
 753                 BT_PORT_TYPE_INPUT,
 754                 other_port_output,
 755                 SWIGTYPE_p_bt_port_output);
 756 }
 757
 758 static
 759 bt_component_class_sink_graph_is_configured_method_status
 760 component_class_sink_graph_is_configured(
 761                 bt_self_component_sink *self_component_sink)
 762 {
 763         PyObject *py_comp = NULL;
 764         PyObject *py_method_result = NULL;
 765         bt_component_class_sink_graph_is_configured_method_status status = __BT_FUNC_STATUS_OK;
 766         bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink);
 767
 768         py_comp = bt_self_component_get_data(self_component);
 769         py_method_result = PyObject_CallMethod(py_comp,
 770                 "_bt_graph_is_configured_from_native", NULL);
 771         BT_ASSERT(!py_method_result || py_method_result == Py_None);
 772         status = py_exc_to_status_component(self_component);
 773         Py_XDECREF(py_method_result);
 774         return status;
 775 }
 776
 777 static
 778 bt_component_class_query_method_status component_class_query(
 779                 const bt_component_class *component_class,
 780                 bt_self_component_class *self_component_class,
 781                 bt_private_query_executor *priv_query_executor,
 782                 const char *object, const bt_value *params, void *method_data,
 783                 const bt_value **result)
 784 {
 785         PyObject *py_cls = NULL;
 786         PyObject *py_params_ptr = NULL;
 787         PyObject *py_priv_query_exec_ptr = NULL;
 788         PyObject *py_query_func = NULL;
 789         PyObject *py_object = NULL;
 790         PyObject *py_results_addr = NULL;
 791         bt_component_class_query_method_status status = __BT_FUNC_STATUS_OK;
 792         const bt_query_executor *query_exec =
 793                 bt_private_query_executor_as_query_executor_const(
 794                         priv_query_executor);
 795         bt_logging_level log_level =
 796                 bt_query_executor_get_logging_level(query_exec);
 797
 798         /*
 799          * If there's any `method_data`, assume this component class is
 800          * getting queried from Python, so that `method_data` is a
 801          * Python object to pass to the user's _user_query() method.
 802          */
 803         BT_ASSERT(!method_data ||
 804                         bt_bt2_is_python_component_class(component_class));
 805
 806         py_cls = lookup_cc_ptr_to_py_cls(component_class);
 807         if (!py_cls) {
 808                 BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
 809                         "Cannot find Python class associated to native component class: "
 810                         "comp-cls-addr=%p", component_class);
 811                 goto error;
 812         }
 813
 814         py_params_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(params),
 815                 SWIGTYPE_p_bt_value, 0);
 816         if (!py_params_ptr) {
 817                 BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
 818                         "Failed to create a SWIG pointer object.");
 819                 goto error;
 820         }
 821
 822         py_priv_query_exec_ptr = SWIG_NewPointerObj(
 823                 SWIG_as_voidptr(priv_query_executor),
 824                 SWIGTYPE_p_bt_private_query_executor, 0);
 825         if (!py_priv_query_exec_ptr) {
 826                 BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
 827                         "Failed to create a SWIG pointer object.");
 828                 goto error;
 829         }
 830
 831         py_object = SWIG_FromCharPtr(object);
 832         if (!py_object) {
 833                 BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
 834                         "Failed to create a Python string.");
 835                 goto error;
 836         }
 837
 838         /*
 839          * We don't take any reference on `method_data` which, if not
 840          * `NULL`, is assumed to be a `PyObject *`: the user's
 841          * _user_query() function will eventually take a reference if
 842          * needed. If `method_data` is `NULL`, then we pass `Py_None` as
 843          * the initialization's Python object.
 844          */
 845         py_results_addr = PyObject_CallMethod(py_cls,
 846                 "_bt_query_from_native", "(OOOO)", py_priv_query_exec_ptr,
 847                 py_object, py_params_ptr,
 848                 method_data ? method_data : Py_None);
 849         if (!py_results_addr) {
 850                 status = py_exc_to_status_component_class(self_component_class,
 851                         log_level);
 852                 if (status < 0) {
 853                         static const char *fmt =
 854                                 "Failed to call Python class's _bt_query_from_native() method: py-cls-addr=%p";
 855                         BT_LOG_WRITE_CUR_LVL(BT_LOG_WARNING, log_level, BT_LOG_TAG,
 856                                 fmt, py_cls);
 857                         BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT_CLASS(
 858                                 self_component_class, fmt, py_cls);
 859                 }
 860                 goto end;
 861         }
 862
 863         /*
 864          * The returned object, on success, is an integer object
 865          * (PyLong) containing the address of a BT value object (new
 866          * reference).
 867          */
 868         *result = PyLong_AsVoidPtr(py_results_addr);
 869         BT_ASSERT(!PyErr_Occurred());
 870         BT_ASSERT(*result);
 871         goto end;
 872
 873 error:
 874         PyErr_Clear();
 875         status = __BT_FUNC_STATUS_ERROR;
 876
 877 end:
 878         Py_XDECREF(py_params_ptr);
 879         Py_XDECREF(py_priv_query_exec_ptr);
 880         Py_XDECREF(py_query_func);
 881         Py_XDECREF(py_object);
 882         Py_XDECREF(py_results_addr);
 883         return status;
 884 }
 885
 886 static
 887 bt_component_class_query_method_status component_class_source_query(
 888                 bt_self_component_class_source *self_component_class_source,
 889                 bt_private_query_executor *priv_query_executor,
 890                 const char *object, const bt_value *params, void *method_data,
 891                 const bt_value **result)
 892 {
 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);
 896
 897         return component_class_query(component_class, self_component_class,
 898                 priv_query_executor, object, params, method_data, result);
 899 }
 900
 901 static
 902 bt_component_class_query_method_status component_class_filter_query(
 903                 bt_self_component_class_filter *self_component_class_filter,
 904                 bt_private_query_executor *priv_query_executor,
 905                 const char *object, const bt_value *params, void *method_data,
 906                 const bt_value **result)
 907 {
 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);
 911
 912         return component_class_query(component_class, self_component_class,
 913                 priv_query_executor, object, params, method_data, result);
 914 }
 915
 916 static
 917 bt_component_class_query_method_status component_class_sink_query(
 918                 bt_self_component_class_sink *self_component_class_sink,
 919                 bt_private_query_executor *priv_query_executor,
 920                 const char *object, const bt_value *params, void *method_data,
 921                 const bt_value **result)
 922 {
 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);
 926
 927         return component_class_query(component_class, self_component_class,
 928                 priv_query_executor, object, params, method_data, result);
 929 }
 930
 931 static
 932 bt_component_class_message_iterator_init_method_status
 933 component_class_message_iterator_init(
 934                 bt_self_message_iterator *self_message_iterator,
 935                 bt_self_component *self_component,
 936                 bt_self_component_port_output *self_component_port_output)
 937 {
 938         bt_component_class_message_iterator_init_method_status status = __BT_FUNC_STATUS_OK;
 939         PyObject *py_comp_cls = NULL;
 940         PyObject *py_iter_cls = NULL;
 941         PyObject *py_iter_ptr = NULL;
 942         PyObject *py_component_port_output_ptr = NULL;
 943         PyObject *py_init_method_result = NULL;
 944         PyObject *py_iter = NULL;
 945         PyObject *py_comp;
 946         bt_logging_level log_level = get_self_component_log_level(
 947                 self_component);
 948
 949         py_comp = bt_self_component_get_data(self_component);
 950
 951         /* Find user's Python message iterator class */
 952         py_comp_cls = PyObject_GetAttrString(py_comp, "__class__");
 953         if (!py_comp_cls) {
 954                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
 955                         "Cannot get Python object's `__class__` attribute.");
 956                 goto python_error;
 957         }
 958
 959         py_iter_cls = PyObject_GetAttrString(py_comp_cls, "_iter_cls");
 960         if (!py_iter_cls) {
 961                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
 962                         "Cannot get Python class's `_iter_cls` attribute.");
 963                 goto python_error;
 964         }
 965
 966         py_iter_ptr = SWIG_NewPointerObj(SWIG_as_voidptr(self_message_iterator),
 967                 SWIGTYPE_p_bt_self_message_iterator, 0);
 968         if (!py_iter_ptr) {
 969                 const char *err = "Failed to create a SWIG pointer object.";
 970
 971                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
 972                         "%s", err);
 973                 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR(
 974                         self_message_iterator, err);
 975                 goto error;
 976         }
 977
 978         /*
 979          * Create object with borrowed native message iterator
 980          * reference:
 981          *
 982          *     py_iter = py_iter_cls.__new__(py_iter_cls, py_iter_ptr)
 983          */
 984         py_iter = PyObject_CallMethod(py_iter_cls, "__new__",
 985                 "(OO)", py_iter_cls, py_iter_ptr);
 986         if (!py_iter) {
 987                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
 988                         "Failed to call Python class's __new__() method: "
 989                         "py-cls-addr=%p", py_iter_cls);
 990                 goto python_error;
 991         }
 992
 993         /*
 994          * Initialize object:
 995          *
 996          *     py_iter.__init__(self_output_port)
 997          *
 998          * through the _init_for_native helper static method.
 999          *
1000          * At this point, py_iter._ptr is set, so this initialization
1001          * function has access to self._component (which gives it the
1002          * user Python component object from which the iterator was
1003          * created).
1004          */
1005         py_component_port_output_ptr = SWIG_NewPointerObj(
1006                 SWIG_as_voidptr(self_component_port_output),
1007                 SWIGTYPE_p_bt_self_component_port_output, 0);
1008         if (!py_component_port_output_ptr) {
1009                 const char *err = "Failed to create a SWIG pointer object.";
1010
1011                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
1012                         "%s", err);
1013                 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR(
1014                         self_message_iterator, err);
1015                 goto error;
1016         }
1017
1018         py_init_method_result = PyObject_CallMethod(py_iter,
1019                 "_bt_init_from_native", "O", py_component_port_output_ptr);
1020         if (!py_init_method_result) {
1021                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_component,
1022                         "User's __init__() method failed:");
1023                 goto python_error;
1024         }
1025
1026         /*
1027          * Since the Python code can never instantiate a user-defined
1028          * message iterator class, the native message iterator
1029          * object does NOT belong to a user Python message iterator
1030          * object (borrowed reference). However this Python object is
1031          * owned by this native message iterator object.
1032          *
1033          * In the Python world, the lifetime of the native message
1034          * iterator is managed by a _GenericMessageIterator
1035          * instance:
1036          *
1037          *     _GenericMessageIterator instance:
1038          *         owns a native bt_message_iterator object (iter)
1039          *             owns a _UserMessageIterator instance (py_iter)
1040          *                 self._ptr is a borrowed reference to the
1041          *                 native bt_private_connection_private_message_iterator
1042          *                 object (iter)
1043          */
1044         bt_self_message_iterator_set_data(self_message_iterator, py_iter);
1045         py_iter = NULL;
1046         goto end;
1047
1048 python_error:
1049         /* Handling of errors that cause a Python exception to be set. */
1050         status = py_exc_to_status_message_iterator(self_message_iterator);
1051         BT_ASSERT(status != __BT_FUNC_STATUS_OK);
1052         goto end;
1053
1054 error:
1055         /* Handling of errors that don't cause a Python exception to be set. */
1056         status = __BT_FUNC_STATUS_ERROR;
1057
1058 end:
1059         BT_ASSERT(!PyErr_Occurred());
1060
1061         Py_XDECREF(py_comp_cls);
1062         Py_XDECREF(py_iter_cls);
1063         Py_XDECREF(py_iter_ptr);
1064         Py_XDECREF(py_component_port_output_ptr);
1065         Py_XDECREF(py_init_method_result);
1066         Py_XDECREF(py_iter);
1067         return status;
1068 }
1069
1070 static
1071 bt_component_class_message_iterator_init_method_status
1072 component_class_source_message_iterator_init(
1073                 bt_self_message_iterator *self_message_iterator,
1074                 bt_self_component_source *self_component_source,
1075                 bt_self_component_port_output *self_component_port_output)
1076 {
1077         bt_self_component *self_component = bt_self_component_source_as_self_component(self_component_source);
1078
1079         return component_class_message_iterator_init(self_message_iterator, self_component, self_component_port_output);
1080 }
1081
1082 static
1083 bt_component_class_message_iterator_init_method_status
1084 component_class_filter_message_iterator_init(
1085                 bt_self_message_iterator *self_message_iterator,
1086                 bt_self_component_filter *self_component_filter,
1087                 bt_self_component_port_output *self_component_port_output)
1088 {
1089         bt_self_component *self_component = bt_self_component_filter_as_self_component(self_component_filter);
1090
1091         return component_class_message_iterator_init(self_message_iterator, self_component, self_component_port_output);
1092 }
1093
1094 static
1095 void component_class_message_iterator_finalize(
1096                 bt_self_message_iterator *message_iterator)
1097 {
1098         PyObject *py_message_iter = bt_self_message_iterator_get_data(
1099                 message_iterator);
1100         PyObject *py_method_result = NULL;
1101
1102         BT_ASSERT(py_message_iter);
1103
1104         /* Call user's _user_finalize() method */
1105         py_method_result = PyObject_CallMethod(py_message_iter,
1106                 "_user_finalize", NULL);
1107
1108         if (PyErr_Occurred()) {
1109                 bt_self_component *self_comp =
1110                         bt_self_message_iterator_borrow_component(
1111                                 message_iterator);
1112                 bt_logging_level log_level = get_self_component_log_level(
1113                         self_comp);
1114
1115                 BT_COMP_LOG_CUR_LVL(BT_LOG_WARNING, log_level, self_comp,
1116                         "User's _user_finalize() method raised an exception: ignoring:");
1117                 logw_exception(get_self_message_iterator_log_level(
1118                         message_iterator));
1119         }
1120
1121         /*
1122          * Ignore any exception raised by the _user_finalize() method
1123          * because it won't change anything at this point: the component
1124          * is being destroyed anyway.
1125          */
1126         PyErr_Clear();
1127         Py_XDECREF(py_method_result);
1128         Py_DECREF(py_message_iter);
1129 }
1130
1131 /* Valid for both sources and filters. */
1132
1133 static
1134 bt_component_class_message_iterator_next_method_status
1135 component_class_message_iterator_next(
1136                 bt_self_message_iterator *message_iterator,
1137                 bt_message_array_const msgs, uint64_t capacity,
1138                 uint64_t *count)
1139 {
1140         bt_component_class_message_iterator_next_method_status status = __BT_FUNC_STATUS_OK;
1141         PyObject *py_message_iter = bt_self_message_iterator_get_data(message_iterator);
1142         PyObject *py_method_result = NULL;
1143
1144         BT_ASSERT(py_message_iter);
1145         py_method_result = PyObject_CallMethod(py_message_iter,
1146                 "_bt_next_from_native", NULL);
1147         if (!py_method_result) {
1148                 status = py_exc_to_status_message_iterator(message_iterator);
1149                 BT_ASSERT(status != __BT_FUNC_STATUS_OK);
1150                 goto end;
1151         }
1152
1153         /*
1154          * The returned object, on success, is an integer object
1155          * (PyLong) containing the address of a native message
1156          * object (which is now ours).
1157          */
1158         msgs[0] = PyLong_AsVoidPtr(py_method_result);
1159         *count = 1;
1160
1161         /* Clear potential overflow error; should never happen */
1162         BT_ASSERT(!PyErr_Occurred());
1163         goto end;
1164
1165 end:
1166         Py_XDECREF(py_method_result);
1167         return status;
1168 }
1169
1170 static
1171 bt_component_class_sink_consume_method_status
1172 component_class_sink_consume(bt_self_component_sink *self_component_sink)
1173 {
1174         bt_self_component *self_component = bt_self_component_sink_as_self_component(self_component_sink);
1175         PyObject *py_comp = bt_self_component_get_data(self_component);
1176         PyObject *py_method_result = NULL;
1177         bt_component_class_sink_consume_method_status status;
1178
1179         BT_ASSERT(py_comp);
1180         py_method_result = PyObject_CallMethod(py_comp,
1181                 "_user_consume", NULL);
1182         status = py_exc_to_status_component(self_component);
1183         BT_ASSERT(py_method_result || status != __BT_FUNC_STATUS_OK);
1184         Py_XDECREF(py_method_result);
1185         return status;
1186 }
1187
1188 static
1189 int component_class_set_help_and_desc(
1190                 bt_component_class *component_class,
1191                 const char *description, const char *help)
1192 {
1193         int ret;
1194
1195         if (description) {
1196                 ret = bt_component_class_set_description(component_class, description);
1197                 if (ret) {
1198                         BT_LOGE("Cannot set component class's description: "
1199                                 "comp-cls-addr=%p", component_class);
1200                         goto end;
1201                 }
1202         }
1203
1204         if (help) {
1205                 ret = bt_component_class_set_help(component_class, help);
1206                 if (ret) {
1207                         BT_LOGE("Cannot set component class's help text: "
1208                                 "comp-cls-addr=%p", component_class);
1209                         goto end;
1210                 }
1211         }
1212
1213         ret = 0;
1214
1215 end:
1216         return ret;
1217 }
1218
1219 static
1220 bt_component_class_source *bt_bt2_component_class_source_create(
1221                 PyObject *py_cls, const char *name, const char *description,
1222                 const char *help)
1223 {
1224         bt_component_class_source *component_class_source;
1225         bt_component_class *component_class;
1226         int ret;
1227
1228         BT_ASSERT(py_cls);
1229         component_class_source = bt_component_class_source_create(name,
1230                 component_class_message_iterator_next);
1231         if (!component_class_source) {
1232                 BT_LOGE_STR("Cannot create source component class.");
1233                 goto end;
1234         }
1235
1236         component_class = bt_component_class_source_as_component_class(component_class_source);
1237
1238         if (component_class_set_help_and_desc(component_class, description, help)) {
1239                 goto end;
1240         }
1241
1242         ret = bt_component_class_source_set_init_method(component_class_source, component_class_source_init);
1243         BT_ASSERT(ret == 0);
1244         ret = bt_component_class_source_set_finalize_method(component_class_source, component_class_source_finalize);
1245         BT_ASSERT(ret == 0);
1246         ret = bt_component_class_source_set_message_iterator_can_seek_beginning_method(component_class_source,
1247                 component_class_can_seek_beginning);
1248         BT_ASSERT(ret == 0);
1249         ret = bt_component_class_source_set_message_iterator_seek_beginning_method(component_class_source,
1250                 component_class_seek_beginning);
1251         ret = bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method(
1252                 component_class_source, component_class_can_seek_ns_from_origin);
1253         BT_ASSERT(ret == 0);
1254         ret = bt_component_class_source_set_message_iterator_seek_ns_from_origin_method(
1255                 component_class_source, component_class_seek_ns_from_origin);
1256         BT_ASSERT(ret == 0);
1257         ret = bt_component_class_source_set_output_port_connected_method(component_class_source,
1258                 component_class_source_output_port_connected);
1259         BT_ASSERT(ret == 0);
1260         ret = bt_component_class_source_set_query_method(component_class_source, component_class_source_query);
1261         BT_ASSERT(ret == 0);
1262         ret = bt_component_class_source_set_get_supported_mip_versions_method(component_class_source, component_class_source_get_supported_mip_versions);
1263         BT_ASSERT(ret == 0);
1264         ret = bt_component_class_source_set_message_iterator_init_method(
1265                 component_class_source, component_class_source_message_iterator_init);
1266         BT_ASSERT(ret == 0);
1267         ret = bt_component_class_source_set_message_iterator_finalize_method(
1268                 component_class_source, component_class_message_iterator_finalize);
1269         BT_ASSERT(ret == 0);
1270         register_cc_ptr_to_py_cls(component_class, py_cls);
1271
1272 end:
1273         return component_class_source;
1274 }
1275
1276 static
1277 bt_component_class_filter *bt_bt2_component_class_filter_create(
1278                 PyObject *py_cls, const char *name, const char *description,
1279                 const char *help)
1280 {
1281         bt_component_class *component_class;
1282         bt_component_class_filter *component_class_filter;
1283         int ret;
1284
1285         BT_ASSERT(py_cls);
1286         component_class_filter = bt_component_class_filter_create(name,
1287                 component_class_message_iterator_next);
1288         if (!component_class_filter) {
1289                 BT_LOGE_STR("Cannot create filter component class.");
1290                 goto end;
1291         }
1292
1293         component_class = bt_component_class_filter_as_component_class(component_class_filter);
1294
1295         if (component_class_set_help_and_desc(component_class, description, help)) {
1296                 goto end;
1297         }
1298
1299         ret = bt_component_class_filter_set_init_method(component_class_filter, component_class_filter_init);
1300         BT_ASSERT(ret == 0);
1301         ret = bt_component_class_filter_set_finalize_method (component_class_filter, component_class_filter_finalize);
1302         BT_ASSERT(ret == 0);
1303         ret = bt_component_class_filter_set_message_iterator_can_seek_beginning_method(component_class_filter,
1304                 component_class_can_seek_beginning);
1305         BT_ASSERT(ret == 0);
1306         ret = bt_component_class_filter_set_message_iterator_seek_beginning_method(component_class_filter,
1307                 component_class_seek_beginning);
1308         BT_ASSERT(ret == 0);
1309         ret = bt_component_class_filter_set_message_iterator_can_seek_ns_from_origin_method(
1310                 component_class_filter, component_class_can_seek_ns_from_origin);
1311         BT_ASSERT(ret == 0);
1312         ret = bt_component_class_filter_set_message_iterator_seek_ns_from_origin_method(
1313                 component_class_filter, component_class_seek_ns_from_origin);
1314         ret = bt_component_class_filter_set_input_port_connected_method(component_class_filter,
1315                 component_class_filter_input_port_connected);
1316         BT_ASSERT(ret == 0);
1317         ret = bt_component_class_filter_set_output_port_connected_method(component_class_filter,
1318                 component_class_filter_output_port_connected);
1319         BT_ASSERT(ret == 0);
1320         ret = bt_component_class_filter_set_query_method(component_class_filter, component_class_filter_query);
1321         BT_ASSERT(ret == 0);
1322         ret = bt_component_class_filter_set_get_supported_mip_versions_method(component_class_filter, component_class_filter_get_supported_mip_versions);
1323         BT_ASSERT(ret == 0);
1324         ret = bt_component_class_filter_set_message_iterator_init_method(
1325                 component_class_filter, component_class_filter_message_iterator_init);
1326         BT_ASSERT(ret == 0);
1327         ret = bt_component_class_filter_set_message_iterator_finalize_method(
1328                 component_class_filter, component_class_message_iterator_finalize);
1329         BT_ASSERT(ret == 0);
1330         register_cc_ptr_to_py_cls(component_class, py_cls);
1331
1332 end:
1333         return component_class_filter;
1334 }
1335
1336 static
1337 bt_component_class_sink *bt_bt2_component_class_sink_create(
1338                 PyObject *py_cls, const char *name, const char *description,
1339                 const char *help)
1340 {
1341         bt_component_class_sink *component_class_sink;
1342         bt_component_class *component_class;
1343         int ret;
1344
1345         BT_ASSERT(py_cls);
1346         component_class_sink = bt_component_class_sink_create(name, component_class_sink_consume);
1347
1348         if (!component_class_sink) {
1349                 BT_LOGE_STR("Cannot create sink component class.");
1350                 goto end;
1351         }
1352
1353         component_class = bt_component_class_sink_as_component_class(component_class_sink);
1354
1355         if (component_class_set_help_and_desc(component_class, description, help)) {
1356                 goto end;
1357         }
1358
1359         ret = bt_component_class_sink_set_init_method(component_class_sink, component_class_sink_init);
1360         BT_ASSERT(ret == 0);
1361         ret = bt_component_class_sink_set_finalize_method(component_class_sink, component_class_sink_finalize);
1362         BT_ASSERT(ret == 0);
1363         ret = bt_component_class_sink_set_input_port_connected_method(component_class_sink,
1364                 component_class_sink_input_port_connected);
1365         BT_ASSERT(ret == 0);
1366         ret = bt_component_class_sink_set_graph_is_configured_method(component_class_sink,
1367                 component_class_sink_graph_is_configured);
1368         BT_ASSERT(ret == 0);
1369         ret = bt_component_class_sink_set_query_method(component_class_sink, component_class_sink_query);
1370         BT_ASSERT(ret == 0);
1371         ret = bt_component_class_sink_set_get_supported_mip_versions_method(component_class_sink, component_class_sink_get_supported_mip_versions);
1372         BT_ASSERT(ret == 0);
1373         register_cc_ptr_to_py_cls(component_class, py_cls);
1374
1375 end:
1376         return component_class_sink;
1377 }