Commit | Line | Data |
---|---|---|
de713ce0 JG |
1 | /* |
2 | * component.c | |
3 | * | |
4 | * Babeltrace Plugin Component | |
5 | * | |
6 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
7 | * | |
8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * | |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
29 | #include <babeltrace/plugin/component-internal.h> | |
30 | #include <babeltrace/babeltrace-internal.h> | |
31 | #include <babeltrace/compiler.h> | |
32 | ||
33 | static void bt_component_destroy(struct bt_ctf_ref *ref); | |
34 | ||
35 | const char *bt_component_get_name(struct bt_component *component) | |
36 | { | |
37 | const char *ret = NULL; | |
38 | ||
39 | if (!component) { | |
40 | goto end; | |
41 | } | |
42 | ||
43 | ret = component->name->str; | |
44 | end: | |
45 | return ret; | |
46 | } | |
47 | ||
48 | enum bt_component_status bt_component_set_name(struct bt_component *component, | |
49 | const char *name) | |
50 | { | |
51 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
52 | ||
53 | if (!component || !name || name[0] == '\0') { | |
54 | ret = BT_COMPONENT_STATUS_INVAL; | |
55 | goto end; | |
56 | } | |
57 | ||
58 | g_string_assign(component->name, name); | |
59 | end: | |
60 | return ret; | |
61 | } | |
62 | ||
63 | enum bt_component_type bt_component_get_type(struct bt_component *component) | |
64 | { | |
65 | enum bt_component_type type = BT_COMPONENT_TYPE_UNKNOWN; | |
66 | ||
67 | if (!component) { | |
68 | goto end; | |
69 | } | |
70 | ||
71 | type = component->type; | |
72 | end: | |
73 | return type; | |
74 | } | |
75 | ||
76 | enum bt_component_status bt_component_set_error_stream( | |
77 | struct bt_component *component, FILE *stream) | |
78 | { | |
79 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
80 | ||
81 | if (!component) { | |
82 | ret = BT_COMPONENT_STATUS_INVAL; | |
83 | goto end; | |
84 | } | |
85 | ||
86 | component->error_stream = stream; | |
87 | end: | |
88 | return ret; | |
89 | } | |
90 | ||
91 | void bt_component_get(struct bt_component *component) | |
92 | { | |
93 | if (!component) { | |
94 | return; | |
95 | } | |
96 | ||
97 | bt_ctf_ref_get(&component->ref_count); | |
98 | } | |
99 | ||
100 | void bt_component_put(struct bt_component *component) | |
101 | { | |
102 | if (!component) { | |
103 | return; | |
104 | } | |
105 | ||
106 | bt_ctf_ref_put(&component->ref_count, bt_component_destroy); | |
107 | } | |
108 | ||
109 | BT_HIDDEN | |
0d884c50 JG |
110 | enum bt_component_status bt_component_init(struct bt_component *component, |
111 | const char *name, void *user_data, | |
112 | bt_component_destroy_cb user_destroy_func, | |
de713ce0 JG |
113 | enum bt_component_type component_type, |
114 | bt_component_destroy_cb component_destroy) | |
115 | { | |
116 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
117 | ||
118 | if (!component || !name || name[0] == '\0' || | |
119 | !user_destroy_func || !user_data || !component_destroy) { | |
120 | ret = BT_COMPONENT_STATUS_INVAL; | |
121 | goto end; | |
122 | } | |
123 | ||
124 | bt_ctf_ref_init(&component->ref_count); | |
125 | component->type = component_type; | |
126 | component->user_data = user_data; | |
127 | component->user_data_destroy = user_destroy_func; | |
128 | component->destroy = component_destroy; | |
129 | ||
130 | component->name = g_string_new(name); | |
131 | if (!component->name) { | |
132 | ret = BT_COMPONENT_STATUS_NOMEM; | |
133 | goto end; | |
134 | } | |
135 | end: | |
136 | return ret; | |
137 | } | |
138 | ||
139 | void *bt_component_get_private_data(struct bt_component *component) | |
140 | { | |
0d884c50 | 141 | void *ret = NULL; |
de713ce0 JG |
142 | |
143 | if (!component) { | |
144 | goto end; | |
145 | } | |
146 | ||
147 | ret = component->user_data; | |
148 | end: | |
149 | return ret; | |
150 | } | |
151 | ||
152 | enum bt_component_status | |
153 | bt_component_set_private_data(struct bt_component *component, | |
154 | void *data) | |
155 | { | |
156 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
157 | ||
158 | if (!component) { | |
159 | ret = BT_COMPONENT_STATUS_INVAL; | |
160 | goto end; | |
161 | } | |
162 | ||
163 | component->user_data = data; | |
164 | end: | |
165 | return ret; | |
166 | } | |
167 | ||
168 | static | |
169 | void bt_component_destroy(struct bt_ctf_ref *ref) | |
170 | { | |
171 | struct bt_component *component = NULL; | |
172 | ||
173 | if (!ref) { | |
174 | return; | |
175 | } | |
176 | ||
177 | component = container_of(ref, struct bt_component, ref_count); | |
178 | ||
179 | /** | |
180 | * User data is destroyed first, followed by the concrete component | |
181 | * instance. | |
182 | */ | |
183 | assert(!component->user_data || component->user_data_destroy); | |
184 | component->user_data_destroy(component->user_data); | |
185 | ||
186 | g_string_free(component->name, TRUE); | |
187 | ||
188 | assert(component->destroy); | |
189 | component->destroy(component); | |
190 | } |