ctf: make src.ctf.fs not recurse
[babeltrace.git] / src / plugins / ctf / fs-src / fs.c
index 1cb42e09791fd097715dce6c0aea71d482590b5f..2c0d86ad77f69cfd9a0a6f449645016c6fe6bb65 100644 (file)
@@ -258,14 +258,14 @@ bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init(
        bt_component_class_message_iterator_init_method_status ret =
                BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK;
        bt_logging_level log_level;
-       bt_self_component *self_comp;
+       bt_self_component *self_comp =
+               bt_self_component_source_as_self_component(self_comp_src);
 
        port_data = bt_self_component_port_get_data(
                bt_self_component_port_output_as_self_component_port(
                        self_port));
        BT_ASSERT(port_data);
        log_level = port_data->ctf_fs->log_level;
-       self_comp = port_data->ctf_fs->self_comp;
        msg_iter_data = g_new0(struct ctf_fs_msg_iter_data, 1);
        if (!msg_iter_data) {
                ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
@@ -281,7 +281,7 @@ bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init(
                ctf_fs_ds_file_medops, NULL, msg_iter_data->log_level,
                self_comp);
        if (!msg_iter_data->msg_iter) {
-               BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create a CTF message iterator.");
                ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
                goto error;
        }
@@ -359,10 +359,6 @@ void ctf_fs_trace_destroy(struct ctf_fs_trace *ctf_fs_trace)
                g_string_free(ctf_fs_trace->path, TRUE);
        }
 
-       if (ctf_fs_trace->name) {
-               g_string_free(ctf_fs_trace->name, TRUE);
-       }
-
        if (ctf_fs_trace->metadata) {
                ctf_fs_metadata_fini(ctf_fs_trace->metadata);
                g_free(ctf_fs_trace->metadata);
@@ -389,7 +385,6 @@ struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level,
        }
 
        ctf_fs->log_level = log_level;
-       ctf_fs->self_comp = self_comp;
        ctf_fs->port_data =
                g_ptr_array_new_with_free_func(port_data_destroy_notifier);
        if (!ctf_fs->port_data) {
@@ -405,9 +400,8 @@ struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level,
        goto end;
 
 error:
-       if (ctf_fs) {
-               ctf_fs_destroy(ctf_fs);
-       }
+       ctf_fs_destroy(ctf_fs);
+       ctf_fs = NULL;
 
 end:
        return ctf_fs;
@@ -466,13 +460,15 @@ gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group)
 static
 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)
+               struct ctf_fs_ds_file_group *ds_file_group,
+               bt_self_component_source *self_comp_src)
 {
        int ret = 0;
        struct ctf_fs_port_data *port_data = NULL;
        gchar *port_name;
        bt_logging_level log_level = ctf_fs->log_level;
-       bt_self_component *self_comp = ctf_fs->self_comp;
+       bt_self_component *self_comp =
+               bt_self_component_source_as_self_component(self_comp_src);
 
        port_name = ctf_fs_make_port_name(ds_file_group);
        if (!port_name) {
@@ -490,7 +486,7 @@ int create_one_port_for_trace(struct ctf_fs_component *ctf_fs,
        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_src, port_name, port_data, NULL);
+               self_comp_src, port_name, port_data, NULL);
        if (ret) {
                goto error;
        }
@@ -511,12 +507,14 @@ end:
 
 static
 int create_ports_for_trace(struct ctf_fs_component *ctf_fs,
-               struct ctf_fs_trace *ctf_fs_trace)
+               struct ctf_fs_trace *ctf_fs_trace,
+               bt_self_component_source *self_comp_src)
 {
        int ret = 0;
        size_t i;
        bt_logging_level log_level = ctf_fs_trace->log_level;
-       bt_self_component *self_comp = ctf_fs_trace->self_comp;
+       bt_self_component *self_comp =
+               bt_self_component_source_as_self_component(self_comp_src);
 
        /* Create one output port for each stream file group */
        for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) {
@@ -524,9 +522,9 @@ int create_ports_for_trace(struct ctf_fs_component *ctf_fs,
                        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);
+                       ds_file_group, self_comp_src);
                if (ret) {
-                       BT_COMP_LOGE("Cannot create output port.");
+                       BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create output port.");
                        goto end;
                }
        }
