2 * SPDX-License-Identifier: MIT
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 #define BT_LOG_TAG "LIB/COMPONENT-SINK"
9 #include "lib/logging.h"
11 #include "common/assert.h"
12 #include "lib/assert-cond.h"
13 #include "compat/compiler.h"
14 #include <babeltrace2/value.h>
15 #include <babeltrace2/graph/self-component.h>
16 #include <babeltrace2/graph/component.h>
17 #include <babeltrace2/graph/graph.h>
19 #include "component-sink.h"
20 #include "component.h"
22 #include "lib/func-status.h"
24 struct bt_component
*bt_component_sink_create(void)
26 struct bt_component_sink
*sink
= NULL
;
28 sink
= g_new0(struct bt_component_sink
, 1);
30 BT_LIB_LOGE_APPEND_CAUSE(
31 "Failed to allocate one sink component.");
40 const bt_component_class_sink
*
41 bt_component_sink_borrow_class_const(
42 const bt_component_sink
*component
)
44 struct bt_component_class
*cls
;
46 BT_ASSERT_PRE_DEV_COMP_NON_NULL(component
);
48 cls
= component
->parent
.class;
51 BT_ASSERT_DBG(cls
->type
== BT_COMPONENT_CLASS_TYPE_SINK
);
53 return (bt_component_class_sink
*) cls
;
57 uint64_t bt_component_sink_get_input_port_count(
58 const struct bt_component_sink
*component
)
60 /* bt_component_get_input_port_count() checks preconditions */
61 return bt_component_get_input_port_count((void *) component
, __func__
);
65 const struct bt_port_input
*
66 bt_component_sink_borrow_input_port_by_name_const(
67 const struct bt_component_sink
*component
, const char *name
)
70 * bt_component_borrow_input_port_by_name() logs details/errors
71 * and checks preconditions.
73 return bt_component_borrow_input_port_by_name((void *) component
, name
,
78 struct bt_self_component_port_input
*
79 bt_self_component_sink_borrow_input_port_by_name(
80 struct bt_self_component_sink
*component
, const char *name
)
83 * bt_component_borrow_input_port_by_name() logs details/errors
84 * and checks preconditions.
86 return (void *) bt_component_borrow_input_port_by_name(
87 (void *) component
, name
, __func__
);
91 const struct bt_port_input
*bt_component_sink_borrow_input_port_by_index_const(
92 const struct bt_component_sink
*component
, uint64_t index
)
95 * bt_component_borrow_input_port_by_index() logs details/errors
96 * and checks preconditions.
98 return bt_component_borrow_input_port_by_index(
99 (void *) component
, index
, __func__
);
103 struct bt_self_component_port_input
*
104 bt_self_component_sink_borrow_input_port_by_index(
105 struct bt_self_component_sink
*component
, uint64_t index
)
108 * bt_component_borrow_input_port_by_index() logs details/errors
109 * and checks preconditions.
111 return (void *) bt_component_borrow_input_port_by_index(
112 (void *) component
, index
, __func__
);
116 enum bt_self_component_add_port_status
bt_self_component_sink_add_input_port(
117 struct bt_self_component_sink
*self_comp
,
118 const char *name
, void *user_data
,
119 struct bt_self_component_port_input
**self_port
)
121 enum bt_self_component_add_port_status status
;
122 struct bt_port
*port
= NULL
;
123 struct bt_component
*comp
= (void *) self_comp
;
126 * bt_component_add_input_port() logs details/errors and checks
129 status
= bt_component_add_input_port(comp
, name
, user_data
, &port
,
131 if (status
!= BT_FUNC_STATUS_OK
) {
136 /* Move reference to user */
137 *self_port
= (void *) port
;
141 bt_object_put_ref(port
);
146 bt_bool
bt_self_component_sink_is_interrupted(
147 const struct bt_self_component_sink
*self_comp
)
149 struct bt_component
*comp
= (void *) self_comp
;
151 BT_ASSERT_PRE_COMP_NON_NULL(comp
);
152 return (bt_bool
) bt_graph_is_interrupted(
153 bt_component_borrow_graph(comp
));
157 void bt_component_sink_get_ref(
158 const struct bt_component_sink
*component_sink
)
160 bt_object_get_ref(component_sink
);
164 void bt_component_sink_put_ref(
165 const struct bt_component_sink
*component_sink
)
167 bt_object_put_ref(component_sink
);