#include <babeltrace/assert-internal.h>
#include <inttypes.h>
-static
-int bt_event_common_validate_types_for_create(
- struct bt_event_class_common *event_class,
+static inline
+int bt_event_validate_types_for_create(
+ struct bt_event_class *event_class,
struct bt_validation_output *validation_output,
bt_validation_flag_copy_field_type_func copy_field_type_func)
{
enum bt_validation_flag validation_flags =
BT_VALIDATION_FLAG_STREAM |
BT_VALIDATION_FLAG_EVENT;
- struct bt_trace_common *trace = NULL;
- struct bt_stream_class_common *stream_class = NULL;
- struct bt_field_type_common *packet_header_type = NULL;
- struct bt_field_type_common *packet_context_type = NULL;
- struct bt_field_type_common *event_header_type = NULL;
- struct bt_field_type_common *stream_event_ctx_type = NULL;
- struct bt_field_type_common *event_context_type = NULL;
- struct bt_field_type_common *event_payload_type = NULL;
+ struct bt_trace *trace = NULL;
+ struct bt_stream_class *stream_class = NULL;
+ struct bt_field_type *packet_header_type = NULL;
+ struct bt_field_type *packet_context_type = NULL;
+ struct bt_field_type *event_header_type = NULL;
+ struct bt_field_type *stream_event_ctx_type = NULL;
+ struct bt_field_type *event_context_type = NULL;
+ struct bt_field_type *event_payload_type = NULL;
int trace_valid = 0;
struct bt_value *environment = NULL;
- stream_class = bt_event_class_common_borrow_stream_class(event_class);
+ stream_class = bt_event_class_borrow_stream_class(event_class);
BT_ASSERT(stream_class);
- trace = bt_stream_class_common_borrow_trace(stream_class);
+ trace = bt_stream_class_borrow_trace(stream_class);
if (trace) {
BT_LOGD_STR("Event class is part of a trace.");
packet_header_type =
- bt_trace_common_borrow_packet_header_field_type(trace);
+ bt_trace_borrow_packet_header_field_type(trace);
trace_valid = trace->valid;
BT_ASSERT(trace_valid);
environment = trace->environment;
}
packet_context_type =
- bt_stream_class_common_borrow_packet_context_field_type(
+ bt_stream_class_borrow_packet_context_field_type(
stream_class);
event_header_type =
- bt_stream_class_common_borrow_event_header_field_type(
+ bt_stream_class_borrow_event_header_field_type(
stream_class);
stream_event_ctx_type =
- bt_stream_class_common_borrow_event_context_field_type(
+ bt_stream_class_borrow_event_context_field_type(
stream_class);
event_context_type =
- bt_event_class_common_borrow_context_field_type(event_class);
+ bt_event_class_borrow_context_field_type(event_class);
event_payload_type =
- bt_event_class_common_borrow_payload_field_type(event_class);
+ bt_event_class_borrow_payload_field_type(event_class);
ret = bt_validate_class_types(environment, packet_header_type,
packet_context_type, event_header_type, stream_event_ctx_type,
event_context_type, event_payload_type, trace_valid,
}
static
-int bt_event_common_create_fields(
- struct bt_stream_class_common *stream_class,
+int bt_event_create_fields(
+ struct bt_stream_class *stream_class,
struct bt_validation_output *validation_output,
create_field_func create_field_func,
release_field_func release_field_func,
create_header_field_func create_header_field_func,
release_header_field_func release_header_field_func,
struct bt_field_wrapper **header_field,
- struct bt_field_common **stream_event_context_field,
- struct bt_field_common **context_field,
- struct bt_field_common **payload_field)
+ struct bt_field **stream_event_context_field,
+ struct bt_field **context_field,
+ struct bt_field **payload_field)
{
int ret = 0;
}
BT_HIDDEN
-int _bt_event_common_validate(struct bt_event_common *event)
+int _bt_event_validate(struct bt_event *event)
{
int ret = 0;
- struct bt_stream_class_common *stream_class;
+ struct bt_stream_class *stream_class;
BT_ASSERT(event);
if (event->header_field) {
- ret = bt_field_common_validate_recursive(
+ ret = bt_field_validate_recursive(
event->header_field->field);
if (ret) {
BT_ASSERT_PRE_MSG("Invalid event's header field: "
- "%![event-]+_e, %![field-]+_f",
+ "%![event-]+e, %![field-]+f",
event, event->header_field->field);
goto end;
}
}
- stream_class = bt_event_class_common_borrow_stream_class(event->class);
+ stream_class = bt_event_class_borrow_stream_class(event->class);
/*
* We should not have been able to create the event without associating
BT_ASSERT(stream_class);
if (stream_class->event_context_field_type) {
- ret = bt_field_common_validate_recursive(
+ ret = bt_field_validate_recursive(
event->stream_event_context_field);
if (ret) {
BT_ASSERT_PRE_MSG("Invalid event's stream event context field: "
- "%![event-]+_e, %![field-]+_f",
+ "%![event-]+e, %![field-]+f",
event, event->stream_event_context_field);
goto end;
}
}
if (event->class->context_field_type) {
- ret = bt_field_common_validate_recursive(event->context_field);
+ ret = bt_field_validate_recursive(event->context_field);
if (ret) {
BT_ASSERT_PRE_MSG("Invalid event's payload field: "
- "%![event-]+_e, %![field-]+_f",
+ "%![event-]+e, %![field-]+f",
event, event->context_field);
goto end;
}
}
- ret = bt_field_common_validate_recursive(event->payload_field);
+ ret = bt_field_validate_recursive(event->payload_field);
if (ret) {
BT_ASSERT_PRE_MSG("Invalid event's payload field: "
- "%![event-]+_e, %![field-]+_f",
+ "%![event-]+e, %![field-]+f",
event, event->payload_field);
goto end;
}
}
BT_HIDDEN
-void _bt_event_common_set_is_frozen(struct bt_event_common *event,
+void _bt_event_set_is_frozen(struct bt_event *event,
bool is_frozen)
{
BT_ASSERT(event);
BT_LOGD("Freezing event: addr=%p, "
"event-class-name=\"%s\", event-class-id=%" PRId64,
- event, bt_event_class_common_get_name(event->class),
- bt_event_class_common_get_id(event->class));
+ event, bt_event_class_get_name(event->class),
+ bt_event_class_get_id(event->class));
if (event->header_field) {
BT_LOGD_STR("Freezing event's header field.");
- bt_field_common_set_is_frozen_recursive(
+ bt_field_set_is_frozen_recursive(
event->header_field->field, is_frozen);
}
if (event->stream_event_context_field) {
BT_LOGD_STR("Freezing event's stream event context field.");
- bt_field_common_set_is_frozen_recursive(
+ bt_field_set_is_frozen_recursive(
event->stream_event_context_field, is_frozen);
}
if (event->context_field) {
BT_LOGD_STR("Freezing event's context field.");
- bt_field_common_set_is_frozen_recursive(event->context_field,
+ bt_field_set_is_frozen_recursive(event->context_field,
is_frozen);
}
if (event->payload_field) {
BT_LOGD_STR("Freezing event's payload field.");
- bt_field_common_set_is_frozen_recursive(event->payload_field,
+ bt_field_set_is_frozen_recursive(event->payload_field,
is_frozen);
}
event->frozen = is_frozen;
+ BT_LOGD_STR("Freezing event's packet.");
+ bt_packet_set_is_frozen(event->packet, is_frozen);
}
-BT_HIDDEN
-int bt_event_common_initialize(struct bt_event_common *event,
- struct bt_event_class_common *event_class,
- struct bt_clock_class *init_expected_clock_class,
- bool is_shared_with_parent, bt_object_release_func release_func,
+static inline
+int bt_event_initialize(struct bt_event *event,
+ struct bt_event_class *event_class,
bt_validation_flag_copy_field_type_func field_type_copy_func,
- bool must_be_in_trace,
- int (*map_clock_classes_func)(struct bt_stream_class_common *stream_class,
- struct bt_field_type_common *packet_context_field_type,
- struct bt_field_type_common *event_header_field_type),
create_field_func create_field_func,
release_field_func release_field_func,
create_header_field_func create_header_field_func,
release_header_field_func release_header_field_func)
{
int ret;
- struct bt_trace_common *trace = NULL;
- struct bt_stream_class_common *stream_class = NULL;
+ struct bt_trace *trace = NULL;
+ struct bt_stream_class *stream_class = NULL;
struct bt_field_wrapper *event_header = NULL;
- struct bt_field_common *stream_event_context = NULL;
- struct bt_field_common *event_context = NULL;
- struct bt_field_common *event_payload = NULL;
+ struct bt_field *stream_event_context = NULL;
+ struct bt_field *event_context = NULL;
+ struct bt_field *event_payload = NULL;
struct bt_validation_output validation_output = { 0 };
- struct bt_clock_class *expected_clock_class =
- init_expected_clock_class ? bt_get(init_expected_clock_class) :
- NULL;
+ struct bt_clock_class *expected_clock_class = NULL;
BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
- BT_LOGD("Initializing common event object: event-class-addr=%p, "
+ BT_LOGD("Initializing event object: event-class-addr=%p, "
"event-class-name=\"%s\", event-class-id=%" PRId64,
- event_class, bt_event_class_common_get_name(event_class),
- bt_event_class_common_get_id(event_class));
+ event_class, bt_event_class_get_name(event_class),
+ bt_event_class_get_id(event_class));
- stream_class = bt_event_class_common_borrow_stream_class(event_class);
+ stream_class = bt_event_class_borrow_stream_class(event_class);
BT_ASSERT_PRE(stream_class,
- "Event class is not part of a stream class: %!+_E", event_class);
+ "Event class is not part of a stream class: %!+E", event_class);
/* The event class was frozen when added to its stream class */
BT_ASSERT(event_class->frozen);
- trace = bt_stream_class_common_borrow_trace(stream_class);
-
- if (must_be_in_trace) {
- BT_ASSERT_PRE(trace,
- "Event class's stream class is not part of a trace: "
- "%![ec-]+_E, %![ec-]+_S", event_class, stream_class);
- }
+ trace = bt_stream_class_borrow_trace(stream_class);
+ BT_ASSERT_PRE(trace,
+ "Event class's stream class is not part of a trace: "
+ "%![ec-]+E, %![ec-]+S", event_class, stream_class);
/*
* This must be called before anything that can fail because on
* failure, the caller releases the reference to `event` to
* destroy it.
*/
- if (is_shared_with_parent) {
- bt_object_init_shared_with_parent(&event->base, release_func);
- } else {
- bt_object_init_unique(&event->base);
- }
+ bt_object_init_unique(&event->base);
if (!stream_class->frozen) {
/*
* single clock class so that we set its expected clock
* class for future checks.
*/
- ret = bt_stream_class_common_validate_single_clock_class(
+ ret = bt_stream_class_validate_single_clock_class(
stream_class, &expected_clock_class);
if (ret) {
BT_LOGW("Event class's stream class or one of its event "
"expected-clock-class-addr=%p, "
"expected-clock-class-name=\"%s\"",
stream_class,
- bt_stream_class_common_get_id(stream_class),
- bt_stream_class_common_get_name(stream_class),
+ bt_stream_class_get_id(stream_class),
+ bt_stream_class_get_name(stream_class),
expected_clock_class,
expected_clock_class ?
bt_clock_class_get_name(expected_clock_class) :
}
/* Validate the trace, the stream class, and the event class */
- ret = bt_event_common_validate_types_for_create(
+ ret = bt_event_validate_types_for_create(
event_class, &validation_output, field_type_copy_func);
if (ret) {
- /* bt_event_common_validate_types_for_create() logs errors */
+ /* bt_event_validate_types_for_create() logs errors */
goto error;
}
- if (map_clock_classes_func) {
- /*
- * Safe to automatically map selected fields to the
- * stream's clock's class here because the stream class
- * is about to be frozen.
- */
- if (map_clock_classes_func(stream_class,
- validation_output.packet_context_type,
- validation_output.event_header_type)) {
- BT_LOGW_STR("Cannot automatically map selected stream class's "
- "field types to stream class's clock's class.");
- goto error;
- }
- }
-
/*
* event does not share a common ancestor with the event class; it has
* to guarantee its existence by holding a reference. This reference
* shall be released once the event is associated to a stream since,
* from that point, the event and its class will share the same
* lifetime.
+ *
+ * TODO: Is this still true now that this API and CTF writer are
+ * two different implementations?
*/
event->class = bt_get(event_class);
-
- ret = bt_event_common_create_fields(stream_class,
+ ret = bt_event_create_fields(stream_class,
&validation_output,
create_field_func, release_field_func,
create_header_field_func, release_header_field_func,
&event_header, &stream_event_context, &event_context,
&event_payload);
if (ret) {
- /* bt_event_common_create_fields() logs errors */
+ /* bt_event_create_fields() logs errors */
goto error;
}
* Freeze the stream class since the event header must not be changed
* anymore.
*/
- bt_stream_class_common_freeze(stream_class);
+ bt_stream_class_freeze(stream_class);
/*
* It is safe to set the stream class's unique clock class
/* Put stuff we borrowed from the event class */
BT_LOGD("Initialized event object: addr=%p, event-class-name=\"%s\", "
"event-class-id=%" PRId64,
- event, bt_event_class_common_get_name(event->class),
- bt_event_class_common_get_id(event->class));
+ event, bt_event_class_get_name(event->class),
+ bt_event_class_get_id(event->class));
goto end;
error:
static
struct bt_field_wrapper *create_event_header_field(
struct bt_stream_class *stream_class,
- struct bt_field_type_common *ft)
+ struct bt_field_type *ft)
{
struct bt_field_wrapper *field_wrapper = NULL;
goto error;
}
- ret = bt_event_common_initialize(BT_TO_COMMON(event),
- BT_TO_COMMON(event_class), NULL, false, NULL,
+ ret = bt_event_initialize(event, event_class,
(bt_validation_flag_copy_field_type_func) bt_field_type_copy,
- true, NULL,
(create_field_func) bt_field_create_recursive,
(release_field_func) bt_field_destroy_recursive,
(create_header_field_func) create_event_header_field,
(release_header_field_func) bt_event_header_field_recycle);
if (ret) {
- /* bt_event_common_initialize() logs errors */
+ /* bt_event_initialize() logs errors */
goto error;
}
struct bt_event_class *bt_event_borrow_class(struct bt_event *event)
{
BT_ASSERT_PRE_NON_NULL(event, "Event");
- return BT_FROM_COMMON(
- bt_event_common_borrow_class(BT_TO_COMMON(event)));
+ return event->class;
}
struct bt_stream *bt_event_borrow_stream(struct bt_event *event)
struct bt_field *bt_event_borrow_payload(struct bt_event *event)
{
- return BT_FROM_COMMON(
- bt_event_common_borrow_payload(BT_TO_COMMON(event)));
+ struct bt_field *payload = NULL;
+
+ BT_ASSERT_PRE_NON_NULL(event, "Event");
+
+ if (!event->payload_field) {
+ BT_LOGV("Event has no current payload field: addr=%p, "
+ "event-class-name=\"%s\", event-class-id=%" PRId64,
+ event, bt_event_class_get_name(event->class),
+ bt_event_class_get_id(event->class));
+ goto end;
+ }
+
+ payload = event->payload_field;
+
+end:
+ return payload;
}
struct bt_field *bt_event_borrow_header(struct bt_event *event)
{
- return BT_FROM_COMMON(
- bt_event_common_borrow_header(BT_TO_COMMON(event)));
+ struct bt_field *header = NULL;
+
+ BT_ASSERT_PRE_NON_NULL(event, "Event");
+
+ if (!event->header_field) {
+ BT_LOGV("Event has no current header field: addr=%p, "
+ "event-class-name=\"%s\", event-class-id=%" PRId64,
+ event, bt_event_class_get_name(event->class),
+ bt_event_class_get_id(event->class));
+ goto end;
+ }
+
+ header = event->header_field->field;
+
+end:
+ return header;
}
struct bt_field *bt_event_borrow_context(struct bt_event *event)
{
- return BT_FROM_COMMON(
- bt_event_common_borrow_context(BT_TO_COMMON(event)));
+ struct bt_field *context = NULL;
+
+ BT_ASSERT_PRE_NON_NULL(event, "Event");
+
+ if (!event->context_field) {
+ BT_LOGV("Event has no current context field: addr=%p, "
+ "event-class-name=\"%s\", event-class-id=%" PRId64,
+ event, bt_event_class_get_name(event->class),
+ bt_event_class_get_id(event->class));
+ goto end;
+ }
+
+ context = event->context_field;
+
+end:
+ return context;
}
struct bt_field *bt_event_borrow_stream_event_context(
struct bt_event *event)
{
- return BT_FROM_COMMON(bt_event_common_borrow_stream_event_context(
- BT_TO_COMMON(event)));
+ struct bt_field *stream_event_context = NULL;
+
+ BT_ASSERT_PRE_NON_NULL(event, "Event");
+
+ if (!event->stream_event_context_field) {
+ BT_LOGV("Event has no current stream event context field: addr=%p, "
+ "event-class-name=\"%s\", event-class-id=%" PRId64,
+ event, bt_event_class_get_name(event->class),
+ bt_event_class_get_id(event->class));
+ goto end;
+ }
+
+ stream_event_context = event->stream_event_context_field;
+
+end:
+ return stream_event_context;
}
static
void release_event_header_field(struct bt_field_wrapper *field_wrapper,
- struct bt_event_common *event_common)
+ struct bt_event *event)
{
- struct bt_event *event = BT_FROM_COMMON(event_common);
struct bt_event_class *event_class = bt_event_borrow_class(event);
if (!event_class) {
}
}
+static inline
+void bt_event_finalize(struct bt_object *obj,
+ void (*field_release_func)(void *),
+ void (*header_field_release_func)(void *, struct bt_event *))
+{
+ struct bt_event *event = (void *) obj;
+
+ BT_LOGD("Destroying event: addr=%p, "
+ "event-class-name=\"%s\", event-class-id=%" PRId64,
+ event,
+ event->class ? bt_event_class_get_name(event->class) : NULL,
+ event->class ? bt_event_class_get_id(event->class) : INT64_C(-1));
+
+ if (event->header_field) {
+ BT_LOGD_STR("Releasing event's header field.");
+ header_field_release_func(event->header_field, event);
+ }
+
+ if (event->stream_event_context_field) {
+ BT_LOGD_STR("Releasing event's stream event context field.");
+ field_release_func(event->stream_event_context_field);
+ }
+
+ if (event->context_field) {
+ BT_LOGD_STR("Releasing event's context field.");
+ field_release_func(event->context_field);
+ }
+
+ if (event->payload_field) {
+ BT_LOGD_STR("Releasing event's payload field.");
+ field_release_func(event->payload_field);
+ }
+
+ /*
+ * Leave this after calling header_field_release_func() because
+ * this function receives the event object and could need its
+ * class to perform some cleanup.
+ */
+ if (!event->base.parent) {
+ /*
+ * Event was keeping a reference to its class since it shared no
+ * common ancestor with it to guarantee they would both have the
+ * same lifetime.
+ */
+ bt_put(event->class);
+ }
+}
+
BT_HIDDEN
void bt_event_destroy(struct bt_event *event)
{
BT_ASSERT(event);
- bt_event_common_finalize((void *) event,
+ bt_event_finalize((void *) event,
(void *) bt_field_destroy_recursive,
(void *) release_event_header_field);
bt_clock_value_set_finalize(&event->cv_set);
{
BT_ASSERT_PRE_NON_NULL(event, "Event");
BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
- BT_ASSERT_PRE_HOT(BT_TO_COMMON(event), "Event", ": %!+e", event);
+ BT_ASSERT_PRE_HOT(event, "Event", ": %!+e", event);
BT_ASSERT_PRE(is_default,
"You can only set a default clock value as of this version.");
return bt_clock_value_set_set_clock_value(&event->cv_set, clock_class,
if (!event->packet) {
BT_LOGV("Event has no current packet: addr=%p, "
"event-class-name=\"%s\", event-class-id=%" PRId64,
- event, bt_event_class_common_get_name(event->common.class),
- bt_event_class_common_get_id(event->common.class));
+ event, bt_event_class_get_name(event->class),
+ bt_event_class_get_id(event->class));
goto end;
}
return packet;
}
-BT_HIDDEN
-void _bt_event_set_is_frozen(struct bt_event *event, bool is_frozen)
-{
- bt_event_common_set_is_frozen(BT_TO_COMMON(event), is_frozen);
- BT_LOGD_STR("Freezing event's packet.");
- bt_packet_set_is_frozen(event->packet, is_frozen);
-}
-
int bt_event_move_header(struct bt_event *event,
struct bt_event_header_field *header_field)
{
BT_ASSERT_PRE_NON_NULL(event, "Event");
BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
- BT_ASSERT_PRE_HOT(BT_TO_COMMON(event), "Event", ": %!+e", event);
+ BT_ASSERT_PRE_HOT(event, "Event", ": %!+e", event);
stream_class = bt_event_class_borrow_stream_class(
bt_event_borrow_class(event));
- BT_ASSERT_PRE(stream_class->common.event_header_field_type,
+ BT_ASSERT_PRE(stream_class->event_header_field_type,
"Stream class has no event header field type: %!+S",
stream_class);
/* Recycle current header field: always exists */
- BT_ASSERT(event->common.header_field);
- bt_event_header_field_recycle(event->common.header_field,
+ BT_ASSERT(event->header_field);
+ bt_event_header_field_recycle(event->header_field,
stream_class);
/* Move new field */
- event->common.header_field = (void *) field_wrapper;
+ event->header_field = (void *) field_wrapper;
return 0;
}
projects / babeltrace.git / blobdiff