lib/graph/clock-class-priority-map.c

   1 /*
   2  * clock-class-priority-map.c
   3  *
   4  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24
  25 #define BT_LOG_TAG "CC-PRIO-MAP"
  26 #include <babeltrace/lib-logging-internal.h>
  27
  28 #include <babeltrace/graph/clock-class-priority-map.h>
  29 #include <babeltrace/graph/clock-class-priority-map-internal.h>
  30 #include <babeltrace/ctf-ir/clock-class.h>
  31 #include <babeltrace/ctf-ir/clock-class-internal.h>
  32 #include <babeltrace/babeltrace-internal.h>
  33 #include <babeltrace/compiler-internal.h>
  34 #include <babeltrace/ref.h>
  35 #include <babeltrace/assert-internal.h>
  36 #include <babeltrace/assert-pre-internal.h>
  37 #include <stdint.h>
  38 #include <inttypes.h>
  39 #include <glib.h>
  40
  41 static
  42 void bt_clock_class_priority_map_destroy(struct bt_object *obj)
  43 {
  44         struct bt_clock_class_priority_map *cc_prio_map = (void *) obj;
  45
  46         BT_LOGD("Destroying component class priority map object: addr=%p",
  47                 cc_prio_map);
  48
  49         if (cc_prio_map->entries) {
  50                 BT_LOGD("Putting clock classes.");
  51                 g_ptr_array_free(cc_prio_map->entries, TRUE);
  52         }
  53
  54         if (cc_prio_map->prios) {
  55                 g_hash_table_destroy(cc_prio_map->prios);
  56         }
  57
  58         g_free(cc_prio_map);
  59 }
  60
  61 struct bt_clock_class_priority_map *bt_clock_class_priority_map_create()
  62 {
  63         struct bt_clock_class_priority_map *cc_prio_map = NULL;
  64
  65         BT_LOGD_STR("Creating clock class priority map object.");
  66
  67         cc_prio_map = g_new0(struct bt_clock_class_priority_map, 1);
  68         if (!cc_prio_map) {
  69                 BT_LOGE_STR("Failed to allocate one clock class priority map.");
  70                 goto error;
  71         }
  72
  73         bt_object_init(cc_prio_map, bt_clock_class_priority_map_destroy);
  74         cc_prio_map->entries = g_ptr_array_new_with_free_func(
  75                 (GDestroyNotify) bt_put);
  76         if (!cc_prio_map->entries) {
  77                 BT_LOGE_STR("Failed to allocate a GPtrArray.");
  78                 goto error;
  79         }
  80
  81         cc_prio_map->prios = g_hash_table_new_full(g_direct_hash,
  82                 g_direct_equal, NULL, (GDestroyNotify) g_free);
  83         if (!cc_prio_map->entries) {
  84                 BT_LOGE_STR("Failed to allocate a GHashTable.");
  85                 goto error;
  86         }
  87
  88         BT_LOGD("Created clock class priority map object: addr=%p",
  89                 cc_prio_map);
  90         goto end;
  91
  92 error:
  93         BT_PUT(cc_prio_map);
  94
  95 end:
  96         return cc_prio_map;
  97 }
  98
  99 int64_t bt_clock_class_priority_map_get_clock_class_count(
 100                 struct bt_clock_class_priority_map *cc_prio_map)
 101 {
 102         BT_ASSERT_PRE_NON_NULL(cc_prio_map, "Clock class priority map");
 103         return (int64_t) cc_prio_map->entries->len;
 104 }
 105
 106 struct bt_clock_class *bt_clock_class_priority_map_get_clock_class_by_index(
 107                 struct bt_clock_class_priority_map *cc_prio_map,
 108                 uint64_t index)
 109 {
 110         BT_ASSERT_PRE_NON_NULL(cc_prio_map, "Clock class priority map");
 111         BT_ASSERT_PRE(index < cc_prio_map->entries->len,
 112                 "Index is out of bounds: index=%" PRIu64 ", count=%" PRIu64,
 113                 index, cc_prio_map->entries->len);
 114         return bt_get(g_ptr_array_index(cc_prio_map->entries, index));
 115 }
 116
 117 struct bt_clock_class *bt_clock_class_priority_map_get_clock_class_by_name(
 118                 struct bt_clock_class_priority_map *cc_prio_map,
 119                 const char *name)
 120 {
 121         size_t i;
 122         struct bt_clock_class *clock_class = NULL;
 123
 124         BT_ASSERT_PRE_NON_NULL(cc_prio_map, "Clock class priority map");
 125         BT_ASSERT_PRE_NON_NULL(name, "Name");
 126
 127         for (i = 0; i < cc_prio_map->entries->len; i++) {
 128                 struct bt_clock_class *cur_cc =
 129                         g_ptr_array_index(cc_prio_map->entries, i);
 130                 const char *cur_cc_name =
 131                         bt_clock_class_get_name(cur_cc);
 132
 133                 BT_ASSERT(cur_cc_name);
 134
 135                 if (strcmp(cur_cc_name, name) == 0) {
 136                         clock_class = bt_get(cur_cc);
 137                         goto end;
 138                 }
 139         }
 140
 141 end:
 142         return clock_class;
 143 }
 144
 145
 146 struct clock_class_prio {
 147         uint64_t prio;
 148         struct bt_clock_class *clock_class;
 149 };
 150
 151 static
 152 void current_highest_prio_gh_func(gpointer key, gpointer value,
 153                 gpointer user_data)
 154 {
 155         struct clock_class_prio *func_data = user_data;
 156         uint64_t *prio = value;
 157
 158         if (*prio <= func_data->prio) {
 159                 func_data->prio = *prio;
 160                 func_data->clock_class = key;
 161         }
 162 }
 163
 164 static
 165 struct clock_class_prio bt_clock_class_priority_map_current_highest_prio(
 166                 struct bt_clock_class_priority_map *cc_prio_map)
 167 {
 168         struct clock_class_prio func_data = {
 169                 .prio = -1ULL,
 170                 .clock_class = NULL,
 171         };
 172
 173         g_hash_table_foreach(cc_prio_map->prios, current_highest_prio_gh_func,
 174                 &func_data);
 175         return func_data;
 176 }
 177
 178 struct bt_clock_class *
 179 bt_clock_class_priority_map_get_highest_priority_clock_class(
 180                 struct bt_clock_class_priority_map *cc_prio_map)
 181 {
 182         BT_ASSERT_PRE_NON_NULL(cc_prio_map, "Clock class priority map");
 183         return(bt_get(cc_prio_map->highest_prio_cc));
 184 }
 185
 186 int bt_clock_class_priority_map_get_clock_class_priority(
 187                 struct bt_clock_class_priority_map *cc_prio_map,
 188                 struct bt_clock_class *clock_class, uint64_t *priority)
 189 {
 190         int ret = 0;
 191         uint64_t *prio;
 192
 193         BT_ASSERT_PRE_NON_NULL(cc_prio_map, "Clock class priority map");
 194         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 195         BT_ASSERT_PRE_NON_NULL(priority, "Priority");
 196         prio = g_hash_table_lookup(cc_prio_map->prios, clock_class);
 197         if (!prio) {
 198                 BT_LOGV("Clock class does not exist in clock class priority map: "
 199                         "cc-prio-map-addr=%p, clock-class-addr=%p, "
 200                         "clock-class-name=\"%s\"",
 201                         cc_prio_map, clock_class,
 202                         bt_clock_class_get_name(clock_class));
 203                 ret = -1;
 204                 goto end;
 205         }
 206
 207         *priority = *prio;
 208
 209 end:
 210         return ret;
 211 }
 212
 213 int bt_clock_class_priority_map_add_clock_class(
 214                 struct bt_clock_class_priority_map *cc_prio_map,
 215                 struct bt_clock_class *clock_class, uint64_t priority)
 216 {
 217         int ret = 0;
 218         uint64_t *prio_ptr = NULL;
 219         struct clock_class_prio cc_prio;
 220
 221         // FIXME when available: check
 222         // bt_clock_class_is_valid(clock_class)
 223         BT_ASSERT_PRE_NON_NULL(cc_prio_map, "Clock class priority map");
 224         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 225         BT_ASSERT_PRE_HOT(cc_prio_map, "Clock class priority map", "");
 226
 227         /* Check for existing clock class */
 228         prio_ptr = g_hash_table_lookup(cc_prio_map->prios, clock_class);
 229         if (prio_ptr) {
 230                 *prio_ptr = priority;
 231                 prio_ptr = NULL;
 232                 goto set_highest_prio;
 233         }
 234
 235         prio_ptr = g_new(uint64_t, 1);
 236         if (!prio_ptr) {
 237                 BT_LOGE_STR("Failed to allocate a uint64_t.");
 238                 ret = -1;
 239                 goto end;
 240         }
 241
 242         *prio_ptr = priority;
 243         bt_get(clock_class);
 244         g_ptr_array_add(cc_prio_map->entries, clock_class);
 245         g_hash_table_insert(cc_prio_map->prios, clock_class, prio_ptr);
 246         prio_ptr = NULL;
 247
 248 set_highest_prio:
 249         cc_prio = bt_clock_class_priority_map_current_highest_prio(
 250                 cc_prio_map);
 251         BT_ASSERT(cc_prio.clock_class);
 252         cc_prio_map->highest_prio_cc = cc_prio.clock_class;
 253         BT_LOGV("Added clock class to clock class priority map: "
 254                 "cc-prio-map-addr=%p, added-clock-class-addr=%p, "
 255                 "added-clock-class-name=\"%s\", "
 256                 "highest-prio-clock-class-addr=%p, "
 257                 "highest-prio-clock-class-name=\"%s\"",
 258                 cc_prio_map, clock_class,
 259                 bt_clock_class_get_name(clock_class),
 260                 cc_prio.clock_class,
 261                 bt_clock_class_get_name(cc_prio.clock_class));
 262
 263 end:
 264         g_free(prio_ptr);
 265
 266         return ret;
 267 }
 268
 269 struct bt_clock_class_priority_map *bt_clock_class_priority_map_copy(
 270                 struct bt_clock_class_priority_map *orig_cc_prio_map)
 271 {
 272         struct bt_clock_class_priority_map *cc_prio_map;
 273         size_t i;
 274
 275         cc_prio_map = bt_clock_class_priority_map_create();
 276         if (!cc_prio_map) {
 277                 BT_LOGE_STR("Cannot create empty clock class priority map.");
 278                 goto error;
 279         }
 280
 281         for (i = 0; i < orig_cc_prio_map->entries->len; i++) {
 282                 struct bt_clock_class *clock_class =
 283                         g_ptr_array_index(orig_cc_prio_map->entries, i);
 284                 uint64_t *prio = g_hash_table_lookup(orig_cc_prio_map->prios,
 285                         clock_class);
 286                 int ret = bt_clock_class_priority_map_add_clock_class(
 287                         cc_prio_map, clock_class, *prio);
 288
 289                 if (ret) {
 290                         BT_LOGE("Cannot add clock class to clock class priority map copy: "
 291                                 "cc-prio-map-copy-addr=%p, clock-class-addr=%p, "
 292                                 "clock-class-name=\"%s\"",
 293                                 cc_prio_map, clock_class,
 294                                 bt_clock_class_get_name(clock_class));
 295                         goto error;
 296                 }
 297         }
 298
 299         cc_prio_map->highest_prio_cc = orig_cc_prio_map->highest_prio_cc;
 300         BT_LOGD("Copied clock class priority map: "
 301                 "original-addr=%p, copy-addr=%p",
 302                 orig_cc_prio_map, cc_prio_map);
 303         goto end;
 304
 305 error:
 306         BT_PUT(cc_prio_map);
 307
 308 end:
 309         return cc_prio_map;
 310 }