* SOFTWARE.
*/
-#define BT_LOG_TAG "QUERY-EXECUTOR"
-#include "lib/lib-logging.h"
+#define BT_LOG_TAG "LIB/QUERY-EXECUTOR"
+#include "lib/logging.h"
#include "common/assert.h"
+#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 "component-class.h"
#include "query-executor.h"
+#include "interrupter.h"
+#include "lib/func-status.h"
static
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);
}
BT_LOGD_STR("Creating query executor.");
query_exec = g_new0(struct bt_query_executor, 1);
if (!query_exec) {
- BT_LOGE_STR("Failed to allocate one query executor.");
+ BT_LIB_LOGE_APPEND_CAUSE(
+ "Failed to allocate one query executor.");
+ 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);
return (void *) query_exec;
}
-enum bt_query_executor_status bt_query_executor_query(
+enum bt_query_executor_query_status bt_query_executor_query(
struct bt_query_executor *query_exec,
const struct bt_component_class *comp_cls,
const char *object, const struct bt_value *params,
+ enum bt_logging_level log_level,
const struct bt_value **user_result)
{
- typedef enum bt_query_status (*method_t)(void *, const void *,
- const void *, const void *, const void *);
+ typedef enum bt_component_class_query_method_status (*method_t)(void *,
+ const void *, const void *, const void *, enum bt_logging_level,
+ const void *);
- enum bt_query_status status;
- enum bt_query_executor_status exec_status;
+ enum bt_query_executor_query_status status;
+ enum bt_component_class_query_method_status query_status;
method_t method = NULL;
BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
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;
/* Not an error: nothing to query */
BT_LIB_LOGD("Component class has no registered query method: "
"%!+C", comp_cls);
- exec_status = BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED;
+ status = BT_FUNC_STATUS_INVALID_OBJECT;
goto end;
}
BT_LIB_LOGD("Calling user's query method: "
- "query-exec-addr=%p, %![cc-]+C, object=\"%s\", %![params-]+v",
- query_exec, comp_cls, object, params);
+ "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));
*user_result = NULL;
- status = method((void *) comp_cls, query_exec, object, params,
- user_result);
+ query_status = method((void *) comp_cls, query_exec, object, params,
+ log_level, user_result);
BT_LIB_LOGD("User method returned: status=%s, %![res-]+v",
- bt_query_status_string(status), *user_result);
- BT_ASSERT_PRE(status != BT_QUERY_STATUS_OK || *user_result,
- "User method returned `BT_QUERY_STATUS_OK` without a result.");
- exec_status = (int) status;
- if (query_exec->canceled) {
- BT_OBJECT_PUT_REF_AND_RESET(*user_result);
- exec_status = BT_QUERY_EXECUTOR_STATUS_CANCELED;
- goto end;
- }
+ 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.");
+ status = (int) query_status;
end:
- return exec_status;
+ return status;
+}
+
+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");
+ 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;
}
-enum bt_query_executor_status bt_query_executor_cancel(
- struct bt_query_executor *query_exec)
+bt_bool bt_query_executor_is_interrupted(const struct bt_query_executor *query_exec)
{
BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
- query_exec->canceled = BT_TRUE;
- BT_LOGI("Canceled query executor: addr=%p", query_exec);
- return BT_QUERY_EXECUTOR_STATUS_OK;
+ return (bt_bool) bt_interrupter_array_any_is_set(
+ query_exec->interrupters);
}
-bt_bool bt_query_executor_is_canceled(const struct bt_query_executor *query_exec)
+void bt_query_executor_interrupt(struct bt_query_executor *query_exec)
{
BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
- return query_exec->canceled;
+ 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)