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"
25 void bt_component_sink_destroy(struct bt_component
*component
)
30 struct bt_component
*bt_component_sink_create(
31 const struct bt_component_class
*class)
33 struct bt_component_sink
*sink
= NULL
;
35 sink
= g_new0(struct bt_component_sink
, 1);
37 BT_LIB_LOGE_APPEND_CAUSE(
38 "Failed to allocate one sink component.");
46 const bt_component_class_sink
*
47 bt_component_sink_borrow_class_const(
48 const bt_component_sink
*component
)
50 struct bt_component_class
*cls
;
52 BT_ASSERT_PRE_DEV_COMP_NON_NULL(component
);
54 cls
= component
->parent
.class;
57 BT_ASSERT_DBG(cls
->type
== BT_COMPONENT_CLASS_TYPE_SINK
);
59 return (bt_component_class_sink
*) cls
;
62 uint64_t bt_component_sink_get_input_port_count(
63 const struct bt_component_sink
*component
)
65 /* bt_component_get_input_port_count() checks preconditions */
66 return bt_component_get_input_port_count((void *) component
, __func__
);
69 const struct bt_port_input
*
70 bt_component_sink_borrow_input_port_by_name_const(
71 const struct bt_component_sink
*component
, const char *name
)
74 * bt_component_borrow_input_port_by_name() logs details/errors
75 * and checks preconditions.
77 return bt_component_borrow_input_port_by_name((void *) component
, name
,
81 struct bt_self_component_port_input
*
82 bt_self_component_sink_borrow_input_port_by_name(
83 struct bt_self_component_sink
*component
, const char *name
)
86 * bt_component_borrow_input_port_by_name() logs details/errors
87 * and checks preconditions.
89 return (void *) bt_component_borrow_input_port_by_name(
90 (void *) component
, name
, __func__
);
93 const struct bt_port_input
*bt_component_sink_borrow_input_port_by_index_const(
94 const struct bt_component_sink
*component
, uint64_t index
)
97 * bt_component_borrow_input_port_by_index() logs details/errors
98 * and checks preconditions.
100 return bt_component_borrow_input_port_by_index(
101 (void *) component
, index
, __func__
);
104 struct bt_self_component_port_input
*
105 bt_self_component_sink_borrow_input_port_by_index(
106 struct bt_self_component_sink
*component
, uint64_t index
)
109 * bt_component_borrow_input_port_by_index() logs details/errors
110 * and checks preconditions.
112 return (void *) bt_component_borrow_input_port_by_index(
113 (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
;
125 BT_ASSERT_PRE_NO_ERROR();
128 * bt_component_add_input_port() logs details/errors and checks
131 status
= bt_component_add_input_port(comp
, name
, user_data
, &port
,
133 if (status
!= BT_FUNC_STATUS_OK
) {
138 /* Move reference to user */
139 *self_port
= (void *) port
;
143 bt_object_put_ref(port
);
147 bt_bool
bt_self_component_sink_is_interrupted(
148 const struct bt_self_component_sink
*self_comp
)
150 struct bt_component
*comp
= (void *) self_comp
;
152 BT_ASSERT_PRE_COMP_NON_NULL(comp
);
153 return (bt_bool
) bt_graph_is_interrupted(
154 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
);
163 void bt_component_sink_put_ref(
164 const struct bt_component_sink
*component_sink
)
166 bt_object_put_ref(component_sink
);