Document libbabeltrace2's C API

[babeltrace.git] / src / lib / trace-ir / stream-class.c

diff --git a/src/lib/trace-ir/stream-class.c b/src/lib/trace-ir/stream-class.c
index aeccff72cac2e12f0ebd4779afbf12463fbee151..e402f4151e40f6e8297e0c86763bb01158f01a15 100644 (file)
--- a/src/lib/trace-ir/stream-class.c
+++ b/src/lib/trace-ir/stream-class.c
@@ -25,7 +25,7 @@
 #include "lib/logging.h"
 
 #include "lib/assert-pre.h"
-#include <babeltrace2/trace-ir/trace-const.h>
+#include <babeltrace2/trace-ir/trace.h>
 #include "compat/compiler.h"
 #include "common/align.h"
 #include "compat/endian.h"
@@ -44,6 +44,7 @@
 #include "stream-class.h"
 #include "trace.h"
 #include "utils.h"
+#include "lib/value.h"
 #include "lib/func-status.h"
 
 #define BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(_sc) \
@@ -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)
 {
@@ -127,12 +128,17 @@ struct bt_stream_class *create_stream_class_with_id(
 
        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_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        stream_class->id = id;
@@ -171,6 +177,7 @@ end:
 
 struct bt_stream_class *bt_stream_class_create(struct bt_trace_class *tc)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
        BT_ASSERT_PRE(tc->assigns_automatic_stream_class_id,
                "Trace class does not automatically assigns stream class IDs: "
@@ -182,6 +189,7 @@ struct bt_stream_class *bt_stream_class_create(struct bt_trace_class *tc)
 struct bt_stream_class *bt_stream_class_create_with_id(
                struct bt_trace_class *tc, uint64_t id)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
        BT_ASSERT_PRE(!tc->assigns_automatic_stream_class_id,
                "Trace class automatically assigns stream class IDs: "
@@ -212,6 +220,7 @@ enum bt_stream_class_set_name_status bt_stream_class_set_name(
                struct bt_stream_class *stream_class,
                const char *name)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_NON_NULL(name, "Name");
        BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
@@ -309,6 +318,7 @@ bt_stream_class_set_packet_context_field_class(
                .event_payload = NULL,
        };
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE(stream_class->supports_packets,
                "Stream class does not support packets: %![sc-]+S",
@@ -333,7 +343,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);
@@ -371,6 +381,7 @@ bt_stream_class_set_event_common_context_field_class(
                .event_payload = NULL,
        };
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
        BT_ASSERT_PRE_DEV_STREAM_CLASS_HOT(stream_class);
@@ -393,7 +404,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);
@@ -407,6 +418,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;
 }
@@ -416,12 +430,13 @@ bt_stream_class_set_default_clock_class(
                struct bt_stream_class *stream_class,
                struct bt_clock_class *clock_class)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock 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);
@@ -609,6 +624,34 @@ void bt_stream_class_set_assigns_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);