X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=lib%2Fctf-ir%2Fevent.c;h=a026cac998a5b8e8328f59d75ce7242892e13a86;hb=3dca22768a95bef664012559aa9ac977091de6ac;hp=59eac156596fabe61dc703b37b41488eb9c4d780;hpb=7b010242359ecd3c2e0df31be8f109bf117e1253;p=babeltrace.git diff --git a/lib/ctf-ir/event.c b/lib/ctf-ir/event.c index 59eac156..a026cac9 100644 --- a/lib/ctf-ir/event.c +++ b/lib/ctf-ir/event.c @@ -29,9 +29,12 @@ #define BT_LOG_TAG "EVENT" #include +#include #include #include #include +#include +#include #include #include #include @@ -41,99 +44,65 @@ #include #include #include +#include #include #include #include #include -#include #include #include #include +#include #include static -void bt_ctf_event_destroy(struct bt_object *obj); +void bt_event_destroy(struct bt_object *obj); -struct bt_ctf_event *bt_ctf_event_create(struct bt_ctf_event_class *event_class) +static +int bt_event_common_validate_types_for_create( + struct bt_event_class_common *event_class, + struct bt_validation_output *validation_output, + bt_validation_flag_copy_field_type_func copy_field_type_func) { int ret; - enum bt_ctf_validation_flag validation_flags = - BT_CTF_VALIDATION_FLAG_STREAM | - BT_CTF_VALIDATION_FLAG_EVENT; - struct bt_ctf_event *event = NULL; - struct bt_ctf_trace *trace = NULL; - struct bt_ctf_stream_class *stream_class = NULL; - struct bt_ctf_field_type *packet_header_type = NULL; - struct bt_ctf_field_type *packet_context_type = NULL; - struct bt_ctf_field_type *event_header_type = NULL; - struct bt_ctf_field_type *stream_event_ctx_type = NULL; - struct bt_ctf_field_type *event_context_type = NULL; - struct bt_ctf_field_type *event_payload_type = NULL; - struct bt_ctf_field *event_header = NULL; - struct bt_ctf_field *stream_event_context = NULL; - struct bt_ctf_field *event_context = NULL; - struct bt_ctf_field *event_payload = NULL; - struct bt_value *environment = NULL; - struct bt_ctf_validation_output validation_output = { 0 }; + 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; int trace_valid = 0; + struct bt_value *environment = NULL; - BT_LOGD("Creating event object: event-class-addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event_class, bt_ctf_event_class_get_name(event_class), - bt_ctf_event_class_get_id(event_class)); - - if (!event_class) { - BT_LOGW_STR("Invalid parameter: event class is NULL."); - goto error; - } - - stream_class = bt_ctf_event_class_get_stream_class(event_class); - - /* - * We disallow the creation of an event if its event class has not been - * associated to a stream class. - */ - if (!stream_class) { - BT_LOGW("Event class is not part of a stream class: " - "addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event_class)); - goto error; - } - - /* A stream class should always have an existing event header type */ - assert(stream_class->event_header_type); - - /* The event class was frozen when added to its stream class */ - assert(event_class->frozen); - - /* Validate the trace (if any), the stream class, and the event class */ - trace = bt_ctf_stream_class_get_trace(stream_class); + stream_class = bt_event_class_common_borrow_stream_class(event_class); + BT_ASSERT(stream_class); + trace = bt_stream_class_common_borrow_trace(stream_class); if (trace) { - BT_LOGD("Event's class is part of a trace: " - "event-class-name=\"%s\", event-class-id=%" PRId64, - bt_ctf_event_class_get_name(event_class), - bt_ctf_event_class_get_id(event_class)); - packet_header_type = bt_ctf_trace_get_packet_header_type(trace); + BT_LOGD_STR("Event class is part of a trace."); + packet_header_type = bt_trace_common_get_packet_header_field_type(trace); trace_valid = trace->valid; - assert(trace_valid); + BT_ASSERT(trace_valid); environment = trace->environment; } - packet_context_type = bt_ctf_stream_class_get_packet_context_type( + packet_context_type = bt_stream_class_common_get_packet_context_field_type( stream_class); - event_header_type = bt_ctf_stream_class_get_event_header_type( + event_header_type = bt_stream_class_common_get_event_header_field_type( stream_class); - stream_event_ctx_type = bt_ctf_stream_class_get_event_context_type( + stream_event_ctx_type = bt_stream_class_common_get_event_context_field_type( stream_class); - event_context_type = bt_ctf_event_class_get_context_type(event_class); - event_payload_type = bt_ctf_event_class_get_payload_type(event_class); - ret = bt_ctf_validate_class_types(environment, packet_header_type, + event_context_type = bt_event_class_common_get_context_field_type(event_class); + event_payload_type = bt_event_class_common_get_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, stream_class->valid, event_class->valid, - &validation_output, validation_flags); + validation_output, validation_flags, copy_field_type_func); BT_PUT(packet_header_type); BT_PUT(packet_context_type); BT_PUT(event_header_type); @@ -145,871 +114,584 @@ struct bt_ctf_event *bt_ctf_event_create(struct bt_ctf_event_class *event_class) * This means something went wrong during the validation * process, not that the objects are invalid. */ - BT_LOGE("Failed to validate event: addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event_class)); + BT_LOGE("Failed to validate event and parents: ret=%d", ret); goto error; } - if ((validation_output.valid_flags & validation_flags) != + if ((validation_output->valid_flags & validation_flags) != validation_flags) { /* Invalid trace/stream class/event class */ - BT_LOGE("Invalid trace, stream class, or event class: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64 ", valid-flags=0x%x", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event_class), - validation_output.valid_flags); + BT_LOGW("Invalid trace, stream class, or event class: " + "valid-flags=0x%x", validation_output->valid_flags); goto error; } - /* - * At this point we know the trace (if associated to the stream - * class), the stream class, and the event class, with their - * current types, are valid. We may proceed with creating - * the event. - */ - event = g_new0(struct bt_ctf_event, 1); - if (!event) { - BT_LOGE_STR("Failed to allocate one event."); - goto error; - } + goto end; - bt_object_init(event, bt_ctf_event_destroy); +error: + bt_validation_output_put_types(validation_output); + ret = -1; - /* - * 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. - */ - event->event_class = bt_get(event_class); - event->clock_values = g_hash_table_new_full(g_direct_hash, - g_direct_equal, bt_put, bt_put); - event_header = - bt_ctf_field_create(validation_output.event_header_type); - if (!event_header) { - BT_LOGE_STR("Cannot create initial event header field object."); - goto error; +end: + BT_ASSERT(!packet_header_type); + BT_ASSERT(!packet_context_type); + BT_ASSERT(!event_header_type); + BT_ASSERT(!stream_event_ctx_type); + BT_ASSERT(!event_context_type); + BT_ASSERT(!event_payload_type); + return ret; +} + +static +int bt_event_common_create_fields( + struct bt_validation_output *validation_output, + void *(*create_field_func)(void *), + struct bt_field_common **header_field, + struct bt_field_common **stream_event_context_field, + struct bt_field_common **context_field, + struct bt_field_common **payload_field) +{ + int ret = 0; + + if (validation_output->event_header_type) { + BT_LOGD("Creating initial event header field: ft-addr=%p", + validation_output->event_header_type); + *header_field = + create_field_func(validation_output->event_header_type); + if (!*header_field) { + BT_LOGE_STR("Cannot create initial event header field object."); + goto error; + } } - if (validation_output.stream_event_ctx_type) { - stream_event_context = bt_ctf_field_create( - validation_output.stream_event_ctx_type); - if (!stream_event_context) { + if (validation_output->stream_event_ctx_type) { + BT_LOGD("Creating initial stream event context field: ft-addr=%p", + validation_output->stream_event_ctx_type); + *stream_event_context_field = create_field_func( + validation_output->stream_event_ctx_type); + if (!*stream_event_context_field) { BT_LOGE_STR("Cannot create initial stream event context field object."); goto error; } } - if (validation_output.event_context_type) { - event_context = bt_ctf_field_create( - validation_output.event_context_type); - if (!event_context) { + if (validation_output->event_context_type) { + BT_LOGD("Creating initial event context field: ft-addr=%p", + validation_output->event_context_type); + *context_field = create_field_func( + validation_output->event_context_type); + if (!*context_field) { BT_LOGE_STR("Cannot create initial event context field object."); goto error; } } - if (validation_output.event_payload_type) { - event_payload = bt_ctf_field_create( - validation_output.event_payload_type); - if (!event_payload) { + if (validation_output->event_payload_type) { + BT_LOGD("Creating initial event payload field: ft-addr=%p", + validation_output->event_payload_type); + *payload_field = create_field_func( + validation_output->event_payload_type); + if (!*payload_field) { BT_LOGE_STR("Cannot create initial event payload field object."); goto error; } } - /* - * At this point all the fields are created, potentially from - * validated copies of field types, so that the field types and - * fields can be replaced in the trace, stream class, - * event class, and created event. - */ - bt_ctf_validation_replace_types(trace, stream_class, - event_class, &validation_output, validation_flags); - BT_MOVE(event->event_header, event_header); - BT_MOVE(event->stream_event_context, stream_event_context); - BT_MOVE(event->context_payload, event_context); - BT_MOVE(event->fields_payload, event_payload); - - /* - * Put what was not moved in bt_ctf_validation_replace_types(). - */ - bt_ctf_validation_output_put_types(&validation_output); - - /* - * Freeze the stream class since the event header must not be changed - * anymore. - */ - bt_ctf_stream_class_freeze(stream_class); - - /* - * Mark stream class, and event class as valid since - * they're all frozen now. - */ - stream_class->valid = 1; - event_class->valid = 1; - - /* Put stuff we borrowed from the event class */ - BT_PUT(stream_class); - BT_PUT(trace); - BT_LOGD("Created event object: addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event_class)); - return event; + goto end; error: - bt_ctf_validation_output_put_types(&validation_output); - BT_PUT(event); - BT_PUT(stream_class); - BT_PUT(trace); - BT_PUT(event_header); - BT_PUT(stream_event_context); - BT_PUT(event_context); - BT_PUT(event_payload); - assert(!packet_header_type); - assert(!packet_context_type); - assert(!event_header_type); - assert(!stream_event_ctx_type); - assert(!event_context_type); - assert(!event_payload_type); - - return event; -} + BT_PUT(*header_field); + BT_PUT(*stream_event_context_field); + BT_PUT(*context_field); + BT_PUT(*payload_field); + ret = -1; -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) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - goto end; - } - - event_class = event ? bt_get(bt_ctf_event_borrow_event_class(event)) : - NULL; end: - return event_class; + return ret; } -struct bt_ctf_stream *bt_ctf_event_get_stream(struct bt_ctf_event *event) +BT_HIDDEN +int _bt_event_common_validate(struct bt_event_common *event) { - struct bt_ctf_stream *stream = NULL; - - if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - goto end; - } + int ret = 0; + struct bt_stream_class_common *stream_class; - /* - * If the event has a parent, then this is its (writer) stream. - * If the event has no parent, then if it has a packet, this - * is its (non-writer) stream. - */ - if (event->base.parent) { - stream = (struct bt_ctf_stream *) bt_object_get_parent(event); - } else { - if (event->packet) { - stream = bt_get(event->packet->stream); + BT_ASSERT(event); + if (event->header_field) { + ret = bt_field_common_validate_recursive(event->header_field); + if (ret) { + BT_ASSERT_PRE_MSG("Invalid event's header field: " + "%![event-]+_e, %![field-]+_f", + event, event->header_field); + goto end; } } -end: - return stream; -} - -int bt_ctf_event_set_payload(struct bt_ctf_event *event, - const char *name, - struct bt_ctf_field *payload) -{ - int ret = 0; + stream_class = bt_event_class_common_borrow_stream_class(event->class); - if (!event || !payload) { - BT_LOGW("Invalid parameter: event or payload field is NULL: " - "event-addr=%p, payload-field-addr=%p", - event, payload); - ret = -1; - goto end; - } + /* + * We should not have been able to create the event without associating + * the event class to a stream class. + */ + BT_ASSERT(stream_class); - if (event->frozen) { - BT_LOGW("Invalid parameter: event is frozen: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = -1; - goto end; + if (stream_class->event_context_field_type) { + ret = bt_field_common_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, event->stream_event_context_field); + goto end; + } } - if (name) { - ret = bt_ctf_field_structure_set_field(event->fields_payload, - name, payload); - } else { - struct bt_ctf_field_type *payload_type; - - payload_type = bt_ctf_field_get_type(payload); - - if (bt_ctf_field_type_compare(payload_type, - event->event_class->fields) == 0) { - bt_put(event->fields_payload); - bt_get(payload); - event->fields_payload = payload; - } else { - BT_LOGW("Invalid parameter: payload field type is different from the expected field type: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, - bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = -1; + if (event->class->context_field_type) { + ret = bt_field_common_validate_recursive(event->context_field); + if (ret) { + BT_ASSERT_PRE_MSG("Invalid event's payload field: " + "%![event-]+_e, %![field-]+_f", + event, event->context_field); + goto end; } - - bt_put(payload_type); } + ret = bt_field_common_validate_recursive(event->payload_field); if (ret) { - BT_LOGW("Failed to set event's payload field: event-addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64 ", " - "payload-field-name=\"%s\", payload-field-addr=%p", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), - name, payload); - } else { - BT_LOGV("Set event's payload field: event-addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64 ", " - "payload-field-name=\"%s\", payload-field-addr=%p", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), - name, payload); + BT_ASSERT_PRE_MSG("Invalid event's payload field: " + "%![event-]+_e, %![field-]+_f", + event, event->payload_field); + goto end; } end: return ret; } -struct bt_ctf_field *bt_ctf_event_get_event_payload(struct bt_ctf_event *event) +BT_HIDDEN +void _bt_event_common_freeze(struct bt_event_common *event) { - struct bt_ctf_field *payload = NULL; - - if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - goto end; - } + BT_ASSERT(event); - if (!event->fields_payload) { - BT_LOGV("Event has no current payload field: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - goto end; + if (event->frozen) { + return; } - payload = event->fields_payload; - bt_get(payload); -end: - return payload; + 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)); + BT_LOGD_STR("Freezing event's header field."); + bt_field_common_freeze_recursive(event->header_field); + BT_LOGD_STR("Freezing event's stream event context field."); + bt_field_common_freeze_recursive(event->stream_event_context_field); + BT_LOGD_STR("Freezing event's context field."); + bt_field_common_freeze_recursive(event->context_field); + BT_LOGD_STR("Freezing event's payload field."); + bt_field_common_freeze_recursive(event->payload_field); + event->frozen = 1; } -int bt_ctf_event_set_event_payload(struct bt_ctf_event *event, - struct bt_ctf_field *payload) +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, + bt_object_release_func release_func, + 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), + void *(*create_field_func)(void *)) { - return bt_ctf_event_set_payload(event, NULL, payload); -} + int ret; + struct bt_trace_common *trace = NULL; + struct bt_stream_class_common *stream_class = NULL; + struct bt_field_common *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_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_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event, - const char *name) -{ - struct bt_ctf_field *field = NULL; + BT_ASSERT_PRE_NON_NULL(event_class, "Event class"); + BT_LOGD("Initializing common 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)); - if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - goto end; - } + stream_class = bt_event_class_common_borrow_stream_class(event_class); + BT_ASSERT_PRE(stream_class, + "Event class is not part of a stream class: %!+_E", event_class); - if (name) { - field = bt_ctf_field_structure_get_field(event->fields_payload, - name); - } else { - field = event->fields_payload; - bt_get(field); + /* 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); } -end: - return field; -} -struct bt_ctf_field *bt_ctf_event_get_payload_by_index( - struct bt_ctf_event *event, uint64_t index) -{ - struct bt_ctf_field *field = NULL; + /* + * This must be called before anything that can fail because on + * failure, the caller releases the reference to `event` to + * destroy it. + */ + bt_object_init(event, release_func); - if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - goto end; + if (!stream_class->frozen) { + /* + * Because this function freezes the stream class, + * validate that this stream class contains at most a + * single clock class so that we set its expected clock + * class for future checks. + */ + ret = bt_stream_class_common_validate_single_clock_class( + stream_class, &expected_clock_class); + if (ret) { + BT_LOGW("Event class's stream class or one of its event " + "classes contains a field type which is not " + "recursively mapped to the expected " + "clock class: " + "stream-class-addr=%p, " + "stream-class-id=%" PRId64 ", " + "stream-class-name=\"%s\", " + "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), + expected_clock_class, + expected_clock_class ? + bt_clock_class_get_name(expected_clock_class) : + NULL); + goto error; + } } - field = bt_ctf_field_structure_get_field_by_index(event->fields_payload, - index); -end: - return field; -} - -struct bt_ctf_field *bt_ctf_event_get_header( - struct bt_ctf_event *event) -{ - struct bt_ctf_field *header = NULL; + /* Validate the trace, the stream class, and the event class */ + ret = bt_event_common_validate_types_for_create( + event_class, &validation_output, field_type_copy_func); + if (ret) { + /* bt_event_common_validate_types_for_create() logs errors */ + goto error; + } - if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - goto end; + 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; + } } - if (!event->event_header) { - BT_LOGV("Event has no current header field: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - goto end; + /* + * 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. + */ + event->class = bt_get(event_class); + + ret = bt_event_common_create_fields(&validation_output, + create_field_func, &event_header, + &stream_event_context, &event_context, &event_payload); + if (ret) { + /* bt_event_common_create_fields() logs errors */ + goto error; } - header = event->event_header; - bt_get(header); -end: - return header; -} + /* + * At this point all the fields are created, potentially from + * validated copies of field types, so that the field types and + * fields can be replaced in the trace, stream class, + * event class, and created event. + */ + bt_validation_replace_types(trace, stream_class, event_class, + &validation_output, + BT_VALIDATION_FLAG_STREAM | BT_VALIDATION_FLAG_EVENT); + BT_MOVE(event->header_field, event_header); + BT_MOVE(event->stream_event_context_field, stream_event_context); + BT_MOVE(event->context_field, event_context); + BT_MOVE(event->payload_field, event_payload); -int bt_ctf_event_set_header(struct bt_ctf_event *event, - struct bt_ctf_field *header) -{ - int ret = 0; - struct bt_ctf_field_type *field_type = NULL; - struct bt_ctf_stream_class *stream_class = NULL; + /* + * Put what was not moved in bt_validation_replace_types(). + */ + bt_validation_output_put_types(&validation_output); - if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - ret = -1; - goto end; - } + /* + * Freeze the stream class since the event header must not be changed + * anymore. + */ + bt_stream_class_common_freeze(stream_class); - if (event->frozen) { - BT_LOGW("Invalid parameter: event is frozen: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = -1; - goto end; + /* + * It is safe to set the stream class's unique clock class + * now because the stream class is frozen. + */ + if (expected_clock_class) { + BT_MOVE(stream_class->clock_class, expected_clock_class); } - stream_class = (struct bt_ctf_stream_class *) bt_object_get_parent( - event->event_class); /* - * Ensure the provided header's type matches the one registered to the - * stream class. + * Mark stream class, and event class as valid since + * they're all frozen now. */ - field_type = bt_ctf_field_get_type(header); - if (bt_ctf_field_type_compare(field_type, - stream_class->event_header_type)) { - BT_LOGW("Invalid parameter: header field type is different from the expected field type: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, - bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = -1; - goto end; - } + stream_class->valid = 1; + event_class->valid = 1; + + /* 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)); + goto end; + +error: + bt_validation_output_put_types(&validation_output); + bt_put(expected_clock_class); + bt_put(event_header); + bt_put(stream_event_context); + bt_put(event_context); + bt_put(event_payload); + ret = -1; - bt_put(event->event_header); - event->event_header = bt_get(header); - BT_LOGV("Set event's header field: event-addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64 ", " - "header-field-addr=%p", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), header); end: - bt_put(stream_class); - bt_put(field_type); return ret; } -struct bt_ctf_field *bt_ctf_event_get_event_context( - struct bt_ctf_event *event) +struct bt_event *bt_event_create(struct bt_event_class *event_class) { - struct bt_ctf_field *context = NULL; + int ret; + struct bt_event *event = NULL; + event = g_new0(struct bt_event, 1); if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - goto end; + BT_LOGE_STR("Failed to allocate one event."); + goto error; } - if (!event->context_payload) { - BT_LOGV("Event has no current context field: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - goto end; + ret = bt_event_common_initialize(BT_TO_COMMON(event), + BT_TO_COMMON(event_class), NULL, bt_event_destroy, + (bt_validation_flag_copy_field_type_func) bt_field_type_copy, + true, NULL, (void *) bt_field_create); + if (ret) { + /* bt_event_common_initialize() logs errors */ + goto error; } - context = event->context_payload; - bt_get(context); + event->clock_values = g_hash_table_new_full(g_direct_hash, + g_direct_equal, bt_put, bt_put); + assert(event->clock_values); + goto end; + +error: + BT_PUT(event); + end: - return context; + return event; } -int bt_ctf_event_set_event_context(struct bt_ctf_event *event, - struct bt_ctf_field *context) +struct bt_event_class *bt_event_get_class(struct bt_event *event) { - int ret = 0; - struct bt_ctf_field_type *field_type = NULL; - - if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - ret = -1; - goto end; - } - - if (event->frozen) { - BT_LOGW("Invalid parameter: event is frozen: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = -1; - goto end; - } - - field_type = bt_ctf_field_get_type(context); - if (bt_ctf_field_type_compare(field_type, - event->event_class->context)) { - BT_LOGW("Invalid parameter: context field type is different from the expected field type: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, - bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = -1; - goto end; - } - - bt_put(event->context_payload); - event->context_payload = bt_get(context); - BT_LOGV("Set event's context field: event-addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64 ", " - "context-field-addr=%p", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), context); -end: - bt_put(field_type); - return ret; + BT_ASSERT_PRE_NON_NULL(event, "Event"); + return bt_get(bt_event_common_borrow_class(BT_TO_COMMON(event))); } -struct bt_ctf_field *bt_ctf_event_get_stream_event_context( - struct bt_ctf_event *event) +BT_HIDDEN +struct bt_stream *bt_event_borrow_stream(struct bt_event *event) { - struct bt_ctf_field *stream_event_context = NULL; + struct bt_stream *stream = NULL; - if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - goto end; - } + BT_ASSERT(event); - if (!event->stream_event_context) { - BT_LOGV("Event has no current stream event context field: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - goto end; + if (event->packet) { + stream = event->packet->stream; } - stream_event_context = event->stream_event_context; -end: - return bt_get(stream_event_context); + return stream; } -int bt_ctf_event_set_stream_event_context(struct bt_ctf_event *event, - struct bt_ctf_field *stream_event_context) +struct bt_stream *bt_event_get_stream(struct bt_event *event) { - int ret = 0; - struct bt_ctf_field_type *field_type = NULL; - struct bt_ctf_stream_class *stream_class = NULL; + BT_ASSERT_PRE_NON_NULL(event, "Event"); + return bt_get(bt_event_borrow_stream(event)); +} - if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - ret = -1; - goto end; - } +struct bt_field *bt_event_get_payload(struct bt_event *event) +{ + return BT_FROM_COMMON(bt_event_common_get_payload(BT_TO_COMMON(event))); +} - if (event->frozen) { - BT_LOGW("Invalid parameter: event is frozen: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = -1; - goto end; - } +int bt_event_set_payload(struct bt_event *event, struct bt_field *field) +{ + return bt_event_common_set_payload(BT_TO_COMMON(event), + (void *) field); +} - stream_class = bt_ctf_event_class_get_stream_class(event->event_class); - /* - * We should not have been able to create the event without associating - * the event class to a stream class. - */ - assert(stream_class); +struct bt_field *bt_event_get_header(struct bt_event *event) +{ + return BT_FROM_COMMON(bt_event_common_get_header(BT_TO_COMMON(event))); +} - field_type = bt_ctf_field_get_type(stream_event_context); - if (bt_ctf_field_type_compare(field_type, - stream_class->event_context_type)) { - BT_LOGW("Invalid parameter: stream event context field type is different from the expected field type: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, - bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = -1; - goto end; - } +int bt_event_set_header(struct bt_event *event, struct bt_field *field) +{ + return bt_event_common_set_header(BT_TO_COMMON(event), (void *) field); +} - bt_get(stream_event_context); - BT_MOVE(event->stream_event_context, stream_event_context); - BT_LOGV("Set event's stream event context field: event-addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64 ", " - "stream-event-context-field-addr=%p", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), - stream_event_context); -end: - BT_PUT(stream_class); - bt_put(field_type); - return ret; +struct bt_field *bt_event_get_context(struct bt_event *event) +{ + return BT_FROM_COMMON(bt_event_common_get_context(BT_TO_COMMON(event))); } -/* Pre-2.0 CTF writer backward compatibility */ -void bt_ctf_event_get(struct bt_ctf_event *event) +int bt_event_set_context(struct bt_event *event, struct bt_field *field) { - bt_get(event); + return bt_event_common_set_context(BT_TO_COMMON(event), (void *) field); } -/* Pre-2.0 CTF writer backward compatibility */ -void bt_ctf_event_put(struct bt_ctf_event *event) +struct bt_field *bt_event_get_stream_event_context( + struct bt_event *event) { - bt_put(event); + return BT_FROM_COMMON(bt_event_common_get_stream_event_context( + BT_TO_COMMON(event))); } -void bt_ctf_event_destroy(struct bt_object *obj) +int bt_event_set_stream_event_context(struct bt_event *event, + struct bt_field *field) { - struct bt_ctf_event *event; + return bt_event_common_set_stream_event_context( + BT_TO_COMMON(event), (void *) field); +} - event = container_of(obj, struct bt_ctf_event, base); - BT_LOGD("Destroying event: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); +void bt_event_destroy(struct bt_object *obj) +{ + struct bt_event *event = (void *) obj; - 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->event_class); - } + bt_event_common_finalize(obj); g_hash_table_destroy(event->clock_values); - bt_put(event->event_header); - bt_put(event->stream_event_context); - bt_put(event->context_payload); - bt_put(event->fields_payload); + BT_LOGD_STR("Putting event's packet."); bt_put(event->packet); g_free(event); } -struct bt_ctf_clock_value *bt_ctf_event_get_clock_value( - struct bt_ctf_event *event, struct bt_ctf_clock_class *clock_class) +struct bt_clock_value *bt_event_get_clock_value( + struct bt_event *event, struct bt_clock_class *clock_class) { - struct bt_ctf_clock_value *clock_value = NULL; - - if (!event || !clock_class) { - BT_LOGW("Invalid parameter: event or clock class is NULL: " - "event-addr=%p, clock-class-addr=%p", - event, clock_class); - goto end; - } + struct bt_clock_value *clock_value = NULL; + BT_ASSERT_PRE_NON_NULL(event, "Event"); + BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); clock_value = g_hash_table_lookup(event->clock_values, clock_class); if (!clock_value) { BT_LOGV("No clock value associated to the given clock class: " "event-addr=%p, event-class-name=\"%s\", " "event-class-id=%" PRId64 ", clock-class-addr=%p, " "clock-class-name=\"%s\"", event, - bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), - clock_class, bt_ctf_clock_class_get_name(clock_class)); + bt_event_class_common_get_name(event->common.class), + bt_event_class_common_get_id(event->common.class), + clock_class, bt_clock_class_get_name(clock_class)); goto end; } bt_get(clock_value); + end: return clock_value; } -int bt_ctf_event_set_clock_value(struct bt_ctf_event *event, - struct bt_ctf_clock_value *value) +int bt_event_set_clock_value(struct bt_event *event, + struct bt_clock_value *value) { - int ret = 0; - struct bt_ctf_trace *trace; - struct bt_ctf_stream_class *stream_class; - struct bt_ctf_event_class *event_class; - struct bt_ctf_clock_class *clock_class = NULL; - - if (!event || !value) { - BT_LOGW("Invalid parameter: event or clock value is NULL: " - "event-addr=%p, clock-value-addr=%p", - event, value); - ret = -1; - goto end; - } - - if (event->frozen) { - BT_LOGW("Invalid parameter: event is frozen: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = -1; - goto end; - } - - clock_class = bt_ctf_clock_value_get_class(value); - event_class = bt_ctf_event_borrow_event_class(event); - assert(event_class); - stream_class = bt_ctf_event_class_borrow_stream_class(event_class); - assert(stream_class); - trace = bt_ctf_stream_class_borrow_trace(stream_class); - assert(trace); - - if (!bt_ctf_trace_has_clock_class(trace, clock_class)) { - BT_LOGW("Invalid parameter: clock class is not part of event's trace: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64 ", clock-class-addr=%p, " - "clock-class-name=\"%s\"", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), - clock_class, bt_ctf_clock_class_get_name(clock_class)); - ret = -1; - goto end; - } - + struct bt_trace *trace; + struct bt_stream_class *stream_class; + struct bt_event_class *event_class; + struct bt_clock_class *clock_class = NULL; + + BT_ASSERT_PRE_NON_NULL(event, "Event"); + BT_ASSERT_PRE_NON_NULL(value, "Clock value"); + BT_ASSERT_PRE_EVENT_COMMON_HOT(BT_TO_COMMON(event), "Event"); + clock_class = bt_clock_value_get_class(value); + event_class = BT_FROM_COMMON(event->common.class); + BT_ASSERT(event_class); + stream_class = bt_event_class_borrow_stream_class(event_class); + BT_ASSERT(stream_class); + trace = bt_stream_class_borrow_trace(stream_class); + BT_ASSERT(trace); + BT_ASSERT_PRE(bt_trace_common_has_clock_class(BT_TO_COMMON(trace), + clock_class), + "Clock class is not part of event's trace: " + "%![event-]+e, %![clock-class-]+K", + event, clock_class); g_hash_table_insert(event->clock_values, clock_class, bt_get(value)); BT_LOGV("Set event's clock value: " "event-addr=%p, event-class-name=\"%s\", " "event-class-id=%" PRId64 ", clock-class-addr=%p, " "clock-class-name=\"%s\", clock-value-addr=%p, " "clock-value-cycles=%" PRIu64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), - clock_class, bt_ctf_clock_class_get_name(clock_class), + event, bt_event_class_common_get_name(event->common.class), + bt_event_class_common_get_id(event->common.class), + clock_class, bt_clock_class_get_name(clock_class), value, value->value); clock_class = NULL; - -end: bt_put(clock_class); - return ret; -} - -BT_HIDDEN -int bt_ctf_event_validate(struct bt_ctf_event *event) -{ - /* Make sure each field's payload has been set */ - int ret; - struct bt_ctf_stream_class *stream_class = NULL; - - assert(event); - ret = bt_ctf_field_validate(event->event_header); - if (ret) { - BT_LOGD("Invalid event's header field: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - goto end; - } - - stream_class = bt_ctf_event_class_get_stream_class(event->event_class); - /* - * We should not have been able to create the event without associating - * the event class to a stream class. - */ - assert(stream_class); - if (stream_class->event_context_type) { - ret = bt_ctf_field_validate(event->stream_event_context); - if (ret) { - BT_LOGD("Invalid event's stream event context field: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, - bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - goto end; - } - } - - ret = bt_ctf_field_validate(event->fields_payload); - if (ret) { - BT_LOGD("Invalid event's payload field: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, - bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - goto end; - } - - if (event->event_class->context) { - BT_LOGD("Invalid event's context field: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, - bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = bt_ctf_field_validate(event->context_payload); - } -end: - bt_put(stream_class); - return ret; -} - -BT_HIDDEN -int bt_ctf_event_serialize(struct bt_ctf_event *event, - struct bt_ctf_stream_pos *pos, - enum bt_ctf_byte_order native_byte_order) -{ - int ret = 0; - - assert(event); - assert(pos); - - BT_LOGD("Serializing event: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64 ", pos-addr=%p, " - "native-bo=%s", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), - pos, bt_ctf_field_type_byte_order_string(native_byte_order)); - - if (event->context_payload) { - ret = bt_ctf_field_serialize(event->context_payload, pos, - native_byte_order); - if (ret) { - BT_LOGE("Cannot serialize event's context field: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, - bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - goto end; - } - } - - if (event->fields_payload) { - ret = bt_ctf_field_serialize(event->fields_payload, pos, - native_byte_order); - if (ret) { - BT_LOGE("Cannot serialize event's payload field: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64, - event, - bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - goto end; - } - } -end: - return ret; + return 0; } -struct bt_ctf_packet *bt_ctf_event_get_packet(struct bt_ctf_event *event) +struct bt_packet *bt_event_get_packet(struct bt_event *event) { - struct bt_ctf_packet *packet = NULL; - - if (!event) { - BT_LOGW_STR("Invalid parameter: event is NULL."); - goto end; - } + struct bt_packet *packet = NULL; + BT_ASSERT_PRE_NON_NULL(event, "Event"); if (!event->packet) { BT_LOGV("Event has no current packet: addr=%p, " "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); + event, bt_event_class_common_get_name(event->common.class), + bt_event_class_common_get_id(event->common.class)); goto end; } packet = bt_get(event->packet); + end: return packet; } -int bt_ctf_event_set_packet(struct bt_ctf_event *event, - struct bt_ctf_packet *packet) +int bt_event_set_packet(struct bt_event *event, + struct bt_packet *packet) { - struct bt_ctf_stream_class *event_stream_class = NULL; - struct bt_ctf_stream_class *packet_stream_class = NULL; - struct bt_ctf_stream *stream = NULL; - int ret = 0; - - if (!event || !packet) { - BT_LOGW("Invalid parameter: event or packet is NULL: " - "event-addr=%p, packet-addr=%p", - event, packet); - ret = -1; - goto end; - } - - if (event->frozen) { - BT_LOGW("Invalid parameter: event is frozen: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - ret = -1; - goto end; - } + BT_ASSERT_PRE_NON_NULL(event, "Event"); + BT_ASSERT_PRE_NON_NULL(packet, "Packet"); + BT_ASSERT_PRE_EVENT_COMMON_HOT(BT_TO_COMMON(event), "Event"); /* * Make sure the new packet was created by this event's * stream, if it is set. */ - stream = bt_ctf_event_get_stream(event); - if (stream) { - if (packet->stream != stream) { - BT_LOGW("Invalid parameter: packet's stream and event's stream differ: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64 ", packet-stream-addr=%p, " - "event-stream-addr=%p", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), - packet->stream, stream); - ret = -1; - goto end; - } + if (bt_event_borrow_stream(event)) { + BT_ASSERT_PRE(packet->stream == bt_event_borrow_stream(event), + "Packet's stream and event's stream differ: " + "%![event-]+e, %![packet-]+a", + event, packet); } else { - event_stream_class = - bt_ctf_event_class_get_stream_class(event->event_class); - packet_stream_class = - bt_ctf_stream_get_class(packet->stream); - - assert(event_stream_class); - assert(packet_stream_class); - - if (event_stream_class != packet_stream_class) { - BT_LOGW("Invalid parameter: packet's stream class and event's stream class differ: " - "event-addr=%p, event-class-name=\"%s\", " - "event-class-id=%" PRId64 ", packet-stream-class-addr=%p, " - "event-stream-class-addr=%p", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), - packet_stream_class, event_stream_class); - ret = -1; - goto end; - } + BT_ASSERT_PRE(bt_event_class_borrow_stream_class( + BT_FROM_COMMON(event->common.class)) == + BT_FROM_COMMON(packet->stream->common.stream_class), + "Packet's stream class and event's stream class differ: " + "%![event-]+e, %![packet-]+a", + event, packet); } bt_get(packet); @@ -1017,34 +699,15 @@ int bt_ctf_event_set_packet(struct bt_ctf_event *event, BT_LOGV("Set event's packet: event-addr=%p, " "event-class-name=\"%s\", event-class-id=%" PRId64 ", " "packet-addr=%p", - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class), packet); - -end: - BT_PUT(stream); - BT_PUT(event_stream_class); - BT_PUT(packet_stream_class); - - return ret; + event, bt_event_class_common_get_name(event->common.class), + bt_event_class_common_get_id(event->common.class), packet); + return 0; } BT_HIDDEN -void bt_ctf_event_freeze(struct bt_ctf_event *event) +void _bt_event_freeze(struct bt_event *event) { - assert(event); - - if (event->frozen) { - return; - } - - BT_LOGD("Freezing event: addr=%p, " - "event-class-name=\"%s\", event-class-id=%" PRId64, - event, bt_ctf_event_class_get_name(event->event_class), - bt_ctf_event_class_get_id(event->event_class)); - bt_ctf_packet_freeze(event->packet); - bt_ctf_field_freeze(event->event_header); - bt_ctf_field_freeze(event->stream_event_context); - bt_ctf_field_freeze(event->context_payload); - bt_ctf_field_freeze(event->fields_payload); - event->frozen = 1; + _bt_event_common_freeze(BT_TO_COMMON(event)); + BT_LOGD_STR("Freezing event's packet."); + bt_packet_freeze(event->packet); }