lib/ctf-ir/clock-class.c: improve logging with clock class's name

Clock class log statements should be easier to follow with a clock
class's name field.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/lib/ctf-ir/clock-class.c b/lib/ctf-ir/clock-class.c
index 345b7b1677cd51fe11ebe08e2f4d3eac97f11762..87c3d6bbf74f587d5de6709c513096e2a6a14b9d 100644 (file)
--- a/lib/ctf-ir/clock-class.c
+++ b/lib/ctf-ir/clock-class.c
@@ -58,15 +58,15 @@ int bt_ctf_clock_class_set_name(struct bt_ctf_clock_class *clock_class,
        }
 
        if (clock_class->frozen) {
-               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p",
-                       clock_class);
+               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class));
                ret = -1;
                goto end;
        }
 
        if (bt_ctf_validate_identifier(name)) {
                BT_LOGE("Clock class's name is not a valid CTF identifier: "
-                       "clock-class-addr=%p, name=\"%s\"",
+                       "addr=%p, name=\"%s\"",
                        clock_class, name);
                ret = -1;
                goto end;
@@ -83,7 +83,7 @@ int bt_ctf_clock_class_set_name(struct bt_ctf_clock_class *clock_class,
                }
        }
 
-       BT_LOGV("Set clock class's name: clock-class-addr=%p, name=\"%s\"",
+       BT_LOGV("Set clock class's name: addr=%p, name=\"%s\"",
                clock_class, name);
 
 end:
@@ -111,7 +111,7 @@ struct bt_ctf_clock_class *bt_ctf_clock_class_create(const char *name)
                ret = bt_ctf_clock_class_set_name(clock_class, name);
                if (ret) {
                        BT_LOGE("Cannot set clock class's name: "
-                               "clock-class-addr=%p, name=\"%s\"",
+                               "addr=%p, name=\"%s\"",
                                clock_class, name);
                        goto error;
                }
@@ -124,7 +124,8 @@ struct bt_ctf_clock_class *bt_ctf_clock_class_create(const char *name)
        }
 
        clock_class->uuid_set = 1;
-       BT_LOGD("Created clock class object: addr=%p", clock_class);
+       BT_LOGD("Created clock class object: addr=%p, name=\"%s\"",
+               clock_class, name);
        return clock_class;
 error:
        BT_PUT(clock_class);
@@ -172,23 +173,25 @@ int bt_ctf_clock_class_set_description(struct bt_ctf_clock_class *clock_class,
 
        if (!clock_class || !desc) {
                BT_LOGW("Invalid parameter: clock class or description is NULL: "
-                       "clock-class-addr=%p, desc-addr=%p",
-                       clock_class, desc);
+                       "clock-class-addr=%p, name=\"%s\", desc-addr=%p",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class),
+                       desc);
                ret = -1;
                goto end;
        }
 
        if (clock_class->frozen) {
-               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p",
-                       clock_class);
+               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class));
                ret = -1;
                goto end;
        }
 
        clock_class->description = g_string_new(desc);
        ret = clock_class->description ? 0 : -1;
-       BT_LOGV("Set clock class's description: clock-class-addr=%p, desc=\"%s\"",
-               clock_class, desc);
+       BT_LOGV("Set clock class's description: addr=%p, "
+               "name=\"%s\", desc=\"%s\"",
+               clock_class, bt_ctf_clock_class_get_name(clock_class), desc);
 end:
        return ret;
 }
@@ -215,22 +218,23 @@ int bt_ctf_clock_class_set_frequency(struct bt_ctf_clock_class *clock_class,
 
        if (!clock_class || freq == -1ULL) {
                BT_LOGW("Invalid parameter: clock class is NULL or frequency is invalid: "
-                       "clock-class-addr=%p, freq=%" PRIu64,
-                       clock_class, freq);
+                       "addr=%p, name=\"%s\", freq=%" PRIu64,
+                       clock_class, bt_ctf_clock_class_get_name(clock_class),
+                       freq);
                ret = -1;
                goto end;
        }
 
        if (clock_class->frozen) {
-               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p",
-                       clock_class);
+               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class));
                ret = -1;
                goto end;
        }
 
        clock_class->frequency = freq;
-       BT_LOGV("Set clock class's frequency: clock-class-addr=%p, freq=%" PRIu64,
-               clock_class, freq);
+       BT_LOGV("Set clock class's frequency: addr=%p, name=\"%s\", freq=%" PRIu64,
+               clock_class, bt_ctf_clock_class_get_name(clock_class), freq);
 end:
        return ret;
 }
