1 #ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
2 #define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
5 * BabelTrace - Component internal
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 #include <babeltrace/babeltrace-internal.h>
31 #include <babeltrace/graph/component.h>
32 #include <babeltrace/graph/component-class-internal.h>
33 #include <babeltrace/graph/port-internal.h>
34 #include <babeltrace/object-internal.h>
35 #include <babeltrace/types.h>
36 #include <babeltrace/assert-internal.h>
40 typedef void (*bt_component_destroy_listener_func
)(
41 struct bt_component
*class, void *data
);
43 struct bt_component_destroy_listener
{
44 bt_component_destroy_listener_func func
;
49 struct bt_object base
;
50 struct bt_component_class
*class;
54 * Internal destroy function specific to a source, filter, or
55 * sink component object.
57 void (*destroy
)(struct bt_component
*);
59 /* User-defined data */
62 /* Input and output ports (weak references) */
63 GPtrArray
*input_ports
;
64 GPtrArray
*output_ports
;
66 /* Array of struct bt_component_destroy_listener */
67 GArray
*destroy_listeners
;
73 struct bt_component
*bt_component_borrow_from_private(
74 struct bt_private_component
*private_component
)
76 return (void *) private_component
;
80 struct bt_private_component
*bt_private_component_from_component(
81 struct bt_component
*component
)
83 return (void *) component
;
87 struct bt_graph
*bt_component_borrow_graph(struct bt_component
*comp
)
90 return (void *) comp
->base
.parent
;
94 enum bt_component_status
bt_component_create(
95 struct bt_component_class
*component_class
,
96 const char *name
, struct bt_component
**component
);
99 enum bt_component_status
bt_component_accept_port_connection(
100 struct bt_component
*component
, struct bt_port
*self_port
,
101 struct bt_port
*other_port
);
104 void bt_component_port_connected(struct bt_component
*comp
,
105 struct bt_port
*self_port
, struct bt_port
*other_port
);
108 void bt_component_port_disconnected(struct bt_component
*comp
,
109 struct bt_port
*port
);
112 void bt_component_set_graph(struct bt_component
*component
,
113 struct bt_graph
*graph
);
116 int64_t bt_component_get_input_port_count(struct bt_component
*comp
);
119 int64_t bt_component_get_output_port_count(struct bt_component
*comp
);
122 struct bt_port
*bt_component_get_input_port_by_index(struct bt_component
*comp
,
126 struct bt_port
*bt_component_get_output_port_by_index(struct bt_component
*comp
,
130 struct bt_port
*bt_component_get_input_port_by_name(struct bt_component
*comp
,
134 struct bt_port
*bt_component_get_output_port_by_name(struct bt_component
*comp
,
138 struct bt_port
*bt_component_add_input_port(
139 struct bt_component
*component
, const char *name
,
143 struct bt_port
*bt_component_add_output_port(
144 struct bt_component
*component
, const char *name
,
148 enum bt_component_status
bt_component_remove_port(
149 struct bt_component
*component
, struct bt_port
*port
);
152 void bt_component_add_destroy_listener(struct bt_component
*component
,
153 bt_component_destroy_listener_func func
, void *data
);
156 void bt_component_remove_destroy_listener(struct bt_component
*component
,
157 bt_component_destroy_listener_func func
, void *data
);
160 const char *bt_component_status_string(enum bt_component_status status
)
163 case BT_COMPONENT_STATUS_OK
:
164 return "BT_COMPONENT_STATUS_OK";
165 case BT_COMPONENT_STATUS_END
:
166 return "BT_COMPONENT_STATUS_END";
167 case BT_COMPONENT_STATUS_AGAIN
:
168 return "BT_COMPONENT_STATUS_AGAIN";
169 case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION
:
170 return "BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
171 case BT_COMPONENT_STATUS_ERROR
:
172 return "BT_COMPONENT_STATUS_ERROR";
173 case BT_COMPONENT_STATUS_UNSUPPORTED
:
174 return "BT_COMPONENT_STATUS_UNSUPPORTED";
175 case BT_COMPONENT_STATUS_INVALID
:
176 return "BT_COMPONENT_STATUS_INVALID";
177 case BT_COMPONENT_STATUS_NOMEM
:
178 return "BT_COMPONENT_STATUS_NOMEM";
179 case BT_COMPONENT_STATUS_NOT_FOUND
:
180 return "BT_COMPONENT_STATUS_NOT_FOUND";
181 case BT_COMPONENT_STATUS_GRAPH_IS_CANCELED
:
182 return "BT_COMPONENT_STATUS_GRAPH_IS_CANCELED";
188 #endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */