X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=formats%2Fctf%2Fir%2Fstream-class.c;h=573fb421ebfe6c26e37df2f8b0bf36b8a4fc384d;hb=83509119a945fc77faff869daaf48627e1c4b3fa;hp=058f4b29ecd1765f6a7d0521d58c02eb559a73c5;hpb=739a93c79685bd9d9bd34bdb6f7a12089fa91256;p=babeltrace.git

diff --git a/formats/ctf/ir/stream-class.c b/formats/ctf/ir/stream-class.c
index 058f4b29..573fb421 100644
--- a/formats/ctf/ir/stream-class.c
+++ b/formats/ctf/ir/stream-class.c
@@ -34,25 +34,26 @@
 #include <babeltrace/ctf-ir/event-fields-internal.h>
 #include <babeltrace/ctf-writer/stream.h>
 #include <babeltrace/ctf-ir/stream-class-internal.h>
+#include <babeltrace/ctf-ir/visitor-internal.h>
 #include <babeltrace/ctf-writer/functor-internal.h>
+#include <babeltrace/ctf-ir/utils.h>
+#include <babeltrace/ref.h>
 #include <babeltrace/compiler.h>
 #include <babeltrace/align.h>
 
 static
-void bt_ctf_stream_class_destroy(struct bt_ctf_ref *ref);
+void bt_ctf_stream_class_destroy(struct bt_object *obj);
 static
-int init_event_header(struct bt_ctf_stream_class *stream_class,
-		enum bt_ctf_byte_order byte_order);
+int init_event_header(struct bt_ctf_stream_class *stream_class);
 static
-int init_packet_context(struct bt_ctf_stream_class *stream_class,
-		enum bt_ctf_byte_order byte_order);
+int init_packet_context(struct bt_ctf_stream_class *stream_class);
 
 struct bt_ctf_stream_class *bt_ctf_stream_class_create(const char *name)
 {
 	int ret;
 	struct bt_ctf_stream_class *stream_class = NULL;
 
-	if (!name || !strlen(name)) {
+	if (name && bt_ctf_validate_identifier(name)) {
 		goto error;
 	}
 
@@ -63,26 +64,46 @@ struct bt_ctf_stream_class *bt_ctf_stream_class_create(const char *name)
 
 	stream_class->name = g_string_new(name);
 	stream_class->event_classes = g_ptr_array_new_with_free_func(
-		(GDestroyNotify)bt_ctf_event_class_put);
+		(GDestroyNotify) bt_put);
 	if (!stream_class->event_classes) {
-		goto error_destroy;
+		goto error;
 	}
 
-	ret = init_packet_context(stream_class, BT_CTF_BYTE_ORDER_NATIVE);
+	ret = init_event_header(stream_class);
 	if (ret) {
-		goto error_destroy;
+		goto error;
 	}
 
-	bt_ctf_ref_init(&stream_class->ref_count);
+	ret = init_packet_context(stream_class);
+	if (ret) {
+		goto error;
+	}
+
+	bt_object_init(stream_class, bt_ctf_stream_class_destroy);
 	return stream_class;
 
-error_destroy:
-	bt_ctf_stream_class_destroy(&stream_class->ref_count);
-	stream_class = NULL;
 error:
+        BT_PUT(stream_class);
 	return stream_class;
 }
 
+struct bt_ctf_trace *bt_ctf_stream_class_get_trace(
+		struct bt_ctf_stream_class *stream_class)
+{
+	struct bt_ctf_trace *trace = NULL;
+
+	if (!stream_class) {
+		goto end;
+	}
+
+	trace = stream_class->trace;
+	if (trace) {
+		bt_get(trace);
+	}
+end:
+	return trace;
+}
+
 const char *bt_ctf_stream_class_get_name(
 		struct bt_ctf_stream_class *stream_class)
 {
@@ -97,6 +118,21 @@ end:
 	return name;
 }
 
+int bt_ctf_stream_class_set_name(struct bt_ctf_stream_class *stream_class,
+		const char *name)
+{
+	int ret = 0;
+
+	if (!stream_class || stream_class->frozen) {
+		ret = -1;
+		goto end;
+	}
+
+	g_string_assign(stream_class->name, name);
+end:
+	return ret;
+}
+
 struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
 		struct bt_ctf_stream_class *stream_class)
 {
@@ -107,7 +143,7 @@ struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
 	}
 
 	clock = stream_class->clock;
-	bt_ctf_clock_get(clock);
+	bt_get(clock);
 end:
 	return clock;
 }
@@ -116,19 +152,47 @@ int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class *stream_class,
 		struct bt_ctf_clock *clock)
 {
 	int ret = 0;
+	struct bt_ctf_field_type *timestamp_field = NULL;
 
 	if (!stream_class || !clock || stream_class->frozen) {
 		ret = -1;
 		goto end;
 	}
 
+	/*
+	 * Look for a "timestamp" field in the stream class' event header type
+	 * and map the stream's clock to that field if no current mapping is
+	 * currently set.
+	 */
+	timestamp_field = bt_ctf_field_type_structure_get_field_type_by_name(
+		stream_class->event_header_type, "timestamp");
+	if (timestamp_field) {
+		struct bt_ctf_clock *mapped_clock;
+
+		mapped_clock = bt_ctf_field_type_integer_get_mapped_clock(
+			timestamp_field);
+		if (mapped_clock) {
+			bt_put(mapped_clock);
+			goto end;
+		}
+
+		ret = bt_ctf_field_type_integer_set_mapped_clock(
+			timestamp_field, clock);
+		if (ret) {
+			goto end;
+		}
+	}
+
 	if (stream_class->clock) {
-		bt_ctf_clock_put(stream_class->clock);
+		bt_put(stream_class->clock);
 	}
 
 	stream_class->clock = clock;
-	bt_ctf_clock_get(clock);
+	bt_get(clock);
 end:
+	if (timestamp_field) {
+		bt_put(timestamp_field);
+	}
 	return ret;
 }
 
@@ -146,6 +210,56 @@ end:
 	return ret;
 }
 
+BT_HIDDEN
+int _bt_ctf_stream_class_set_id(
+		struct bt_ctf_stream_class *stream_class, uint32_t id)
+{
+	stream_class->id = id;
+	stream_class->id_set = 1;
+	return 0;
+}
+
+struct event_class_set_stream_id_data {
+	uint32_t stream_id;
+	int ret;
+};
+
+static
+void event_class_set_stream_id(gpointer event_class, gpointer data)
+{
+	struct event_class_set_stream_id_data *typed_data = data;
+
+	typed_data->ret |= bt_ctf_event_class_set_stream_id(event_class,
+		typed_data->stream_id);
+}
+
+BT_HIDDEN
+int bt_ctf_stream_class_set_id_no_check(
+		struct bt_ctf_stream_class *stream_class, uint32_t id)
+{
+	int ret = 0;
+	struct event_class_set_stream_id_data data =
+		{ .stream_id = id, .ret = 0 };
+
+	/*
+	 * Make sure all event classes have their "stream_id" attribute
+	 * set to this value.
+	 */
+	g_ptr_array_foreach(stream_class->event_classes,
+		event_class_set_stream_id, &data);
+	ret = data.ret;
+	if (ret) {
+		goto end;
+	}
+
+	ret = _bt_ctf_stream_class_set_id(stream_class, id);
+	if (ret) {
+		goto end;
+	}
+end:
+	return ret;
+}
+
 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class *stream_class,
 		uint32_t id)
 {
@@ -156,12 +270,55 @@ int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class *stream_class,
 		goto end;
 	}
 
-	stream_class->id = id;
-	stream_class->id_set = 1;
+	ret = bt_ctf_stream_class_set_id_no_check(stream_class, id);
 end:
 	return ret;
 }
 
