/*
- * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
+ * Copyright 2017
-2018 Philippe Proulx <pproulx@efficios.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
*/
#define BT_LOG_TAG "QUERY-EXECUTOR"
-#include <babeltrace/lib-logging-internal.h>
-
-#include <babeltrace/graph/query-executor.h>
-#include <babeltrace/graph/query-executor-internal.h>
-#include <babeltrace/graph/component-class.h>
-#include <babeltrace/graph/component-class-internal.h>
-#include <babeltrace/values.h>
-#include <babeltrace/object-internal.h>
-#include <babeltrace/compiler-internal.h>
+#include <babeltrace2/lib-logging-internal.h>
+
+#include <babeltrace2/assert-internal.h>
+#include <babeltrace2/assert-pre-internal.h>
+#include <babeltrace2/graph/query-executor-const.h>
+#include <babeltrace2/graph/query-executor.h>
+#include <babeltrace2/graph/query-executor-internal.h>
+#include <babeltrace2/graph/component-class.h>
+#include <babeltrace2/graph/component-class-internal.h>
+#include <babeltrace2/value.h>
+#include <babeltrace2/value-const.h>
+#include <babeltrace2/object-internal.h>
+#include <babeltrace2/compiler-internal.h>
static
void bt_query_executor_destroy(struct bt_object *obj)
struct bt_query_executor *query_exec =
container_of(obj, struct bt_query_executor, base);
- BT_LOGD("Destroying port: addr=%p", query_exec);
+ BT_LOGD("Destroying query executor: addr=%p", query_exec);
g_free(query_exec);
}
BT_LOGD("Created query executor: addr=%p", query_exec);
end:
- return query_exec;
+ return (void *) query_exec;
}
-enum bt_query_status bt_query_executor_query(
+enum bt_query_executor_status bt_query_executor_query(
struct bt_query_executor *query_exec,
- struct bt_component_class *component_class,
- const char *object, struct bt_value *params,
- struct bt_value **user_result)
+ const struct bt_component_class *comp_cls,
+ const char *object, const struct bt_value *params,
+ const struct bt_value **user_result)
{
- struct bt_component_class_query_method_return ret = {
- .result = NULL,
- .status = BT_QUERY_STATUS_OK,
- };
+ typedef enum bt_query_status (*method_t)(void *, const void *,
+ const void *, const void *, const void *);
- if (!query_exec) {
- BT_LOGW_STR("Invalid parameter: query executor is NULL.");
- ret.status = BT_QUERY_STATUS_INVALID;
- goto end;
- }
+ enum bt_query_status status;
+ enum bt_query_executor_status exec_status;
+ method_t method = NULL;
- if (query_exec->canceled) {
- BT_LOGW_STR("Invalid parameter: query executor is canceled.");
- ret.status = BT_QUERY_STATUS_EXECUTOR_CANCELED;
- goto end;
+ 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.");
+
+ if (!params) {
+ params = bt_value_null;
}
- if (!component_class) {
- BT_LOGW_STR("Invalid parameter: component class is NULL.");
- ret.status = BT_QUERY_STATUS_INVALID;
- goto end;
+ switch (comp_cls->type) {
+ case BT_COMPONENT_CLASS_TYPE_SOURCE:
+ {
+ struct bt_component_class_source *src_cc = (void *) comp_cls;
+
+ method = (method_t) src_cc->methods.query;
+ break;
}
+ case BT_COMPONENT_CLASS_TYPE_FILTER:
+ {
+ struct bt_component_class_filter *flt_cc = (void *) comp_cls;
- if (!object) {
- BT_LOGW_STR("Invalid parameter: object string is NULL.");
- ret.status = BT_QUERY_STATUS_INVALID;
- goto end;
+ method = (method_t) flt_cc->methods.query;
+ break;
}
+ case BT_COMPONENT_CLASS_TYPE_SINK:
+ {
+ struct bt_component_class_sink *sink_cc = (void *) comp_cls;
- if (!params) {
- params = bt_value_null;
+ method = (method_t) sink_cc->methods.query;
+ break;
+ }
+ default:
+ abort();
}
- if (!component_class->methods.query) {
+ if (!method) {
/* Not an error: nothing to query */
- BT_LOGD("Component class has no registered query method: "
- "addr=%p, name=\"%s\", type=%s",
- component_class,
- bt_component_class_get_name(component_class),
- bt_component_class_type_string(component_class->type));
- ret.status = BT_QUERY_STATUS_ERROR;
+ BT_LIB_LOGD("Component class has no registered query method: "
+ "%!+C", comp_cls);
+ exec_status = BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED;
goto end;
}
- BT_LOGD("Calling user's query method: "
- "query-exec-addr=%p, comp-class-addr=%p, "
- "comp-class-name=\"%s\", comp-class-type=%s, "
- "object=\"%s\", params-addr=%p",
- query_exec, component_class,
- bt_component_class_get_name(component_class),
- bt_component_class_type_string(component_class->type),
- object, params);
- ret = component_class->methods.query(component_class, query_exec,
- object, params);
- BT_LOGD("User method returned: status=%s, result-addr=%p",
- bt_query_status_string(ret.status), ret.result);
+ BT_LIB_LOGD("Calling user's query method: "
+ "query-exec-addr=%p, %![cc-]+C, object=\"%s\", %![params-]+v",
+ query_exec, comp_cls, object, params);
+ *user_result = NULL;
+ status = method((void *) comp_cls, query_exec, object, params,
+ 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_PUT(ret.result);
- ret.status = BT_QUERY_STATUS_EXECUTOR_CANCELED;
+ BT_OBJECT_PUT_REF_AND_RESET(*user_result);
+ exec_status = BT_QUERY_EXECUTOR_STATUS_CANCELED;
goto end;
- } else {
- if (ret.status == BT_QUERY_STATUS_EXECUTOR_CANCELED) {
- /*
- * The user cannot decide that the executor is
- * canceled if it's not.
- */
- BT_PUT(ret.result);
- ret.status = BT_QUERY_STATUS_ERROR;
- goto end;
- }
- }
-
- switch (ret.status) {
- case BT_QUERY_STATUS_INVALID:
- /*
- * This is reserved for invalid parameters passed to
- * this function.
- */
- BT_PUT(ret.result);
- ret.status = BT_QUERY_STATUS_ERROR;
- break;
- case BT_QUERY_STATUS_OK:
- if (!ret.result) {
- ret.result = bt_value_null;
- }
- break;
- default:
- if (ret.result) {
- BT_LOGW("User method did not return BT_QUERY_STATUS_OK, but result is not NULL: "
- "status=%s, result-addr=%p",
- bt_query_status_string(ret.status), ret.result);
- BT_PUT(ret.result);
- }
}
end:
- if (user_result) {
- *user_result = ret.result;
- ret.result = NULL;
- }
-
- bt_put(ret.result);
- return ret.status;
+ return exec_status;
}
-enum bt_query_status bt_query_executor_cancel(
+enum bt_query_executor_status bt_query_executor_cancel(
struct bt_query_executor *query_exec)
{
- enum bt_query_status ret = BT_QUERY_STATUS_OK;
-
- if (!query_exec) {
- BT_LOGW_STR("Invalid parameter: query executor is NULL.");
- ret = BT_QUERY_STATUS_INVALID;
- goto end;
- }
-
+ BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
query_exec->canceled = BT_TRUE;
BT_LOGV("Canceled query executor: addr=%p", query_exec);
-
-end:
- return ret;
+ return BT_QUERY_EXECUTOR_STATUS_OK;
}
-bt_bool bt_query_executor_is_canceled(struct bt_query_executor *query_exec)
+bt_bool bt_query_executor_is_canceled(const struct bt_query_executor *query_exec)
{
- bt_bool canceled = BT_FALSE;
-
- if (!query_exec) {
- BT_LOGW_STR("Invalid parameter: query executor is NULL.");
- goto end;
- }
+ BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
+ return query_exec->canceled;
+}
- canceled = query_exec->canceled;
+void bt_query_executor_get_ref(const struct bt_query_executor *query_executor)
+{
+ bt_object_get_ref(query_executor);
+}
-end:
- return canceled;
+void bt_query_executor_put_ref(const struct bt_query_executor *query_executor)
+{
+ bt_object_put_ref(query_executor);
}
projects / babeltrace.git / blobdiff