lib/graph/notification/inactivity.c

   1 /*
   2  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22
  23 #define BT_LOG_TAG "NOTIF-INACTIVITY"
  24 #include <babeltrace/lib-logging-internal.h>
  25
  26 #include <babeltrace/object-internal.h>
  27 #include <babeltrace/compiler-internal.h>
  28 #include <babeltrace/ctf-ir/clock-class.h>
  29 #include <babeltrace/ctf-ir/clock-value-internal.h>
  30 #include <babeltrace/graph/notification-internal.h>
  31 #include <babeltrace/graph/notification-inactivity-internal.h>
  32 #include <babeltrace/graph/private-connection-private-notification-iterator.h>
  33 #include <babeltrace/assert-pre-internal.h>
  34
  35 static
  36 void bt_notification_inactivity_destroy(struct bt_object *obj)
  37 {
  38         struct bt_notification_inactivity *notification =
  39                         (struct bt_notification_inactivity *) obj;
  40
  41         BT_LOGD("Destroying inactivity notification: addr=%p", notification);
  42
  43         if (notification->default_cv) {
  44                 bt_clock_value_recycle(notification->default_cv);
  45         }
  46
  47         g_free(notification);
  48 }
  49
  50 struct bt_notification *bt_notification_inactivity_create(
  51                 struct bt_private_connection_private_notification_iterator *notif_iter,
  52                 struct bt_clock_class *default_clock_class)
  53 {
  54         struct bt_notification_inactivity *notification;
  55         struct bt_notification *ret_notif = NULL;
  56
  57         BT_ASSERT_PRE_NON_NULL(notif_iter, "Notification iterator");
  58         BT_ASSERT_PRE_NON_NULL(default_clock_class, "Default clock class");
  59         BT_LOGD_STR("Creating inactivity notification object.");
  60         notification = g_new0(struct bt_notification_inactivity, 1);
  61         if (!notification) {
  62                 BT_LOGE_STR("Failed to allocate one inactivity notification.");
  63                 goto error;
  64         }
  65         bt_notification_init(&notification->parent,
  66                 BT_NOTIFICATION_TYPE_INACTIVITY,
  67                 bt_notification_inactivity_destroy, NULL);
  68         ret_notif = &notification->parent;
  69         notification->default_cv = bt_clock_value_create(default_clock_class);
  70         if (!notification->default_cv) {
  71                 goto error;
  72         }
  73
  74         BT_LOGD("Created inactivity notification object: addr=%p",
  75                 ret_notif);
  76         goto end;
  77
  78 error:
  79         BT_PUT(ret_notif);
  80
  81 end:
  82         return ret_notif;
  83 }
  84
  85 int bt_notification_inactivity_set_default_clock_value(
  86                 struct bt_notification *notif, uint64_t value_cycles)
  87 {
  88         struct bt_notification_inactivity *inactivity = (void *) notif;
  89
  90         BT_ASSERT_PRE_NON_NULL(notif, "Notification");
  91         BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_INACTIVITY);
  92         BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
  93         bt_clock_value_set_value_inline(inactivity->default_cv, value_cycles);
  94         BT_LIB_LOGV("Set inactivity notification's default clock value: "
  95                 "%![notif-]+n, value=%" PRIu64, notif, value_cycles);
  96         return 0;
  97 }
  98
  99 struct bt_clock_value *bt_notification_inactivity_borrow_default_clock_value(
 100                 struct bt_notification *notif)
 101 {
 102         struct bt_notification_inactivity *inactivity = (void *) notif;
 103
 104         BT_ASSERT_PRE_NON_NULL(notif, "Notification");
 105         BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_INACTIVITY);
 106         return inactivity->default_cv;
 107 }