lib: rename `bt_object_{get,put}_no` -> `bt_object_{get,put}_ref_no`
[babeltrace.git] / src / lib / trace-ir / stream-class.c
index 7abea88491b456bdba8a7876608c99afd23cadf2..c87978b5a19e5c92ad1287ad99161fb2571f1f72 100644 (file)
 #include "stream-class.h"
 #include "trace.h"
 #include "utils.h"
+#include "lib/value.h"
 #include "lib/func-status.h"
 
-#define BT_ASSERT_PRE_STREAM_CLASS_HOT(_sc) \
-       BT_ASSERT_PRE_HOT((_sc), "Stream class", ": %!+S", (_sc))
+#define BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(_sc) \
+       BT_ASSERT_PRE_DEV_HOT((_sc), "Stream class", ": %!+S", (_sc))
 
 static
 void destroy_stream_class(struct bt_object *obj)
@@ -56,6 +57,7 @@ void destroy_stream_class(struct bt_object *obj)
 
        BT_LIB_LOGD("Destroying stream class: %!+S", stream_class);
        BT_LOGD_STR("Putting default clock class.");
+       BT_OBJECT_PUT_REF_AND_RESET(stream_class->user_attributes);
        BT_OBJECT_PUT_REF_AND_RESET(stream_class->default_clock_class);
 
        if (stream_class->event_classes) {
@@ -85,7 +87,6 @@ void free_field_wrapper(struct bt_field_wrapper *field_wrapper,
        bt_field_wrapper_destroy((void *) field_wrapper);
 }
 
-BT_ASSERT_PRE_FUNC
 static
 bool stream_class_id_is_unique(const struct bt_trace_class *tc, uint64_t id)
 {
@@ -120,18 +121,24 @@ struct bt_stream_class *create_stream_class_with_id(
                tc, id);
        stream_class = g_new0(struct bt_stream_class, 1);
        if (!stream_class) {
-               BT_LOGE_STR("Failed to allocate one stream class.");
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to allocate one stream class.");
                goto error;
        }
 
        bt_object_init_shared_with_parent(&stream_class->base,
                destroy_stream_class);
+       stream_class->user_attributes = bt_value_map_create();
+       if (!stream_class->user_attributes) {
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to create a map value object.");
+               goto error;
+       }
 
        stream_class->name.str = g_string_new(NULL);
        if (!stream_class->name.str) {
-               BT_LOGE_STR("Failed to allocate a GString.");
-               ret = -1;
-               goto end;
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
+               goto error;
        }
 
        stream_class->id = id;
@@ -140,7 +147,7 @@ struct bt_stream_class *create_stream_class_with_id(
        stream_class->event_classes = g_ptr_array_new_with_free_func(
                (GDestroyNotify) bt_object_try_spec_release);
        if (!stream_class->event_classes) {
-               BT_LOGE_STR("Failed to allocate a GPtrArray.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
                goto error;
        }
 
@@ -149,7 +156,8 @@ struct bt_stream_class *create_stream_class_with_id(
                (bt_object_pool_destroy_object_func) free_field_wrapper,
                stream_class);
        if (ret) {
-               BT_LOGE("Failed to initialize packet context field pool: ret=%d",
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to initialize packet context field pool: ret=%d",
                        ret);
                goto error;
        }
@@ -190,7 +198,7 @@ struct bt_stream_class *bt_stream_class_create_with_id(
 struct bt_trace_class *bt_stream_class_borrow_trace_class(
                struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return bt_stream_class_borrow_trace_class_inline(stream_class);
 }
 
@@ -202,7 +210,7 @@ const struct bt_trace_class *bt_stream_class_borrow_trace_class_const(
 
 const char *bt_stream_class_get_name(const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return stream_class->name.value;
 }
 
@@ -212,7 +220,7 @@ enum bt_stream_class_set_name_status bt_stream_class_set_name(
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_NON_NULL(name, "Name");
-       BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
+       BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
        g_string_assign(stream_class->name.str, name);
        stream_class->name.value = stream_class->name.str->str;
        BT_LIB_LOGD("Set stream class's name: %!+S", stream_class);
@@ -221,22 +229,22 @@ enum bt_stream_class_set_name_status bt_stream_class_set_name(
 
 uint64_t bt_stream_class_get_id(const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return stream_class->id;
 }
 
 uint64_t bt_stream_class_get_event_class_count(
                const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return (uint64_t) stream_class->event_classes->len;
 }
 
 struct bt_event_class *bt_stream_class_borrow_event_class_by_index(
                struct bt_stream_class *stream_class, uint64_t index)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-       BT_ASSERT_PRE_VALID_INDEX(index, stream_class->event_classes->len);
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_VALID_INDEX(index, stream_class->event_classes->len);
        return g_ptr_array_index(stream_class->event_classes, index);
 }
 
@@ -254,7 +262,7 @@ struct bt_event_class *bt_stream_class_borrow_event_class_by_id(
        struct bt_event_class *event_class = NULL;
        uint64_t i;
 
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
 
        for (i = 0; i < stream_class->event_classes->len; i++) {
                struct bt_event_class *event_class_candidate =
@@ -282,7 +290,7 @@ const struct bt_field_class *
 bt_stream_class_borrow_packet_context_field_class_const(
                const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return stream_class->packet_context_fc;
 }
 
@@ -290,7 +298,7 @@ struct bt_field_class *
 bt_stream_class_borrow_packet_context_field_class(
                struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return stream_class->packet_context_fc;
 }
 
@@ -308,8 +316,11 @@ bt_stream_class_set_packet_context_field_class(
        };
 
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE(stream_class->supports_packets,
+               "Stream class does not support packets: %![sc-]+S",
+               stream_class);
        BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
-       BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
+       BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
        BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
                BT_FIELD_CLASS_TYPE_STRUCTURE,
                "Packet context field class is not a structure field class: %!+F",
@@ -328,7 +339,7 @@ bt_stream_class_set_packet_context_field_class(
        bt_field_class_make_part_of_trace_class(field_class);
        bt_object_put_ref(stream_class->packet_context_fc);
        stream_class->packet_context_fc = field_class;
-       bt_object_get_no_null_check(stream_class->packet_context_fc);
+       bt_object_get_ref_no_null_check(stream_class->packet_context_fc);
        bt_field_class_freeze(field_class);
        BT_LIB_LOGD("Set stream class's packet context field class: %!+S",
                stream_class);
@@ -341,7 +352,7 @@ const struct bt_field_class *
 bt_stream_class_borrow_event_common_context_field_class_const(
                const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return stream_class->event_common_context_fc;
 }
 
@@ -349,7 +360,7 @@ struct bt_field_class *
 bt_stream_class_borrow_event_common_context_field_class(
                struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return stream_class->event_common_context_fc;
 }
 
@@ -368,7 +379,7 @@ bt_stream_class_set_event_common_context_field_class(
 
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
-       BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
+       BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
        BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
                BT_FIELD_CLASS_TYPE_STRUCTURE,
                "Event common context field class is not a structure field class: %!+F",
@@ -388,7 +399,7 @@ bt_stream_class_set_event_common_context_field_class(
        bt_field_class_make_part_of_trace_class(field_class);
        bt_object_put_ref(stream_class->event_common_context_fc);
        stream_class->event_common_context_fc = field_class;
-       bt_object_get_no_null_check(stream_class->event_common_context_fc);
+       bt_object_get_ref_no_null_check(stream_class->event_common_context_fc);
        bt_field_class_freeze(field_class);
        BT_LIB_LOGD("Set stream class's event common context field class: %!+S",
                stream_class);
@@ -402,6 +413,9 @@ void _bt_stream_class_freeze(const struct bt_stream_class *stream_class)
 {
        /* The field classes and default clock class are already frozen */
        BT_ASSERT(stream_class);
+       BT_LIB_LOGD("Freezing stream class's user attributes: %!+v",
+               stream_class->user_attributes);
+       bt_value_freeze(stream_class->user_attributes);
        BT_LIB_LOGD("Freezing stream class: %!+S", stream_class);
        ((struct bt_stream_class *) stream_class)->frozen = true;
 }
@@ -413,10 +427,10 @@ bt_stream_class_set_default_clock_class(
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
-       BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
+       BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
        bt_object_put_ref(stream_class->default_clock_class);
        stream_class->default_clock_class = clock_class;
-       bt_object_get_no_null_check(stream_class->default_clock_class);
+       bt_object_get_ref_no_null_check(stream_class->default_clock_class);
        bt_clock_class_freeze(clock_class);
        BT_LIB_LOGD("Set stream class's default clock class: %!+S",
                stream_class);
@@ -426,21 +440,21 @@ bt_stream_class_set_default_clock_class(
 struct bt_clock_class *bt_stream_class_borrow_default_clock_class(
                struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return stream_class->default_clock_class;
 }
 
 const struct bt_clock_class *bt_stream_class_borrow_default_clock_class_const(
                const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return stream_class->default_clock_class;
 }
 
 bt_bool bt_stream_class_assigns_automatic_event_class_id(
                const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->assigns_automatic_event_class_id;
 }
 
@@ -449,56 +463,16 @@ void bt_stream_class_set_assigns_automatic_event_class_id(
                bt_bool value)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-       BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
+       BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
        stream_class->assigns_automatic_event_class_id = (bool) value;
        BT_LIB_LOGD("Set stream class's automatic event class ID "
                "assignment property: %!+S", stream_class);
 }
 
-bt_bool bt_stream_class_packets_have_beginning_default_clock_snapshot(
-               const struct bt_stream_class *stream_class)
-{
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-       return (bt_bool) stream_class->packets_have_beginning_default_clock_snapshot;
-}
-
-void bt_stream_class_set_packets_have_beginning_default_clock_snapshot(
-               struct bt_stream_class *stream_class, bt_bool value)
-{
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-       BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
-       BT_ASSERT_PRE(!value || stream_class->default_clock_class,
-               "Stream class has no default clock class: %!+S", stream_class);
-       stream_class->packets_have_beginning_default_clock_snapshot =
-               (bool) value;
-       BT_LIB_LOGD("Set stream class's \"packets have default beginning "
-               "clock snapshot\" property: %!+S", stream_class);
-}
-
-bt_bool bt_stream_class_packets_have_end_default_clock_snapshot(
-               const struct bt_stream_class *stream_class)
-{
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-       return (bt_bool) stream_class->packets_have_end_default_clock_snapshot;
-}
-
-void bt_stream_class_set_packets_have_end_default_clock_snapshot(
-               struct bt_stream_class *stream_class, bt_bool value)
-{
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-       BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
-       BT_ASSERT_PRE(!value || stream_class->default_clock_class,
-               "Stream class has no default clock class: %!+S", stream_class);
-       stream_class->packets_have_end_default_clock_snapshot =
-               (bool) value;
-       BT_LIB_LOGD("Set stream class's \"packets have default end "
-               "clock snapshot\" property: %!+S", stream_class);
-}
-
 bt_bool bt_stream_class_assigns_automatic_stream_id(
                const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->assigns_automatic_stream_id;
 }
 
@@ -508,7 +482,7 @@ void bt_stream_class_set_supports_discarded_events(
                bt_bool with_default_clock_snapshots)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-       BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
+       BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
        BT_ASSERT_PRE(supports_discarded_events ||
                !with_default_clock_snapshots,
                "Discarded events cannot have default clock snapshots when "
@@ -527,14 +501,14 @@ void bt_stream_class_set_supports_discarded_events(
 bt_bool bt_stream_class_supports_discarded_events(
                const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->supports_discarded_events;
 }
 
 bt_bool bt_stream_class_discarded_events_have_default_clock_snapshots(
                const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->discarded_events_have_default_clock_snapshots;
 }
 
@@ -544,7 +518,11 @@ void bt_stream_class_set_supports_discarded_packets(
                bt_bool with_default_clock_snapshots)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-       BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
+       BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
+       BT_ASSERT_PRE(!supports_discarded_packets ||
+               stream_class->supports_packets,
+               "Stream class does not support packets: %!+S",
+               stream_class);
        BT_ASSERT_PRE(supports_discarded_packets ||
                !with_default_clock_snapshots,
                "Discarded packets cannot have default clock snapshots when "
@@ -563,28 +541,111 @@ void bt_stream_class_set_supports_discarded_packets(
 bt_bool bt_stream_class_supports_discarded_packets(
                const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->supports_discarded_packets;
 }
 
 bt_bool bt_stream_class_discarded_packets_have_default_clock_snapshots(
                const struct bt_stream_class *stream_class)
 {
-       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->discarded_packets_have_default_clock_snapshots;
 }
 
+void bt_stream_class_set_supports_packets(
+               struct bt_stream_class *stream_class,
+               bt_bool supports_packets,
+               bt_bool with_beginning_default_clock_snapshot,
+               bt_bool with_end_default_clock_snapshot)
+{
+       bt_bool with_default_clock_snapshot =
+               with_beginning_default_clock_snapshot ||
+               with_end_default_clock_snapshot;
+       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
+       BT_ASSERT_PRE(supports_packets ||
+               !with_default_clock_snapshot,
+               "Packets cannot have default clock snapshots when "
+               "not supported: %!+S", stream_class);
+       BT_ASSERT_PRE(!with_default_clock_snapshot ||
+               stream_class->default_clock_class,
+               "Stream class has no default clock class: %!+S", stream_class);
+       BT_ASSERT_PRE(supports_packets || !stream_class->packet_context_fc,
+               "Stream class already has a packet context field class: %!+S",
+               stream_class);
+       BT_ASSERT_PRE(supports_packets ||
+               !stream_class->supports_discarded_packets,
+               "Stream class already supports discarded packets: %!+S",
+               stream_class);
+       stream_class->supports_packets = (bool) supports_packets;
+       stream_class->packets_have_beginning_default_clock_snapshot =
+               (bool) with_beginning_default_clock_snapshot;
+       stream_class->packets_have_end_default_clock_snapshot =
+               (bool) with_end_default_clock_snapshot;
+       BT_LIB_LOGD("Set stream class's packets support property: %!+S",
+               stream_class);
+}
+
+bt_bool bt_stream_class_supports_packets(
+               const struct bt_stream_class *stream_class)
+{
+       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       return (bt_bool) stream_class->supports_packets;
+}
+
+bt_bool bt_stream_class_packets_have_beginning_default_clock_snapshot(
+               const struct bt_stream_class *stream_class)
+{
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
+       return (bt_bool) stream_class->packets_have_beginning_default_clock_snapshot;
+}
+
+bt_bool bt_stream_class_packets_have_end_default_clock_snapshot(
+               const struct bt_stream_class *stream_class)
+{
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
+       return (bt_bool) stream_class->packets_have_end_default_clock_snapshot;
+}
+
 void bt_stream_class_set_assigns_automatic_stream_id(
                struct bt_stream_class *stream_class,
                bt_bool value)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-       BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
+       BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
        stream_class->assigns_automatic_stream_id = (bool) value;
        BT_LIB_LOGD("Set stream class's automatic stream ID "
                "assignment property: %!+S", stream_class);
 }
 
+const struct bt_value *bt_stream_class_borrow_user_attributes_const(
+               const struct bt_stream_class *stream_class)
+{
+       BT_ASSERT_PRE_DEV_NON_NULL(stream_class, "Stream class");
+       return stream_class->user_attributes;
+}
+
+struct bt_value *bt_stream_class_borrow_user_attributes(
+               struct bt_stream_class *stream_class)
+{
+       return (void *) bt_stream_class_borrow_user_attributes_const(
+               (void *) stream_class);
+}
+
+void bt_stream_class_set_user_attributes(
+               struct bt_stream_class *stream_class,
+               const struct bt_value *user_attributes)
+{
+       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
+       BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
+               "User attributes object is not a map value object.");
+       BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
+       bt_object_put_ref_no_null_check(stream_class->user_attributes);
+       stream_class->user_attributes = (void *) user_attributes;
+       bt_object_get_ref_no_null_check(stream_class->user_attributes);
+}
+
 void bt_stream_class_get_ref(const struct bt_stream_class *stream_class)
 {
        bt_object_get_ref(stream_class);
This page took 0.030528 seconds and 4 git commands to generate.