@@ -256,22 +260,24 @@ int bt_ctf_clock_class_set_precision(struct bt_ctf_clock_class *clock_class,
 
        if (!clock_class || precision == -1ULL) {
                BT_LOGW("Invalid parameter: clock class is NULL or precision is invalid: "
-                       "clock-class-addr=%p, precision=%" PRIu64,
-                       clock_class, precision);
+                       "addr=%p, name=\"%s\", precision=%" PRIu64,
+                       clock_class, bt_ctf_clock_class_get_name(clock_class),
+                       precision);
                ret = -1;
                goto end;
        }
 
        if (clock_class->frozen) {
-               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p",
-                       clock_class);
+               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class));
                ret = -1;
                goto end;
        }
 
        clock_class->precision = precision;
-       BT_LOGV("Set clock class's precision: clock-class-addr=%p, precision=%" PRIu64,
-               clock_class, precision);
+       BT_LOGV("Set clock class's precision: addr=%p, name=\"%s\", precision=%" PRIu64,
+               clock_class, bt_ctf_clock_class_get_name(clock_class),
+               precision);
 end:
        return ret;
 }
@@ -283,8 +289,9 @@ int bt_ctf_clock_class_get_offset_s(struct bt_ctf_clock_class *clock_class,
 
        if (!clock_class || !offset_s) {
                BT_LOGW("Invalid parameter: clock class or offset pointer is NULL: "
-                       "clock-class-addr=%p, offset-addr=%p",
-                       clock_class, offset_s);
+                       "clock-class-addr=%p, name=\"%s\", offset-addr=%p",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class),
+                       offset_s);
                ret = -1;
                goto end;
        }
@@ -306,15 +313,17 @@ int bt_ctf_clock_class_set_offset_s(struct bt_ctf_clock_class *clock_class,
        }
 
        if (clock_class->frozen) {
-               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p",
-                       clock_class);
+               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class));
                ret = -1;
                goto end;
        }
 
        clock_class->offset_s = offset_s;
-       BT_LOGV("Set clock class's offset (seconds): clock-class-addr=%p, offset-s=%" PRId64,
-               clock_class, offset_s);
+       BT_LOGV("Set clock class's offset (seconds): "
+               "addr=%p, name=\"%s\", offset-s=%" PRId64,
+               clock_class, bt_ctf_clock_class_get_name(clock_class),
+               offset_s);
 end:
        return ret;
 }
@@ -326,8 +335,9 @@ int bt_ctf_clock_class_get_offset_cycles(struct bt_ctf_clock_class *clock_class,
 
        if (!clock_class || !offset) {
                BT_LOGW("Invalid parameter: clock class or offset pointer is NULL: "
-                       "clock-class-addr=%p, offset-addr=%p",
-                       clock_class, offset);
+                       "clock-class-addr=%p, name=\"%s\", offset-addr=%p",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class),
+                       offset);
                ret = -1;
                goto end;
        }
@@ -349,15 +359,15 @@ int bt_ctf_clock_class_set_offset_cycles(struct bt_ctf_clock_class *clock_class,
        }
 
        if (clock_class->frozen) {
-               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p",
-                       clock_class);
+               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class));
                ret = -1;
                goto end;
        }
 
        clock_class->offset = offset;
-       BT_LOGV("Set clock class's offset (cycles): clock-class-addr=%p, offset-cycles=%" PRId64,
-               clock_class, offset);
+       BT_LOGV("Set clock class's offset (cycles): addr=%p, name=\"%s\", offset-cycles=%" PRId64,
+               clock_class, bt_ctf_clock_class_get_name(clock_class), offset);
 end:
        return ret;
 }
@@ -388,15 +398,16 @@ int bt_ctf_clock_class_set_is_absolute(struct bt_ctf_clock_class *clock_class,
        }
 
        if (clock_class->frozen) {
-               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p",
-                       clock_class);
+               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class));
                ret = -1;
                goto end;
        }
 
        clock_class->absolute = !!is_absolute;
-       BT_LOGV("Set clock class's absolute flag: clock-class-addr=%p, is-absolute=%d",
-               clock_class, !!is_absolute);
+       BT_LOGV("Set clock class's absolute flag: addr=%p, name=\"%s\", is-absolute=%d",
+               clock_class, bt_ctf_clock_class_get_name(clock_class),
+               is_absolute);
 end:
        return ret;
 }
@@ -413,8 +424,8 @@ const unsigned char *bt_ctf_clock_class_get_uuid(
        }
 
        if (!clock_class->uuid_set) {
-               BT_LOGV("Clock class's UUID is not set: clock-class-addr=%p",
-                       clock_class);
+               BT_LOGV("Clock class's UUID is not set: addr=%p, name=\"%s\"",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class));
                ret = NULL;
                goto end;
        }
