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> |
5c563278 | 34 | #include <babeltrace/graph/private-component.h> |
b2e0c907 PP |
35 | #include <babeltrace/graph/component-sink-internal.h> |
36 | #include <babeltrace/graph/component-internal.h> | |
37 | #include <babeltrace/graph/notification.h> | |
bd7cc15b | 38 | #include <babeltrace/graph/graph.h> |
f6ccaed9 PP |
39 | #include <babeltrace/assert-internal.h> |
40 | #include <babeltrace/assert-internal.h> | |
0d884c50 | 41 | |
72b913fb | 42 | BT_HIDDEN |
fec2a9f2 JG |
43 | void bt_component_sink_destroy(struct bt_component *component) |
44 | { | |
fec2a9f2 JG |
45 | } |
46 | ||
8738a040 | 47 | BT_HIDDEN |
fb2dcc52 | 48 | struct bt_component *bt_component_sink_create( |
36712f1d | 49 | struct bt_component_class *class) |
0d884c50 JG |
50 | { |
51 | struct bt_component_sink *sink = NULL; | |
0d884c50 | 52 | |
0d884c50 JG |
53 | sink = g_new0(struct bt_component_sink, 1); |
54 | if (!sink) { | |
be9ef048 | 55 | BT_LOGE_STR("Failed to allocate one sink component."); |
0d884c50 JG |
56 | goto end; |
57 | } | |
58 | ||
0d884c50 JG |
59 | end: |
60 | return sink ? &sink->parent : NULL; | |
61 | } | |
fa55ed98 | 62 | |
973a2bd1 | 63 | BT_HIDDEN |
fec2a9f2 JG |
64 | enum bt_component_status bt_component_sink_consume( |
65 | struct bt_component *component) | |
fa55ed98 JG |
66 | { |
67 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
d3e4dcd8 | 68 | struct bt_component_class_sink *sink_class = NULL; |
fa55ed98 | 69 | |
f6ccaed9 PP |
70 | BT_ASSERT(component); |
71 | BT_ASSERT(bt_component_get_class_type(component) == BT_COMPONENT_CLASS_TYPE_SINK); | |
d3e4dcd8 | 72 | sink_class = container_of(component->class, struct bt_component_class_sink, parent); |
f6ccaed9 | 73 | BT_ASSERT(sink_class->methods.consume); |
be9ef048 PP |
74 | BT_LOGD("Calling user's consume method: " |
75 | "comp-addr=%p, comp-name=\"%s\"", | |
76 | component, bt_component_get_name(component)); | |
890882ef | 77 | ret = sink_class->methods.consume(bt_private_component_from_component(component)); |
be9ef048 PP |
78 | BT_LOGD("User method returned: status=%s", |
79 | bt_component_status_string(ret)); | |
80 | if (ret < 0) { | |
81 | BT_LOGW_STR("Consume method failed."); | |
82 | } | |
83 | ||
fa55ed98 JG |
84 | return ret; |
85 | } | |
34a9ed19 | 86 | |
544d0515 | 87 | int64_t bt_component_sink_get_input_port_count(struct bt_component *component) |
952ebade | 88 | { |
544d0515 | 89 | int64_t ret; |
952ebade | 90 | |
be9ef048 PP |
91 | if (!component) { |
92 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
93 | ret = (int64_t) -1; | |
94 | goto end; | |
95 | } | |
96 | ||
97 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
98 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
99 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
100 | component, bt_component_get_name(component), | |
101 | bt_component_class_type_string(component->class->type)); | |
102 | ret = (int64_t) -1; | |
952ebade JG |
103 | goto end; |
104 | } | |
105 | ||
be9ef048 | 106 | /* bt_component_get_input_port_count() logs details/errors */ |
544d0515 | 107 | ret = bt_component_get_input_port_count(component); |
be9ef048 | 108 | |
fec2a9f2 | 109 | end: |
544d0515 | 110 | return ret; |
fec2a9f2 JG |
111 | } |
112 | ||
9ac68eb1 | 113 | struct bt_port *bt_component_sink_get_input_port_by_name( |
366e034f | 114 | struct bt_component *component, const char *name) |
fec2a9f2 | 115 | { |
72b913fb | 116 | struct bt_port *port = NULL; |
fec2a9f2 | 117 | |
be9ef048 PP |
118 | if (!component) { |
119 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
120 | goto end; | |
121 | } | |
122 | ||
123 | if (!name) { | |
124 | BT_LOGW_STR("Invalid parameter: name is NULL."); | |
125 | goto end; | |
126 | } | |
127 | ||
128 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
129 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
130 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
131 | component, bt_component_get_name(component), | |
132 | bt_component_class_type_string(component->class->type)); | |
fec2a9f2 JG |
133 | goto end; |
134 | } | |
135 | ||
be9ef048 | 136 | /* bt_component_get_input_port_by_name() logs details/errors */ |
9ac68eb1 | 137 | port = bt_component_get_input_port_by_name(component, name); |
be9ef048 | 138 | |
fec2a9f2 | 139 | end: |
72b913fb | 140 | return port; |
fec2a9f2 JG |
141 | } |
142 | ||
9ac68eb1 PP |
143 | struct bt_port *bt_component_sink_get_input_port_by_index( |
144 | struct bt_component *component, uint64_t index) | |
fec2a9f2 | 145 | { |
366e034f | 146 | struct bt_port *port = NULL; |
fec2a9f2 | 147 | |
be9ef048 PP |
148 | if (!component) { |
149 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
150 | goto end; | |
151 | } | |
152 | ||
153 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
154 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
155 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
156 | component, bt_component_get_name(component), | |
157 | bt_component_class_type_string(component->class->type)); | |
fec2a9f2 JG |
158 | goto end; |
159 | } | |
160 | ||
be9ef048 | 161 | /* bt_component_get_input_port_by_index() logs details/errors */ |
9ac68eb1 | 162 | port = bt_component_get_input_port_by_index(component, index); |
be9ef048 | 163 | |
fec2a9f2 | 164 | end: |
366e034f | 165 | return port; |
fec2a9f2 JG |
166 | } |
167 | ||
890882ef | 168 | struct bt_private_port * |
9ac68eb1 PP |
169 | bt_private_component_sink_get_input_private_port_by_index( |
170 | struct bt_private_component *private_component, uint64_t index) | |
890882ef | 171 | { |
be9ef048 | 172 | /* bt_component_sink_get_input_port_by_index() logs details/errors */ |
890882ef | 173 | return bt_private_port_from_port( |
9ac68eb1 | 174 | bt_component_sink_get_input_port_by_index( |
6d137876 | 175 | bt_component_borrow_from_private(private_component), index)); |
890882ef PP |
176 | } |
177 | ||
b9d103be PP |
178 | struct bt_private_port * |
179 | bt_private_component_sink_get_input_private_port_by_name( | |
180 | struct bt_private_component *private_component, | |
181 | const char *name) | |
890882ef | 182 | { |
be9ef048 | 183 | /* bt_component_sink_get_input_port_by_name() logs details/errors */ |
890882ef | 184 | return bt_private_port_from_port( |
b9d103be | 185 | bt_component_sink_get_input_port_by_name( |
6d137876 | 186 | bt_component_borrow_from_private(private_component), name)); |
890882ef PP |
187 | } |
188 | ||
147337a3 | 189 | enum bt_component_status bt_private_component_sink_add_input_private_port( |
890882ef | 190 | struct bt_private_component *private_component, |
147337a3 PP |
191 | const char *name, void *user_data, |
192 | struct bt_private_port **user_priv_port) | |
366e034f | 193 | { |
147337a3 | 194 | enum bt_component_status status = BT_COMPONENT_STATUS_OK; |
72b913fb | 195 | struct bt_port *port = NULL; |
890882ef | 196 | struct bt_component *component = |
6d137876 | 197 | bt_component_borrow_from_private(private_component); |
bd7cc15b | 198 | struct bt_graph *graph; |
fec2a9f2 | 199 | |
be9ef048 PP |
200 | if (!component) { |
201 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
147337a3 | 202 | status = BT_COMPONENT_STATUS_INVALID; |
be9ef048 PP |
203 | goto end; |
204 | } | |
205 | ||
206 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
207 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
208 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
209 | component, bt_component_get_name(component), | |
210 | bt_component_class_type_string(component->class->type)); | |
147337a3 | 211 | status = BT_COMPONENT_STATUS_INVALID; |
fec2a9f2 JG |
212 | goto end; |
213 | } | |
214 | ||
bd7cc15b PP |
215 | graph = bt_component_borrow_graph(component); |
216 | ||
217 | if (graph && bt_graph_is_canceled(graph)) { | |
43ca7dcc | 218 | BT_LOGW("Cannot add input port to sink component: graph is canceled: " |
bd7cc15b PP |
219 | "comp-addr=%p, comp-name=\"%s\", graph-addr=%p", |
220 | component, bt_component_get_name(component), | |
221 | bt_component_borrow_graph(component)); | |
222 | status = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED; | |
223 | goto end; | |
224 | } | |
225 | ||
be9ef048 | 226 | /* bt_component_add_input_port() logs details/errors */ |
3e9b0023 | 227 | port = bt_component_add_input_port(component, name, user_data); |
147337a3 PP |
228 | if (!port) { |
229 | status = BT_COMPONENT_STATUS_NOMEM; | |
230 | goto end; | |
231 | } | |
232 | ||
233 | if (user_priv_port) { | |
234 | /* Move reference to user */ | |
235 | *user_priv_port = bt_private_port_from_port(port); | |
236 | port = NULL; | |
237 | } | |
be9ef048 | 238 | |
fec2a9f2 | 239 | end: |
147337a3 PP |
240 | bt_put(port); |
241 | return status; | |
fec2a9f2 | 242 | } |