| 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.h> |
| 30 | #include <babeltrace/plugin/component-internal.h> |
| 31 | #include <babeltrace/plugin/source-internal.h> |
| 32 | #include <babeltrace/plugin/sink-internal.h> |
| 33 | #include <babeltrace/babeltrace-internal.h> |
| 34 | #include <babeltrace/compiler.h> |
| 35 | #include <babeltrace/ref.h> |
| 36 | |
| 37 | static |
| 38 | struct bt_component * (* const component_create_funcs[])( |
| 39 | struct bt_component_class *, struct bt_value *) = { |
| 40 | [BT_COMPONENT_TYPE_SOURCE] = bt_component_source_create, |
| 41 | [BT_COMPONENT_TYPE_SINK] = bt_component_sink_create, |
| 42 | }; |
| 43 | |
| 44 | static |
| 45 | enum bt_component_status (* const component_validation_funcs[])( |
| 46 | struct bt_component *) = { |
| 47 | [BT_COMPONENT_TYPE_SOURCE] = bt_component_source_validate, |
| 48 | [BT_COMPONENT_TYPE_SINK] = bt_component_sink_validate, |
| 49 | }; |
| 50 | |
| 51 | static |
| 52 | void bt_component_destroy(struct bt_object *obj) |
| 53 | { |
| 54 | struct bt_component *component = NULL; |
| 55 | struct bt_component_class *component_class = NULL; |
| 56 | |
| 57 | if (!obj) { |
| 58 | return; |
| 59 | } |
| 60 | |
| 61 | component = container_of(obj, struct bt_component, base); |
| 62 | component_class = component->class; |
| 63 | |
| 64 | /* |
| 65 | * User data is destroyed first, followed by the concrete component |
| 66 | * instance. |
| 67 | */ |
| 68 | if (component->user_destroy) { |
| 69 | component->user_destroy(component); |
| 70 | } |
| 71 | |
| 72 | if (component->destroy) { |
| 73 | component->destroy(component); |
| 74 | } |
| 75 | |
| 76 | g_string_free(component->name, TRUE); |
| 77 | bt_put(component_class); |
| 78 | g_free(component); |
| 79 | } |
| 80 | |
| 81 | BT_HIDDEN |
| 82 | enum bt_component_status bt_component_init(struct bt_component *component, |
| 83 | bt_component_destroy_cb destroy) |
| 84 | { |
| 85 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; |
| 86 | |
| 87 | if (!component) { |
| 88 | ret = BT_COMPONENT_STATUS_INVALID; |
| 89 | goto end; |
| 90 | } |
| 91 | |
| 92 | component->destroy = destroy; |
| 93 | end: |
| 94 | return ret; |
| 95 | } |
| 96 | |
| 97 | BT_HIDDEN |
| 98 | enum bt_component_type bt_component_get_type(struct bt_component *component) |
| 99 | { |
| 100 | return component ? component->class->type : BT_COMPONENT_TYPE_UNKNOWN; |
| 101 | } |
| 102 | |
| 103 | struct bt_component *bt_component_create( |
| 104 | struct bt_component_class *component_class, const char *name, |
| 105 | struct bt_value *params) |
| 106 | { |
| 107 | int ret; |
| 108 | struct bt_component *component = NULL; |
| 109 | enum bt_component_type type; |
| 110 | |
| 111 | if (!component_class) { |
| 112 | goto end; |
| 113 | } |
| 114 | |
| 115 | type = bt_component_class_get_type(component_class); |
| 116 | if (type <= BT_COMPONENT_TYPE_UNKNOWN || |
| 117 | type >= BT_COMPONENT_TYPE_FILTER) { |
| 118 | /* Filter components are not supported yet. */ |
| 119 | goto end; |
| 120 | } |
| 121 | |
| 122 | component = component_create_funcs[type](component_class, params); |
| 123 | if (!component) { |
| 124 | goto end; |
| 125 | } |
| 126 | |
| 127 | bt_object_init(component, bt_component_destroy); |
| 128 | component->name = g_string_new(name); |
| 129 | if (!component->name) { |
| 130 | BT_PUT(component); |
| 131 | goto end; |
| 132 | } |
| 133 | |
| 134 | component->initializing = true; |
| 135 | component_class->init(component, params); |
| 136 | component->initializing = false; |
| 137 | ret = component_validation_funcs[type](component); |
| 138 | if (ret != BT_COMPONENT_STATUS_OK) { |
| 139 | BT_PUT(component); |
| 140 | goto end; |
| 141 | } |
| 142 | end: |
| 143 | return component; |
| 144 | } |
| 145 | |
| 146 | const char *bt_component_get_name(struct bt_component *component) |
| 147 | { |
| 148 | const char *ret = NULL; |
| 149 | |
| 150 | if (!component) { |
| 151 | goto end; |
| 152 | } |
| 153 | |
| 154 | ret = component->name->str; |
| 155 | end: |
| 156 | return ret; |
| 157 | } |
| 158 | |
| 159 | enum bt_component_status bt_component_set_name(struct bt_component *component, |
| 160 | const char *name) |
| 161 | { |
| 162 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; |
| 163 | |
| 164 | if (!component || !name || name[0] == '\0') { |
| 165 | ret = BT_COMPONENT_STATUS_INVALID; |
| 166 | goto end; |
| 167 | } |
| 168 | |
| 169 | g_string_assign(component->name, name); |
| 170 | end: |
| 171 | return ret; |
| 172 | } |
| 173 | |
| 174 | struct bt_component_class *bt_component_get_class( |
| 175 | struct bt_component *component) |
| 176 | { |
| 177 | return component ? bt_get(component->class) : NULL; |
| 178 | } |
| 179 | |
| 180 | void *bt_component_get_private_data(struct bt_component *component) |
| 181 | { |
| 182 | return component ? component->user_data : NULL; |
| 183 | } |
| 184 | |
| 185 | enum bt_component_status |
| 186 | bt_component_set_private_data(struct bt_component *component, |
| 187 | void *data) |
| 188 | { |
| 189 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; |
| 190 | |
| 191 | if (!component || !component->initializing) { |
| 192 | ret = BT_COMPONENT_STATUS_INVALID; |
| 193 | goto end; |
| 194 | } |
| 195 | |
| 196 | component->user_data = data; |
| 197 | end: |
| 198 | return ret; |
| 199 | } |
| 200 | |
| 201 | enum bt_component_status bt_component_set_destroy_cb( |
| 202 | struct bt_component *component, bt_component_destroy_cb destroy) |
| 203 | { |
| 204 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; |
| 205 | |
| 206 | if (!component || !component->initializing) { |
| 207 | ret = BT_COMPONENT_STATUS_INVALID; |
| 208 | goto end; |
| 209 | } |
| 210 | |
| 211 | component->user_destroy = destroy; |
| 212 | end: |
| 213 | return ret; |
| 214 | } |