@@ -431,24 +442,25 @@ int bt_ctf_clock_class_set_uuid(struct bt_ctf_clock_class *clock_class,
 
        if (!clock_class || !uuid) {
                BT_LOGW("Invalid parameter: clock class or UUID is NULL: "
-                       "clock-class-addr=%p, uuid-addr=%p",
-                       clock_class, uuid);
+                       "clock-class-addr=%p, name=\"%s\", uuid-addr=%p",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class),
+                       uuid);
                ret = -1;
                goto end;
        }
 
        if (clock_class->frozen) {
-               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p",
-                       clock_class);
+               BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class));
                ret = -1;
                goto end;
        }
 
        memcpy(clock_class->uuid, uuid, sizeof(uuid_t));
        clock_class->uuid_set = 1;
-       BT_LOGV("Set clock class's UUID: clock-class-addr=%p, "
+       BT_LOGV("Set clock class's UUID: addr=%p, name=\"%s\", "
                "uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
-               clock_class,
+               clock_class, bt_ctf_clock_class_get_name(clock_class),
                (unsigned int) uuid[0],
                (unsigned int) uuid[1],
                (unsigned int) uuid[2],
@@ -491,7 +503,8 @@ void bt_ctf_clock_class_freeze(struct bt_ctf_clock_class *clock_class)
        }
 
        if (!clock_class->frozen) {
-               BT_LOGD("Freezing clock class: addr=%p", clock_class);
+               BT_LOGD("Freezing clock class: addr=%p, name=\"%s\"",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class));
                clock_class->frozen = 1;
        }
 }
@@ -503,12 +516,14 @@ void bt_ctf_clock_class_serialize(struct bt_ctf_clock_class *clock_class,
        unsigned char *uuid;
 
        BT_LOGD("Serializing clock class's metadata: clock-class-addr=%p, "
-               "metadata-context-addr=%p", clock_class, context);
+               "name=\"%s\", metadata-context-addr=%p", clock_class,
+               bt_ctf_clock_class_get_name(clock_class), context);
 
        if (!clock_class || !context) {
                BT_LOGW("Invalid parameter: clock class or metadata context is NULL: "
-                       "clock-class-addr=%p, metadata-context-addr=%p",
-                       clock_class, context);
+                       "clock-class-addr=%p, name=\"%s\", metadata-context-addr=%p",
+                       clock_class, bt_ctf_clock_class_get_name(clock_class),
+                       context);
                return;
        }
 
@@ -545,8 +560,9 @@ void bt_ctf_clock_class_destroy(struct bt_object *obj)
 {
        struct bt_ctf_clock_class *clock_class;
 
-       BT_LOGD("Destroying clock class: addr=%p", obj);
        clock_class = container_of(obj, struct bt_ctf_clock_class, base);
+       BT_LOGD("Destroying clock class: addr=%p, name=\"%s\"",
+               obj, bt_ctf_clock_class_get_name(clock_class));
        if (clock_class->name) {
                g_string_free(clock_class->name, TRUE);
        }
@@ -562,13 +578,14 @@ void bt_ctf_clock_value_destroy(struct bt_object *obj)
 {
        struct bt_ctf_clock_value *value;
 
-       BT_LOGD("Destroying clock value: addr=%p", obj);
-
        if (!obj) {
                return;
        }
 
        value = container_of(obj, struct bt_ctf_clock_value, base);
+       BT_LOGD("Destroying clock value: addr=%p, clock-class-addr=%p, "
+               "clock-class-name=\"%s\"", obj, value->clock_class,
+               bt_ctf_clock_class_get_name(value->clock_class));
        bt_put(value->clock_class);
        g_free(value);
 }
@@ -579,7 +596,8 @@ struct bt_ctf_clock_value *bt_ctf_clock_value_create(
        struct bt_ctf_clock_value *ret = NULL;
 
        BT_LOGD("Creating clock value object: clock-class-addr=%p, "
-               "value=%" PRIu64, clock_class, value);
+               "clock-class-name=\"%s\", value=%" PRIu64, clock_class,
+               bt_ctf_clock_class_get_name(clock_class), value);
 
        if (!clock_class) {
                BT_LOGW_STR("Invalid parameter: clock class is NULL.");
@@ -595,7 +613,9 @@ struct bt_ctf_clock_value *bt_ctf_clock_value_create(
        bt_object_init(ret, bt_ctf_clock_value_destroy);
        ret->clock_class = bt_get(clock_class);
        ret->value = value;
-       BT_LOGD("Created clock value object: addr=%p", ret);
+       BT_LOGD("Created clock value object: clock-value-addr=%p, "
+               "clock-class-addr=%p, clock-class-name=\"%s\"",
+               ret, clock_class, bt_ctf_clock_class_get_name(clock_class));
 end:
        return ret;
 }