+static
+void event_class_exists(gpointer element, gpointer query)
+{
+	struct bt_ctf_event_class *event_class_a = element;
+	struct search_query *search_query = query;
+	struct bt_ctf_event_class *event_class_b = search_query->value;
+	int64_t id_a, id_b;
+
+	if (search_query->value == element) {
+		search_query->found = 1;
+		goto end;
+	}
+
+	/*
+	 * Two event classes cannot share the same name in a given
+	 * stream class.
+	 */
+	if (!strcmp(bt_ctf_event_class_get_name(event_class_a),
+			bt_ctf_event_class_get_name(event_class_b))) {
+		search_query->found = 1;
+		goto end;
+	}
+
+	/*
+	 * Two event classes cannot share the same ID in a given
+	 * stream class.
+	 */
+	id_a = bt_ctf_event_class_get_id(event_class_a);
+	id_b = bt_ctf_event_class_get_id(event_class_b);
+
+	if (id_a < 0 || id_b < 0) {
+		/* at least one ID is not set: will be automatically set later */
+		goto end;
+	}
+
+	if (id_a == id_b) {
+		search_query->found = 1;
+		goto end;
+	}
+
+end:
+	return;
+}
+
 int bt_ctf_stream_class_add_event_class(
 		struct bt_ctf_stream_class *stream_class,
 		struct bt_ctf_event_class *event_class)
@@ -176,12 +333,27 @@ int bt_ctf_stream_class_add_event_class(
 
 	/* Check for duplicate event classes */
 	struct search_query query = { .value = event_class, .found = 0 };
-	g_ptr_array_foreach(stream_class->event_classes, value_exists, &query);
+	g_ptr_array_foreach(stream_class->event_classes, event_class_exists,
+		&query);
 	if (query.found) {
 		ret = -1;
 		goto end;
 	}
 
+	/*
+	 * Resolve the event's sequence length and variant tags if the
+	 * stream is already associated with a trace. Otherwise, this
+	 * validation will be performed once the stream is registered
+	 * to a trace.
+	 */
+	if (stream_class->trace) {
+		ret = bt_ctf_event_class_resolve_types(event_class,
+			stream_class->trace, stream_class);
+		if (ret) {
+			goto end;
+		}
+	}
+
 	/* Only set an event id if none was explicitly set before */
 	event_id = bt_ctf_event_class_get_id(event_class);
 	if (event_id < 0) {
@@ -197,8 +369,26 @@ int bt_ctf_stream_class_add_event_class(
 		goto end;
 	}
 
-	bt_ctf_event_class_get(event_class);
+	ret = bt_ctf_event_class_set_stream_id(event_class, stream_class->id);
+	if (ret) {
+		goto end;
+	}
+
+	bt_get(event_class);
 	g_ptr_array_add(stream_class->event_classes, event_class);
+	bt_ctf_event_class_freeze(event_class);
+
+	if (stream_class->byte_order) {
+		/*
+		 * Only set native byte order if it has been initialized
+		 * when the stream class was added to a trace.
+		 *
+		 * If not set here, this will be set when the stream
+		 * classe will be added to a trace.
+		 */
+		bt_ctf_event_class_set_native_byte_order(event_class,
+			stream_class->byte_order);
+	}
 end:
 	return ret;
 }
@@ -229,7 +419,7 @@ struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class(
 	}
 
 	event_class = g_ptr_array_index(stream_class->event_classes, index);
-	bt_ctf_event_class_get(event_class);
+	bt_get(event_class);
 end:
 	return event_class;
 }
