/*
* event.c
*
- * Babeltrace CTF Writer
+ * Babeltrace CTF IR - Event
*
- * Copyright 2013 EfficiOS Inc.
+ * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
#include <babeltrace/ctf-ir/event-fields-internal.h>
#include <babeltrace/ctf-ir/event-types-internal.h>
#include <babeltrace/ctf-ir/event-internal.h>
-#include <babeltrace/ctf-writer/writer-internal.h>
+#include <babeltrace/ctf-ir/stream-class.h>
+#include <babeltrace/ctf-ir/stream-class-internal.h>
+#include <babeltrace/ctf-ir/trace-internal.h>
#include <babeltrace/compiler.h>
static
void bt_ctf_event_class_destroy(struct bt_ctf_ref *ref);
static
void bt_ctf_event_destroy(struct bt_ctf_ref *ref);
+static
+int set_integer_field_value(struct bt_ctf_field *field, uint64_t value);
struct bt_ctf_event_class *bt_ctf_event_class_create(const char *name)
{
return event_class;
}
+const char *bt_ctf_event_class_get_name(struct bt_ctf_event_class *event_class)
+{
+ const char *name = NULL;
+
+ if (!event_class) {
+ goto end;
+ }
+
+ name = g_quark_to_string(event_class->name);
+end:
+ return name;
+}
+
+int64_t bt_ctf_event_class_get_id(struct bt_ctf_event_class *event_class)
+{
+ int64_t ret;
+
+ if (!event_class || !event_class->id_set) {
+ ret = -1;
+ goto end;
+ }
+
+ ret = (int64_t) event_class->id;
+end:
+ return ret;
+}
+
+int bt_ctf_event_class_set_id(struct bt_ctf_event_class *event_class,
+ uint32_t id)
+{
+ int ret = 0;
+
+ if (!event_class) {
+ ret = -1;
+ goto end;
+ }
+
+ if (event_class->stream_class) {
+ /*
+ * We don't allow changing the id if the event class has already
+ * been added to a stream class.
+ */
+ ret = -1;
+ goto end;
+ }
+
+ event_class->id = id;
+ event_class->id_set = 1;
+end:
+ return ret;
+}
+
+struct bt_ctf_stream_class *bt_ctf_event_class_get_stream_class(
+ struct bt_ctf_event_class *event_class)
+{
+ struct bt_ctf_stream_class *stream_class = NULL;
+
+ if (!event_class) {
+ goto end;
+ }
+
+ stream_class = event_class->stream_class;
+ bt_ctf_stream_class_get(stream_class);
+end:
+ return stream_class;
+}
+
int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class,
struct bt_ctf_field_type *type,
const char *name)
return ret;
}
+int bt_ctf_event_class_get_field_count(
+ struct bt_ctf_event_class *event_class)
+{
+ int ret;
+
+ if (!event_class) {
+ ret = -1;
+ goto end;
+ }
+
+ ret = bt_ctf_field_type_structure_get_field_count(event_class->fields);
+end:
+ return ret;
+}
+
+int bt_ctf_event_class_get_field(struct bt_ctf_event_class *event_class,
+ const char **field_name, struct bt_ctf_field_type **field_type,
+ int index)
+{
+ int ret;
+
+ if (!event_class || index < 0) {
+ ret = -1;
+ goto end;
+ }
+
+ ret = bt_ctf_field_type_structure_get_field(event_class->fields,
+ field_name, field_type, index);
+end:
+ return ret;
+}
+
+struct bt_ctf_field_type *bt_ctf_event_class_get_field_by_name(
+ struct bt_ctf_event_class *event_class, const char *name)
+{
+ GQuark name_quark;
+ struct bt_ctf_field_type *field_type = NULL;
+
+ if (!event_class || !name) {
+ goto end;
+ }
+
+ name_quark = g_quark_try_string(name);
+ if (!name_quark) {
+ goto end;
+ }
+
+ /*
+ * No need to increment field_type's reference count since getting it
+ * from the structure already does.
+ */
+ field_type = bt_ctf_field_type_structure_get_field_type_by_name(
+ event_class->fields, name);
+end:
+ return field_type;
+}
+
+struct bt_ctf_field_type *bt_ctf_event_class_get_context_type(
+ struct bt_ctf_event_class *event_class)
+{
+ struct bt_ctf_field_type *context_type = NULL;
+
+ if (!event_class || !event_class->context) {
+ goto end;
+ }
+
+ bt_ctf_field_type_get(event_class->context);
+ context_type = event_class->context;
+end:
+ return context_type;
+}
+
+int bt_ctf_event_class_set_context_type(
+ struct bt_ctf_event_class *event_class,
+ struct bt_ctf_field_type *context)
+{
+ int ret = 0;
+
+ if (!event_class || !context || event_class->frozen) {
+ ret = -1;
+ goto end;
+ }
+
+ if (bt_ctf_field_type_get_type_id(context) != CTF_TYPE_STRUCT) {
+ ret = -1;
+ goto end;
+ }
+
+ bt_ctf_field_type_get(context);
+ bt_ctf_field_type_put(event_class->context);
+ event_class->context = context;
+end:
+ return ret;
+
+}
+
void bt_ctf_event_class_get(struct bt_ctf_event_class *event_class)
{
if (!event_class) {
bt_ctf_event_class_get(event_class);
bt_ctf_event_class_freeze(event_class);
event->event_class = event_class;
- event->context_payload = bt_ctf_field_create(event_class->context);
+
+ assert(event_class->stream_class);
+ assert(event_class->stream_class->event_header_type);
+
+ event->event_header = bt_ctf_field_create(
+ event_class->stream_class->event_header_type);
+ if (!event->event_header) {
+ goto error_destroy;
+ }
+ if (event_class->context) {
+ event->context_payload = bt_ctf_field_create(
+ event_class->context);
+ if (!event->context_payload) {
+ goto error_destroy;
+ }
+ }
event->fields_payload = bt_ctf_field_create(event_class->fields);
+ if (!event->fields_payload) {
+ goto error_destroy;
+ }
end:
+ /*
+ * Freeze the stream class since the event header must not be changed
+ * anymore.
+ */
+ bt_ctf_stream_class_freeze(event_class->stream_class);
return event;
+error_destroy:
+ bt_ctf_event_destroy(&event->ref_count);
+ return NULL;
+}
+
+struct bt_ctf_event_class *bt_ctf_event_get_class(struct bt_ctf_event *event)
+{
+ struct bt_ctf_event_class *event_class = NULL;
+
+ if (!event) {
+ goto end;
+ }
+
+ event_class = event->event_class;
+ bt_ctf_event_class_get(event_class);
+end:
+ return event_class;
+}
+
+struct bt_ctf_clock *bt_ctf_event_get_clock(struct bt_ctf_event *event)
+{
+ struct bt_ctf_clock *clock = NULL;
+ struct bt_ctf_event_class *event_class;
+ struct bt_ctf_stream_class *stream_class;
+
+ if (!event) {
+ goto end;
+ }
+
+ event_class = bt_ctf_event_get_class(event);
+ if (!event_class) {
+ goto end;
+ }
+
+ stream_class = bt_ctf_event_class_get_stream_class(event_class);
+ if (!stream_class) {
+ goto error_put_event_class;
+ }
+
+ clock = bt_ctf_stream_class_get_clock(stream_class);
+ if (!clock) {
+ goto error_put_stream_class;
+ }
+
+error_put_stream_class:
+ bt_ctf_stream_class_put(stream_class);
+error_put_event_class:
+ bt_ctf_event_class_put(event_class);
+end:
+ return clock;
}
int bt_ctf_event_set_payload(struct bt_ctf_event *event,
return field;
}
+struct bt_ctf_field *bt_ctf_event_get_payload_by_index(
+ struct bt_ctf_event *event, int index)
+{
+ struct bt_ctf_field *field = NULL;
+
+ if (!event || index < 0) {
+ goto end;
+ }
+
+ field = bt_ctf_field_structure_get_field_by_index(event->fields_payload,
+ index);
+end:
+ return field;
+}
+
+struct bt_ctf_field *bt_ctf_event_get_event_header(
+ struct bt_ctf_event *event)
+{
+ struct bt_ctf_field *header = NULL;
+
+ if (!event || !event->event_header) {
+ goto end;
+ }
+
+ header = event->event_header;
+ bt_ctf_field_get(header);
+end:
+ return header;
+}
+
+int bt_ctf_event_set_event_header(struct bt_ctf_event *event,
+ struct bt_ctf_field *header)
+{
+ int ret = 0;
+ struct bt_ctf_field_type *field_type = NULL;
+
+ if (!event || !header) {
+ ret = -1;
+ goto end;
+ }
+
+ /* Could be NULL since an event class doesn't own a stream class */
+ if (!event->event_class->stream_class) {
+ ret = -1;
+ goto end;
+ }
+
+ /*
+ * Ensure the provided header's type matches the one registered to the
+ * stream class.
+ */
+ field_type = bt_ctf_field_get_type(header);
+ if (field_type != event->event_class->stream_class->event_header_type) {
+ ret = -1;
+ goto end;
+ }
+
+ bt_ctf_field_get(header);
+ bt_ctf_field_put(event->event_header);
+ event->event_header = header;
+end:
+ if (field_type) {
+ bt_ctf_field_type_put(field_type);
+ }
+ return ret;
+}
+
+struct bt_ctf_field *bt_ctf_event_get_event_context(
+ struct bt_ctf_event *event)
+{
+ struct bt_ctf_field *context = NULL;
+
+ if (!event || !event->context_payload) {
+ goto end;
+ }
+
+ context = event->context_payload;
+ bt_ctf_field_get(context);
+end:
+ return context;
+}
+
+int bt_ctf_event_set_event_context(struct bt_ctf_event *event,
+ struct bt_ctf_field *context)
+{
+ int ret = 0;
+ struct bt_ctf_field_type *field_type = NULL;
+
+ if (!event || !context) {
+ ret = -1;
+ goto end;
+ }
+
+ field_type = bt_ctf_field_get_type(context);
+ if (field_type != event->event_class->context) {
+ ret = -1;
+ goto end;
+ }
+
+ bt_ctf_field_get(context);
+ bt_ctf_field_put(event->context_payload);
+ event->context_payload = context;
+end:
+ if (field_type) {
+ bt_ctf_field_type_put(field_type);
+ }
+ return ret;
+}
+
void bt_ctf_event_get(struct bt_ctf_event *event)
{
if (!event) {
return;
}
+ /*
+ * Don't call put() on the stream class. See comment in
+ * bt_ctf_event_class_set_stream_class for explanation.
+ */
event_class = container_of(ref, struct bt_ctf_event_class, ref_count);
- bt_ctf_field_type_put(event_class->context);
- bt_ctf_field_type_put(event_class->fields);
+ if (event_class->context) {
+ bt_ctf_field_type_put(event_class->context);
+ }
+ if (event_class->fields) {
+ bt_ctf_field_type_put(event_class->fields);
+ }
g_free(event_class);
}
event = container_of(ref, struct bt_ctf_event,
ref_count);
- bt_ctf_event_class_put(event->event_class);
- bt_ctf_field_put(event->context_payload);
- bt_ctf_field_put(event->fields_payload);
+ if (event->event_class) {
+ bt_ctf_event_class_put(event->event_class);
+ }
+ if (event->event_header) {
+ bt_ctf_field_put(event->event_header);
+ }
+ if (event->context_payload) {
+ bt_ctf_field_put(event->context_payload);
+ }
+ if (event->fields_payload) {
+ bt_ctf_field_put(event->fields_payload);
+ }
g_free(event);
}
-BT_HIDDEN
-void bt_ctf_event_class_freeze(struct bt_ctf_event_class *event_class)
-{
- assert(event_class);
- event_class->frozen = 1;
- bt_ctf_field_type_freeze(event_class->context);
- bt_ctf_field_type_freeze(event_class->fields);
-}
-
-BT_HIDDEN
-int bt_ctf_event_class_set_id(struct bt_ctf_event_class *event_class,
- uint32_t id)
+static
+int set_integer_field_value(struct bt_ctf_field* field, uint64_t value)
{
int ret = 0;
+ struct bt_ctf_field_type *field_type = NULL;
- if (event_class->id_set && id != event_class->id) {
+ if (!field) {
ret = -1;
goto end;
}
- event_class->id = id;
- event_class->id_set = 1;
+ if (!bt_ctf_field_validate(field)) {
+ /* Payload already set, skip! (not an error) */
+ goto end;
+ }
+
+ field_type = bt_ctf_field_get_type(field);
+ assert(field_type);
+
+ if (bt_ctf_field_type_get_type_id(field_type) != CTF_TYPE_INTEGER) {
+ /* Not an integer and the value is unset, error. */
+ ret = -1;
+ goto end;
+ }
+
+ if (bt_ctf_field_type_integer_get_signed(field_type)) {
+ ret = bt_ctf_field_signed_integer_set_value(field, (int64_t) value);
+ if (ret) {
+ /* Value is out of range, error. */
+ goto end;
+ }
+ } else {
+ ret = bt_ctf_field_unsigned_integer_set_value(field, value);
+ if (ret) {
+ /* Value is out of range, error. */
+ goto end;
+ }
+ }
end:
+ bt_ctf_field_type_put(field_type);
return ret;
}
BT_HIDDEN
-uint32_t bt_ctf_event_class_get_id(struct bt_ctf_event_class *event_class)
+void bt_ctf_event_class_freeze(struct bt_ctf_event_class *event_class)
{
assert(event_class);
- return event_class->id;
+ event_class->frozen = 1;
+ bt_ctf_field_type_freeze(event_class->context);
+ bt_ctf_field_type_freeze(event_class->fields);
}
BT_HIDDEN
-int bt_ctf_event_class_set_stream_id(struct bt_ctf_event_class *event_class,
- uint32_t id)
+int bt_ctf_event_class_set_stream_class(struct bt_ctf_event_class *event_class,
+ struct bt_ctf_stream_class *stream_class)
{
int ret = 0;
- assert(event_class);
- if (event_class->stream_id_set && id != event_class->stream_id) {
+ if (!event_class) {
ret = -1;
goto end;
}
- event_class->stream_id = id;
- event_class->stream_id_set = 1;
+ /* Allow a NULL stream_class to unset the current stream_class */
+ if (stream_class && event_class->stream_class) {
+ ret = -1;
+ goto end;
+ }
+
+ event_class->stream_class = stream_class;
+ /*
+ * We don't get() the stream_class since doing so would introduce
+ * a circular ownership between event classes and stream classes.
+ *
+ * A stream class will always unset itself from its events before
+ * being destroyed. This ensures that a user won't get a pointer
+ * to a stale stream class instance from an event class.
+ */
end:
return ret;
}
struct metadata_context *context)
{
int ret = 0;
+ int64_t stream_id;
assert(event_class);
assert(context);
+ stream_id = bt_ctf_stream_class_get_id(event_class->stream_class);
+ if (stream_id < 0) {
+ ret = -1;
+ goto end;
+ }
+
context->current_indentation_level = 1;
g_string_assign(context->field_name, "");
- g_string_append_printf(context->string, "event {\n\tname = \"%s\";\n\tid = %u;\n\tstream_id = %" PRIu32 ";\n",
+ g_string_append_printf(context->string,
+ "event {\n\tname = \"%s\";\n\tid = %u;\n\tstream_id = %" PRId64 ";\n",
g_quark_to_string(event_class->name),
event_class->id,
- event_class->stream_id);
+ stream_id);
if (event_class->context) {
g_string_append(context->string, "\tcontext := ");
int ret;
assert(event);
+ ret = bt_ctf_field_validate(event->event_header);
+ if (ret) {
+ goto end;
+ }
+
ret = bt_ctf_field_validate(event->fields_payload);
if (ret) {
goto end;
assert(event);
return event->timestamp;
}
+
+BT_HIDDEN
+int bt_ctf_event_populate_event_header(struct bt_ctf_event *event)
+{
+ int ret = 0;
+ struct bt_ctf_field *id_field = NULL, *timestamp_field = NULL;
+
+ if (!event) {
+ ret = -1;
+ goto end;
+ }
+
+ id_field = bt_ctf_field_structure_get_field(event->event_header, "id");
+ if (id_field) {
+ ret = set_integer_field_value(id_field,
+ (uint64_t) event->event_class->id);
+ if (ret) {
+ goto end;
+ }
+ }
+
+ timestamp_field = bt_ctf_field_structure_get_field(event->event_header,
+ "timestamp");
+ if (timestamp_field) {
+ ret = set_integer_field_value(timestamp_field,
+ (uint64_t) event->timestamp);
+ if (ret) {
+ goto end;
+ }
+ }
+end:
+ if (id_field) {
+ bt_ctf_field_put(id_field);
+ }
+ if (timestamp_field) {
+ bt_ctf_field_put(timestamp_field);
+ }
+ return ret;
+}