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 BT_HIDDEN
  35 enum bt_component_status bt_component_sink_validate(
  36                 struct bt_component *component)
  37 {
  38         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  39         struct bt_component_sink *sink;
  40
  41         sink = container_of(component, struct bt_component_sink, parent);
  42         if (sink->registered_notifications_mask == 0) {
  43                 /*
  44                  * A sink must be registered to at least one notification type.
  45                  */
  46                 printf_error("Invalid sink component; not registered to any notification");
  47                 ret = BT_COMPONENT_STATUS_INVALID;
  48                 goto end;
  49         }
  50
  51         if (!sink->handle_notification) {
  52                 printf_error("Invalid sink component; no notification handling callback defined.");
  53                 ret = BT_COMPONENT_STATUS_INVALID;
  54                 goto end;
  55         }
  56 end:
  57         return ret;
  58 }
  59
  60 BT_HIDDEN
  61 struct bt_component *bt_component_sink_create(
  62                 struct bt_component_class *class, struct bt_value *params)
  63 {
  64         struct bt_component_sink *sink = NULL;
  65         enum bt_component_status ret;
  66
  67         sink = g_new0(struct bt_component_sink, 1);
  68         if (!sink) {
  69                 goto end;
  70         }
  71
  72         sink->parent.class = bt_get(class);
  73         ret = bt_component_init(&sink->parent, NULL);
  74         if (ret != BT_COMPONENT_STATUS_OK) {
  75                 goto error;
  76         }
  77
  78         ret = bt_component_sink_register_notification_type(&sink->parent,
  79                 BT_NOTIFICATION_TYPE_EVENT);
  80         if (ret != BT_COMPONENT_STATUS_OK) {
  81                 goto error;
  82         }
  83 end:
  84         return sink ? &sink->parent : NULL;
  85 error:
  86         BT_PUT(sink);
  87         return NULL;
  88 }
  89
  90 enum bt_component_status bt_component_sink_handle_notification(
  91                 struct bt_component *component,
  92                 struct bt_notification *notification)
  93 {
  94         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  95         struct bt_component_sink *sink = NULL;
  96
  97         if (!component || !notification) {
  98                 ret = BT_COMPONENT_STATUS_INVALID;
  99                 goto end;
 100         }
 101
 102         if (bt_component_get_type(component) != BT_COMPONENT_TYPE_SINK) {
 103                 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
 104                 goto end;
 105         }
 106
 107         sink = container_of(component, struct bt_component_sink, parent);
 108         assert(sink->handle_notification);
 109         ret = sink->handle_notification(component, notification);
 110 end:
 111         return ret;
 112 }
 113
 114 enum bt_component_status bt_component_sink_register_notification_type(
 115                 struct bt_component *component, enum bt_notification_type type)
 116 {
 117         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 118         struct bt_component_sink *sink = NULL;
 119
 120         if (!component) {
 121                 ret = BT_COMPONENT_STATUS_INVALID;
 122                 goto end;
 123         }
 124
 125         if (bt_component_get_type(component) != BT_COMPONENT_TYPE_SINK) {
 126                 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
 127                 goto end;
 128         }
 129
 130         if (type <= BT_NOTIFICATION_TYPE_UNKNOWN ||
 131                 type >= BT_NOTIFICATION_TYPE_NR) {
 132                 ret = BT_COMPONENT_STATUS_INVALID;
 133                 goto end;
 134         }
 135         sink = container_of(component, struct bt_component_sink, parent);
 136         if (type == BT_NOTIFICATION_TYPE_ALL) {
 137                 sink->registered_notifications_mask = ~(notification_mask_t) 0;
 138         } else {
 139                 sink->registered_notifications_mask |=
 140                         (notification_mask_t) 1 << type;
 141         }
 142 end:
 143         return ret;
 144 }
 145
 146 enum bt_component_status bt_component_sink_set_handle_notification_cb(
 147                 struct bt_component *component,
 148                 bt_component_sink_handle_notification_cb handle_notification)
 149 {
 150         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 151         struct bt_component_sink *sink = NULL;
 152
 153         if (!component) {
 154                 ret = BT_COMPONENT_STATUS_INVALID;
 155                 goto end;
 156         }
 157
 158         if (bt_component_get_type(component) != BT_COMPONENT_TYPE_SINK) {
 159                 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
 160                 goto end;
 161         }
 162
 163         sink = container_of(component, struct bt_component_sink, parent);
 164         sink->handle_notification = handle_notification;
 165 end:
 166         return ret;
 167 }