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/clock-class-priority-map.h>
  31 #include <babeltrace/graph/clock-class-priority-map-internal.h>
  32 #include <babeltrace/graph/notification-internal.h>
  33 #include <babeltrace/graph/notification-inactivity-internal.h>
  34 #include <babeltrace/assert-pre-internal.h>
  35
  36 static
  37 void bt_notification_inactivity_destroy(struct bt_object *obj)
  38 {
  39         struct bt_notification_inactivity *notification =
  40                         (struct bt_notification_inactivity *) obj;
  41
  42         BT_LOGD("Destroying inactivity notification: addr=%p", notification);
  43         BT_LOGD_STR("Putting clock class priority map.");
  44         bt_put(notification->cc_prio_map);
  45
  46         if (notification->clock_values) {
  47                 BT_LOGD_STR("Putting clock values.");
  48                 g_hash_table_destroy(notification->clock_values);
  49         }
  50
  51         g_free(notification);
  52 }
  53
  54 struct bt_notification *bt_notification_inactivity_create(
  55                 struct bt_clock_class_priority_map *cc_prio_map)
  56 {
  57         struct bt_notification_inactivity *notification;
  58         struct bt_notification *ret_notif = NULL;
  59
  60         if (cc_prio_map) {
  61                 /* Function's reference, released at the end */
  62                 bt_get(cc_prio_map);
  63         } else {
  64                 cc_prio_map = bt_clock_class_priority_map_create();
  65                 if (!cc_prio_map) {
  66                         BT_LOGE_STR("Cannot create empty clock class priority map.");
  67                         goto error;
  68                 }
  69         }
  70
  71         BT_LOGD("Creating inactivity notification object: "
  72                 "cc-prio-map-addr=%p",
  73                 cc_prio_map);
  74         notification = g_new0(struct bt_notification_inactivity, 1);
  75         if (!notification) {
  76                 BT_LOGE_STR("Failed to allocate one inactivity notification.");
  77                 goto error;
  78         }
  79         bt_notification_init(&notification->parent,
  80                 BT_NOTIFICATION_TYPE_INACTIVITY,
  81                 bt_notification_inactivity_destroy);
  82         ret_notif = &notification->parent;
  83         notification->clock_values = g_hash_table_new_full(g_direct_hash,
  84                 g_direct_equal, bt_put, bt_put);
  85         if (!notification->clock_values) {
  86                 BT_LOGE_STR("Failed to allocate a GHashTable.");
  87                 goto error;
  88         }
  89
  90         notification->cc_prio_map = bt_get(cc_prio_map);
  91         BT_LOGD_STR("Freezing inactivity notification's clock class priority map.");
  92         bt_clock_class_priority_map_freeze(cc_prio_map);
  93         BT_LOGD("Created inactivity notification object: "
  94                 "cc-prio-map-addr=%p, notif-addr=%p",
  95                 cc_prio_map, ret_notif);
  96         goto end;
  97
  98 error:
  99         BT_PUT(ret_notif);
 100
 101 end:
 102         bt_put(cc_prio_map);
 103         return ret_notif;
 104 }
 105
 106 extern struct bt_clock_class_priority_map *
 107 bt_notification_inactivity_borrow_clock_class_priority_map(
 108                 struct bt_notification *notification)
 109 {
 110         struct bt_notification_inactivity *inactivity_notification;
 111
 112         BT_ASSERT_PRE_NON_NULL(notification, "Notification");
 113         BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
 114                 BT_NOTIFICATION_TYPE_INACTIVITY);
 115         inactivity_notification = container_of(notification,
 116                         struct bt_notification_inactivity, parent);
 117         return inactivity_notification->cc_prio_map;
 118 }
 119
 120 struct bt_clock_value *bt_notification_inactivity_borrow_clock_value(
 121                 struct bt_notification *notification,
 122                 struct bt_clock_class *clock_class)
 123 {
 124         struct bt_notification_inactivity *inactivity_notification;
 125
 126         BT_ASSERT_PRE_NON_NULL(notification, "Notification");
 127         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock_class");
 128         BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
 129                 BT_NOTIFICATION_TYPE_INACTIVITY);
 130         inactivity_notification = container_of(notification,
 131                 struct bt_notification_inactivity, parent);
 132         return g_hash_table_lookup(
 133                 inactivity_notification->clock_values, clock_class);
 134 }
 135
 136 BT_ASSERT_PRE_FUNC
 137 static inline bool cc_prio_map_contains_clock_class(
 138                 struct bt_clock_class_priority_map *cc_prio_map,
 139                 struct bt_clock_class *clock_class)
 140 {
 141         int ret = 0;
 142         uint64_t prio;
 143
 144         ret = bt_clock_class_priority_map_get_clock_class_priority(
 145                 cc_prio_map, clock_class, &prio);
 146         return ret == 0;
 147 }
 148
 149 int bt_notification_inactivity_set_clock_value(
 150                 struct bt_notification *notification,
 151                 struct bt_clock_value *clock_value)
 152 {
 153         struct bt_notification_inactivity *inactivity_notification;
 154
 155         BT_ASSERT_PRE_NON_NULL(notification, "Notification");
 156         BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value");
 157         BT_ASSERT_PRE_HOT(notification, "Notification",
 158                 ": +%!+n", notification);
 159         BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
 160                 BT_NOTIFICATION_TYPE_INACTIVITY);
 161         inactivity_notification = container_of(notification,
 162                         struct bt_notification_inactivity, parent);
 163         BT_ASSERT_PRE(cc_prio_map_contains_clock_class(
 164                 inactivity_notification->cc_prio_map, clock_value->clock_class),
 165                 "Clock value's class is not mapped to a priority within the scope of the inactivity notification: "
 166                 "notif-addr=%p, cc-prio-map-addr=%p, "
 167                 "clock-class-addr=%p, clock-class-name=\"%s\", "
 168                 "clock-value-addr=%p",
 169                 inactivity_notification,
 170                 inactivity_notification->cc_prio_map,
 171                 clock_value->clock_class,
 172                 bt_clock_class_get_name(clock_value->clock_class), clock_value);
 173         g_hash_table_insert(inactivity_notification->clock_values,
 174                 clock_value->clock_class, bt_get(clock_value));
 175         BT_LOGV("Set inactivity notification's clock value: "
 176                 "notif-addr=%p, cc-prio-map-addr=%p, "
 177                 "clock-class-addr=%p, clock-class-name=\"%s\", "
 178                 "clock-value-addr=%p",
 179                 inactivity_notification,
 180                 inactivity_notification->cc_prio_map,
 181                 clock_value->clock_class,
 182                 bt_clock_class_get_name(clock_value->clock_class), clock_value);
 183         return 0;
 184 }