4 * Babeltrace Sink Component
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
29 #include <babeltrace/compiler.h>
30 #include <babeltrace/values.h>
31 #include <babeltrace/component/component-sink-internal.h>
32 #include <babeltrace/component/component-internal.h>
33 #include <babeltrace/component/notification/notification.h>
36 enum bt_component_status
bt_component_sink_validate(
37 struct bt_component
*component
)
39 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
42 ret
= BT_COMPONENT_STATUS_INVALID
;
46 if (!component
->class) {
47 ret
= BT_COMPONENT_STATUS_INVALID
;
51 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
52 ret
= BT_COMPONENT_STATUS_INVALID
;
60 void bt_component_sink_destroy(struct bt_component
*component
)
62 struct bt_component_sink
*sink
= container_of(component
,
63 struct bt_component_sink
, parent
);
65 if (sink
->input_ports
) {
66 g_ptr_array_free(sink
->input_ports
, TRUE
);
71 struct bt_component
*bt_component_sink_create(
72 struct bt_component_class
*class, struct bt_value
*params
)
74 struct bt_component_sink
*sink
= NULL
;
75 enum bt_component_status ret
;
77 sink
= g_new0(struct bt_component_sink
, 1);
82 sink
->parent
.class = bt_get(class);
83 ret
= bt_component_init(&sink
->parent
, bt_component_sink_destroy
);
84 if (ret
!= BT_COMPONENT_STATUS_OK
) {
89 ret = bt_component_sink_register_notification_type(&sink->parent,
90 BT_NOTIFICATION_TYPE_EVENT);
91 if (ret != BT_COMPONENT_STATUS_OK) {
95 ret
= bt_component_init_input_ports(&sink
->parent
,
102 return sink
? &sink
->parent
: NULL
;
109 enum bt_component_status
bt_component_sink_consume(
110 struct bt_component
*component
)
112 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
113 struct bt_component_class_sink
*sink_class
= NULL
;
116 ret
= BT_COMPONENT_STATUS_INVALID
;
120 if (bt_component_get_class_type(component
) != BT_COMPONENT_CLASS_TYPE_SINK
) {
121 ret
= BT_COMPONENT_STATUS_UNSUPPORTED
;
125 sink_class
= container_of(component
->class, struct bt_component_class_sink
, parent
);
126 assert(sink_class
->methods
.consume
);
127 ret
= sink_class
->methods
.consume(component
);
133 enum bt_component_status bt_component_sink_register_notification_type(
134 struct bt_component *component, enum bt_notification_type type)
136 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
137 struct bt_component_sink *sink = NULL;
140 ret = BT_COMPONENT_STATUS_INVALID;
144 if (bt_component_get_class_type(component) != BT_COMPONENT_CLASS_TYPE_SINK) {
145 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
149 if (type <= BT_NOTIFICATION_TYPE_UNKNOWN ||
150 type >= BT_NOTIFICATION_TYPE_NR) {
151 ret = BT_COMPONENT_STATUS_INVALID;
154 sink = container_of(component, struct bt_component_sink, parent);
155 if (type == BT_NOTIFICATION_TYPE_ALL) {
156 sink->registered_notifications_mask = ~(notification_mask_t) 0;
158 sink->registered_notifications_mask |=
159 (notification_mask_t) 1 << type;
166 enum bt_component_status
bt_component_sink_get_input_port_count(
167 struct bt_component
*component
, uint64_t *count
)
169 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
170 struct bt_component_sink
*sink
;
172 if (!component
|| !count
) {
173 status
= BT_COMPONENT_STATUS_INVALID
;
177 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
178 status
= BT_COMPONENT_STATUS_INVALID
;
182 sink
= container_of(component
, struct bt_component_sink
, parent
);
183 *count
= (uint64_t) sink
->input_ports
->len
;
188 struct bt_port
*bt_component_sink_get_input_port(
189 struct bt_component
*component
, const char *name
)
191 struct bt_component_sink
*sink
;
192 struct bt_port
*ret_port
= NULL
;
194 if (!component
|| !name
||
195 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
199 sink
= container_of(component
, struct bt_component_sink
, parent
);
200 ret_port
= bt_component_get_port(sink
->input_ports
, name
);
205 struct bt_port
*bt_component_sink_get_input_port_at_index(
206 struct bt_component
*component
, int index
)
208 struct bt_port
*port
= NULL
;
209 struct bt_component_sink
*sink
;
212 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
216 sink
= container_of(component
, struct bt_component_sink
, parent
);
217 port
= bt_component_get_port_at_index(sink
->input_ports
, index
);
222 struct bt_port
*bt_component_sink_get_default_input_port(
223 struct bt_component
*component
)
225 return bt_component_sink_get_input_port(component
,
226 DEFAULT_INPUT_PORT_NAME
);
229 struct bt_port
*bt_component_sink_add_input_port(
230 struct bt_component
*component
, const char *name
)
232 struct bt_port
*port
;
233 struct bt_component_sink
*sink
;
236 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
241 sink
= container_of(component
, struct bt_component_sink
, parent
);
242 port
= bt_component_add_port(component
, sink
->input_ports
,
243 BT_PORT_TYPE_INPUT
, name
);
248 enum bt_component_status
bt_component_sink_remove_input_port(
249 struct bt_component
*component
, const char *name
)
251 enum bt_component_status status
;
252 struct bt_component_sink
*sink
;
255 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
256 status
= BT_COMPONENT_STATUS_INVALID
;
260 sink
= container_of(component
, struct bt_component_sink
, parent
);
261 status
= bt_component_remove_port(component
, sink
->input_ports
,