@@ -238,15 +428,35 @@ struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_name(
 		struct bt_ctf_stream_class *stream_class, const char *name)
 {
 	size_t i;
-	GQuark name_quark;
 	struct bt_ctf_event_class *event_class = NULL;
 
 	if (!stream_class || !name) {
 		goto end;
 	}
 
-	name_quark = g_quark_try_string(name);
-	if (!name_quark) {
+	for (i = 0; i < stream_class->event_classes->len; i++) {
+		struct bt_ctf_event_class *cur_event_class =
+			g_ptr_array_index(stream_class->event_classes, i);
+		const char *cur_event_class_name =
+			bt_ctf_event_class_get_name(cur_event_class);
+
+		if (!strcmp(name, cur_event_class_name)) {
+			event_class = cur_event_class;
+			bt_get(event_class);
+			goto end;
+		}
+	}
+end:
+	return event_class;
+}
+
+struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_id(
+		struct bt_ctf_stream_class *stream_class, uint32_t id)
+{
+	size_t i;
+	struct bt_ctf_event_class *event_class = NULL;
+
+	if (!stream_class) {
 		goto end;
 	}
 
@@ -254,9 +464,9 @@ struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_name(
 		struct bt_ctf_event_class *current_event_class =
 			g_ptr_array_index(stream_class->event_classes, i);
 
-		if (name_quark == current_event_class->name) {
+		if (bt_ctf_event_class_get_id(current_event_class) == id) {
 			event_class = current_event_class;
-			bt_ctf_event_class_get(event_class);
+			bt_get(event_class);
 			goto end;
 		}
 	}
@@ -274,7 +484,7 @@ struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type(
 	}
 
 	assert(stream_class->packet_context_type);
-	bt_ctf_field_type_get(stream_class->packet_context_type);
+	bt_get(stream_class->packet_context_type);
 	ret = stream_class->packet_context_type;
 end:
 	return ret;
@@ -292,6 +502,9 @@ int bt_ctf_stream_class_set_packet_context_type(
 	}
 
 	assert(stream_class->packet_context_type);
+	if (stream_class->packet_context_type == packet_context_type) {
+		goto end;
+	}
 	if (bt_ctf_field_type_get_type_id(packet_context_type) !=
 		CTF_TYPE_STRUCT) {
 		/* A packet context must be a structure */
@@ -299,13 +512,58 @@ int bt_ctf_stream_class_set_packet_context_type(
 		goto end;
 	}
 
-	bt_ctf_field_type_put(stream_class->packet_context_type);
-	bt_ctf_field_type_get(packet_context_type);
+	bt_put(stream_class->packet_context_type);
+	bt_get(packet_context_type);
 	stream_class->packet_context_type = packet_context_type;
 end:
 	return ret;
 }
 
+struct bt_ctf_field_type *bt_ctf_stream_class_get_event_header_type(
+		struct bt_ctf_stream_class *stream_class)
+{
+	struct bt_ctf_field_type *ret = NULL;
+
+	if (!stream_class || !stream_class->event_header_type) {
+		goto end;
+	}
+
+	assert(stream_class->event_header_type);
+	bt_get(stream_class->event_header_type);
+	ret = stream_class->event_header_type;
+end:
+	return ret;
+}
+
+int bt_ctf_stream_class_set_event_header_type(
+		struct bt_ctf_stream_class *stream_class,
+		struct bt_ctf_field_type *event_header_type)
+{
+	int ret = 0;
+
+	if (!stream_class || !event_header_type || stream_class->frozen) {
+		ret = -1;
+		goto end;
+	}
+
+	assert(stream_class->event_header_type);
+	if (stream_class->event_header_type == event_header_type) {
+		goto end;
+	}
+	if (bt_ctf_field_type_get_type_id(event_header_type) !=
+		CTF_TYPE_STRUCT) {
+		/* An event header must be a structure */
+		ret = -1;
+		goto end;
+	}
+
+	bt_put(stream_class->event_header_type);
+	bt_get(event_header_type);
+	stream_class->event_header_type = event_header_type;
+end:
+	return ret;
+}
+
 struct bt_ctf_field_type *bt_ctf_stream_class_get_event_context_type(
 		struct bt_ctf_stream_class *stream_class)
 {
@@ -316,7 +574,7 @@ struct bt_ctf_field_type *bt_ctf_stream_class_get_event_context_type(
 	}
 
 	assert(stream_class->event_context_type);
-	bt_ctf_field_type_get(stream_class->event_context_type);
+	bt_get(stream_class->event_context_type);
 	ret = stream_class->event_context_type;
 end:
 	return ret;
@@ -340,8 +598,8 @@ int bt_ctf_stream_class_set_event_context_type(
 		goto end;
 	}
 
-	bt_ctf_field_type_put(stream_class->event_context_type);
-	bt_ctf_field_type_get(event_context_type);
+	bt_put(stream_class->event_context_type);
+	bt_get(event_context_type);
 	stream_class->event_context_type = event_context_type;
 end:
 	return ret;
@@ -349,20 +607,12 @@ end:
 
 void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class)
 {
-	if (!stream_class) {
-		return;
-	}
-
-	bt_ctf_ref_get(&stream_class->ref_count);
+	bt_get(stream_class);
 }
 
 void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class)
 {
-	if (!stream_class) {
-		return;
-	}
-
-	bt_ctf_ref_put(&stream_class->ref_count, bt_ctf_stream_class_destroy);
+	bt_put(stream_class);
 }
 
 BT_HIDDEN
@@ -373,23 +623,57 @@ void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class *stream_class)
 	}
 
 	stream_class->frozen = 1;
