2 * clock-class-priority-map.c
4 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #define BT_LOG_TAG "CC-PRIO-MAP"
26 #include <babeltrace/lib-logging-internal.h>
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>
42 void bt_clock_class_priority_map_destroy(struct bt_object
*obj
)
44 struct bt_clock_class_priority_map
*cc_prio_map
= (void *) obj
;
46 BT_LOGD("Destroying component class priority map object: addr=%p",
49 if (cc_prio_map
->entries
) {
50 BT_LOGD("Putting clock classes.");
51 g_ptr_array_free(cc_prio_map
->entries
, TRUE
);
54 if (cc_prio_map
->prios
) {
55 g_hash_table_destroy(cc_prio_map
->prios
);
61 struct bt_clock_class_priority_map
*bt_clock_class_priority_map_create()
63 struct bt_clock_class_priority_map
*cc_prio_map
= NULL
;
65 BT_LOGD_STR("Creating clock class priority map object.");
67 cc_prio_map
= g_new0(struct bt_clock_class_priority_map
, 1);
69 BT_LOGE_STR("Failed to allocate one clock class priority map.");
73 bt_object_init_shared(&cc_prio_map
->base
,
74 bt_clock_class_priority_map_destroy
);
75 cc_prio_map
->entries
= g_ptr_array_new_with_free_func(
76 (GDestroyNotify
) bt_put
);
77 if (!cc_prio_map
->entries
) {
78 BT_LOGE_STR("Failed to allocate a GPtrArray.");
82 cc_prio_map
->prios
= g_hash_table_new_full(g_direct_hash
,
83 g_direct_equal
, NULL
, (GDestroyNotify
) g_free
);
84 if (!cc_prio_map
->entries
) {
85 BT_LOGE_STR("Failed to allocate a GHashTable.");
89 BT_LOGD("Created clock class priority map object: addr=%p",
100 int64_t bt_clock_class_priority_map_get_clock_class_count(
101 struct bt_clock_class_priority_map
*cc_prio_map
)
103 BT_ASSERT_PRE_NON_NULL(cc_prio_map
, "Clock class priority map");
104 return (int64_t) cc_prio_map
->entries
->len
;
107 struct bt_clock_class
*bt_clock_class_priority_map_borrow_clock_class_by_index(
108 struct bt_clock_class_priority_map
*cc_prio_map
,
111 BT_ASSERT_PRE_NON_NULL(cc_prio_map
, "Clock class priority map");
112 BT_ASSERT_PRE(index
< cc_prio_map
->entries
->len
,
113 "Index is out of bounds: index=%" PRIu64
", count=%" PRIu64
,
114 index
, cc_prio_map
->entries
->len
);
115 return g_ptr_array_index(cc_prio_map
->entries
, index
);
118 struct bt_clock_class
*bt_clock_class_priority_map_borrow_clock_class_by_name(
119 struct bt_clock_class_priority_map
*cc_prio_map
,
123 struct bt_clock_class
*clock_class
= NULL
;
125 BT_ASSERT_PRE_NON_NULL(cc_prio_map
, "Clock class priority map");
126 BT_ASSERT_PRE_NON_NULL(name
, "Name");
128 for (i
= 0; i
< cc_prio_map
->entries
->len
; i
++) {
129 struct bt_clock_class
*cur_cc
=
130 g_ptr_array_index(cc_prio_map
->entries
, i
);
131 const char *cur_cc_name
=
132 bt_clock_class_get_name(cur_cc
);
134 BT_ASSERT(cur_cc_name
);
136 if (strcmp(cur_cc_name
, name
) == 0) {
137 clock_class
= cur_cc
;
147 struct clock_class_prio
{
149 struct bt_clock_class
*clock_class
;
153 void current_highest_prio_gh_func(gpointer key
, gpointer value
,
156 struct clock_class_prio
*func_data
= user_data
;
157 uint64_t *prio
= value
;
159 if (*prio
<= func_data
->prio
) {
160 func_data
->prio
= *prio
;
161 func_data
->clock_class
= key
;
166 struct clock_class_prio
bt_clock_class_priority_map_current_highest_prio(
167 struct bt_clock_class_priority_map
*cc_prio_map
)
169 struct clock_class_prio func_data
= {
174 g_hash_table_foreach(cc_prio_map
->prios
, current_highest_prio_gh_func
,
179 struct bt_clock_class
*
180 bt_clock_class_priority_map_borrow_highest_priority_clock_class(
181 struct bt_clock_class_priority_map
*cc_prio_map
)
183 BT_ASSERT_PRE_NON_NULL(cc_prio_map
, "Clock class priority map");
184 return cc_prio_map
->highest_prio_cc
;
187 int bt_clock_class_priority_map_get_clock_class_priority(
188 struct bt_clock_class_priority_map
*cc_prio_map
,
189 struct bt_clock_class
*clock_class
, uint64_t *priority
)
194 BT_ASSERT_PRE_NON_NULL(cc_prio_map
, "Clock class priority map");
195 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
196 BT_ASSERT_PRE_NON_NULL(priority
, "Priority");
197 prio
= g_hash_table_lookup(cc_prio_map
->prios
, clock_class
);
199 BT_LOGV("Clock class does not exist in clock class priority map: "
200 "cc-prio-map-addr=%p, clock-class-addr=%p, "
201 "clock-class-name=\"%s\"",
202 cc_prio_map
, clock_class
,
203 bt_clock_class_get_name(clock_class
));
214 int bt_clock_class_priority_map_add_clock_class(
215 struct bt_clock_class_priority_map
*cc_prio_map
,
216 struct bt_clock_class
*clock_class
, uint64_t priority
)
219 uint64_t *prio_ptr
= NULL
;
220 struct clock_class_prio cc_prio
;
222 // FIXME when available: check
223 // bt_clock_class_is_valid(clock_class)
224 BT_ASSERT_PRE_NON_NULL(cc_prio_map
, "Clock class priority map");
225 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
226 BT_ASSERT_PRE_HOT(cc_prio_map
, "Clock class priority map", "");
228 /* Check for existing clock class */
229 prio_ptr
= g_hash_table_lookup(cc_prio_map
->prios
, clock_class
);
231 *prio_ptr
= priority
;
233 goto set_highest_prio
;
236 prio_ptr
= g_new(uint64_t, 1);
238 BT_LOGE_STR("Failed to allocate a uint64_t.");
243 *prio_ptr
= priority
;
245 g_ptr_array_add(cc_prio_map
->entries
, clock_class
);
246 g_hash_table_insert(cc_prio_map
->prios
, clock_class
, prio_ptr
);
250 cc_prio
= bt_clock_class_priority_map_current_highest_prio(
252 BT_ASSERT(cc_prio
.clock_class
);
253 cc_prio_map
->highest_prio_cc
= cc_prio
.clock_class
;
254 BT_LOGV("Added clock class to clock class priority map: "
255 "cc-prio-map-addr=%p, added-clock-class-addr=%p, "
256 "added-clock-class-name=\"%s\", "
257 "highest-prio-clock-class-addr=%p, "
258 "highest-prio-clock-class-name=\"%s\"",
259 cc_prio_map
, clock_class
,
260 bt_clock_class_get_name(clock_class
),
262 bt_clock_class_get_name(cc_prio
.clock_class
));
270 struct bt_clock_class_priority_map
*bt_clock_class_priority_map_copy(
271 struct bt_clock_class_priority_map
*orig_cc_prio_map
)
273 struct bt_clock_class_priority_map
*cc_prio_map
;
276 cc_prio_map
= bt_clock_class_priority_map_create();
278 BT_LOGE_STR("Cannot create empty clock class priority map.");
282 for (i
= 0; i
< orig_cc_prio_map
->entries
->len
; i
++) {
283 struct bt_clock_class
*clock_class
=
284 g_ptr_array_index(orig_cc_prio_map
->entries
, i
);
285 uint64_t *prio
= g_hash_table_lookup(orig_cc_prio_map
->prios
,
287 int ret
= bt_clock_class_priority_map_add_clock_class(
288 cc_prio_map
, clock_class
, *prio
);
291 BT_LOGE("Cannot add clock class to clock class priority map copy: "
292 "cc-prio-map-copy-addr=%p, clock-class-addr=%p, "
293 "clock-class-name=\"%s\"",
294 cc_prio_map
, clock_class
,
295 bt_clock_class_get_name(clock_class
));
300 cc_prio_map
->highest_prio_cc
= orig_cc_prio_map
->highest_prio_cc
;
301 BT_LOGD("Copied clock class priority map: "
302 "original-addr=%p, copy-addr=%p",
303 orig_cc_prio_map
, cc_prio_map
);