lib: fully configure graph (add components, connect ports), then run
[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/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
90354d3a
JG
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
90354d3a
JG
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:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
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
24 * SOFTWARE.
25 */
26
0db5ca2c 27#include <babeltrace/babeltrace-internal.h>
0d72b8c3 28#include <babeltrace/graph/component-const.h>
b2e0c907
PP
29#include <babeltrace/graph/component-class-internal.h>
30#include <babeltrace/graph/port-internal.h>
b8a06801 31#include <babeltrace/object-internal.h>
c55a9f58 32#include <babeltrace/types.h>
f6ccaed9 33#include <babeltrace/assert-internal.h>
0db5ca2c 34#include <glib.h>
38d02a17 35#include <stdio.h>
90354d3a 36
3230ee6b
PP
37typedef void (*bt_component_destroy_listener_func)(
38 struct bt_component *class, void *data);
39
40struct bt_component_destroy_listener {
41 bt_component_destroy_listener_func func;
42 void *data;
43};
44
e5be10ef
PP
45struct bt_graph;
46
633edee0 47struct bt_component {
b8a06801 48 struct bt_object base;
fb2dcc52 49 struct bt_component_class *class;
0db5ca2c 50 GString *name;
584e4e78 51
72b913fb 52 /*
d3e4dcd8
PP
53 * Internal destroy function specific to a source, filter, or
54 * sink component object.
55 */
890882ef 56 void (*destroy)(struct bt_component *);
d3e4dcd8 57
72b913fb 58 /* User-defined data */
0777b693 59 void *user_data;
fec2a9f2 60
72b913fb
PP
61 /* Input and output ports (weak references) */
62 GPtrArray *input_ports;
63 GPtrArray *output_ports;
3230ee6b
PP
64
65 /* Array of struct bt_component_destroy_listener */
66 GArray *destroy_listeners;
36712f1d
PP
67
68 bool initialized;
72b913fb 69};
38b48196 70
e5be10ef
PP
71static inline
72struct bt_graph *bt_component_borrow_graph(struct bt_component *comp)
73{
74 BT_ASSERT(comp);
75 return (void *) bt_object_borrow_parent(&comp->base);
76}
77
36712f1d 78BT_HIDDEN
d94d92ac 79int bt_component_create(struct bt_component_class *component_class,
36712f1d
PP
80 const char *name, struct bt_component **component);
81
2d41b99e 82BT_HIDDEN
d94d92ac 83enum bt_self_component_status bt_component_accept_port_connection(
8f4799f7
PP
84 struct bt_component *component, struct bt_port *self_port,
85 struct bt_port *other_port);
72b913fb 86
0d8b4d8e 87BT_HIDDEN
d94d92ac 88enum bt_self_component_status bt_component_port_connected(
bf55043c 89 struct bt_component *comp,
0d8b4d8e
PP
90 struct bt_port *self_port, struct bt_port *other_port);
91
366e034f 92BT_HIDDEN
f60c8b34 93void bt_component_set_graph(struct bt_component *component,
366e034f
JG
94 struct bt_graph *graph);
95
96BT_HIDDEN
0d72b8c3 97uint64_t bt_component_get_input_port_count(const struct bt_component *comp);
366e034f
JG
98
99BT_HIDDEN
0d72b8c3 100uint64_t bt_component_get_output_port_count(const struct bt_component *comp);
366e034f
JG
101
102BT_HIDDEN
d94d92ac
PP
103struct bt_port_input *bt_component_borrow_input_port_by_index(
104 struct bt_component *comp, uint64_t index);
366e034f
JG
105
106BT_HIDDEN
d94d92ac
PP
107struct bt_port_output *bt_component_borrow_output_port_by_index(
108 struct bt_component *comp, uint64_t index);
366e034f
JG
109
110BT_HIDDEN
d94d92ac
PP
111struct bt_port_input *bt_component_borrow_input_port_by_name(
112 struct bt_component *comp, const char *name);
366e034f
JG
113
114BT_HIDDEN
d94d92ac
PP
115struct bt_port_output *bt_component_borrow_output_port_by_name(
116 struct bt_component *comp, const char *name);
366e034f 117
72b913fb 118BT_HIDDEN
d94d92ac 119struct bt_port_input *bt_component_add_input_port(
3e9b0023
PP
120 struct bt_component *component, const char *name,
121 void *user_data);
72b913fb
PP
122
123BT_HIDDEN
d94d92ac 124struct bt_port_output *bt_component_add_output_port(
3e9b0023
PP
125 struct bt_component *component, const char *name,
126 void *user_data);
72b913fb
PP
127
128BT_HIDDEN
d94d92ac
PP
129void bt_component_remove_port(struct bt_component *component,
130 struct bt_port *port);
72b913fb 131
3230ee6b
PP
132BT_HIDDEN
133void bt_component_add_destroy_listener(struct bt_component *component,
134 bt_component_destroy_listener_func func, void *data);
135
136BT_HIDDEN
137void bt_component_remove_destroy_listener(struct bt_component *component,
138 bt_component_destroy_listener_func func, void *data);
139
262e5473 140static inline
d94d92ac
PP
141const char *bt_self_component_status_string(
142 enum bt_self_component_status status)
262e5473
PP
143{
144 switch (status) {
d94d92ac
PP
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";
262e5473
PP
157 default:
158 return "(unknown)";
159 }
160}
161
6ac74c0c 162#endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */
This page took 0.051808 seconds and 4 git commands to generate.