Commit | Line | Data |
---|---|---|
6ac74c0c PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H | |
90354d3a JG |
3 | |
4 | /* | |
90354d3a JG |
5 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
6 | * | |
7 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
8 | * | |
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
10 | * of this software and associated documentation files (the "Software"), to deal | |
11 | * in the Software without restriction, including without limitation the rights | |
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
13 | * copies of the Software, and to permit persons to whom the Software is | |
14 | * furnished to do so, subject to the following conditions: | |
15 | * | |
16 | * The above copyright notice and this permission notice shall be included in | |
17 | * all copies or substantial portions of the Software. | |
18 | * | |
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
25 | * SOFTWARE. | |
26 | */ | |
27 | ||
0db5ca2c | 28 | #include <babeltrace/babeltrace-internal.h> |
0d72b8c3 | 29 | #include <babeltrace/graph/component-const.h> |
b2e0c907 PP |
30 | #include <babeltrace/graph/component-class-internal.h> |
31 | #include <babeltrace/graph/port-internal.h> | |
b8a06801 | 32 | #include <babeltrace/object-internal.h> |
c55a9f58 | 33 | #include <babeltrace/types.h> |
f6ccaed9 | 34 | #include <babeltrace/assert-internal.h> |
0db5ca2c | 35 | #include <glib.h> |
38d02a17 | 36 | #include <stdio.h> |
90354d3a | 37 | |
3230ee6b PP |
38 | typedef void (*bt_component_destroy_listener_func)( |
39 | struct bt_component *class, void *data); | |
40 | ||
41 | struct bt_component_destroy_listener { | |
42 | bt_component_destroy_listener_func func; | |
43 | void *data; | |
44 | }; | |
45 | ||
e5be10ef PP |
46 | struct bt_graph; |
47 | ||
633edee0 | 48 | struct 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 | |
e5be10ef PP |
72 | static inline |
73 | struct bt_graph *bt_component_borrow_graph(struct bt_component *comp) | |
74 | { | |
75 | BT_ASSERT(comp); | |
76 | return (void *) bt_object_borrow_parent(&comp->base); | |
77 | } | |
78 | ||
36712f1d | 79 | BT_HIDDEN |
d94d92ac | 80 | int bt_component_create(struct bt_component_class *component_class, |
36712f1d PP |
81 | const char *name, struct bt_component **component); |
82 | ||
2d41b99e | 83 | BT_HIDDEN |
d94d92ac | 84 | enum bt_self_component_status bt_component_accept_port_connection( |
8f4799f7 PP |
85 | struct bt_component *component, struct bt_port *self_port, |
86 | struct bt_port *other_port); | |
72b913fb | 87 | |
0d8b4d8e | 88 | BT_HIDDEN |
d94d92ac | 89 | enum bt_self_component_status bt_component_port_connected( |
bf55043c | 90 | struct bt_component *comp, |
0d8b4d8e PP |
91 | struct bt_port *self_port, struct bt_port *other_port); |
92 | ||
72b913fb PP |
93 | BT_HIDDEN |
94 | void bt_component_port_disconnected(struct bt_component *comp, | |
95 | struct bt_port *port); | |
2d41b99e | 96 | |
366e034f | 97 | BT_HIDDEN |
f60c8b34 | 98 | void bt_component_set_graph(struct bt_component *component, |
366e034f JG |
99 | struct bt_graph *graph); |
100 | ||
101 | BT_HIDDEN | |
0d72b8c3 | 102 | uint64_t bt_component_get_input_port_count(const struct bt_component *comp); |
366e034f JG |
103 | |
104 | BT_HIDDEN | |
0d72b8c3 | 105 | uint64_t bt_component_get_output_port_count(const struct bt_component *comp); |
366e034f JG |
106 | |
107 | BT_HIDDEN | |
d94d92ac PP |
108 | struct bt_port_input *bt_component_borrow_input_port_by_index( |
109 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
110 | |
111 | BT_HIDDEN | |
d94d92ac PP |
112 | struct bt_port_output *bt_component_borrow_output_port_by_index( |
113 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
114 | |
115 | BT_HIDDEN | |
d94d92ac PP |
116 | struct bt_port_input *bt_component_borrow_input_port_by_name( |
117 | struct bt_component *comp, const char *name); | |
366e034f JG |
118 | |
119 | BT_HIDDEN | |
d94d92ac PP |
120 | struct bt_port_output *bt_component_borrow_output_port_by_name( |
121 | struct bt_component *comp, const char *name); | |
366e034f | 122 | |
72b913fb | 123 | BT_HIDDEN |
d94d92ac | 124 | struct bt_port_input *bt_component_add_input_port( |
3e9b0023 PP |
125 | struct bt_component *component, const char *name, |
126 | void *user_data); | |
72b913fb PP |
127 | |
128 | BT_HIDDEN | |
d94d92ac | 129 | struct bt_port_output *bt_component_add_output_port( |
3e9b0023 PP |
130 | struct bt_component *component, const char *name, |
131 | void *user_data); | |
72b913fb PP |
132 | |
133 | BT_HIDDEN | |
d94d92ac PP |
134 | void bt_component_remove_port(struct bt_component *component, |
135 | struct bt_port *port); | |
72b913fb | 136 | |
3230ee6b PP |
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 | ||
262e5473 | 145 | static inline |
d94d92ac PP |
146 | const char *bt_self_component_status_string( |
147 | enum bt_self_component_status status) | |
262e5473 PP |
148 | { |
149 | switch (status) { | |
d94d92ac PP |
150 | case BT_SELF_COMPONENT_STATUS_OK: |
151 | return "BT_SELF_COMPONENT_STATUS_OK"; | |
152 | case BT_SELF_COMPONENT_STATUS_END: | |
153 | return "BT_SELF_COMPONENT_STATUS_END"; | |
154 | case BT_SELF_COMPONENT_STATUS_AGAIN: | |
155 | return "BT_SELF_COMPONENT_STATUS_AGAIN"; | |
156 | case BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION: | |
157 | return "BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION"; | |
158 | case BT_SELF_COMPONENT_STATUS_ERROR: | |
159 | return "BT_SELF_COMPONENT_STATUS_ERROR"; | |
160 | case BT_SELF_COMPONENT_STATUS_NOMEM: | |
161 | return "BT_SELF_COMPONENT_STATUS_NOMEM"; | |
262e5473 PP |
162 | default: |
163 | return "(unknown)"; | |
164 | } | |
165 | } | |
166 | ||
6ac74c0c | 167 | #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */ |