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 | ||
47e5a032 | 29 | #include <babeltrace/plugin/component.h> |
de713ce0 JG |
30 | #include <babeltrace/plugin/component-internal.h> |
31 | #include <babeltrace/babeltrace-internal.h> | |
32 | #include <babeltrace/compiler.h> | |
b8a06801 | 33 | #include <babeltrace/ref.h> |
de713ce0 | 34 | |
b8a06801 JG |
35 | static |
36 | void bt_component_destroy(struct bt_object *obj) | |
37 | { | |
38 | struct bt_component *component = NULL; | |
39 | struct bt_component_class *component_class = NULL; | |
40 | ||
41 | if (!obj) { | |
42 | return; | |
43 | } | |
44 | ||
45 | component = container_of(obj, struct bt_component, base); | |
46 | ||
47 | /** | |
48 | * User data is destroyed first, followed by the concrete component | |
49 | * instance. | |
50 | */ | |
51 | assert(!component->user_data || component->user_destroy); | |
52 | component->user_destroy(component->user_data); | |
53 | ||
54 | g_string_free(component->name, TRUE); | |
55 | ||
56 | assert(component->destroy); | |
57 | component_class = component->class; | |
58 | ||
59 | /* Frees the component, which becomes invalid */ | |
60 | component->destroy(component); | |
61 | component = NULL; | |
62 | ||
63 | bt_put(component_class); | |
64 | } | |
65 | ||
66 | BT_HIDDEN | |
67 | enum bt_component_status bt_component_init(struct bt_component *component, | |
68 | struct bt_component_class *class, const char *name, | |
69 | bt_component_destroy_cb destroy) | |
70 | { | |
71 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
72 | ||
73 | if (!component || !class || !name || name[0] == '\0' || !destroy) { | |
74 | ret = BT_COMPONENT_STATUS_INVAL; | |
75 | goto end; | |
76 | } | |
77 | ||
78 | bt_object_init(component, bt_component_destroy); | |
79 | bt_get(class); | |
80 | component->class = class; | |
81 | component->name = g_string_new(name); | |
82 | if (!component->name) { | |
83 | ret = BT_COMPONENT_STATUS_NOMEM; | |
84 | goto end; | |
85 | } | |
86 | component->destroy = destroy; | |
87 | end: | |
88 | return ret; | |
89 | } | |
de713ce0 JG |
90 | |
91 | const char *bt_component_get_name(struct bt_component *component) | |
92 | { | |
93 | const char *ret = NULL; | |
94 | ||
95 | if (!component) { | |
96 | goto end; | |
97 | } | |
98 | ||
99 | ret = component->name->str; | |
100 | end: | |
101 | return ret; | |
102 | } | |
103 | ||
104 | enum bt_component_status bt_component_set_name(struct bt_component *component, | |
105 | const char *name) | |
106 | { | |
107 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
108 | ||
109 | if (!component || !name || name[0] == '\0') { | |
110 | ret = BT_COMPONENT_STATUS_INVAL; | |
111 | goto end; | |
112 | } | |
113 | ||
114 | g_string_assign(component->name, name); | |
115 | end: | |
116 | return ret; | |
117 | } | |
118 | ||
119 | enum bt_component_type bt_component_get_type(struct bt_component *component) | |
120 | { | |
121 | enum bt_component_type type = BT_COMPONENT_TYPE_UNKNOWN; | |
122 | ||
123 | if (!component) { | |
124 | goto end; | |
125 | } | |
126 | ||
fb2dcc52 | 127 | type = component->class->type; |
de713ce0 JG |
128 | end: |
129 | return type; | |
130 | } | |
131 | ||
132 | enum bt_component_status bt_component_set_error_stream( | |
133 | struct bt_component *component, FILE *stream) | |
134 | { | |
135 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
136 | ||
137 | if (!component) { | |
138 | ret = BT_COMPONENT_STATUS_INVAL; | |
139 | goto end; | |
140 | } | |
141 | ||
142 | component->error_stream = stream; | |
143 | end: | |
144 | return ret; | |
145 | } | |
146 | ||
de713ce0 JG |
147 | void *bt_component_get_private_data(struct bt_component *component) |
148 | { | |
0d884c50 | 149 | void *ret = NULL; |
de713ce0 JG |
150 | |
151 | if (!component) { | |
152 | goto end; | |
153 | } | |
154 | ||
155 | ret = component->user_data; | |
156 | end: | |
157 | return ret; | |
158 | } | |
159 | ||
160 | enum bt_component_status | |
161 | bt_component_set_private_data(struct bt_component *component, | |
162 | void *data) | |
163 | { | |
164 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
165 | ||
166 | if (!component) { | |
167 | ret = BT_COMPONENT_STATUS_INVAL; | |
168 | goto end; | |
169 | } | |
170 | ||
171 | component->user_data = data; | |
172 | end: | |
173 | return ret; | |
174 | } |