lib/plugin-system/iterator.c

   1 /*
   2  * iterator.c
   3  *
   4  * Babeltrace Notification Iterator
   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/ref.h>
  31 #include <babeltrace/plugin/component.h>
  32 #include <babeltrace/plugin/source-internal.h>
  33 #include <babeltrace/plugin/notification/iterator.h>
  34 #include <babeltrace/plugin/notification/iterator-internal.h>
  35
  36 static
  37 void bt_notification_iterator_destroy(struct bt_object *obj)
  38 {
  39         struct bt_notification_iterator *iterator;
  40
  41         assert(obj);
  42         iterator = container_of(obj, struct bt_notification_iterator,
  43                         base);
  44         assert(iterator->user_destroy || !iterator->user_data);
  45         if (iterator->user_destroy) {
  46                 iterator->user_destroy(iterator);
  47         }
  48         BT_PUT(iterator->component);
  49         g_free(iterator);
  50 }
  51
  52 BT_HIDDEN
  53 struct bt_notification_iterator *bt_notification_iterator_create(
  54                 struct bt_component *component)
  55 {
  56         struct bt_notification_iterator *iterator = NULL;
  57
  58         if (!component ||
  59                 bt_component_get_type(component) != BT_COMPONENT_TYPE_SOURCE) {
  60                 goto end;
  61         }
  62
  63         iterator = g_new0(struct bt_notification_iterator, 1);
  64         if (!iterator) {
  65                 goto end;
  66         }
  67
  68         iterator->component = bt_get(component);
  69         bt_object_init(iterator, bt_notification_iterator_destroy);
  70 end:
  71         return iterator;
  72 }
  73
  74 BT_HIDDEN
  75 enum bt_notification_iterator_status bt_notification_iterator_validate(
  76                 struct bt_notification_iterator *iterator)
  77 {
  78         enum bt_notification_iterator_status ret =
  79                         BT_NOTIFICATION_ITERATOR_STATUS_OK;
  80
  81         if (!iterator || !iterator->get || !iterator->next) {
  82                 ret = BT_NOTIFICATION_ITERATOR_STATUS_INVAL;
  83                 goto end;
  84         }
  85 end:
  86         return ret;
  87 }
  88
  89 enum bt_notification_iterator_status bt_notification_iterator_set_get_cb(
  90                 struct bt_notification_iterator *iterator,
  91                 bt_notification_iterator_get_cb get)
  92 {
  93         enum bt_notification_iterator_status ret =
  94                         BT_NOTIFICATION_ITERATOR_STATUS_OK;
  95
  96         if (!iterator || !get) {
  97                 ret = BT_NOTIFICATION_ITERATOR_STATUS_INVAL;
  98                 goto end;
  99         }
 100
 101         iterator->get = get;
 102 end:
 103         return ret;
 104 }
 105
 106 enum bt_notification_iterator_status
 107 bt_notification_iterator_set_next_cb(struct bt_notification_iterator *iterator,
 108                 bt_notification_iterator_next_cb next)
 109 {
 110         enum bt_notification_iterator_status ret =
 111                         BT_NOTIFICATION_ITERATOR_STATUS_OK;
 112
 113         if (!iterator || !next) {
 114                 ret = BT_NOTIFICATION_ITERATOR_STATUS_INVAL;
 115                 goto end;
 116         }
 117
 118         iterator->next = next;
 119 end:
 120         return ret;
 121 }
 122
 123 enum bt_notification_iterator_status
 124 bt_notification_iterator_set_destroy_cb(
 125                 struct bt_notification_iterator *iterator,
 126                 bt_notification_iterator_destroy_cb destroy)
 127 {
 128         enum bt_notification_iterator_status ret =
 129                         BT_NOTIFICATION_ITERATOR_STATUS_OK;
 130
 131         if (!iterator || !destroy) {
 132                 ret = BT_NOTIFICATION_ITERATOR_STATUS_INVAL;
 133                 goto end;
 134         }
 135
 136         iterator->user_destroy = destroy;
 137 end:
 138         return ret;
 139 }
 140
 141 void *bt_notification_iterator_get_private_data(
 142                 struct bt_notification_iterator *iterator)
 143 {
 144         return iterator ? iterator->user_data : NULL;
 145 }
 146
 147 enum bt_notification_iterator_status
 148 bt_notification_iterator_set_private_data(
 149                 struct bt_notification_iterator *iterator, void *data)
 150 {
 151         enum bt_notification_iterator_status ret =
 152                         BT_NOTIFICATION_ITERATOR_STATUS_OK;
 153
 154         if (!iterator || !data) {
 155                 ret = BT_NOTIFICATION_ITERATOR_STATUS_INVAL;
 156                 goto end;
 157         }
 158
 159         iterator->user_data = data;
 160 end:
 161         return ret;
 162 }
 163
 164 struct bt_notification *bt_notification_iterator_get_notification(
 165                 struct bt_notification_iterator *iterator)
 166 {
 167         assert(iterator);
 168         assert(iterator->get);
 169         return iterator->get(iterator);
 170 }
 171
 172 enum bt_notification_iterator_status
 173 bt_notification_iterator_next(struct bt_notification_iterator *iterator)
 174 {
 175         assert(iterator);
 176         assert(iterator->next);
 177         return iterator->next(iterator);
 178 }
 179
 180 struct bt_component *bt_notification_iterator_get_component(
 181                 struct bt_notification_iterator *iterator)
 182 {
 183         return bt_get(iterator->component);
 184 }
 185
 186 enum bt_notification_iterator_status bt_notification_iterator_seek_time(
 187                 struct bt_notification_iterator *iterator,
 188                 enum bt_notification_iterator_seek_origin seek_origin,
 189                 int64_t time)
 190 {
 191         enum bt_notification_iterator_status ret =
 192                         BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED;
 193         return ret;
 194 }