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 | |
544d0515 | 63 | int64_t bt_component_sink_get_input_port_count(struct bt_component *component) |
952ebade | 64 | { |
544d0515 | 65 | int64_t ret; |
952ebade | 66 | |
be9ef048 PP |
67 | if (!component) { |
68 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
69 | ret = (int64_t) -1; | |
70 | goto end; | |
71 | } | |
72 | ||
73 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
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)); | |
78 | ret = (int64_t) -1; | |
952ebade JG |
79 | goto end; |
80 | } | |
81 | ||
be9ef048 | 82 | /* bt_component_get_input_port_count() logs details/errors */ |
544d0515 | 83 | ret = bt_component_get_input_port_count(component); |
be9ef048 | 84 | |
fec2a9f2 | 85 | end: |
544d0515 | 86 | return ret; |
fec2a9f2 JG |
87 | } |
88 | ||
9ac68eb1 | 89 | struct bt_port *bt_component_sink_get_input_port_by_name( |
366e034f | 90 | struct bt_component *component, const char *name) |
fec2a9f2 | 91 | { |
72b913fb | 92 | struct bt_port *port = NULL; |
fec2a9f2 | 93 | |
be9ef048 PP |
94 | if (!component) { |
95 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
96 | goto end; | |
97 | } | |
98 | ||
99 | if (!name) { | |
100 | BT_LOGW_STR("Invalid parameter: name is NULL."); | |
101 | goto end; | |
102 | } | |
103 | ||
104 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
105 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
106 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
107 | component, bt_component_get_name(component), | |
108 | bt_component_class_type_string(component->class->type)); | |
fec2a9f2 JG |
109 | goto end; |
110 | } | |
111 | ||
be9ef048 | 112 | /* bt_component_get_input_port_by_name() logs details/errors */ |
9ac68eb1 | 113 | port = bt_component_get_input_port_by_name(component, name); |
be9ef048 | 114 | |
fec2a9f2 | 115 | end: |
72b913fb | 116 | return port; |
fec2a9f2 JG |
117 | } |
118 | ||
9ac68eb1 PP |
119 | struct bt_port *bt_component_sink_get_input_port_by_index( |
120 | struct bt_component *component, uint64_t index) | |
fec2a9f2 | 121 | { |
366e034f | 122 | struct bt_port *port = NULL; |
fec2a9f2 | 123 | |
be9ef048 PP |
124 | if (!component) { |
125 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
126 | goto end; | |
127 | } | |
128 | ||
129 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
130 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
131 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
132 | component, bt_component_get_name(component), | |
133 | bt_component_class_type_string(component->class->type)); | |
fec2a9f2 JG |
134 | goto end; |
135 | } | |
136 | ||
be9ef048 | 137 | /* bt_component_get_input_port_by_index() logs details/errors */ |
9ac68eb1 | 138 | port = bt_component_get_input_port_by_index(component, index); |
be9ef048 | 139 | |
fec2a9f2 | 140 | end: |
366e034f | 141 | return port; |
fec2a9f2 JG |
142 | } |
143 | ||
890882ef | 144 | struct bt_private_port * |
28e6ca8b | 145 | bt_private_component_sink_get_input_port_by_index( |
9ac68eb1 | 146 | struct bt_private_component *private_component, uint64_t index) |
890882ef | 147 | { |
be9ef048 | 148 | /* bt_component_sink_get_input_port_by_index() logs details/errors */ |
890882ef | 149 | return bt_private_port_from_port( |
9ac68eb1 | 150 | bt_component_sink_get_input_port_by_index( |
6d137876 | 151 | bt_component_borrow_from_private(private_component), index)); |
890882ef PP |
152 | } |
153 | ||
b9d103be | 154 | struct bt_private_port * |
28e6ca8b | 155 | bt_private_component_sink_get_input_port_by_name( |
b9d103be PP |
156 | struct bt_private_component *private_component, |
157 | const char *name) | |
890882ef | 158 | { |
be9ef048 | 159 | /* bt_component_sink_get_input_port_by_name() logs details/errors */ |
890882ef | 160 | return bt_private_port_from_port( |
b9d103be | 161 | bt_component_sink_get_input_port_by_name( |
6d137876 | 162 | bt_component_borrow_from_private(private_component), name)); |
890882ef PP |
163 | } |
164 | ||
28e6ca8b | 165 | enum bt_component_status bt_private_component_sink_add_input_port( |
890882ef | 166 | struct bt_private_component *private_component, |
147337a3 PP |
167 | const char *name, void *user_data, |
168 | struct bt_private_port **user_priv_port) | |
366e034f | 169 | { |
147337a3 | 170 | enum bt_component_status status = BT_COMPONENT_STATUS_OK; |
72b913fb | 171 | struct bt_port *port = NULL; |
890882ef | 172 | struct bt_component *component = |
6d137876 | 173 | bt_component_borrow_from_private(private_component); |
bd7cc15b | 174 | struct bt_graph *graph; |
fec2a9f2 | 175 | |
be9ef048 PP |
176 | if (!component) { |
177 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
147337a3 | 178 | status = BT_COMPONENT_STATUS_INVALID; |
be9ef048 PP |
179 | goto end; |
180 | } | |
181 | ||
182 | if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
183 | BT_LOGW("Invalid parameter: component's class is not a sink component class: " | |
184 | "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s", | |
185 | component, bt_component_get_name(component), | |
186 | bt_component_class_type_string(component->class->type)); | |
147337a3 | 187 | status = BT_COMPONENT_STATUS_INVALID; |
fec2a9f2 JG |
188 | goto end; |
189 | } | |
190 | ||
bd7cc15b PP |
191 | graph = bt_component_borrow_graph(component); |
192 | ||
193 | if (graph && bt_graph_is_canceled(graph)) { | |
43ca7dcc | 194 | BT_LOGW("Cannot add input port to sink component: graph is canceled: " |
bd7cc15b PP |
195 | "comp-addr=%p, comp-name=\"%s\", graph-addr=%p", |
196 | component, bt_component_get_name(component), | |
197 | bt_component_borrow_graph(component)); | |
198 | status = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED; | |
199 | goto end; | |
200 | } | |
201 | ||
be9ef048 | 202 | /* bt_component_add_input_port() logs details/errors */ |
3e9b0023 | 203 | port = bt_component_add_input_port(component, name, user_data); |
147337a3 PP |
204 | if (!port) { |
205 | status = BT_COMPONENT_STATUS_NOMEM; | |
206 | goto end; | |
207 | } | |
208 | ||
209 | if (user_priv_port) { | |
210 | /* Move reference to user */ | |
211 | *user_priv_port = bt_private_port_from_port(port); | |
212 | port = NULL; | |
213 | } | |
be9ef048 | 214 | |
fec2a9f2 | 215 | end: |
65300d60 | 216 | bt_object_put_ref(port); |
147337a3 | 217 | return status; |
fec2a9f2 | 218 | } |