/*
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/trace-ir/clock-class-internal.h>
#include <babeltrace/trace-ir/event-class-internal.h>
-#include <babeltrace/trace-ir/field-classes-internal.h>
-#include <babeltrace/trace-ir/fields-internal.h>
+#include <babeltrace/trace-ir/field-class-internal.h>
+#include <babeltrace/trace-ir/field-internal.h>
#include <babeltrace/trace-ir/stream-class-internal.h>
#include <babeltrace/trace-ir/trace-const.h>
#include <babeltrace/trace-ir/trace-internal.h>
#include <babeltrace/trace-ir/utils-internal.h>
#include <babeltrace/trace-ir/field-wrapper-internal.h>
#include <babeltrace/trace-ir/resolve-field-path-internal.h>
-#include <babeltrace/object.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/align-internal.h>
#include <babeltrace/endian-internal.h>
stream_class->name.value = NULL;
}
- BT_LOGD_STR("Putting event header field classe.");
- BT_OBJECT_PUT_REF_AND_RESET(stream_class->event_header_fc);
- BT_LOGD_STR("Putting packet context field classe.");
+ BT_LOGD_STR("Putting packet context field class.");
BT_OBJECT_PUT_REF_AND_RESET(stream_class->packet_context_fc);
- BT_LOGD_STR("Putting event common context field classe.");
+ BT_LOGD_STR("Putting event common context field class.");
BT_OBJECT_PUT_REF_AND_RESET(stream_class->event_common_context_fc);
- bt_object_pool_finalize(&stream_class->event_header_field_pool);
bt_object_pool_finalize(&stream_class->packet_context_field_pool);
g_free(stream_class);
}
BT_ASSERT_PRE_FUNC
static
-bool stream_class_id_is_unique(const struct bt_trace *trace, uint64_t id)
+bool stream_class_id_is_unique(const struct bt_trace_class *tc, uint64_t id)
{
uint64_t i;
bool is_unique = true;
- for (i = 0; i < trace->stream_classes->len; i++) {
+ for (i = 0; i < tc->stream_classes->len; i++) {
const struct bt_stream_class *sc =
- trace->stream_classes->pdata[i];
+ tc->stream_classes->pdata[i];
if (sc->id == id) {
is_unique = false;
}
static
-struct bt_stream_class *create_stream_class_with_id(struct bt_trace *trace,
- uint64_t id)
+struct bt_stream_class *create_stream_class_with_id(
+ struct bt_trace_class *tc, uint64_t id)
{
struct bt_stream_class *stream_class = NULL;
int ret;
- BT_ASSERT(trace);
- BT_ASSERT_PRE(stream_class_id_is_unique(trace, id),
- "Duplicate stream class ID: %![trace-]+t, id=%" PRIu64,
- trace, id);
- BT_LIB_LOGD("Creating stream class object: %![trace-]+t, id=%" PRIu64,
- trace, id);
+ BT_ASSERT(tc);
+ BT_ASSERT_PRE(stream_class_id_is_unique(tc, id),
+ "Duplicate stream class ID: %![tc-]+T, id=%" PRIu64, tc, id);
+ BT_LIB_LOGD("Creating stream class object: %![tc-]+T, id=%" PRIu64,
+ tc, id);
stream_class = g_new0(struct bt_stream_class, 1);
if (!stream_class) {
BT_LOGE_STR("Failed to allocate one stream class.");
goto error;
}
- ret = bt_object_pool_initialize(&stream_class->event_header_field_pool,
- (bt_object_pool_new_object_func) bt_field_wrapper_new,
- (bt_object_pool_destroy_object_func) free_field_wrapper,
- stream_class);
- if (ret) {
- BT_LOGE("Failed to initialize event header field pool: ret=%d",
- ret);
- goto error;
- }
-
ret = bt_object_pool_initialize(&stream_class->packet_context_field_pool,
(bt_object_pool_new_object_func) bt_field_wrapper_new,
(bt_object_pool_destroy_object_func) free_field_wrapper,
goto error;
}
- bt_object_set_parent(&stream_class->base, &trace->base);
- g_ptr_array_add(trace->stream_classes, stream_class);
- bt_trace_freeze(trace);
+ bt_object_set_parent(&stream_class->base, &tc->base);
+ g_ptr_array_add(tc->stream_classes, stream_class);
+ bt_trace_class_freeze(tc);
BT_LIB_LOGD("Created stream class object: %!+S", stream_class);
goto end;
return stream_class;
}
-struct bt_stream_class *bt_stream_class_create(struct bt_trace *trace)
+struct bt_stream_class *bt_stream_class_create(struct bt_trace_class *tc)
{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE(trace->assigns_automatic_stream_class_id,
- "Trace does not automatically assigns stream class IDs: "
- "%![sc-]+t", trace);
- return create_stream_class_with_id(trace,
- (uint64_t) trace->stream_classes->len);
+ 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: "
+ "%![sc-]+T", tc);
+ return create_stream_class_with_id(tc,
+ (uint64_t) tc->stream_classes->len);
}
struct bt_stream_class *bt_stream_class_create_with_id(
- struct bt_trace *trace, uint64_t id)
+ struct bt_trace_class *tc, uint64_t id)
{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE(!trace->assigns_automatic_stream_class_id,
- "Trace automatically assigns stream class IDs: "
- "%![sc-]+t", trace);
- return create_stream_class_with_id(trace, id);
+ BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
+ BT_ASSERT_PRE(!tc->assigns_automatic_stream_class_id,
+ "Trace class automatically assigns stream class IDs: "
+ "%![sc-]+T", tc);
+ return create_stream_class_with_id(tc, id);
}
-struct bt_trace *bt_stream_class_borrow_trace(
+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");
- return bt_stream_class_borrow_trace_inline(stream_class);
+ return bt_stream_class_borrow_trace_class_inline(stream_class);
}
-const struct bt_trace *bt_stream_class_borrow_trace_const(
+const struct bt_trace_class *bt_stream_class_borrow_trace_class_const(
const struct bt_stream_class *stream_class)
{
- return bt_stream_class_borrow_trace((void *) stream_class);
+ return bt_stream_class_borrow_trace_class((void *) stream_class);
}
const char *bt_stream_class_get_name(const struct bt_stream_class *stream_class)
return stream_class->name.value;
}
-int bt_stream_class_set_name(
+enum bt_stream_class_status bt_stream_class_set_name(
struct bt_stream_class *stream_class,
const char *name)
{
g_string_assign(stream_class->name.str, name);
stream_class->name.value = stream_class->name.str->str;
BT_LIB_LOGV("Set stream class's name: %!+S", stream_class);
- return 0;
+ return BT_STREAM_CLASS_STATUS_OK;
}
uint64_t bt_stream_class_get_id(const struct bt_stream_class *stream_class)
struct bt_event_class *event_class = NULL;
uint64_t i;
- BT_ASSERT_PRE_NON_NULL(stream_class, "Trace");
+ BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
for (i = 0; i < stream_class->event_classes->len; i++) {
struct bt_event_class *event_class_candidate =
return stream_class->packet_context_fc;
}
-int bt_stream_class_set_packet_context_field_class(
+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");
+ return stream_class->packet_context_fc;
+}
+
+enum bt_stream_class_status bt_stream_class_set_packet_context_field_class(
struct bt_stream_class *stream_class,
struct bt_field_class *field_class)
{
int ret;
struct bt_resolve_field_path_context resolve_ctx = {
- .packet_header = NULL,
.packet_context = field_class,
- .event_header = NULL,
.event_common_context = NULL,
.event_specific_context = NULL,
.event_payload = NULL,
BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
BT_FIELD_CLASS_TYPE_STRUCTURE,
- "Packet context field classe is not a structure field classe: %!+F",
+ "Packet context field class is not a structure field class: %!+F",
field_class);
- resolve_ctx.packet_header =
- bt_stream_class_borrow_trace_inline(stream_class)->packet_header_fc;
ret = bt_resolve_field_paths(field_class, &resolve_ctx);
if (ret) {
+ /*
+ * This is the only reason for which
+ * bt_resolve_field_paths() can fail: anything else
+ * would be because a precondition is not satisfied.
+ */
+ ret = BT_STREAM_CLASS_STATUS_NOMEM;
goto end;
}
- bt_field_class_make_part_of_trace(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_field_class_freeze(field_class);
- BT_LIB_LOGV("Set stream class's packet context field classe: %!+S",
+ BT_LIB_LOGV("Set stream class's packet context field class: %!+S",
stream_class);
end:
return ret;
}
-const struct bt_field_class *bt_stream_class_borrow_event_header_field_class_const(
+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");
- return stream_class->event_header_fc;
-}
-
-int bt_stream_class_set_event_header_field_class(
- struct bt_stream_class *stream_class,
- struct bt_field_class *field_class)
-{
- int ret;
- struct bt_resolve_field_path_context resolve_ctx = {
- .packet_header = NULL,
- .packet_context = NULL,
- .event_header = field_class,
- .event_common_context = NULL,
- .event_specific_context = NULL,
- .event_payload = NULL,
- };
-
- 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(bt_field_class_get_type(field_class) ==
- BT_FIELD_CLASS_TYPE_STRUCTURE,
- "Event header field classe is not a structure field classe: %!+F",
- field_class);
- resolve_ctx.packet_header =
- bt_stream_class_borrow_trace_inline(stream_class)->packet_header_fc;
- resolve_ctx.packet_context = stream_class->packet_context_fc;
- ret = bt_resolve_field_paths(field_class, &resolve_ctx);
- if (ret) {
- goto end;
- }
-
- bt_field_class_make_part_of_trace(field_class);
- bt_object_put_ref(stream_class->event_header_fc);
- stream_class->event_header_fc = field_class;
- bt_object_get_no_null_check(stream_class->event_header_fc);
- bt_field_class_freeze(field_class);
- BT_LIB_LOGV("Set stream class's event header field classe: %!+S",
- stream_class);
-
-end:
- return ret;
+ return stream_class->event_common_context_fc;
}
-const struct bt_field_class *
-bt_stream_class_borrow_event_common_context_field_class_const(
- const struct bt_stream_class *stream_class)
+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");
return stream_class->event_common_context_fc;
}
-int bt_stream_class_set_event_common_context_field_class(
+enum bt_stream_class_status
+bt_stream_class_set_event_common_context_field_class(
struct bt_stream_class *stream_class,
struct bt_field_class *field_class)
{
int ret;
struct bt_resolve_field_path_context resolve_ctx = {
- .packet_header = NULL,
.packet_context = NULL,
- .event_header = NULL,
.event_common_context = field_class,
.event_specific_context = NULL,
.event_payload = NULL,
BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
BT_FIELD_CLASS_TYPE_STRUCTURE,
- "Event common context field classe is not a structure field classe: %!+F",
+ "Event common context field class is not a structure field class: %!+F",
field_class);
- resolve_ctx.packet_header =
- bt_stream_class_borrow_trace_inline(stream_class)->packet_header_fc;
resolve_ctx.packet_context = stream_class->packet_context_fc;
- resolve_ctx.event_header = stream_class->event_header_fc;
ret = bt_resolve_field_paths(field_class, &resolve_ctx);
if (ret) {
+ /*
+ * This is the only reason for which
+ * bt_resolve_field_paths() can fail: anything else
+ * would be because a precondition is not satisfied.
+ */
+ ret = BT_STREAM_CLASS_STATUS_NOMEM;
goto end;
}
- bt_field_class_make_part_of_trace(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_field_class_freeze(field_class);
- BT_LIB_LOGV("Set stream class's event common context field classe: %!+S",
+ BT_LIB_LOGV("Set stream class's event common context field class: %!+S",
stream_class);
end:
((struct bt_stream_class *) stream_class)->frozen = true;
}
-int bt_stream_class_set_default_clock_class(
+enum bt_stream_class_status bt_stream_class_set_default_clock_class(
struct bt_stream_class *stream_class,
struct bt_clock_class *clock_class)
{
bt_clock_class_freeze(clock_class);
BT_LIB_LOGV("Set stream class's default clock class: %!+S",
stream_class);
- return 0;
+ return BT_STREAM_CLASS_STATUS_OK;
}
struct bt_clock_class *bt_stream_class_borrow_default_clock_class(
"assignment property: %!+S", stream_class);
}
-bt_bool bt_stream_class_assigns_automatic_stream_id(
+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->assigns_automatic_stream_id;
+ return (bt_bool) stream_class->packets_have_beginning_default_clock_snapshot;
}
-void bt_stream_class_set_assigns_automatic_stream_id(
- struct bt_stream_class *stream_class,
- bt_bool value)
+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);
- stream_class->assigns_automatic_stream_id = (bool) value;
- BT_LIB_LOGV("Set stream class's automatic stream ID "
- "assignment property: %!+S", 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_LOGV("Set stream class's \"packets have default beginning "
+ "clock snapshot\" property: %!+S", stream_class);
}
-bt_bool bt_stream_class_packets_have_discarded_event_counter_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_discarded_event_counter_snapshot;
+ return (bt_bool) stream_class->packets_have_end_default_clock_snapshot;
}
-void bt_stream_class_set_packets_have_discarded_event_counter_snapshot(
- struct bt_stream_class *stream_class,
- bt_bool value)
+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);
- stream_class->packets_have_discarded_event_counter_snapshot =
+ 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_LOGV("Set stream class's "
- "\"packets have discarded event counter snapshot\" property: "
- "%!+S", stream_class);
+ BT_LIB_LOGV("Set stream class's \"packets have default end "
+ "clock snapshot\" property: %!+S", stream_class);
}
-bt_bool bt_stream_class_packets_have_packet_counter_snapshot(
+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");
- return (bt_bool) stream_class->packets_have_packet_counter_snapshot;
+ return (bt_bool) stream_class->assigns_automatic_stream_id;
}
-void bt_stream_class_set_packets_have_packet_counter_snapshot(
+void bt_stream_class_set_supports_discarded_events(
struct bt_stream_class *stream_class,
- bt_bool value)
+ bt_bool 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);
- stream_class->packets_have_packet_counter_snapshot =
- (bool) value;
- BT_LIB_LOGV("Set stream class's "
- "\"packets have packet counter snapshot\" property: "
+ BT_ASSERT_PRE(supports_discarded_events ||
+ !with_default_clock_snapshots,
+ "Discarded events cannot have default clock snapshots when "
+ "not supported: %!+S", stream_class);
+ BT_ASSERT_PRE(!with_default_clock_snapshots ||
+ stream_class->default_clock_class,
+ "Stream class has no default clock class: %!+S", stream_class);
+ stream_class->supports_discarded_events =
+ (bool) supports_discarded_events;
+ stream_class->discarded_events_have_default_clock_snapshots =
+ (bool) with_default_clock_snapshots;
+ BT_LIB_LOGV("Set stream class's discarded events support property: "
"%!+S", stream_class);
}
-bt_bool bt_stream_class_packets_have_default_beginning_clock_value(
+bt_bool bt_stream_class_supports_discarded_events(
const struct bt_stream_class *stream_class)
{
BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return (bt_bool) stream_class->packets_have_default_beginning_cv;
+ return (bt_bool) stream_class->supports_discarded_events;
}
-void bt_stream_class_set_packets_have_default_beginning_clock_value(
+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");
+ return (bt_bool) stream_class->discarded_events_have_default_clock_snapshots;
+}
+
+void bt_stream_class_set_supports_discarded_packets(
struct bt_stream_class *stream_class,
- bt_bool value)
+ bt_bool 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(!value || stream_class->default_clock_class,
- "Stream class does not have a default clock class: %!+S",
- stream_class);
- stream_class->packets_have_default_beginning_cv = (bool) value;
- BT_LIB_LOGV("Set stream class's "
- "\"packets have default beginning clock value\" property: "
+ BT_ASSERT_PRE(supports_discarded_packets ||
+ !with_default_clock_snapshots,
+ "Discarded packets cannot have default clock snapshots when "
+ "not supported: %!+S", stream_class);
+ BT_ASSERT_PRE(!with_default_clock_snapshots ||
+ stream_class->default_clock_class,
+ "Stream class has no default clock class: %!+S", stream_class);
+ stream_class->supports_discarded_packets =
+ (bool) supports_discarded_packets;
+ stream_class->discarded_packets_have_default_clock_snapshots =
+ (bool) with_default_clock_snapshots;
+ BT_LIB_LOGV("Set stream class's discarded packets support property: "
"%!+S", stream_class);
}
-bt_bool bt_stream_class_packets_have_default_end_clock_value(
+bt_bool bt_stream_class_supports_discarded_packets(
+ const struct bt_stream_class *stream_class)
+{
+ BT_ASSERT_PRE_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");
- return (bt_bool) stream_class->packets_have_default_end_cv;
+ return (bt_bool) stream_class->discarded_packets_have_default_clock_snapshots;
}
-void bt_stream_class_set_packets_have_default_end_clock_value(
+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(!value || stream_class->default_clock_class,
- "Stream class does not have a default clock class: %!+S",
- stream_class);
- stream_class->packets_have_default_end_cv = (bool) value;
- BT_LIB_LOGV("Set stream class's "
- "\"packets have default end clock value\" property: "
- "%!+S", stream_class);
+ stream_class->assigns_automatic_stream_id = (bool) value;
+ BT_LIB_LOGV("Set stream class's automatic stream ID "
+ "assignment property: %!+S", stream_class);
}
-bt_bool bt_stream_class_default_clock_is_always_known(
- const struct bt_stream_class *stream_class)
+void bt_stream_class_get_ref(const struct bt_stream_class *stream_class)
+{
+ bt_object_get_ref(stream_class);
+}
+
+void bt_stream_class_put_ref(const struct bt_stream_class *stream_class)
{
- /* BT_CLOCK_VALUE_STATUS_UNKNOWN is not supported as of 2.0 */
- return BT_TRUE;
+ bt_object_put_ref(stream_class);
}