src/lib/graph/query-executor.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22
  23 #define BT_LOG_TAG "LIB/QUERY-EXECUTOR"
  24 #include "lib/logging.h"
  25
  26 #include "common/assert.h"
  27 #include "common/common.h"
  28 #include "lib/assert-pre.h"
  29 #include "lib/assert-post.h"
  30 #include <babeltrace2/graph/query-executor-const.h>
  31 #include <babeltrace2/graph/query-executor.h>
  32 #include <babeltrace2/graph/component-class.h>
  33 #include <babeltrace2/value.h>
  34 #include <babeltrace2/value-const.h>
  35 #include "lib/object.h"
  36 #include "compat/compiler.h"
  37
  38 #include "component-class.h"
  39 #include "query-executor.h"
  40 #include "lib/func-status.h"
  41
  42 static
  43 void bt_query_executor_destroy(struct bt_object *obj)
  44 {
  45         struct bt_query_executor *query_exec =
  46                 container_of(obj, struct bt_query_executor, base);
  47
  48         BT_LOGD("Destroying query executor: addr=%p", query_exec);
  49         g_free(query_exec);
  50 }
  51
  52 struct bt_query_executor *bt_query_executor_create(void)
  53 {
  54         struct bt_query_executor *query_exec;
  55
  56         BT_LOGD_STR("Creating query executor.");
  57         query_exec = g_new0(struct bt_query_executor, 1);
  58         if (!query_exec) {
  59                 BT_LIB_LOGE_APPEND_CAUSE(
  60                         "Failed to allocate one query executor.");
  61                 goto end;
  62         }
  63
  64         bt_object_init_shared(&query_exec->base,
  65                 bt_query_executor_destroy);
  66         BT_LOGD("Created query executor: addr=%p", query_exec);
  67
  68 end:
  69         return (void *) query_exec;
  70 }
  71
  72 enum bt_query_executor_query_status bt_query_executor_query(
  73                 struct bt_query_executor *query_exec,
  74                 const struct bt_component_class *comp_cls,
  75                 const char *object, const struct bt_value *params,
  76                 enum bt_logging_level log_level,
  77                 const struct bt_value **user_result)
  78 {
  79         typedef enum bt_component_class_query_method_status (*method_t)(void *,
  80                 const void *, const void *, const void *, enum bt_logging_level,
  81                 const void *);
  82
  83         enum bt_query_executor_query_status status;
  84         enum bt_component_class_query_method_status query_status;
  85         method_t method = NULL;
  86
  87         BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
  88         BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class");
  89         BT_ASSERT_PRE_NON_NULL(object, "Object");
  90         BT_ASSERT_PRE_NON_NULL(user_result, "Result (output)");
  91         BT_ASSERT_PRE(!query_exec->canceled, "Query executor is canceled.");
  92
  93         if (!params) {
  94                 params = bt_value_null;
  95         }
  96
  97         switch (comp_cls->type) {
  98         case BT_COMPONENT_CLASS_TYPE_SOURCE:
  99         {
 100                 struct bt_component_class_source *src_cc = (void *) comp_cls;
 101
 102                 method = (method_t) src_cc->methods.query;
 103                 break;
 104         }
 105         case BT_COMPONENT_CLASS_TYPE_FILTER:
 106         {
 107                 struct bt_component_class_filter *flt_cc = (void *) comp_cls;
 108
 109                 method = (method_t) flt_cc->methods.query;
 110                 break;
 111         }
 112         case BT_COMPONENT_CLASS_TYPE_SINK:
 113         {
 114                 struct bt_component_class_sink *sink_cc = (void *) comp_cls;
 115
 116                 method = (method_t) sink_cc->methods.query;
 117                 break;
 118         }
 119         default:
 120                 abort();
 121         }
 122
 123         if (!method) {
 124                 /* Not an error: nothing to query */
 125                 BT_LIB_LOGD("Component class has no registered query method: "
 126                         "%!+C", comp_cls);
 127                 status = BT_FUNC_STATUS_INVALID_OBJECT;
 128                 goto end;
 129         }
 130
 131         BT_LIB_LOGD("Calling user's query method: "
 132                 "query-exec-addr=%p, %![cc-]+C, object=\"%s\", %![params-]+v, "
 133                 "log-level=%s",
 134                 query_exec, comp_cls, object, params,
 135                 bt_common_logging_level_string(log_level));
 136         *user_result = NULL;
 137         query_status = method((void *) comp_cls, query_exec, object, params,
 138                 log_level, user_result);
 139         BT_LIB_LOGD("User method returned: status=%s, %![res-]+v",
 140                 bt_common_func_status_string(query_status), *user_result);
 141         BT_ASSERT_POST(query_status != BT_FUNC_STATUS_OK || *user_result,
 142                 "User method returned `BT_FUNC_STATUS_OK` without a result.");
 143         status = (int) query_status;
 144         if (query_exec->canceled) {
 145                 BT_OBJECT_PUT_REF_AND_RESET(*user_result);
 146                 status = BT_FUNC_STATUS_CANCELED;
 147                 goto end;
 148         }
 149
 150 end:
 151         return status;
 152 }
 153
 154 enum bt_query_executor_cancel_status bt_query_executor_cancel(
 155                 struct bt_query_executor *query_exec)
 156 {
 157         BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor");
 158         query_exec->canceled = BT_TRUE;
 159         BT_LOGI("Canceled query executor: addr=%p", query_exec);
 160         return BT_FUNC_STATUS_OK;
 161 }
 162
 163 bt_bool bt_query_executor_is_canceled(const struct bt_query_executor *query_exec)
 164 {
 165         BT_ASSERT_PRE_DEV_NON_NULL(query_exec, "Query executor");
 166         return query_exec->canceled;
 167 }
 168
 169 void bt_query_executor_get_ref(const struct bt_query_executor *query_executor)
 170 {
 171         bt_object_get_ref(query_executor);
 172 }
 173
 174 void bt_query_executor_put_ref(const struct bt_query_executor *query_executor)
 175 {
 176         bt_object_put_ref(query_executor);
 177 }