lib/component/component-class.c

   1 /*
   2  * component-class.c
   3  *
   4  * Babeltrace Plugin Component Class
   5  *
   6  * Copyright 2016 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/compiler.h>
  30 #include <babeltrace/component/component-class-internal.h>
  31 #include <babeltrace/ref.h>
  32 #include <stdbool.h>
  33 #include <glib.h>
  34
  35 static
  36 void bt_component_class_destroy(struct bt_object *obj)
  37 {
  38         struct bt_component_class *class;
  39         int i;
  40
  41         assert(obj);
  42         class = container_of(obj, struct bt_component_class, base);
  43
  44         /* Call destroy listeners in reverse registration order */
  45         for (i = class->destroy_listeners->len - 1; i >= 0; i--) {
  46                 struct bt_component_class_destroy_listener *listener =
  47                         &g_array_index(class->destroy_listeners,
  48                                 struct bt_component_class_destroy_listener,
  49                                 i);
  50
  51                 listener->func(class, listener->data);
  52         }
  53
  54         if (class->name) {
  55                 g_string_free(class->name, TRUE);
  56         }
  57         if (class->description) {
  58                 g_string_free(class->description, TRUE);
  59         }
  60         if (class->help) {
  61                 g_string_free(class->help, TRUE);
  62         }
  63         if (class->destroy_listeners) {
  64                 g_array_free(class->destroy_listeners, TRUE);
  65         }
  66
  67         g_free(class);
  68 }
  69
  70 static
  71 int bt_component_class_init(struct bt_component_class *class,
  72                 enum bt_component_class_type type, const char *name)
  73 {
  74         int ret = 0;
  75
  76         bt_object_init(class, bt_component_class_destroy);
  77         class->type = type;
  78         class->name = g_string_new(name);
  79         if (!class->name) {
  80                 goto error;
  81         }
  82
  83         class->description = g_string_new(NULL);
  84         if (!class->description) {
  85                 goto error;
  86         }
  87
  88         class->help = g_string_new(NULL);
  89         if (!class->help) {
  90                 goto error;
  91         }
  92
  93         class->destroy_listeners = g_array_new(FALSE, TRUE,
  94                 sizeof(struct bt_component_class_destroy_listener));
  95         if (!class->destroy_listeners) {
  96                 goto error;
  97         }
  98
  99         goto end;
 100
 101 error:
 102         BT_PUT(class);
 103         ret = -1;
 104
 105 end:
 106         return ret;
 107 }
 108
 109 struct bt_component_class *bt_component_class_source_create(const char *name,
 110                 bt_component_class_notification_iterator_get_method notification_iterator_get_method,
 111                 bt_component_class_notification_iterator_next_method notification_iterator_next_method)
 112 {
 113         struct bt_component_class_source *source_class = NULL;
 114         int ret;
 115
 116         if (!name || !notification_iterator_get_method ||
 117                         !notification_iterator_next_method) {
 118                 goto end;
 119         }
 120
 121         source_class = g_new0(struct bt_component_class_source, 1);
 122         if (!source_class) {
 123                 goto end;
 124         }
 125
 126         ret = bt_component_class_init(&source_class->parent,
 127                 BT_COMPONENT_CLASS_TYPE_SOURCE, name);
 128         if (ret) {
 129                 /*
 130                  * If bt_component_class_init() fails, the component
 131                  * class is put, therefore its memory is already
 132                  * freed.
 133                  */
 134                 source_class = NULL;
 135                 goto end;
 136         }
 137
 138         source_class->methods.iterator.get = notification_iterator_get_method;
 139         source_class->methods.iterator.next = notification_iterator_next_method;
 140
 141 end:
 142         return &source_class->parent;
 143 }
 144
 145 struct bt_component_class *bt_component_class_filter_create(const char *name,
 146                 bt_component_class_notification_iterator_get_method notification_iterator_get_method,
 147                 bt_component_class_notification_iterator_next_method notification_iterator_next_method)
 148 {
 149         struct bt_component_class_filter *filter_class = NULL;
 150         int ret;
 151
 152         if (!name || !notification_iterator_get_method ||
 153                         !notification_iterator_next_method) {
 154                 goto end;
 155         }
 156
 157         filter_class = g_new0(struct bt_component_class_filter, 1);
 158         if (!filter_class) {
 159                 goto end;
 160         }
 161
 162         ret = bt_component_class_init(&filter_class->parent,
 163                 BT_COMPONENT_CLASS_TYPE_FILTER, name);
 164         if (ret) {
 165                 /*
 166                  * If bt_component_class_init() fails, the component
 167                  * class is put, therefore its memory is already
 168                  * freed.
 169                  */
 170                 filter_class = NULL;
 171                 goto end;
 172         }
 173
 174         filter_class->methods.iterator.get = notification_iterator_get_method;
 175         filter_class->methods.iterator.next = notification_iterator_next_method;
 176
 177 end:
 178         return &filter_class->parent;
 179 }
 180
 181 struct bt_component_class *bt_component_class_sink_create(const char *name,
 182                 bt_component_class_sink_consume_method consume_method)
 183 {
 184         struct bt_component_class_sink *sink_class = NULL;
 185         int ret;
 186
 187         if (!name || !consume_method) {
 188                 goto end;
 189         }
 190
 191         sink_class = g_new0(struct bt_component_class_sink, 1);
 192         if (!sink_class) {
 193                 goto end;
 194         }
 195
 196         ret = bt_component_class_init(&sink_class->parent,
 197                 BT_COMPONENT_CLASS_TYPE_SINK, name);
 198         if (ret) {
 199                 /*
 200                  * If bt_component_class_init() fails, the component
 201                  * class is put, therefore its memory is already
 202                  * freed.
 203                  */
 204                 sink_class = NULL;
 205                 goto end;
 206         }
 207
 208         sink_class->methods.consume = consume_method;
 209
 210 end:
 211         return &sink_class->parent;
 212 }
 213
 214 int bt_component_class_set_init_method(
 215                 struct bt_component_class *component_class,
 216                 bt_component_class_init_method init_method)
 217 {
 218         int ret = 0;
 219
 220         if (!component_class || component_class->frozen || !init_method) {
 221                 ret = -1;
 222                 goto end;
 223         }
 224
 225         component_class->methods.init = init_method;
 226
 227 end:
 228         return ret;
 229 }
 230
 231 int bt_component_class_set_destroy_method(
 232                 struct bt_component_class *component_class,
 233                 bt_component_class_destroy_method destroy_method)
 234 {
 235         int ret = 0;
 236
 237         if (!component_class || component_class->frozen || !destroy_method) {
 238                 ret = -1;
 239                 goto end;
 240         }
 241
 242         component_class->methods.destroy = destroy_method;
 243
 244 end:
 245         return ret;
 246 }
 247
 248 int bt_component_class_source_set_notification_iterator_init_method(
 249                 struct bt_component_class *component_class,
 250                 bt_component_class_notification_iterator_init_method notification_iterator_init_method)
 251 {
 252         struct bt_component_class_source *source_class;
 253         int ret = 0;
 254
 255         if (!component_class || component_class->frozen ||
 256                         !notification_iterator_init_method ||
 257                         component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 258                 ret = -1;
 259                 goto end;
 260         }
 261
 262         source_class = container_of(component_class,
 263                 struct bt_component_class_source, parent);
 264         source_class->methods.iterator.init = notification_iterator_init_method;
 265
 266 end:
 267         return ret;
 268 }
 269
 270 int bt_component_class_source_set_notification_iterator_destroy_method(
 271                 struct bt_component_class *component_class,
 272                 bt_component_class_notification_iterator_destroy_method notification_iterator_destroy_method)
 273 {
 274         struct bt_component_class_source *source_class;
 275         int ret = 0;
 276
 277         if (!component_class || component_class->frozen ||
 278                         !notification_iterator_destroy_method ||
 279                         component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 280                 ret = -1;
 281                 goto end;
 282         }
 283
 284         source_class = container_of(component_class,
 285                 struct bt_component_class_source, parent);
 286         source_class->methods.iterator.destroy =
 287                 notification_iterator_destroy_method;
 288
 289 end:
 290         return ret;
 291 }
 292
 293 int bt_component_class_source_set_notification_iterator_seek_time_method(
 294                 struct bt_component_class *component_class,
 295                 bt_component_class_notification_iterator_seek_time_method notification_iterator_seek_time_method)
 296 {
 297         struct bt_component_class_source *source_class;
 298         int ret = 0;
 299
 300         if (!component_class || component_class->frozen ||
 301                         !notification_iterator_seek_time_method ||
 302                         component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 303                 ret = -1;
 304                 goto end;
 305         }
 306
 307         source_class = container_of(component_class,
 308                 struct bt_component_class_source, parent);
 309         source_class->methods.iterator.seek_time =
 310                 notification_iterator_seek_time_method;
 311
 312 end:
 313         return ret;
 314 }
 315
 316 int bt_component_class_filter_set_notification_iterator_init_method(
 317                 struct bt_component_class *component_class,
 318                 bt_component_class_notification_iterator_init_method notification_iterator_init_method)
 319 {
 320         struct bt_component_class_filter *filter_class;
 321         int ret = 0;
 322
 323         if (!component_class || component_class->frozen ||
 324                         !notification_iterator_init_method ||
 325                         component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 326                 ret = -1;
 327                 goto end;
 328         }
 329
 330         filter_class = container_of(component_class,
 331                 struct bt_component_class_filter, parent);
 332         filter_class->methods.iterator.init = notification_iterator_init_method;
 333
 334 end:
 335         return ret;
 336 }
 337
 338 int bt_component_class_filter_set_notification_iterator_destroy_method(
 339                 struct bt_component_class *component_class,
 340                 bt_component_class_notification_iterator_destroy_method notification_iterator_destroy_method)
 341 {
 342         struct bt_component_class_filter *filter_class;
 343         int ret = 0;
 344
 345         if (!component_class || component_class->frozen ||
 346                         !notification_iterator_destroy_method ||
 347                         component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 348                 ret = -1;
 349                 goto end;
 350         }
 351
 352         filter_class = container_of(component_class,
 353                 struct bt_component_class_filter, parent);
 354         filter_class->methods.iterator.destroy =
 355                 notification_iterator_destroy_method;
 356
 357 end:
 358         return ret;
 359 }
 360
 361 int bt_component_class_filter_set_notification_iterator_seek_time_method(
 362                 struct bt_component_class *component_class,
 363                 bt_component_class_notification_iterator_seek_time_method notification_iterator_seek_time_method)
 364 {
 365         struct bt_component_class_filter *filter_class;
 366         int ret = 0;
 367
 368         if (!component_class || component_class->frozen ||
 369                         !notification_iterator_seek_time_method ||
 370                         component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 371                 ret = -1;
 372                 goto end;
 373         }
 374
 375         filter_class = container_of(component_class,
 376                 struct bt_component_class_filter, parent);
 377         filter_class->methods.iterator.seek_time =
 378                 notification_iterator_seek_time_method;
 379
 380 end:
 381         return ret;
 382 }
 383
 384 int bt_component_class_set_description(
 385                 struct bt_component_class *component_class,
 386                 const char *description)
 387 {
 388         int ret = 0;
 389
 390         if (!component_class || component_class->frozen || !description) {
 391                 ret = -1;
 392                 goto end;
 393         }
 394
 395         g_string_assign(component_class->description, description);
 396
 397 end:
 398         return ret;
 399 }
 400
 401 int bt_component_class_set_help(
 402                 struct bt_component_class *component_class,
 403                 const char *help)
 404 {
 405         int ret = 0;
 406
 407         if (!component_class || component_class->frozen || !help) {
 408                 ret = -1;
 409                 goto end;
 410         }
 411
 412         g_string_assign(component_class->help, help);
 413
 414 end:
 415         return ret;
 416 }
 417
 418 const char *bt_component_class_get_name(
 419                 struct bt_component_class *component_class)
 420 {
 421         return component_class ? component_class->name->str : NULL;
 422 }
 423
 424 enum bt_component_class_type bt_component_class_get_type(
 425                 struct bt_component_class *component_class)
 426 {
 427         return component_class ? component_class->type :
 428                         BT_COMPONENT_CLASS_TYPE_UNKNOWN;
 429 }
 430
 431 const char *bt_component_class_get_description(
 432                 struct bt_component_class *component_class)
 433 {
 434         return component_class && component_class->description &&
 435                 component_class->description->str[0] != '\0' ?
 436                 component_class->description->str : NULL;
 437 }
 438
 439 const char *bt_component_class_get_help(
 440                 struct bt_component_class *component_class)
 441 {
 442         return component_class && component_class->help &&
 443                 component_class->help->str[0] != '\0' ?
 444                 component_class->help->str : NULL;
 445 }
 446
 447 BT_HIDDEN
 448 int bt_component_class_add_destroy_listener(struct bt_component_class *class,
 449                 bt_component_class_destroy_listener_func func, void *data)
 450 {
 451         int ret = 0;
 452         struct bt_component_class_destroy_listener listener;
 453
 454         if (!class || class->frozen || !func) {
 455                 ret = -1;
 456                 goto end;
 457         }
 458
 459         listener.func = func;
 460         listener.data = data;
 461         g_array_append_val(class->destroy_listeners, listener);
 462
 463 end:
 464         return ret;
 465 }
 466
 467 extern int bt_component_class_sink_set_add_iterator_method(
 468                 struct bt_component_class *component_class,
 469                 bt_component_class_sink_add_iterator_method add_iterator_method)
 470 {
 471         struct bt_component_class_sink *sink_class;
 472         int ret = 0;
 473
 474         if (!component_class || component_class->frozen ||
 475                         !add_iterator_method ||
 476                         component_class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 477                 ret = -1;
 478                 goto end;
 479         }
 480
 481         sink_class = container_of(component_class,
 482                 struct bt_component_class_sink, parent);
 483         sink_class->methods.add_iterator = add_iterator_method;
 484
 485 end:
 486         return ret;
 487 }
 488
 489 extern int bt_component_class_filter_set_add_iterator_method(
 490                 struct bt_component_class *component_class,
 491                 bt_component_class_filter_add_iterator_method add_iterator_method)
 492 {
 493         struct bt_component_class_filter *filter_class;
 494         int ret = 0;
 495
 496         if (!component_class || component_class->frozen ||
 497                         !add_iterator_method ||
 498                         component_class->type !=
 499                         BT_COMPONENT_CLASS_TYPE_FILTER) {
 500                 ret = -1;
 501                 goto end;
 502         }
 503
 504         filter_class = container_of(component_class,
 505                 struct bt_component_class_filter, parent);
 506         filter_class->methods.add_iterator = add_iterator_method;
 507
 508 end:
 509         return ret;
 510 }
 511
 512 int bt_component_class_freeze(
 513                 struct bt_component_class *component_class)
 514 {
 515         int ret = 0;
 516
 517         if (!component_class) {
 518                 ret = -1;
 519                 goto end;
 520         }
 521
 522         component_class->frozen = true;
 523
 524 end:
 525         return ret;
 526 }