1 #ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
2 #define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #include <babeltrace2/babeltrace-internal.h>
28 #include <babeltrace2/graph/component-const.h>
29 #include <babeltrace2/graph/component-class-internal.h>
30 #include <babeltrace2/graph/port-internal.h>
31 #include <babeltrace2/object-internal.h>
32 #include <babeltrace2/types.h>
33 #include <babeltrace2/assert-internal.h>
37 typedef void (*bt_component_destroy_listener_func
)(
38 struct bt_component
*class, void *data
);
40 struct bt_component_destroy_listener
{
41 bt_component_destroy_listener_func func
;
48 struct bt_object base
;
49 struct bt_component_class
*class;
53 * Internal destroy function specific to a source, filter, or
54 * sink component object.
56 void (*destroy
)(struct bt_component
*);
58 /* User-defined data */
61 /* Input and output ports (weak references) */
62 GPtrArray
*input_ports
;
63 GPtrArray
*output_ports
;
65 /* Array of struct bt_component_destroy_listener */
66 GArray
*destroy_listeners
;
72 struct bt_graph
*bt_component_borrow_graph(struct bt_component
*comp
)
75 return (void *) bt_object_borrow_parent(&comp
->base
);
79 int bt_component_create(struct bt_component_class
*component_class
,
80 const char *name
, struct bt_component
**component
);
83 enum bt_self_component_status
bt_component_accept_port_connection(
84 struct bt_component
*component
, struct bt_port
*self_port
,
85 struct bt_port
*other_port
);
88 enum bt_self_component_status
bt_component_port_connected(
89 struct bt_component
*comp
,
90 struct bt_port
*self_port
, struct bt_port
*other_port
);
93 void bt_component_set_graph(struct bt_component
*component
,
94 struct bt_graph
*graph
);
97 uint64_t bt_component_get_input_port_count(const struct bt_component
*comp
);
100 uint64_t bt_component_get_output_port_count(const struct bt_component
*comp
);
103 struct bt_port_input
*bt_component_borrow_input_port_by_index(
104 struct bt_component
*comp
, uint64_t index
);
107 struct bt_port_output
*bt_component_borrow_output_port_by_index(
108 struct bt_component
*comp
, uint64_t index
);
111 struct bt_port_input
*bt_component_borrow_input_port_by_name(
112 struct bt_component
*comp
, const char *name
);
115 struct bt_port_output
*bt_component_borrow_output_port_by_name(
116 struct bt_component
*comp
, const char *name
);
119 enum bt_self_component_status
bt_component_add_input_port(
120 struct bt_component
*component
, const char *name
,
121 void *user_data
, struct bt_port
**port
);
124 enum bt_self_component_status
bt_component_add_output_port(
125 struct bt_component
*component
, const char *name
,
126 void *user_data
, struct bt_port
**port
);
129 void bt_component_remove_port(struct bt_component
*component
,
130 struct bt_port
*port
);
133 void bt_component_add_destroy_listener(struct bt_component
*component
,
134 bt_component_destroy_listener_func func
, void *data
);
137 void bt_component_remove_destroy_listener(struct bt_component
*component
,
138 bt_component_destroy_listener_func func
, void *data
);
141 const char *bt_self_component_status_string(
142 enum bt_self_component_status status
)
145 case BT_SELF_COMPONENT_STATUS_OK
:
146 return "BT_SELF_COMPONENT_STATUS_OK";
147 case BT_SELF_COMPONENT_STATUS_END
:
148 return "BT_SELF_COMPONENT_STATUS_END";
149 case BT_SELF_COMPONENT_STATUS_AGAIN
:
150 return "BT_SELF_COMPONENT_STATUS_AGAIN";
151 case BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION
:
152 return "BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
153 case BT_SELF_COMPONENT_STATUS_ERROR
:
154 return "BT_SELF_COMPONENT_STATUS_ERROR";
155 case BT_SELF_COMPONENT_STATUS_NOMEM
:
156 return "BT_SELF_COMPONENT_STATUS_NOMEM";
162 #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */