1 #ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
2 #define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
5 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 #include <babeltrace/babeltrace-internal.h>
29 #include <babeltrace/graph/component.h>
30 #include <babeltrace/graph/component-class-internal.h>
31 #include <babeltrace/graph/port-internal.h>
32 #include <babeltrace/object-internal.h>
33 #include <babeltrace/types.h>
34 #include <babeltrace/assert-internal.h>
38 typedef void (*bt_component_destroy_listener_func
)(
39 struct bt_component
*class, void *data
);
41 struct bt_component_destroy_listener
{
42 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_graph
*bt_component_borrow_graph(struct bt_component
*comp
)
76 return (void *) bt_object_borrow_parent(&comp
->base
);
80 int bt_component_create(struct bt_component_class
*component_class
,
81 const char *name
, struct bt_component
**component
);
84 enum bt_self_component_status
bt_component_accept_port_connection(
85 struct bt_component
*component
, struct bt_port
*self_port
,
86 struct bt_port
*other_port
);
89 enum bt_self_component_status
bt_component_port_connected(
90 struct bt_component
*comp
,
91 struct bt_port
*self_port
, struct bt_port
*other_port
);
94 void bt_component_port_disconnected(struct bt_component
*comp
,
95 struct bt_port
*port
);
98 void bt_component_set_graph(struct bt_component
*component
,
99 struct bt_graph
*graph
);
102 uint64_t bt_component_get_input_port_count(struct bt_component
*comp
);
105 uint64_t bt_component_get_output_port_count(struct bt_component
*comp
);
108 struct bt_port_input
*bt_component_borrow_input_port_by_index(
109 struct bt_component
*comp
, uint64_t index
);
112 struct bt_port_output
*bt_component_borrow_output_port_by_index(
113 struct bt_component
*comp
, uint64_t index
);
116 struct bt_port_input
*bt_component_borrow_input_port_by_name(
117 struct bt_component
*comp
, const char *name
);
120 struct bt_port_output
*bt_component_borrow_output_port_by_name(
121 struct bt_component
*comp
, const char *name
);
124 struct bt_port_input
*bt_component_add_input_port(
125 struct bt_component
*component
, const char *name
,
129 struct bt_port_output
*bt_component_add_output_port(
130 struct bt_component
*component
, const char *name
,
134 void bt_component_remove_port(struct bt_component
*component
,
135 struct bt_port
*port
);
138 void bt_component_add_destroy_listener(struct bt_component
*component
,
139 bt_component_destroy_listener_func func
, void *data
);
142 void bt_component_remove_destroy_listener(struct bt_component
*component
,
143 bt_component_destroy_listener_func func
, void *data
);
146 const char *bt_self_component_status_string(
147 enum bt_self_component_status status
)
150 case BT_SELF_COMPONENT_STATUS_OK
:
151 return "BT_SELF_COMPONENT_STATUS_OK";
152 case BT_SELF_COMPONENT_STATUS_END
:
153 return "BT_SELF_COMPONENT_STATUS_END";
154 case BT_SELF_COMPONENT_STATUS_AGAIN
:
155 return "BT_SELF_COMPONENT_STATUS_AGAIN";
156 case BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION
:
157 return "BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
158 case BT_SELF_COMPONENT_STATUS_ERROR
:
159 return "BT_SELF_COMPONENT_STATUS_ERROR";
160 case BT_SELF_COMPONENT_STATUS_NOMEM
:
161 return "BT_SELF_COMPONENT_STATUS_NOMEM";
167 #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */