#ifndef BABELTRACE_PLUGIN_CTF_FS_H
#define BABELTRACE_PLUGIN_CTF_FS_H
-#include <stdbool.h>
+#include <glib.h>
#include <babeltrace2/babeltrace.h>
-#include "common/macros.h"
+#include "cpp-common/bt2c/logging.hpp"
-#include "../common/metadata/decoder.hpp"
#include "data-stream-file.hpp"
-#include "metadata.hpp"
+#include "plugins/ctf/common/src/metadata/tsdl/decoder.hpp"
extern bool ctf_fs_debug;
-struct ctf_fs_file
-{
- bt_logging_level log_level;
-
- /* Weak */
- bt_self_component *self_comp;
-
- /* Owned by this */
- GString *path;
-
- /* Owned by this */
- FILE *fp;
-
- off_t size;
-};
-
struct ctf_fs_metadata
{
- /* Owned by this */
- struct ctf_metadata_decoder *decoder;
+ using UP = std::unique_ptr<ctf_fs_metadata>;
/* Owned by this */
- bt_trace_class *trace_class;
-
- /* Weak (owned by `decoder` above) */
- struct ctf_trace_class *tc;
-
- /* Owned by this */
- char *text;
-
- int bo;
-};
-
-struct ctf_fs_component
-{
- bt_logging_level log_level;
+ ctf_metadata_decoder_up decoder;
- /* Array of struct ctf_fs_port_data *, owned by this */
- GPtrArray *port_data;
+ bt2::TraceClass::Shared trace_class;
- /* Owned by this */
- struct ctf_fs_trace *trace;
+ /* Weak (owned by `decoder` above) */
+ struct ctf_trace_class *tc = nullptr;
- struct ctf_fs_metadata_config metadata_config;
+ int bo = 0;
};
struct ctf_fs_trace
{
- bt_logging_level log_level;
+ using UP = std::unique_ptr<ctf_fs_trace>;
- /*
- * Weak. These are mostly used to generate log messages or to append
- * error causes. They are mutually exclusive, only one of them must be
- * set.
- */
- bt_self_component *self_comp;
- bt_self_component_class *self_comp_class;
+ explicit ctf_fs_trace(const bt2c::Logger& parentLogger) :
+ logger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"}
+ {
+ }
- /* Owned by this */
- struct ctf_fs_metadata *metadata;
+ bt2c::Logger logger;
- /* Owned by this */
- bt_trace *trace;
+ ctf_fs_metadata::UP metadata;
- /* Array of struct ctf_fs_ds_file_group *, owned by this */
- GPtrArray *ds_file_groups;
+ bt2::Trace::Shared trace;
- /* Owned by this */
- GString *path;
+ std::vector<ctf_fs_ds_file_group::UP> ds_file_groups;
+
+ std::string path;
/* Next automatic stream ID when not provided by packet header */
- uint64_t next_stream_id;
+ uint64_t next_stream_id = 0;
};
-struct ctf_fs_ds_index_entry
+struct ctf_fs_port_data
{
- /* Weak, belongs to ctf_fs_ds_file_info. */
- const char *path;
-
- /* Position, in bytes, of the packet from the beginning of the file. */
- uint64_t offset;
-
- /* Size of the packet, in bytes. */
- uint64_t packet_size;
-
- /*
- * Extracted from the packet context, relative to the respective fields'
- * mapped clock classes (in cycles).
- */
- uint64_t timestamp_begin, timestamp_end;
-
- /*
- * Converted from the packet context, relative to the trace's EPOCH
- * (in ns since EPOCH).
- */
- int64_t timestamp_begin_ns, timestamp_end_ns;
+ using UP = std::unique_ptr<ctf_fs_port_data>;
- /*
- * Packet sequence number, or UINT64_MAX if not present in the index.
- */
- uint64_t packet_seq_num;
-};
+ /* Weak, belongs to ctf_fs_trace */
+ struct ctf_fs_ds_file_group *ds_file_group = nullptr;
-struct ctf_fs_ds_index
-{
- /* Array of pointer to struct ctf_fs_ds_index_entry. */
- GPtrArray *entries;
+ /* Weak */
+ struct ctf_fs_component *ctf_fs = nullptr;
};
-struct ctf_fs_ds_file_group
+struct ctf_fs_component
{
- /*
- * Array of struct ctf_fs_ds_file_info, owned by this.
- *
- * This is an _ordered_ array of data stream file infos which
- * belong to this group (a single stream instance).
- *
- * You can call ctf_fs_ds_file_create() with one of those paths
- * and the trace IR stream below.
- */
- GPtrArray *ds_file_infos;
+ using UP = std::unique_ptr<ctf_fs_component>;
- /* Owned by this */
- struct ctf_stream_class *sc;
+ explicit ctf_fs_component(const bt2c::Logger& parentLogger) noexcept :
+ logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"}
+ {
+ }
- /* Owned by this */
- bt_stream *stream;
+ bt2c::Logger logger;
- /* Stream (instance) ID; -1ULL means none */
- uint64_t stream_id;
+ std::vector<ctf_fs_port_data::UP> port_data;
- /* Weak, belongs to component */
- struct ctf_fs_trace *ctf_fs_trace;
-
- /*
- * Owned by this.
- */
- struct ctf_fs_ds_index *index;
-};
-
-struct ctf_fs_port_data
-{
- /* Weak, belongs to ctf_fs_trace */
- struct ctf_fs_ds_file_group *ds_file_group;
+ ctf_fs_trace::UP trace;
- /* Weak */
- struct ctf_fs_component *ctf_fs;
+ ctf::src::ClkClsCfg clkClsCfg;
};
struct ctf_fs_msg_iter_data
{
- bt_logging_level log_level;
+ using UP = std::unique_ptr<ctf_fs_msg_iter_data>;
- /* Weak */
- bt_self_component *self_comp;
+ explicit ctf_fs_msg_iter_data(bt_self_message_iterator *selfMsgIter) :
+ self_msg_iter {selfMsgIter}, logger {bt2::SelfMessageIterator {self_msg_iter},
+ "PLUGIN/SRC.CTF.FS/MSG-ITER"}
+ {
+ }
/* Weak */
- bt_self_message_iterator *self_msg_iter;
+ bt_self_message_iterator *self_msg_iter = nullptr;
+
+ bt2c::Logger logger;
/* Weak, belongs to ctf_fs_trace */
- struct ctf_fs_ds_file_group *ds_file_group;
+ struct ctf_fs_ds_file_group *ds_file_group = nullptr;
- /* Owned by this */
- struct ctf_msg_iter *msg_iter;
+ ctf_msg_iter_up msg_iter;
/*
* Saved error. If we hit an error in the _next method, but have some
* messages ready to return, we save the error here and return it on
* the next _next call.
*/
- bt_message_iterator_class_next_method_status next_saved_status;
- const struct bt_error *next_saved_error;
+ bt_message_iterator_class_next_method_status next_saved_status =
+ BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
+ const struct bt_error *next_saved_error = nullptr;
- struct ctf_fs_ds_group_medops_data *msg_iter_medops_data;
+ ctf_fs_ds_group_medops_data_up msg_iter_medops_data;
};
bt_component_class_initialize_method_status
bt_message_iterator_class_seek_beginning_method_status
ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator);
-/* Create and initialize a new, empty ctf_fs_component. */
-
-struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level);
-
/*
* Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
* the same UUID.
*/
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);
+ bt2::ConstArrayValue pathsValue, const char *traceName,
+ bt_self_component *selfComp);
+
+namespace ctf {
+namespace src {
+namespace fs {
-/* Free `ctf_fs` and everything it owns. */
+/* `src.ctf.fs` parameters */
-void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
+struct Parameters
+{
+ explicit Parameters(const bt2::ConstArrayValue inputsParam) noexcept : inputs {inputsParam}
+ {
+ }
+
+ bt2::ConstArrayValue inputs;
+ bt2s::optional<std::string> traceName;
+ ClkClsCfg clkClsCfg;
+};
+
+} /* namespace fs */
+} /* namespace src */
+} /* namespace ctf */
/*
* Read and validate parameters taken by the src.ctf.fs plugin.
*
- * - The mandatory `paths` parameter is returned in `*paths`.
- * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
- * present, are recorded in the `ctf_fs` structure.
- * - The optional `trace-name` parameter is returned in `*trace_name` if
- * present, else `*trace_name` is set to NULL.
- *
- * `self_comp` and `self_comp_class` are used for logging, only one of them
- * should be set.
- *
- * Return true on success, false if any parameter didn't pass validation.
+ * Throw if any parameter doesn't pass validation.
*/
-bool read_src_fs_parameters(const bt_value *params, const bt_value **paths,
- const bt_value **trace_name, struct ctf_fs_component *ctf_fs,
- bt_self_component *self_comp, bt_self_component_class *self_comp_class);
+ctf::src::fs::Parameters read_src_fs_parameters(bt2::ConstMapValue params,
+ const bt2c::Logger& logger);
/*
* Generate the port name to be used for a given data stream file group.
- *
- * The result must be freed using g_free by the caller.
*/
-gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
+std::string ctf_fs_make_port_name(ctf_fs_ds_file_group *ds_file_group);
#endif /* BABELTRACE_PLUGIN_CTF_FS_H */
projects / babeltrace.git / blobdiff