X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=lib%2Fctf-ir%2Ftrace.c;h=eb4211cf8885d739b45bf3ce0c8ad922b2c1b643;hp=e0ef7b61c90f37f609c469db8a2e11c2082b638c;hb=312c056ae3d374b253fa0cfe5ed576c0b0e5e569;hpb=3d9990ac8bcbb870300869ed217b80151b52bf4e diff --git a/lib/ctf-ir/trace.c b/lib/ctf-ir/trace.c index e0ef7b61..eb4211cf 100644 --- a/lib/ctf-ir/trace.c +++ b/lib/ctf-ir/trace.c @@ -26,6 +26,10 @@ * SOFTWARE. */ +#define BT_LOG_TAG "TRACE" +#include + +#include #include #include #include @@ -35,90 +39,207 @@ #include #include #include +#include #include #include #include #include #include -#include +#include #include #include +#include #include +#include #include +#include #include +#include +#include +#include #define DEFAULT_IDENTIFIER_SIZE 128 #define DEFAULT_METADATA_STRING_SIZE 4096 struct listener_wrapper { - bt_ctf_listener_cb listener; + bt_listener_cb listener; void *data; }; -static -void bt_ctf_trace_destroy(struct bt_object *obj); -static -int init_trace_packet_header(struct bt_ctf_trace *trace); -static -void bt_ctf_trace_freeze(struct bt_ctf_trace *trace); - -static -const unsigned int field_type_aliases_alignments[] = { - [FIELD_TYPE_ALIAS_UINT5_T] = 1, - [FIELD_TYPE_ALIAS_UINT8_T ... FIELD_TYPE_ALIAS_UINT16_T] = 8, - [FIELD_TYPE_ALIAS_UINT27_T] = 1, - [FIELD_TYPE_ALIAS_UINT32_T ... FIELD_TYPE_ALIAS_UINT64_T] = 8, +struct bt_trace_is_static_listener_elem { + bt_trace_is_static_listener func; + bt_trace_listener_removed removed; + void *data; }; static -const unsigned int field_type_aliases_sizes[] = { - [FIELD_TYPE_ALIAS_UINT5_T] = 5, - [FIELD_TYPE_ALIAS_UINT8_T] = 8, - [FIELD_TYPE_ALIAS_UINT16_T] = 16, - [FIELD_TYPE_ALIAS_UINT27_T] = 27, - [FIELD_TYPE_ALIAS_UINT32_T] = 32, - [FIELD_TYPE_ALIAS_UINT64_T] = 64, -}; +void bt_trace_destroy(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)); + + /* + * Call remove listeners first so that everything else still + * exists in the trace. + */ + if (trace->is_static_listeners) { + size_t i; -struct bt_ctf_trace *bt_ctf_trace_create(void) + for (i = 0; i < trace->is_static_listeners->len; i++) { + struct bt_trace_is_static_listener_elem elem = + g_array_index(trace->is_static_listeners, + struct bt_trace_is_static_listener_elem, i); + + if (elem.removed) { + elem.removed(trace, elem.data); + } + } + + 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_common_finalize(BT_TO_COMMON(trace)); + g_free(trace); +} + +BT_HIDDEN +int bt_trace_common_initialize(struct bt_trace_common *trace, + bt_object_release_func release_func) { - struct bt_ctf_trace *trace = NULL; + int ret = 0; - trace = g_new0(struct bt_ctf_trace, 1); - if (!trace) { + BT_LOGD_STR("Initializing common trace object."); + trace->native_byte_order = BT_BYTE_ORDER_UNSPECIFIED; + bt_object_init(trace, 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; } - trace->native_byte_order = BT_CTF_BYTE_ORDER_NATIVE; - bt_object_init(trace, bt_ctf_trace_destroy); - trace->clocks = g_ptr_array_new_with_free_func( - (GDestroyNotify) bt_put); trace->streams = g_ptr_array_new_with_free_func( (GDestroyNotify) bt_object_release); - trace->stream_classes = g_ptr_array_new_with_free_func( - (GDestroyNotify) bt_object_release); - if (!trace->clocks || !trace->stream_classes || !trace->streams) { + if (!trace->streams) { + BT_LOGE_STR("Failed to allocate one GPtrArray."); goto error; } - /* Generate a trace UUID */ - uuid_generate(trace->uuid); - if (init_trace_packet_header(trace)) { + trace->stream_classes = g_ptr_array_new_with_free_func( + (GDestroyNotify) bt_object_release); + if (!trace->stream_classes) { + BT_LOGE_STR("Failed to allocate one GPtrArray."); goto error; } /* Create the environment array object */ - trace->environment = bt_ctf_attributes_create(); + trace->environment = bt_attributes_create(); if (!trace->environment) { + BT_LOGE_STR("Cannot create empty attributes object."); + goto error; + } + + BT_LOGD("Initialized common trace object: addr=%p", trace); + goto end; + +error: + ret = -1; + +end: + return ret; +} + +BT_HIDDEN +void bt_trace_common_finalize(struct bt_trace_common *trace) +{ + BT_LOGD("Finalizing common trace object: addr=%p, name=\"%s\"", + trace, bt_trace_common_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); +} + +static +void free_packet_header_field(struct bt_field_wrapper *field_wrapper, + struct bt_trace *trace) +{ + bt_field_wrapper_destroy(field_wrapper); +} + +struct bt_trace *bt_trace_create(void) +{ + struct bt_trace *trace = NULL; + int ret; + + BT_LOGD_STR("Creating trace object."); + trace = g_new0(struct bt_trace, 1); + if (!trace) { + BT_LOGE_STR("Failed to allocate one trace."); + goto error; + } + + ret = bt_trace_common_initialize(BT_TO_COMMON(trace), bt_trace_destroy); + if (ret) { + /* bt_trace_common_initialize() logs errors */ goto error; } trace->listeners = g_ptr_array_new_with_free_func( (GDestroyNotify) g_free); if (!trace->listeners) { + BT_LOGE_STR("Failed to allocate one GPtrArray."); + goto error; + } + + trace->is_static_listeners = g_array_new(FALSE, TRUE, + sizeof(struct bt_trace_is_static_listener_elem)); + if (!trace->is_static_listeners) { + BT_LOGE_STR("Failed to allocate one GArray."); + goto error; + } + + 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, + trace); + if (ret) { + BT_LOGE("Failed to initialize packet header field pool: ret=%d", + ret); goto error; } + BT_LOGD("Created trace object: addr=%p", trace); return trace; error: @@ -126,24 +247,32 @@ error: return trace; } -const char *bt_ctf_trace_get_name(struct bt_ctf_trace *trace) +const char *bt_trace_get_name(struct bt_trace *trace) { - const char *name = NULL; - - if (!trace || !trace->name) { - goto end; - } - - name = trace->name->str; -end: - return name; + return bt_trace_common_get_name(BT_TO_COMMON(trace)); } -int bt_ctf_trace_set_name(struct bt_ctf_trace *trace, const char *name) +BT_HIDDEN +int bt_trace_common_set_name(struct bt_trace_common *trace, const char *name) { int ret = 0; - if (!trace || !name || trace->frozen) { + 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_common_get_name(trace)); ret = -1; goto end; } @@ -151,59 +280,124 @@ int bt_ctf_trace_set_name(struct bt_ctf_trace *trace, const char *name) 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; } -void bt_ctf_trace_destroy(struct bt_object *obj) +int bt_trace_set_name(struct bt_trace *trace, const char *name) { - struct bt_ctf_trace *trace; + return bt_trace_common_set_name(BT_TO_COMMON(trace), name); +} - trace = container_of(obj, struct bt_ctf_trace, base); - if (trace->environment) { - bt_ctf_attributes_destroy(trace->environment); - } +const unsigned char *bt_trace_get_uuid(struct bt_trace *trace) +{ + return bt_trace_common_get_uuid(BT_TO_COMMON(trace)); +} - if (trace->name) { - g_string_free(trace->name, TRUE); - } +BT_HIDDEN +int bt_trace_common_set_uuid(struct bt_trace_common *trace, + const unsigned char *uuid) +{ + int ret = 0; - if (trace->clocks) { - g_ptr_array_free(trace->clocks, TRUE); + if (!trace) { + BT_LOGW_STR("Invalid parameter: trace is NULL."); + ret = -1; + goto end; } - if (trace->streams) { - g_ptr_array_free(trace->streams, TRUE); + if (!uuid) { + BT_LOGW_STR("Invalid parameter: UUID is NULL."); + ret = -1; + goto end; } - if (trace->stream_classes) { - g_ptr_array_free(trace->stream_classes, TRUE); + 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 (trace->listeners) { - g_ptr_array_free(trace->listeners, TRUE); - } + 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_common_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]); - bt_put(trace->packet_header_type); - g_free(trace); +end: + return ret; +} + +int bt_trace_set_uuid(struct bt_trace *trace, + const unsigned char *uuid) +{ + return bt_trace_common_set_uuid(BT_TO_COMMON(trace), uuid); } -int bt_ctf_trace_set_environment_field(struct bt_ctf_trace *trace, +BT_HIDDEN +int bt_trace_common_set_environment_field(struct bt_trace_common *trace, const char *name, struct bt_value *value) { int ret = 0; - if (!trace || !name || !value || - bt_ctf_validate_identifier(name) || - !(bt_value_is_integer(value) || bt_value_is_string(value))) { + 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 (!value) { + BT_LOGW_STR("Invalid parameter: value is NULL."); + 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_common_get_name(trace), name); ret = -1; goto end; } - if (strchr(name, ' ')) { + 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_common_get_name(trace), name, + bt_value_type_string(bt_value_get_type(value))); ret = -1; goto end; } @@ -216,11 +410,14 @@ int bt_ctf_trace_set_environment_field(struct bt_ctf_trace *trace, * The object passed is frozen like all other attributes. */ struct bt_value *attribute = - bt_ctf_attributes_get_field_value_by_name( + bt_attributes_borrow_field_value_by_name( trace->environment, name); if (attribute) { - BT_PUT(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_common_get_name(trace), name); ret = -1; goto end; } @@ -228,306 +425,804 @@ int bt_ctf_trace_set_environment_field(struct bt_ctf_trace *trace, bt_value_freeze(value); } - ret = bt_ctf_attributes_set_field_value(trace->environment, name, + ret = bt_attributes_set_field_value(trace->environment, name, value); + if (ret) { + BT_LOGE("Cannot set environment field's value: " + "trace-addr=%p, trace-name=\"%s\", " + "env-name=\"%s\"", + trace, bt_trace_common_get_name(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_common_get_name(trace), name, value); + } end: return ret; } -int bt_ctf_trace_set_environment_field_string(struct bt_ctf_trace *trace, - const char *name, const char *value) +int bt_trace_set_environment_field(struct bt_trace *trace, + const char *name, struct bt_value *value) { - int ret = 0; - struct bt_value *env_value_string_obj = NULL; + int ret; - if (!trace || !name || !value) { + 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 (trace->frozen) { - /* - * New environment fields may be added to a frozen trace, - * but existing fields may not be changed. - */ - struct bt_value *attribute = - bt_ctf_attributes_get_field_value_by_name( - trace->environment, name); + ret = bt_trace_common_set_environment_field(BT_TO_COMMON(trace), + name, value); - if (attribute) { - BT_PUT(attribute); - ret = -1; - goto end; - } +end: + return ret; +} + +BT_HIDDEN +int bt_trace_common_set_environment_field_string(struct bt_trace_common *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; } env_value_string_obj = bt_value_string_create_init(value); - if (!env_value_string_obj) { + BT_LOGE_STR("Cannot create string value object."); ret = -1; goto end; } - if (trace->frozen) { - bt_value_freeze(env_value_string_obj); - } - ret = bt_ctf_trace_set_environment_field(trace, name, + /* bt_trace_common_set_environment_field() logs errors */ + ret = bt_trace_common_set_environment_field(trace, name, env_value_string_obj); end: - BT_PUT(env_value_string_obj); + bt_put(env_value_string_obj); return ret; } -int bt_ctf_trace_set_environment_field_integer(struct bt_ctf_trace *trace, - const char *name, int64_t value) +int bt_trace_set_environment_field_string(struct bt_trace *trace, + const char *name, const char *value) +{ + return bt_trace_common_set_environment_field_string(BT_TO_COMMON(trace), + name, value); +} + +BT_HIDDEN +int bt_trace_common_set_environment_field_integer( + struct bt_trace_common *trace, const char *name, int64_t value) { int ret = 0; struct bt_value *env_value_integer_obj = NULL; - if (!trace || !name) { - ret = -1; - goto end; - } - - if (trace->frozen) { - /* - * New environment fields may be added to a frozen trace, - * but existing fields may not be changed. - */ - struct bt_value *attribute = - bt_ctf_attributes_get_field_value_by_name( - trace->environment, name); - - if (attribute) { - BT_PUT(attribute); - ret = -1; - goto end; - } - } - env_value_integer_obj = bt_value_integer_create_init(value); if (!env_value_integer_obj) { + BT_LOGE_STR("Cannot create integer value object."); ret = -1; goto end; } - ret = bt_ctf_trace_set_environment_field(trace, name, + /* bt_trace_common_set_environment_field() logs errors */ + ret = bt_trace_common_set_environment_field(trace, name, env_value_integer_obj); - if (trace->frozen) { - bt_value_freeze(env_value_integer_obj); - } + end: - BT_PUT(env_value_integer_obj); + bt_put(env_value_integer_obj); return ret; } -int bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace *trace) +int bt_trace_set_environment_field_integer( + struct bt_trace *trace, const char *name, int64_t value) +{ + return bt_trace_common_set_environment_field_integer( + BT_TO_COMMON(trace), name, value); +} + +int64_t bt_trace_get_environment_field_count(struct bt_trace *trace) +{ + return bt_trace_common_get_environment_field_count(BT_TO_COMMON(trace)); +} + +const char * +bt_trace_get_environment_field_name_by_index(struct bt_trace *trace, + uint64_t index) +{ + return bt_trace_common_get_environment_field_name_by_index( + BT_TO_COMMON(trace), index); +} + +struct bt_value *bt_trace_borrow_environment_field_value_by_index( + struct bt_trace *trace, uint64_t index) +{ + return bt_trace_common_borrow_environment_field_value_by_index( + BT_TO_COMMON(trace), index); +} + +struct bt_value *bt_trace_borrow_environment_field_value_by_name( + struct bt_trace *trace, const char *name) +{ + return bt_trace_common_borrow_environment_field_value_by_name( + BT_TO_COMMON(trace), name); +} + +BT_HIDDEN +int bt_trace_common_add_clock_class(struct bt_trace_common *trace, + struct bt_clock_class *clock_class) { int ret = 0; if (!trace) { + BT_LOGW_STR("Invalid parameter: trace is NULL."); ret = -1; goto end; } - ret = bt_ctf_attributes_get_count(trace->environment); + 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_common_get_name(trace), + clock_class, bt_clock_class_get_name(clock_class)); + ret = -1; + goto end; + } -end: - return ret; -} + /* Check for duplicate clock classes */ + if (bt_trace_common_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_common_get_name(trace), + clock_class, bt_clock_class_get_name(clock_class)); + ret = -1; + goto end; + } -const char * -bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace *trace, - int index) -{ - const char *ret = NULL; + bt_get(clock_class); + g_ptr_array_add(trace->clock_classes, clock_class); - if (!trace) { - goto end; + if (trace->frozen) { + BT_LOGV_STR("Freezing added clock class because trace is frozen."); + bt_clock_class_freeze(clock_class); } - ret = bt_ctf_attributes_get_field_name(trace->environment, index); + BT_LOGV("Added clock class to trace: " + "trace-addr=%p, trace-name=\"%s\", " + "clock-class-addr=%p, clock-class-name=\"%s\"", + trace, bt_trace_common_get_name(trace), + clock_class, bt_clock_class_get_name(clock_class)); end: return ret; } -struct bt_value *bt_ctf_trace_get_environment_field_value( - struct bt_ctf_trace *trace, int index) +int bt_trace_add_clock_class(struct bt_trace *trace, + struct bt_clock_class *clock_class) { - struct bt_value *ret = NULL; + int ret; - if (!trace) { + 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; } - ret = bt_ctf_attributes_get_field_value(trace->environment, index); + ret = bt_trace_common_add_clock_class(BT_TO_COMMON(trace), + clock_class); end: return ret; } -struct bt_value *bt_ctf_trace_get_environment_field_value_by_name( - struct bt_ctf_trace *trace, const char *name) +int64_t bt_trace_get_clock_class_count(struct bt_trace *trace) { - struct bt_value *ret = NULL; + return bt_trace_common_get_clock_class_count(BT_TO_COMMON(trace)); +} + +struct bt_clock_class *bt_trace_borrow_clock_class_by_index( + struct bt_trace *trace, uint64_t index) +{ + return bt_trace_common_borrow_clock_class_by_index( + BT_TO_COMMON(trace), index); +} - if (!trace || !name) { +static +bool packet_header_field_type_is_valid(struct bt_trace_common *trace, + struct bt_field_type_common *packet_header_type) +{ + int ret; + bool is_valid = true; + struct bt_field_type_common *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; + } + + /* No packet header field type: valid at this point */ goto end; } - ret = bt_ctf_attributes_get_field_value_by_name(trace->environment, - name); + /* 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; + } + + /* + * 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 ret; + return is_valid; } -int bt_ctf_trace_add_clock_class(struct bt_ctf_trace *trace, - struct bt_ctf_clock_class *clock_class) +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) { - int ret = 0; + bool is_valid = true; + struct bt_field_type_common *field_type = NULL; - if (!trace || !bt_ctf_clock_class_is_valid(clock_class)) { - ret = -1; + if (!packet_context_type) { + /* No packet context field type: valid at this point */ goto end; } - /* Check for duplicate clock classes */ - if (bt_ctf_trace_has_clock_class(trace, clock_class)) { - ret = -1; - 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; } - bt_get(clock_class); - g_ptr_array_add(trace->clocks, clock_class); + /* + * 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 (trace->frozen) { - bt_ctf_clock_class_freeze(clock_class); + 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 ret; + return is_valid; } -int bt_ctf_trace_get_clock_class_count(struct bt_ctf_trace *trace) +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) { - int ret = -1; + bool is_valid = true; + struct bt_field_type_common *field_type = NULL; - if (!trace) { + /* + * 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; } - ret = trace->clocks->len; + /* 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 ret; + return is_valid; } -struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class( - struct bt_ctf_trace *trace, int index) +static +int check_packet_header_type_has_no_clock_class(struct bt_trace_common *trace) { - struct bt_ctf_clock_class *clock_class = NULL; + int ret = 0; - if (!trace || index < 0 || index >= trace->clocks->len) { - goto end; + 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; + } } - clock_class = g_ptr_array_index(trace->clocks, index); - bt_get(clock_class); -end: - return clock_class; + return ret; } -int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace, - struct bt_ctf_stream_class *stream_class) +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, i; + int ret; + int64_t i; int64_t stream_id; - struct bt_ctf_validation_output trace_sc_validation_output = { 0 }; - struct bt_ctf_validation_output *ec_validation_outputs = NULL; - const enum bt_ctf_validation_flag trace_sc_validation_flags = - BT_CTF_VALIDATION_FLAG_TRACE | - BT_CTF_VALIDATION_FLAG_STREAM; - const enum bt_ctf_validation_flag ec_validation_flags = - BT_CTF_VALIDATION_FLAG_EVENT; - struct bt_ctf_field_type *packet_header_type = NULL; - struct bt_ctf_field_type *packet_context_type = NULL; - struct bt_ctf_field_type *event_header_type = NULL; - struct bt_ctf_field_type *stream_event_ctx_type = NULL; - int event_class_count; - struct bt_ctf_trace *current_parent_trace = NULL; - - if (!trace || !stream_class) { + 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; } - /* - * At the end of this function we freeze the trace, so its - * native byte order must NOT be BT_CTF_BYTE_ORDER_NATIVE. - */ - if (trace->native_byte_order == BT_CTF_BYTE_ORDER_NATIVE) { + if (!stream_class) { + BT_LOGW_STR("Invalid parameter: stream class is NULL."); ret = -1; goto end; } - current_parent_trace = bt_ctf_stream_class_get_trace(stream_class); + 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_ctf_stream_class_get_event_class_count(stream_class); - assert(event_class_count >= 0); + bt_stream_class_common_get_event_class_count(stream_class); + BT_ASSERT(event_class_count >= 0); - /* Check for duplicate stream classes */ - for (i = 0; i < trace->stream_classes->len; i++) { - if (trace->stream_classes->pdata[i] == stream_class) { - /* Stream class already registered to the trace */ - ret = -1; + 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; } } - if (stream_class->clock) { - struct bt_ctf_clock_class *stream_clock_class = - stream_class->clock->clock_class; - - if (trace->is_created_by_writer) { - /* - * Make sure this clock was also added to the - * trace (potentially through its CTF writer - * owner). - */ - size_t i; - - for (i = 0; i < trace->clocks->len; i++) { - if (trace->clocks->pdata[i] == - stream_clock_class) { - /* Found! */ - break; - } - } - - if (i == trace->clocks->len) { - /* Not found */ - ret = -1; - goto end; - } - } else { - /* - * This trace was NOT created by a CTF writer, - * thus do not allow the stream class to add to - * have a clock at all. Those are two - * independent APIs (non-writer and writer - * APIs), and isolating them simplifies things. - */ - 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; } /* @@ -542,28 +1237,28 @@ int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace, * class of this stream class can be validated individually. */ packet_header_type = - bt_ctf_trace_get_packet_header_type(trace); + bt_trace_common_borrow_packet_header_field_type(trace); packet_context_type = - bt_ctf_stream_class_get_packet_context_type(stream_class); + bt_stream_class_common_borrow_packet_context_field_type(stream_class); event_header_type = - bt_ctf_stream_class_get_event_header_type(stream_class); + bt_stream_class_common_borrow_event_header_field_type(stream_class); stream_event_ctx_type = - bt_ctf_stream_class_get_event_context_type(stream_class); - ret = bt_ctf_validate_class_types(trace->environment, + 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); - BT_PUT(packet_header_type); - BT_PUT(packet_context_type); - BT_PUT(event_header_type); - BT_PUT(stream_event_ctx_type); + 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; } @@ -571,14 +1266,18 @@ int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace, 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_ctf_validation_output, + 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; } @@ -586,62 +1285,128 @@ int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace, /* Validate each event class individually */ for (i = 0; i < event_class_count; i++) { - struct bt_ctf_event_class *event_class = - bt_ctf_stream_class_get_event_class(stream_class, i); - struct bt_ctf_field_type *event_context_type = NULL; - struct bt_ctf_field_type *event_payload_type = NULL; + 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_ctf_event_class_get_context_type(event_class); + bt_event_class_common_borrow_context_field_type( + event_class); event_payload_type = - bt_ctf_event_class_get_payload_type(event_class); + 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. */ - ret = bt_ctf_validate_class_types(trace->environment, + 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); - BT_PUT(event_context_type); - BT_PUT(event_payload_type); - BT_PUT(event_class); + 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_ctf_stream_class_get_id(stream_class); + 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_ctf_stream_class_get_id( + 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_ctf_stream_class_set_id_no_check(stream_class, - stream_id)) { + 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; } @@ -658,457 +1423,317 @@ int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace, * all the event classes of the stream class and mark them as * valid. */ - bt_ctf_validation_replace_types(trace, stream_class, NULL, + 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_ctf_validation_replace_types(). + * Put what was not moved in bt_validation_replace_types(). */ - bt_ctf_validation_output_put_types(&trace_sc_validation_output); + bt_validation_output_put_types(&trace_sc_validation_output); for (i = 0; i < event_class_count; i++) { - struct bt_ctf_event_class *event_class = - bt_ctf_stream_class_get_event_class(stream_class, i); + struct bt_event_class_common *event_class = + bt_stream_class_common_borrow_event_class_by_index( + stream_class, i); - bt_ctf_validation_replace_types(NULL, NULL, event_class, + bt_validation_replace_types(NULL, NULL, event_class, &ec_validation_outputs[i], ec_validation_flags); event_class->valid = 1; - BT_PUT(event_class); /* * Put what was not moved in - * bt_ctf_validation_replace_types(). + * bt_validation_replace_types(). */ - bt_ctf_validation_output_put_types(&ec_validation_outputs[i]); + bt_validation_output_put_types(&ec_validation_outputs[i]); } /* * Freeze the trace and the stream class. */ - bt_ctf_stream_class_freeze(stream_class); - bt_ctf_trace_freeze(trace); + 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)); - /* Notifiy listeners of the trace's schema modification. */ - bt_ctf_stream_class_visit(stream_class, - bt_ctf_trace_object_modification, trace); end: if (ret) { bt_object_set_parent(stream_class, NULL); if (ec_validation_outputs) { for (i = 0; i < event_class_count; i++) { - bt_ctf_validation_output_put_types( + bt_validation_output_put_types( &ec_validation_outputs[i]); } } } g_free(ec_validation_outputs); - bt_ctf_validation_output_put_types(&trace_sc_validation_output); - bt_put(current_parent_trace); - assert(!packet_header_type); - assert(!packet_context_type); - assert(!event_header_type); - assert(!stream_event_ctx_type); - + bt_validation_output_put_types(&trace_sc_validation_output); + bt_put(expected_clock_class); return ret; } -int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace *trace) +int bt_trace_add_stream_class(struct bt_trace *trace, + struct bt_stream_class *stream_class) { - int ret; + int ret = 0; if (!trace) { + BT_LOGW_STR("Invalid parameter: trace is NULL."); ret = -1; goto end; } - ret = trace->stream_classes->len; -end: - return ret; -} - -struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class( - struct bt_ctf_trace *trace, int index) -{ - struct bt_ctf_stream_class *stream_class = NULL; - - if (!trace || index < 0 || index >= trace->stream_classes->len) { + if (trace->is_static) { + BT_LOGW_STR("Invalid parameter: trace is static."); + ret = -1; goto end; } - stream_class = g_ptr_array_index(trace->stream_classes, index); - bt_get(stream_class); -end: - return stream_class; -} - -struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_id( - struct bt_ctf_trace *trace, uint32_t id) -{ - int i; - struct bt_ctf_stream_class *stream_class = NULL; - - if (!trace) { + 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; } - for (i = 0; i < trace->stream_classes->len; i++) { - struct bt_ctf_stream_class *stream_class_candidate; - - stream_class_candidate = - g_ptr_array_index(trace->stream_classes, i); - - if (bt_ctf_stream_class_get_id(stream_class_candidate) == - (int64_t) id) { - stream_class = stream_class_candidate; - bt_get(stream_class); - 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 stream_class; + return ret; } -struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class_by_name( - struct bt_ctf_trace *trace, const char *name) +int64_t bt_trace_get_stream_count(struct bt_trace *trace) { - size_t i; - struct bt_ctf_clock_class *clock_class = NULL; - - if (!trace || !name) { - goto end; - } - - for (i = 0; i < trace->clocks->len; i++) { - struct bt_ctf_clock_class *cur_clk = - g_ptr_array_index(trace->clocks, i); - const char *cur_clk_name = bt_ctf_clock_class_get_name(cur_clk); - - if (!cur_clk_name) { - goto end; - } - - if (!strcmp(cur_clk_name, name)) { - clock_class = cur_clk; - bt_get(clock_class); - goto end; - } - } - -end: - return clock_class; + return bt_trace_common_get_stream_count(BT_TO_COMMON(trace)); } -BT_HIDDEN -bool bt_ctf_trace_has_clock_class(struct bt_ctf_trace *trace, - struct bt_ctf_clock_class *clock_class) +struct bt_stream *bt_trace_borrow_stream_by_index( + struct bt_trace *trace, uint64_t index) { - struct search_query query = { .value = clock_class, .found = 0 }; - - assert(trace); - assert(clock_class); - - g_ptr_array_foreach(trace->clocks, value_exists, &query); - return query.found; + return BT_FROM_COMMON(bt_trace_common_borrow_stream_by_index( + BT_TO_COMMON(trace), index)); } -BT_HIDDEN -const char *get_byte_order_string(enum bt_ctf_byte_order byte_order) +int64_t bt_trace_get_stream_class_count(struct bt_trace *trace) { - const char *string; - - switch (byte_order) { - case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN: - string = "le"; - break; - case BT_CTF_BYTE_ORDER_BIG_ENDIAN: - string = "be"; - break; - case BT_CTF_BYTE_ORDER_NATIVE: - string = "native"; - break; - default: - assert(false); - } - - return string; + return bt_trace_common_get_stream_class_count(BT_TO_COMMON(trace)); } -static -int append_trace_metadata(struct bt_ctf_trace *trace, - struct metadata_context *context) +struct bt_stream_class *bt_trace_borrow_stream_class_by_index( + struct bt_trace *trace, uint64_t index) { - unsigned char *uuid = trace->uuid; - int ret; - - g_string_append(context->string, "trace {\n"); - - g_string_append(context->string, "\tmajor = 1;\n"); - g_string_append(context->string, "\tminor = 8;\n"); - assert(trace->native_byte_order == BT_CTF_BYTE_ORDER_LITTLE_ENDIAN || - trace->native_byte_order == BT_CTF_BYTE_ORDER_BIG_ENDIAN || - trace->native_byte_order == BT_CTF_BYTE_ORDER_NETWORK); - g_string_append_printf(context->string, - "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n", - uuid[0], uuid[1], uuid[2], uuid[3], - uuid[4], uuid[5], uuid[6], uuid[7], - uuid[8], uuid[9], uuid[10], uuid[11], - uuid[12], uuid[13], uuid[14], uuid[15]); - g_string_append_printf(context->string, "\tbyte_order = %s;\n", - get_byte_order_string(trace->native_byte_order)); - - g_string_append(context->string, "\tpacket.header := "); - context->current_indentation_level++; - g_string_assign(context->field_name, ""); - ret = bt_ctf_field_type_serialize(trace->packet_header_type, - context); - if (ret) { - goto end; - } - context->current_indentation_level--; - - g_string_append(context->string, ";\n};\n\n"); -end: - return ret; + return BT_FROM_COMMON(bt_trace_common_borrow_stream_class_by_index( + BT_TO_COMMON(trace), index)); } -static -void append_env_metadata(struct bt_ctf_trace *trace, - struct metadata_context *context) +struct bt_stream_class *bt_trace_borrow_stream_class_by_id( + struct bt_trace *trace, uint64_t id) { - int i; - int env_size; - - env_size = bt_ctf_attributes_get_count(trace->environment); - - if (env_size <= 0) { - return; - } - - g_string_append(context->string, "env {\n"); - - for (i = 0; i < env_size; i++) { - struct bt_value *env_field_value_obj = NULL; - const char *entry_name; - - entry_name = bt_ctf_attributes_get_field_name( - trace->environment, i); - env_field_value_obj = bt_ctf_attributes_get_field_value( - trace->environment, i); - - if (!entry_name || !env_field_value_obj) { - goto loop_next; - } - - switch (bt_value_get_type(env_field_value_obj)) { - case BT_VALUE_TYPE_INTEGER: - { - int ret; - int64_t int_value; - - ret = bt_value_integer_get(env_field_value_obj, - &int_value); - - if (ret) { - goto loop_next; - } - - g_string_append_printf(context->string, - "\t%s = %" PRId64 ";\n", entry_name, - int_value); - break; - } - case BT_VALUE_TYPE_STRING: - { - int ret; - const char *str_value; - char *escaped_str = NULL; - - ret = bt_value_string_get(env_field_value_obj, - &str_value); - - if (ret) { - goto loop_next; - } - - escaped_str = g_strescape(str_value, NULL); - - if (!escaped_str) { - goto loop_next; - } - - g_string_append_printf(context->string, - "\t%s = \"%s\";\n", entry_name, escaped_str); - free(escaped_str); - break; - } - - default: - goto loop_next; - } - -loop_next: - BT_PUT(env_field_value_obj); - } - - g_string_append(context->string, "};\n\n"); + return BT_FROM_COMMON( + bt_trace_common_borrow_stream_class_by_id( + BT_TO_COMMON(trace), id)); } -char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace *trace) +struct bt_clock_class *bt_trace_borrow_clock_class_by_name( + struct bt_trace *trace, const char *name) { - char *metadata = NULL; - struct metadata_context *context = NULL; - int err = 0; - size_t i; - - if (!trace) { - goto end; - } + return bt_trace_common_borrow_clock_class_by_name(BT_TO_COMMON(trace), + name); +} - context = g_new0(struct metadata_context, 1); - if (!context) { - goto end; - } +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 }; - context->field_name = g_string_sized_new(DEFAULT_IDENTIFIER_SIZE); - context->string = g_string_sized_new(DEFAULT_METADATA_STRING_SIZE); - g_string_append(context->string, "/* CTF 1.8 */\n\n"); - if (append_trace_metadata(trace, context)) { - goto error; - } - append_env_metadata(trace, context); - g_ptr_array_foreach(trace->clocks, - (GFunc)bt_ctf_clock_class_serialize, context); + BT_ASSERT(trace); + BT_ASSERT(clock_class); - for (i = 0; i < trace->stream_classes->len; i++) { - err = bt_ctf_stream_class_serialize( - trace->stream_classes->pdata[i], context); - if (err) { - goto error; - } - } + g_ptr_array_foreach(trace->clock_classes, value_exists, &query); + return query.found; +} - metadata = context->string->str; -error: - g_string_free(context->string, err ? TRUE : FALSE); - g_string_free(context->field_name, TRUE); - g_free(context); -end: - return metadata; +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)); } -enum bt_ctf_byte_order bt_ctf_trace_get_byte_order(struct bt_ctf_trace *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) { - enum bt_ctf_byte_order ret = BT_CTF_BYTE_ORDER_UNKNOWN; + int ret = 0; if (!trace) { + BT_LOGW_STR("Invalid parameter: trace is NULL."); + ret = -1; goto end; } - ret = trace->native_byte_order; - -end: - return ret; -} - -int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace, - enum bt_ctf_byte_order byte_order) -{ - int ret = 0; + 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 (!trace || trace->frozen) { + 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_CTF_BYTE_ORDER_LITTLE_ENDIAN && - byte_order != BT_CTF_BYTE_ORDER_BIG_ENDIAN && - byte_order != BT_CTF_BYTE_ORDER_NETWORK) { + 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; } -struct bt_ctf_field_type *bt_ctf_trace_get_packet_header_type( - struct bt_ctf_trace *trace) +int bt_trace_set_native_byte_order(struct bt_trace *trace, + enum bt_byte_order byte_order) { - struct bt_ctf_field_type *field_type = NULL; - - if (!trace) { - goto end; - } + return bt_trace_common_set_native_byte_order(BT_TO_COMMON(trace), + byte_order, true); +} - bt_get(trace->packet_header_type); - field_type = trace->packet_header_type; -end: - return field_type; +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))); } -int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace *trace, - struct bt_ctf_field_type *packet_header_type) +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 || trace->frozen) { + 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 && - bt_ctf_field_type_get_type_id(packet_header_type) != - BT_CTF_FIELD_TYPE_ID_STRUCT) { + 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_type); - trace->packet_header_type = bt_get(packet_header_type); + 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 -int get_stream_class_count(void *element) +int64_t get_stream_class_count(void *element) { - return bt_ctf_trace_get_stream_class_count( - (struct bt_ctf_trace *) element); + return bt_trace_get_stream_class_count( + (struct bt_trace *) element); } static void *get_stream_class(void *element, int i) { - return bt_ctf_trace_get_stream_class( - (struct bt_ctf_trace *) element, i); + return bt_trace_get_stream_class_by_index( + (struct bt_trace *) element, i); } static -int visit_stream_class(void *object, bt_ctf_visitor visitor,void *data) +int visit_stream_class(void *object, bt_visitor visitor,void *data) { - return bt_ctf_stream_class_visit(object, visitor, data); + return bt_stream_class_visit(object, visitor, data); } -int bt_ctf_trace_visit(struct bt_ctf_trace *trace, - bt_ctf_visitor visitor, void *data) +int bt_trace_visit(struct bt_trace *trace, + bt_visitor visitor, void *data) { int ret; - struct bt_ctf_object obj = - { .object = trace, .type = BT_CTF_OBJECT_TYPE_TRACE }; + 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 (!trace || !visitor) { + 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: @@ -1116,7 +1741,7 @@ end: } static -int invoke_listener(struct bt_ctf_object *object, void *data) +int invoke_listener(struct bt_visitor_object *object, void *data) { struct listener_wrapper *listener_wrapper = data; @@ -1124,8 +1749,9 @@ int invoke_listener(struct bt_ctf_object *object, void *data) return 0; } -int bt_ctf_trace_add_listener(struct bt_ctf_trace *trace, - bt_ctf_listener_cb listener, void *listener_data) +// 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 = @@ -1140,7 +1766,7 @@ int bt_ctf_trace_add_listener(struct bt_ctf_trace *trace, listener_wrapper->data = listener_data; /* Visit the current schema. */ - ret = bt_ctf_trace_visit(trace, invoke_listener, listener_wrapper); + ret = bt_trace_visit(trace, invoke_listener, listener_wrapper); if (ret) { goto error; } @@ -1157,14 +1783,14 @@ error: } BT_HIDDEN -int bt_ctf_trace_object_modification(struct bt_ctf_object *object, +int bt_trace_object_modification(struct bt_visitor_object *object, void *trace_ptr) { size_t i; - struct bt_ctf_trace *trace = trace_ptr; + struct bt_trace *trace = trace_ptr; - assert(trace); - assert(object); + BT_ASSERT(trace); + BT_ASSERT(object); if (trace->listeners->len == 0) { goto end; @@ -1180,94 +1806,214 @@ end: return 0; } -BT_HIDDEN -struct bt_ctf_field_type *get_field_type(enum field_type_alias alias) +bt_bool bt_trace_is_static(struct bt_trace *trace) { - int ret; - unsigned int alignment, size; - struct bt_ctf_field_type *field_type = NULL; + BT_ASSERT_PRE_NON_NULL(trace, "Trace"); + return trace->is_static; +} + +int bt_trace_set_is_static(struct bt_trace *trace) +{ + int ret = 0; + size_t i; - if (alias >= NR_FIELD_TYPE_ALIAS) { + if (!trace) { + BT_LOGW_STR("Invalid parameter: trace is NULL."); + ret = -1; goto end; } - alignment = field_type_aliases_alignments[alias]; - size = field_type_aliases_sizes[alias]; - field_type = bt_ctf_field_type_integer_create(size); - ret = bt_ctf_field_type_set_alignment(field_type, alignment); + ret = check_packet_header_type_has_no_clock_class(BT_TO_COMMON(trace)); if (ret) { - BT_PUT(field_type); + /* check_packet_header_type_has_no_clock_class() logs errors */ + goto end; + } + + trace->is_static = BT_TRUE; + bt_trace_common_freeze(BT_TO_COMMON(trace)); + BT_LOGV("Set trace static: addr=%p, name=\"%s\"", + trace, bt_trace_get_name(trace)); + + /* Call all the "trace is static" listeners */ + for (i = 0; i < trace->is_static_listeners->len; i++) { + struct bt_trace_is_static_listener_elem elem = + g_array_index(trace->is_static_listeners, + struct bt_trace_is_static_listener_elem, i); + + if (elem.func) { + elem.func(trace, elem.data); + } } + end: - return field_type; + return ret; } -static -void bt_ctf_trace_freeze(struct bt_ctf_trace *trace) +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) { int 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_ctf_field_type_freeze(trace->packet_header_type); - bt_ctf_attributes_freeze(trace->environment); + /* Find the next available spot */ + for (i = 0; i < trace->is_static_listeners->len; i++) { + struct bt_trace_is_static_listener_elem elem = + g_array_index(trace->is_static_listeners, + struct bt_trace_is_static_listener_elem, i); - for (i = 0; i < trace->clocks->len; i++) { - struct bt_ctf_clock_class *clock_class = - g_ptr_array_index(trace->clocks, i); + if (!elem.func) { + break; + } + } - bt_ctf_clock_class_freeze(clock_class); + if (i == trace->is_static_listeners->len) { + g_array_append_val(trace->is_static_listeners, new_elem); + } else { + g_array_insert_val(trace->is_static_listeners, i, new_elem); } - trace->frozen = 1; + 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); + +end: + return i; } -static -int init_trace_packet_header(struct bt_ctf_trace *trace) +int bt_trace_remove_is_static_listener( + struct bt_trace *trace, int listener_id) { int ret = 0; - struct bt_ctf_field *magic = NULL, *uuid_array = NULL; - struct bt_ctf_field_type *_uint32_t = - get_field_type(FIELD_TYPE_ALIAS_UINT32_T); - struct bt_ctf_field_type *_uint8_t = - get_field_type(FIELD_TYPE_ALIAS_UINT8_T); - struct bt_ctf_field_type *trace_packet_header_type = - bt_ctf_field_type_structure_create(); - struct bt_ctf_field_type *uuid_array_type = - bt_ctf_field_type_array_create(_uint8_t, 16); - - if (!trace_packet_header_type || !uuid_array_type) { + struct bt_trace_is_static_listener_elem *elem; + + if (!trace) { + BT_LOGW_STR("Invalid parameter: trace is NULL."); ret = -1; goto end; } - ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type, - _uint32_t, "magic"); - if (ret) { + 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; } - ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type, - uuid_array_type, "uuid"); - if (ret) { + if (listener_id < 0) { + BT_LOGW("Invalid listener ID: must be zero or positive: " + "listener-id=%d", listener_id); + ret = -1; goto end; } - ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type, - _uint32_t, "stream_id"); - if (ret) { + 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; } - ret = bt_ctf_trace_set_packet_header_type(trace, - trace_packet_header_type); - if (ret) { + 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; } + + 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; + elem->removed(trace, elem->data); + trace->in_remove_listener = BT_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); + end: - bt_put(uuid_array_type); - bt_put(_uint32_t); - bt_put(_uint8_t); - bt_put(magic); - bt_put(uuid_array); - bt_put(trace_packet_header_type); return ret; } + +struct bt_packet_header_field *bt_trace_create_packet_header_field( + struct bt_trace *trace) +{ + struct bt_field_wrapper *field_wrapper; + + BT_ASSERT_PRE_NON_NULL(trace, "Trace"); + BT_ASSERT_PRE(trace->common.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->common.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(field_wrapper->field); + bt_trace_common_freeze(BT_TO_COMMON(trace)); + goto end; + +error: + if (field_wrapper) { + bt_field_wrapper_destroy(field_wrapper); + field_wrapper = NULL; + } + +end: + return (void *) field_wrapper; +}