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 ebc1991ebfe659301449994e85c4620808cbacc5..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"
 
@@ -68,16 +67,17 @@ void bt_query_executor_destroy(struct bt_object *obj)
        g_free(query_exec);
 }
 
-struct bt_query_executor *bt_query_executor_create(
+struct bt_query_executor *bt_query_executor_create_with_method_data(
                const bt_component_class *comp_cls, const char *object,
-               const bt_value *params)
+               const bt_value *params, void *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: "
-               "%![comp-cls-]+C, object=\"%s\", %![params-]%+v",
+               "%![comp-cls-]+C, object=\"%s\", %![params-]+v",
                comp_cls, object, params);
        query_exec = g_new0(struct bt_query_executor, 1);
        if (!query_exec) {
@@ -87,7 +87,7 @@ struct bt_query_executor *bt_query_executor_create(
        }
 
        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(
        }
 
        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,20 +118,30 @@ struct bt_query_executor *bt_query_executor_create(
                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,
                query_exec->default_interrupter);
        bt_object_init_shared(&query_exec->base,
                bt_query_executor_destroy);
        BT_LIB_LOGD("Created query executor: "
-               "addr=%p, %![comp-cls-]+C, object=\"%s\", %![params-]%+v",
+               "addr=%p, %![comp-cls-]+C, object=\"%s\", %![params-]+v",
                query_exec, comp_cls, object, params);
 
 end:
        return (void *) query_exec;
 }
 
+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);
+}
+
 enum bt_query_executor_query_status bt_query_executor_query(
                struct bt_query_executor *query_exec,
                const struct bt_value **user_result)
@@ -141,12 +151,14 @@ enum bt_query_executor_query_status bt_query_executor_query(
                void * /* private query executor */,
                const char * /* object */,
                const struct bt_value * /* parameters */,
+               void * /* method data */,
                const struct bt_value ** /* result */);
 
        enum bt_query_executor_query_status status;
        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)");
 
@@ -199,7 +211,7 @@ enum bt_query_executor_query_status bt_query_executor_query(
                break;
        }
        default:
-               abort();
+               bt_common_abort();
        }
 
        if (!method) {
@@ -219,11 +231,12 @@ enum bt_query_executor_query_status bt_query_executor_query(
        *user_result = NULL;
        query_status = method((void *) query_exec->comp_cls,
                (void *) query_exec, query_exec->object->str,
-               query_exec->params, user_result);
+               query_exec->params, query_exec->method_data, user_result);
        BT_LIB_LOGD("User method returned: status=%s, %![res-]+v",
                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) {
@@ -245,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);
@@ -262,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