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