* SOFTWARE.
*/
-#include <babeltrace/common-internal.h>
-#include <babeltrace/babeltrace.h>
+#include <babeltrace2/common-internal.h>
+#include <babeltrace2/babeltrace.h>
+#include <babeltrace2/compat/uuid-internal.h>
#include <plugins-common.h>
#include <glib.h>
-#include <babeltrace/assert-internal.h>
+#include <babeltrace2/assert-internal.h>
#include <inttypes.h>
#include <stdbool.h>
#include "fs.h"
bt_self_component_source_as_self_component(component)));
}
-static
-GString *get_stream_instance_unique_name(
- struct ctf_fs_ds_file_group *ds_file_group)
+gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group)
{
- GString *name;
- struct ctf_fs_ds_file_info *ds_file_info;
+ GString *name = g_string_new(NULL);
- name = g_string_new(NULL);
- if (!name) {
- goto end;
+ /*
+ * The unique port name is generated by concatenating unique identifiers
+ * for:
+ *
+ * - the trace
+ * - the stream class
+ * - the stream
+ */
+
+ /* For the trace, use the uuid if present, else the path. */
+ if (ds_file_group->ctf_fs_trace->metadata->tc->is_uuid_set) {
+ char uuid_str[BABELTRACE_UUID_STR_LEN];
+
+ bt_uuid_unparse(ds_file_group->ctf_fs_trace->metadata->tc->uuid, uuid_str);
+ g_string_assign(name, uuid_str);
+ } else {
+ g_string_assign(name, ds_file_group->ctf_fs_trace->path->str);
}
/*
- * 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.
+ * For the stream class, use the id if present. We can omit this field
+ * otherwise, as there will only be a single stream class.
*/
- 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);
+ if (ds_file_group->sc->id != UINT64_C(-1)) {
+ g_string_append_printf(name, " | %" PRIu64, ds_file_group->sc->id);
+ }
-end:
- return name;
+ /* For the stream, use the id if present, else, use the path. */
+ if (ds_file_group->stream_id != UINT64_C(-1)) {
+ g_string_append_printf(name, " | %" PRIu64, ds_file_group->stream_id);
+ } else {
+ BT_ASSERT(ds_file_group->ds_file_infos->len == 1);
+ struct ctf_fs_ds_file_info *ds_file_info =
+ g_ptr_array_index(ds_file_group->ds_file_infos, 0);
+ g_string_append_printf(name, " | %s", ds_file_info->path->str);
+ }
+
+ return g_string_free(name, FALSE);
}
static
{
int ret = 0;
struct ctf_fs_port_data *port_data = NULL;
- GString *port_name = NULL;
+ gchar *port_name;
- port_name = get_stream_instance_unique_name(ds_file_group);
+ port_name = ctf_fs_make_port_name(ds_file_group);
if (!port_name) {
goto error;
}
- BT_LOGD("Creating one port named `%s`", port_name->str);
+ BT_LOGD("Creating one port named `%s`", port_name);
/* Create output port for this file */
port_data = g_new0(struct ctf_fs_port_data, 1);
port_data->ctf_fs = ctf_fs;
port_data->ds_file_group = ds_file_group;
ret = bt_self_component_source_add_output_port(
- ctf_fs->self_comp, port_name->str, port_data, NULL);
+ ctf_fs->self_comp, port_name, port_data, NULL);
if (ret) {
goto error;
}
end:
if (port_name) {
- g_string_free(port_name, TRUE);
+ g_free(port_name);
}
port_data_destroy(port_data);
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,
- int64_t begin_ns, struct ctf_fs_ds_index *index)
+ int64_t begin_ns)
{
struct ctf_fs_ds_file_info *ds_file_info;
}
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;
}
g_ptr_array_free(ds_file_group->ds_file_infos, TRUE);
}
+ if (ds_file_group->index) {
+ if (ds_file_group->index->entries) {
+ g_ptr_array_free(ds_file_group->index->entries, TRUE);
+ }
+ g_free(ds_file_group->index);
+ }
+
bt_stream_put_ref(ds_file_group->stream);
g_free(ds_file_group);
}
struct ctf_fs_ds_file_group *ctf_fs_ds_file_group_create(
struct ctf_fs_trace *ctf_fs_trace,
struct ctf_stream_class *sc,
- uint64_t stream_instance_id)
+ uint64_t stream_instance_id,
+ struct ctf_fs_ds_index *index)
{
struct ctf_fs_ds_file_group *ds_file_group;
goto error;
}
+ ds_file_group->index = index;
+
ds_file_group->stream_id = stream_instance_id;
BT_ASSERT(sc);
ds_file_group->sc = sc;
error:
ctf_fs_ds_file_group_destroy(ds_file_group);
+ ctf_fs_ds_index_destroy(index);
ds_file_group = NULL;
end:
(original_array_len - pos) * sizeof(gpointer));
}
- /* Insert the value and bump the array len */
+ /* Insert the value. */
array->pdata[pos] = element;
}
+/*
+ * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
+ * place to keep it sorted.
+ */
+
static
-int ctf_fs_ds_file_group_add_ds_file_info(
+void ds_file_group_insert_ds_file_info_sorted(
struct ctf_fs_ds_file_group *ds_file_group,
- const char *path, int64_t begin_ns,
- struct ctf_fs_ds_index *index)
+ struct ctf_fs_ds_file_info *ds_file_info)
{
- 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;
- }
+ guint i;
- /* Find a spot to insert this one */
+ /* Find the spot where to insert this ds_file_info. */
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) {
+ if (ds_file_info->begin_ns < other_ds_file_info->begin_ns) {
break;
}
}
array_insert(ds_file_group->ds_file_infos, ds_file_info, i);
+}
+
+static
+void ds_file_group_insert_ds_index_entry_sorted(
+ struct ctf_fs_ds_file_group *ds_file_group,
+ struct ctf_fs_ds_index_entry *entry)
+{
+ guint i;
+
+ /* Find the spot where to insert this index entry. */
+ for (i = 0; i < ds_file_group->index->entries->len; i++) {
+ struct ctf_fs_ds_index_entry *other_entry = g_ptr_array_index(
+ ds_file_group->index->entries, i);
+
+ if (entry->timestamp_begin_ns < other_entry->timestamp_begin_ns) {
+ break;
+ }
+ }
+
+ array_insert(ds_file_group->index->entries, entry, i);
+}
+
+/*
+ * Create a new ds_file_info using the provided path, begin_ns and index, then
+ * add it to ds_file_group's list of ds_file_infos.
+ */
+
+static
+int ctf_fs_ds_file_group_add_ds_file_info(
+ struct ctf_fs_ds_file_group *ds_file_group,
+ const char *path, int64_t begin_ns)
+{
+ struct ctf_fs_ds_file_info *ds_file_info;
+ int ret = 0;
+
+ ds_file_info = ctf_fs_ds_file_info_create(path, begin_ns);
+ if (!ds_file_info) {
+ goto error;
+ }
+
+ ds_file_group_insert_ds_file_info_sorted(ds_file_group, ds_file_info);
+
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;
* group.
*/
ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace,
- sc, UINT64_C(-1));
+ sc, UINT64_C(-1), index);
+ /* Ownership of index is transferred. */
+ index = NULL;
+
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;
+ path, begin_ns);
if (ret) {
goto error;
}
if (!ds_file_group) {
ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace,
- sc, stream_instance_id);
+ sc, stream_instance_id, index);
+ /* Ownership of index is transferred. */
+ index = NULL;
if (!ds_file_group) {
goto error;
}
}
ret = ctf_fs_ds_file_group_add_ds_file_info(ds_file_group, path,
- begin_ns, index);
- index = NULL;
+ begin_ns);
if (ret) {
goto error;
}
error:
ctf_fs_ds_file_group_destroy(ds_file_group);
+ ds_file_group = NULL;
ret = -1;
end:
return ret;
}
+/* GCompareFunc to sort traces by UUID. */
+
+static
+gint sort_traces_by_uuid(gconstpointer a, gconstpointer b)
+{
+ const struct ctf_fs_trace *trace_a = *((const struct ctf_fs_trace **) a);
+ const struct ctf_fs_trace *trace_b = *((const struct ctf_fs_trace **) b);
+
+ bool trace_a_has_uuid = trace_a->metadata->tc->is_uuid_set;
+ bool trace_b_has_uuid = trace_b->metadata->tc->is_uuid_set;
+ gint ret;
+
+ /* Order traces without uuid first. */
+ if (!trace_a_has_uuid && trace_b_has_uuid) {
+ ret = -1;
+ } else if (trace_a_has_uuid && !trace_b_has_uuid) {
+ ret = 1;
+ } else if (!trace_a_has_uuid && !trace_b_has_uuid) {
+ ret = 0;
+ } else {
+ ret = bt_uuid_compare(trace_a->metadata->tc->uuid, trace_b->metadata->tc->uuid);
+ }
+
+ return ret;
+}
+
+/*
+ * Count the number of stream and event classes defined by this trace's metadata.
+ *
+ * This is used to determine which metadata is the "latest", out of multiple
+ * traces sharing the same UUID. It is assumed that amongst all these metadatas,
+ * a bigger metadata is a superset of a smaller metadata. Therefore, it is
+ * enough to just count the classes.
+ */
+
+static
+unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace *trace)
+{
+ unsigned int num = trace->metadata->tc->stream_classes->len;
+ guint i;
+
+ for (i = 0; i < trace->metadata->tc->stream_classes->len; i++) {
+ struct ctf_stream_class *sc = trace->metadata->tc->stream_classes->pdata[i];
+ num += sc->event_classes->len;
+ }
+
+ return num;
+}
+
+/*
+ * Merge the src ds_file_group into dest. This consists of merging their
+ * ds_file_infos, making sure to keep the result sorted.
+ */
+
+static
+void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group *dest, struct ctf_fs_ds_file_group *src)
+{
+ guint i;
+
+ for (i = 0; i < src->ds_file_infos->len; i++) {
+ struct ctf_fs_ds_file_info *ds_file_info =
+ g_ptr_array_index(src->ds_file_infos, i);
+
+ /* Ownership of the ds_file_info is transferred to dest. */
+ g_ptr_array_index(src->ds_file_infos, i) = NULL;
+
+ ds_file_group_insert_ds_file_info_sorted(dest, ds_file_info);
+ }
+
+ /* Merge both indexes. */
+ for (i = 0; i < src->index->entries->len; i++) {
+ struct ctf_fs_ds_index_entry *entry = g_ptr_array_index(
+ src->index->entries, i);
+
+ /*
+ * Ownership of the ctf_fs_ds_index_entry is transferred to
+ * dest.
+ */
+ g_ptr_array_index(src->index->entries, i) = NULL;
+
+ ds_file_group_insert_ds_index_entry_sorted(dest, entry);
+ }
+}
+/* Merge src_trace's data stream file groups into dest_trace's. */
+
+static
+int merge_matching_ctf_fs_ds_file_groups(
+ struct ctf_fs_trace *dest_trace,
+ struct ctf_fs_trace *src_trace)
+{
+
+ GPtrArray *dest = dest_trace->ds_file_groups;
+ GPtrArray *src = src_trace->ds_file_groups;
+ guint s_i;
+ int ret = 0;
+
+ /*
+ * Save the initial length of dest: we only want to check against the
+ * original elements in the inner loop.
+ */
+ const guint dest_len = dest->len;
+
+ for (s_i = 0; s_i < src->len; s_i++) {
+ struct ctf_fs_ds_file_group *src_group = g_ptr_array_index(src, s_i);
+ struct ctf_fs_ds_file_group *dest_group = NULL;
+
+ /* A stream instance without ID can't match a stream in the other trace. */
+ if (src_group->stream_id != -1) {
+ guint d_i;
+
+ /* Let's search for a matching ds_file_group in the destination. */
+ for (d_i = 0; d_i < dest_len; d_i++) {
+ struct ctf_fs_ds_file_group *candidate_dest = g_ptr_array_index(dest, d_i);
+
+ /* Can't match a stream instance without ID. */
+ if (candidate_dest->stream_id == -1) {
+ continue;
+ }
+
+ /*
+ * If the two groups have the same stream instance id
+ * and belong to the same stream class (stream instance
+ * ids are per-stream class), they represent the same
+ * stream instance.
+ */
+ if (candidate_dest->stream_id != src_group->stream_id ||
+ candidate_dest->sc->id != src_group->sc->id) {
+ continue;
+ }
+
+ dest_group = candidate_dest;
+ break;
+ }
+ }
+
+ /*
+ * Didn't find a friend in dest to merge our src_group into?
+ * Create a new empty one. This can happen if a stream was
+ * active in the source trace chunk but not in the destination
+ * trace chunk.
+ */
+ if (!dest_group) {
+ struct ctf_stream_class *sc;
+ struct ctf_fs_ds_index *index;
+
+ sc = ctf_trace_class_borrow_stream_class_by_id(
+ dest_trace->metadata->tc, src_group->sc->id);
+ BT_ASSERT(sc);
+
+ index = ctf_fs_ds_index_create();
+ if (!index) {
+ ret = -1;
+ goto end;
+ }
+
+ dest_group = ctf_fs_ds_file_group_create(dest_trace, sc,
+ src_group->stream_id, index);
+ /* Ownership of index is transferred. */
+ index = NULL;
+ if (!dest_group) {
+ ret = -1;
+ goto end;
+ }
+
+ g_ptr_array_add(dest_trace->ds_file_groups, dest_group);
+ }
+
+ BT_ASSERT(dest_group);
+ merge_ctf_fs_ds_file_groups(dest_group, src_group);
+ }
+
+end:
+ return ret;
+}
+
+/*
+ * Collapse the given traces, which must all share the same UUID, in a single
+ * one.
+ *
+ * The trace with the most expansive metadata is chosen and all other traces
+ * are merged into that one. The array slots of all the traces that get merged
+ * in the chosen one are set to NULL, so only the slot of the chosen trace
+ * remains non-NULL.
+ */
+
+static
+int merge_ctf_fs_traces(struct ctf_fs_trace **traces, unsigned int num_traces)
+{
+ unsigned int winner_count;
+ struct ctf_fs_trace *winner;
+ guint i;
+ int ret = 0;
+ char uuid_str[BABELTRACE_UUID_STR_LEN];
+
+ BT_ASSERT(num_traces >= 2);
+
+ winner_count = metadata_count_stream_and_event_classes(traces[0]);
+ winner = traces[0];
+
+ /* Find the trace with the largest metadata. */
+ for (i = 1; i < num_traces; i++) {
+ struct ctf_fs_trace *candidate;
+ unsigned int candidate_count;
+
+ candidate = traces[i];
+
+ /* A bit of sanity check. */
+ BT_ASSERT(bt_uuid_compare(winner->metadata->tc->uuid, candidate->metadata->tc->uuid) == 0);
+
+ candidate_count = metadata_count_stream_and_event_classes(candidate);
+
+ if (candidate_count > winner_count) {
+ winner_count = candidate_count;
+ winner = candidate;
+ }
+ }
+
+ /* Merge all the other traces in the winning trace. */
+ for (i = 0; i < num_traces; i++) {
+ struct ctf_fs_trace *trace = traces[i];
+
+ /* Don't merge the winner into itself. */
+ if (trace == winner) {
+ continue;
+ }
+
+ /* Merge trace's data stream file groups into winner's. */
+ ret = merge_matching_ctf_fs_ds_file_groups(winner, trace);
+ if (ret) {
+ goto end;
+ }
+
+ /* Free the trace that got merged into winner, clear the slot in the array. */
+ ctf_fs_trace_destroy(trace);
+ traces[i] = NULL;
+ }
+
+ /* Use the string representation of the UUID as the trace name. */
+ bt_uuid_unparse(winner->metadata->tc->uuid, uuid_str);
+ g_string_printf(winner->name, "%s", uuid_str);
+
+end:
+ return ret;
+}
+
+/*
+ * Merge all traces of `ctf_fs` that share the same UUID in a single trace.
+ * Traces with no UUID are not merged.
+ */
+
+static
+int merge_traces_with_same_uuid(struct ctf_fs_component *ctf_fs)
+{
+ GPtrArray *traces = ctf_fs->traces;
+ guint range_start_idx = 0;
+ unsigned int num_traces = 0;
+ guint i;
+ int ret = 0;
+
+ /* Sort the traces by uuid, then collapse traces with the same uuid in a single one. */
+ g_ptr_array_sort(traces, sort_traces_by_uuid);
+
+ /* Find ranges of consecutive traces that share the same UUID. */
+ while (range_start_idx < traces->len) {
+ guint range_len;
+ struct ctf_fs_trace *range_start_trace = g_ptr_array_index(traces, range_start_idx);
+
+ /* Exclusive end of range. */
+ guint range_end_exc_idx = range_start_idx + 1;
+
+ while (range_end_exc_idx < traces->len) {
+ struct ctf_fs_trace *this_trace = g_ptr_array_index(traces, range_end_exc_idx);
+
+ if (!range_start_trace->metadata->tc->is_uuid_set ||
+ (bt_uuid_compare(range_start_trace->metadata->tc->uuid, this_trace->metadata->tc->uuid) != 0)) {
+ break;
+ }
+
+ range_end_exc_idx++;
+ }
+
+ /* If we have two or more traces with matching UUIDs, merge them. */
+ range_len = range_end_exc_idx - range_start_idx;
+ if (range_len > 1) {
+ struct ctf_fs_trace **range_start = (struct ctf_fs_trace **) &traces->pdata[range_start_idx];
+ ret = merge_ctf_fs_traces(range_start, range_len);
+ if (ret) {
+ goto end;
+ }
+ }
+
+ num_traces++;
+ range_start_idx = range_end_exc_idx;
+ }
+
+ /* Clear any NULL slot (traces that got merged in another one) in the array. */
+ for (i = 0; i < traces->len;) {
+ if (g_ptr_array_index(traces, i) == NULL) {
+ g_ptr_array_remove_index_fast(traces, i);
+ } else {
+ i++;
+ }
+ }
+
+ BT_ASSERT(num_traces == traces->len);
+
+end:
+ return ret;
+}
+
int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp,
struct ctf_fs_component *ctf_fs,
const bt_value *paths_value)
}
}
+ ret = merge_traces_with_same_uuid(ctf_fs);
+
end:
return ret;
}
+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;
+ }
+
+ /*
+ * 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;
+}
+
/* Create the IR stream objects for ctf_fs_trace. */
static
return ret;
}
+/*
+ * Validate the "paths" parameter passed to this component. It must be
+ * present, and it must be an array of strings.
+ */
+
+static
bool validate_paths_parameter(const bt_value *paths)
{
bool ret;
return ret;
}
+bool read_src_fs_parameters(const bt_value *params,
+ const bt_value **paths, struct ctf_fs_component *ctf_fs) {
+ bool ret;
+ const bt_value *value;
+
+ /* paths parameter */
+ *paths = bt_value_map_borrow_entry_value_const(params, "paths");
+ if (!validate_paths_parameter(*paths)) {
+ goto error;
+ }
+
+ /* clock-class-offset-s parameter */
+ value = bt_value_map_borrow_entry_value_const(params,
+ "clock-class-offset-s");
+ if (value) {
+ if (!bt_value_is_signed_integer(value)) {
+ BT_LOGE("clock-class-offset-s must be an integer");
+ goto error;
+ }
+ ctf_fs->metadata_config.clock_class_offset_s =
+ bt_value_signed_integer_get(value);
+ }
+
+ /* clock-class-offset-ns parameter */
+ value = bt_value_map_borrow_entry_value_const(params,
+ "clock-class-offset-ns");
+ if (value) {
+ if (!bt_value_is_signed_integer(value)) {
+ BT_LOGE("clock-class-offset-ns must be an integer");
+ goto error;
+ }
+ ctf_fs->metadata_config.clock_class_offset_ns =
+ bt_value_signed_integer_get(value);
+ }
+
+
+ ret = true;
+ goto end;
+
+error:
+ ret = false;
+
+end:
+ return ret;
+}
+
static
struct ctf_fs_component *ctf_fs_create(
bt_self_component_source *self_comp,
const bt_value *params)
{
struct ctf_fs_component *ctf_fs = NULL;
- const bt_value *value = NULL;
guint i;
const bt_value *paths_value;
- paths_value = bt_value_map_borrow_entry_value_const(params, "paths");
- if (!validate_paths_parameter(paths_value)) {
+ ctf_fs = ctf_fs_component_create();
+ if (!ctf_fs) {
goto error;
}
- ctf_fs = ctf_fs_component_create();
- if (!ctf_fs) {
+ if (!read_src_fs_parameters(params, &paths_value, ctf_fs)) {
goto error;
}
*/
ctf_fs->self_comp = self_comp;
- value = bt_value_map_borrow_entry_value_const(params,
- "clock-class-offset-s");
- if (value) {
- if (!bt_value_is_integer(value)) {
- BT_LOGE("clock-class-offset-s should be an integer");
- goto error;
- }
- ctf_fs->metadata_config.clock_class_offset_s = bt_value_integer_get(value);
- }
-
- value = bt_value_map_borrow_entry_value_const(params,
- "clock-class-offset-ns");
- if (value) {
- if (!bt_value_is_integer(value)) {
- BT_LOGE("clock-class-offset-ns should be an integer");
- goto error;
- }
- ctf_fs->metadata_config.clock_class_offset_ns = bt_value_integer_get(value);
- }
-
if (ctf_fs_component_create_ctf_fs_traces(self_comp, ctf_fs, paths_value)) {
goto error;
}
projects / babeltrace.git / blobdiff