lib/component/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/component/component.h>
  32 #include <babeltrace/component/component-source-internal.h>
  33 #include <babeltrace/component/component-class-internal.h>
  34 #include <babeltrace/component/notification/iterator.h>
  35 #include <babeltrace/component/notification/iterator-internal.h>
  36
  37 static
  38 void bt_notification_iterator_destroy(struct bt_object *obj)
  39 {
  40         struct bt_notification_iterator *iterator;
  41         struct bt_component_class *comp_class;
  42
  43         assert(obj);
  44         iterator = container_of(obj, struct bt_notification_iterator,
  45                         base);
  46         assert(iterator->component);
  47         comp_class = iterator->component->class;
  48
  49         /* Call user-defined destroy method */
  50         switch (comp_class->type) {
  51         case BT_COMPONENT_CLASS_TYPE_SOURCE:
  52         {
  53                 struct bt_component_class_source *source_class;
  54
  55                 source_class = container_of(comp_class, struct bt_component_class_source, parent);
  56
  57                 if (source_class->methods.iterator.finalize) {
  58                         source_class->methods.iterator.finalize(
  59                                 bt_private_notification_iterator_from_notification_iterator(iterator));
  60                 }
  61                 break;
  62         }
  63         case BT_COMPONENT_CLASS_TYPE_FILTER:
  64         {
  65                 struct bt_component_class_filter *filter_class;
  66
  67                 filter_class = container_of(comp_class, struct bt_component_class_filter, parent);
  68
  69                 if (filter_class->methods.iterator.finalize) {
  70                         filter_class->methods.iterator.finalize(
  71                                 bt_private_notification_iterator_from_notification_iterator(iterator));
  72                 }
  73                 break;
  74         }
  75         default:
  76                 /* Unreachable */
  77                 assert(0);
  78         }
  79
  80         BT_PUT(iterator->component);
  81         g_free(iterator);
  82 }
  83
  84 BT_HIDDEN
  85 struct bt_notification_iterator *bt_notification_iterator_create(
  86                 struct bt_component *component)
  87 {
  88         enum bt_component_class_type type;
  89         struct bt_notification_iterator *iterator = NULL;
  90
  91         if (!component) {
  92                 goto end;
  93         }
  94
  95         type = bt_component_get_class_type(component);
  96         switch (type) {
  97         case BT_COMPONENT_CLASS_TYPE_SOURCE:
  98         case BT_COMPONENT_CLASS_TYPE_FILTER:
  99                 break;
 100         default:
 101                 goto end;
 102         }
 103
 104         iterator = g_new0(struct bt_notification_iterator, 1);
 105         if (!iterator) {
 106                 goto end;
 107         }
 108
 109         iterator->component = bt_get(component);
 110         bt_object_init(iterator, bt_notification_iterator_destroy);
 111 end:
 112         return iterator;
 113 }
 114
 115 BT_HIDDEN
 116 enum bt_notification_iterator_status bt_notification_iterator_validate(
 117                 struct bt_notification_iterator *iterator)
 118 {
 119         enum bt_notification_iterator_status ret =
 120                         BT_NOTIFICATION_ITERATOR_STATUS_OK;
 121
 122         if (!iterator) {
 123                 ret = BT_NOTIFICATION_ITERATOR_STATUS_INVAL;
 124                 goto end;
 125         }
 126 end:
 127         return ret;
 128 }
 129
 130 void *bt_private_notification_iterator_get_user_data(
 131                 struct bt_private_notification_iterator *private_iterator)
 132 {
 133         struct bt_notification_iterator *iterator =
 134                 bt_notification_iterator_from_private(private_iterator);
 135
 136         return iterator ? iterator->user_data : NULL;
 137 }
 138
 139 enum bt_notification_iterator_status
 140 bt_private_notification_iterator_set_user_data(
 141                 struct bt_private_notification_iterator *private_iterator,
 142                 void *data)
 143 {
 144         enum bt_notification_iterator_status ret =
 145                         BT_NOTIFICATION_ITERATOR_STATUS_OK;
 146         struct bt_notification_iterator *iterator =
 147                 bt_notification_iterator_from_private(private_iterator);
 148
 149         if (!iterator) {
 150                 ret = BT_NOTIFICATION_ITERATOR_STATUS_INVAL;
 151                 goto end;
 152         }
 153
 154         iterator->user_data = data;
 155 end:
 156         return ret;
 157 }
 158
 159 struct bt_notification *bt_notification_iterator_get_notification(
 160                 struct bt_notification_iterator *iterator)
 161 {
 162         struct bt_private_notification_iterator *priv_iterator =
 163                 bt_private_notification_iterator_from_notification_iterator(iterator);
 164         bt_component_class_notification_iterator_get_method get_method = NULL;
 165
 166         assert(iterator);
 167         assert(iterator->component);
 168         assert(iterator->component->class);
 169
 170         switch (iterator->component->class->type) {
 171         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 172         {
 173                 struct bt_component_class_source *source_class =
 174                         container_of(iterator->component->class,
 175                                 struct bt_component_class_source, parent);
 176
 177                 assert(source_class->methods.iterator.get);
 178                 get_method = source_class->methods.iterator.get;
 179                 break;
 180         }
 181         case BT_COMPONENT_CLASS_TYPE_FILTER:
 182         {
 183                 struct bt_component_class_filter *filter_class =
 184                         container_of(iterator->component->class,
 185                                 struct bt_component_class_filter, parent);
 186
 187                 assert(filter_class->methods.iterator.get);
 188                 get_method = filter_class->methods.iterator.get;
 189                 break;
 190         }
 191         default:
 192                 assert(false);
 193                 break;
 194         }
 195
 196         assert(get_method);
 197         return get_method(priv_iterator);
 198 }
 199
 200 enum bt_notification_iterator_status
 201 bt_notification_iterator_next(struct bt_notification_iterator *iterator)
 202 {
 203         struct bt_private_notification_iterator *priv_iterator =
 204                 bt_private_notification_iterator_from_notification_iterator(iterator);
 205         bt_component_class_notification_iterator_next_method next_method = NULL;
 206
 207         assert(iterator);
 208         assert(iterator->component);
 209         assert(iterator->component->class);
 210
 211         switch (iterator->component->class->type) {
 212         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 213         {
 214                 struct bt_component_class_source *source_class =
 215                         container_of(iterator->component->class,
 216                                 struct bt_component_class_source, parent);
 217
 218                 assert(source_class->methods.iterator.next);
 219                 next_method = source_class->methods.iterator.next;
 220                 break;
 221         }
 222         case BT_COMPONENT_CLASS_TYPE_FILTER:
 223         {
 224                 struct bt_component_class_filter *filter_class =
 225                         container_of(iterator->component->class,
 226                                 struct bt_component_class_filter, parent);
 227
 228                 assert(filter_class->methods.iterator.next);
 229                 next_method = filter_class->methods.iterator.next;
 230                 break;
 231         }
 232         default:
 233                 assert(false);
 234                 break;
 235         }
 236
 237         assert(next_method);
 238         return next_method(priv_iterator);
 239 }
 240
 241 struct bt_component *bt_notification_iterator_get_component(
 242                 struct bt_notification_iterator *iterator)
 243 {
 244         return bt_get(iterator->component);
 245 }
 246
 247 enum bt_notification_iterator_status bt_notification_iterator_seek_time(
 248                 struct bt_notification_iterator *iterator,
 249                 enum bt_notification_iterator_seek_origin seek_origin,
 250                 int64_t time)
 251 {
 252         enum bt_notification_iterator_status ret =
 253                         BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED;
 254         return ret;
 255 }