lib: use object pool for event and packet notifications
[babeltrace.git] / include / babeltrace / graph / component-internal.h
1 #ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
2 #define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
3
4 /*
5 * BabelTrace - Component internal
6 *
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 *
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:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
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
27 * SOFTWARE.
28 */
29
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>
37 #include <glib.h>
38 #include <stdio.h>
39
40 typedef void (*bt_component_destroy_listener_func)(
41 struct bt_component *class, void *data);
42
43 struct bt_component_destroy_listener {
44 bt_component_destroy_listener_func func;
45 void *data;
46 };
47
48 struct bt_component {
49 struct bt_object base;
50 struct bt_component_class *class;
51 GString *name;
52
53 /*
54 * Internal destroy function specific to a source, filter, or
55 * sink component object.
56 */
57 void (*destroy)(struct bt_component *);
58
59 /* User-defined data */
60 void *user_data;
61
62 /* Input and output ports (weak references) */
63 GPtrArray *input_ports;
64 GPtrArray *output_ports;
65
66 /* Array of struct bt_component_destroy_listener */
67 GArray *destroy_listeners;
68
69 bool initialized;
70 };
71
72 static inline
73 struct bt_private_component *bt_private_component_from_component(
74 struct bt_component *component)
75 {
76 return (void *) component;
77 }
78
79 BT_HIDDEN
80 enum bt_component_status bt_component_create(
81 struct bt_component_class *component_class,
82 const char *name, struct bt_component **component);
83
84 BT_HIDDEN
85 enum bt_component_status bt_component_accept_port_connection(
86 struct bt_component *component, struct bt_port *self_port,
87 struct bt_port *other_port);
88
89 BT_HIDDEN
90 void bt_component_port_connected(struct bt_component *comp,
91 struct bt_port *self_port, struct bt_port *other_port);
92
93 BT_HIDDEN
94 void bt_component_port_disconnected(struct bt_component *comp,
95 struct bt_port *port);
96
97 BT_HIDDEN
98 void bt_component_set_graph(struct bt_component *component,
99 struct bt_graph *graph);
100
101 BT_HIDDEN
102 int64_t bt_component_get_input_port_count(struct bt_component *comp);
103
104 BT_HIDDEN
105 int64_t bt_component_get_output_port_count(struct bt_component *comp);
106
107 BT_HIDDEN
108 struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp,
109 uint64_t index);
110
111 BT_HIDDEN
112 struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp,
113 uint64_t index);
114
115 BT_HIDDEN
116 struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp,
117 const char *name);
118
119 BT_HIDDEN
120 struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp,
121 const char *name);
122
123 BT_HIDDEN
124 struct bt_port *bt_component_add_input_port(
125 struct bt_component *component, const char *name,
126 void *user_data);
127
128 BT_HIDDEN
129 struct bt_port *bt_component_add_output_port(
130 struct bt_component *component, const char *name,
131 void *user_data);
132
133 BT_HIDDEN
134 enum bt_component_status bt_component_remove_port(
135 struct bt_component *component, struct bt_port *port);
136
137 BT_HIDDEN
138 void bt_component_add_destroy_listener(struct bt_component *component,
139 bt_component_destroy_listener_func func, void *data);
140
141 BT_HIDDEN
142 void bt_component_remove_destroy_listener(struct bt_component *component,
143 bt_component_destroy_listener_func func, void *data);
144
145 static inline
146 const char *bt_component_status_string(enum bt_component_status status)
147 {
148 switch (status) {
149 case BT_COMPONENT_STATUS_OK:
150 return "BT_COMPONENT_STATUS_OK";
151 case BT_COMPONENT_STATUS_END:
152 return "BT_COMPONENT_STATUS_END";
153 case BT_COMPONENT_STATUS_AGAIN:
154 return "BT_COMPONENT_STATUS_AGAIN";
155 case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
156 return "BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION";
157 case BT_COMPONENT_STATUS_ERROR:
158 return "BT_COMPONENT_STATUS_ERROR";
159 case BT_COMPONENT_STATUS_UNSUPPORTED:
160 return "BT_COMPONENT_STATUS_UNSUPPORTED";
161 case BT_COMPONENT_STATUS_INVALID:
162 return "BT_COMPONENT_STATUS_INVALID";
163 case BT_COMPONENT_STATUS_NOMEM:
164 return "BT_COMPONENT_STATUS_NOMEM";
165 case BT_COMPONENT_STATUS_NOT_FOUND:
166 return "BT_COMPONENT_STATUS_NOT_FOUND";
167 case BT_COMPONENT_STATUS_GRAPH_IS_CANCELED:
168 return "BT_COMPONENT_STATUS_GRAPH_IS_CANCELED";
169 default:
170 return "(unknown)";
171 }
172 }
173
174 #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */
This page took 0.033745 seconds and 4 git commands to generate.