Commit | Line | Data |
---|---|---|
c7eee084 | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
c7eee084 | 3 | * |
0235b0db | 4 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
c7eee084 PP |
5 | */ |
6 | ||
350ad6c1 | 7 | #define BT_LOG_TAG "LIB/QUERY-EXECUTOR" |
c2d9d9cf | 8 | #include "lib/logging.h" |
c7eee084 | 9 | |
578e048b | 10 | #include "common/assert.h" |
f4e38e70 | 11 | #include "common/common.h" |
d98421f2 | 12 | #include "lib/assert-cond.h" |
3fadfbc0 | 13 | #include <babeltrace2/graph/query-executor.h> |
3fadfbc0 | 14 | #include <babeltrace2/graph/component-class.h> |
43c59509 | 15 | #include <babeltrace2/graph/query-executor.h> |
3fadfbc0 | 16 | #include <babeltrace2/value.h> |
578e048b MJ |
17 | #include "lib/object.h" |
18 | #include "compat/compiler.h" | |
19 | ||
20 | #include "component-class.h" | |
21 | #include "query-executor.h" | |
9b4f9b42 | 22 | #include "interrupter.h" |
d24d5663 | 23 | #include "lib/func-status.h" |
c7eee084 PP |
24 | |
25 | static | |
26 | void bt_query_executor_destroy(struct bt_object *obj) | |
27 | { | |
28 | struct bt_query_executor *query_exec = | |
29 | container_of(obj, struct bt_query_executor, base); | |
30 | ||
d94d92ac | 31 | BT_LOGD("Destroying query executor: addr=%p", query_exec); |
9b4f9b42 PP |
32 | |
33 | if (query_exec->interrupters) { | |
34 | BT_LOGD_STR("Putting interrupters."); | |
35 | g_ptr_array_free(query_exec->interrupters, TRUE); | |
36 | query_exec->interrupters = NULL; | |
37 | } | |
38 | ||
3c729b9a PP |
39 | BT_LOGD_STR("Putting component class."); |
40 | BT_OBJECT_PUT_REF_AND_RESET(query_exec->comp_cls); | |
41 | ||
42 | if (query_exec->object) { | |
43 | g_string_free(query_exec->object, TRUE); | |
44 | query_exec->object = NULL; | |
45 | } | |
9b4f9b42 | 46 | |
3c729b9a PP |
47 | BT_LOGD_STR("Putting parameters."); |
48 | BT_OBJECT_PUT_REF_AND_RESET(query_exec->params); | |
49 | BT_OBJECT_PUT_REF_AND_RESET(query_exec->default_interrupter); | |
c7eee084 PP |
50 | g_free(query_exec); |
51 | } | |
52 | ||
1353b066 | 53 | BT_EXPORT |
7c14d641 | 54 | struct bt_query_executor *bt_query_executor_create_with_method_data( |
3c729b9a | 55 | const bt_component_class *comp_cls, const char *object, |
7c14d641 | 56 | const bt_value *params, void *method_data) |
c7eee084 PP |
57 | { |
58 | struct bt_query_executor *query_exec; | |
59 | ||
17f3083a | 60 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b | 61 | BT_ASSERT_PRE_COMP_CLS_NON_NULL(comp_cls); |
1778c2a4 | 62 | BT_ASSERT_PRE_NON_NULL("object", object, "Object"); |
3c729b9a | 63 | BT_LIB_LOGD("Creating query executor: " |
fb739d29 | 64 | "%![comp-cls-]+C, object=\"%s\", %![params-]+v", |
3c729b9a | 65 | comp_cls, object, params); |
c7eee084 PP |
66 | query_exec = g_new0(struct bt_query_executor, 1); |
67 | if (!query_exec) { | |
870631a2 PP |
68 | BT_LIB_LOGE_APPEND_CAUSE( |
69 | "Failed to allocate one query executor."); | |
c7eee084 PP |
70 | goto end; |
71 | } | |
72 | ||
9b4f9b42 | 73 | query_exec->interrupters = g_ptr_array_new_with_free_func( |
6871026b | 74 | (GDestroyNotify) bt_object_put_ref_no_null_check); |
9b4f9b42 PP |
75 | if (!query_exec->interrupters) { |
76 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray."); | |
77 | BT_OBJECT_PUT_REF_AND_RESET(query_exec); | |
78 | goto end; | |
79 | } | |
80 | ||
81 | query_exec->default_interrupter = bt_interrupter_create(); | |
82 | if (!query_exec->default_interrupter) { | |
83 | BT_LIB_LOGE_APPEND_CAUSE( | |
84 | "Failed to create one interrupter object."); | |
85 | BT_OBJECT_PUT_REF_AND_RESET(query_exec); | |
86 | goto end; | |
87 | } | |
88 | ||
3c729b9a PP |
89 | query_exec->object = g_string_new(object); |
90 | if (!query_exec->object) { | |
91 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString."); | |
92 | BT_OBJECT_PUT_REF_AND_RESET(query_exec); | |
93 | goto end; | |
94 | } | |
95 | ||
96 | query_exec->comp_cls = comp_cls; | |
6871026b | 97 | bt_object_get_ref_no_null_check(query_exec->comp_cls); |
3c729b9a PP |
98 | |
99 | if (!params) { | |
100 | query_exec->params = bt_value_null; | |
101 | } else { | |
102 | query_exec->params = params; | |
103 | } | |
104 | ||
6871026b | 105 | bt_object_get_ref_no_null_check(query_exec->params); |
7c14d641 | 106 | query_exec->method_data = method_data; |
3c729b9a | 107 | query_exec->log_level = BT_LOGGING_LEVEL_NONE; |
9b4f9b42 PP |
108 | bt_query_executor_add_interrupter(query_exec, |
109 | query_exec->default_interrupter); | |
3fea54f6 PP |
110 | bt_object_init_shared(&query_exec->base, |
111 | bt_query_executor_destroy); | |
3c729b9a | 112 | BT_LIB_LOGD("Created query executor: " |
fb739d29 | 113 | "addr=%p, %![comp-cls-]+C, object=\"%s\", %![params-]+v", |
3c729b9a | 114 | query_exec, comp_cls, object, params); |
c7eee084 PP |
115 | |
116 | end: | |
d94d92ac | 117 | return (void *) query_exec; |
c7eee084 PP |
118 | } |
119 | ||
1353b066 | 120 | BT_EXPORT |
7c14d641 PP |
121 | struct bt_query_executor *bt_query_executor_create( |
122 | const bt_component_class *comp_cls, const char *object, | |
123 | const bt_value *params) | |
124 | { | |
17f3083a | 125 | BT_ASSERT_PRE_NO_ERROR(); |
7c14d641 PP |
126 | return bt_query_executor_create_with_method_data(comp_cls, |
127 | object, params, NULL); | |
128 | } | |
129 | ||
1353b066 | 130 | BT_EXPORT |
d24d5663 | 131 | enum bt_query_executor_query_status bt_query_executor_query( |
0d72b8c3 | 132 | struct bt_query_executor *query_exec, |
05e21286 | 133 | const struct bt_value **user_result) |
c7eee084 | 134 | { |
3c729b9a PP |
135 | typedef enum bt_component_class_query_method_status (*method_t)( |
136 | void * /* self component class */, | |
137 | void * /* private query executor */, | |
138 | const char * /* object */, | |
139 | const struct bt_value * /* parameters */, | |
7c14d641 | 140 | void * /* method data */, |
3c729b9a | 141 | const struct bt_value ** /* result */); |
c7eee084 | 142 | |
d24d5663 PP |
143 | enum bt_query_executor_query_status status; |
144 | enum bt_component_class_query_method_status query_status; | |
d94d92ac | 145 | method_t method = NULL; |
1778c2a4 | 146 | const char *method_name = NULL; |
c7eee084 | 147 | |
17f3083a | 148 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b PP |
149 | BT_ASSERT_PRE_QUERY_EXEC_NON_NULL(query_exec); |
150 | BT_ASSERT_PRE_RES_OUT_NON_NULL(user_result); | |
d94d92ac | 151 | |
647c6d45 PP |
152 | /* |
153 | * Initial check: is the query executor already interrupted? If | |
154 | * so, return `BT_FUNC_STATUS_AGAIN`. Returning this status is | |
155 | * harmless: it's not `BT_FUNC_STATUS_OK` (there's no result), | |
156 | * and it's not `BT_FUNC_STATUS_ERROR` either (there's no | |
157 | * legitimate error). Since any query operation could return | |
158 | * `BT_FUNC_STATUS_AGAIN` when interrupted or instead of | |
159 | * blocking, the caller is responsible for checking the | |
160 | * interruption state of the query executor when getting this | |
161 | * status. | |
162 | */ | |
163 | if (bt_query_executor_is_interrupted(query_exec)) { | |
164 | BT_LIB_LOGD("Query executor is interrupted: " | |
165 | "not performing the query operation: " | |
166 | "query-exec-addr=%p, %![cc-]+C, object=\"%s\", " | |
167 | "%![params-]+v, log-level=%s", | |
3c729b9a PP |
168 | query_exec, query_exec->comp_cls, |
169 | query_exec->object->str, query_exec->params, | |
170 | bt_common_logging_level_string(query_exec->log_level)); | |
647c6d45 PP |
171 | status = BT_FUNC_STATUS_AGAIN; |
172 | goto end; | |
173 | } | |
174 | ||
3c729b9a | 175 | switch (query_exec->comp_cls->type) { |
d94d92ac PP |
176 | case BT_COMPONENT_CLASS_TYPE_SOURCE: |
177 | { | |
3c729b9a PP |
178 | struct bt_component_class_source *src_cc = (void *) |
179 | query_exec->comp_cls; | |
d94d92ac PP |
180 | |
181 | method = (method_t) src_cc->methods.query; | |
1778c2a4 | 182 | method_name = "bt_component_class_source_query_method"; |
d94d92ac | 183 | break; |
c7eee084 | 184 | } |
d94d92ac PP |
185 | case BT_COMPONENT_CLASS_TYPE_FILTER: |
186 | { | |
3c729b9a PP |
187 | struct bt_component_class_filter *flt_cc = (void *) |
188 | query_exec->comp_cls; | |
c7eee084 | 189 | |
d94d92ac | 190 | method = (method_t) flt_cc->methods.query; |
1778c2a4 | 191 | method_name = "bt_component_class_filter_query_method"; |
d94d92ac | 192 | break; |
c7eee084 | 193 | } |
d94d92ac PP |
194 | case BT_COMPONENT_CLASS_TYPE_SINK: |
195 | { | |
3c729b9a PP |
196 | struct bt_component_class_sink *sink_cc = (void *) |
197 | query_exec->comp_cls; | |
c7eee084 | 198 | |
d94d92ac | 199 | method = (method_t) sink_cc->methods.query; |
1778c2a4 | 200 | method_name = "bt_component_class_sink_query_method"; |
d94d92ac PP |
201 | break; |
202 | } | |
203 | default: | |
498e7994 | 204 | bt_common_abort(); |
c7eee084 PP |
205 | } |
206 | ||
d94d92ac | 207 | if (!method) { |
c7eee084 | 208 | /* Not an error: nothing to query */ |
d94d92ac | 209 | BT_LIB_LOGD("Component class has no registered query method: " |
3c729b9a | 210 | "%!+C", query_exec->comp_cls); |
76b6c2f7 | 211 | status = BT_FUNC_STATUS_UNKNOWN_OBJECT; |
c7eee084 PP |
212 | goto end; |
213 | } | |
214 | ||
d94d92ac | 215 | BT_LIB_LOGD("Calling user's query method: " |
f4e38e70 PP |
216 | "query-exec-addr=%p, %![cc-]+C, object=\"%s\", %![params-]+v, " |
217 | "log-level=%s", | |
3c729b9a PP |
218 | query_exec, query_exec->comp_cls, query_exec->object->str, |
219 | query_exec->params, | |
220 | bt_common_logging_level_string(query_exec->log_level)); | |
d94d92ac | 221 | *user_result = NULL; |
3c729b9a PP |
222 | query_status = method((void *) query_exec->comp_cls, |
223 | (void *) query_exec, query_exec->object->str, | |
7c14d641 | 224 | query_exec->params, query_exec->method_data, user_result); |
d94d92ac | 225 | BT_LIB_LOGD("User method returned: status=%s, %![res-]+v", |
d24d5663 | 226 | bt_common_func_status_string(query_status), *user_result); |
1778c2a4 PP |
227 | BT_ASSERT_POST(method_name, "status-ok-with-result", |
228 | query_status != BT_FUNC_STATUS_OK || *user_result, | |
d24d5663 | 229 | "User method returned `BT_FUNC_STATUS_OK` without a result."); |
1778c2a4 | 230 | BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(method_name, query_status); |
d24d5663 | 231 | status = (int) query_status; |
c7eee084 | 232 | |
a635e507 SM |
233 | if (status < 0) { |
234 | BT_LIB_LOGW_APPEND_CAUSE( | |
235 | "Component class's \"query\" method failed: " | |
236 | "query-exec-addr=%p, %![cc-]+C, object=\"%s\", " | |
3c729b9a PP |
237 | "%![params-]+v, log-level=%s", query_exec, |
238 | query_exec->comp_cls, query_exec->object->str, | |
239 | query_exec->params, | |
240 | bt_common_logging_level_string(query_exec->log_level)); | |
a635e507 SM |
241 | goto end; |
242 | } | |
243 | ||
c7eee084 | 244 | end: |
d24d5663 | 245 | return status; |
c7eee084 PP |
246 | } |
247 | ||
1353b066 | 248 | BT_EXPORT |
9b4f9b42 PP |
249 | enum bt_query_executor_add_interrupter_status bt_query_executor_add_interrupter( |
250 | struct bt_query_executor *query_exec, | |
251 | const struct bt_interrupter *intr) | |
c7eee084 | 252 | { |
17f3083a | 253 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b PP |
254 | BT_ASSERT_PRE_QUERY_EXEC_NON_NULL(query_exec); |
255 | BT_ASSERT_PRE_INTR_NON_NULL(intr); | |
9b4f9b42 | 256 | g_ptr_array_add(query_exec->interrupters, (void *) intr); |
6871026b | 257 | bt_object_get_ref_no_null_check(intr); |
9b4f9b42 PP |
258 | BT_LIB_LOGD("Added interrupter to query executor: " |
259 | "query-exec-addr=%p, %![intr-]+z", | |
260 | query_exec, intr); | |
d24d5663 | 261 | return BT_FUNC_STATUS_OK; |
c7eee084 PP |
262 | } |
263 | ||
1353b066 | 264 | BT_EXPORT |
9b4f9b42 | 265 | bt_bool bt_query_executor_is_interrupted(const struct bt_query_executor *query_exec) |
c7eee084 | 266 | { |
d5b13b9b | 267 | BT_ASSERT_PRE_QUERY_EXEC_NON_NULL(query_exec); |
9b4f9b42 PP |
268 | return (bt_bool) bt_interrupter_array_any_is_set( |
269 | query_exec->interrupters); | |
270 | } | |
271 | ||
1353b066 | 272 | BT_EXPORT |
88d1a0b7 SM |
273 | struct bt_interrupter *bt_query_executor_borrow_default_interrupter( |
274 | struct bt_query_executor *query_exec) | |
9b4f9b42 | 275 | { |
d5b13b9b | 276 | BT_ASSERT_PRE_QUERY_EXEC_NON_NULL(query_exec); |
88d1a0b7 | 277 | return query_exec->default_interrupter; |
c7eee084 | 278 | } |
c5b9b441 | 279 | |
1353b066 | 280 | BT_EXPORT |
3c729b9a PP |
281 | enum bt_query_executor_set_logging_level_status |
282 | bt_query_executor_set_logging_level(struct bt_query_executor *query_exec, | |
283 | enum bt_logging_level log_level) | |
284 | { | |
d5b13b9b | 285 | BT_ASSERT_PRE_QUERY_EXEC_NON_NULL(query_exec); |
3c729b9a PP |
286 | query_exec->log_level = log_level; |
287 | return BT_FUNC_STATUS_OK; | |
288 | } | |
289 | ||
1353b066 | 290 | BT_EXPORT |
3c729b9a PP |
291 | enum bt_logging_level bt_query_executor_get_logging_level( |
292 | const struct bt_query_executor *query_exec) | |
293 | { | |
d5b13b9b | 294 | BT_ASSERT_PRE_QUERY_EXEC_NON_NULL(query_exec); |
3c729b9a PP |
295 | return query_exec->log_level; |
296 | } | |
297 | ||
1353b066 | 298 | BT_EXPORT |
c5b9b441 PP |
299 | void bt_query_executor_get_ref(const struct bt_query_executor *query_executor) |
300 | { | |
301 | bt_object_get_ref(query_executor); | |
302 | } | |
303 | ||
1353b066 | 304 | BT_EXPORT |
c5b9b441 PP |
305 | void bt_query_executor_put_ref(const struct bt_query_executor *query_executor) |
306 | { | |
307 | bt_object_put_ref(query_executor); | |
308 | } |