#include <babeltrace/ctf-ir/field-wrapper-internal.h>
#include <babeltrace/ctf-ir/field-types-internal.h>
#include <babeltrace/ctf-ir/attributes-internal.h>
-#include <babeltrace/ctf-ir/validation-internal.h>
-#include <babeltrace/ctf-ir/visitor-internal.h>
-#include <babeltrace/ctf-ir/utils.h>
#include <babeltrace/ctf-ir/utils-internal.h>
+#include <babeltrace/ctf-ir/resolve-field-path-internal.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/values.h>
#include <babeltrace/values-internal.h>
#include <babeltrace/types.h>
#include <babeltrace/endian-internal.h>
#include <babeltrace/assert-internal.h>
+#include <babeltrace/compat/glib-internal.h>
#include <inttypes.h>
#include <stdint.h>
#include <string.h>
#include <stdlib.h>
-#define DEFAULT_IDENTIFIER_SIZE 128
-#define DEFAULT_METADATA_STRING_SIZE 4096
-
-struct listener_wrapper {
- bt_listener_cb listener;
- void *data;
-};
-
struct bt_trace_is_static_listener_elem {
bt_trace_is_static_listener func;
bt_trace_listener_removed removed;
void *data;
};
-static inline
-void bt_trace_finalize(struct bt_trace *trace)
-{
- BT_LOGD("Finalizing trace object: addr=%p, name=\"%s\"",
- trace, bt_trace_get_name(trace));
-
- if (trace->environment) {
- BT_LOGD_STR("Destroying environment attributes.");
- bt_attributes_destroy(trace->environment);
- }
-
- if (trace->name) {
- g_string_free(trace->name, TRUE);
- }
-
- if (trace->clock_classes) {
- BT_LOGD_STR("Putting clock classes.");
- g_ptr_array_free(trace->clock_classes, TRUE);
- }
-
- if (trace->streams) {
- BT_LOGD_STR("Destroying streams.");
- g_ptr_array_free(trace->streams, TRUE);
- }
-
- if (trace->stream_classes) {
- BT_LOGD_STR("Destroying stream classes.");
- g_ptr_array_free(trace->stream_classes, TRUE);
- }
-
- BT_LOGD_STR("Putting packet header field type.");
- bt_put(trace->packet_header_field_type);
-}
+#define BT_ASSERT_PRE_TRACE_HOT(_trace) \
+ BT_ASSERT_PRE_HOT((_trace), "Trace", ": %!+t", (_trace))
static
-void bt_trace_destroy(struct bt_object *obj)
+void destroy_trace(struct bt_object *obj)
{
struct bt_trace *trace = (void *) obj;
- BT_LOGD("Destroying trace object: addr=%p, name=\"%s\"",
- trace, bt_trace_get_name(trace));
+ BT_LIB_LOGD("Destroying trace object: %!+t", trace);
/*
* Call remove listeners first so that everything else still
g_array_free(trace->is_static_listeners, TRUE);
}
- if (trace->listeners) {
- g_ptr_array_free(trace->listeners, TRUE);
- }
-
bt_object_pool_finalize(&trace->packet_header_field_pool);
- bt_trace_finalize(trace);
- g_free(trace);
-}
-static inline
-int bt_trace_initialize(struct bt_trace *trace,
- bt_object_release_func release_func)
-{
- int ret = 0;
-
- BT_LOGD_STR("Initializing trace object.");
- trace->native_byte_order = BT_BYTE_ORDER_UNSPECIFIED;
- bt_object_init_shared_with_parent(&trace->base, release_func);
- trace->clock_classes = g_ptr_array_new_with_free_func(
- (GDestroyNotify) bt_put);
- if (!trace->clock_classes) {
- BT_LOGE_STR("Failed to allocate one GPtrArray.");
- goto error;
+ if (trace->environment) {
+ BT_LOGD_STR("Destroying environment attributes.");
+ bt_attributes_destroy(trace->environment);
}
- trace->streams = g_ptr_array_new_with_free_func(
- (GDestroyNotify) bt_object_try_spec_release);
- if (!trace->streams) {
- BT_LOGE_STR("Failed to allocate one GPtrArray.");
- goto error;
+ if (trace->name.str) {
+ g_string_free(trace->name.str, TRUE);
}
- trace->stream_classes = g_ptr_array_new_with_free_func(
- (GDestroyNotify) bt_object_try_spec_release);
- if (!trace->stream_classes) {
- BT_LOGE_STR("Failed to allocate one GPtrArray.");
- goto error;
+ if (trace->streams) {
+ BT_LOGD_STR("Destroying streams.");
+ g_ptr_array_free(trace->streams, TRUE);
}
- /* Create the environment array object */
- trace->environment = bt_attributes_create();
- if (!trace->environment) {
- BT_LOGE_STR("Cannot create empty attributes object.");
- goto error;
+ if (trace->stream_classes) {
+ BT_LOGD_STR("Destroying stream classes.");
+ g_ptr_array_free(trace->stream_classes, TRUE);
}
- BT_LOGD("Initialized trace object: addr=%p", trace);
- goto end;
-
-error:
- ret = -1;
+ if (trace->stream_classes_stream_count) {
+ g_hash_table_destroy(trace->stream_classes_stream_count);
+ }
-end:
- return ret;
+ BT_LOGD_STR("Putting packet header field type.");
+ bt_put(trace->packet_header_ft);
+ g_free(trace);
}
static
struct bt_trace *trace = NULL;
int ret;
- BT_LOGD_STR("Creating trace object.");
+ BT_LOGD_STR("Creating default trace object.");
trace = g_new0(struct bt_trace, 1);
if (!trace) {
BT_LOGE_STR("Failed to allocate one trace.");
goto error;
}
- ret = bt_trace_initialize(trace, bt_trace_destroy);
- if (ret) {
- /* bt_trace_initialize() logs errors */
+ bt_object_init_shared_with_parent(&trace->base, destroy_trace);
+ trace->streams = g_ptr_array_new_with_free_func(
+ (GDestroyNotify) bt_object_try_spec_release);
+ if (!trace->streams) {
+ BT_LOGE_STR("Failed to allocate one GPtrArray.");
goto error;
}
- trace->listeners = g_ptr_array_new_with_free_func(
- (GDestroyNotify) g_free);
- if (!trace->listeners) {
+ trace->stream_classes = g_ptr_array_new_with_free_func(
+ (GDestroyNotify) bt_object_try_spec_release);
+ if (!trace->stream_classes) {
BT_LOGE_STR("Failed to allocate one GPtrArray.");
goto error;
}
+ trace->stream_classes_stream_count = g_hash_table_new(g_direct_hash,
+ g_direct_equal);
+ if (!trace->stream_classes_stream_count) {
+ BT_LOGE_STR("Failed to allocate one GHashTable.");
+ goto error;
+ }
+
+ trace->name.str = g_string_new(NULL);
+ if (!trace->name.str) {
+ BT_LOGE_STR("Failed to allocate one GString.");
+ goto error;
+ }
+
+ trace->environment = bt_attributes_create();
+ if (!trace->environment) {
+ BT_LOGE_STR("Cannot create empty attributes object.");
+ goto error;
+ }
+
trace->is_static_listeners = g_array_new(FALSE, TRUE,
sizeof(struct bt_trace_is_static_listener_elem));
if (!trace->is_static_listeners) {
goto error;
}
+ trace->assigns_automatic_stream_class_id = true;
ret = bt_object_pool_initialize(&trace->packet_header_field_pool,
(bt_object_pool_new_object_func) bt_field_wrapper_new,
(bt_object_pool_destroy_object_func) free_packet_header_field,
goto error;
}
- BT_LOGD("Created trace object: addr=%p", trace);
- return trace;
+ BT_LIB_LOGD("Created trace object: %!+t", trace);
+ goto end;
error:
BT_PUT(trace);
+
+end:
return trace;
}
const char *bt_trace_get_name(struct bt_trace *trace)
{
BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return trace->name ? trace->name->str : NULL;
+ return trace->name.value;
}
int bt_trace_set_name(struct bt_trace *trace, const char *name)
{
- int ret = 0;
-
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- goto end;
- }
-
- if (!name) {
- BT_LOGW_STR("Invalid parameter: name is NULL.");
- ret = -1;
- goto end;
- }
-
- if (trace->frozen) {
- BT_LOGW("Invalid parameter: trace is frozen: "
- "addr=%p, name=\"%s\"",
- trace, bt_trace_get_name(trace));
- ret = -1;
- goto end;
- }
-
- trace->name = trace->name ? g_string_assign(trace->name, name) :
- g_string_new(name);
- if (!trace->name) {
- BT_LOGE_STR("Failed to allocate one GString.");
- ret = -1;
- goto end;
- }
-
- BT_LOGV("Set trace's name: addr=%p, name=\"%s\"", trace, name);
-
-end:
- return ret;
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ BT_ASSERT_PRE_NON_NULL(name, "Name");
+ BT_ASSERT_PRE_TRACE_HOT(trace);
+ g_string_assign(trace->name.str, name);
+ trace->name.value = trace->name.str->str;
+ BT_LIB_LOGV("Set trace's name: %!+t", trace);
+ return 0;
}
-const unsigned char *bt_trace_get_uuid(struct bt_trace *trace)
+bt_uuid bt_trace_get_uuid(struct bt_trace *trace)
{
BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return trace->uuid_set ? trace->uuid : NULL;
+ return trace->uuid.value;
}
-int bt_trace_set_uuid(struct bt_trace *trace,
- const unsigned char *uuid)
+int bt_trace_set_uuid(struct bt_trace *trace, bt_uuid uuid)
{
- int ret = 0;
-
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- goto end;
- }
-
- if (!uuid) {
- BT_LOGW_STR("Invalid parameter: UUID is NULL.");
- ret = -1;
- goto end;
- }
-
- if (trace->frozen) {
- BT_LOGW("Invalid parameter: trace is frozen: "
- "addr=%p, name=\"%s\"",
- trace, bt_trace_get_name(trace));
- ret = -1;
- goto end;
- }
-
- memcpy(trace->uuid, uuid, BABELTRACE_UUID_LEN);
- trace->uuid_set = BT_TRUE;
- BT_LOGV("Set trace's UUID: addr=%p, name=\"%s\", "
- "uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
- trace, bt_trace_get_name(trace),
- (unsigned int) uuid[0],
- (unsigned int) uuid[1],
- (unsigned int) uuid[2],
- (unsigned int) uuid[3],
- (unsigned int) uuid[4],
- (unsigned int) uuid[5],
- (unsigned int) uuid[6],
- (unsigned int) uuid[7],
- (unsigned int) uuid[8],
- (unsigned int) uuid[9],
- (unsigned int) uuid[10],
- (unsigned int) uuid[11],
- (unsigned int) uuid[12],
- (unsigned int) uuid[13],
- (unsigned int) uuid[14],
- (unsigned int) uuid[15]);
-
-end:
- return ret;
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
+ BT_ASSERT_PRE_TRACE_HOT(trace);
+ memcpy(trace->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
+ trace->uuid.value = trace->uuid.uuid;
+ BT_LIB_LOGV("Set trace's UUID: %!+t", trace);
+ return 0;
}
-int bt_trace_set_environment_field(struct bt_trace *trace,
- const char *name, struct bt_value *value)
+BT_ASSERT_FUNC
+static
+bool trace_has_environment_entry(struct bt_trace *trace, const char *name)
{
- int ret = 0;
-
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- goto end;
- }
-
- if (!name) {
- BT_LOGW_STR("Invalid parameter: name is NULL.");
- ret = -1;
- goto end;
- }
+ struct bt_value *attribute;
- if (!value) {
- BT_LOGW_STR("Invalid parameter: value is NULL.");
- ret = -1;
- goto end;
- }
-
- if (trace->is_static) {
- BT_LOGW("Invalid parameter: trace is static: "
- "addr=%p, name=\"%s\"",
- trace, bt_trace_get_name(trace));
- ret = -1;
- goto end;
- }
-
- if (!bt_identifier_is_valid(name)) {
- BT_LOGW("Invalid parameter: environment field's name is not a valid CTF identifier: "
- "trace-addr=%p, trace-name=\"%s\", "
- "env-name=\"%s\"",
- trace, bt_trace_get_name(trace), name);
- ret = -1;
- goto end;
- }
-
- if (!bt_value_is_integer(value) && !bt_value_is_string(value)) {
- BT_LOGW("Invalid parameter: environment field's value is not an integer or string value: "
- "trace-addr=%p, trace-name=\"%s\", "
- "env-name=\"%s\", env-value-type=%s",
- trace, bt_trace_get_name(trace), name,
- bt_value_type_string(bt_value_get_type(value)));
- ret = -1;
- goto end;
- }
+ BT_ASSERT(trace);
- if (trace->frozen) {
- /*
- * New environment fields may be added to a frozen trace,
- * but existing fields may not be changed.
- *
- * The object passed is frozen like all other attributes.
- */
- struct bt_value *attribute =
- bt_attributes_borrow_field_value_by_name(
- trace->environment, name);
-
- if (attribute) {
- BT_LOGW("Invalid parameter: trace is frozen and environment field already exists with this name: "
- "trace-addr=%p, trace-name=\"%s\", "
- "env-name=\"%s\"",
- trace, bt_trace_get_name(trace), name);
- ret = -1;
- goto end;
- }
+ attribute = bt_attributes_borrow_field_value_by_name(
+ trace->environment, name);
+ return attribute != NULL;
+}
- bt_value_freeze(value);
- }
+static
+int set_environment_entry(struct bt_trace *trace, const char *name,
+ struct bt_value *value)
+{
+ int ret;
+ BT_ASSERT(trace);
+ BT_ASSERT(name);
+ BT_ASSERT(value);
+ BT_ASSERT_PRE(!trace->frozen ||
+ !trace_has_environment_entry(trace, name),
+ "Trace is frozen: cannot replace environment entry: "
+ "%![trace-]+t, entry-name=\"%s\"", trace, name);
ret = bt_attributes_set_field_value(trace->environment, name,
value);
+ bt_value_freeze(value);
if (ret) {
- BT_LOGE("Cannot set environment field's value: "
- "trace-addr=%p, trace-name=\"%s\", "
- "env-name=\"%s\"",
- trace, bt_trace_get_name(trace), name);
+ BT_LIB_LOGE("Cannot set trace's environment entry: "
+ "%![trace-]+t, entry-name=\"%s\"", trace, name);
} else {
- BT_LOGV("Set environment field's value: "
- "trace-addr=%p, trace-name=\"%s\", "
- "env-name=\"%s\", value-addr=%p",
- trace, bt_trace_get_name(trace), name, value);
+ BT_LIB_LOGV("Set trace's environment entry: "
+ "%![trace-]+t, entry-name=\"%s\"", trace, name);
}
-end:
return ret;
}
-int bt_trace_set_environment_field_string(struct bt_trace *trace,
+int bt_trace_set_environment_entry_string(struct bt_trace *trace,
const char *name, const char *value)
{
- int ret = 0;
- struct bt_value *env_value_string_obj = NULL;
-
- if (!value) {
- BT_LOGW_STR("Invalid parameter: value is NULL.");
- ret = -1;
- goto end;
- }
+ int ret;
+ struct bt_value *value_obj;
- env_value_string_obj = bt_value_string_create_init(value);
- if (!env_value_string_obj) {
- BT_LOGE_STR("Cannot create string value object.");
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ BT_ASSERT_PRE_NON_NULL(name, "Name");
+ BT_ASSERT_PRE_NON_NULL(value, "Value");
+ value_obj = bt_value_string_create_init(value);
+ if (!value_obj) {
+ BT_LOGE_STR("Cannot create a string value object.");
ret = -1;
goto end;
}
- /* bt_trace_set_environment_field() logs errors */
- ret = bt_trace_set_environment_field(trace, name,
- env_value_string_obj);
+ /* set_environment_entry() logs errors */
+ ret = set_environment_entry(trace, name, value_obj);
end:
- bt_put(env_value_string_obj);
+ bt_put(value_obj);
return ret;
}
-int bt_trace_set_environment_field_integer(
+int bt_trace_set_environment_entry_integer(
struct bt_trace *trace, const char *name, int64_t value)
{
- int ret = 0;
- struct bt_value *env_value_integer_obj = NULL;
+ int ret;
+ struct bt_value *value_obj;
- env_value_integer_obj = bt_value_integer_create_init(value);
- if (!env_value_integer_obj) {
- BT_LOGE_STR("Cannot create integer value object.");
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ BT_ASSERT_PRE_NON_NULL(name, "Name");
+ value_obj = bt_value_integer_create_init(value);
+ if (!value_obj) {
+ BT_LOGE_STR("Cannot create an integer value object.");
ret = -1;
goto end;
}
- /* bt_trace_set_environment_field() logs errors */
- ret = bt_trace_set_environment_field(trace, name,
- env_value_integer_obj);
+ /* set_environment_entry() logs errors */
+ ret = set_environment_entry(trace, name, value_obj);
end:
- bt_put(env_value_integer_obj);
+ bt_put(value_obj);
return ret;
}
-int64_t bt_trace_get_environment_field_count(struct bt_trace *trace)
+uint64_t bt_trace_get_environment_entry_count(struct bt_trace *trace)
{
int64_t ret;
BT_ASSERT_PRE_NON_NULL(trace, "Trace");
ret = bt_attributes_get_count(trace->environment);
BT_ASSERT(ret >= 0);
- return ret;
-}
-
-const char *
-bt_trace_get_environment_field_name_by_index(struct bt_trace *trace,
- uint64_t index)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return bt_attributes_get_field_name(trace->environment, index);
+ return (uint64_t) ret;
}
-struct bt_value *bt_trace_borrow_environment_field_value_by_index(
- struct bt_trace *trace, uint64_t index)
+void bt_trace_borrow_environment_entry_by_index(
+ struct bt_trace *trace, uint64_t index,
+ const char **name, struct bt_value **value)
{
BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return bt_attributes_borrow_field_value(trace->environment, index);
+ BT_ASSERT_PRE_NON_NULL(name, "Name");
+ BT_ASSERT_PRE_NON_NULL(value, "Value");
+ BT_ASSERT_PRE_VALID_INDEX(index,
+ bt_attributes_get_count(trace->environment));
+ *value = bt_attributes_borrow_field_value(trace->environment, index);
+ BT_ASSERT(*value);
+ *name = bt_attributes_get_field_name(trace->environment, index);
+ BT_ASSERT(*name);
}
-struct bt_value *bt_trace_borrow_environment_field_value_by_name(
+struct bt_value *bt_trace_borrow_environment_entry_value_by_name(
struct bt_trace *trace, const char *name)
{
BT_ASSERT_PRE_NON_NULL(trace, "Trace");
name);
}
-int bt_trace_add_clock_class(struct bt_trace *trace,
- struct bt_clock_class *clock_class)
+uint64_t bt_trace_get_stream_count(struct bt_trace *trace)
{
- int ret = 0;
-
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- goto end;
- }
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ return (uint64_t) trace->streams->len;
+}
- if (trace->is_static) {
- BT_LOGW("Invalid parameter: trace is static: "
- "addr=%p, name=\"%s\"",
- trace, bt_trace_get_name(trace));
- ret = -1;
- goto end;
- }
+struct bt_stream *bt_trace_borrow_stream_by_index(
+ struct bt_trace *trace, uint64_t index)
+{
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ BT_ASSERT_PRE_VALID_INDEX(index, trace->streams->len);
+ return g_ptr_array_index(trace->streams, index);
+}
- if (!bt_clock_class_is_valid(clock_class)) {
- BT_LOGW("Invalid parameter: clock class is invalid: "
- "trace-addr=%p, trace-name=\"%s\", "
- "clock-class-addr=%p, clock-class-name=\"%s\"",
- trace, bt_trace_get_name(trace),
- clock_class, bt_clock_class_get_name(clock_class));
- ret = -1;
- goto end;
- }
+struct bt_stream *bt_trace_borrow_stream_by_id(
+ struct bt_trace *trace, uint64_t id)
+{
+ struct bt_stream *stream = NULL;
+ uint64_t i;
- /* Check for duplicate clock classes */
- if (bt_trace_has_clock_class(trace, clock_class)) {
- BT_LOGW("Invalid parameter: clock class already exists in trace: "
- "trace-addr=%p, trace-name=\"%s\", "
- "clock-class-addr=%p, clock-class-name=\"%s\"",
- trace, bt_trace_get_name(trace),
- clock_class, bt_clock_class_get_name(clock_class));
- ret = -1;
- goto end;
- }
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- bt_get(clock_class);
- g_ptr_array_add(trace->clock_classes, clock_class);
+ for (i = 0; i < trace->streams->len; i++) {
+ struct bt_stream *stream_candidate =
+ g_ptr_array_index(trace->streams, i);
- if (trace->frozen) {
- BT_LOGV_STR("Freezing added clock class because trace is frozen.");
- bt_clock_class_freeze(clock_class);
+ if (stream_candidate->id == id) {
+ stream = stream_candidate;
+ goto end;
+ }
}
- BT_LOGV("Added clock class to trace: "
- "trace-addr=%p, trace-name=\"%s\", "
- "clock-class-addr=%p, clock-class-name=\"%s\"",
- trace, bt_trace_get_name(trace),
- clock_class, bt_clock_class_get_name(clock_class));
-
end:
- return ret;
+ return stream;
}
-int64_t bt_trace_get_clock_class_count(struct bt_trace *trace)
+uint64_t bt_trace_get_stream_class_count(struct bt_trace *trace)
{
BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return trace->clock_classes->len;
+ return (uint64_t) trace->stream_classes->len;
}
-struct bt_clock_class *bt_trace_borrow_clock_class_by_index(
+struct bt_stream_class *bt_trace_borrow_stream_class_by_index(
struct bt_trace *trace, uint64_t index)
{
BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE(index < trace->clock_classes->len,
- "Index is out of bounds: index=%" PRIu64 ", "
- "count=%u",
- index, trace->clock_classes->len);
- return g_ptr_array_index(trace->clock_classes, index);
+ BT_ASSERT_PRE_VALID_INDEX(index, trace->stream_classes->len);
+ return g_ptr_array_index(trace->stream_classes, index);
}
-static
-bool packet_header_field_type_is_valid(struct bt_trace *trace,
- struct bt_field_type *packet_header_type)
+struct bt_stream_class *bt_trace_borrow_stream_class_by_id(
+ struct bt_trace *trace, uint64_t id)
{
- int ret;
- bool is_valid = true;
- struct bt_field_type *field_type = NULL;
-
- if (!packet_header_type) {
- /*
- * No packet header field type: trace must have only
- * one stream. At this point the stream class being
- * added is not part of the trace yet, so we validate
- * that the trace contains no stream classes yet.
- */
- if (trace->stream_classes->len >= 1) {
- BT_LOGW_STR("Invalid packet header field type: "
- "packet header field type does not exist but there's more than one stream class in the trace.");
- goto invalid;
- }
+ struct bt_stream_class *stream_class = NULL;
+ uint64_t i;
- /* No packet header field type: valid at this point */
- goto end;
- }
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- /* Packet header field type, if it exists, must be a structure */
- if (packet_header_type->id != BT_FIELD_TYPE_ID_STRUCT) {
- BT_LOGW("Invalid packet header field type: must be a structure field type if it exists: "
- "ft-addr=%p, ft-id=%s",
- packet_header_type,
- bt_common_field_type_id_string(packet_header_type->id));
- goto invalid;
- }
+ for (i = 0; i < trace->stream_classes->len; i++) {
+ struct bt_stream_class *stream_class_candidate =
+ g_ptr_array_index(trace->stream_classes, i);
- /*
- * 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_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 (stream_class_candidate->id == id) {
+ stream_class = stream_class_candidate;
+ goto end;
}
+ }
- if (bt_field_type_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;
- }
+end:
+ return stream_class;
+}
- if (bt_field_type_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_integer_get_size(field_type));
- goto invalid;
- }
+struct bt_field_type *bt_trace_borrow_packet_header_field_type(
+ struct bt_trace *trace)
+{
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ return trace->packet_header_ft;
+}
- ret = bt_field_type_structure_borrow_field_by_index(
- packet_header_type, &field_name, NULL, 0);
- BT_ASSERT(ret == 0);
+int bt_trace_set_packet_header_field_type(struct bt_trace *trace,
+ struct bt_field_type *field_type)
+{
+ int ret;
+ struct bt_resolve_field_path_context resolve_ctx = {
+ .packet_header = field_type,
+ .packet_context = NULL,
+ .event_header = NULL,
+ .event_common_context = NULL,
+ .event_specific_context = NULL,
+ .event_payload = NULL,
+ };
- 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;
- }
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ BT_ASSERT_PRE_NON_NULL(field_type, "Field type");
+ BT_ASSERT_PRE_TRACE_HOT(trace);
+ BT_ASSERT_PRE(bt_field_type_get_type_id(field_type) ==
+ BT_FIELD_TYPE_ID_STRUCTURE,
+ "Packet header field type is not a structure field type: %!+F",
+ field_type);
+ ret = bt_resolve_field_paths(field_type, &resolve_ctx);
+ if (ret) {
+ goto end;
}
- /*
- * 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_structure_borrow_field_type_by_name(
- packet_header_type, "uuid");
- if (field_type) {
- struct bt_field_type *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_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_array_get_length(field_type));
- goto invalid;
- }
-
- elem_ft = bt_field_type_array_borrow_element_field_type(field_type);
- BT_ASSERT(elem_ft);
+ bt_field_type_make_part_of_trace(field_type);
+ bt_put(trace->packet_header_ft);
+ trace->packet_header_ft = bt_get(field_type);
+ bt_field_type_freeze(field_type);
+ BT_LIB_LOGV("Set trace's packet header field type: %!+t", trace);
- 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_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_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_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_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_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_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_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 *trace,
- struct bt_stream_class *stream_class,
- struct bt_field_type *packet_context_type,
- bool check_ts_begin_end_mapped)
-{
- bool is_valid = true;
- struct bt_field_type *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_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_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_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_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_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_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_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_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_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_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_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_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 *trace,
- struct bt_stream_class *stream_class,
- struct bt_field_type *event_header_type)
-{
- bool is_valid = true;
- struct bt_field_type *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_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_structure_borrow_field_type_by_name(
- event_header_type, "id");
- if (field_type) {
- struct bt_field_type *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_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_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 *trace)
-{
- int ret = 0;
-
- if (trace->packet_header_field_type) {
- struct bt_clock_class *clock_class = NULL;
-
- ret = bt_field_type_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_get_name(trace),
- clock_class ?
- bt_clock_class_get_name(clock_class) :
- NULL);
- ret = -1;
- }
- }
-
- return ret;
-}
-
-int bt_trace_add_stream_class(struct bt_trace *trace,
- struct bt_stream_class *stream_class)
-{
- 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 *packet_header_type = NULL;
- struct bt_field_type *packet_context_type = NULL;
- struct bt_field_type *event_header_type = NULL;
- struct bt_field_type *stream_event_ctx_type = NULL;
- int64_t event_class_count;
- struct bt_trace *current_parent_trace = NULL;
- struct bt_clock_class *expected_clock_class = NULL;
-
- 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;
- }
-
- 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_get_name(trace),
- stream_class, bt_stream_class_get_name(stream_class),
- bt_stream_class_get_id(stream_class));
-
- current_parent_trace = bt_stream_class_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_get_name(current_parent_trace));
- ret = -1;
- goto end;
- }
-
- event_class_count =
- bt_stream_class_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_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_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_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_get_id(stream_class),
- bt_stream_class_get_name(stream_class),
- expected_clock_class,
- expected_clock_class ?
- bt_clock_class_get_name(expected_clock_class) :
- 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_borrow_packet_header_field_type(trace);
- packet_context_type =
- bt_stream_class_borrow_packet_context_field_type(stream_class);
- event_header_type =
- bt_stream_class_borrow_event_header_field_type(stream_class);
- stream_event_ctx_type =
- bt_stream_class_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, bt_field_type_copy);
-
- 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 *event_class =
- bt_stream_class_borrow_event_class_by_index(
- stream_class, i);
- struct bt_field_type *event_context_type = NULL;
- struct bt_field_type *event_payload_type = NULL;
-
- event_context_type =
- bt_event_class_borrow_context_field_type(
- event_class);
- event_payload_type =
- bt_event_class_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_get_name(event_class),
- bt_event_class_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, bt_field_type_copy);
-
- 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_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_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_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, true)) {
- 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;
- }
-
- bt_object_set_parent(&stream_class->base, &trace->base);
- 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 *event_class =
- bt_stream_class_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_freeze(stream_class);
- bt_trace_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);
- }
-
- /* Notify listeners of the trace's schema modification. */
- bt_stream_class_visit(stream_class,
- bt_trace_object_modification, trace);
- 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_get_name(trace),
- stream_class, bt_stream_class_get_name(stream_class),
- bt_stream_class_get_id(stream_class));
-
-end:
- if (ret) {
- bt_object_set_parent(&stream_class->base, 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;
-}
-
-int64_t bt_trace_get_stream_count(struct bt_trace *trace)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return (int64_t) trace->streams->len;
-}
-
-struct bt_stream *bt_trace_borrow_stream_by_index(
- struct bt_trace *trace, uint64_t index)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE(index < trace->streams->len,
- "Index is out of bounds: index=%" PRIu64 ", "
- "count=%u",
- index, trace->streams->len);
- return g_ptr_array_index(trace->streams, index);
-}
-
-int64_t bt_trace_get_stream_class_count(struct bt_trace *trace)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return (int64_t) trace->stream_classes->len;
-}
-
-struct bt_stream_class *bt_trace_borrow_stream_class_by_index(
- struct bt_trace *trace, uint64_t index)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE(index < trace->stream_classes->len,
- "Index is out of bounds: index=%" PRIu64 ", "
- "count=%u",
- index, trace->stream_classes->len);
- return g_ptr_array_index(trace->stream_classes, index);
-}
-
-struct bt_stream_class *bt_trace_borrow_stream_class_by_id(
- struct bt_trace *trace, uint64_t id_param)
-{
- int i;
- struct bt_stream_class *stream_class = NULL;
- int64_t id = (int64_t) id_param;
-
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE(id >= 0,
- "Invalid stream class ID: %" PRIu64, id_param);
-
- for (i = 0; i < trace->stream_classes->len; i++) {
- struct bt_stream_class *stream_class_candidate;
-
- stream_class_candidate =
- g_ptr_array_index(trace->stream_classes, i);
-
- if (bt_stream_class_get_id(stream_class_candidate) ==
- (int64_t) id) {
- stream_class = stream_class_candidate;
- goto end;
- }
- }
-
-end:
- return stream_class;
-}
-
-struct bt_clock_class *bt_trace_borrow_clock_class_by_name(
- struct bt_trace *trace, const char *name)
-{
- size_t i;
- struct bt_clock_class *clock_class = NULL;
-
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE_NON_NULL(name, "Name");
-
- for (i = 0; i < trace->clock_classes->len; i++) {
- struct bt_clock_class *cur_clk =
- g_ptr_array_index(trace->clock_classes, i);
- const char *cur_clk_name = bt_clock_class_get_name(cur_clk);
-
- if (!cur_clk_name) {
- goto end;
- }
-
- if (!strcmp(cur_clk_name, name)) {
- clock_class = cur_clk;
- goto end;
- }
- }
-
-end:
- return clock_class;
-}
-
-BT_HIDDEN
-bt_bool bt_trace_has_clock_class(struct bt_trace *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)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return trace->native_byte_order;
-}
-
-int bt_trace_set_native_byte_order(struct bt_trace *trace,
- enum bt_byte_order byte_order)
-{
- 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_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_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_get_name(trace),
- bt_common_byte_order_string(byte_order));
-
-end:
- return ret;
-}
-
-struct bt_field_type *bt_trace_borrow_packet_header_field_type(
- struct bt_trace *trace)
-{
- BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return trace->packet_header_field_type;
-}
-
-int bt_trace_set_packet_header_field_type(struct bt_trace *trace,
- struct bt_field_type *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_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_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_get_name(trace), packet_header_type);
-end:
- return ret;
-}
-
-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:
- return 0;
-}
-
bt_bool bt_trace_is_static(struct bt_trace *trace)
{
BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- return trace->is_static;
+ return (bt_bool) trace->is_static;
}
-int bt_trace_set_is_static(struct bt_trace *trace)
+int bt_trace_make_static(struct bt_trace *trace)
{
- int ret = 0;
- size_t i;
-
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- 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;
- }
+ uint64_t i;
- trace->is_static = BT_TRUE;
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ trace->is_static = true;
bt_trace_freeze(trace);
- BT_LOGV("Set trace static: addr=%p, name=\"%s\"",
- trace, bt_trace_get_name(trace));
+ BT_LIB_LOGV("Trace is now static: %!+t", trace);
/* Call all the "trace is static" listeners */
for (i = 0; i < trace->is_static_listeners->len; i++) {
}
}
-end:
- return ret;
+ return 0;
}
int bt_trace_add_is_static_listener(struct bt_trace *trace,
bt_trace_is_static_listener listener,
- bt_trace_listener_removed listener_removed, void *data)
+ bt_trace_listener_removed listener_removed, void *data,
+ uint64_t *listener_id)
{
- int i;
+ uint64_t i;
struct bt_trace_is_static_listener_elem new_elem = {
.func = listener,
.removed = listener_removed,
.data = data,
};
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- i = -1;
- goto end;
- }
-
- if (!listener) {
- BT_LOGW_STR("Invalid parameter: listener is NULL.");
- i = -1;
- goto end;
- }
-
- if (trace->is_static) {
- BT_LOGW("Invalid parameter: trace is already static: "
- "addr=%p, name=\"%s\"",
- trace, bt_trace_get_name(trace));
- i = -1;
- goto end;
- }
-
- if (trace->in_remove_listener) {
- BT_LOGW("Cannot call this function during the execution of a remove listener: "
- "addr=%p, name=\"%s\"",
- trace, bt_trace_get_name(trace));
- i = -1;
- goto end;
- }
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ BT_ASSERT_PRE_NON_NULL(listener, "Listener");
+ BT_ASSERT_PRE(!trace->is_static,
+ "Trace is already static: %!+t", trace);
+ BT_ASSERT_PRE(trace->in_remove_listener,
+ "Cannot call this function while executing a "
+ "remove listener: %!+t", trace);
/* Find the next available spot */
for (i = 0; i < trace->is_static_listeners->len; i++) {
g_array_insert_val(trace->is_static_listeners, i, new_elem);
}
- BT_LOGV("Added \"trace is static\" listener: "
- "trace-addr=%p, trace-name=\"%s\", func-addr=%p, "
- "data-addr=%p, listener-id=%d",
- trace, bt_trace_get_name(trace), listener, data, i);
+ if (listener_id) {
+ *listener_id = i;
+ }
-end:
- return i;
+ BT_LIB_LOGV("Added \"trace is static\" listener: "
+ "%![trace-]+t, listener-id=%" PRIu64, trace, i);
+ return 0;
+}
+
+BT_ASSERT_PRE_FUNC
+static
+bool has_listener_id(struct bt_trace *trace, uint64_t listener_id)
+{
+ BT_ASSERT(listener_id < trace->is_static_listeners->len);
+ return (&g_array_index(trace->is_static_listeners,
+ struct bt_trace_is_static_listener_elem,
+ listener_id))->func != NULL;
}
int bt_trace_remove_is_static_listener(
- struct bt_trace *trace, int listener_id)
+ struct bt_trace *trace, uint64_t listener_id)
{
- int ret = 0;
struct bt_trace_is_static_listener_elem *elem;
- if (!trace) {
- BT_LOGW_STR("Invalid parameter: trace is NULL.");
- ret = -1;
- goto end;
- }
-
- if (trace->in_remove_listener) {
- BT_LOGW("Cannot call this function during the execution of a remove listener: "
- "addr=%p, name=\"%s\", listener-id=%d",
- trace, bt_trace_get_name(trace),
- listener_id);
- ret = -1;
- goto end;
- }
-
- if (listener_id < 0) {
- BT_LOGW("Invalid listener ID: must be zero or positive: "
- "listener-id=%d", listener_id);
- ret = -1;
- goto end;
- }
-
- if (listener_id >= trace->is_static_listeners->len) {
- BT_LOGW("Invalid parameter: no listener with this listener ID: "
- "addr=%p, name=\"%s\", listener-id=%d",
- trace, bt_trace_get_name(trace),
- listener_id);
- ret = -1;
- goto end;
- }
-
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ BT_ASSERT_PRE(!trace->is_static,
+ "Trace is already static: %!+t", trace);
+ BT_ASSERT_PRE(trace->in_remove_listener,
+ "Cannot call this function while executing a "
+ "remove listener: %!+t", trace);
+ BT_ASSERT_PRE(has_listener_id(trace, listener_id),
+ "Trace has no such \"trace is static\" listener ID: "
+ "%![trace-]+t, %" PRIu64, trace, listener_id);
elem = &g_array_index(trace->is_static_listeners,
struct bt_trace_is_static_listener_elem,
listener_id);
- if (!elem->func) {
- BT_LOGW("Invalid parameter: no listener with this listener ID: "
- "addr=%p, name=\"%s\", listener-id=%d",
- trace, bt_trace_get_name(trace),
- listener_id);
- ret = -1;
- goto end;
- }
+ BT_ASSERT(elem->func);
if (elem->removed) {
/* Call remove listener */
- BT_LOGV("Calling remove listener: "
- "trace-addr=%p, trace-name=\"%s\", "
- "listener-id=%d", trace, bt_trace_get_name(trace),
- listener_id);
- trace->in_remove_listener = BT_TRUE;
+ BT_LIB_LOGV("Calling remove listener: "
+ "%![trace-]+t, listener-id=%" PRIu64,
+ trace, listener_id);
+ trace->in_remove_listener = true;
elem->removed(trace, elem->data);
- trace->in_remove_listener = BT_FALSE;
+ trace->in_remove_listener = false;
}
elem->func = NULL;
elem->removed = NULL;
elem->data = NULL;
- BT_LOGV("Removed \"trace is static\" listener: "
- "trace-addr=%p, trace-name=\"%s\", "
- "listener-id=%d", trace, bt_trace_get_name(trace),
- listener_id);
+ BT_LIB_LOGV("Removed \"trace is static\" listener: "
+ "%![trace-]+t, listener-id=%" PRIu64,
+ trace, listener_id);
+ return 0;
+}
-end:
- return ret;
+BT_HIDDEN
+void _bt_trace_freeze(struct bt_trace *trace)
+{
+ /* The packet header field type is already frozen */
+ BT_ASSERT(trace);
+ BT_LIB_LOGD("Freezing trace: %!+t", trace);
+ trace->frozen = true;
}
-struct bt_packet_header_field *bt_trace_create_packet_header_field(
- struct bt_trace *trace)
+bt_bool bt_trace_assigns_automatic_stream_class_id(struct bt_trace *trace)
{
- struct bt_field_wrapper *field_wrapper;
+ BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+ return (bt_bool) trace->assigns_automatic_stream_class_id;
+}
+int bt_trace_set_assigns_automatic_stream_class_id(
+ struct bt_trace *trace, bt_bool value)
+{
BT_ASSERT_PRE_NON_NULL(trace, "Trace");
- BT_ASSERT_PRE(trace->packet_header_field_type,
- "Trace has no packet header field type: %!+t",
- trace);
- field_wrapper = bt_field_wrapper_create(
- &trace->packet_header_field_pool,
- (void *) trace->packet_header_field_type);
- if (!field_wrapper) {
- BT_LIB_LOGE("Cannot allocate one packet header field from trace: "
- "%![trace-]+t", trace);
- goto error;
- }
+ BT_ASSERT_PRE_TRACE_HOT(trace);
+ trace->assigns_automatic_stream_class_id = (bool) value;
+ BT_LIB_LOGV("Set trace's automatic stream class ID "
+ "assignment property: %!+t", trace);
+ return 0;
+}
- BT_ASSERT(field_wrapper->field);
+BT_HIDDEN
+void bt_trace_add_stream(struct bt_trace *trace, struct bt_stream *stream)
+{
+ guint count = 0;
+
+ bt_object_set_parent(&stream->base, &trace->base);
+ g_ptr_array_add(trace->streams, stream);
bt_trace_freeze(trace);
- goto end;
-error:
- if (field_wrapper) {
- bt_field_wrapper_destroy(field_wrapper);
- field_wrapper = NULL;
+ if (bt_g_hash_table_contains(trace->stream_classes_stream_count,
+ stream->class)) {
+ count = GPOINTER_TO_UINT(g_hash_table_lookup(
+ trace->stream_classes_stream_count, stream->class));
}
-end:
- return (void *) field_wrapper;
+ g_hash_table_insert(trace->stream_classes_stream_count,
+ stream->class, GUINT_TO_POINTER(count + 1));
+}
+
+BT_HIDDEN
+uint64_t bt_trace_get_automatic_stream_id(struct bt_trace *trace,
+ struct bt_stream_class *stream_class)
+{
+ gpointer orig_key;
+ gpointer value;
+ uint64_t id = 0;
+
+ BT_ASSERT(stream_class);
+ BT_ASSERT(trace);
+ if (g_hash_table_lookup_extended(trace->stream_classes_stream_count,
+ stream_class, &orig_key, &value)) {
+ id = (uint64_t) GPOINTER_TO_UINT(value);
+ }
+
+ return id;
}
projects / babeltrace.git / blobdiff