+	bt_ctf_field_type_freeze(stream_class->event_header_type);
 	bt_ctf_field_type_freeze(stream_class->packet_context_type);
 	bt_ctf_field_type_freeze(stream_class->event_context_type);
 	bt_ctf_clock_freeze(stream_class->clock);
-	g_ptr_array_foreach(stream_class->event_classes,
-		(GFunc)bt_ctf_event_class_freeze, NULL);
 }
 
 BT_HIDDEN
 int bt_ctf_stream_class_set_byte_order(struct bt_ctf_stream_class *stream_class,
 	enum bt_ctf_byte_order byte_order)
 {
-	int ret = 0;
+	int i, ret = 0;
+	int internal_byte_order;
 
-	ret = init_event_header(stream_class, byte_order);
-	if (ret) {
+	/* Note that "NATIVE" means the trace's endianness, not the host's. */
+	if (!stream_class || byte_order <= BT_CTF_BYTE_ORDER_UNKNOWN ||
+		byte_order > BT_CTF_BYTE_ORDER_NETWORK) {
+		ret = -1;
 		goto end;
 	}
+
+	switch (byte_order) {
+	case BT_CTF_BYTE_ORDER_NETWORK:
+	case BT_CTF_BYTE_ORDER_BIG_ENDIAN:
+		internal_byte_order = BIG_ENDIAN;
+		break;
+	case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN:
+		internal_byte_order = LITTLE_ENDIAN;
+		break;
+	default:
+		ret = -1;
+		goto end;
+	}
+
+	stream_class->byte_order = internal_byte_order;
+
+	/* Set native byte order to little or big endian */
+	bt_ctf_field_type_set_native_byte_order(
+		stream_class->event_header_type, stream_class->byte_order);
+	bt_ctf_field_type_set_native_byte_order(
+		stream_class->packet_context_type, stream_class->byte_order);
+	bt_ctf_field_type_set_native_byte_order(
+		stream_class->event_context_type, stream_class->byte_order);
+
+	/* Set all events' native byte order */
+	for (i = 0; i < stream_class->event_classes->len; i++) {
+		bt_ctf_event_class_set_native_byte_order(
+			g_ptr_array_index(stream_class->event_classes, i),
+			stream_class->byte_order);
+		bt_ctf_event_class_freeze(
+			g_ptr_array_index(stream_class->event_classes, i));
+	}
 end:
 	return ret;
 }
@@ -448,17 +732,35 @@ end:
 	return ret;
 }
 
