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 #define BT_LOG_TAG "COMP-SINK"
30 #include <babeltrace/lib-logging-internal.h>
32 #include <babeltrace/compiler-internal.h>
33 #include <babeltrace/values.h>
34 #include <babeltrace/graph/component-sink-internal.h>
35 #include <babeltrace/graph/component-internal.h>
36 #include <babeltrace/graph/notification.h>
39 void bt_component_sink_destroy(struct bt_component
*component
)
44 struct bt_component
*bt_component_sink_create(
45 struct bt_component_class
*class, struct bt_value
*params
)
47 struct bt_component_sink
*sink
= NULL
;
49 sink
= g_new0(struct bt_component_sink
, 1);
51 BT_LOGE_STR("Failed to allocate one sink component.");
56 return sink
? &sink
->parent
: NULL
;
60 enum bt_component_status
bt_component_sink_consume(
61 struct bt_component
*component
)
63 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
64 struct bt_component_class_sink
*sink_class
= NULL
;
67 BT_LOGW_STR("Invalid parameter: component is NULL.");
68 ret
= BT_COMPONENT_STATUS_INVALID
;
72 if (bt_component_get_class_type(component
) != BT_COMPONENT_CLASS_TYPE_SINK
) {
73 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
74 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
75 component
, bt_component_get_name(component
),
76 bt_component_class_type_string(component
->class->type
));
77 ret
= BT_COMPONENT_STATUS_UNSUPPORTED
;
81 sink_class
= container_of(component
->class, struct bt_component_class_sink
, parent
);
82 assert(sink_class
->methods
.consume
);
83 BT_LOGD("Calling user's consume method: "
84 "comp-addr=%p, comp-name=\"%s\"",
85 component
, bt_component_get_name(component
));
86 ret
= sink_class
->methods
.consume(bt_private_component_from_component(component
));
87 BT_LOGD("User method returned: status=%s",
88 bt_component_status_string(ret
));
90 BT_LOGW_STR("Consume method failed.");
97 int64_t bt_component_sink_get_input_port_count(struct bt_component
*component
)
102 BT_LOGW_STR("Invalid parameter: component is NULL.");
107 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
108 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
109 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
110 component
, bt_component_get_name(component
),
111 bt_component_class_type_string(component
->class->type
));
116 /* bt_component_get_input_port_count() logs details/errors */
117 ret
= bt_component_get_input_port_count(component
);
123 struct bt_port
*bt_component_sink_get_input_port_by_name(
124 struct bt_component
*component
, const char *name
)
126 struct bt_port
*port
= NULL
;
129 BT_LOGW_STR("Invalid parameter: component is NULL.");
134 BT_LOGW_STR("Invalid parameter: name is NULL.");
138 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
139 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
140 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
141 component
, bt_component_get_name(component
),
142 bt_component_class_type_string(component
->class->type
));
146 /* bt_component_get_input_port_by_name() logs details/errors */
147 port
= bt_component_get_input_port_by_name(component
, name
);
153 struct bt_port
*bt_component_sink_get_input_port_by_index(
154 struct bt_component
*component
, uint64_t index
)
156 struct bt_port
*port
= NULL
;
159 BT_LOGW_STR("Invalid parameter: component is NULL.");
163 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
164 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
165 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
166 component
, bt_component_get_name(component
),
167 bt_component_class_type_string(component
->class->type
));
171 /* bt_component_get_input_port_by_index() logs details/errors */
172 port
= bt_component_get_input_port_by_index(component
, index
);
178 struct bt_private_port
*
179 bt_private_component_sink_get_input_private_port_by_index(
180 struct bt_private_component
*private_component
, uint64_t index
)
182 /* bt_component_sink_get_input_port_by_index() logs details/errors */
183 return bt_private_port_from_port(
184 bt_component_sink_get_input_port_by_index(
185 bt_component_from_private(private_component
), index
));
188 struct bt_private_port
*
189 bt_private_component_sink_get_input_private_port_by_name(
190 struct bt_private_component
*private_component
,
193 /* bt_component_sink_get_input_port_by_name() logs details/errors */
194 return bt_private_port_from_port(
195 bt_component_sink_get_input_port_by_name(
196 bt_component_from_private(private_component
), name
));
199 struct bt_private_port
*bt_private_component_sink_add_input_private_port(
200 struct bt_private_component
*private_component
,
201 const char *name
, void *user_data
)
203 struct bt_port
*port
= NULL
;
204 struct bt_component
*component
=
205 bt_component_from_private(private_component
);
208 BT_LOGW_STR("Invalid parameter: component is NULL.");
212 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
213 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
214 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
215 component
, bt_component_get_name(component
),
216 bt_component_class_type_string(component
->class->type
));
220 /* bt_component_add_input_port() logs details/errors */
221 port
= bt_component_add_input_port(component
, name
, user_data
);
224 return bt_private_port_from_port(port
);