* BabelTrace - CTF on File System Component
*/
-#ifndef BABELTRACE_PLUGIN_CTF_FS_H
-#define BABELTRACE_PLUGIN_CTF_FS_H
+#ifndef BABELTRACE_PLUGINS_CTF_FS_SRC_FS_HPP
+#define BABELTRACE_PLUGINS_CTF_FS_SRC_FS_HPP
#include <glib.h>
#include <babeltrace2/babeltrace.h>
-#include "cpp-common/bt2c/glib-up.hpp"
+#include "cpp-common/bt2c/aliases.hpp"
#include "cpp-common/bt2c/logging.hpp"
#include "data-stream-file.hpp"
-#include "plugins/ctf/common/src/metadata/tsdl/decoder.hpp"
+#include "plugins/ctf/common/src/metadata/metadata-stream-parser-utils.hpp"
+#include "plugins/ctf/common/src/msg-iter.hpp"
-extern bool ctf_fs_debug;
-
-struct ctf_fs_metadata
-{
- /* Owned by this */
- ctf_metadata_decoder_up decoder;
-
- /* Owned by this */
- bt_trace_class *trace_class = nullptr;
-
- /* Weak (owned by `decoder` above) */
- struct ctf_trace_class *tc = nullptr;
+#define CTF_FS_METADATA_FILENAME "metadata"
- /* Owned by this */
- char *text = nullptr;
-
- int bo = 0;
-};
-
-struct ctf_fs_trace_deleter
-{
- void operator()(ctf_fs_trace *) noexcept;
-};
+extern bool ctf_fs_debug;
struct ctf_fs_trace
{
- using UP = std::unique_ptr<ctf_fs_trace, ctf_fs_trace_deleter>;
+ using UP = std::unique_ptr<ctf_fs_trace>;
- explicit ctf_fs_trace(const bt2c::Logger& parentLogger) :
- logger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"}
+ explicit ctf_fs_trace(const ctf::src::ClkClsCfg& clkClsCfg,
+ const bt2::OptionalBorrowedObject<bt2::SelfComponent> selfComp,
+ const bt2c::Logger& parentLogger) :
+ _mLogger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"},
+ _mClkClsCfg {clkClsCfg}, _mSelfComp {selfComp}
{
}
- bt2c::Logger logger;
+ const ctf::src::TraceCls *cls() const
+ {
+ BT_ASSERT(_mParseRet);
+ BT_ASSERT(_mParseRet->traceCls);
+ return _mParseRet->traceCls.get();
+ }
+
+ const bt2s::optional<bt2c::Uuid>& metadataStreamUuid() const noexcept
+ {
+ BT_ASSERT(_mParseRet);
+ return _mParseRet->uuid;
+ }
- /* Owned by this */
- struct ctf_fs_metadata *metadata = nullptr;
+ void parseMetadata(const bt2c::ConstBytes buffer)
+ {
+ _mParseRet = ctf::src::parseMetadataStream(_mSelfComp, _mClkClsCfg, buffer, _mLogger);
+ }
- /* Owned by this */
- bt_trace *trace = nullptr;
+ bt2::Trace::Shared trace;
std::vector<ctf_fs_ds_file_group::UP> ds_file_groups;
- /* Owned by this */
- GString *path = nullptr;
+ std::string path;
/* Next automatic stream ID when not provided by packet header */
uint64_t next_stream_id = 0;
+
+private:
+ bt2c::Logger _mLogger;
+ ctf::src::ClkClsCfg _mClkClsCfg;
+ bt2::OptionalBorrowedObject<bt2::SelfComponent> _mSelfComp;
+ bt2s::optional<ctf::src::MetadataStreamParser::ParseRet> _mParseRet;
};
struct ctf_fs_port_data
struct ctf_fs_component *ctf_fs = nullptr;
};
-struct ctf_fs_component_deleter
-{
- void operator()(ctf_fs_component *);
-};
-
struct ctf_fs_component
{
- using UP = std::unique_ptr<ctf_fs_component, ctf_fs_component_deleter>;
+ using UP = std::unique_ptr<ctf_fs_component>;
- explicit ctf_fs_component(const bt2c::Logger& parentLogger) noexcept :
- logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"}
+ explicit ctf_fs_component(const ctf::src::ClkClsCfg& clkClsCfgParam,
+ const bt2c::Logger& parentLogger) noexcept :
+ logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"},
+ clkClsCfg {clkClsCfgParam}
{
}
ctf_fs_trace::UP trace;
ctf::src::ClkClsCfg clkClsCfg;
+ ctf::src::MsgIterQuirks quirks;
};
struct ctf_fs_msg_iter_data
{
- 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"}
+ using UP = std::unique_ptr<ctf_fs_msg_iter_data>;
+
+ explicit ctf_fs_msg_iter_data(const bt2::SelfMessageIterator selfMsgIterParam) :
+ selfMsgIter {selfMsgIterParam}, logger {selfMsgIter, "PLUGIN/SRC.CTF.FS/MSG-ITER"}
{
}
- /* Weak */
- bt_self_message_iterator *self_msg_iter = nullptr;
+ bt2::SelfMessageIterator selfMsgIter;
bt2c::Logger logger;
- /* Weak, belongs to ctf_fs_trace */
- struct ctf_fs_ds_file_group *ds_file_group = nullptr;
+ /* Weak, belongs to ctf_fs_component */
+ ctf_fs_port_data *port_data = nullptr;
- /* Owned by this */
- struct ctf_msg_iter *msg_iter = nullptr;
+ bt2s::optional<ctf::src::MsgIter> msgIter;
/*
* Saved error. If we hit an error in the _next method, but have some
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;
-
- 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. */
-
-ctf_fs_component::UP ctf_fs_component_create(const bt2c::Logger& parentLogger);
-
/*
* Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
* the same UUID.
* `paths_value` must be an array of strings,
*
* The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
- *
- * `self_comp` and `self_comp_class` are used for logging, only one of them
- * should be set.
*/
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 *selfComp);
+ bt2::ConstArrayValue pathsValue, const char *traceName,
+ bt2::OptionalBorrowedObject<bt2::SelfComponent> selfComp);
+
+namespace ctf {
+namespace src {
+namespace fs {
+
+/* `src.ctf.fs` parameters */
+
+struct Parameters
+{
+ explicit Parameters(const bt2::ConstArrayValue inputsParam) noexcept : inputs {inputsParam}
+ {
+ }
-/* Free `ctf_fs` and everything it owns. */
+ bt2::ConstArrayValue inputs;
+ bt2s::optional<std::string> traceName;
+ ClkClsCfg clkClsCfg;
+};
-void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
+} /* 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);
+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.
*/
-bt2c::GCharUP 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 */
+#endif /* BABELTRACE_PLUGINS_CTF_FS_SRC_FS_HPP */
projects / babeltrace.git / blobdiff