X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=plugins%2Fctf%2Ffs-src%2Ffs.c;h=07b4c049fc28bbd0ca155f6ab239a1921197f965;hp=6fc53e3c30da2f47f917e09c735defdbdd03b2eb;hb=312c056ae3d374b253fa0cfe5ed576c0b0e5e569;hpb=1a9f7075566704f314c36f92339c2e2fed697523 diff --git a/plugins/ctf/fs-src/fs.c b/plugins/ctf/fs-src/fs.c index 6fc53e3c..07b4c049 100644 --- a/plugins/ctf/fs-src/fs.c +++ b/plugins/ctf/fs-src/fs.c @@ -25,60 +25,183 @@ * SOFTWARE. */ -#include -#include -#include -#include -#include -#include -#include -#include -#include +#include +#include #include #include -#include +#include +#include #include -#include #include "fs.h" #include "metadata.h" -#include "data-stream.h" +#include "data-stream-file.h" #include "file.h" #include "../common/metadata/decoder.h" +#include "../common/notif-iter/notif-iter.h" +#include "../common/utils/utils.h" +#include "query.h" -#define PRINT_ERR_STREAM ctf_fs->error_fp -#define PRINT_PREFIX "ctf-fs" -#define PRINT_DBG_CHECK ctf_fs_debug -#include "../print.h" -#define METADATA_TEXT_SIG "/* CTF 1.8" +#define BT_LOG_TAG "PLUGIN-CTF-FS-SRC" +#include "logging.h" -BT_HIDDEN -bool ctf_fs_debug; +static +int notif_iter_data_set_current_ds_file(struct ctf_fs_notif_iter_data *notif_iter_data) +{ + struct ctf_fs_ds_file_info *ds_file_info; + int ret = 0; + + BT_ASSERT(notif_iter_data->ds_file_info_index < + notif_iter_data->ds_file_group->ds_file_infos->len); + ds_file_info = g_ptr_array_index( + notif_iter_data->ds_file_group->ds_file_infos, + notif_iter_data->ds_file_info_index); + + ctf_fs_ds_file_destroy(notif_iter_data->ds_file); + notif_iter_data->ds_file = ctf_fs_ds_file_create( + notif_iter_data->ds_file_group->ctf_fs_trace, + notif_iter_data->notif_iter, + notif_iter_data->ds_file_group->stream, + ds_file_info->path->str); + if (!notif_iter_data->ds_file) { + ret = -1; + } -struct bt_notification_iterator_next_return ctf_fs_iterator_next( - struct bt_private_notification_iterator *iterator) + return ret; +} + +static +void ctf_fs_notif_iter_data_destroy( + struct ctf_fs_notif_iter_data *notif_iter_data) { - struct ctf_fs_stream *fs_stream = - bt_private_notification_iterator_get_user_data(iterator); + if (!notif_iter_data) { + return; + } + + ctf_fs_ds_file_destroy(notif_iter_data->ds_file); + + if (notif_iter_data->notif_iter) { + bt_notif_iter_destroy(notif_iter_data->notif_iter); + } + + g_free(notif_iter_data); +} + +struct bt_notification_iterator_next_method_return ctf_fs_iterator_next( + struct bt_private_connection_private_notification_iterator *iterator) +{ + struct bt_notification_iterator_next_method_return next_ret; + struct ctf_fs_notif_iter_data *notif_iter_data = + bt_private_connection_private_notification_iterator_get_user_data(iterator); + int ret; + + BT_ASSERT(notif_iter_data->ds_file); + next_ret = ctf_fs_ds_file_next(notif_iter_data->ds_file); + + if (next_ret.status == BT_NOTIFICATION_ITERATOR_STATUS_OK && + bt_notification_get_type(next_ret.notification) == + BT_NOTIFICATION_TYPE_STREAM_BEGIN) { + if (notif_iter_data->skip_stream_begin_notifs) { + /* + * We already emitted a + * BT_NOTIFICATION_TYPE_STREAM_BEGIN + * notification: skip this one, get a new one. + */ + BT_PUT(next_ret.notification); + next_ret = ctf_fs_ds_file_next(notif_iter_data->ds_file); + BT_ASSERT(next_ret.status != BT_NOTIFICATION_ITERATOR_STATUS_END); + goto end; + } else { + /* + * First BT_NOTIFICATION_TYPE_STREAM_BEGIN + * notification: skip all following. + */ + notif_iter_data->skip_stream_begin_notifs = true; + goto end; + } + } + + if (next_ret.status == BT_NOTIFICATION_ITERATOR_STATUS_OK && + bt_notification_get_type(next_ret.notification) == + BT_NOTIFICATION_TYPE_STREAM_END) { + notif_iter_data->ds_file_info_index++; + + if (notif_iter_data->ds_file_info_index == + notif_iter_data->ds_file_group->ds_file_infos->len) { + /* + * No more stream files to read: we reached the + * real end. Emit this + * BT_NOTIFICATION_TYPE_STREAM_END notification. + * The next time ctf_fs_iterator_next() is + * called for this notification iterator, + * ctf_fs_ds_file_next() will return + * BT_NOTIFICATION_ITERATOR_STATUS_END(). + */ + goto end; + } + + BT_PUT(next_ret.notification); + bt_notif_iter_reset(notif_iter_data->notif_iter); + + /* + * Open and start reading the next stream file within + * our stream file group. + */ + ret = notif_iter_data_set_current_ds_file(notif_iter_data); + if (ret) { + next_ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR; + goto end; + } + + next_ret = ctf_fs_ds_file_next(notif_iter_data->ds_file); + + /* + * If we get a notification, we expect to get a + * BT_NOTIFICATION_TYPE_STREAM_BEGIN notification + * because the iterator's state machine emits one before + * even requesting the first block of data from the + * medium. Skip this notification because we're not + * really starting a new stream here, and try getting a + * new notification (which, if it works, is a + * BT_NOTIFICATION_TYPE_PACKET_BEGIN one). We're sure to + * get at least one pair of + * BT_NOTIFICATION_TYPE_PACKET_BEGIN and + * BT_NOTIFICATION_TYPE_PACKET_END notifications in the + * case of a single, empty packet. We know there's at + * least one packet because the stream file group does + * not contain empty stream files. + */ + BT_ASSERT(notif_iter_data->skip_stream_begin_notifs); + + if (next_ret.status == BT_NOTIFICATION_ITERATOR_STATUS_OK) { + BT_ASSERT(bt_notification_get_type(next_ret.notification) == + BT_NOTIFICATION_TYPE_STREAM_BEGIN); + BT_PUT(next_ret.notification); + next_ret = ctf_fs_ds_file_next(notif_iter_data->ds_file); + BT_ASSERT(next_ret.status != BT_NOTIFICATION_ITERATOR_STATUS_END); + } + } - return ctf_fs_stream_next(fs_stream); +end: + return next_ret; } -void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it) +void ctf_fs_iterator_finalize(struct bt_private_connection_private_notification_iterator *it) { - void *ctf_fs_stream = - bt_private_notification_iterator_get_user_data(it); + void *notif_iter_data = + bt_private_connection_private_notification_iterator_get_user_data(it); - ctf_fs_stream_destroy(ctf_fs_stream); + ctf_fs_notif_iter_data_destroy(notif_iter_data); } enum bt_notification_iterator_status ctf_fs_iterator_init( - struct bt_private_notification_iterator *it, + struct bt_private_connection_private_notification_iterator *it, struct bt_private_port *port) { - struct ctf_fs_stream *ctf_fs_stream = NULL; struct ctf_fs_port_data *port_data; + struct ctf_fs_notif_iter_data *notif_iter_data = NULL; enum bt_notification_iterator_status ret = BT_NOTIFICATION_ITERATOR_STATUS_OK; + int iret; port_data = bt_private_port_get_user_data(port); if (!port_data) { @@ -86,29 +209,42 @@ enum bt_notification_iterator_status ctf_fs_iterator_init( goto error; } - ctf_fs_stream = ctf_fs_stream_create(port_data->ctf_fs_trace, - port_data->path->str); - if (!ctf_fs_stream) { + notif_iter_data = g_new0(struct ctf_fs_notif_iter_data, 1); + if (!notif_iter_data) { + ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM; goto error; } - ret = bt_private_notification_iterator_set_user_data(it, ctf_fs_stream); - if (ret) { + notif_iter_data->notif_iter = bt_notif_iter_create( + port_data->ds_file_group->ctf_fs_trace->metadata->trace, + bt_common_get_page_size() * 8, + ctf_fs_ds_file_medops, NULL); + if (!notif_iter_data->notif_iter) { + BT_LOGE_STR("Cannot create a CTF notification iterator."); + ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM; goto error; } - ctf_fs_stream = NULL; + notif_iter_data->ds_file_group = port_data->ds_file_group; + iret = notif_iter_data_set_current_ds_file(notif_iter_data); + if (iret) { + ret = BT_NOTIFICATION_ITERATOR_STATUS_ERROR; + goto error; + } + + ret = bt_private_connection_private_notification_iterator_set_user_data(it, notif_iter_data); + if (ret != BT_NOTIFICATION_ITERATOR_STATUS_OK) { + goto error; + } + + notif_iter_data = NULL; goto end; error: - (void) bt_private_notification_iterator_set_user_data(it, NULL); - - if (ret == BT_NOTIFICATION_ITERATOR_STATUS_OK) { - ret = BT_NOTIFICATION_ITERATOR_STATUS_ERROR; - } + (void) bt_private_connection_private_notification_iterator_set_user_data(it, NULL); end: - ctf_fs_stream_destroy(ctf_fs_stream); + ctf_fs_notif_iter_data_destroy(notif_iter_data); return ret; } @@ -130,15 +266,17 @@ void ctf_fs_destroy(struct ctf_fs_component *ctf_fs) g_free(ctf_fs); } -static -void ctf_fs_trace_destroy(void *data) +BT_HIDDEN +void ctf_fs_trace_destroy(struct ctf_fs_trace *ctf_fs_trace) { - struct ctf_fs_trace *ctf_fs_trace = data; - if (!ctf_fs_trace) { return; } + if (ctf_fs_trace->ds_file_groups) { + g_ptr_array_free(ctf_fs_trace->ds_file_groups, TRUE); + } + if (ctf_fs_trace->path) { g_string_free(ctf_fs_trace->path, TRUE); } @@ -156,6 +294,13 @@ void ctf_fs_trace_destroy(void *data) g_free(ctf_fs_trace); } +static +void ctf_fs_trace_destroy_notifier(void *data) +{ + struct ctf_fs_trace *trace = data; + ctf_fs_trace_destroy(trace); +} + void ctf_fs_finalize(struct bt_private_component *component) { void *data = bt_private_component_get_user_data(component); @@ -171,31 +316,49 @@ void port_data_destroy(void *data) { return; } - if (port_data->path) { - g_string_free(port_data->path, TRUE); + g_free(port_data); +} + +static +GString *get_stream_instance_unique_name( + struct ctf_fs_ds_file_group *ds_file_group) +{ + GString *name; + struct ctf_fs_ds_file_info *ds_file_info; + + name = g_string_new(NULL); + if (!name) { + goto end; } - g_free(port_data); + /* + * If there's more than one stream file in the stream file + * group, the first (earliest) stream file's path is used as + * the stream's unique name. + */ + BT_ASSERT(ds_file_group->ds_file_infos->len > 0); + ds_file_info = g_ptr_array_index(ds_file_group->ds_file_infos, 0); + g_string_assign(name, ds_file_info->path->str); + +end: + return name; } static -int create_one_port_for_trace(struct ctf_fs_trace *ctf_fs_trace, - const char *stream_path) +int create_one_port_for_trace(struct ctf_fs_component *ctf_fs, + struct ctf_fs_trace *ctf_fs_trace, + struct ctf_fs_ds_file_group *ds_file_group) { int ret = 0; - struct bt_private_port *port = NULL; struct ctf_fs_port_data *port_data = NULL; GString *port_name = NULL; - struct ctf_fs_component *ctf_fs = ctf_fs_trace->ctf_fs; - port_name = g_string_new(NULL); + port_name = get_stream_instance_unique_name(ds_file_group); if (!port_name) { goto error; } - /* Assign the name for the new output port */ - g_string_printf(port_name, "%s", stream_path); - PDBG("Creating one port named `%s`\n", port_name->str); + BT_LOGD("Creating one port named `%s`", port_name->str); /* Create output port for this file */ port_data = g_new0(struct ctf_fs_port_data, 1); @@ -203,15 +366,10 @@ int create_one_port_for_trace(struct ctf_fs_trace *ctf_fs_trace, goto error; } - port_data->ctf_fs_trace = ctf_fs_trace; - port_data->path = g_string_new(stream_path); - if (!port_data->path) { - goto error; - } - - port = bt_private_component_source_add_output_private_port( - ctf_fs->priv_comp, port_name->str, port_data); - if (!port) { + port_data->ds_file_group = ds_file_group; + ret = bt_private_component_source_add_output_private_port( + ctf_fs->priv_comp, port_name->str, port_data, NULL); + if (ret) { goto error; } @@ -227,86 +385,519 @@ end: g_string_free(port_name, TRUE); } - bt_put(port); port_data_destroy(port_data); return ret; } static -int create_ports_for_trace(struct ctf_fs_trace *ctf_fs_trace) +int create_ports_for_trace(struct ctf_fs_component *ctf_fs, + struct ctf_fs_trace *ctf_fs_trace) +{ + int ret = 0; + size_t i; + + /* Create one output port for each stream file group */ + for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { + struct ctf_fs_ds_file_group *ds_file_group = + g_ptr_array_index(ctf_fs_trace->ds_file_groups, i); + + ret = create_one_port_for_trace(ctf_fs, ctf_fs_trace, + ds_file_group); + if (ret) { + BT_LOGE("Cannot create output port."); + goto end; + } + } + +end: + return ret; +} + +static +uint64_t get_packet_header_stream_instance_id(struct ctf_fs_trace *ctf_fs_trace, + struct bt_field *packet_header_field) +{ + struct bt_field *stream_instance_id_field = NULL; + uint64_t stream_instance_id = -1ULL; + int ret; + + if (!packet_header_field) { + goto end; + } + + stream_instance_id_field = bt_field_structure_borrow_field_by_name( + packet_header_field, "stream_instance_id"); + if (!stream_instance_id_field) { + goto end; + } + + ret = bt_field_integer_unsigned_get_value(stream_instance_id_field, + &stream_instance_id); + if (ret) { + stream_instance_id = -1ULL; + goto end; + } + +end: + return stream_instance_id; +} + +uint64_t get_packet_context_timestamp_begin_ns( + struct ctf_fs_trace *ctf_fs_trace, + struct bt_field *packet_context_field) +{ + int ret; + struct bt_field *timestamp_begin_field = NULL; + struct bt_field_type *timestamp_begin_ft = NULL; + uint64_t timestamp_begin_raw_value = -1ULL; + uint64_t timestamp_begin_ns = -1ULL; + int64_t timestamp_begin_ns_signed; + struct bt_clock_class *timestamp_begin_clock_class = NULL; + + if (!packet_context_field) { + goto end; + } + + timestamp_begin_field = bt_field_structure_borrow_field_by_name( + packet_context_field, "timestamp_begin"); + if (!timestamp_begin_field) { + goto end; + } + + timestamp_begin_ft = bt_field_borrow_type(timestamp_begin_field); + BT_ASSERT(timestamp_begin_ft); + timestamp_begin_clock_class = + bt_field_type_integer_borrow_mapped_clock_class(timestamp_begin_ft); + if (!timestamp_begin_clock_class) { + goto end; + } + + ret = bt_field_integer_unsigned_get_value(timestamp_begin_field, + ×tamp_begin_raw_value); + if (ret) { + goto end; + } + + ret = bt_clock_class_cycles_to_ns(timestamp_begin_clock_class, + timestamp_begin_raw_value, ×tamp_begin_ns_signed); + if (ret) { + goto end; + } + + timestamp_begin_ns = (uint64_t) timestamp_begin_ns_signed; + +end: + return timestamp_begin_ns; +} + +static +void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info *ds_file_info) +{ + if (!ds_file_info) { + return; + } + + if (ds_file_info->path) { + g_string_free(ds_file_info->path, TRUE); + } + + ctf_fs_ds_index_destroy(ds_file_info->index); + g_free(ds_file_info); +} + +static +struct ctf_fs_ds_file_info *ctf_fs_ds_file_info_create(const char *path, + uint64_t begin_ns, struct ctf_fs_ds_index *index) +{ + struct ctf_fs_ds_file_info *ds_file_info; + + ds_file_info = g_new0(struct ctf_fs_ds_file_info, 1); + if (!ds_file_info) { + goto end; + } + + ds_file_info->path = g_string_new(path); + if (!ds_file_info->path) { + ctf_fs_ds_file_info_destroy(ds_file_info); + ds_file_info = NULL; + goto end; + } + + ds_file_info->begin_ns = begin_ns; + ds_file_info->index = index; + index = NULL; + +end: + ctf_fs_ds_index_destroy(index); + return ds_file_info; +} + +static +void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group *ds_file_group) +{ + if (!ds_file_group) { + return; + } + + if (ds_file_group->ds_file_infos) { + g_ptr_array_free(ds_file_group->ds_file_infos, TRUE); + } + + bt_put(ds_file_group->stream); + bt_put(ds_file_group->stream_class); + g_free(ds_file_group); +} + +static +struct ctf_fs_ds_file_group *ctf_fs_ds_file_group_create( + struct ctf_fs_trace *ctf_fs_trace, + struct bt_stream_class *stream_class, + uint64_t stream_instance_id) +{ + struct ctf_fs_ds_file_group *ds_file_group; + + ds_file_group = g_new0(struct ctf_fs_ds_file_group, 1); + if (!ds_file_group) { + goto error; + } + + ds_file_group->ds_file_infos = g_ptr_array_new_with_free_func( + (GDestroyNotify) ctf_fs_ds_file_info_destroy); + if (!ds_file_group->ds_file_infos) { + goto error; + } + + ds_file_group->stream_id = stream_instance_id; + BT_ASSERT(stream_class); + ds_file_group->stream_class = bt_get(stream_class); + ds_file_group->ctf_fs_trace = ctf_fs_trace; + goto end; + +error: + ctf_fs_ds_file_group_destroy(ds_file_group); + ds_file_group = NULL; + +end: + return ds_file_group; +} + +/* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */ +static +void array_insert(GPtrArray *array, gpointer element, size_t pos) +{ + size_t original_array_len = array->len; + + /* Allocate an unused element at the end of the array. */ + g_ptr_array_add(array, NULL); + + /* If we are not inserting at the end, move the elements by one. */ + if (pos < original_array_len) { + memmove(&(array->pdata[pos + 1]), + &(array->pdata[pos]), + (original_array_len - pos) * sizeof(gpointer)); + } + + /* Insert the value and bump the array len */ + array->pdata[pos] = element; +} + +static +int ctf_fs_ds_file_group_add_ds_file_info( + struct ctf_fs_ds_file_group *ds_file_group, + const char *path, uint64_t begin_ns, + struct ctf_fs_ds_index *index) +{ + struct ctf_fs_ds_file_info *ds_file_info; + gint i = 0; + int ret = 0; + + /* Onwership of index is transferred. */ + ds_file_info = ctf_fs_ds_file_info_create(path, begin_ns, index); + index = NULL; + if (!ds_file_info) { + goto error; + } + + /* Find a spot to insert this one */ + for (i = 0; i < ds_file_group->ds_file_infos->len; i++) { + struct ctf_fs_ds_file_info *other_ds_file_info = + g_ptr_array_index(ds_file_group->ds_file_infos, i); + + if (begin_ns < other_ds_file_info->begin_ns) { + break; + } + } + + array_insert(ds_file_group->ds_file_infos, ds_file_info, i); + ds_file_info = NULL; + goto end; + +error: + ctf_fs_ds_file_info_destroy(ds_file_info); + ctf_fs_ds_index_destroy(index); + ret = -1; +end: + return ret; +} + +static +int add_ds_file_to_ds_file_group(struct ctf_fs_trace *ctf_fs_trace, + const char *path) +{ + struct bt_field *packet_header_field = NULL; + struct bt_field *packet_context_field = NULL; + struct bt_stream_class *stream_class = NULL; + uint64_t stream_instance_id = -1ULL; + uint64_t begin_ns = -1ULL; + struct ctf_fs_ds_file_group *ds_file_group = NULL; + bool add_group = false; + int ret; + size_t i; + struct ctf_fs_ds_file *ds_file = NULL; + struct ctf_fs_ds_index *index = NULL; + struct bt_notif_iter *notif_iter = NULL; + + notif_iter = bt_notif_iter_create(ctf_fs_trace->metadata->trace, + bt_common_get_page_size() * 8, ctf_fs_ds_file_medops, NULL); + if (!notif_iter) { + BT_LOGE_STR("Cannot create a CTF notification iterator."); + goto error; + } + + ds_file = ctf_fs_ds_file_create(ctf_fs_trace, notif_iter, NULL, path); + if (!ds_file) { + goto error; + } + + ret = ctf_fs_ds_file_borrow_packet_header_context_fields(ds_file, + &packet_header_field, &packet_context_field); + if (ret) { + BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).", + path); + goto error; + } + + stream_instance_id = get_packet_header_stream_instance_id(ctf_fs_trace, + packet_header_field); + begin_ns = get_packet_context_timestamp_begin_ns(ctf_fs_trace, + packet_context_field); + stream_class = ctf_utils_borrow_stream_class_from_packet_header( + ctf_fs_trace->metadata->trace, packet_header_field); + if (!stream_class) { + goto error; + } + + index = ctf_fs_ds_file_build_index(ds_file); + if (!index) { + BT_LOGW("Failed to index CTF stream file \'%s\'", + ds_file->file->path->str); + } + + if (begin_ns == -1ULL) { + /* + * No beggining timestamp to sort the stream files + * within a stream file group, so consider that this + * file must be the only one within its group. + */ + stream_instance_id = -1ULL; + } + + if (stream_instance_id == -1ULL) { + /* + * No stream instance ID or no beginning timestamp: + * create a unique stream file group for this stream + * file because, even if there's a stream instance ID, + * there's no timestamp to order the file within its + * group. + */ + ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace, + stream_class, stream_instance_id); + if (!ds_file_group) { + goto error; + } + + ret = ctf_fs_ds_file_group_add_ds_file_info(ds_file_group, + path, begin_ns, index); + /* Ownership of index is transferred. */ + index = NULL; + if (ret) { + goto error; + } + + add_group = true; + goto end; + } + + BT_ASSERT(stream_instance_id != -1ULL); + BT_ASSERT(begin_ns != -1ULL); + + /* Find an existing stream file group with this ID */ + for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { + ds_file_group = g_ptr_array_index( + ctf_fs_trace->ds_file_groups, i); + + if (ds_file_group->stream_class == stream_class && + ds_file_group->stream_id == + stream_instance_id) { + break; + } + + ds_file_group = NULL; + } + + if (!ds_file_group) { + ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace, + stream_class, stream_instance_id); + if (!ds_file_group) { + goto error; + } + + add_group = true; + } + + ret = ctf_fs_ds_file_group_add_ds_file_info(ds_file_group, path, + begin_ns, index); + index = NULL; + if (ret) { + goto error; + } + + goto end; + +error: + ctf_fs_ds_file_group_destroy(ds_file_group); + ret = -1; + +end: + if (add_group && ds_file_group) { + g_ptr_array_add(ctf_fs_trace->ds_file_groups, ds_file_group); + } + + ctf_fs_ds_file_destroy(ds_file); + + if (notif_iter) { + bt_notif_iter_destroy(notif_iter); + } + + ctf_fs_ds_index_destroy(index); + return ret; +} + +static +int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace) { int ret = 0; const char *basename; GError *error = NULL; GDir *dir = NULL; - struct ctf_fs_file *file = NULL; - struct ctf_fs_component *ctf_fs = ctf_fs_trace->ctf_fs; + size_t i; - /* Create one output port for each stream file */ + /* Check each file in the path directory, except specific ones */ dir = g_dir_open(ctf_fs_trace->path->str, 0, &error); if (!dir) { - PERR("Cannot open directory `%s`: %s (code %d)\n", + BT_LOGE("Cannot open directory `%s`: %s (code %d)", ctf_fs_trace->path->str, error->message, error->code); goto error; } while ((basename = g_dir_read_name(dir))) { + struct ctf_fs_file *file; + if (!strcmp(basename, CTF_FS_METADATA_FILENAME)) { /* Ignore the metadata stream. */ - PDBG("Ignoring metadata file `%s/%s`\n", + BT_LOGD("Ignoring metadata file `%s" G_DIR_SEPARATOR_S "%s`", ctf_fs_trace->path->str, basename); continue; } if (basename[0] == '.') { - PDBG("Ignoring hidden file `%s/%s`\n", + BT_LOGD("Ignoring hidden file `%s" G_DIR_SEPARATOR_S "%s`", ctf_fs_trace->path->str, basename); continue; } /* Create the file. */ - file = ctf_fs_file_create(ctf_fs); + file = ctf_fs_file_create(); if (!file) { - PERR("Cannot create stream file object for file `%s/%s`\n", + BT_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S "%s`", ctf_fs_trace->path->str, basename); goto error; } /* Create full path string. */ - g_string_append_printf(file->path, "%s/%s", + g_string_append_printf(file->path, "%s" G_DIR_SEPARATOR_S "%s", ctf_fs_trace->path->str, basename); if (!g_file_test(file->path->str, G_FILE_TEST_IS_REGULAR)) { - PDBG("Ignoring non-regular file `%s`\n", + BT_LOGD("Ignoring non-regular file `%s`", file->path->str); ctf_fs_file_destroy(file); file = NULL; continue; } - ret = ctf_fs_file_open(ctf_fs, file, "rb"); + ret = ctf_fs_file_open(file, "rb"); if (ret) { - PERR("Cannot open stream file `%s`\n", file->path->str); + BT_LOGE("Cannot open stream file `%s`", file->path->str); goto error; } if (file->size == 0) { /* Skip empty stream. */ - PDBG("Ignoring empty file `%s`\n", file->path->str); + BT_LOGD("Ignoring empty file `%s`", file->path->str); ctf_fs_file_destroy(file); - file = NULL; continue; } - ret = create_one_port_for_trace(ctf_fs_trace, file->path->str); + ret = add_ds_file_to_ds_file_group(ctf_fs_trace, + file->path->str); if (ret) { - PERR("Cannot create output port for file `%s`\n", + BT_LOGE("Cannot add stream file `%s` to stream file group", file->path->str); + ctf_fs_file_destroy(file); goto error; } ctf_fs_file_destroy(file); - file = NULL; + } + + /* + * At this point, DS file groupes are created, but their + * associated stream objects do not exist yet. This is because + * we need to name the created stream object with the data + * stream file's path. We have everything we need here to do + * this. + */ + for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { + struct ctf_fs_ds_file_group *ds_file_group = + g_ptr_array_index(ctf_fs_trace->ds_file_groups, i); + GString *name = get_stream_instance_unique_name(ds_file_group); + + if (!name) { + goto error; + } + + if (ds_file_group->stream_id == -1ULL) { + /* No stream ID: use 0 */ + ds_file_group->stream = bt_stream_create( + ds_file_group->stream_class, name->str, + ctf_fs_trace->next_stream_id); + ctf_fs_trace->next_stream_id++; + } else { + /* Specific stream ID */ + ds_file_group->stream = bt_stream_create( + ds_file_group->stream_class, name->str, + ds_file_group->stream_id); + } + + g_string_free(name, TRUE); + + if (!ds_file_group->stream) { + BT_LOGE("Cannot create stream for DS file group: " + "addr=%p, stream-name=\"%s\"", + ds_file_group, name->str); + goto error; + } } goto end; @@ -324,7 +915,6 @@ end: g_error_free(error); } - ctf_fs_file_destroy(file); return ret; } @@ -335,26 +925,25 @@ int create_cc_prio_map(struct ctf_fs_trace *ctf_fs_trace) size_t i; int count; - assert(ctf_fs_trace); + BT_ASSERT(ctf_fs_trace); ctf_fs_trace->cc_prio_map = bt_clock_class_priority_map_create(); if (!ctf_fs_trace->cc_prio_map) { ret = -1; goto end; } - count = bt_ctf_trace_get_clock_class_count( + count = bt_trace_get_clock_class_count( ctf_fs_trace->metadata->trace); - assert(count >= 0); + BT_ASSERT(count >= 0); for (i = 0; i < count; i++) { - struct bt_ctf_clock_class *clock_class = - bt_ctf_trace_get_clock_class_by_index( + struct bt_clock_class *clock_class = + bt_trace_borrow_clock_class_by_index( ctf_fs_trace->metadata->trace, i); - assert(clock_class); + BT_ASSERT(clock_class); ret = bt_clock_class_priority_map_add_clock_class( ctf_fs_trace->cc_prio_map, clock_class, 0); - BT_PUT(clock_class); if (ret) { goto end; @@ -365,9 +954,9 @@ end: return ret; } -static -struct ctf_fs_trace *ctf_fs_trace_create(struct ctf_fs_component *ctf_fs, - const char *path, const char *name) +BT_HIDDEN +struct ctf_fs_trace *ctf_fs_trace_create(const char *path, const char *name, + struct ctf_fs_metadata_config *metadata_config) { struct ctf_fs_trace *ctf_fs_trace; int ret; @@ -377,7 +966,6 @@ struct ctf_fs_trace *ctf_fs_trace_create(struct ctf_fs_component *ctf_fs, goto end; } - ctf_fs_trace->ctf_fs = ctf_fs; ctf_fs_trace->path = g_string_new(path); if (!ctf_fs_trace->path) { goto error; @@ -393,21 +981,34 @@ struct ctf_fs_trace *ctf_fs_trace_create(struct ctf_fs_component *ctf_fs, goto error; } - ret = ctf_fs_metadata_set_trace(ctf_fs_trace); + ctf_fs_trace->ds_file_groups = g_ptr_array_new_with_free_func( + (GDestroyNotify) ctf_fs_ds_file_group_destroy); + if (!ctf_fs_trace->ds_file_groups) { + goto error; + } + + ret = ctf_fs_metadata_set_trace(ctf_fs_trace, metadata_config); if (ret) { goto error; } - ret = create_cc_prio_map(ctf_fs_trace); + ret = create_ds_file_groups(ctf_fs_trace); if (ret) { goto error; } - ret = create_ports_for_trace(ctf_fs_trace); + ret = create_cc_prio_map(ctf_fs_trace); if (ret) { goto error; } + /* + * create_ds_file_groups() created all the streams that this + * trace needs. There won't be any more. Therefore it is safe to + * make this trace static. + */ + (void) bt_trace_set_is_static(ctf_fs_trace->metadata->trace); + goto end; error: @@ -428,7 +1029,7 @@ int path_is_ctf_trace(const char *path) goto end; } - g_string_printf(metadata_path, "%s/%s", path, CTF_FS_METADATA_FILENAME); + g_string_printf(metadata_path, "%s" G_DIR_SEPARATOR_S "%s", path, CTF_FS_METADATA_FILENAME); if (g_file_test(metadata_path->str, G_FILE_TEST_IS_REGULAR)) { ret = 1; @@ -441,48 +1042,39 @@ end: } static -int add_trace_path(struct ctf_fs_component *ctf_fs, GList **trace_paths, - const char *path) +int add_trace_path(GList **trace_paths, const char *path) { - GString *path_str = g_string_new(NULL); + GString *norm_path = NULL; int ret = 0; - char *rp = NULL; - if (!path_str) { + norm_path = bt_common_normalize_path(path, NULL); + if (!norm_path) { + BT_LOGE("Failed to normalize path `%s`.", path); ret = -1; goto end; } - /* - * Find the real path so that we don't have relative components - * in the trace name. This also squashes consecutive slashes and - * removes any slash at the end. - */ - rp = realpath(path, NULL); - if (!rp) { - PERR("realpath() failed: %s (%d)\n", strerror(errno), errno); + // FIXME: Remove or ifdef for __MINGW32__ + if (strcmp(norm_path->str, "/") == 0) { + BT_LOGE("Opening a trace in `/` is not supported."); ret = -1; goto end; } - if (strcmp(rp, "/") == 0) { - PERR("Opening a trace in `/` is not supported.\n"); - ret = -1; - goto end; - } - - g_string_assign(path_str, rp); - *trace_paths = g_list_prepend(*trace_paths, path_str); - assert(*trace_paths); + *trace_paths = g_list_prepend(*trace_paths, norm_path); + BT_ASSERT(*trace_paths); + norm_path = NULL; end: - free(rp); + if (norm_path) { + g_string_free(norm_path, TRUE); + } + return ret; } -static -int find_ctf_traces(struct ctf_fs_component *ctf_fs, - GList **trace_paths, const char *start_path) +BT_HIDDEN +int ctf_fs_find_traces(GList **trace_paths, const char *start_path) { int ret; GError *error = NULL; @@ -497,10 +1089,10 @@ int find_ctf_traces(struct ctf_fs_component *ctf_fs, if (ret) { /* - * Do not even recurse: a CTF trace cannot contain - * another CTF trace. + * Stop recursion: a CTF trace cannot contain another + * CTF trace. */ - ret = add_trace_path(ctf_fs, trace_paths, start_path); + ret = add_trace_path(trace_paths, start_path); goto end; } @@ -513,12 +1105,12 @@ int find_ctf_traces(struct ctf_fs_component *ctf_fs, dir = g_dir_open(start_path, 0, &error); if (!dir) { if (error->code == G_FILE_ERROR_ACCES) { - PDBG("Cannot open directory `%s`: %s (code %d): continuing\n", + BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing", start_path, error->message, error->code); goto end; } - PERR("Cannot open directory `%s`: %s (code %d)\n", + BT_LOGE("Cannot open directory `%s`: %s (code %d)", start_path, error->message, error->code); ret = -1; goto end; @@ -532,8 +1124,8 @@ int find_ctf_traces(struct ctf_fs_component *ctf_fs, goto end; } - g_string_printf(sub_path, "%s/%s", start_path, basename); - ret = find_ctf_traces(ctf_fs, trace_paths, sub_path->str); + g_string_printf(sub_path, "%s" G_DIR_SEPARATOR_S "%s", start_path, basename); + ret = ctf_fs_find_traces(trace_paths, sub_path->str); g_string_free(sub_path, TRUE); if (ret) { goto end; @@ -552,69 +1144,53 @@ end: return ret; } -static -GList *create_trace_names(GList *trace_paths) { +BT_HIDDEN +GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path) { GList *trace_names = NULL; - size_t chars_to_strip = 0; - size_t at = 0; GList *node; - bool done = false; + const char *last_sep; + size_t base_dist; /* - * Find the number of characters to strip from the beginning, - * that is, the longest prefix until a common slash (also - * stripped). + * At this point we know that all the trace paths are + * normalized, and so is the base path. This means that + * they are absolute and they don't end with a separator. + * We can simply find the location of the last separator + * in the base path, which gives us the name of the actual + * directory to look into, and use this location as the + * start of each trace name within each trace path. + * + * For example: + * + * Base path: /home/user/my-traces/some-trace + * Trace paths: + * - /home/user/my-traces/some-trace/host1/trace1 + * - /home/user/my-traces/some-trace/host1/trace2 + * - /home/user/my-traces/some-trace/host2/trace + * - /home/user/my-traces/some-trace/other-trace + * + * In this case the trace names are: + * + * - some-trace/host1/trace1 + * - some-trace/host1/trace2 + * - some-trace/host2/trace + * - some-trace/other-trace */ - while (true) { - gchar common_ch = '\0'; - - for (node = trace_paths; node; node = g_list_next(node)) { - GString *gstr = node->data; - gchar this_ch = gstr->str[at]; - - if (this_ch == '\0') { - done = true; - break; - } - - if (common_ch == '\0') { - /* - * Establish the expected common - * character at this position. - */ - common_ch = this_ch; - continue; - } - - if (this_ch != common_ch) { - done = true; - break; - } - } - - if (done) { - break; - } + last_sep = strrchr(base_path, G_DIR_SEPARATOR); - if (common_ch == '/') { - /* - * Common character is a slash: safe to include - * this slash in the number of characters to - * strip because the paths are guaranteed not to - * end with slash. - */ - chars_to_strip = at + 1; - } + /* We know there's at least one separator */ + BT_ASSERT(last_sep); - at++; - } + /* Distance to base */ + base_dist = last_sep - base_path + 1; /* Create the trace names */ for (node = trace_paths; node; node = g_list_next(node)) { GString *trace_name = g_string_new(NULL); GString *trace_path = node->data; - g_string_assign(trace_name, &trace_path->str[chars_to_strip]); + BT_ASSERT(trace_name); + g_string_assign(trace_name, &trace_path->str[base_dist]); trace_names = g_list_append(trace_names, trace_name); } @@ -627,25 +1203,33 @@ int create_ctf_fs_traces(struct ctf_fs_component *ctf_fs, { struct ctf_fs_trace *ctf_fs_trace = NULL; int ret = 0; + GString *norm_path = NULL; GList *trace_paths = NULL; GList *trace_names = NULL; GList *tp_node; GList *tn_node; - ret = find_ctf_traces(ctf_fs, &trace_paths, path_param); + norm_path = bt_common_normalize_path(path_param, NULL); + if (!norm_path) { + BT_LOGE("Failed to normalize path: `%s`.", + path_param); + goto error; + } + + ret = ctf_fs_find_traces(&trace_paths, norm_path->str); if (ret) { goto error; } if (!trace_paths) { - PERR("No CTF traces recursively found in `%s`.\n", + BT_LOGE("No CTF traces recursively found in `%s`.", path_param); goto error; } - trace_names = create_trace_names(trace_paths); + trace_names = ctf_fs_create_trace_names(trace_paths, norm_path->str); if (!trace_names) { - PERR("Cannot create trace names from trace paths.\n"); + BT_LOGE("Cannot create trace names from trace paths."); goto error; } @@ -655,17 +1239,23 @@ int create_ctf_fs_traces(struct ctf_fs_component *ctf_fs, GString *trace_path = tp_node->data; GString *trace_name = tn_node->data; - ctf_fs_trace = ctf_fs_trace_create(ctf_fs, trace_path->str, - trace_name->str); + ctf_fs_trace = ctf_fs_trace_create(trace_path->str, + trace_name->str, &ctf_fs->metadata_config); if (!ctf_fs_trace) { - PERR("Cannot create trace for `%s`.\n", + BT_LOGE("Cannot create trace for `%s`.", trace_path->str); goto error; } + + ret = create_ports_for_trace(ctf_fs, ctf_fs_trace); + if (ret) { + goto error; + } + + g_ptr_array_add(ctf_fs->traces, ctf_fs_trace); + ctf_fs_trace = NULL; } - g_ptr_array_add(ctf_fs->traces, ctf_fs_trace); - ctf_fs_trace = NULL; goto end; error: @@ -693,6 +1283,10 @@ end: g_list_free(trace_names); } + if (norm_path) { + g_string_free(norm_path, TRUE); + } + return ret; } @@ -703,7 +1297,8 @@ struct ctf_fs_component *ctf_fs_create(struct bt_private_component *priv_comp, struct ctf_fs_component *ctf_fs; struct bt_value *value = NULL; const char *path_param; - int ret; + enum bt_component_status ret; + enum bt_value_status value_ret; ctf_fs = g_new0(struct ctf_fs_component, 1); if (!ctf_fs) { @@ -711,7 +1306,7 @@ struct ctf_fs_component *ctf_fs_create(struct bt_private_component *priv_comp, } ret = bt_private_component_set_user_data(priv_comp, ctf_fs); - assert(ret == 0); + BT_ASSERT(ret == BT_COMPONENT_STATUS_OK); /* * We don't need to get a new reference here because as long as @@ -719,58 +1314,47 @@ struct ctf_fs_component *ctf_fs_create(struct bt_private_component *priv_comp, * private component should also exist. */ ctf_fs->priv_comp = priv_comp; - value = bt_value_map_get(params, "path"); - if (!bt_value_is_string(value)) { + value = bt_value_map_borrow(params, "path"); + if (value && !bt_value_is_string(value)) { goto error; } - ret = bt_value_string_get(value, &path_param); - assert(ret == 0); - BT_PUT(value); - value = bt_value_map_get(params, "offset-s"); + value_ret = bt_value_string_get(value, &path_param); + BT_ASSERT(value_ret == BT_VALUE_STATUS_OK); + value = bt_value_map_borrow(params, "clock-class-offset-s"); if (value) { - int64_t offset; - if (!bt_value_is_integer(value)) { - fprintf(stderr, - "offset-s should be an integer\n"); + BT_LOGE("clock-class-offset-s should be an integer"); goto error; } - ret = bt_value_integer_get(value, &offset); - assert(ret == 0); - ctf_fs->options.clock_offset = offset; - BT_PUT(value); + value_ret = bt_value_integer_get(value, + &ctf_fs->metadata_config.clock_class_offset_s); + BT_ASSERT(value_ret == BT_VALUE_STATUS_OK); } - value = bt_value_map_get(params, "offset-ns"); + value = bt_value_map_borrow(params, "clock-class-offset-ns"); if (value) { - int64_t offset; - if (!bt_value_is_integer(value)) { - fprintf(stderr, - "offset-ns should be an integer\n"); + BT_LOGE("clock-class-offset-ns should be an integer"); goto error; } - ret = bt_value_integer_get(value, &offset); - assert(ret == 0); - ctf_fs->options.clock_offset_ns = offset; - BT_PUT(value); + value_ret = bt_value_integer_get(value, + &ctf_fs->metadata_config.clock_class_offset_ns); + BT_ASSERT(value_ret == BT_VALUE_STATUS_OK); } - ctf_fs->error_fp = stderr; - ctf_fs->page_size = (size_t) getpagesize(); ctf_fs->port_data = g_ptr_array_new_with_free_func(port_data_destroy); if (!ctf_fs->port_data) { goto error; } - ctf_fs->traces = g_ptr_array_new_with_free_func(ctf_fs_trace_destroy); + ctf_fs->traces = g_ptr_array_new_with_free_func( + ctf_fs_trace_destroy_notifier); if (!ctf_fs->traces) { goto error; } - ret = create_ctf_fs_traces(ctf_fs, path_param); - if (ret) { + if (create_ctf_fs_traces(ctf_fs, path_param)) { goto error; } @@ -780,10 +1364,9 @@ error: ctf_fs_destroy(ctf_fs); ctf_fs = NULL; ret = bt_private_component_set_user_data(priv_comp, NULL); - assert(ret == 0); + BT_ASSERT(ret == BT_COMPONENT_STATUS_OK); end: - bt_put(value); return ctf_fs; } @@ -794,7 +1377,6 @@ enum bt_component_status ctf_fs_init(struct bt_private_component *priv_comp, struct ctf_fs_component *ctf_fs; enum bt_component_status ret = BT_COMPONENT_STATUS_OK; - ctf_fs_debug = g_strcmp0(getenv("CTF_FS_DEBUG"), "1") == 0; ctf_fs = ctf_fs_create(priv_comp, params); if (!ctf_fs) { ret = BT_COMPONENT_STATUS_ERROR; @@ -804,128 +1386,25 @@ enum bt_component_status ctf_fs_init(struct bt_private_component *priv_comp, } BT_HIDDEN -struct bt_value *ctf_fs_query(struct bt_component_class *comp_class, +struct bt_component_class_query_method_return ctf_fs_query( + struct bt_component_class *comp_class, + struct bt_query_executor *query_exec, const char *object, struct bt_value *params) { - struct bt_value *results = NULL; - struct bt_value *path_value = NULL; - char *metadata_text = NULL; - FILE *metadata_fp = NULL; - GString *g_metadata_text = NULL; - - if (strcmp(object, "metadata-info") == 0) { - int ret; - int bo; - const char *path; - bool is_packetized; - - results = bt_value_map_create(); - if (!results) { - goto error; - } - - if (!bt_value_is_map(params)) { - fprintf(stderr, - "Query parameters is not a map value object\n"); - goto error; - } - - path_value = bt_value_map_get(params, "path"); - ret = bt_value_string_get(path_value, &path); - if (ret) { - fprintf(stderr, - "Cannot get `path` string parameter\n"); - goto error; - } - - assert(path); - metadata_fp = ctf_fs_metadata_open_file(path); - if (!metadata_fp) { - fprintf(stderr, - "Cannot open trace at path `%s`\n", path); - goto error; - } - - is_packetized = ctf_metadata_decoder_is_packetized(metadata_fp, - &bo); - - if (is_packetized) { - ret = ctf_metadata_decoder_packetized_file_stream_to_buf( - metadata_fp, &metadata_text, bo); - if (ret) { - fprintf(stderr, - "Cannot decode packetized metadata file\n"); - goto error; - } - } else { - long filesize; - - fseek(metadata_fp, 0, SEEK_END); - filesize = ftell(metadata_fp); - rewind(metadata_fp); - metadata_text = malloc(filesize + 1); - if (!metadata_text) { - fprintf(stderr, - "Cannot allocate buffer for metadata text\n"); - goto error; - } - - if (fread(metadata_text, filesize, 1, metadata_fp) != - 1) { - fprintf(stderr, - "Cannot read metadata file\n"); - goto error; - } - - metadata_text[filesize] = '\0'; - } - - g_metadata_text = g_string_new(NULL); - if (!g_metadata_text) { - goto error; - } - - if (strncmp(metadata_text, METADATA_TEXT_SIG, - sizeof(METADATA_TEXT_SIG) - 1) != 0) { - g_string_assign(g_metadata_text, METADATA_TEXT_SIG); - g_string_append(g_metadata_text, " */\n\n"); - } - - g_string_append(g_metadata_text, metadata_text); - - ret = bt_value_map_insert_string(results, "text", - g_metadata_text->str); - if (ret) { - fprintf(stderr, "Cannot insert metadata text into results\n"); - goto error; - } - - ret = bt_value_map_insert_bool(results, "is-packetized", - is_packetized); - if (ret) { - fprintf(stderr, "Cannot insert is packetized into results\n"); - goto error; - } + struct bt_component_class_query_method_return ret = { + .result = NULL, + .status = BT_QUERY_STATUS_OK, + }; + + if (!strcmp(object, "metadata-info")) { + ret = metadata_info_query(comp_class, params); + } else if (!strcmp(object, "trace-info")) { + ret = trace_info_query(comp_class, params); } else { - fprintf(stderr, "Unknown query object `%s`\n", object); - goto error; + BT_LOGE("Unknown query object `%s`", object); + ret.status = BT_QUERY_STATUS_INVALID_OBJECT; + goto end; } - - goto end; - -error: - BT_PUT(results); - end: - bt_put(path_value); - free(metadata_text); - - if (g_metadata_text) { - g_string_free(g_metadata_text, TRUE); - } - - if (metadata_fp) { - fclose(metadata_fp); - } - return results; + return ret; }