Document libbabeltrace2's C API

[babeltrace.git] / src / lib / graph / query-executor.c

diff --git a/src/lib/graph/query-executor.c b/src/lib/graph/query-executor.c
index efd6b51f6fefec49e64e26340e855cf41233605f..e922d3ea1bd3c52c5c38e4d9b31605e9f05d3c9f 100644 (file)
--- a/src/lib/graph/query-executor.c
+++ b/src/lib/graph/query-executor.c
@@ -27,11 +27,10 @@
 #include "common/common.h"
 #include "lib/assert-pre.h"
 #include "lib/assert-post.h"
-#include <babeltrace2/graph/query-executor-const.h>
 #include <babeltrace2/graph/query-executor.h>
 #include <babeltrace2/graph/component-class.h>
+#include <babeltrace2/graph/query-executor.h>
 #include <babeltrace2/value.h>
-#include <babeltrace2/value-const.h>
 #include "lib/object.h"
 #include "compat/compiler.h"
 
@@ -74,6 +73,7 @@ struct bt_query_executor *bt_query_executor_create_with_method_data(
 {
        struct bt_query_executor *query_exec;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class");
        BT_ASSERT_PRE_NON_NULL(object, "Object");
        BT_LIB_LOGD("Creating query executor: "
@@ -87,7 +87,7 @@ struct bt_query_executor *bt_query_executor_create_with_method_data(
        }
 
        query_exec->interrupters = g_ptr_array_new_with_free_func(
-               (GDestroyNotify) bt_object_put_no_null_check);
+               (GDestroyNotify) bt_object_put_ref_no_null_check);
        if (!query_exec->interrupters) {
                BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
                BT_OBJECT_PUT_REF_AND_RESET(query_exec);
@@ -110,7 +110,7 @@ struct bt_query_executor *bt_query_executor_create_with_method_data(
        }
 
        query_exec->comp_cls = comp_cls;
-       bt_object_get_no_null_check(query_exec->comp_cls);
+       bt_object_get_ref_no_null_check(query_exec->comp_cls);
 
        if (!params) {
                query_exec->params = bt_value_null;
@@ -118,7 +118,7 @@ struct bt_query_executor *bt_query_executor_create_with_method_data(
                query_exec->params = params;
        }
 
-       bt_object_get_no_null_check(query_exec->params);
+       bt_object_get_ref_no_null_check(query_exec->params);
        query_exec->method_data = method_data;
        query_exec->log_level = BT_LOGGING_LEVEL_NONE;
        bt_query_executor_add_interrupter(query_exec,
@@ -137,6 +137,7 @@ struct bt_query_executor *bt_query_executor_create(
                const bt_component_class *comp_cls, const char *object,
                const bt_value *params)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        return bt_query_executor_create_with_method_data(comp_cls,
                object, params, NULL);
 }
@@ -157,6 +158,7 @@ enum bt_query_executor_query_status bt_query_executor_query(
        enum bt_component_class_query_method_status query_status;
        method_t method = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
        BT_ASSERT_PRE_NON_NULL(user_result, "Result (output)");
 
@@ -209,7 +211,7 @@ enum bt_query_executor_query_status bt_query_executor_query(
                break;
        }
        default:
-               abort();
+               bt_common_abort();
        }
 
        if (!method) {
@@ -234,6 +236,7 @@ enum bt_query_executor_query_status bt_query_executor_query(
                bt_common_func_status_string(query_status), *user_result);
        BT_ASSERT_POST(query_status != BT_FUNC_STATUS_OK || *user_result,
                "User method returned `BT_FUNC_STATUS_OK` without a result.");
+       BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(query_status);
        status = (int) query_status;
 
        if (status < 0) {
@@ -255,10 +258,11 @@ enum bt_query_executor_add_interrupter_status bt_query_executor_add_interrupter(
                struct bt_query_executor *query_exec,
                const struct bt_interrupter *intr)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
        BT_ASSERT_PRE_NON_NULL(intr, "Interrupter");
        g_ptr_array_add(query_exec->interrupters, (void *) intr);
-       bt_object_get_no_null_check(intr);
+       bt_object_get_ref_no_null_check(intr);
        BT_LIB_LOGD("Added interrupter to query executor: "
                "query-exec-addr=%p, %![intr-]+z",
                query_exec, intr);
@@ -272,12 +276,11 @@ bt_bool bt_query_executor_is_interrupted(const struct bt_query_executor *query_e
                query_exec->interrupters);
 }
 
-void bt_query_executor_interrupt(struct bt_query_executor *query_exec)
+struct bt_interrupter *bt_query_executor_borrow_default_interrupter(
+               struct bt_query_executor *query_exec)
 {
        BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
-       bt_interrupter_set(query_exec->default_interrupter);
-       BT_LIB_LOGI("Interrupted query executor: query-exec-addr=%p",
-               query_exec);
+       return query_exec->default_interrupter;
 }
 
 enum bt_query_executor_set_logging_level_status