lib/plugin-system/sink.c

   1 /*
   2  * sink.c
   3  *
   4  * Babeltrace Sink 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/compiler.h>
  30 #include <babeltrace/plugin/sink-internal.h>
  31 #include <babeltrace/plugin/component-internal.h>
  32 #include <babeltrace/plugin/notification/notification.h>
  33
  34 static
  35 void bt_component_sink_destroy(struct bt_component *component)
  36 {
  37         return;
  38 }
  39
  40 BT_HIDDEN
  41 enum bt_component_status bt_component_sink_validate(
  42                 struct bt_component *component)
  43 {
  44         return BT_COMPONENT_STATUS_OK;
  45 }
  46
  47 BT_HIDDEN
  48 struct bt_component *bt_component_sink_create(
  49                 struct bt_component_class *class, struct bt_value *params)
  50 {
  51         struct bt_component_sink *sink = NULL;
  52         enum bt_component_status ret;
  53
  54         sink = g_new0(struct bt_component_sink, 1);
  55         if (!sink) {
  56                 goto end;
  57         }
  58
  59         ret = bt_component_init(&sink->parent, bt_component_sink_destroy);
  60         if (ret != BT_COMPONENT_STATUS_OK) {
  61                 BT_PUT(sink);
  62                 goto end;
  63         }
  64 end:
  65         return sink ? &sink->parent : NULL;
  66 }
  67
  68 enum bt_component_status bt_component_sink_handle_notification(
  69                 struct bt_component *component,
  70                 struct bt_notification *notification)
  71 {
  72         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  73         struct bt_component_sink *sink = NULL;
  74
  75         if (!component || !notification) {
  76                 ret = BT_COMPONENT_STATUS_INVALID;
  77                 goto end;
  78         }
  79
  80         if (bt_component_get_type(component) != BT_COMPONENT_TYPE_SINK) {
  81                 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
  82                 goto end;
  83         }
  84
  85         sink = container_of(component, struct bt_component_sink, parent);
  86         assert(sink->handle_notification);
  87         ret = sink->handle_notification(component, notification);
  88 end:
  89         return ret;
  90 }
  91
  92 enum bt_component_status bt_component_sink_register_notification_type(
  93                 struct bt_component *component, enum bt_notification_type type)
  94 {
  95         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  96         struct bt_component_sink *sink = NULL;
  97
  98         if (!component) {
  99                 ret = BT_COMPONENT_STATUS_INVALID;
 100                 goto end;
 101         }
 102
 103         if (bt_component_get_type(component) != BT_COMPONENT_TYPE_SINK) {
 104                 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
 105                 goto end;
 106         }
 107
 108         if (type <= BT_NOTIFICATION_TYPE_UNKNOWN ||
 109                 type >= BT_NOTIFICATION_TYPE_NR) {
 110                 ret = BT_COMPONENT_STATUS_INVALID;
 111                 goto end;
 112         }
 113         sink = container_of(component, struct bt_component_sink, parent);
 114         if (type == BT_NOTIFICATION_TYPE_ALL) {
 115                 sink->registered_notifications_mask = ~(notification_mask_t) 0;
 116         } else {
 117                 sink->registered_notifications_mask |=
 118                         (notification_mask_t) 1 << type;
 119         }
 120 end:
 121         return ret;
 122 }