Commit | Line | Data |
---|---|---|
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 |
37 | typedef void (*bt_component_destroy_listener_func)( |
38 | struct bt_component *class, void *data); | |
39 | ||
40 | struct bt_component_destroy_listener { | |
41 | bt_component_destroy_listener_func func; | |
42 | void *data; | |
43 | }; | |
44 | ||
e5be10ef PP |
45 | struct bt_graph; |
46 | ||
633edee0 | 47 | struct 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 |
71 | static inline |
72 | struct 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 | 78 | BT_HIDDEN |
d94d92ac | 79 | int bt_component_create(struct bt_component_class *component_class, |
36712f1d PP |
80 | const char *name, struct bt_component **component); |
81 | ||
2d41b99e | 82 | BT_HIDDEN |
d94d92ac | 83 | enum 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 | 87 | BT_HIDDEN |
d94d92ac | 88 | enum 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 | 92 | BT_HIDDEN |
f60c8b34 | 93 | void bt_component_set_graph(struct bt_component *component, |
366e034f JG |
94 | struct bt_graph *graph); |
95 | ||
96 | BT_HIDDEN | |
0d72b8c3 | 97 | uint64_t bt_component_get_input_port_count(const struct bt_component *comp); |
366e034f JG |
98 | |
99 | BT_HIDDEN | |
0d72b8c3 | 100 | uint64_t bt_component_get_output_port_count(const struct bt_component *comp); |
366e034f JG |
101 | |
102 | BT_HIDDEN | |
d94d92ac PP |
103 | struct bt_port_input *bt_component_borrow_input_port_by_index( |
104 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
105 | |
106 | BT_HIDDEN | |
d94d92ac PP |
107 | struct bt_port_output *bt_component_borrow_output_port_by_index( |
108 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
109 | |
110 | BT_HIDDEN | |
d94d92ac PP |
111 | struct bt_port_input *bt_component_borrow_input_port_by_name( |
112 | struct bt_component *comp, const char *name); | |
366e034f JG |
113 | |
114 | BT_HIDDEN | |
d94d92ac PP |
115 | struct bt_port_output *bt_component_borrow_output_port_by_name( |
116 | struct bt_component *comp, const char *name); | |
366e034f | 117 | |
72b913fb | 118 | BT_HIDDEN |
8cc56726 | 119 | enum bt_self_component_status bt_component_add_input_port( |
3e9b0023 | 120 | struct bt_component *component, const char *name, |
8cc56726 | 121 | void *user_data, struct bt_port **port); |
72b913fb PP |
122 | |
123 | BT_HIDDEN | |
8cc56726 | 124 | enum bt_self_component_status bt_component_add_output_port( |
3e9b0023 | 125 | struct bt_component *component, const char *name, |
8cc56726 | 126 | void *user_data, struct bt_port **port); |
72b913fb PP |
127 | |
128 | BT_HIDDEN | |
d94d92ac PP |
129 | void bt_component_remove_port(struct bt_component *component, |
130 | struct bt_port *port); | |
72b913fb | 131 | |
3230ee6b PP |
132 | BT_HIDDEN |
133 | void bt_component_add_destroy_listener(struct bt_component *component, | |
134 | bt_component_destroy_listener_func func, void *data); | |
135 | ||
136 | BT_HIDDEN | |
137 | void bt_component_remove_destroy_listener(struct bt_component *component, | |
138 | bt_component_destroy_listener_func func, void *data); | |
139 | ||
262e5473 | 140 | static inline |
d94d92ac PP |
141 | const 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 */ |