- /*
- * If there's a `magic` field, it must be a 32-bit unsigned
- * integer field type. Also it must be the first field of the
- * packet header field type.
- */
- field_type = bt_field_type_common_structure_borrow_field_type_by_name(
- packet_header_type, "magic");
- if (field_type) {
- const char *field_name;
-
- if (field_type->id != BT_FIELD_TYPE_ID_INTEGER) {
- BT_LOGW("Invalid packet header field type: `magic` field must be an integer field type: "
- "magic-ft-addr=%p, magic-ft-id=%s",
- field_type,
- bt_common_field_type_id_string(field_type->id));
- goto invalid;
- }
-
- if (bt_field_type_common_integer_is_signed(field_type)) {
- BT_LOGW("Invalid packet header field type: `magic` field must be an unsigned integer field type: "
- "magic-ft-addr=%p", field_type);
- goto invalid;
- }
-
- if (bt_field_type_common_integer_get_size(field_type) != 32) {
- BT_LOGW("Invalid packet header field type: `magic` field must be a 32-bit unsigned integer field type: "
- "magic-ft-addr=%p, magic-ft-size=%u",
- field_type,
- bt_field_type_common_integer_get_size(field_type));
- goto invalid;
- }
-
- ret = bt_field_type_common_structure_borrow_field_by_index(
- packet_header_type, &field_name, NULL, 0);
- BT_ASSERT(ret == 0);
-
- if (strcmp(field_name, "magic") != 0) {
- BT_LOGW("Invalid packet header field type: `magic` field must be the first field: "
- "magic-ft-addr=%p, first-field-name=\"%s\"",
- field_type, field_name);
- goto invalid;
- }
- }
-
- /*
- * If there's a `uuid` field, it must be an array field type of
- * length 16 with an 8-bit unsigned integer element field type.
- */
- field_type = bt_field_type_common_structure_borrow_field_type_by_name(
- packet_header_type, "uuid");
- if (field_type) {
- struct bt_field_type_common *elem_ft;
-
- if (field_type->id != BT_FIELD_TYPE_ID_ARRAY) {
- BT_LOGW("Invalid packet header field type: `uuid` field must be an array field type: "
- "uuid-ft-addr=%p, uuid-ft-id=%s",
- field_type,
- bt_common_field_type_id_string(field_type->id));
- goto invalid;
- }
-
- if (bt_field_type_common_array_get_length(field_type) != 16) {
- BT_LOGW("Invalid packet header field type: `uuid` array field type's length must be 16: "
- "uuid-ft-addr=%p, uuid-ft-length=%" PRId64,
- field_type,
- bt_field_type_common_array_get_length(field_type));
- goto invalid;
- }
-
- elem_ft = bt_field_type_common_array_borrow_element_field_type(field_type);
- BT_ASSERT(elem_ft);
-
- if (elem_ft->id != BT_FIELD_TYPE_ID_INTEGER) {
- BT_LOGW("Invalid packet header field type: `uuid` field's element field type must be an integer field type: "
- "elem-ft-addr=%p, elem-ft-id=%s",
- elem_ft,
- bt_common_field_type_id_string(elem_ft->id));
- goto invalid;
- }
-
- if (bt_field_type_common_integer_is_signed(elem_ft)) {
- BT_LOGW("Invalid packet header field type: `uuid` field's element field type must be an unsigned integer field type: "
- "elem-ft-addr=%p", elem_ft);
- goto invalid;
- }
-
- if (bt_field_type_common_integer_get_size(elem_ft) != 8) {
- BT_LOGW("Invalid packet header field type: `uuid` field's element field type must be an 8-bit unsigned integer field type: "
- "elem-ft-addr=%p, elem-ft-size=%u",
- elem_ft,
- bt_field_type_common_integer_get_size(elem_ft));
- goto invalid;
- }
- }
-
- /*
- * The `stream_id` field must exist if there's more than one
- * stream classes in the trace.
- */
- field_type = bt_field_type_common_structure_borrow_field_type_by_name(
- packet_header_type, "stream_id");
-
- if (!field_type && trace->stream_classes->len >= 1) {
- BT_LOGW_STR("Invalid packet header field type: "
- "`stream_id` field does not exist but there's more than one stream class in the trace.");
- goto invalid;
- }
-
- /*
- * If there's a `stream_id` field, it must be an unsigned
- * integer field type.
- */
- if (field_type) {
- if (field_type->id != BT_FIELD_TYPE_ID_INTEGER) {
- BT_LOGW("Invalid packet header field type: `stream_id` field must be an integer field type: "
- "stream-id-ft-addr=%p, stream-id-ft-id=%s",
- field_type,
- bt_common_field_type_id_string(field_type->id));
- goto invalid;
- }
-
- if (bt_field_type_common_integer_is_signed(field_type)) {
- BT_LOGW("Invalid packet header field type: `stream_id` field must be an unsigned integer field type: "
- "stream-id-ft-addr=%p", field_type);
- goto invalid;
- }
- }
-
- /*
- * If there's a `packet_seq_num` field, it must be an unsigned
- * integer field type.
- */
- field_type = bt_field_type_common_structure_borrow_field_type_by_name(
- packet_header_type, "packet_seq_num");
- if (field_type) {
- if (field_type->id != BT_FIELD_TYPE_ID_INTEGER) {
- BT_LOGW("Invalid packet header field type: `packet_seq_num` field must be an integer field type: "
- "stream-id-ft-addr=%p, packet-seq-num-ft-id=%s",
- field_type,
- bt_common_field_type_id_string(field_type->id));
- goto invalid;
- }
-
- if (bt_field_type_common_integer_is_signed(field_type)) {
- BT_LOGW("Invalid packet header field type: `packet_seq_num` field must be an unsigned integer field type: "
- "packet-seq-num-ft-addr=%p", field_type);
- goto invalid;
- }
- }
-
- goto end;
-
-invalid:
- is_valid = false;
-
-end:
- return is_valid;
-}
-
-static
-bool packet_context_field_type_is_valid(struct bt_trace_common *trace,
- struct bt_stream_class_common *stream_class,
- struct bt_field_type_common *packet_context_type,
- bool check_ts_begin_end_mapped)
-{
- bool is_valid = true;
- struct bt_field_type_common *field_type = NULL;
-
- if (!packet_context_type) {
- /* No packet context field type: valid at this point */
- goto end;
- }
-
- /* Packet context field type, if it exists, must be a structure */
- if (packet_context_type->id != BT_FIELD_TYPE_ID_STRUCT) {
- BT_LOGW("Invalid packet context field type: must be a structure field type if it exists: "
- "ft-addr=%p, ft-id=%s",
- packet_context_type,
- bt_common_field_type_id_string(packet_context_type->id));
- goto invalid;
- }
-
- /*
- * If there's a `packet_size` field, it must be an unsigned
- * integer field type.
- */
- field_type = bt_field_type_common_structure_borrow_field_type_by_name(
- packet_context_type, "packet_size");
- if (field_type) {
- if (field_type->id != BT_FIELD_TYPE_ID_INTEGER) {
- BT_LOGW("Invalid packet context field type: `packet_size` field must be an integer field type: "
- "packet-size-ft-addr=%p, packet-size-ft-id=%s",
- field_type,
- bt_common_field_type_id_string(field_type->id));
- goto invalid;
- }
-
- if (bt_field_type_common_integer_is_signed(field_type)) {
- BT_LOGW("Invalid packet context field type: `packet_size` field must be an unsigned integer field type: "
- "packet-size-ft-addr=%p", field_type);
- goto invalid;
- }
- }
-
- /*
- * If there's a `content_size` field, it must be an unsigned
- * integer field type.
- */
- field_type = bt_field_type_common_structure_borrow_field_type_by_name(
- packet_context_type, "content_size");
- if (field_type) {
- if (field_type->id != BT_FIELD_TYPE_ID_INTEGER) {
- BT_LOGW("Invalid packet context field type: `content_size` field must be an integer field type: "
- "content-size-ft-addr=%p, content-size-ft-id=%s",
- field_type,
- bt_common_field_type_id_string(field_type->id));
- goto invalid;
- }
-
- if (bt_field_type_common_integer_is_signed(field_type)) {
- BT_LOGW("Invalid packet context field type: `content_size` field must be an unsigned integer field type: "
- "content-size-ft-addr=%p", field_type);
- goto invalid;
- }
- }
-
- /*
- * If there's a `events_discarded` field, it must be an unsigned
- * integer field type.
- */
- field_type = bt_field_type_common_structure_borrow_field_type_by_name(
- packet_context_type, "events_discarded");
- if (field_type) {
- if (field_type->id != BT_FIELD_TYPE_ID_INTEGER) {
- BT_LOGW("Invalid packet context field type: `events_discarded` field must be an integer field type: "
- "events-discarded-ft-addr=%p, events-discarded-ft-id=%s",
- field_type,
- bt_common_field_type_id_string(field_type->id));
- goto invalid;
- }
-
- if (bt_field_type_common_integer_is_signed(field_type)) {
- BT_LOGW("Invalid packet context field type: `events_discarded` field must be an unsigned integer field type: "
- "events-discarded-ft-addr=%p", field_type);
- goto invalid;
- }
- }
-
- /*
- * If there's a `timestamp_begin` field, it must be an unsigned
- * integer field type. Also, if the trace is not a CTF writer's
- * trace, then we cannot automatically set the mapped clock
- * class of this field, so it must have a mapped clock class.
- */
- field_type = bt_field_type_common_structure_borrow_field_type_by_name(
- packet_context_type, "timestamp_begin");
- if (field_type) {
- if (field_type->id != BT_FIELD_TYPE_ID_INTEGER) {
- BT_LOGW("Invalid packet context field type: `timestamp_begin` field must be an integer field type: "
- "timestamp-begin-ft-addr=%p, timestamp-begin-ft-id=%s",
- field_type,
- bt_common_field_type_id_string(field_type->id));
- goto invalid;
- }
-
- if (bt_field_type_common_integer_is_signed(field_type)) {
- BT_LOGW("Invalid packet context field type: `timestamp_begin` field must be an unsigned integer field type: "
- "timestamp-begin-ft-addr=%p", field_type);
- goto invalid;
- }
-
- if (check_ts_begin_end_mapped) {
- struct bt_clock_class *clock_class =
- bt_field_type_common_integer_borrow_mapped_clock_class(
- field_type);
-
- if (!clock_class) {
- BT_LOGW("Invalid packet context field type: `timestamp_begin` field must be mapped to a clock class: "
- "timestamp-begin-ft-addr=%p", field_type);
- goto invalid;
- }
- }
- }
-
- /*
- * If there's a `timestamp_end` field, it must be an unsigned
- * integer field type. Also, if the trace is not a CTF writer's
- * trace, then we cannot automatically set the mapped clock
- * class of this field, so it must have a mapped clock class.
- */
- field_type = bt_field_type_common_structure_borrow_field_type_by_name(
- packet_context_type, "timestamp_end");
- if (field_type) {
- if (field_type->id != BT_FIELD_TYPE_ID_INTEGER) {
- BT_LOGW("Invalid packet context field type: `timestamp_end` field must be an integer field type: "
- "timestamp-end-ft-addr=%p, timestamp-end-ft-id=%s",
- field_type,
- bt_common_field_type_id_string(field_type->id));
- goto invalid;
- }
-
- if (bt_field_type_common_integer_is_signed(field_type)) {
- BT_LOGW("Invalid packet context field type: `timestamp_end` field must be an unsigned integer field type: "
- "timestamp-end-ft-addr=%p", field_type);
- goto invalid;
- }
-
- if (check_ts_begin_end_mapped) {
- struct bt_clock_class *clock_class =
- bt_field_type_common_integer_borrow_mapped_clock_class(
- field_type);
-
- if (!clock_class) {
- BT_LOGW("Invalid packet context field type: `timestamp_end` field must be mapped to a clock class: "
- "timestamp-end-ft-addr=%p", field_type);
- goto invalid;
- }
- }
- }
-
- goto end;
-
-invalid:
- is_valid = false;
-
-end:
- return is_valid;
-}
-
-static
-bool event_header_field_type_is_valid(struct bt_trace_common *trace,
- struct bt_stream_class_common *stream_class,
- struct bt_field_type_common *event_header_type)
-{
- bool is_valid = true;
- struct bt_field_type_common *field_type = NULL;
-
- /*
- * We do not validate that the `timestamp` field exists here
- * because CTF does not require this exact name to be mapped to
- * a clock class.
- */
-
- if (!event_header_type) {
- /*
- * No event header field type: stream class must have
- * only one event class.
- */
- if (bt_stream_class_common_get_event_class_count(stream_class) > 1) {
- BT_LOGW_STR("Invalid event header field type: "
- "event header field type does not exist but there's more than one event class in the stream class.");
- goto invalid;
- }
-
- /* No event header field type: valid at this point */
- goto end;
- }
-
- /* Event header field type, if it exists, must be a structure */
- if (event_header_type->id != BT_FIELD_TYPE_ID_STRUCT) {
- BT_LOGW("Invalid event header field type: must be a structure field type if it exists: "
- "ft-addr=%p, ft-id=%s",
- event_header_type,
- bt_common_field_type_id_string(event_header_type->id));
- goto invalid;
- }
-
- /*
- * If there's an `id` field, it must be an unsigned integer
- * field type or an enumeration field type with an unsigned
- * integer container field type.
- */
- field_type = bt_field_type_common_structure_borrow_field_type_by_name(
- event_header_type, "id");
- if (field_type) {
- struct bt_field_type_common *int_ft;
-
- if (field_type->id == BT_FIELD_TYPE_ID_INTEGER) {
- int_ft = field_type;
- } else if (field_type->id == BT_FIELD_TYPE_ID_ENUM) {
- int_ft = bt_field_type_common_enumeration_borrow_container_field_type(
- field_type);
- } else {
- BT_LOGW("Invalid event header field type: `id` field must be an integer or enumeration field type: "
- "id-ft-addr=%p, id-ft-id=%s",
- field_type,
- bt_common_field_type_id_string(field_type->id));
- goto invalid;
- }
-
- BT_ASSERT(int_ft);
- if (bt_field_type_common_integer_is_signed(int_ft)) {
- BT_LOGW("Invalid event header field type: `id` field must be an unsigned integer or enumeration field type: "
- "id-ft-addr=%p", int_ft);
- goto invalid;
- }
- }
-
- goto end;
-
-invalid:
- is_valid = false;
-
-end:
- return is_valid;
-}
-
-static
-int check_packet_header_type_has_no_clock_class(struct bt_trace_common *trace)
-{
- int ret = 0;
-
- if (trace->packet_header_field_type) {
- struct bt_clock_class *clock_class = NULL;
-
- ret = bt_field_type_common_validate_single_clock_class(
- trace->packet_header_field_type,
- &clock_class);
- bt_put(clock_class);
- if (ret || clock_class) {
- BT_LOGW("Trace's packet header field type cannot "
- "contain a field type which is mapped to "
- "a clock class: "
- "trace-addr=%p, trace-name=\"%s\", "
- "clock-class-name=\"%s\"",
- trace, bt_trace_common_get_name(trace),
- clock_class ?
- bt_clock_class_get_name(clock_class) :
- NULL);
- ret = -1;
- }
- }
-
- return ret;
-}
-
-BT_HIDDEN
-int bt_trace_common_add_stream_class(struct bt_trace_common *trace,
- struct bt_stream_class_common *stream_class,
- bt_validation_flag_copy_field_type_func copy_field_type_func,
- struct bt_clock_class *init_expected_clock_class,
- 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),
- bool check_ts_begin_end_mapped)
-{
- int ret;
- int64_t i;
- int64_t stream_id;
- struct bt_validation_output trace_sc_validation_output = { 0 };
- struct bt_validation_output *ec_validation_outputs = NULL;
- const enum bt_validation_flag trace_sc_validation_flags =
- BT_VALIDATION_FLAG_TRACE |
- BT_VALIDATION_FLAG_STREAM;
- const enum bt_validation_flag ec_validation_flags =
- BT_VALIDATION_FLAG_EVENT;
- 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;
- int64_t event_class_count;
- struct bt_trace_common *current_parent_trace = NULL;
- struct bt_clock_class *expected_clock_class =
- bt_get(init_expected_clock_class);
-
- BT_ASSERT(copy_field_type_func);
-
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- goto end;
- }
-
- if (!stream_class) {
- BT_LOGW_STR("Invalid parameter: stream class is NULL.");
- ret = -1;
- goto end;
- }
-
- BT_LOGD("Adding stream class to trace: "
- "trace-addr=%p, trace-name=\"%s\", "
- "stream-class-addr=%p, stream-class-name=\"%s\", "
- "stream-class-id=%" PRId64,
- trace, bt_trace_common_get_name(trace),
- stream_class, bt_stream_class_common_get_name(stream_class),
- bt_stream_class_common_get_id(stream_class));
-
- current_parent_trace = bt_stream_class_common_borrow_trace(stream_class);
- if (current_parent_trace) {
- /* Stream class is already associated to a trace, abort. */
- BT_LOGW("Invalid parameter: stream class is already part of a trace: "
- "stream-class-trace-addr=%p, "
- "stream-class-trace-name=\"%s\"",
- current_parent_trace,
- bt_trace_common_get_name(current_parent_trace));
- ret = -1;
- goto end;
- }
-
- event_class_count =
- bt_stream_class_common_get_event_class_count(stream_class);
- BT_ASSERT(event_class_count >= 0);
-
- if (!stream_class->frozen) {
- /*
- * Stream class is not frozen yet. Validate that the
- * stream class contains at most a single clock class
- * because the previous
- * bt_stream_class_common_add_event_class() calls did
- * not make this validation since the stream class's
- * direct field types (packet context, event header,
- * event context) could change afterwards. This stream
- * class is about to be frozen and those field types
- * won't be changed if this function succeeds.
- *
- * At this point we're also sure that the stream class's
- * clock, if any, has the same class as the stream
- * class's expected clock class, if any. This is why, if
- * bt_stream_class_common_validate_single_clock_class()
- * succeeds below, the call to
- * bt_stream_class_map_clock_class() at the end of this
- * function is safe because it maps to the same, single
- * clock class.
- */
- ret = bt_stream_class_common_validate_single_clock_class(
- stream_class, &expected_clock_class);
- if (ret) {
- BT_LOGW("Invalid parameter: 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 end;
- }
- }
-
- ret = check_packet_header_type_has_no_clock_class(trace);
- if (ret) {
- /* check_packet_header_type_has_no_clock_class() logs errors */
- goto end;
- }
-
- /*
- * We're about to freeze both the trace and the stream class.
- * Also, each event class contained in this stream class are
- * already frozen.
- *
- * This trace, this stream class, and all its event classes
- * should be valid at this point.
- *
- * Validate trace and stream class first, then each event
- * class of this stream class can be validated individually.
- */
- packet_header_type =
- bt_trace_common_borrow_packet_header_field_type(trace);
- packet_context_type =
- bt_stream_class_common_borrow_packet_context_field_type(stream_class);
- event_header_type =
- bt_stream_class_common_borrow_event_header_field_type(stream_class);
- stream_event_ctx_type =
- bt_stream_class_common_borrow_event_context_field_type(stream_class);
-
- BT_LOGD("Validating trace and stream class field types.");
- ret = bt_validate_class_types(trace->environment,
- packet_header_type, packet_context_type, event_header_type,
- stream_event_ctx_type, NULL, NULL, trace->valid,
- stream_class->valid, 1, &trace_sc_validation_output,
- trace_sc_validation_flags, copy_field_type_func);
-
- if (ret) {
- /*
- * This means something went wrong during the validation
- * process, not that the objects are invalid.
- */
- BT_LOGE("Failed to validate trace and stream class field types: "
- "ret=%d", ret);
- goto end;
- }
-
- if ((trace_sc_validation_output.valid_flags &
- trace_sc_validation_flags) !=
- trace_sc_validation_flags) {
- /* Invalid trace/stream class */
- BT_LOGW("Invalid trace or stream class field types: "
- "valid-flags=0x%x",
- trace_sc_validation_output.valid_flags);
- ret = -1;
- goto end;
- }
-
- if (event_class_count > 0) {
- ec_validation_outputs = g_new0(struct bt_validation_output,
- event_class_count);
- if (!ec_validation_outputs) {
- BT_LOGE_STR("Failed to allocate one validation output structure.");
- ret = -1;
- goto end;
- }
- }
-
- /* Validate each event class individually */
- for (i = 0; i < event_class_count; i++) {
- struct bt_event_class_common *event_class =
- bt_stream_class_common_borrow_event_class_by_index(
- stream_class, i);
- struct bt_field_type_common *event_context_type = NULL;
- struct bt_field_type_common *event_payload_type = NULL;
-
- event_context_type =
- bt_event_class_common_borrow_context_field_type(
- event_class);
- event_payload_type =
- bt_event_class_common_borrow_payload_field_type(
- event_class);
-
- /*
- * It is important to use the field types returned by
- * the previous trace and stream class validation here
- * because copies could have been made.
- */
- BT_LOGD("Validating event class's field types: "
- "addr=%p, name=\"%s\", id=%" PRId64,
- event_class, bt_event_class_common_get_name(event_class),
- bt_event_class_common_get_id(event_class));
- ret = bt_validate_class_types(trace->environment,
- trace_sc_validation_output.packet_header_type,
- trace_sc_validation_output.packet_context_type,
- trace_sc_validation_output.event_header_type,
- trace_sc_validation_output.stream_event_ctx_type,
- event_context_type, event_payload_type,
- 1, 1, event_class->valid, &ec_validation_outputs[i],
- ec_validation_flags, copy_field_type_func);
-
- if (ret) {
- BT_LOGE("Failed to validate event class field types: "
- "ret=%d", ret);
- goto end;
- }
-
- if ((ec_validation_outputs[i].valid_flags &
- ec_validation_flags) != ec_validation_flags) {
- /* Invalid event class */
- BT_LOGW("Invalid event class field types: "
- "valid-flags=0x%x",
- ec_validation_outputs[i].valid_flags);
- ret = -1;
- goto end;
- }
- }
-
- stream_id = bt_stream_class_common_get_id(stream_class);
- if (stream_id < 0) {
- stream_id = trace->next_stream_id++;
- if (stream_id < 0) {
- BT_LOGE_STR("No more stream class IDs available.");
- ret = -1;
- goto end;
- }
-
- /* Try to assign a new stream id */
- for (i = 0; i < trace->stream_classes->len; i++) {
- if (stream_id == bt_stream_class_common_get_id(
- trace->stream_classes->pdata[i])) {
- /* Duplicate stream id found */
- BT_LOGW("Duplicate stream class ID: "
- "id=%" PRId64, (int64_t) stream_id);
- ret = -1;
- goto end;
- }
- }
-
- if (bt_stream_class_common_set_id_no_check(stream_class,
- stream_id)) {
- /* TODO Should retry with a different stream id */
- BT_LOGE("Cannot set stream class's ID: "
- "id=%" PRId64, (int64_t) stream_id);
- ret = -1;
- goto end;
- }
- }
-
- /*
- * At this point all the field types in the validation output
- * are valid. Validate the semantics of some scopes according to
- * the CTF specification.
- */
- if (!packet_header_field_type_is_valid(trace,
- trace_sc_validation_output.packet_header_type)) {
- BT_LOGW_STR("Invalid trace's packet header field type.");
- ret = -1;
- goto end;
- }
-
- if (!packet_context_field_type_is_valid(trace,
- stream_class,
- trace_sc_validation_output.packet_context_type,
- check_ts_begin_end_mapped)) {
- BT_LOGW_STR("Invalid stream class's packet context field type.");
- ret = -1;
- goto end;
- }
-
- if (!event_header_field_type_is_valid(trace,
- stream_class,
- trace_sc_validation_output.event_header_type)) {
- BT_LOGW_STR("Invalid steam class's event header field type.");
- ret = -1;
- goto end;
- }
-
- /*
- * Now is the time to automatically map specific field types of
- * the stream class's packet context and event header field
- * types to the stream class's clock's class if they are not
- * mapped to a clock class yet. We do it here because we know
- * that after this point, everything is frozen so it won't be
- * possible for the user to modify the stream class's clock, or
- * to map those field types to other clock classes.
- */
- if (map_clock_classes_func) {
- if (map_clock_classes_func(stream_class,
- trace_sc_validation_output.packet_context_type,
- trace_sc_validation_output.event_header_type)) {
- /* map_clock_classes_func() logs errors */
- ret = -1;
- goto end;
- }
- }
-
- bt_object_set_parent(stream_class, trace);
- g_ptr_array_add(trace->stream_classes, stream_class);
-
- /*
- * At this point we know that the function will be successful.
- * Therefore we can replace the trace and stream class field
- * types with what's in their validation output structure and
- * mark them as valid. We can also replace the field types of
- * all the event classes of the stream class and mark them as
- * valid.
- */
- bt_validation_replace_types(trace, stream_class, NULL,
- &trace_sc_validation_output, trace_sc_validation_flags);
- trace->valid = 1;
- stream_class->valid = 1;
-
- /*
- * Put what was not moved in bt_validation_replace_types().
- */
- bt_validation_output_put_types(&trace_sc_validation_output);
-
- for (i = 0; i < event_class_count; i++) {
- struct bt_event_class_common *event_class =
- bt_stream_class_common_borrow_event_class_by_index(
- stream_class, i);
-
- bt_validation_replace_types(NULL, NULL, event_class,
- &ec_validation_outputs[i], ec_validation_flags);
- event_class->valid = 1;
-
- /*
- * Put what was not moved in
- * bt_validation_replace_types().
- */
- bt_validation_output_put_types(&ec_validation_outputs[i]);
- }
-
- /*
- * Freeze the trace and the stream class.
- */
- bt_stream_class_common_freeze(stream_class);
- bt_trace_common_freeze(trace);
-
- /*
- * 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);
- }
-
- BT_LOGD("Added stream class to trace: "
- "trace-addr=%p, trace-name=\"%s\", "
- "stream-class-addr=%p, stream-class-name=\"%s\", "
- "stream-class-id=%" PRId64,
- trace, bt_trace_common_get_name(trace),
- stream_class, bt_stream_class_common_get_name(stream_class),
- bt_stream_class_common_get_id(stream_class));
-
-end:
- if (ret) {
- bt_object_set_parent(stream_class, NULL);
-
- if (ec_validation_outputs) {
- for (i = 0; i < event_class_count; i++) {
- bt_validation_output_put_types(
- &ec_validation_outputs[i]);
- }
- }
- }
-
- g_free(ec_validation_outputs);
- bt_validation_output_put_types(&trace_sc_validation_output);
- bt_put(expected_clock_class);
- return ret;
-}
-
-int bt_trace_add_stream_class(struct bt_trace *trace,
- struct bt_stream_class *stream_class)
-{
- int ret = 0;
-
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- goto end;
- }
-
- if (trace->is_static) {
- BT_LOGW_STR("Invalid parameter: trace is static.");
- ret = -1;
- goto end;
- }
-
- ret = bt_trace_common_add_stream_class(BT_TO_COMMON(trace),
- BT_TO_COMMON(stream_class),
- (bt_validation_flag_copy_field_type_func) bt_field_type_copy,
- NULL, NULL, true);
- if (ret) {
- goto end;
- }
-
- /* Notifiy listeners of the trace's schema modification. */
- bt_stream_class_common_visit(BT_TO_COMMON(stream_class),
- bt_trace_object_modification, trace);
-
-end:
- return ret;
-}
-
-int64_t bt_trace_get_stream_count(struct bt_trace *trace)
-{
- return bt_trace_common_get_stream_count(BT_TO_COMMON(trace));
-}
-
-struct bt_stream *bt_trace_borrow_stream_by_index(
- struct bt_trace *trace, uint64_t index)
-{
- return BT_FROM_COMMON(bt_trace_common_borrow_stream_by_index(
- BT_TO_COMMON(trace), index));
-}
-
-int64_t bt_trace_get_stream_class_count(struct bt_trace *trace)
-{
- return bt_trace_common_get_stream_class_count(BT_TO_COMMON(trace));
-}
-
-struct bt_stream_class *bt_trace_borrow_stream_class_by_index(
- struct bt_trace *trace, uint64_t index)
-{
- return BT_FROM_COMMON(bt_trace_common_borrow_stream_class_by_index(
- BT_TO_COMMON(trace), index));
-}
-
-struct bt_stream_class *bt_trace_borrow_stream_class_by_id(
- struct bt_trace *trace, uint64_t id)
-{
- return BT_FROM_COMMON(
- bt_trace_common_borrow_stream_class_by_id(
- BT_TO_COMMON(trace), id));
-}
-
-struct bt_clock_class *bt_trace_borrow_clock_class_by_name(
- struct bt_trace *trace, const char *name)
-{
- return bt_trace_common_borrow_clock_class_by_name(BT_TO_COMMON(trace),
- name);
-}
-
-BT_HIDDEN
-bt_bool bt_trace_common_has_clock_class(struct bt_trace_common *trace,
- struct bt_clock_class *clock_class)
-{
- struct search_query query = { .value = clock_class, .found = 0 };
-
- BT_ASSERT(trace);
- BT_ASSERT(clock_class);
-
- g_ptr_array_foreach(trace->clock_classes, value_exists, &query);
- return query.found;
-}
-
-enum bt_byte_order bt_trace_get_native_byte_order(
- struct bt_trace *trace)
-{
- return bt_trace_common_get_native_byte_order(BT_TO_COMMON(trace));
-}
-
-BT_HIDDEN
-int bt_trace_common_set_native_byte_order(struct bt_trace_common *trace,
- enum bt_byte_order byte_order, bool allow_unspecified)
-{
- int ret = 0;
-
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- goto end;
- }
-
- if (trace->frozen) {
- BT_LOGW("Invalid parameter: trace is frozen: "
- "addr=%p, name=\"%s\"",
- trace, bt_trace_common_get_name(trace));
- ret = -1;
- goto end;
- }
-
- if (byte_order == BT_BYTE_ORDER_UNSPECIFIED && !allow_unspecified) {
- BT_LOGW("Invalid parameter: BT_BYTE_ORDER_UNSPECIFIED byte order is not allowed: "
- "addr=%p, name=\"%s\"",
- trace, bt_trace_common_get_name(trace));
- ret = -1;
- goto end;
- }
-
- if (byte_order != BT_BYTE_ORDER_LITTLE_ENDIAN &&
- byte_order != BT_BYTE_ORDER_BIG_ENDIAN &&
- byte_order != BT_BYTE_ORDER_NETWORK) {
- BT_LOGW("Invalid parameter: invalid byte order: "
- "addr=%p, name=\"%s\", bo=%s",
- trace, bt_trace_common_get_name(trace),
- bt_common_byte_order_string(byte_order));
- ret = -1;
- goto end;
- }
-
- trace->native_byte_order = byte_order;
- BT_LOGV("Set trace's native byte order: "
- "addr=%p, name=\"%s\", bo=%s",
- trace, bt_trace_common_get_name(trace),
- bt_common_byte_order_string(byte_order));
-
-end:
- return ret;
-}
-
-int bt_trace_set_native_byte_order(struct bt_trace *trace,
- enum bt_byte_order byte_order)
-{
- return bt_trace_common_set_native_byte_order(BT_TO_COMMON(trace),
- byte_order, true);
-}
-
-struct bt_field_type *bt_trace_borrow_packet_header_field_type(
- struct bt_trace *trace)
-{
- return BT_FROM_COMMON(bt_trace_common_borrow_packet_header_field_type(
- BT_TO_COMMON(trace)));
-}
-
-BT_HIDDEN
-int bt_trace_common_set_packet_header_field_type(struct bt_trace_common *trace,
- struct bt_field_type_common *packet_header_type)
-{
- int ret = 0;
-
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- goto end;
- }
-
- if (trace->frozen) {
- BT_LOGW("Invalid parameter: trace is frozen: "
- "addr=%p, name=\"%s\"",
- trace, bt_trace_common_get_name(trace));
- ret = -1;
- goto end;
- }
-
- /* packet_header_type must be a structure. */
- if (packet_header_type &&
- packet_header_type->id != BT_FIELD_TYPE_ID_STRUCT) {
- BT_LOGW("Invalid parameter: packet header field type must be a structure field type if it exists: "
- "addr=%p, name=\"%s\", ft-addr=%p, ft-id=%s",
- trace, bt_trace_common_get_name(trace),
- packet_header_type,
- bt_common_field_type_id_string(packet_header_type->id));
- ret = -1;
- goto end;
- }
-
- bt_put(trace->packet_header_field_type);
- trace->packet_header_field_type = bt_get(packet_header_type);
- BT_LOGV("Set trace's packet header field type: "
- "addr=%p, name=\"%s\", packet-context-ft-addr=%p",
- trace, bt_trace_common_get_name(trace), packet_header_type);
-end:
- return ret;
-}
-
-int bt_trace_set_packet_header_field_type(struct bt_trace *trace,
- struct bt_field_type *packet_header_type)
-{
- return bt_trace_common_set_packet_header_field_type(BT_TO_COMMON(trace),
- (void *) packet_header_type);
-}
-
-static
-int64_t get_stream_class_count(void *element)
-{
- return bt_trace_get_stream_class_count(
- (struct bt_trace *) element);
-}
-
-static
-void *get_stream_class(void *element, int i)
-{
- return bt_trace_get_stream_class_by_index(
- (struct bt_trace *) element, i);
-}
-
-static
-int visit_stream_class(void *object, bt_visitor visitor,void *data)
-{
- return bt_stream_class_visit(object, visitor, data);
-}
-
-int bt_trace_visit(struct bt_trace *trace,
- bt_visitor visitor, void *data)
-{
- int ret;
- struct bt_visitor_object obj = {
- .object = trace,
- .type = BT_VISITOR_OBJECT_TYPE_TRACE
- };
-
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- goto end;
- }
-
- if (!visitor) {
- BT_LOGW_STR("Invalid parameter: visitor is NULL.");
- ret = -1;
- goto end;
- }
-
- BT_LOGV("Visiting trace: addr=%p, name=\"%s\"",
- trace, bt_trace_get_name(trace));
- ret = visitor_helper(&obj, get_stream_class_count,
- get_stream_class, visit_stream_class, visitor, data);
-end:
- return ret;
-}
-
-static
-int invoke_listener(struct bt_visitor_object *object, void *data)
-{
- struct listener_wrapper *listener_wrapper = data;
-
- listener_wrapper->listener(object, listener_wrapper->data);
- return 0;
-}
-
-// TODO: add logging to this function once we use it internally.
-int bt_trace_add_listener(struct bt_trace *trace,
- bt_listener_cb listener, void *listener_data)
-{
- int ret = 0;
- struct listener_wrapper *listener_wrapper =
- g_new0(struct listener_wrapper, 1);
-
- if (!trace || !listener || !listener_wrapper) {
- ret = -1;
- goto error;
- }
-
- listener_wrapper->listener = listener;
- listener_wrapper->data = listener_data;
-
- /* Visit the current schema. */
- ret = bt_trace_visit(trace, invoke_listener, listener_wrapper);
- if (ret) {
- goto error;
- }
-
- /*
- * Add listener to the array of callbacks which will be invoked on
- * schema changes.
- */
- g_ptr_array_add(trace->listeners, listener_wrapper);
- return ret;
-error:
- g_free(listener_wrapper);
- return ret;
-}
-
-BT_HIDDEN
-int bt_trace_object_modification(struct bt_visitor_object *object,
- void *trace_ptr)
-{
- size_t i;
- struct bt_trace *trace = trace_ptr;
-
- BT_ASSERT(trace);
- BT_ASSERT(object);
-
- if (trace->listeners->len == 0) {
- goto end;
- }
-
- for (i = 0; i < trace->listeners->len; i++) {
- struct listener_wrapper *listener =
- g_ptr_array_index(trace->listeners, i);
-
- listener->listener(object, listener->data);
- }
-end: