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 "common/macros.h"
28 #include <babeltrace2/graph/component-const.h>
29 #include "lib/object.h"
30 #include <babeltrace2/types.h>
31 #include "common/assert.h"
35 #include "component-class.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_set_graph(struct bt_component
*component
,
95 struct bt_graph
*graph
);
98 uint64_t bt_component_get_input_port_count(const struct bt_component
*comp
);
101 uint64_t bt_component_get_output_port_count(const struct bt_component
*comp
);
104 struct bt_port_input
*bt_component_borrow_input_port_by_index(
105 struct bt_component
*comp
, uint64_t index
);
108 struct bt_port_output
*bt_component_borrow_output_port_by_index(
109 struct bt_component
*comp
, uint64_t index
);
112 struct bt_port_input
*bt_component_borrow_input_port_by_name(
113 struct bt_component
*comp
, const char *name
);
116 struct bt_port_output
*bt_component_borrow_output_port_by_name(
117 struct bt_component
*comp
, const char *name
);
120 enum bt_self_component_status
bt_component_add_input_port(
121 struct bt_component
*component
, const char *name
,
122 void *user_data
, struct bt_port
**port
);
125 enum bt_self_component_status
bt_component_add_output_port(
126 struct bt_component
*component
, const char *name
,
127 void *user_data
, struct bt_port
**port
);
130 void bt_component_remove_port(struct bt_component
*component
,
131 struct bt_port
*port
);
134 void bt_component_add_destroy_listener(struct bt_component
*component
,
135 bt_component_destroy_listener_func func
, void *data
);
138 void bt_component_remove_destroy_listener(struct bt_component
*component
,
139 bt_component_destroy_listener_func func
, void *data
);
142 const char *bt_self_component_status_string(
143 enum bt_self_component_status status
)
146 case BT_SELF_COMPONENT_STATUS_OK
:
147 return "BT_SELF_COMPONENT_STATUS_OK";
148 case BT_SELF_COMPONENT_STATUS_END
:
149 return "BT_SELF_COMPONENT_STATUS_END";
150 case BT_SELF_COMPONENT_STATUS_AGAIN
:
151 return "BT_SELF_COMPONENT_STATUS_AGAIN";
152 case BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION
:
153 return "BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
154 case BT_SELF_COMPONENT_STATUS_ERROR
:
155 return "BT_SELF_COMPONENT_STATUS_ERROR";
156 case BT_SELF_COMPONENT_STATUS_NOMEM
:
157 return "BT_SELF_COMPONENT_STATUS_NOMEM";
163 #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */