Commit | Line | Data |
---|---|---|
c7eee084 | 1 | /* |
e2f7325d | 2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
c7eee084 PP |
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 | ||
350ad6c1 | 23 | #define BT_LOG_TAG "LIB/QUERY-EXECUTOR" |
c2d9d9cf | 24 | #include "lib/logging.h" |
c7eee084 | 25 | |
578e048b | 26 | #include "common/assert.h" |
f4e38e70 | 27 | #include "common/common.h" |
578e048b | 28 | #include "lib/assert-pre.h" |
f6f301d7 | 29 | #include "lib/assert-post.h" |
3fadfbc0 MJ |
30 | #include <babeltrace2/graph/query-executor-const.h> |
31 | #include <babeltrace2/graph/query-executor.h> | |
3fadfbc0 | 32 | #include <babeltrace2/graph/component-class.h> |
3fadfbc0 MJ |
33 | #include <babeltrace2/value.h> |
34 | #include <babeltrace2/value-const.h> | |
578e048b MJ |
35 | #include "lib/object.h" |
36 | #include "compat/compiler.h" | |
37 | ||
38 | #include "component-class.h" | |
39 | #include "query-executor.h" | |
c7eee084 PP |
40 | |
41 | static | |
42 | void bt_query_executor_destroy(struct bt_object *obj) | |
43 | { | |
44 | struct bt_query_executor *query_exec = | |
45 | container_of(obj, struct bt_query_executor, base); | |
46 | ||
d94d92ac | 47 | BT_LOGD("Destroying query executor: addr=%p", query_exec); |
c7eee084 PP |
48 | g_free(query_exec); |
49 | } | |
50 | ||
0d72b8c3 | 51 | struct bt_query_executor *bt_query_executor_create(void) |
c7eee084 PP |
52 | { |
53 | struct bt_query_executor *query_exec; | |
54 | ||
55 | BT_LOGD_STR("Creating query executor."); | |
56 | query_exec = g_new0(struct bt_query_executor, 1); | |
57 | if (!query_exec) { | |
58 | BT_LOGE_STR("Failed to allocate one query executor."); | |
59 | goto end; | |
60 | } | |
61 | ||
3fea54f6 PP |
62 | bt_object_init_shared(&query_exec->base, |
63 | bt_query_executor_destroy); | |
c7eee084 PP |
64 | BT_LOGD("Created query executor: addr=%p", query_exec); |
65 | ||
66 | end: | |
d94d92ac | 67 | return (void *) query_exec; |
c7eee084 PP |
68 | } |
69 | ||
0d72b8c3 PP |
70 | enum bt_query_executor_status bt_query_executor_query( |
71 | struct bt_query_executor *query_exec, | |
72 | const struct bt_component_class *comp_cls, | |
05e21286 | 73 | const char *object, const struct bt_value *params, |
f4e38e70 | 74 | bt_logging_level log_level, |
05e21286 | 75 | const struct bt_value **user_result) |
c7eee084 | 76 | { |
0d72b8c3 | 77 | typedef enum bt_query_status (*method_t)(void *, const void *, |
f4e38e70 | 78 | const void *, const void *, bt_logging_level, const void *); |
c7eee084 | 79 | |
d94d92ac | 80 | enum bt_query_status status; |
d72535e6 | 81 | enum bt_query_executor_status exec_status; |
d94d92ac | 82 | method_t method = NULL; |
c7eee084 | 83 | |
d94d92ac PP |
84 | BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor"); |
85 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
86 | BT_ASSERT_PRE_NON_NULL(object, "Object"); | |
87 | BT_ASSERT_PRE_NON_NULL(user_result, "Result (output)"); | |
88 | BT_ASSERT_PRE(!query_exec->canceled, "Query executor is canceled."); | |
89 | ||
90 | if (!params) { | |
91 | params = bt_value_null; | |
c7eee084 PP |
92 | } |
93 | ||
d94d92ac PP |
94 | switch (comp_cls->type) { |
95 | case BT_COMPONENT_CLASS_TYPE_SOURCE: | |
96 | { | |
97 | struct bt_component_class_source *src_cc = (void *) comp_cls; | |
98 | ||
99 | method = (method_t) src_cc->methods.query; | |
100 | break; | |
c7eee084 | 101 | } |
d94d92ac PP |
102 | case BT_COMPONENT_CLASS_TYPE_FILTER: |
103 | { | |
104 | struct bt_component_class_filter *flt_cc = (void *) comp_cls; | |
c7eee084 | 105 | |
d94d92ac PP |
106 | method = (method_t) flt_cc->methods.query; |
107 | break; | |
c7eee084 | 108 | } |
d94d92ac PP |
109 | case BT_COMPONENT_CLASS_TYPE_SINK: |
110 | { | |
111 | struct bt_component_class_sink *sink_cc = (void *) comp_cls; | |
c7eee084 | 112 | |
d94d92ac PP |
113 | method = (method_t) sink_cc->methods.query; |
114 | break; | |
115 | } | |
116 | default: | |
117 | abort(); | |
c7eee084 PP |
118 | } |
119 | ||
d94d92ac | 120 | if (!method) { |
c7eee084 | 121 | /* Not an error: nothing to query */ |
d94d92ac PP |
122 | BT_LIB_LOGD("Component class has no registered query method: " |
123 | "%!+C", comp_cls); | |
d72535e6 | 124 | exec_status = BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED; |
c7eee084 PP |
125 | goto end; |
126 | } | |
127 | ||
d94d92ac | 128 | BT_LIB_LOGD("Calling user's query method: " |
f4e38e70 PP |
129 | "query-exec-addr=%p, %![cc-]+C, object=\"%s\", %![params-]+v, " |
130 | "log-level=%s", | |
131 | query_exec, comp_cls, object, params, | |
132 | bt_common_logging_level_string(log_level)); | |
d94d92ac | 133 | *user_result = NULL; |
0d72b8c3 | 134 | status = method((void *) comp_cls, query_exec, object, params, |
f4e38e70 | 135 | log_level, user_result); |
d94d92ac PP |
136 | BT_LIB_LOGD("User method returned: status=%s, %![res-]+v", |
137 | bt_query_status_string(status), *user_result); | |
f6f301d7 | 138 | BT_ASSERT_POST(status != BT_QUERY_STATUS_OK || *user_result, |
d94d92ac | 139 | "User method returned `BT_QUERY_STATUS_OK` without a result."); |
d72535e6 | 140 | exec_status = (int) status; |
c7eee084 | 141 | if (query_exec->canceled) { |
d94d92ac | 142 | BT_OBJECT_PUT_REF_AND_RESET(*user_result); |
cb9547ee | 143 | exec_status = BT_QUERY_EXECUTOR_STATUS_CANCELED; |
c7eee084 | 144 | goto end; |
c7eee084 PP |
145 | } |
146 | ||
147 | end: | |
d72535e6 | 148 | return exec_status; |
c7eee084 PP |
149 | } |
150 | ||
0d72b8c3 PP |
151 | enum bt_query_executor_status bt_query_executor_cancel( |
152 | struct bt_query_executor *query_exec) | |
c7eee084 | 153 | { |
d94d92ac | 154 | BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor"); |
c7eee084 | 155 | query_exec->canceled = BT_TRUE; |
3f7d4d90 | 156 | BT_LOGI("Canceled query executor: addr=%p", query_exec); |
d72535e6 | 157 | return BT_QUERY_EXECUTOR_STATUS_OK; |
c7eee084 PP |
158 | } |
159 | ||
0d72b8c3 | 160 | bt_bool bt_query_executor_is_canceled(const struct bt_query_executor *query_exec) |
c7eee084 | 161 | { |
d94d92ac PP |
162 | BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor"); |
163 | return query_exec->canceled; | |
c7eee084 | 164 | } |
c5b9b441 PP |
165 | |
166 | void bt_query_executor_get_ref(const struct bt_query_executor *query_executor) | |
167 | { | |
168 | bt_object_get_ref(query_executor); | |
169 | } | |
170 | ||
171 | void bt_query_executor_put_ref(const struct bt_query_executor *query_executor) | |
172 | { | |
173 | bt_object_put_ref(query_executor); | |
174 | } |