-static
-void bt_ctf_stream_class_destroy(struct bt_ctf_ref *ref)
+BT_HIDDEN
+int bt_ctf_stream_class_set_trace(struct bt_ctf_stream_class *stream_class,
+		struct bt_ctf_trace *trace)
 {
-	struct bt_ctf_stream_class *stream_class;
+	int ret = 0;
 
-	if (!ref) {
-		return;
+	if (!stream_class) {
+		ret = -1;
+		goto end;
 	}
 
-	stream_class = container_of(ref, struct bt_ctf_stream_class, ref_count);
-	bt_ctf_clock_put(stream_class->clock);
+	if (stream_class->trace && trace) {
+		/* Already attached to a trace */
+		ret = -1;
+		goto end;
+	}
+
+	stream_class->trace = trace;
+end:
+	return ret;
+}
+
+static
+void bt_ctf_stream_class_destroy(struct bt_object *obj)
+{
+	struct bt_ctf_stream_class *stream_class;
+
+	stream_class = container_of(obj, struct bt_ctf_stream_class, base);
+	bt_put(stream_class->clock);
 
 	if (stream_class->event_classes) {
 		size_t i;
@@ -479,18 +781,14 @@ void bt_ctf_stream_class_destroy(struct bt_ctf_ref *ref)
 		g_string_free(stream_class->name, TRUE);
 	}
 
-	bt_ctf_field_type_put(stream_class->event_header_type);
-	bt_ctf_field_put(stream_class->event_header);
-	bt_ctf_field_type_put(stream_class->packet_context_type);
-	if (stream_class->event_context_type) {
-		bt_ctf_field_type_put(stream_class->event_context_type);
-	}
+	bt_put(stream_class->event_header_type);
+	bt_put(stream_class->packet_context_type);
+	bt_put(stream_class->event_context_type);
 	g_free(stream_class);
 }
 
 static
-int init_event_header(struct bt_ctf_stream_class *stream_class,
-		enum bt_ctf_byte_order byte_order)
+int init_event_header(struct bt_ctf_stream_class *stream_class)
 {
 	int ret = 0;
 	struct bt_ctf_field_type *event_header_type =
@@ -505,16 +803,6 @@ int init_event_header(struct bt_ctf_stream_class *stream_class,
 		goto end;
 	}
 
-	ret = bt_ctf_field_type_set_byte_order(_uint32_t, byte_order);
-	if (ret) {
-		goto end;
-	}
-
-	ret = bt_ctf_field_type_set_byte_order(_uint64_t, byte_order);
-	if (ret) {
-		goto end;
-	}
-
 	ret = bt_ctf_field_type_structure_add_field(event_header_type,
 		_uint32_t, "id");
 	if (ret) {
@@ -527,25 +815,22 @@ int init_event_header(struct bt_ctf_stream_class *stream_class,
 		goto end;
 	}
 
-	stream_class->event_header_type = event_header_type;
-	stream_class->event_header = bt_ctf_field_create(
-		stream_class->event_header_type);
-	if (!stream_class->event_header) {
-		ret = -1;
+	if (stream_class->event_header_type) {
+		bt_put(stream_class->event_header_type);
 	}
+	stream_class->event_header_type = event_header_type;
 end:
 	if (ret) {
-		bt_ctf_field_type_put(event_header_type);
+		bt_put(event_header_type);
 	}
 
-	bt_ctf_field_type_put(_uint32_t);
-	bt_ctf_field_type_put(_uint64_t);
+	bt_put(_uint32_t);
+	bt_put(_uint64_t);
 	return ret;
 }
 
 static
-int init_packet_context(struct bt_ctf_stream_class *stream_class,
-		enum bt_ctf_byte_order byte_order)
+int init_packet_context(struct bt_ctf_stream_class *stream_class)
 {
 	int ret = 0;
 	struct bt_ctf_field_type *packet_context_type =
@@ -562,11 +847,6 @@ int init_packet_context(struct bt_ctf_stream_class *stream_class,
 	 * We create a stream packet context as proposed in the CTF
 	 * specification.
 	 */
-	ret = bt_ctf_field_type_set_byte_order(_uint64_t, byte_order);
-	if (ret) {
-		goto end;
-	}
-
 	ret = bt_ctf_field_type_structure_add_field(packet_context_type,
 		_uint64_t, "timestamp_begin");
 	if (ret) {
@@ -597,13 +877,14 @@ int init_packet_context(struct bt_ctf_stream_class *stream_class,
 		goto end;
 	}
 
+	bt_put(stream_class->packet_context_type);
 	stream_class->packet_context_type = packet_context_type;
 end:
 	if (ret) {
-		bt_ctf_field_type_put(packet_context_type);
+		bt_put(packet_context_type);
 		goto end;
 	}
 
-	bt_ctf_field_type_put(_uint64_t);
+	bt_put(_uint64_t);
 	return ret;
 }