lib/graph/notification/stream.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "NOTIF-STREAM"
  25 #include <babeltrace/lib-logging-internal.h>
  26
  27 #include <babeltrace/assert-pre-internal.h>
  28 #include <babeltrace/compiler-internal.h>
  29 #include <babeltrace/trace-ir/stream-internal.h>
  30 #include <babeltrace/trace-ir/stream-class.h>
  31 #include <babeltrace/trace-ir/stream-class-internal.h>
  32 #include <babeltrace/graph/notification-stream.h>
  33 #include <babeltrace/graph/notification-stream-const.h>
  34 #include <babeltrace/graph/notification-stream-internal.h>
  35 #include <babeltrace/assert-internal.h>
  36 #include <babeltrace/object.h>
  37 #include <inttypes.h>
  38
  39 static
  40 void bt_notification_stream_end_destroy(struct bt_object *obj)
  41 {
  42         struct bt_notification_stream_end *notification =
  43                         (struct bt_notification_stream_end *) obj;
  44
  45         BT_LIB_LOGD("Destroying stream end notification: %!+n",
  46                 notification);
  47         BT_LIB_LOGD("Putting stream: %!+s", notification->stream);
  48         BT_OBJECT_PUT_REF_AND_RESET(notification->stream);
  49
  50         if (notification->default_cv) {
  51                 bt_clock_value_recycle(notification->default_cv);
  52                 notification->default_cv = NULL;
  53         }
  54
  55         g_free(notification);
  56 }
  57
  58 struct bt_notification *bt_notification_stream_end_create(
  59                 struct bt_self_notification_iterator *self_notif_iter,
  60                 struct bt_stream *stream)
  61 {
  62         struct bt_notification_stream_end *notification;
  63         struct bt_stream_class *stream_class;
  64
  65         BT_ASSERT_PRE_NON_NULL(self_notif_iter, "Notification iterator");
  66         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
  67         stream_class = bt_stream_borrow_class(stream);
  68         BT_ASSERT(stream_class);
  69         BT_LIB_LOGD("Creating stream end notification object: "
  70                 "%![stream-]+s, %![sc-]+S", stream, stream_class);
  71         notification = g_new0(struct bt_notification_stream_end, 1);
  72         if (!notification) {
  73                 BT_LOGE_STR("Failed to allocate one stream end notification.");
  74                 goto error;
  75         }
  76
  77         bt_notification_init(&notification->parent,
  78                         BT_NOTIFICATION_TYPE_STREAM_END,
  79                         bt_notification_stream_end_destroy, NULL);
  80         notification->stream = stream;
  81         bt_object_get_no_null_check(notification->stream);
  82         BT_LIB_LOGD("Created stream end notification object: "
  83                 "%![notif-]+n, %![stream-]+s, %![sc-]+S", notification,
  84                 stream, stream_class);
  85
  86         return (void *) &notification->parent;
  87 error:
  88         return NULL;
  89 }
  90
  91 struct bt_stream *bt_notification_stream_end_borrow_stream(
  92                 struct bt_notification *notification)
  93 {
  94         struct bt_notification_stream_end *stream_end;
  95
  96         BT_ASSERT_PRE_NON_NULL(notification, "Notification");
  97         BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
  98                 BT_NOTIFICATION_TYPE_STREAM_END);
  99         stream_end = (void *) notification;
 100         return stream_end->stream;
 101 }
 102
 103 const struct bt_stream *bt_notification_stream_end_borrow_stream_const(
 104                 const struct bt_notification *notification)
 105 {
 106         return bt_notification_stream_end_borrow_stream(
 107                 (void *) notification);
 108 }
 109
 110 void bt_notification_stream_end_set_default_clock_value(
 111                 struct bt_notification *notif, uint64_t value_cycles)
 112 {
 113         struct bt_notification_stream_end *se_notif = (void *) notif;
 114
 115         BT_ASSERT_PRE_NON_NULL(notif, "Notification");
 116         BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
 117         BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_END);
 118         BT_ASSERT_PRE(se_notif->stream->class->default_clock_class,
 119                 "Notification's stream class has no default clock class: "
 120                 "%![notif-]+n, %![sc-]+S", notif, se_notif->stream->class);
 121
 122         /* TODO: have the object already created */
 123         se_notif->default_cv = bt_clock_value_create(
 124                 se_notif->stream->class->default_clock_class);
 125         BT_ASSERT(se_notif->default_cv);
 126         bt_clock_value_set_value_inline(se_notif->default_cv, value_cycles);
 127         BT_LIB_LOGV("Set notification's default clock value: %![notif-]+n, "
 128                 "value=%" PRIu64, value_cycles);
 129 }
 130
 131 struct bt_clock_value *bt_notification_stream_end_borrow_default_clock_value(
 132                 struct bt_notification *notif)
 133 {
 134         struct bt_notification_stream_end *stream_end = (void *) notif;
 135
 136         BT_ASSERT_PRE_NON_NULL(notif, "Notification");
 137         BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_END);
 138         return stream_end->default_cv;
 139 }
 140
 141 static
 142 void bt_notification_stream_beginning_destroy(struct bt_object *obj)
 143 {
 144         struct bt_notification_stream_beginning *notification =
 145                         (struct bt_notification_stream_beginning *) obj;
 146
 147         BT_LIB_LOGD("Destroying stream beginning notification: %!+n",
 148                 notification);
 149         BT_LIB_LOGD("Putting stream: %!+s", notification->stream);
 150         BT_OBJECT_PUT_REF_AND_RESET(notification->stream);
 151
 152         if (notification->default_cv) {
 153                 bt_clock_value_recycle(notification->default_cv);
 154                 notification->default_cv = NULL;
 155         }
 156
 157         g_free(notification);
 158 }
 159
 160 struct bt_notification *bt_notification_stream_beginning_create(
 161                 struct bt_self_notification_iterator *self_notif_iter,
 162                 struct bt_stream *stream)
 163 {
 164         struct bt_notification_stream_beginning *notification;
 165         struct bt_stream_class *stream_class;
 166
 167         BT_ASSERT_PRE_NON_NULL(self_notif_iter, "Notification iterator");
 168         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 169         stream_class = bt_stream_borrow_class(stream);
 170         BT_ASSERT(stream_class);
 171         BT_LIB_LOGD("Creating stream beginning notification object: "
 172                 "%![stream-]+s, %![sc-]+S", stream, stream_class);
 173         notification = g_new0(struct bt_notification_stream_beginning, 1);
 174         if (!notification) {
 175                 BT_LOGE_STR("Failed to allocate one stream beginning notification.");
 176                 goto error;
 177         }
 178
 179         bt_notification_init(&notification->parent,
 180                         BT_NOTIFICATION_TYPE_STREAM_BEGINNING,
 181                         bt_notification_stream_beginning_destroy, NULL);
 182         notification->stream = stream;
 183         bt_object_get_no_null_check(notification->stream);
 184         BT_LIB_LOGD("Created stream beginning notification object: "
 185                 "%![notif-]+n, %![stream-]+s, %![sc-]+S", notification,
 186                 stream, stream_class);
 187         return (void *) &notification->parent;
 188 error:
 189         return NULL;
 190 }
 191
 192 struct bt_stream *bt_notification_stream_beginning_borrow_stream(
 193                 struct bt_notification *notification)
 194 {
 195         struct bt_notification_stream_beginning *stream_begin;
 196
 197         BT_ASSERT_PRE_NON_NULL(notification, "Notification");
 198         BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
 199                 BT_NOTIFICATION_TYPE_STREAM_BEGINNING);
 200         stream_begin = (void *) notification;
 201         return stream_begin->stream;
 202 }
 203
 204 const struct bt_stream *bt_notification_stream_beginning_borrow_stream_const(
 205                 const struct bt_notification *notification)
 206 {
 207         return bt_notification_stream_beginning_borrow_stream(
 208                 (void *) notification);
 209 }
 210
 211 void bt_notification_stream_beginning_set_default_clock_value(
 212                 struct bt_notification *notif,
 213                 uint64_t value_cycles)
 214 {
 215         struct bt_notification_stream_beginning *sb_notif = (void *) notif;
 216
 217         BT_ASSERT_PRE_NON_NULL(notif, "Notification");
 218         BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
 219         BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGINNING);
 220         BT_ASSERT_PRE(sb_notif->stream->class->default_clock_class,
 221                 "Notification's stream class has no default clock class: "
 222                 "%![notif-]+n, %![sc-]+S", notif, sb_notif->stream->class);
 223
 224         /* TODO: have the object already created */
 225         sb_notif->default_cv = bt_clock_value_create(
 226                 sb_notif->stream->class->default_clock_class);
 227         BT_ASSERT(sb_notif->default_cv);
 228         bt_clock_value_set_value_inline(sb_notif->default_cv, value_cycles);
 229         BT_LIB_LOGV("Set notification's default clock value: %![notif-]+n, "
 230                 "value=%" PRIu64, value_cycles);
 231 }
 232
 233 struct bt_clock_value *bt_notification_stream_beginning_borrow_default_clock_value(
 234                 struct bt_notification *notif)
 235 {
 236         struct bt_notification_stream_beginning *stream_begin = (void *) notif;
 237
 238         BT_ASSERT_PRE_NON_NULL(notif, "Notification");
 239         BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGINNING);
 240         return stream_begin->default_cv;
 241 }