lib: use object pool for event and packet notifications
[babeltrace.git] / include / babeltrace / graph / component-internal.h
CommitLineData
6ac74c0c
PP
1#ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
2#define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H
90354d3a
JG
3
4/*
633edee0 5 * BabelTrace - Component internal
90354d3a
JG
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
0db5ca2c 30#include <babeltrace/babeltrace-internal.h>
b2e0c907
PP
31#include <babeltrace/graph/component.h>
32#include <babeltrace/graph/component-class-internal.h>
33#include <babeltrace/graph/port-internal.h>
b8a06801 34#include <babeltrace/object-internal.h>
c55a9f58 35#include <babeltrace/types.h>
f6ccaed9 36#include <babeltrace/assert-internal.h>
0db5ca2c 37#include <glib.h>
38d02a17 38#include <stdio.h>
90354d3a 39
3230ee6b
PP
40typedef void (*bt_component_destroy_listener_func)(
41 struct bt_component *class, void *data);
42
43struct bt_component_destroy_listener {
44 bt_component_destroy_listener_func func;
45 void *data;
46};
47
633edee0 48struct bt_component {
b8a06801 49 struct bt_object base;
fb2dcc52 50 struct bt_component_class *class;
0db5ca2c 51 GString *name;
584e4e78 52
72b913fb 53 /*
d3e4dcd8
PP
54 * Internal destroy function specific to a source, filter, or
55 * sink component object.
56 */
890882ef 57 void (*destroy)(struct bt_component *);
d3e4dcd8 58
72b913fb 59 /* User-defined data */
0777b693 60 void *user_data;
fec2a9f2 61
72b913fb
PP
62 /* Input and output ports (weak references) */
63 GPtrArray *input_ports;
64 GPtrArray *output_ports;
3230ee6b
PP
65
66 /* Array of struct bt_component_destroy_listener */
67 GArray *destroy_listeners;
36712f1d
PP
68
69 bool initialized;
72b913fb 70};
38b48196 71
890882ef
PP
72static inline
73struct bt_private_component *bt_private_component_from_component(
74 struct bt_component *component)
75{
76 return (void *) component;
77}
5645cd95 78
36712f1d
PP
79BT_HIDDEN
80enum bt_component_status bt_component_create(
81 struct bt_component_class *component_class,
82 const char *name, struct bt_component **component);
83
2d41b99e 84BT_HIDDEN
72b913fb 85enum bt_component_status bt_component_accept_port_connection(
8f4799f7
PP
86 struct bt_component *component, struct bt_port *self_port,
87 struct bt_port *other_port);
72b913fb 88
0d8b4d8e
PP
89BT_HIDDEN
90void bt_component_port_connected(struct bt_component *comp,
91 struct bt_port *self_port, struct bt_port *other_port);
92
72b913fb
PP
93BT_HIDDEN
94void bt_component_port_disconnected(struct bt_component *comp,
95 struct bt_port *port);
2d41b99e 96
366e034f 97BT_HIDDEN
f60c8b34 98void bt_component_set_graph(struct bt_component *component,
366e034f
JG
99 struct bt_graph *graph);
100
101BT_HIDDEN
544d0515 102int64_t bt_component_get_input_port_count(struct bt_component *comp);
366e034f
JG
103
104BT_HIDDEN
544d0515 105int64_t bt_component_get_output_port_count(struct bt_component *comp);
366e034f
JG
106
107BT_HIDDEN
9ac68eb1
PP
108struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp,
109 uint64_t index);
366e034f
JG
110
111BT_HIDDEN
9ac68eb1
PP
112struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp,
113 uint64_t index);
366e034f
JG
114
115BT_HIDDEN
9ac68eb1 116struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp,
72b913fb 117 const char *name);
366e034f
JG
118
119BT_HIDDEN
9ac68eb1 120struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp,
366e034f
JG
121 const char *name);
122
72b913fb
PP
123BT_HIDDEN
124struct bt_port *bt_component_add_input_port(
3e9b0023
PP
125 struct bt_component *component, const char *name,
126 void *user_data);
72b913fb
PP
127
128BT_HIDDEN
129struct bt_port *bt_component_add_output_port(
3e9b0023
PP
130 struct bt_component *component, const char *name,
131 void *user_data);
72b913fb
PP
132
133BT_HIDDEN
134enum bt_component_status bt_component_remove_port(
135 struct bt_component *component, struct bt_port *port);
136
3230ee6b
PP
137BT_HIDDEN
138void bt_component_add_destroy_listener(struct bt_component *component,
139 bt_component_destroy_listener_func func, void *data);
140
141BT_HIDDEN
142void bt_component_remove_destroy_listener(struct bt_component *component,
143 bt_component_destroy_listener_func func, void *data);
144
262e5473
PP
145static inline
146const 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";
bd7cc15b
PP
167 case BT_COMPONENT_STATUS_GRAPH_IS_CANCELED:
168 return "BT_COMPONENT_STATUS_GRAPH_IS_CANCELED";
262e5473
PP
169 default:
170 return "(unknown)";
171 }
172}
173
6ac74c0c 174#endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */
This page took 0.049645 seconds and 4 git commands to generate.