include/babeltrace/graph/notification-iterator.h

   1 #ifndef BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_H
   2 #define BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_H
   3
   4 /*
   5  * BabelTrace - Plug-in Notification Iterator
   6  *
   7  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <stdint.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 struct bt_notification;
  37 struct bt_notification_iterator;
  38
  39 /**
  40  * Status code. Errors are always negative.
  41  */
  42 enum bt_notification_iterator_status {
  43         /** Try again. */
  44         BT_NOTIFICATION_ITERATOR_STATUS_AGAIN = 11,
  45         /** No more notifications to be delivered. */
  46         BT_NOTIFICATION_ITERATOR_STATUS_END = 1,
  47         /** No error, okay. */
  48         BT_NOTIFICATION_ITERATOR_STATUS_OK = 0,
  49         /** Invalid arguments. */
  50         BT_NOTIFICATION_ITERATOR_STATUS_INVALID = -22,
  51         /** General error. */
  52         BT_NOTIFICATION_ITERATOR_STATUS_ERROR = -1,
  53         /** Out of memory. */
  54         BT_NOTIFICATION_ITERATOR_STATUS_NOMEM = -12,
  55         /** Unsupported iterator feature. */
  56         BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED = -2,
  57
  58 };
  59
  60 /**
  61  * Notification iterator seek reference.
  62  */
  63 enum bt_notification_iterator_seek_origin {
  64         /** Seek at a time relative to the beginning of the trace. */
  65         BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_BEGIN = 0,
  66
  67         /** Seek at a time relative to the current position. */
  68         BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_CURRENT = 1,
  69
  70         /** Seek at a time relative to the end of the trace. */
  71         BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_END = 2,
  72
  73         /** Seek at a time relative to EPOCH. */
  74         BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_EPOCH = 3,
  75 };
  76
  77 struct bt_notification_iterator_next_return {
  78         struct bt_notification *notification;
  79         enum bt_notification_iterator_status status;
  80 };
  81
  82 /**
  83  * Get current notification at iterator's position.
  84  *
  85  * This functions will <b>not</b> advance the cursor's position.
  86  * The returned notification's reference count is already incremented.
  87  *
  88  * @param iterator      Iterator instance
  89  * @returns             Returns a bt_notification instance
  90  *
  91  * @see bt_put()
  92  */
  93 extern struct bt_notification *bt_notification_iterator_get_notification(
  94                 struct bt_notification_iterator *iterator);
  95
  96 /**
  97  * Advance the iterator's position forward.
  98  *
  99  * This function can be called repeatedly to iterate through the iterator's
 100  * associated trace.
 101  *
 102  * @param iterator      Iterator instance
 103  * @returns             Returns a bt_notification instance
 104  *
 105  * @see bt_notification_iterator_get_notification()
 106  */
 107 extern enum bt_notification_iterator_status
 108 bt_notification_iterator_next(struct bt_notification_iterator *iterator);
 109
 110 /**
 111  * Seek iterator to time.
 112  *
 113  * Sets the iterator's position for the trace associated with the iterator.
 114  * The new position is computed by adding \p time to the position specified
 115  * by \p seek_origin.
 116  *
 117  * time is expressed in nanoseconds.
 118  *
 119  * @param iterator      Iterator instance
 120  * @param seek_origin   One of #bt_notification_iterator_seek_type values.
 121  * @returns             One of #bt_notification_iterator_status values;
 122  *                      if \iterator does not support seeking,
 123  *                      #BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED is
 124  *                      returned.
 125  *
 126  * @see bt_notification_iterator_get_notification()
 127  */
 128 extern enum bt_notification_iterator_status bt_notification_iterator_seek_time(
 129                 struct bt_notification_iterator *iterator,
 130                 enum bt_notification_iterator_seek_origin seek_origin,
 131                 int64_t time);
 132
 133 extern struct bt_component *bt_notification_iterator_get_component(
 134                 struct bt_notification_iterator *iterator);
 135
 136 #ifdef __cplusplus
 137 }
 138 #endif
 139
 140 #endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_H */