lib: make packets and packet messages optional, disabled by default
[babeltrace.git] / src / lib / trace-ir / stream-class.c
index be5752965d98f4501c4b5e3bd0ede7ec88eeee53..edeccbecc730391c62857f6c371839da5c9bccbb 100644 (file)
@@ -22,7 +22,7 @@
  */
 
 #define BT_LOG_TAG "LIB/STREAM-CLASS"
-#include "lib/lib-logging.h"
+#include "lib/logging.h"
 
 #include "lib/assert-pre.h"
 #include <babeltrace2/trace-ir/trace-const.h>
@@ -44,6 +44,7 @@
 #include "stream-class.h"
 #include "trace.h"
 #include "utils.h"
+#include "lib/func-status.h"
 
 #define BT_ASSERT_PRE_STREAM_CLASS_HOT(_sc) \
        BT_ASSERT_PRE_HOT((_sc), "Stream class", ": %!+S", (_sc))
@@ -119,7 +120,8 @@ 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;
        }
 
@@ -128,7 +130,7 @@ struct bt_stream_class *create_stream_class_with_id(
 
        stream_class->name.str = g_string_new(NULL);
        if (!stream_class->name.str) {
-               BT_LOGE_STR("Failed to allocate a GString.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
                ret = -1;
                goto end;
        }
@@ -139,7 +141,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;
        }
 
@@ -148,7 +150,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;
        }
@@ -205,7 +208,7 @@ const char *bt_stream_class_get_name(const struct bt_stream_class *stream_class)
        return stream_class->name.value;
 }
 
-enum bt_stream_class_status bt_stream_class_set_name(
+enum bt_stream_class_set_name_status bt_stream_class_set_name(
                struct bt_stream_class *stream_class,
                const char *name)
 {
@@ -215,7 +218,7 @@ enum bt_stream_class_status bt_stream_class_set_name(
        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);
-       return BT_STREAM_CLASS_STATUS_OK;
+       return BT_FUNC_STATUS_OK;
 }
 
 uint64_t bt_stream_class_get_id(const struct bt_stream_class *stream_class)
@@ -293,7 +296,8 @@ bt_stream_class_borrow_packet_context_field_class(
        return stream_class->packet_context_fc;
 }
 
-enum bt_stream_class_status bt_stream_class_set_packet_context_field_class(
+enum bt_stream_class_set_field_class_status
+bt_stream_class_set_packet_context_field_class(
                struct bt_stream_class *stream_class,
                struct bt_field_class *field_class)
 {
@@ -306,6 +310,9 @@ enum bt_stream_class_status 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(bt_field_class_get_type(field_class) ==
@@ -319,7 +326,7 @@ enum bt_stream_class_status bt_stream_class_set_packet_context_field_class(
                 * bt_resolve_field_paths() can fail: anything else
                 * would be because a precondition is not satisfied.
                 */
-               ret = BT_STREAM_CLASS_STATUS_NOMEM;
+               ret = BT_FUNC_STATUS_MEMORY_ERROR;
                goto end;
        }
 
@@ -351,7 +358,7 @@ bt_stream_class_borrow_event_common_context_field_class(
        return stream_class->event_common_context_fc;
 }
 
-enum bt_stream_class_status
+enum bt_stream_class_set_field_class_status
 bt_stream_class_set_event_common_context_field_class(
                struct bt_stream_class *stream_class,
                struct bt_field_class *field_class)
@@ -379,7 +386,7 @@ bt_stream_class_set_event_common_context_field_class(
                 * bt_resolve_field_paths() can fail: anything else
                 * would be because a precondition is not satisfied.
                 */
-               ret = BT_STREAM_CLASS_STATUS_NOMEM;
+               ret = BT_FUNC_STATUS_MEMORY_ERROR;
                goto end;
        }
 
@@ -404,7 +411,8 @@ void _bt_stream_class_freeze(const struct bt_stream_class *stream_class)
        ((struct bt_stream_class *) stream_class)->frozen = true;
 }
 
-enum bt_stream_class_status bt_stream_class_set_default_clock_class(
+enum bt_stream_class_set_default_clock_class_status
+bt_stream_class_set_default_clock_class(
                struct bt_stream_class *stream_class,
                struct bt_clock_class *clock_class)
 {
@@ -417,7 +425,7 @@ enum bt_stream_class_status bt_stream_class_set_default_clock_class(
        bt_clock_class_freeze(clock_class);
        BT_LIB_LOGD("Set stream class's default clock class: %!+S",
                stream_class);
-       return BT_STREAM_CLASS_STATUS_OK;
+       return BT_FUNC_STATUS_OK;
 }
 
 struct bt_clock_class *bt_stream_class_borrow_default_clock_class(
@@ -452,46 +460,6 @@ void bt_stream_class_set_assigns_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)
 {
@@ -542,6 +510,10 @@ void bt_stream_class_set_supports_discarded_packets(
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_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 "
@@ -571,6 +543,61 @@ bt_bool bt_stream_class_discarded_packets_have_default_clock_snapshots(
        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_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_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_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)
This page took 0.0264 seconds and 4 git commands to generate.