Commit | Line | Data |
---|---|---|
1286dcbb PP |
1 | /* |
2 | * Copyright 2017 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 "QUERY-EXECUTOR" | |
24 | #include <babeltrace/lib-logging-internal.h> | |
25 | ||
834e9996 | 26 | #include <babeltrace/graph/private-query-executor.h> |
1286dcbb PP |
27 | #include <babeltrace/graph/query-executor.h> |
28 | #include <babeltrace/graph/query-executor-internal.h> | |
29 | #include <babeltrace/graph/component-class.h> | |
30 | #include <babeltrace/graph/component-class-internal.h> | |
78cf9df6 | 31 | #include <babeltrace/values.h> |
ce141536 | 32 | #include <babeltrace/values-const.h> |
1286dcbb | 33 | #include <babeltrace/object-internal.h> |
834e9996 | 34 | #include <babeltrace/object.h> |
1286dcbb | 35 | #include <babeltrace/compiler-internal.h> |
834e9996 PP |
36 | #include <babeltrace/assert-internal.h> |
37 | #include <babeltrace/assert-pre-internal.h> | |
1286dcbb PP |
38 | |
39 | static | |
40 | void bt_query_executor_destroy(struct bt_object *obj) | |
41 | { | |
42 | struct bt_query_executor *query_exec = | |
43 | container_of(obj, struct bt_query_executor, base); | |
44 | ||
834e9996 | 45 | BT_LOGD("Destroying query executor: addr=%p", query_exec); |
1286dcbb PP |
46 | g_free(query_exec); |
47 | } | |
48 | ||
834e9996 | 49 | struct bt_private_query_executor *bt_private_query_executor_create(void) |
1286dcbb PP |
50 | { |
51 | struct bt_query_executor *query_exec; | |
52 | ||
53 | BT_LOGD_STR("Creating query executor."); | |
54 | query_exec = g_new0(struct bt_query_executor, 1); | |
55 | if (!query_exec) { | |
56 | BT_LOGE_STR("Failed to allocate one query executor."); | |
57 | goto end; | |
58 | } | |
59 | ||
1d7bf349 PP |
60 | bt_object_init_shared(&query_exec->base, |
61 | bt_query_executor_destroy); | |
1286dcbb PP |
62 | BT_LOGD("Created query executor: addr=%p", query_exec); |
63 | ||
64 | end: | |
834e9996 | 65 | return (void *) query_exec; |
1286dcbb PP |
66 | } |
67 | ||
79400927 | 68 | enum bt_query_executor_status bt_private_query_executor_query( |
834e9996 PP |
69 | struct bt_private_query_executor *priv_query_exec, |
70 | struct bt_component_class *comp_cls, | |
ce141536 PP |
71 | const char *object, const struct bt_value *params, |
72 | const struct bt_value **user_result) | |
1286dcbb | 73 | { |
834e9996 | 74 | typedef enum bt_query_status (*method_t)(void *, void *, |
ce141536 | 75 | const void *, const void *, void *); |
1286dcbb | 76 | |
834e9996 PP |
77 | struct bt_query_executor *query_exec = (void *) priv_query_exec; |
78 | enum bt_query_status status; | |
79400927 | 79 | enum bt_query_executor_status exec_status; |
834e9996 | 80 | method_t method = NULL; |
1286dcbb | 81 | |
834e9996 PP |
82 | BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor"); |
83 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); | |
84 | BT_ASSERT_PRE_NON_NULL(object, "Object"); | |
85 | BT_ASSERT_PRE_NON_NULL(user_result, "Result (output)"); | |
86 | BT_ASSERT_PRE(!query_exec->canceled, "Query executor is canceled."); | |
87 | ||
88 | if (!params) { | |
89 | params = bt_value_null; | |
1286dcbb PP |
90 | } |
91 | ||
834e9996 PP |
92 | switch (comp_cls->type) { |
93 | case BT_COMPONENT_CLASS_TYPE_SOURCE: | |
94 | { | |
95 | struct bt_component_class_source *src_cc = (void *) comp_cls; | |
96 | ||
97 | method = (method_t) src_cc->methods.query; | |
98 | break; | |
1286dcbb | 99 | } |
834e9996 PP |
100 | case BT_COMPONENT_CLASS_TYPE_FILTER: |
101 | { | |
102 | struct bt_component_class_filter *flt_cc = (void *) comp_cls; | |
1286dcbb | 103 | |
834e9996 PP |
104 | method = (method_t) flt_cc->methods.query; |
105 | break; | |
1286dcbb | 106 | } |
834e9996 PP |
107 | case BT_COMPONENT_CLASS_TYPE_SINK: |
108 | { | |
109 | struct bt_component_class_sink *sink_cc = (void *) comp_cls; | |
1286dcbb | 110 | |
834e9996 PP |
111 | method = (method_t) sink_cc->methods.query; |
112 | break; | |
113 | } | |
114 | default: | |
115 | abort(); | |
1286dcbb PP |
116 | } |
117 | ||
834e9996 | 118 | if (!method) { |
1286dcbb | 119 | /* Not an error: nothing to query */ |
834e9996 PP |
120 | BT_LIB_LOGD("Component class has no registered query method: " |
121 | "%!+C", comp_cls); | |
79400927 | 122 | exec_status = BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED; |
1286dcbb PP |
123 | goto end; |
124 | } | |
125 | ||
834e9996 PP |
126 | BT_LIB_LOGD("Calling user's query method: " |
127 | "query-exec-addr=%p, %![cc-]+C, object=\"%s\", %![params-]+v", | |
128 | query_exec, comp_cls, object, params); | |
129 | *user_result = NULL; | |
130 | status = method(comp_cls, query_exec, object, params, user_result); | |
131 | BT_LIB_LOGD("User method returned: status=%s, %![res-]+v", | |
132 | bt_query_status_string(status), *user_result); | |
834e9996 PP |
133 | BT_ASSERT_PRE(status != BT_QUERY_STATUS_OK || *user_result, |
134 | "User method returned `BT_QUERY_STATUS_OK` without a result."); | |
79400927 | 135 | exec_status = (int) status; |
1286dcbb | 136 | if (query_exec->canceled) { |
834e9996 | 137 | BT_OBJECT_PUT_REF_AND_RESET(*user_result); |
79400927 | 138 | status = BT_QUERY_EXECUTOR_STATUS_CANCELED; |
1286dcbb | 139 | goto end; |
1286dcbb PP |
140 | } |
141 | ||
142 | end: | |
79400927 | 143 | return exec_status; |
1286dcbb PP |
144 | } |
145 | ||
79400927 | 146 | enum bt_query_executor_status bt_private_query_executor_cancel( |
834e9996 | 147 | struct bt_private_query_executor *priv_query_exec) |
1286dcbb | 148 | { |
834e9996 | 149 | struct bt_query_executor *query_exec = (void *) priv_query_exec; |
1286dcbb | 150 | |
834e9996 | 151 | BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor"); |
1286dcbb PP |
152 | query_exec->canceled = BT_TRUE; |
153 | BT_LOGV("Canceled query executor: addr=%p", query_exec); | |
79400927 | 154 | return BT_QUERY_EXECUTOR_STATUS_OK; |
1286dcbb PP |
155 | } |
156 | ||
157 | bt_bool bt_query_executor_is_canceled(struct bt_query_executor *query_exec) | |
158 | { | |
834e9996 PP |
159 | BT_ASSERT_PRE_NON_NULL(query_exec, "Query executor"); |
160 | return query_exec->canceled; | |
1286dcbb | 161 | } |