/*
- * fs.c
- *
- * Babeltrace CTF file system Reader Component
+ * SPDX-License-Identifier: MIT
*
* Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * Babeltrace CTF file system Reader Component
*/
#define BT_COMP_LOG_SELF_COMP self_comp
#include "../common/metadata/ctf-meta-configure-ir-trace.h"
#include "../common/msg-iter/msg-iter.h"
#include "query.h"
+#include "plugins/common/param-validation/param-validation.h"
struct tracer_info {
const char *name;
int64_t patch;
};
-static
-int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data *msg_iter_data)
-{
- struct ctf_fs_ds_file_info *ds_file_info;
- int ret = 0;
-
- BT_ASSERT(msg_iter_data->ds_file_info_index <
- msg_iter_data->ds_file_group->ds_file_infos->len);
- ds_file_info = g_ptr_array_index(
- msg_iter_data->ds_file_group->ds_file_infos,
- msg_iter_data->ds_file_info_index);
-
- ctf_fs_ds_file_destroy(msg_iter_data->ds_file);
- msg_iter_data->ds_file = ctf_fs_ds_file_create(
- msg_iter_data->ds_file_group->ctf_fs_trace,
- msg_iter_data->pc_msg_iter,
- msg_iter_data->msg_iter,
- msg_iter_data->ds_file_group->stream,
- ds_file_info->path->str,
- msg_iter_data->log_level);
- if (!msg_iter_data->ds_file) {
- ret = -1;
- }
-
- return ret;
-}
-
static
void ctf_fs_msg_iter_data_destroy(
struct ctf_fs_msg_iter_data *msg_iter_data)
return;
}
- ctf_fs_ds_file_destroy(msg_iter_data->ds_file);
-
if (msg_iter_data->msg_iter) {
- bt_msg_iter_destroy(msg_iter_data->msg_iter);
+ ctf_msg_iter_destroy(msg_iter_data->msg_iter);
}
- g_free(msg_iter_data);
-}
+ if (msg_iter_data->msg_iter_medops_data) {
+ ctf_fs_ds_group_medops_data_destroy(
+ msg_iter_data->msg_iter_medops_data);
+ }
-static
-void set_msg_iter_emits_stream_beginning_end_messages(
- struct ctf_fs_msg_iter_data *msg_iter_data)
-{
- bt_msg_iter_set_emit_stream_beginning_message(
- msg_iter_data->ds_file->msg_iter,
- msg_iter_data->ds_file_info_index == 0);
- bt_msg_iter_set_emit_stream_end_message(
- msg_iter_data->ds_file->msg_iter,
- msg_iter_data->ds_file_info_index ==
- msg_iter_data->ds_file_group->ds_file_infos->len - 1);
+ g_free(msg_iter_data);
}
static
-bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next_one(
+bt_message_iterator_class_next_method_status ctf_fs_iterator_next_one(
struct ctf_fs_msg_iter_data *msg_iter_data,
const bt_message **out_msg)
{
- bt_component_class_message_iterator_next_method_status status;
+ bt_message_iterator_class_next_method_status status;
+ enum ctf_msg_iter_status msg_iter_status;
+ bt_logging_level log_level = msg_iter_data->log_level;
- BT_ASSERT(msg_iter_data->ds_file);
+ msg_iter_status = ctf_msg_iter_get_next_message(
+ msg_iter_data->msg_iter, out_msg);
- while (true) {
- bt_message *msg;
+ switch (msg_iter_status) {
+ case CTF_MSG_ITER_STATUS_OK:
+ /* Cool, message has been written to *out_msg. */
+ status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
+ break;
- status = ctf_fs_ds_file_next(msg_iter_data->ds_file, &msg);
- switch (status) {
- case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK:
- *out_msg = msg;
- msg = NULL;
- goto end;
- case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END:
- {
- int ret;
+ case CTF_MSG_ITER_STATUS_EOF:
+ status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END;
+ break;
- if (msg_iter_data->ds_file_info_index ==
- msg_iter_data->ds_file_group->ds_file_infos->len - 1) {
- /* End of all group's stream files */
- goto end;
- }
+ case CTF_MSG_ITER_STATUS_AGAIN:
+ /*
+ * Should not make it this far as this is
+ * medium-specific; there is nothing for the user to do
+ * and it should have been handled upstream.
+ */
+ bt_common_abort();
- msg_iter_data->ds_file_info_index++;
- bt_msg_iter_reset_for_next_stream_file(
- msg_iter_data->msg_iter);
- set_msg_iter_emits_stream_beginning_end_messages(
- msg_iter_data);
+ case CTF_MSG_ITER_MEDIUM_STATUS_ERROR:
+ BT_MSG_ITER_LOGE_APPEND_CAUSE(msg_iter_data->self_msg_iter,
+ "Failed to get next message from CTF message iterator.");
+ status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
+ break;
- /*
- * Open and start reading the next stream file
- * within our stream file group.
- */
- ret = msg_iter_data_set_current_ds_file(msg_iter_data);
- if (ret) {
- status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR;
- goto end;
- }
+ case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR:
+ BT_MSG_ITER_LOGE_APPEND_CAUSE(msg_iter_data->self_msg_iter,
+ "Failed to get next message from CTF message iterator.");
+ status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR;
+ break;
- /* Continue the loop to get the next message */
- break;
- }
- default:
- goto end;
- }
+ default:
+ bt_common_abort();
}
-end:
return status;
}
BT_HIDDEN
-bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next(
+bt_message_iterator_class_next_method_status ctf_fs_iterator_next(
bt_self_message_iterator *iterator,
bt_message_array_const msgs, uint64_t capacity,
uint64_t *count)
{
- bt_component_class_message_iterator_next_method_status status =
- BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
+ bt_message_iterator_class_next_method_status status;
struct ctf_fs_msg_iter_data *msg_iter_data =
bt_self_message_iterator_get_data(iterator);
uint64_t i = 0;
- while (i < capacity &&
- status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) {
+ if (G_UNLIKELY(msg_iter_data->next_saved_error)) {
+ /*
+ * Last time we were called, we hit an error but had some
+ * messages to deliver, so we stashed the error here. Return
+ * it now.
+ */
+ BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data->next_saved_error);
+ status = msg_iter_data->next_saved_status;
+ goto end;
+ }
+
+ do {
status = ctf_fs_iterator_next_one(msg_iter_data, &msgs[i]);
- if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) {
+ if (status == BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK) {
i++;
}
- }
+ } while (i < capacity &&
+ status == BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK);
if (i > 0) {
/*
* Even if ctf_fs_iterator_next_one() returned something
- * else than BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
+ * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
* accumulated message objects in the output
* message array, so we need to return
- * BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
+ * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
* transfered to downstream. This other status occurs
* again the next time muxer_msg_iter_do_next() is
* called, possibly without any accumulated
* message, in which case we'll return it.
*/
- *count = i;
- status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
- }
-
- return status;
-}
-
-static
-int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data *msg_iter_data)
-{
- int ret;
+ if (status < 0) {
+ /*
+ * Save this error for the next _next call. Assume that
+ * this component always appends error causes when
+ * returning an error status code, which will cause the
+ * current thread error to be non-NULL.
+ */
+ msg_iter_data->next_saved_error = bt_current_thread_take_error();
+ BT_ASSERT(msg_iter_data->next_saved_error);
+ msg_iter_data->next_saved_status = status;
+ }
- msg_iter_data->ds_file_info_index = 0;
- ret = msg_iter_data_set_current_ds_file(msg_iter_data);
- if (ret) {
- goto end;
+ *count = i;
+ status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
}
- bt_msg_iter_reset(msg_iter_data->msg_iter);
- set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data);
-
end:
- return ret;
+ return status;
}
BT_HIDDEN
-bt_component_class_message_iterator_seek_beginning_method_status
+bt_message_iterator_class_seek_beginning_method_status
ctf_fs_iterator_seek_beginning(bt_self_message_iterator *it)
{
struct ctf_fs_msg_iter_data *msg_iter_data =
bt_self_message_iterator_get_data(it);
- bt_component_class_message_iterator_seek_beginning_method_status status =
- BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK;
BT_ASSERT(msg_iter_data);
- if (ctf_fs_iterator_reset(msg_iter_data)) {
- status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR;
- }
- return status;
+ ctf_msg_iter_reset(msg_iter_data->msg_iter);
+ ctf_fs_ds_group_medops_data_reset(msg_iter_data->msg_iter_medops_data);
+
+ return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK;
}
BT_HIDDEN
}
BT_HIDDEN
-bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init(
+bt_message_iterator_class_initialize_method_status ctf_fs_iterator_init(
bt_self_message_iterator *self_msg_iter,
- bt_self_component_source *self_comp_src,
+ bt_self_message_iterator_configuration *config,
bt_self_component_port_output *self_port)
{
struct ctf_fs_port_data *port_data;
struct ctf_fs_msg_iter_data *msg_iter_data = NULL;
- bt_component_class_message_iterator_init_method_status ret =
- BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK;
+ bt_message_iterator_class_initialize_method_status status;
bt_logging_level log_level;
+ enum ctf_msg_iter_medium_status medium_status;
bt_self_component *self_comp =
- bt_self_component_source_as_self_component(self_comp_src);
+ bt_self_message_iterator_borrow_component(self_msg_iter);
port_data = bt_self_component_port_get_data(
bt_self_component_port_output_as_self_component_port(
log_level = port_data->ctf_fs->log_level;
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;
+ status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
goto error;
}
msg_iter_data->log_level = log_level;
msg_iter_data->self_comp = self_comp;
- msg_iter_data->pc_msg_iter = self_msg_iter;
- msg_iter_data->msg_iter = bt_msg_iter_create(
- port_data->ds_file_group->ctf_fs_trace->metadata->tc,
+ msg_iter_data->self_msg_iter = self_msg_iter;
+ msg_iter_data->ds_file_group = port_data->ds_file_group;
+
+ medium_status = ctf_fs_ds_group_medops_data_create(
+ msg_iter_data->ds_file_group, self_msg_iter, log_level,
+ &msg_iter_data->msg_iter_medops_data);
+ BT_ASSERT(
+ medium_status == CTF_MSG_ITER_MEDIUM_STATUS_OK ||
+ medium_status == CTF_MSG_ITER_MEDIUM_STATUS_ERROR ||
+ medium_status == CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR);
+ if (medium_status != CTF_MSG_ITER_MEDIUM_STATUS_OK) {
+ BT_MSG_ITER_LOGE_APPEND_CAUSE(self_msg_iter,
+ "Failed to create ctf_fs_ds_group_medops");
+ status = (int) medium_status;
+ goto error;
+ }
+
+ msg_iter_data->msg_iter = ctf_msg_iter_create(
+ msg_iter_data->ds_file_group->ctf_fs_trace->metadata->tc,
bt_common_get_page_size(msg_iter_data->log_level) * 8,
- ctf_fs_ds_file_medops, NULL, msg_iter_data->log_level,
- self_comp);
+ ctf_fs_ds_group_medops,
+ msg_iter_data->msg_iter_medops_data,
+ msg_iter_data->log_level,
+ self_comp, self_msg_iter);
if (!msg_iter_data->msg_iter) {
BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create a CTF message iterator.");
- ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
+ status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
goto error;
}
- msg_iter_data->ds_file_group = port_data->ds_file_group;
- if (ctf_fs_iterator_reset(msg_iter_data)) {
- ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR;
- goto error;
+ /*
+ * This iterator can seek forward if its stream class has a default
+ * clock class.
+ */
+ if (msg_iter_data->ds_file_group->sc->default_clock_class) {
+ bt_self_message_iterator_configuration_set_can_seek_forward(
+ config, true);
}
bt_self_message_iterator_set_data(self_msg_iter,
msg_iter_data);
- if (ret != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK) {
- goto error;
- }
-
msg_iter_data = NULL;
+
+ status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK;
goto end;
error:
end:
ctf_fs_msg_iter_data_destroy(msg_iter_data);
- return ret;
+ return status;
}
static
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);
- }
+ ctf_fs_ds_index_destroy(ds_file_group->index);
bt_stream_put_ref(ds_file_group->stream);
g_free(ds_file_group);
}
static
-void ds_file_group_insert_ds_index_entry_sorted(
- struct ctf_fs_ds_file_group *ds_file_group,
+bool ds_index_entries_equal(
+ const struct ctf_fs_ds_index_entry *left,
+ const struct ctf_fs_ds_index_entry *right)
+{
+ if (left->packet_size != right->packet_size) {
+ return false;
+ }
+
+ if (left->timestamp_begin != right->timestamp_begin) {
+ return false;
+ }
+
+ if (left->timestamp_end != right->timestamp_end) {
+ return false;
+ }
+
+ if (left->packet_seq_num != right->packet_seq_num) {
+ return false;
+ }
+
+ return true;
+}
+
+/*
+ * Insert `entry` into `index`, without duplication.
+ *
+ * The entry is inserted only if there isn't an identical entry already.
+ *
+ * In any case, the ownership of `entry` is transferred to this function. So if
+ * the entry is not inserted, it is freed.
+ */
+
+static
+void ds_index_insert_ds_index_entry_sorted(
+ struct ctf_fs_ds_index *index,
struct ctf_fs_ds_index_entry *entry)
{
guint i;
+ struct ctf_fs_ds_index_entry *other_entry = NULL;
/* 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);
+ for (i = 0; i < index->entries->len; i++) {
+ other_entry = g_ptr_array_index(index->entries, i);
- if (entry->timestamp_begin_ns < other_entry->timestamp_begin_ns) {
+ if (entry->timestamp_begin_ns <= other_entry->timestamp_begin_ns) {
break;
}
}
- array_insert(ds_file_group->index->entries, entry, i);
+ /*
+ * Insert the entry only if a duplicate doesn't already exist.
+ *
+ * There can be duplicate packets if reading multiple overlapping
+ * snapshots of the same trace. We then want the index to contain
+ * a reference to only one copy of that packet.
+ */
+ if (i == index->entries->len ||
+ !ds_index_entries_equal(entry, other_entry)) {
+ array_insert(index->entries, entry, i);
+ } else {
+ g_free(entry);
+ }
+}
+
+static
+void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index *dest, struct ctf_fs_ds_index *src)
+{
+ guint i;
+
+ for (i = 0; i < src->entries->len; i++) {
+ struct ctf_fs_ds_index_entry *entry =
+ g_ptr_array_index(src->entries, i);
+
+ /*
+ * Ownership of the ctf_fs_ds_index_entry is transferred to
+ * ds_index_insert_ds_index_entry_sorted.
+ */
+ g_ptr_array_index(src->entries, i) = NULL;
+ ds_index_insert_ds_index_entry_sorted(dest, entry);
+ }
}
static
struct ctf_fs_ds_file *ds_file = NULL;
struct ctf_fs_ds_file_info *ds_file_info = NULL;
struct ctf_fs_ds_index *index = NULL;
- struct bt_msg_iter *msg_iter = NULL;
+ struct ctf_msg_iter *msg_iter = NULL;
struct ctf_stream_class *sc = NULL;
- struct bt_msg_iter_packet_properties props;
+ struct ctf_msg_iter_packet_properties props;
bt_logging_level log_level = ctf_fs_trace->log_level;
bt_self_component *self_comp = ctf_fs_trace->self_comp;
+ bt_self_component_class *self_comp_class = ctf_fs_trace->self_comp_class;
+
+ /*
+ * Create a temporary ds_file to read some properties about the data
+ * stream file.
+ */
+ ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, NULL, path,
+ log_level);
+ if (!ds_file) {
+ goto error;
+ }
- msg_iter = bt_msg_iter_create(ctf_fs_trace->metadata->tc,
+ /* Create a temporary iterator to read the ds_file. */
+ msg_iter = ctf_msg_iter_create(ctf_fs_trace->metadata->tc,
bt_common_get_page_size(log_level) * 8,
- ctf_fs_ds_file_medops, NULL, log_level, self_comp);
+ ctf_fs_ds_file_medops, ds_file, log_level, self_comp, NULL);
if (!msg_iter) {
BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
goto error;
}
- ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter,
- NULL, path, log_level);
- if (!ds_file) {
- goto error;
- }
+ ctf_msg_iter_set_dry_run(msg_iter, true);
- ret = bt_msg_iter_get_packet_properties(ds_file->msg_iter, &props);
+ ret = ctf_msg_iter_get_packet_properties(msg_iter, &props);
if (ret) {
- BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
"Cannot get stream file's first packet's header and context fields (`%s`).",
path);
goto error;
sc->default_clock_class->offset_seconds,
sc->default_clock_class->offset_cycles, &begin_ns);
if (ret) {
- BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
"Cannot convert clock cycles to nanoseconds from origin (`%s`).",
path);
goto error;
goto error;
}
- index = ctf_fs_ds_file_build_index(ds_file, ds_file_info);
+ index = ctf_fs_ds_file_build_index(ds_file, ds_file_info, msg_iter);
if (!index) {
- BT_COMP_LOGW("Failed to index CTF stream file \'%s\'",
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
+ self_comp, self_comp_class,
+ "Failed to index CTF stream file \'%s\'",
ds_file->file->path->str);
+ goto error;
}
if (begin_ns == -1) {
/*
- * No beggining timestamp to sort the stream files
+ * No beginning timestamp to sort the stream files
* within a stream file group, so consider that this
* file must be the only one within its group.
*/
goto error;
}
- ds_file_group_insert_ds_file_info_sorted(ds_file_group, ds_file_info);
+ ds_file_group_insert_ds_file_info_sorted(ds_file_group,
+ BT_MOVE_REF(ds_file_info));
add_group = true;
goto end;
}
add_group = true;
+ } else {
+ merge_ctf_fs_ds_indexes(ds_file_group->index, index);
}
- ds_file_group_insert_ds_file_info_sorted(ds_file_group, ds_file_info);
+ ds_file_group_insert_ds_file_info_sorted(ds_file_group,
+ BT_MOVE_REF(ds_file_info));
goto end;
}
ctf_fs_ds_file_destroy(ds_file);
+ ctf_fs_ds_file_info_destroy(ds_file_info);
if (msg_iter) {
- bt_msg_iter_destroy(msg_iter);
+ ctf_msg_iter_destroy(msg_iter);
}
ctf_fs_ds_index_destroy(index);
GDir *dir = NULL;
bt_logging_level log_level = ctf_fs_trace->log_level;
bt_self_component *self_comp = ctf_fs_trace->self_comp;
+ bt_self_component_class *self_comp_class = ctf_fs_trace->self_comp_class;
/* 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_APPEND_CAUSE(self_comp, "Cannot open directory `%s`: %s (code %d)",
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+ "Cannot open directory `%s`: %s (code %d)",
ctf_fs_trace->path->str, error->message,
error->code);
goto error;
/* Create the file. */
file = ctf_fs_file_create(log_level, self_comp);
if (!file) {
- BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
"Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S "%s`",
ctf_fs_trace->path->str, basename);
goto error;
ret = ctf_fs_file_open(file, "rb");
if (ret) {
- BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot open stream file `%s`",
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+ "Cannot open stream file `%s`",
file->path->str);
goto error;
}
ret = add_ds_file_to_ds_file_group(ctf_fs_trace,
file->path->str);
if (ret) {
- BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
"Cannot add stream file `%s` to stream file group",
file->path->str);
ctf_fs_file_destroy(file);
}
static
-struct ctf_fs_trace *ctf_fs_trace_create(bt_self_component *self_comp,
+struct ctf_fs_trace *ctf_fs_trace_create(
+ bt_self_component *self_comp,
+ bt_self_component_class *self_comp_class,
const char *path, const char *name,
struct ctf_fs_metadata_config *metadata_config,
bt_logging_level log_level)
struct ctf_fs_trace *ctf_fs_trace;
int ret;
+ /* Only one of them must be set. */
+ BT_ASSERT(!self_comp != !self_comp_class);
+
ctf_fs_trace = g_new0(struct ctf_fs_trace, 1);
if (!ctf_fs_trace) {
goto end;
ctf_fs_trace->log_level = log_level;
ctf_fs_trace->self_comp = self_comp;
+ ctf_fs_trace->self_comp_class = self_comp_class;
ctf_fs_trace->path = g_string_new(path);
if (!ctf_fs_trace->path) {
goto error;
int ctf_fs_component_create_ctf_fs_trace_one_path(
struct ctf_fs_component *ctf_fs,
const char *path_param,
+ const char *trace_name,
GPtrArray *traces,
bt_self_component *self_comp,
bt_self_component_class *self_comp_class)
norm_path = bt_common_normalize_path(path_param, NULL);
if (!norm_path) {
BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
- "Failed to normalize path: `%s`.", path_param);
+ "Failed to normalize path: `%s`.",
+ path_param);
goto error;
}
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);
+ "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);
+ "Path is not a CTF trace (does not contain a metadata file): `%s`.",
+ norm_path->str);
goto error;
}
goto end;
}
- ctf_fs_trace = ctf_fs_trace_create(self_comp, norm_path->str,
- norm_path->str, &ctf_fs->metadata_config, log_level);
+ ctf_fs_trace = ctf_fs_trace_create(self_comp, self_comp_class, norm_path->str,
+ trace_name, &ctf_fs->metadata_config, log_level);
if (!ctf_fs_trace) {
- BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create trace for `%s`.",
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+ "Cannot create trace for `%s`.",
norm_path->str);
goto error;
}
}
/* 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_ctf_fs_ds_indexes(dest->index, src->index);
}
/* Merge src_trace's data stream file groups into dest_trace's. */
struct ctf_fs_ds_index_entry *index_entry,
enum target_event target_event, uint64_t *cs, int64_t *ts_ns)
{
- enum bt_msg_iter_status iter_status = BT_MSG_ITER_STATUS_OK;
+ enum ctf_msg_iter_status iter_status = CTF_MSG_ITER_STATUS_OK;
struct ctf_fs_ds_file *ds_file = NULL;
- struct bt_msg_iter *msg_iter = NULL;
+ struct ctf_msg_iter *msg_iter = NULL;
bt_logging_level log_level = ctf_fs_trace->log_level;
bt_self_component *self_comp = ctf_fs_trace->self_comp;
int ret = 0;
BT_ASSERT(ctf_fs_trace);
- BT_ASSERT(ctf_fs_trace->metadata);
- BT_ASSERT(ctf_fs_trace->metadata->tc);
-
- msg_iter = bt_msg_iter_create(ctf_fs_trace->metadata->tc,
- bt_common_get_page_size(log_level) * 8, ctf_fs_ds_file_medops,
- NULL, log_level, self_comp);
- if (!msg_iter) {
- /* bt_msg_iter_create() logs errors. */
- ret = -1;
- goto end;
- }
-
BT_ASSERT(index_entry);
BT_ASSERT(index_entry->path);
- ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter,
+ ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL,
NULL, index_entry->path, log_level);
if (!ds_file) {
BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to create a ctf_fs_ds_file");
goto end;
}
+ BT_ASSERT(ctf_fs_trace->metadata);
+ BT_ASSERT(ctf_fs_trace->metadata->tc);
+
+ msg_iter = ctf_msg_iter_create(ctf_fs_trace->metadata->tc,
+ bt_common_get_page_size(log_level) * 8, ctf_fs_ds_file_medops,
+ ds_file, log_level, self_comp, NULL);
+ if (!msg_iter) {
+ /* ctf_msg_iter_create() logs errors. */
+ ret = -1;
+ goto end;
+ }
+
/*
* Turn on dry run mode to prevent the creation and usage of Babeltrace
* library objects (bt_field, bt_message_*, etc.).
*/
- bt_msg_iter_set_dry_run(msg_iter, true);
+ ctf_msg_iter_set_dry_run(msg_iter, true);
/* Seek to the beginning of the target packet. */
- iter_status = bt_msg_iter_seek(ds_file->msg_iter, index_entry->offset);
+ iter_status = ctf_msg_iter_seek(msg_iter, index_entry->offset);
if (iter_status) {
- /* bt_msg_iter_seek() logs errors. */
+ /* ctf_msg_iter_seek() logs errors. */
ret = -1;
goto end;
}
* the first event. To extract the first event's clock
* snapshot.
*/
- iter_status = bt_msg_iter_curr_packet_first_event_clock_snapshot(
- ds_file->msg_iter, cs);
+ iter_status = ctf_msg_iter_curr_packet_first_event_clock_snapshot(
+ msg_iter, cs);
break;
case LAST_EVENT:
/* Decode the packet to extract the last event's clock snapshot. */
- iter_status = bt_msg_iter_curr_packet_last_event_clock_snapshot(
- ds_file->msg_iter, cs);
+ iter_status = ctf_msg_iter_curr_packet_last_event_clock_snapshot(
+ msg_iter, cs);
break;
default:
- abort();
+ bt_common_abort();
}
if (iter_status) {
ret = -1;
ctf_fs_ds_file_destroy(ds_file);
}
if (msg_iter) {
- bt_msg_iter_destroy(msg_iter);
+ ctf_msg_iter_destroy(msg_iter);
}
return ret;
*/
static
int fix_packet_index_tracer_bugs(struct ctf_fs_component *ctf_fs,
- bt_self_component *self_comp)
+ bt_self_component *self_comp,
+ bt_self_component_class *self_comp_class)
{
int ret = 0;
struct tracer_info current_tracer_info;
BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
ret = fix_index_lttng_event_after_packet_bug(ctf_fs->trace);
if (ret) {
- BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
+ self_comp, self_comp_class,
"Failed to fix LTTng event-after-packet bug.");
goto end;
}
BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
ret = fix_index_barectf_event_before_packet_bug(ctf_fs->trace);
if (ret) {
- BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
+ self_comp, self_comp_class,
"Failed to fix barectf event-before-packet bug.");
goto end;
}
¤t_tracer_info)) {
ret = fix_index_lttng_crash_quirk(ctf_fs->trace);
if (ret) {
- BT_COMP_LOGE_APPEND_CAUSE(self_comp,
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
+ self_comp, self_comp_class,
"Failed to fix lttng-crash timestamp quirks.");
goto end;
}
return ret;
}
+static
+gint compare_ds_file_groups_by_first_path(gconstpointer a, gconstpointer b)
+{
+ struct ctf_fs_ds_file_group * const *ds_file_group_a = a;
+ struct ctf_fs_ds_file_group * const *ds_file_group_b = b;
+ const struct ctf_fs_ds_file_info *first_ds_file_info_a;
+ const struct ctf_fs_ds_file_info *first_ds_file_info_b;
+
+ BT_ASSERT((*ds_file_group_a)->ds_file_infos->len > 0);
+ BT_ASSERT((*ds_file_group_b)->ds_file_infos->len > 0);
+ first_ds_file_info_a = (*ds_file_group_a)->ds_file_infos->pdata[0];
+ first_ds_file_info_b = (*ds_file_group_b)->ds_file_infos->pdata[0];
+ return strcmp(first_ds_file_info_a->path->str,
+ first_ds_file_info_b->path->str);
+}
+
+static
+gint compare_strings(gconstpointer p_a, gconstpointer p_b)
+{
+ const char *a = *((const char **) p_a);
+ const char *b = *((const char **) p_b);
+
+ return strcmp(a, b);
+}
+
int ctf_fs_component_create_ctf_fs_trace(
struct ctf_fs_component *ctf_fs,
const bt_value *paths_value,
+ const bt_value *trace_name_value,
bt_self_component *self_comp,
bt_self_component_class *self_comp_class)
{
int ret = 0;
uint64_t i;
bt_logging_level log_level = ctf_fs->log_level;
+ GPtrArray *paths = NULL;
GPtrArray *traces;
+ const char *trace_name;
BT_ASSERT(bt_value_get_type(paths_value) == BT_VALUE_TYPE_ARRAY);
BT_ASSERT(!bt_value_array_is_empty(paths_value));
goto error;
}
- /* Start by creating a separate ctf_fs_trace object for each path. */
+ paths = g_ptr_array_new_with_free_func(g_free);
+ if (!paths) {
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+ "Failed to allocate a GPtrArray.");
+ goto error;
+ }
+
+ trace_name = trace_name_value ? bt_value_string_get(trace_name_value) : NULL;
+
+ /*
+ * Create a sorted array of the paths, to make the execution of this
+ * component deterministic.
+ */
for (i = 0; i < bt_value_array_get_length(paths_value); i++) {
- const bt_value *path_value = bt_value_array_borrow_element_by_index_const(paths_value, i);
+ 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);
+ gchar *input_copy;
+
+ input_copy = g_strdup(input);
+ if (!input_copy) {
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+ "Failed to copy a string.");
+ goto error;
+ }
+
+ g_ptr_array_add(paths, input_copy);
+ }
+
+ g_ptr_array_sort(paths, compare_strings);
+
+ /* Create a separate ctf_fs_trace object for each path. */
+ for (i = 0; i < paths->len; i++) {
+ const char *path = g_ptr_array_index(paths, i);
ret = ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs,
- input, traces, self_comp, self_comp_class);
+ path, trace_name, traces, self_comp, self_comp_class);
if (ret) {
goto end;
}
traces->pdata[0] = NULL;
}
- ret = fix_packet_index_tracer_bugs(ctf_fs, self_comp);
+ ret = fix_packet_index_tracer_bugs(ctf_fs, self_comp, self_comp_class);
if (ret) {
BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
"Failed to fix packet index tracer bugs.");
}
+ /*
+ * Sort data stream file groups by first data stream file info
+ * path to get a deterministic order. This order influences the
+ * order of the output ports. It also influences the order of
+ * the automatic stream IDs if the trace's packet headers do not
+ * contain a `stream_instance_id` field, in which case the data
+ * stream file to stream ID association is always the same,
+ * whatever the build and the system.
+ *
+ * Having a deterministic order here can help debugging and
+ * testing.
+ */
+ g_ptr_array_sort(ctf_fs->trace->ds_file_groups,
+ compare_ds_file_groups_by_first_path);
goto end;
error:
ret = -1;
end:
- g_ptr_array_free(traces, TRUE);
+ if (traces) {
+ g_ptr_array_free(traces, TRUE);
+ }
+
+ if (paths) {
+ g_ptr_array_free(paths, TRUE);
+ }
+
return ret;
}
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_inputs_parameter(struct ctf_fs_component *ctf_fs,
- 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;
-
- if (!inputs) {
- 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_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;
- }
-
- if (bt_value_array_is_empty(inputs)) {
- BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp,
- self_comp_class, "`inputs` parameter must not be empty");
- goto error;
- }
-
- for (i = 0; i < bt_value_array_get_length(inputs); i++) {
- const bt_value *elem;
+static const struct bt_param_validation_value_descr inputs_elem_descr = {
+ .type = BT_VALUE_TYPE_STRING,
+};
- 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_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;
+static const struct bt_param_validation_map_value_entry_descr fs_params_entries_descr[] = {
+ { "inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, {
+ BT_VALUE_TYPE_ARRAY,
+ .array = {
+ .min_length = 1,
+ .max_length = BT_PARAM_VALIDATION_INFINITE,
+ .element_type = &inputs_elem_descr,
}
- }
-
- ret = true;
- goto end;
-
-error:
- ret = false;
+ }},
+ { "trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } },
+ { "clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_SIGNED_INTEGER } },
+ { "clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_SIGNED_INTEGER } },
+ { "force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
+ BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
+};
-end:
- return ret;
-}
bool read_src_fs_parameters(const bt_value *params,
- const bt_value **inputs, struct ctf_fs_component *ctf_fs,
+ const bt_value **inputs,
+ const bt_value **trace_name,
+ 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;
+ enum bt_param_validation_status validate_value_status;
+ gchar *error = NULL;
+
+ validate_value_status = bt_param_validation_validate(params,
+ fs_params_entries_descr, &error);
+ if (validate_value_status != BT_PARAM_VALIDATION_STATUS_OK) {
+ BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
+ "%s", error);
+ ret = false;
+ goto end;
+ }
/* inputs parameter */
*inputs = bt_value_map_borrow_entry_value_const(params, "inputs");
- if (!validate_inputs_parameter(ctf_fs, *inputs, self_comp, self_comp_class)) {
- 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_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 =
bt_value_integer_signed_get(value);
}
value = bt_value_map_borrow_entry_value_const(params,
"clock-class-offset-ns");
if (value) {
- if (!bt_value_is_signed_integer(value)) {
- 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 =
bt_value_integer_signed_get(value);
}
+ /* force-clock-class-origin-unix-epoch parameter */
+ value = bt_value_map_borrow_entry_value_const(params,
+ "force-clock-class-origin-unix-epoch");
+ if (value) {
+ ctf_fs->metadata_config.force_clock_class_origin_unix_epoch =
+ bt_value_bool_get(value);
+ }
+
+ /* trace-name parameter */
+ *trace_name = bt_value_map_borrow_entry_value_const(params, "trace-name");
ret = true;
- goto end;
-
-error:
- ret = false;
end:
+ g_free(error);
return ret;
}
static
struct ctf_fs_component *ctf_fs_create(
const bt_value *params,
- bt_self_component_source *self_comp_src,
- bt_self_component_class *self_comp_class)
+ bt_self_component_source *self_comp_src)
{
struct ctf_fs_component *ctf_fs = NULL;
const bt_value *inputs_value;
+ const bt_value *trace_name_value;
bt_self_component *self_comp =
bt_self_component_source_as_self_component(self_comp_src);
goto error;
}
- if (!read_src_fs_parameters(params, &inputs_value, ctf_fs,
- self_comp, self_comp_class)) {
+ if (!read_src_fs_parameters(params, &inputs_value, &trace_name_value,
+ ctf_fs, self_comp, NULL)) {
goto error;
}
bt_self_component_set_data(self_comp, ctf_fs);
if (ctf_fs_component_create_ctf_fs_trace(ctf_fs, inputs_value,
- self_comp, self_comp_class)) {
+ trace_name_value, self_comp, NULL)) {
goto error;
}
}
BT_HIDDEN
-bt_component_class_init_method_status ctf_fs_init(
+bt_component_class_initialize_method_status ctf_fs_init(
bt_self_component_source *self_comp_src,
+ bt_self_component_source_configuration *config,
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;
+ bt_component_class_initialize_method_status ret =
+ BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
- ctf_fs = ctf_fs_create(params, self_comp_src, NULL);
+ ctf_fs = ctf_fs_create(params, self_comp_src);
if (!ctf_fs) {
- ret = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
+ ret = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
}
return ret;
projects / babeltrace.git / blobdiff