@@ -732,7 +730,8 @@ int add_ds_file_to_ds_file_group(struct ctf_fs_trace *ctf_fs_trace,
 
        ret = bt_msg_iter_get_packet_properties(ds_file->msg_iter, &props);
        if (ret) {
-               BT_COMP_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+                       "Cannot get stream file's first packet's header and context fields (`%s`).",
                        path);
                goto error;
        }
@@ -750,7 +749,8 @@ int add_ds_file_to_ds_file_group(struct ctf_fs_trace *ctf_fs_trace,
                        sc->default_clock_class->offset_seconds,
                        sc->default_clock_class->offset_cycles, &begin_ns);
                if (ret) {
-                       BT_COMP_LOGE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
+                       BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+                               "Cannot convert clock cycles to nanoseconds from origin (`%s`).",
                                path);
                        goto error;
                }
@@ -865,7 +865,7 @@ int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace)
        /* Check each file in the path directory, except specific ones */
        dir = g_dir_open(ctf_fs_trace->path->str, 0, &error);
        if (!dir) {
-               BT_COMP_LOGE("Cannot open directory `%s`: %s (code %d)",
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot open directory `%s`: %s (code %d)",
                        ctf_fs_trace->path->str, error->message,
                        error->code);
                goto error;
@@ -890,7 +890,8 @@ int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace)
                /* Create the file. */
                file = ctf_fs_file_create(log_level, self_comp);
                if (!file) {
-                       BT_COMP_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S "%s`",
+                       BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+                               "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S "%s`",
                                ctf_fs_trace->path->str, basename);
                        goto error;
                }
@@ -908,7 +909,8 @@ int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace)
 
                ret = ctf_fs_file_open(file, "rb");
                if (ret) {
-                       BT_COMP_LOGE("Cannot open stream file `%s`", file->path->str);
+                       BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot open stream file `%s`",
+                               file->path->str);
                        goto error;
                }
 
@@ -922,7 +924,8 @@ int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace)
                ret = add_ds_file_to_ds_file_group(ctf_fs_trace,
                        file->path->str);
                if (ret) {
-                       BT_COMP_LOGE("Cannot add stream file `%s` to stream file group",
+                       BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+                               "Cannot add stream file `%s` to stream file group",
                                file->path->str);
                        ctf_fs_file_destroy(file);
                        goto error;
@@ -1018,11 +1021,6 @@ struct ctf_fs_trace *ctf_fs_trace_create(bt_self_component *self_comp,
                goto error;
        }
 
-       ctf_fs_trace->name = g_string_new(name);
-       if (!ctf_fs_trace->name) {
-               goto error;
-       }
-
        ctf_fs_trace->metadata = g_new0(struct ctf_fs_metadata, 1);
        if (!ctf_fs_trace->metadata) {
                goto error;
@@ -1101,258 +1099,64 @@ end:
        return ret;
 }
 
-static
-int add_trace_path(GList **trace_paths, const char *path,
-               bt_logging_level log_level, bt_self_component *self_comp)
-{
-       GString *norm_path = NULL;
-       int ret = 0;
-
-       norm_path = bt_common_normalize_path(path, NULL);
-       if (!norm_path) {
-               BT_COMP_LOGE("Failed to normalize path `%s`.", path);
-               ret = -1;
-               goto end;
-       }
-
-       // FIXME: Remove or ifdef for __MINGW32__
-       if (strcmp(norm_path->str, "/") == 0) {
-               BT_COMP_LOGE("Opening a trace in `/` is not supported.");
-               ret = -1;
-               goto end;
-       }
-
-       *trace_paths = g_list_prepend(*trace_paths, norm_path);
-       BT_ASSERT(*trace_paths);
-       norm_path = NULL;
-
-end:
-       if (norm_path) {
-               g_string_free(norm_path, TRUE);
-       }
-
-       return ret;
-}
+/* Helper for ctf_fs_component_create_ctf_fs_traces, to handle a single path. */
 
 static
-int ctf_fs_find_traces(GList **trace_paths, const char *start_path,
-               bt_logging_level log_level, bt_self_component *self_comp)
-{
-       int ret;
-       GError *error = NULL;
-       GDir *dir = NULL;
-       const char *basename = NULL;
-
-       /* Check if the starting path is a CTF trace itself */
-       ret = path_is_ctf_trace(start_path);
-       if (ret < 0) {
-               goto end;
-       }
-
-       if (ret) {
-               /*
-                * Stop recursion: a CTF trace cannot contain another
-                * CTF trace.
-                */
-               ret = add_trace_path(trace_paths, start_path, log_level,
-                       self_comp);
-               goto end;
-       }
-
-       /* Look for subdirectories */
-       if (!g_file_test(start_path, G_FILE_TEST_IS_DIR)) {
-               /* Starting path is not a directory: end of recursion */
-               goto end;
-       }
-
-       dir = g_dir_open(start_path, 0, &error);
-       if (!dir) {
-               if (error->code == G_FILE_ERROR_ACCES) {
-                       BT_COMP_LOGI("Cannot open directory `%s`: %s (code %d): continuing",
-                               start_path, error->message, error->code);
-                       goto end;
-               }
-
-               BT_COMP_LOGE("Cannot open directory `%s`: %s (code %d)",
-                       start_path, error->message, error->code);
-               ret = -1;
-               goto end;
-       }
-
-       while ((basename = g_dir_read_name(dir))) {
-               GString *sub_path = g_string_new(NULL);
-
-               if (!sub_path) {
-                       ret = -1;
-                       goto end;
-               }
-
-               g_string_printf(sub_path, "%s" G_DIR_SEPARATOR_S "%s", start_path, basename);
-               ret = ctf_fs_find_traces(trace_paths, sub_path->str,
-                       log_level, self_comp);
-               g_string_free(sub_path, TRUE);
-               if (ret) {
-                       goto end;
-               }
-       }
-
-end:
-       if (dir) {
-               g_dir_close(dir);
-       }
-
-       if (error) {
-               g_error_free(error);
-       }
-
-       return ret;
-}
-
-static
-GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path) {
-       GList *trace_names = NULL;
-       GList *node;
-       const char *last_sep;
-       size_t base_dist;
-
-       /*
-        * 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
-        */
-       last_sep = strrchr(base_path, G_DIR_SEPARATOR);
-
-       /* We know there's at least one separator */
-       BT_ASSERT(last_sep);
-
-       /* 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;
-
-               BT_ASSERT(trace_name);
-               g_string_assign(trace_name, &trace_path->str[base_dist]);
-               trace_names = g_list_append(trace_names, trace_name);
-       }
-
-       return trace_names;
-}
-
-/* Helper for ctf_fs_component_create_ctf_fs_traces, to handle a single path/root. */
-
-static
-int ctf_fs_component_create_ctf_fs_traces_one_root(
+int ctf_fs_component_create_ctf_fs_traces_one_path(
                struct ctf_fs_component *ctf_fs,
-               const char *path_param)
+               const char *path_param,
+               bt_self_component *self_comp,
+               bt_self_component_class *self_comp_class)
 {
-       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;
+       struct ctf_fs_trace *ctf_fs_trace;
+       int ret;
+       GString *norm_path;
        bt_logging_level log_level = ctf_fs->log_level;
-       bt_self_component *self_comp = ctf_fs->self_comp;
 
        norm_path = bt_common_normalize_path(path_param, NULL);
        if (!norm_path) {
-               BT_COMP_LOGE("Failed to normalize path: `%s`.",
-                       path_param);
+               BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+                       "Failed to normalize path: `%s`.", path_param);
                goto error;
        }
 
-       ret = ctf_fs_find_traces(&trace_paths, norm_path->str, log_level,
-               self_comp);
-       if (ret) {
+       ret = path_is_ctf_trace(norm_path->str);
+       if (ret < 0) {
+               BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+                       "Failed to check if path is a CTF trace: path=%s", norm_path->str);
+               goto error;
+       } else if (ret == 0) {
+               BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+                       "Path is not a CTF trace (does not contain a metadata file): `%s`.", norm_path->str);
                goto error;
        }
 
-       if (!trace_paths) {
-               BT_COMP_LOGE("No CTF traces recursively found in `%s`.",
-                       path_param);
-               (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(
-                       ctf_fs->self_comp,
-                       "No CTF traces recursively found in `%s`.", path_param);
-               goto error;
+       // FIXME: Remove or ifdef for __MINGW32__
+       if (strcmp(norm_path->str, "/") == 0) {
+               BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+                       "Opening a trace in `/` is not supported.");
+               ret = -1;
+               goto end;
        }
 
-       trace_names = ctf_fs_create_trace_names(trace_paths, norm_path->str);
-       if (!trace_names) {
-               BT_COMP_LOGE("Cannot create trace names from trace paths.");
+       ctf_fs_trace = ctf_fs_trace_create(self_comp, norm_path->str,
+               norm_path->str, &ctf_fs->metadata_config, log_level);
+       if (!ctf_fs_trace) {
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create trace for `%s`.",
+                       norm_path->str);
                goto error;
        }
 
-       for (tp_node = trace_paths, tn_node = trace_names; tp_node;
-                       tp_node = g_list_next(tp_node),
-                       tn_node = g_list_next(tn_node)) {
-               GString *trace_path = tp_node->data;
-               GString *trace_name = tn_node->data;
-
-               ctf_fs_trace = ctf_fs_trace_create(self_comp,
-                               trace_path->str, trace_name->str,
-                               &ctf_fs->metadata_config,
-                               log_level);
-               if (!ctf_fs_trace) {
-                       BT_COMP_LOGE("Cannot create trace for `%s`.",
-                               trace_path->str);
-                       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;
 
+       ret = 0;
        goto end;
 
 error:
        ret = -1;
-       ctf_fs_trace_destroy(ctf_fs_trace);
 
 end:
-       for (tp_node = trace_paths; tp_node; tp_node = g_list_next(tp_node)) {
-               if (tp_node->data) {
-                       g_string_free(tp_node->data, TRUE);
-               }
-       }
-
-       for (tn_node = trace_names; tn_node; tn_node = g_list_next(tn_node)) {
-               if (tn_node->data) {
-                       g_string_free(tn_node->data, TRUE);
-               }
-       }
-
-       if (trace_paths) {
-               g_list_free(trace_paths);
-       }
-
-       if (trace_names) {
-               g_list_free(trace_names);
-       }
-
        if (norm_path) {
                g_string_free(norm_path, TRUE);
        }
@@ -1553,7 +1357,6 @@ int merge_ctf_fs_traces(struct ctf_fs_trace **traces, unsigned int num_traces)
        struct ctf_fs_trace *winner;
        guint i;
        int ret = 0;
-       char uuid_str[BT_UUID_STR_LEN + 1];
 
        BT_ASSERT(num_traces >= 2);
 
@@ -1598,10 +1401,6 @@ int merge_ctf_fs_traces(struct ctf_fs_trace **traces, unsigned int num_traces)
                traces[i] = NULL;
        }
 
-       /* Use the string representation of the UUID as the trace name. */
-       bt_uuid_to_str(winner->metadata->tc->uuid, uuid_str);
-       g_string_printf(winner->name, "%s", uuid_str);
-
 end:
        return ret;
 }
@@ -1708,7 +1507,7 @@ int decode_clock_snapshot_after_event(struct ctf_fs_trace *ctf_fs_trace,
        ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter,
                NULL, index_entry->path, log_level);
        if (!ds_file) {
-               BT_LOGE_STR("Failed to create a ctf_fs_ds_file");
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to create a ctf_fs_ds_file");
                ret = -1;
                goto end;
        }
@@ -1755,7 +1554,8 @@ int decode_clock_snapshot_after_event(struct ctf_fs_trace *ctf_fs_trace,
                default_cc->frequency, default_cc->offset_seconds,
                default_cc->offset_cycles, ts_ns);
        if (ret) {
-               BT_LOGE_STR("Failed to convert clock snapshot to timestamp");
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+                       "Failed to convert clock snapshot to timestamp");
                goto end;
        }
 
@@ -1770,6 +1570,15 @@ end:
        return ret;
 }
 
+static
+int decode_packet_first_event_timestamp(struct ctf_fs_trace *ctf_fs_trace,
+       struct ctf_clock_class *default_cc,
+       struct ctf_fs_ds_index_entry *index_entry, uint64_t *cs, int64_t *ts_ns)
+{
+       return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc,
+               index_entry, FIRST_EVENT, cs, ts_ns);
+}
+
 static
 int decode_packet_last_event_timestamp(struct ctf_fs_trace *ctf_fs_trace,
        struct ctf_clock_class *default_cc,
@@ -1860,7 +1669,8 @@ int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace *trace)
                        last_entry, &last_entry->timestamp_end,
                        &last_entry->timestamp_end_ns);
                if (ret) {
-                       BT_LOGE_STR("Failed to decode stream's last packet to get its last event's clock snapshot.");
+                       BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp,
+                               "Failed to decode stream's last packet to get its last event's clock snapshot.");
                        goto end;
                }
        }
@@ -1869,6 +1679,169 @@ end:
        return ret;
 }
 
+/*
+ * Fix up packet index entries for barectf's "event-before-packet" bug.
+ * Some buggy barectf tracer versions may emit events with a timestamp that is
+ * less than the timestamp_begin of the their packets.
+ *
+ * To fix up this erroneous data we do the following:
+ *  1. Starting at the second index entry, set the timestamp_begin of the
+ *     current entry to the timestamp of the first event of the packet.
+ *  2. Set the previous entry's timestamp_end to the timestamp_begin of the
+ *     current packet.
+ *
+ * Known buggy tracer versions:
+ *  - before barectf 2.3.1
+ */
+static
+int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace *trace)
+{
+       int ret = 0;
+       guint ds_file_group_i;
+       GPtrArray *ds_file_groups = trace->ds_file_groups;
+       bt_logging_level log_level = trace->log_level;
+
+       for (ds_file_group_i = 0; ds_file_group_i < ds_file_groups->len;
+                       ds_file_group_i++) {
+               guint entry_i;
+               struct ctf_clock_class *default_cc;
+               struct ctf_fs_ds_file_group *ds_file_group =
+                       g_ptr_array_index(ds_file_groups, ds_file_group_i);
+
+               struct ctf_fs_ds_index *index = ds_file_group->index;
+
+               BT_ASSERT(index);
+               BT_ASSERT(index->entries);
+               BT_ASSERT(index->entries->len > 0);
+
+               BT_ASSERT(ds_file_group->sc->default_clock_class);
+               default_cc = ds_file_group->sc->default_clock_class;
+
+               /*
+                * 1. Iterate over the index, starting from the second entry
+                * (index = 1).
+                */
+               for (entry_i = 1; entry_i < index->entries->len;
+                               entry_i++) {
+                       struct ctf_fs_ds_index_entry *curr_entry, *prev_entry;
+                       prev_entry = g_ptr_array_index(index->entries, entry_i - 1);
+                       curr_entry = g_ptr_array_index(index->entries, entry_i);
+                       /*
+                        * 2. Set the current entry `begin` timestamp to the
+                        * timestamp of the first event of the current packet.
+                        */
+                       ret = decode_packet_first_event_timestamp(trace, default_cc,
+                               curr_entry, &curr_entry->timestamp_begin,
+                               &curr_entry->timestamp_begin_ns);
+                       if (ret) {
+                               BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp,
+                                       "Failed to decode first event's clock snapshot");
+                               goto end;
+                       }
+
+                       /*
+                        * 3. Set the previous entry `end` timestamp to the
+                        * timestamp of the first event of the current packet.
+                        */
+                       prev_entry->timestamp_end = curr_entry->timestamp_begin;
+                       prev_entry->timestamp_end_ns = curr_entry->timestamp_begin_ns;
+               }
+       }
+end:
+       return ret;
+}
+
+/*
+ * When using the lttng-crash feature it's likely that the last packets of each
+ * stream have their timestamp_end set to zero. This is caused by the fact that
+ * the tracer crashed and was not able to properly close the packets.
+ *
+ * To fix up this erroneous data we do the following:
+ * For each index entry, if the entry's timestamp_end is 0 and the
+ * timestamp_begin is not 0:
+ *  - If it's the stream file's last packet: set the packet index entry's end
+ *    time to the packet's last event's time, if any, or to the packet's
+ *    beginning time otherwise.
+ *  - If it's not the stream file's last packet: set the packet index
+ *    entry's end time to the next packet's beginning time.
+ *
+ * Affected versions:
+ * - All current and future lttng-ust and lttng-modules versions.
+ */
+static
+int fix_index_lttng_crash_quirk(struct ctf_fs_trace *trace)
+{
+       int ret = 0;
+       guint ds_file_group_idx;
+       GPtrArray *ds_file_groups = trace->ds_file_groups;
+       bt_logging_level log_level = trace->log_level;
+
+       for (ds_file_group_idx = 0; ds_file_group_idx < ds_file_groups->len;
+                       ds_file_group_idx++) {
+               guint entry_idx;
+               struct ctf_clock_class *default_cc;
+               struct ctf_fs_ds_index_entry *last_entry;
+               struct ctf_fs_ds_index *index;
+
+               struct ctf_fs_ds_file_group *ds_file_group =
+                       g_ptr_array_index(ds_file_groups, ds_file_group_idx);
+
+               BT_ASSERT(ds_file_group);
+               index = ds_file_group->index;
+
+               BT_ASSERT(ds_file_group->sc->default_clock_class);
+               default_cc = ds_file_group->sc->default_clock_class;
+
+               BT_ASSERT(index);
+               BT_ASSERT(index->entries);
+               BT_ASSERT(index->entries->len > 0);
+
+               last_entry = g_ptr_array_index(index->entries,
+                       index->entries->len - 1);
+               BT_ASSERT(last_entry);
+
+
+               /* 1. Fix the last entry first. */
+               if (last_entry->timestamp_end == 0 &&
+                               last_entry->timestamp_begin != 0) {
+                       /*
+                        * Decode packet to read the timestamp of the
+                        * last event of the stream file.
+                        */
+                       ret = decode_packet_last_event_timestamp(trace,
+                               default_cc, last_entry,
+                               &last_entry->timestamp_end,
+                               &last_entry->timestamp_end_ns);
+                       if (ret) {
+                               BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp,
+                                       "Failed to decode last event's clock snapshot");
+                               goto end;
+                       }
+               }
+
+               /* Iterate over all entries but the last one. */
+               for (entry_idx = 0; entry_idx < index->entries->len - 1;
+                               entry_idx++) {
+                       struct ctf_fs_ds_index_entry *curr_entry, *next_entry;
+                       curr_entry = g_ptr_array_index(index->entries, entry_idx);
+                       next_entry = g_ptr_array_index(index->entries, entry_idx + 1);
+
+                       if (curr_entry->timestamp_end == 0 &&
+                                       curr_entry->timestamp_begin != 0) {
+                               /*
+                                * 2. Set the current index entry `end` timestamp to
+                                * the next index entry `begin` timestamp.
+                                */
+                               curr_entry->timestamp_end = next_entry->timestamp_begin;
+                               curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns;
+                       }
+               }
+       }
+
+end:
+       return ret;
+}
+
 /*
  * Extract the tracer information necessary to compare versions.
  * Returns 0 on success, and -1 if the extraction is not successful because the
@@ -1982,12 +1955,53 @@ bool is_tracer_affected_by_lttng_event_after_packet_bug(
        return is_affected;
 }
 
+static
+bool is_tracer_affected_by_barectf_event_before_packet_bug(
+               struct tracer_info *curr_tracer_info)
+{
+       bool is_affected = false;
+
+       if (strcmp(curr_tracer_info->name, "barectf") == 0) {
+               if (curr_tracer_info->major < 2) {
+                       is_affected = true;
+               } else if (curr_tracer_info->major == 2) {
+                       if (curr_tracer_info->minor < 3) {
+                               is_affected = true;
+                       } else if (curr_tracer_info->minor == 3) {
+                               /* fixed in barectf 2.3.1 */
+                               if (curr_tracer_info->patch < 1) {
+                                       is_affected = true;
+                               }
+                       }
+               }
+       }
+
+       return is_affected;
+}
+
+static
+bool is_tracer_affected_by_lttng_crash_quirk(
+               struct tracer_info *curr_tracer_info)
+{
+       bool is_affected = false;
+
+       /* All LTTng tracer may be affected by this lttng crash quirk. */
+       if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) {
+               is_affected = true;
+       } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) {
+               is_affected = true;
+       }
+
+       return is_affected;
+}
+
 /*
  * Looks for trace produced by known buggy tracers and fix up the index
  * produced earlier.
  */
 static
-int fix_packet_index_tracer_bugs(struct ctf_fs_component *ctf_fs)
+int fix_packet_index_tracer_bugs(struct ctf_fs_component *ctf_fs,
+               bt_self_component *self_comp)
 {
        int ret = 0;
        guint trace_i;
@@ -2023,18 +2037,45 @@ int fix_packet_index_tracer_bugs(struct ctf_fs_component *ctf_fs)
                        BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
                        ret = fix_index_lttng_event_after_packet_bug(trace);
                        if (ret) {
-                               BT_LOGE_STR("Failed to fix LTTng event-after-packet bug.");
+                               BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+                                       "Failed to fix LTTng event-after-packet bug.");
+                               goto end;
+                       }
+                       trace->metadata->tc->quirks.lttng_event_after_packet = true;
+               }
+
+               if (is_tracer_affected_by_barectf_event_before_packet_bug(
+                               &current_tracer_info)) {
+                       BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
+                       ret = fix_index_barectf_event_before_packet_bug(trace);
+                       if (ret) {
+                               BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+                                       "Failed to fix barectf event-before-packet bug.");
                                goto end;
                        }
+                       trace->metadata->tc->quirks.barectf_event_before_packet = true;
+               }
+
+               if (is_tracer_affected_by_lttng_crash_quirk(
+                               &current_tracer_info)) {
+                       ret = fix_index_lttng_crash_quirk(trace);
+                       if (ret) {
+                               BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+                                       "Failed to fix lttng-crash timestamp quirks.");
+                               goto end;
+                       }
+                       trace->metadata->tc->quirks.lttng_crash = true;
                }
        }
 end:
        return ret;
 }
 
-int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp,
+int ctf_fs_component_create_ctf_fs_traces(
                struct ctf_fs_component *ctf_fs,
-               const bt_value *paths_value)
+               const bt_value *paths_value,
+               bt_self_component *self_comp,
+               bt_self_component_class *self_comp_class)
 {
        int ret = 0;
        uint64_t i;
@@ -2044,8 +2085,8 @@ int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp,
                const bt_value *path_value = bt_value_array_borrow_element_by_index_const(paths_value, i);
                const char *input = bt_value_string_get(path_value);
 
-               ret = ctf_fs_component_create_ctf_fs_traces_one_root(ctf_fs,
-                       input);
+               ret = ctf_fs_component_create_ctf_fs_traces_one_path(ctf_fs,
+                       input, self_comp, self_comp_class);
                if (ret) {
                        goto end;
                }
@@ -2053,12 +2094,14 @@ int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp,
 
        ret = merge_traces_with_same_uuid(ctf_fs);
        if (ret) {
-               BT_LOGE_STR("Failed to merge traces with the same UUID.");
+               BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+                       "Failed to merge traces with the same UUID.");
        }
 
-       ret = fix_packet_index_tracer_bugs(ctf_fs);
+       ret = fix_packet_index_tracer_bugs(ctf_fs, self_comp);
        if (ret) {
-               BT_LOGE_STR("Failed to fix packet index tracer bugs.");
+               BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+                       "Failed to fix packet index tracer bugs.");
        }
 end:
        return ret;
@@ -2131,7 +2174,8 @@ int create_streams_for_trace(struct ctf_fs_trace *ctf_fs_trace)
                }
 
                if (!ds_file_group->stream) {
-                       BT_COMP_LOGE("Cannot create stream for DS file group: "
+                       BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+                               "Cannot create stream for DS file group: "
                                "addr=%p, stream-name=\"%s\"",
                                ds_file_group, name->str);
                        goto error;
@@ -2140,7 +2184,7 @@ int create_streams_for_trace(struct ctf_fs_trace *ctf_fs_trace)
                ret = bt_stream_set_name(ds_file_group->stream,
                        name->str);
                if (ret) {
-                       BT_COMP_LOGE("Cannot set stream's name: "
+                       BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot set stream's name: "
                                "addr=%p, stream-name=\"%s\"",
                                ds_file_group->stream, name->str);
                        goto error;
@@ -2171,22 +2215,24 @@ end:
 
 static
 bool validate_inputs_parameter(struct ctf_fs_component *ctf_fs,
-               const bt_value *inputs)
+               const bt_value *inputs, bt_self_component *self_comp,
+               bt_self_component_class *self_comp_class)
 {
        bool ret;
        bt_value_type type;
        uint64_t i;
        bt_logging_level log_level = ctf_fs->log_level;
-       bt_self_component *self_comp = ctf_fs->self_comp;
 
        if (!inputs) {
-               BT_COMP_LOGE("missing \"inputs\" parameter");
+               BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp,
+                       self_comp_class, "missing \"inputs\" parameter");
                goto error;
        }
 
        type = bt_value_get_type(inputs);
        if (type != BT_VALUE_TYPE_ARRAY) {
-               BT_COMP_LOGE("`inputs` parameter: expecting array value: type=%s",
+               BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp,
+                       self_comp_class, "`inputs` parameter: expecting array value: type=%s",
                        bt_common_value_type_string(type));
                goto error;
        }
@@ -2197,7 +2243,8 @@ bool validate_inputs_parameter(struct ctf_fs_component *ctf_fs,
                elem = bt_value_array_borrow_element_by_index_const(inputs, i);
                type = bt_value_get_type(elem);
                if (type != BT_VALUE_TYPE_STRING) {
-                       BT_COMP_LOGE("`inputs` parameter: expecting string value: index=%" PRIu64 ", type=%s",
+                       BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+                               "`inputs` parameter: expecting string value: index=%" PRIu64 ", type=%s",
                                i, bt_common_value_type_string(type));
                        goto error;
                }
@@ -2214,15 +2261,16 @@ end:
 }
 
 bool read_src_fs_parameters(const bt_value *params,
-               const bt_value **inputs, struct ctf_fs_component *ctf_fs) {
+               const bt_value **inputs, struct ctf_fs_component *ctf_fs,
+               bt_self_component *self_comp,
+               bt_self_component_class *self_comp_class) {
        bool ret;
        const bt_value *value;
        bt_logging_level log_level = ctf_fs->log_level;
-       bt_self_component *self_comp = ctf_fs->self_comp;
 
        /* inputs parameter */
        *inputs = bt_value_map_borrow_entry_value_const(params, "inputs");
-       if (!validate_inputs_parameter(ctf_fs, *inputs)) {
+       if (!validate_inputs_parameter(ctf_fs, *inputs, self_comp, self_comp_class)) {
                goto error;
        }
 
@@ -2231,7 +2279,8 @@ bool read_src_fs_parameters(const bt_value *params,
                "clock-class-offset-s");
        if (value) {
                if (!bt_value_is_signed_integer(value)) {
-                       BT_COMP_LOGE("clock-class-offset-s must be an integer");
+                       BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+                               "clock-class-offset-s must be an integer");
                        goto error;
                }
                ctf_fs->metadata_config.clock_class_offset_s =
@@ -2243,7 +2292,8 @@ bool read_src_fs_parameters(const bt_value *params,
                "clock-class-offset-ns");
        if (value) {
                if (!bt_value_is_signed_integer(value)) {
-                       BT_COMP_LOGE("clock-class-offset-ns must be an integer");
+                       BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+                               "clock-class-offset-ns must be an integer");
                        goto error;
                }
                ctf_fs->metadata_config.clock_class_offset_ns =
@@ -2263,8 +2313,9 @@ end:
 
 static
 struct ctf_fs_component *ctf_fs_create(
-               bt_self_component_source *self_comp_src,
-               const bt_value *params)
+       const bt_value *params,
+       bt_self_component_source *self_comp_src,
+       bt_self_component_class *self_comp_class)
 {
        struct ctf_fs_component *ctf_fs = NULL;
        guint i;
@@ -2278,15 +2329,15 @@ struct ctf_fs_component *ctf_fs_create(
                goto error;
        }
 
-       if (!read_src_fs_parameters(params, &inputs_value, ctf_fs)) {
+       if (!read_src_fs_parameters(params, &inputs_value, ctf_fs,
+                       self_comp, self_comp_class)) {
                goto error;
        }
 
        bt_self_component_set_data(self_comp, ctf_fs);
-       ctf_fs->self_comp = self_comp;
-       ctf_fs->self_comp_src = self_comp_src;
 
-       if (ctf_fs_component_create_ctf_fs_traces(self_comp_src, ctf_fs, inputs_value)) {
+       if (ctf_fs_component_create_ctf_fs_traces(ctf_fs, inputs_value,
+                       self_comp, self_comp_class)) {
                goto error;
        }
 
@@ -2297,7 +2348,7 @@ struct ctf_fs_component *ctf_fs_create(
                        goto error;
                }
 
-               if (create_ports_for_trace(ctf_fs, trace)) {
+               if (create_ports_for_trace(ctf_fs, trace, self_comp_src)) {
                        goto error;
                }
        }
@@ -2315,14 +2366,14 @@ end:
 
 BT_HIDDEN
 bt_component_class_init_method_status ctf_fs_init(
-               bt_self_component_source *self_comp,
+               bt_self_component_source *self_comp_src,
                const bt_value *params, __attribute__((unused)) void *init_method_data)
 {
        struct ctf_fs_component *ctf_fs;
        bt_component_class_init_method_status ret =
                BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK;
 
-       ctf_fs = ctf_fs_create(self_comp, params);
+       ctf_fs = ctf_fs_create(params, self_comp_src, NULL);
        if (!ctf_fs) {
                ret = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
        }
This page took 0.034528 seconds and 4 git commands to generate.