*
* Babeltrace - CTF IR: Validation of trace, stream class, and event class
*
- * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
+ * Copyright 2016
-2018 Philippe Proulx <pproulx@efficios.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* SOFTWARE.
*/
+#define BT_LOG_TAG "VALIDATION"
+#include <babeltrace/lib-logging-internal.h>
+
+#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/ctf-ir/validation-internal.h>
#include <babeltrace/ctf-ir/resolve-internal.h>
#include <babeltrace/ctf-ir/trace-internal.h>
#include <babeltrace/ctf-ir/stream-class-internal.h>
#include <babeltrace/ctf-ir/field-types-internal.h>
#include <babeltrace/ctf-ir/event-class-internal.h>
+#include <babeltrace/ctf-ir/field-types-internal.h>
#include <babeltrace/values.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/ref.h>
-#define _printf_error(fmt, args...) \
- printf_verbose("[validation] " fmt, ## args)
-
/*
* This function resolves and validates the field types of an event
* class. Only `event_context_type` and `event_payload_type` are
*/
static
int validate_event_class_types(struct bt_value *environment,
- struct bt_ctf_field_type *packet_header_type,
- struct bt_ctf_field_type *packet_context_type,
- struct bt_ctf_field_type *event_header_type,
- struct bt_ctf_field_type *stream_event_ctx_type,
- struct bt_ctf_field_type *event_context_type,
- struct bt_ctf_field_type *event_payload_type)
+ struct bt_field_type *packet_header_type,
+ struct bt_field_type *packet_context_type,
+ struct bt_field_type *event_header_type,
+ struct bt_field_type *stream_event_ctx_type,
+ struct bt_field_type *event_context_type,
+ struct bt_field_type *event_payload_type)
{
int ret = 0;
+ BT_LOGV("Validating event class field types: "
+ "packet-header-ft-addr=%p, "
+ "packet-context-ft-addr=%p, "
+ "event-header-ft-addr=%p, "
+ "stream-event-context-ft-addr=%p, "
+ "event-context-ft-addr=%p, "
+ "event-payload-ft-addr=%p",
+ packet_header_type, packet_context_type, event_header_type,
+ stream_event_ctx_type, event_context_type, event_payload_type);
+
/* Resolve sequence type lengths and variant type tags first */
- ret = bt_ctf_resolve_types(environment, packet_header_type,
+ ret = bt_resolve_types(environment, packet_header_type,
packet_context_type, event_header_type, stream_event_ctx_type,
event_context_type, event_payload_type,
- BT_CTF_RESOLVE_FLAG_EVENT_CONTEXT |
- BT_CTF_RESOLVE_FLAG_EVENT_PAYLOAD);
+ BT_RESOLVE_FLAG_EVENT_CONTEXT |
+ BT_RESOLVE_FLAG_EVENT_PAYLOAD);
if (ret) {
- _printf_error("Cannot resolve event class types\n");
+ BT_LOGW("Cannot resolve event class field types: ret=%d",
+ ret);
goto end;
}
/* Validate field types individually */
if (event_context_type) {
- ret = bt_ctf_field_type_validate(event_context_type);
+ ret = bt_field_type_validate(event_context_type);
if (ret) {
- _printf_error("Invalid event context type\n");
+ BT_LOGW("Invalid event class's context field type: "
+ "ret=%d", ret);
goto end;
}
}
if (event_payload_type) {
- ret = bt_ctf_field_type_validate(event_payload_type);
+ ret = bt_field_type_validate(event_payload_type);
if (ret) {
- _printf_error("Invalid event payload type\n");
+ BT_LOGW("Invalid event class's payload field type: "
+ "ret=%d", ret);
goto end;
}
}
*/
static
int validate_stream_class_types(struct bt_value *environment,
- struct bt_ctf_field_type *packet_header_type,
- struct bt_ctf_field_type *packet_context_type,
- struct bt_ctf_field_type *event_header_type,
- struct bt_ctf_field_type *stream_event_ctx_type)
+ struct bt_field_type *packet_header_type,
+ struct bt_field_type *packet_context_type,
+ struct bt_field_type *event_header_type,
+ struct bt_field_type *stream_event_ctx_type)
{
int ret = 0;
+ BT_LOGV("Validating stream class field types: "
+ "packet-header-ft-addr=%p, "
+ "packet-context-ft-addr=%p, "
+ "event-header-ft-addr=%p, "
+ "stream-event-context-ft-addr=%p",
+ packet_header_type, packet_context_type, event_header_type,
+ stream_event_ctx_type);
+
/* Resolve sequence type lengths and variant type tags first */
- ret = bt_ctf_resolve_types(environment, packet_header_type,
+ ret = bt_resolve_types(environment, packet_header_type,
packet_context_type, event_header_type, stream_event_ctx_type,
NULL, NULL,
- BT_CTF_RESOLVE_FLAG_PACKET_CONTEXT |
- BT_CTF_RESOLVE_FLAG_EVENT_HEADER |
- BT_CTF_RESOLVE_FLAG_STREAM_EVENT_CTX);
+ BT_RESOLVE_FLAG_PACKET_CONTEXT |
+ BT_RESOLVE_FLAG_EVENT_HEADER |
+ BT_RESOLVE_FLAG_STREAM_EVENT_CTX);
if (ret) {
- _printf_error("Cannot resolve stream class types\n");
+ BT_LOGW("Cannot resolve stream class field types: ret=%d",
+ ret);
goto end;
}
/* Validate field types individually */
if (packet_context_type) {
- ret = bt_ctf_field_type_validate(packet_context_type);
+ ret = bt_field_type_validate(packet_context_type);
if (ret) {
- _printf_error("Invalid stream packet context type\n");
+ BT_LOGW("Invalid stream class's packet context field type: "
+ "ret=%d", ret);
goto end;
}
}
if (event_header_type) {
- ret = bt_ctf_field_type_validate(event_header_type);
+ ret = bt_field_type_validate(event_header_type);
if (ret) {
- _printf_error("Invalid stream event header type\n");
+ BT_LOGW("Invalid stream class's event header field type: "
+ "ret=%d", ret);
goto end;
}
}
if (stream_event_ctx_type) {
- ret = bt_ctf_field_type_validate(
+ ret = bt_field_type_validate(
stream_event_ctx_type);
if (ret) {
- _printf_error("Invalid stream event context type\n");
+ BT_LOGW("Invalid stream class's event context field type: "
+ "ret=%d", ret);
goto end;
}
}
*/
static
int validate_trace_types(struct bt_value *environment,
- struct bt_ctf_field_type *packet_header_type)
+ struct bt_field_type *packet_header_type)
{
int ret = 0;
+ BT_LOGV("Validating event class field types: "
+ "packet-header-ft-addr=%p", packet_header_type);
+
/* Resolve sequence type lengths and variant type tags first */
- ret = bt_ctf_resolve_types(environment, packet_header_type,
+ ret = bt_resolve_types(environment, packet_header_type,
NULL, NULL, NULL, NULL, NULL,
- BT_CTF_RESOLVE_FLAG_PACKET_HEADER);
+ BT_RESOLVE_FLAG_PACKET_HEADER);
if (ret) {
- _printf_error("Cannot resolve trace types\n");
+ BT_LOGW("Cannot resolve trace field types: ret=%d",
+ ret);
goto end;
}
/* Validate field types individually */
if (packet_header_type) {
- ret = bt_ctf_field_type_validate(packet_header_type);
+ ret = bt_field_type_validate(packet_header_type);
if (ret) {
- _printf_error("Invalid trace packet header type\n");
+ BT_LOGW("Invalid trace's packet header field type: "
+ "ret=%d", ret);
goto end;
}
}
* `field_type` is owned by the caller.
*/
static
-int field_type_contains_sequence_or_variant_ft(struct bt_ctf_field_type *type)
+int field_type_contains_sequence_or_variant_ft(struct bt_field_type *type)
{
int ret = 0;
- enum bt_ctf_type_id type_id = bt_ctf_field_type_get_type_id(type);
+ enum bt_field_type_id type_id = bt_field_type_get_type_id(type);
switch (type_id) {
- case BT_CTF_TYPE_ID_SEQUENCE:
- case BT_CTF_TYPE_ID_VARIANT:
+ case BT_FIELD_TYPE_ID_SEQUENCE:
+ case BT_FIELD_TYPE_ID_VARIANT:
ret = 1;
goto end;
- case BT_CTF_TYPE_ID_ARRAY:
- case BT_CTF_TYPE_ID_STRUCT:
+ case BT_FIELD_TYPE_ID_ARRAY:
+ case BT_FIELD_TYPE_ID_STRUCT:
{
int i;
- int field_count = bt_ctf_field_type_get_field_count(type);
+ int field_count = bt_field_type_get_field_count(type);
if (field_count < 0) {
ret = -1;
}
for (i = 0; i < field_count; ++i) {
- struct bt_ctf_field_type *child_type =
- bt_ctf_field_type_get_field_at_index(type, i);
+ struct bt_field_type *child_type =
+ bt_field_type_borrow_field_at_index(
+ type, i);
ret = field_type_contains_sequence_or_variant_ft(
child_type);
- BT_PUT(child_type);
if (ret != 0) {
goto end;
}
}
BT_HIDDEN
-int bt_ctf_validate_class_types(struct bt_value *environment,
- struct bt_ctf_field_type *packet_header_type,
- struct bt_ctf_field_type *packet_context_type,
- struct bt_ctf_field_type *event_header_type,
- struct bt_ctf_field_type *stream_event_ctx_type,
- struct bt_ctf_field_type *event_context_type,
- struct bt_ctf_field_type *event_payload_type,
+int bt_validate_class_types(struct bt_value *environment,
+ struct bt_field_type *packet_header_type,
+ struct bt_field_type *packet_context_type,
+ struct bt_field_type *event_header_type,
+ struct bt_field_type *stream_event_ctx_type,
+ struct bt_field_type *event_context_type,
+ struct bt_field_type *event_payload_type,
int trace_valid, int stream_class_valid, int event_class_valid,
- struct bt_ctf_validation_output *output,
- enum bt_ctf_validation_flag validate_flags)
+ struct bt_validation_output *output,
+ enum bt_validation_flag validate_flags,
+ bt_validation_flag_copy_field_type_func copy_field_type_func)
{
int ret = 0;
int contains_seq_var;
int valid_ret;
+ BT_LOGV("Validating field types: "
+ "packet-header-ft-addr=%p, "
+ "packet-context-ft-addr=%p, "
+ "event-header-ft-addr=%p, "
+ "stream-event-context-ft-addr=%p, "
+ "event-context-ft-addr=%p, "
+ "event-payload-ft-addr=%p, "
+ "trace-is-valid=%d, stream-class-is-valid=%d, "
+ "event-class-is-valid=%d, validation-flags=%x",
+ 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,
+ (unsigned int) validate_flags);
+
/* Clean output values */
memset(output, 0, sizeof(*output));
/* Set initial valid flags according to valid parameters */
if (trace_valid) {
- output->valid_flags |= BT_CTF_VALIDATION_FLAG_TRACE;
+ output->valid_flags |= BT_VALIDATION_FLAG_TRACE;
}
if (stream_class_valid) {
- output->valid_flags |= BT_CTF_VALIDATION_FLAG_STREAM;
+ output->valid_flags |= BT_VALIDATION_FLAG_STREAM;
}
if (event_class_valid) {
- output->valid_flags |= BT_CTF_VALIDATION_FLAG_EVENT;
+ output->valid_flags |= BT_VALIDATION_FLAG_EVENT;
}
/* Own the type parameters */
bt_get(event_payload_type);
/* Validate trace */
- if ((validate_flags & BT_CTF_VALIDATION_FLAG_TRACE) && !trace_valid) {
- struct bt_ctf_field_type *packet_header_type_copy = NULL;
+ if ((validate_flags & BT_VALIDATION_FLAG_TRACE) && !trace_valid) {
+ struct bt_field_type *packet_header_type_copy = NULL;
/* Create field type copies */
if (packet_header_type) {
goto skip_packet_header_type_copy;
}
+ BT_LOGV_STR("Copying packet header field type because it contains at least one sequence or variant field type.");
packet_header_type_copy =
- bt_ctf_field_type_copy(packet_header_type);
+ copy_field_type_func(packet_header_type);
if (!packet_header_type_copy) {
ret = -1;
- _printf_error("Cannot copy packet header type\n");
+ BT_LOGE_STR("Cannot copy packet header field type.");
goto error;
}
* caller, it cannot be modified any way since
* it will be resolved.
*/
- bt_ctf_field_type_freeze(packet_header_type_copy);
+ bt_field_type_freeze(packet_header_type_copy);
}
skip_packet_header_type_copy:
/* Validate trace field types */
valid_ret = validate_trace_types(environment,
packet_header_type);
- if (!valid_ret) {
+ if (valid_ret == 0) {
/* Trace is valid */
- output->valid_flags |= BT_CTF_VALIDATION_FLAG_TRACE;
+ output->valid_flags |= BT_VALIDATION_FLAG_TRACE;
}
}
/* Validate stream class */
- if ((validate_flags & BT_CTF_VALIDATION_FLAG_STREAM) &&
+ if ((validate_flags & BT_VALIDATION_FLAG_STREAM) &&
!stream_class_valid) {
- struct bt_ctf_field_type *packet_context_type_copy = NULL;
- struct bt_ctf_field_type *event_header_type_copy = NULL;
- struct bt_ctf_field_type *stream_event_ctx_type_copy = NULL;
+ struct bt_field_type *packet_context_type_copy = NULL;
+ struct bt_field_type *event_header_type_copy = NULL;
+ struct bt_field_type *stream_event_ctx_type_copy = NULL;
if (packet_context_type) {
contains_seq_var =
goto skip_packet_context_type_copy;
}
+ BT_LOGV_STR("Copying packet context field type because it contains at least one sequence or variant field type.");
packet_context_type_copy =
- bt_ctf_field_type_copy(packet_context_type);
+ copy_field_type_func(packet_context_type);
if (!packet_context_type_copy) {
- _printf_error("Cannot copy packet context type\n");
+ BT_LOGE_STR("Cannot copy packet context field type.");
goto sc_validation_error;
}
* caller, it cannot be modified any way since
* it will be resolved.
*/
- bt_ctf_field_type_freeze(packet_context_type_copy);
+ bt_field_type_freeze(packet_context_type_copy);
}
skip_packet_context_type_copy:
goto skip_event_header_type_copy;
}
+ BT_LOGV_STR("Copying event header field type because it contains at least one sequence or variant field type.");
event_header_type_copy =
- bt_ctf_field_type_copy(event_header_type);
+ copy_field_type_func(event_header_type);
if (!event_header_type_copy) {
- _printf_error("Cannot copy event header type\n");
+ BT_LOGE_STR("Cannot copy event header field type.");
goto sc_validation_error;
}
* caller, it cannot be modified any way since
* it will be resolved.
*/
- bt_ctf_field_type_freeze(event_header_type_copy);
+ bt_field_type_freeze(event_header_type_copy);
}
skip_event_header_type_copy:
goto skip_stream_event_ctx_type_copy;
}
+ BT_LOGV_STR("Copying stream event context field type because it contains at least one sequence or variant field type.");
stream_event_ctx_type_copy =
- bt_ctf_field_type_copy(stream_event_ctx_type);
+ copy_field_type_func(stream_event_ctx_type);
if (!stream_event_ctx_type_copy) {
- _printf_error("Cannot copy stream event context type\n");
+ BT_LOGE_STR("Cannot copy stream event context field type.");
goto sc_validation_error;
}
* caller, it cannot be modified any way since
* it will be resolved.
*/
- bt_ctf_field_type_freeze(stream_event_ctx_type_copy);
+ bt_field_type_freeze(stream_event_ctx_type_copy);
}
skip_stream_event_ctx_type_copy:
valid_ret = validate_stream_class_types(environment,
packet_header_type, packet_context_type,
event_header_type, stream_event_ctx_type);
- if (!valid_ret) {
+ if (valid_ret == 0) {
/* Stream class is valid */
- output->valid_flags |= BT_CTF_VALIDATION_FLAG_STREAM;
+ output->valid_flags |= BT_VALIDATION_FLAG_STREAM;
}
goto sc_validation_done;
sc_validation_done:
/* Validate event class */
- if ((validate_flags & BT_CTF_VALIDATION_FLAG_EVENT) &&
+ if ((validate_flags & BT_VALIDATION_FLAG_EVENT) &&
!event_class_valid) {
- struct bt_ctf_field_type *event_context_type_copy = NULL;
- struct bt_ctf_field_type *event_payload_type_copy = NULL;
+ struct bt_field_type *event_context_type_copy = NULL;
+ struct bt_field_type *event_payload_type_copy = NULL;
if (event_context_type) {
contains_seq_var =
goto skip_event_context_type_copy;
}
+ BT_LOGV_STR("Copying event context field type because it contains at least one sequence or variant field type.");
event_context_type_copy =
- bt_ctf_field_type_copy(event_context_type);
+ copy_field_type_func(event_context_type);
if (!event_context_type_copy) {
- _printf_error("Cannot copy event context type\n");
+ BT_LOGE_STR("Cannot copy event context field type.");
goto ec_validation_error;
}
* caller, it cannot be modified any way since
* it will be resolved.
*/
- bt_ctf_field_type_freeze(event_context_type_copy);
+ bt_field_type_freeze(event_context_type_copy);
}
skip_event_context_type_copy:
goto skip_event_payload_type_copy;
}
+ BT_LOGV_STR("Copying event payload field type because it contains at least one sequence or variant field type.");
event_payload_type_copy =
- bt_ctf_field_type_copy(event_payload_type);
+ copy_field_type_func(event_payload_type);
if (!event_payload_type_copy) {
- _printf_error("Cannot copy event payload type\n");
+ BT_LOGE_STR("Cannot copy event payload field type.");
goto ec_validation_error;
}
* caller, it cannot be modified any way since
* it will be resolved.
*/
- bt_ctf_field_type_freeze(event_payload_type_copy);
+ bt_field_type_freeze(event_payload_type_copy);
}
skip_event_payload_type_copy:
packet_header_type, packet_context_type,
event_header_type, stream_event_ctx_type,
event_context_type, event_payload_type);
- if (!valid_ret) {
+ if (valid_ret == 0) {
/* Event class is valid */
- output->valid_flags |= BT_CTF_VALIDATION_FLAG_EVENT;
+ output->valid_flags |= BT_VALIDATION_FLAG_EVENT;
}
goto ec_validation_done;
BT_MOVE(output->stream_event_ctx_type, stream_event_ctx_type);
BT_MOVE(output->event_context_type, event_context_type);
BT_MOVE(output->event_payload_type, event_payload_type);
-
return ret;
error:
BT_PUT(stream_event_ctx_type);
BT_PUT(event_context_type);
BT_PUT(event_payload_type);
-
return ret;
}
BT_HIDDEN
-void bt_ctf_validation_replace_types(struct bt_ctf_trace *trace,
- struct bt_ctf_stream_class *stream_class,
- struct bt_ctf_event_class *event_class,
- struct bt_ctf_validation_output *output,
- enum bt_ctf_validation_flag replace_flags)
+void bt_validation_replace_types(struct bt_trace *trace,
+ struct bt_stream_class *stream_class,
+ struct bt_event_class *event_class,
+ struct bt_validation_output *output,
+ enum bt_validation_flag replace_flags)
{
- if ((replace_flags & BT_CTF_VALIDATION_FLAG_TRACE) && trace) {
- bt_ctf_field_type_freeze(trace->packet_header_type);
- BT_MOVE(trace->packet_header_type, output->packet_header_type);
+ if ((replace_flags & BT_VALIDATION_FLAG_TRACE) && trace) {
+ bt_field_type_freeze(trace->packet_header_field_type);
+ BT_MOVE(trace->packet_header_field_type,
+ output->packet_header_type);
}
- if ((replace_flags & BT_CTF_VALIDATION_FLAG_STREAM) && stream_class) {
- bt_ctf_field_type_freeze(stream_class->packet_context_type);
- bt_ctf_field_type_freeze(stream_class->event_header_type);
- bt_ctf_field_type_freeze(stream_class->event_context_type);
- BT_MOVE(stream_class->packet_context_type,
+ if ((replace_flags & BT_VALIDATION_FLAG_STREAM) && stream_class) {
+ bt_field_type_freeze(stream_class->packet_context_field_type);
+ bt_field_type_freeze(stream_class->event_header_field_type);
+ bt_field_type_freeze(stream_class->event_context_field_type);
+ BT_MOVE(stream_class->packet_context_field_type,
output->packet_context_type);
- BT_MOVE(stream_class->event_header_type,
+ BT_MOVE(stream_class->event_header_field_type,
output->event_header_type);
- BT_MOVE(stream_class->event_context_type,
+ BT_MOVE(stream_class->event_context_field_type,
output->stream_event_ctx_type);
}
- if ((replace_flags & BT_CTF_VALIDATION_FLAG_EVENT) && event_class) {
- bt_ctf_field_type_freeze(event_class->context);
- bt_ctf_field_type_freeze(event_class->fields);
- BT_MOVE(event_class->context, output->event_context_type);
- BT_MOVE(event_class->fields, output->event_payload_type);
+ if ((replace_flags & BT_VALIDATION_FLAG_EVENT) && event_class) {
+ bt_field_type_freeze(event_class->context_field_type);
+ bt_field_type_freeze(event_class->payload_field_type);
+ BT_MOVE(event_class->context_field_type, output->event_context_type);
+ BT_MOVE(event_class->payload_field_type, output->event_payload_type);
}
}
BT_HIDDEN
-void bt_ctf_validation_output_put_types(
- struct bt_ctf_validation_output *output)
+void bt_validation_output_put_types(
+ struct bt_validation_output *output)
{
BT_PUT(output->packet_header_type);
BT_PUT(output->packet_context_type);
projects / babeltrace.git / blobdiff