lib: remove INVALID_PARAMS status

[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 3a00c9b80985abe0af2e4cf2a4f6a96a3d3b0d54..ce6dd6d9a3dbf2cbb4b5b5a7cc005fe4f65564ce 100644 (file)
--- a/src/lib/graph/query-executor.c
+++ b/src/lib/graph/query-executor.c
@@ -37,6 +37,7 @@
 
 #include "component-class.h"
 #include "query-executor.h"
+#include "interrupter.h"
 #include "lib/func-status.h"
 
 static
@@ -46,6 +47,15 @@ void bt_query_executor_destroy(struct bt_object *obj)
                container_of(obj, struct bt_query_executor, base);
 
        BT_LOGD("Destroying query executor: addr=%p", query_exec);
+
+       if (query_exec->interrupters) {
+               BT_LOGD_STR("Putting interrupters.");
+               g_ptr_array_free(query_exec->interrupters, TRUE);
+               query_exec->interrupters = NULL;
+       }
+
+       BT_OBJECT_PUT_REF_AND_RESET(query_exec->default_interrupter);
+
        g_free(query_exec);
 }
 
@@ -61,6 +71,24 @@ struct bt_query_executor *bt_query_executor_create(void)
                goto end;
        }
 
+       query_exec->interrupters = g_ptr_array_new_with_free_func(
+               (GDestroyNotify) bt_object_put_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);
+               goto end;
+       }
+
+       query_exec->default_interrupter = bt_interrupter_create();
+       if (!query_exec->default_interrupter) {
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to create one interrupter object.");
+               BT_OBJECT_PUT_REF_AND_RESET(query_exec);
+               goto end;
+       }
+
+       bt_query_executor_add_interrupter(query_exec,
+               query_exec->default_interrupter);
        bt_object_init_shared(&query_exec->base,
                bt_query_executor_destroy);
        BT_LOGD("Created query executor: addr=%p", query_exec);
@@ -88,7 +116,28 @@ enum bt_query_executor_query_status bt_query_executor_query(
        BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class");
        BT_ASSERT_PRE_NON_NULL(object, "Object");
        BT_ASSERT_PRE_NON_NULL(user_result, "Result (output)");
-       BT_ASSERT_PRE(!query_exec->canceled, "Query executor is canceled.");
+
+       /*
+        * Initial check: is the query executor already interrupted? If
+        * so, return `BT_FUNC_STATUS_AGAIN`. Returning this status is
+        * harmless: it's not `BT_FUNC_STATUS_OK` (there's no result),
+        * and it's not `BT_FUNC_STATUS_ERROR` either (there's no
+        * legitimate error). Since any query operation could return
+        * `BT_FUNC_STATUS_AGAIN` when interrupted or instead of
+        * blocking, the caller is responsible for checking the
+        * interruption state of the query executor when getting this
+        * status.
+        */
+       if (bt_query_executor_is_interrupted(query_exec)) {
+               BT_LIB_LOGD("Query executor is interrupted: "
+                       "not performing the query operation: "
+                       "query-exec-addr=%p, %![cc-]+C, object=\"%s\", "
+                       "%![params-]+v, log-level=%s",
+                       query_exec, comp_cls, object, params,
+                       bt_common_logging_level_string(log_level));
+               status = BT_FUNC_STATUS_AGAIN;
+               goto end;
+       }
 
        if (!params) {
                params = bt_value_null;
@@ -141,9 +190,13 @@ enum bt_query_executor_query_status bt_query_executor_query(
        BT_ASSERT_POST(query_status != BT_FUNC_STATUS_OK || *user_result,
                "User method returned `BT_FUNC_STATUS_OK` without a result.");
        status = (int) query_status;
-       if (query_exec->canceled) {
-               BT_OBJECT_PUT_REF_AND_RESET(*user_result);
-               status = BT_FUNC_STATUS_CANCELED;
+
+       if (status < 0) {
+               BT_LIB_LOGW_APPEND_CAUSE(
+                       "Component class's \"query\" method failed: "
+                       "query-exec-addr=%p, %![cc-]+C, object=\"%s\", "
+                       "%![params-]+v, log-level=%s", query_exec, comp_cls,
+                       object, params, bt_common_logging_level_string(log_level));
                goto end;
        }
 
@@ -151,19 +204,33 @@ end:
        return status;
 }
 
-enum bt_query_executor_cancel_status bt_query_executor_cancel(
-               struct bt_query_executor *query_exec)
+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_NON_NULL(query_exec, "Query executor");
-       query_exec->canceled = BT_TRUE;
-       BT_LOGI("Canceled query executor: addr=%p", query_exec);
+       BT_ASSERT_PRE_NON_NULL(intr, "Interrupter");
+       g_ptr_array_add(query_exec->interrupters, (void *) intr);
+       bt_object_get_no_null_check(intr);
+       BT_LIB_LOGD("Added interrupter to query executor: "
+               "query-exec-addr=%p, %![intr-]+z",
+               query_exec, intr);
        return BT_FUNC_STATUS_OK;
 }
 
-bt_bool bt_query_executor_is_canceled(const struct bt_query_executor *query_exec)
+bt_bool bt_query_executor_is_interrupted(const struct bt_query_executor *query_exec)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(query_exec, "Query executor");
-       return query_exec->canceled;
+       BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
+       return (bt_bool) bt_interrupter_array_any_is_set(
+               query_exec->interrupters);
+}
+
+void bt_query_executor_interrupt(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);
 }
 
 void bt_query_executor_get_ref(const struct bt_query_executor *query_executor)