Commit | Line | Data |
---|---|---|
0d884c50 JG |
1 | /* |
2 | * sink.c | |
3 | * | |
47e5a032 | 4 | * Babeltrace Sink Component |
0d884c50 JG |
5 | * |
6 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
7 | * | |
8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * | |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
be9ef048 PP |
29 | #define BT_LOG_TAG "COMP-SINK" |
30 | #include <babeltrace/lib-logging-internal.h> | |
31 | ||
3d9990ac | 32 | #include <babeltrace/compiler-internal.h> |
fec2a9f2 | 33 | #include <babeltrace/values.h> |
b2e0c907 PP |
34 | #include <babeltrace/graph/component-sink-internal.h> |
35 | #include <babeltrace/graph/component-internal.h> | |
36 | #include <babeltrace/graph/notification.h> | |
bd7cc15b | 37 | #include <babeltrace/graph/graph.h> |
0d884c50 | 38 | |
72b913fb | 39 | BT_HIDDEN |
fec2a9f2 JG |
40 | void bt_component_sink_destroy(struct bt_component *component) |
41 | { | |
fec2a9f2 JG |
42 | } |
43 | ||
8738a040 | 44 | BT_HIDDEN |
fb2dcc52 | 45 | struct bt_component *bt_component_sink_create( |
36712f1d | 46 | struct bt_component_class *class) |
0d884c50 JG |
47 | { |
48 | struct bt_component_sink *sink = NULL; | |
0d884c50 | 49 | |
0d884c50 JG |
50 | sink = g_new0(struct bt_component_sink, 1); |
51 | if (!sink) { | |
be9ef048 | 52 | BT_LOGE_STR("Failed to allocate one sink component."); |
0d884c50 JG |
53 | goto end; |
54 | } | |
55 | ||
0d884c50 JG |
56 | end: |
57 | return sink ? &sink->parent : NULL; | |
58 | } | |
fa55ed98 | 59 | |
973a2bd1 | 60 | BT_HIDDEN |
fec2a9f2 JG |
61 | enum bt_component_status bt_component_sink_consume( |
62 | struct bt_component *component) | |
fa55ed98 JG |
63 | { |
64 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
d3e4dcd8 | 65 | struct bt_component_class_sink *sink_class = NULL; |
fa55ed98 | 66 | |
fec2a9f2 | 67 | if (!component) { |
be9ef048 | 68 | BT_LOGW_STR("Invalid parameter: component is NULL."); |
30d619df | 69 | ret = BT_COMPONENT_STATUS_INVALID; |
fa55ed98 JG |
70 | goto end; |
71 | } | |
72 | ||
d3e4dcd8 | 73 | if (bt_component_get_class_type(component) != BT_COMPONENT_CLASS_TYPE_SINK) { |
be9ef048 PP |
74 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " |
75 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
76 | component, bt_component_get_name(component), | |
77 | bt_component_class_type_string(component->class->type)); | |
fa55ed98 JG |
78 | ret = BT_COMPONENT_STATUS_UNSUPPORTED; |
79 | goto end; | |
80 | } | |
81 | ||
d3e4dcd8 PP |
82 | sink_class = container_of(component->class, struct bt_component_class_sink, parent); |
83 | assert(sink_class->methods.consume); | |
be9ef048 PP |
84 | BT_LOGD("Calling user's consume method: " |
85 | "comp-addr=%p, comp-name=\"%s\"", | |
86 | component, bt_component_get_name(component)); | |
890882ef | 87 | ret = sink_class->methods.consume(bt_private_component_from_component(component)); |
be9ef048 PP |
88 | BT_LOGD("User method returned: status=%s", |
89 | bt_component_status_string(ret)); | |
90 | if (ret < 0) { | |
91 | BT_LOGW_STR("Consume method failed."); | |
92 | } | |
93 | ||
fa55ed98 JG |
94 | end: |
95 | return ret; | |
96 | } | |
34a9ed19 | 97 | |
544d0515 | 98 | int64_t bt_component_sink_get_input_port_count(struct bt_component *component) |
952ebade | 99 | { |
544d0515 | 100 | int64_t ret; |
952ebade | 101 | |
be9ef048 PP |
102 | if (!component) { |
103 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
104 | ret = (int64_t) -1; | |
105 | goto end; | |
106 | } | |
107 | ||
108 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
109 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
110 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
111 | component, bt_component_get_name(component), | |
112 | bt_component_class_type_string(component->class->type)); | |
113 | ret = (int64_t) -1; | |
952ebade JG |
114 | goto end; |
115 | } | |
116 | ||
be9ef048 | 117 | /* bt_component_get_input_port_count() logs details/errors */ |
544d0515 | 118 | ret = bt_component_get_input_port_count(component); |
be9ef048 | 119 | |
fec2a9f2 | 120 | end: |
544d0515 | 121 | return ret; |
fec2a9f2 JG |
122 | } |
123 | ||
9ac68eb1 | 124 | struct bt_port *bt_component_sink_get_input_port_by_name( |
366e034f | 125 | struct bt_component *component, const char *name) |
fec2a9f2 | 126 | { |
72b913fb | 127 | struct bt_port *port = NULL; |
fec2a9f2 | 128 | |
be9ef048 PP |
129 | if (!component) { |
130 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
131 | goto end; | |
132 | } | |
133 | ||
134 | if (!name) { | |
135 | BT_LOGW_STR("Invalid parameter: name is NULL."); | |
136 | goto end; | |
137 | } | |
138 | ||
139 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
140 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
141 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
142 | component, bt_component_get_name(component), | |
143 | bt_component_class_type_string(component->class->type)); | |
fec2a9f2 JG |
144 | goto end; |
145 | } | |
146 | ||
be9ef048 | 147 | /* bt_component_get_input_port_by_name() logs details/errors */ |
9ac68eb1 | 148 | port = bt_component_get_input_port_by_name(component, name); |
be9ef048 | 149 | |
fec2a9f2 | 150 | end: |
72b913fb | 151 | return port; |
fec2a9f2 JG |
152 | } |
153 | ||
9ac68eb1 PP |
154 | struct bt_port *bt_component_sink_get_input_port_by_index( |
155 | struct bt_component *component, uint64_t index) | |
fec2a9f2 | 156 | { |
366e034f | 157 | struct bt_port *port = NULL; |
fec2a9f2 | 158 | |
be9ef048 PP |
159 | if (!component) { |
160 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
161 | goto end; | |
162 | } | |
163 | ||
164 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
165 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
166 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
167 | component, bt_component_get_name(component), | |
168 | bt_component_class_type_string(component->class->type)); | |
fec2a9f2 JG |
169 | goto end; |
170 | } | |
171 | ||
be9ef048 | 172 | /* bt_component_get_input_port_by_index() logs details/errors */ |
9ac68eb1 | 173 | port = bt_component_get_input_port_by_index(component, index); |
be9ef048 | 174 | |
fec2a9f2 | 175 | end: |
366e034f | 176 | return port; |
fec2a9f2 JG |
177 | } |
178 | ||
890882ef | 179 | struct bt_private_port * |
9ac68eb1 PP |
180 | bt_private_component_sink_get_input_private_port_by_index( |
181 | struct bt_private_component *private_component, uint64_t index) | |
890882ef | 182 | { |
be9ef048 | 183 | /* bt_component_sink_get_input_port_by_index() logs details/errors */ |
890882ef | 184 | return bt_private_port_from_port( |
9ac68eb1 | 185 | bt_component_sink_get_input_port_by_index( |
890882ef PP |
186 | bt_component_from_private(private_component), index)); |
187 | } | |
188 | ||
b9d103be PP |
189 | struct bt_private_port * |
190 | bt_private_component_sink_get_input_private_port_by_name( | |
191 | struct bt_private_component *private_component, | |
192 | const char *name) | |
890882ef | 193 | { |
be9ef048 | 194 | /* bt_component_sink_get_input_port_by_name() logs details/errors */ |
890882ef | 195 | return bt_private_port_from_port( |
b9d103be PP |
196 | bt_component_sink_get_input_port_by_name( |
197 | bt_component_from_private(private_component), name)); | |
890882ef PP |
198 | } |
199 | ||
147337a3 | 200 | enum bt_component_status bt_private_component_sink_add_input_private_port( |
890882ef | 201 | struct bt_private_component *private_component, |
147337a3 PP |
202 | const char *name, void *user_data, |
203 | struct bt_private_port **user_priv_port) | |
366e034f | 204 | { |
147337a3 | 205 | enum bt_component_status status = BT_COMPONENT_STATUS_OK; |
72b913fb | 206 | struct bt_port *port = NULL; |
890882ef PP |
207 | struct bt_component *component = |
208 | bt_component_from_private(private_component); | |
bd7cc15b | 209 | struct bt_graph *graph; |
fec2a9f2 | 210 | |
be9ef048 PP |
211 | if (!component) { |
212 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
147337a3 | 213 | status = BT_COMPONENT_STATUS_INVALID; |
be9ef048 PP |
214 | goto end; |
215 | } | |
216 | ||
217 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
218 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
219 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
220 | component, bt_component_get_name(component), | |
221 | bt_component_class_type_string(component->class->type)); | |
147337a3 | 222 | status = BT_COMPONENT_STATUS_INVALID; |
fec2a9f2 JG |
223 | goto end; |
224 | } | |
225 | ||
bd7cc15b PP |
226 | graph = bt_component_borrow_graph(component); |
227 | ||
228 | if (graph && bt_graph_is_canceled(graph)) { | |
43ca7dcc | 229 | BT_LOGW("Cannot add input port to sink component: graph is canceled: " |
bd7cc15b PP |
230 | "comp-addr=%p, comp-name=\"%s\", graph-addr=%p", |
231 | component, bt_component_get_name(component), | |
232 | bt_component_borrow_graph(component)); | |
233 | status = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED; | |
234 | goto end; | |
235 | } | |
236 | ||
be9ef048 | 237 | /* bt_component_add_input_port() logs details/errors */ |
3e9b0023 | 238 | port = bt_component_add_input_port(component, name, user_data); |
147337a3 PP |
239 | if (!port) { |
240 | status = BT_COMPONENT_STATUS_NOMEM; | |
241 | goto end; | |
242 | } | |
243 | ||
244 | if (user_priv_port) { | |
245 | /* Move reference to user */ | |
246 | *user_priv_port = bt_private_port_from_port(port); | |
247 | port = NULL; | |
248 | } | |
be9ef048 | 249 | |
fec2a9f2 | 250 | end: |
147337a3 PP |
251 | bt_put(port); |
252 | return status; | |
fec2a9f2 | 253 | } |