lib/component/component.c

   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/component/component.h>
  30 #include <babeltrace/component/component-internal.h>
  31 #include <babeltrace/component/component-class-internal.h>
  32 #include <babeltrace/component/component-source-internal.h>
  33 #include <babeltrace/component/component-filter-internal.h>
  34 #include <babeltrace/component/component-sink-internal.h>
  35 #include <babeltrace/component/notification/iterator-internal.h>
  36 #include <babeltrace/babeltrace-internal.h>
  37 #include <babeltrace/compiler.h>
  38 #include <babeltrace/ref.h>
  39
  40 static
  41 struct bt_component * (* const component_create_funcs[])(
  42                 struct bt_component_class *, struct bt_value *) = {
  43         [BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_create,
  44         [BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_create,
  45         [BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_create,
  46 };
  47
  48 static
  49 enum bt_component_status (* const component_validation_funcs[])(
  50                 struct bt_component *) = {
  51         [BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_validate,
  52         [BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_validate,
  53         [BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_validate,
  54 };
  55
  56 static
  57 void bt_component_destroy(struct bt_object *obj)
  58 {
  59         struct bt_component *component = NULL;
  60         struct bt_component_class *component_class = NULL;
  61
  62         if (!obj) {
  63                 return;
  64         }
  65
  66         component = container_of(obj, struct bt_component, base);
  67         component_class = component->class;
  68
  69         /*
  70          * User data is destroyed first, followed by the concrete component
  71          * instance.
  72          */
  73         if (component->class->methods.destroy) {
  74                 component->class->methods.destroy(component);
  75         }
  76
  77         if (component->destroy) {
  78                 component->destroy(component);
  79         }
  80
  81         g_string_free(component->name, TRUE);
  82         bt_put(component_class);
  83         g_free(component);
  84 }
  85
  86 BT_HIDDEN
  87 enum bt_component_status bt_component_init(struct bt_component *component,
  88                 bt_component_class_destroy_method destroy)
  89 {
  90         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  91
  92         if (!component) {
  93                 ret = BT_COMPONENT_STATUS_INVALID;
  94                 goto end;
  95         }
  96
  97         component->destroy = destroy;
  98 end:
  99         return ret;
 100 }
 101
 102 enum bt_component_class_type bt_component_get_class_type(
 103                 struct bt_component *component)
 104 {
 105         return component ? component->class->type : BT_COMPONENT_CLASS_TYPE_UNKNOWN;
 106 }
 107
 108 BT_HIDDEN
 109 struct bt_notification_iterator *bt_component_create_iterator(
 110                 struct bt_component *component, void *init_method_data)
 111 {
 112         enum bt_notification_iterator_status ret_iterator;
 113         enum bt_component_class_type type;
 114         struct bt_notification_iterator *iterator = NULL;
 115         struct bt_component_class *class = component->class;
 116
 117         if (!component) {
 118                 goto error;
 119         }
 120
 121         type = bt_component_get_class_type(component);
 122         if (type != BT_COMPONENT_CLASS_TYPE_SOURCE &&
 123                         type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 124                 /* Unsupported operation. */
 125                 goto error;
 126         }
 127
 128         iterator = bt_notification_iterator_create(component);
 129         if (!iterator) {
 130                 goto error;
 131         }
 132
 133         switch (type) {
 134         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 135         {
 136                 struct bt_component_class_source *source_class;
 137                 enum bt_notification_iterator_status status;
 138
 139                 source_class = container_of(class, struct bt_component_class_source, parent);
 140
 141                 if (source_class->methods.iterator.init) {
 142                         status = source_class->methods.iterator.init(component,
 143                                         iterator, init_method_data);
 144                         if (status < 0) {
 145                                 goto error;
 146                         }
 147                 }
 148                 break;
 149         }
 150         case BT_COMPONENT_CLASS_TYPE_FILTER:
 151         {
 152                 struct bt_component_class_filter *filter_class;
 153                 enum bt_notification_iterator_status status;
 154
 155                 filter_class = container_of(class, struct bt_component_class_filter, parent);
 156
 157                 if (filter_class->methods.iterator.init) {
 158                         status = filter_class->methods.iterator.init(component,
 159                                         iterator, init_method_data);
 160                         if (status < 0) {
 161                                 goto error;
 162                         }
 163                 }
 164                 break;
 165         }
 166         default:
 167                 /* Unreachable. */
 168                 assert(0);
 169         }
 170
 171         ret_iterator = bt_notification_iterator_validate(iterator);
 172         if (ret_iterator != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
 173                 goto error;
 174         }
 175
 176         return iterator;
 177 error:
 178         BT_PUT(iterator);
 179         return iterator;
 180 }
 181
 182 struct bt_component *bt_component_create_with_init_method_data(
 183                 struct bt_component_class *component_class, const char *name,
 184                 struct bt_value *params, void *init_method_data)
 185 {
 186         int ret;
 187         struct bt_component *component = NULL;
 188         enum bt_component_class_type type;
 189
 190         if (!component_class) {
 191                 goto end;
 192         }
 193
 194         type = bt_component_class_get_type(component_class);
 195         if (type <= BT_COMPONENT_CLASS_TYPE_UNKNOWN ||
 196                         type > BT_COMPONENT_CLASS_TYPE_FILTER) {
 197                 goto end;
 198         }
 199
 200         component = component_create_funcs[type](component_class, params);
 201         if (!component) {
 202                 goto end;
 203         }
 204
 205         bt_object_init(component, bt_component_destroy);
 206         component->name = g_string_new(name);
 207         if (!component->name) {
 208                 BT_PUT(component);
 209                 goto end;
 210         }
 211
 212         component->initializing = true;
 213
 214         if (component_class->methods.init) {
 215                 ret = component_class->methods.init(component, params,
 216                         init_method_data);
 217                 component->initializing = false;
 218                 if (ret != BT_COMPONENT_STATUS_OK) {
 219                         BT_PUT(component);
 220                         goto end;
 221                 }
 222         }
 223
 224         component->initializing = false;
 225         ret = component_validation_funcs[type](component);
 226         if (ret != BT_COMPONENT_STATUS_OK) {
 227                 BT_PUT(component);
 228                 goto end;
 229         }
 230
 231         bt_component_class_freeze(component->class);
 232 end:
 233         return component;
 234 }
 235
 236 struct bt_component *bt_component_create(
 237                 struct bt_component_class *component_class, const char *name,
 238                 struct bt_value *params)
 239 {
 240         return bt_component_create_with_init_method_data(component_class, name,
 241                 params, NULL);
 242 }
 243
 244 const char *bt_component_get_name(struct bt_component *component)
 245 {
 246         const char *ret = NULL;
 247
 248         if (!component) {
 249                 goto end;
 250         }
 251
 252         ret = component->name->len == 0 ? NULL : component->name->str;
 253 end:
 254         return ret;
 255 }
 256
 257 enum bt_component_status bt_component_set_name(struct bt_component *component,
 258                 const char *name)
 259 {
 260         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 261
 262         if (!component || !name || name[0] == '\0') {
 263                 ret = BT_COMPONENT_STATUS_INVALID;
 264                 goto end;
 265         }
 266
 267         g_string_assign(component->name, name);
 268 end:
 269         return ret;
 270 }
 271
 272 struct bt_component_class *bt_component_get_class(
 273                 struct bt_component *component)
 274 {
 275         return component ? bt_get(component->class) : NULL;
 276 }
 277
 278 void *bt_component_get_private_data(struct bt_component *component)
 279 {
 280         return component ? component->user_data : NULL;
 281 }
 282
 283 enum bt_component_status
 284 bt_component_set_private_data(struct bt_component *component,
 285                 void *data)
 286 {
 287         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 288
 289         if (!component || !component->initializing) {
 290                 ret = BT_COMPONENT_STATUS_INVALID;
 291                 goto end;
 292         }
 293
 294         component->user_data = data;
 295 end:
 296         return ret;
 297 }