doc/api/libbabeltrace2/DoxygenLayout.xml: use `topics` tab
[babeltrace.git] / src / plugins / ctf / fs-src / fs.hpp
index 4446524c64728af2f5707c8209a3cfb21d9be498..c9ca2a90be0dd093086a89c6ced1f38d3eaedfa7 100644 (file)
 
 #include <babeltrace2/babeltrace.h>
 
-#include "cpp-common/bt2c/data-len.hpp"
-#include "cpp-common/bt2c/glib-up.hpp"
 #include "cpp-common/bt2c/logging.hpp"
 
-#include "metadata.hpp"
+#include "data-stream-file.hpp"
 #include "plugins/ctf/common/src/metadata/tsdl/decoder.hpp"
 
 extern bool ctf_fs_debug;
 
-struct ctf_fs_file
-{
-    explicit ctf_fs_file(const bt2c::Logger& parentLogger) :
-        logger {parentLogger, "PLUGIN/SRC.CTF.FS/FILE"}
-    {
-    }
-
-    bt2c::Logger logger;
-
-    /* Owned by this */
-    GString *path = nullptr;
-
-    /* Owned by this */
-    FILE *fp = nullptr;
-
-    off_t size = 0;
-};
-
 struct ctf_fs_metadata
 {
+    using UP = std::unique_ptr<ctf_fs_metadata>;
+
     /* Owned by this */
     ctf_metadata_decoder_up decoder;
 
-    /* Owned by this */
-    bt_trace_class *trace_class = nullptr;
+    bt2::TraceClass::Shared trace_class;
 
     /* Weak (owned by `decoder` above) */
     struct ctf_trace_class *tc = nullptr;
 
-    /* Owned by this */
-    char *text = nullptr;
-
     int bo = 0;
 };
 
-struct ctf_fs_component_deleter
-{
-    void operator()(struct ctf_fs_component *);
-};
-
-struct ctf_fs_component
-{
-    using UP = std::unique_ptr<ctf_fs_component, ctf_fs_component_deleter>;
-
-    explicit ctf_fs_component(const bt2c::Logger& parentLogger) :
-        logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"}
-    {
-    }
-
-    bt2c::Logger logger;
-
-    /* Array of struct ctf_fs_port_data *, owned by this */
-    GPtrArray *port_data = nullptr;
-
-    /* Owned by this */
-    struct ctf_fs_trace *trace = nullptr;
-
-    ctf::src::ClkClsCfg clkClsCfg;
-};
-
 struct ctf_fs_trace
 {
+    using UP = std::unique_ptr<ctf_fs_trace>;
+
     explicit ctf_fs_trace(const bt2c::Logger& parentLogger) :
         logger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"}
     {
@@ -92,106 +47,53 @@ struct ctf_fs_trace
 
     bt2c::Logger logger;
 
-    /* Owned by this */
-    struct ctf_fs_metadata *metadata = nullptr;
+    ctf_fs_metadata::UP metadata;
 
-    /* Owned by this */
-    bt_trace *trace = nullptr;
+    bt2::Trace::Shared trace;
 
-    /* Array of struct ctf_fs_ds_file_group *, owned by this */
-    GPtrArray *ds_file_groups = nullptr;
+    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;
 };
 
-struct ctf_fs_ds_index_entry
+struct ctf_fs_port_data
 {
-    explicit ctf_fs_ds_index_entry(const bt2c::DataLen offsetParam,
-                                   const bt2c::DataLen packetSizeParam) noexcept :
-        offset(offsetParam),
-        packetSize(packetSizeParam)
-    {
-    }
-
-    /* Weak, belongs to ctf_fs_ds_file_info. */
-    const char *path = nullptr;
-
-    /* Position of the packet from the beginning of the file. */
-    bt2c::DataLen offset;
-
-    /* Size of the packet. */
-    bt2c::DataLen packetSize;
-
-    /*
-     * Extracted from the packet context, relative to the respective fields'
-     * mapped clock classes (in cycles).
-     */
-    uint64_t timestamp_begin = 0, timestamp_end = 0;
+    using UP = std::unique_ptr<ctf_fs_port_data>;
 
-    /*
-     * Converted from the packet context, relative to the trace's EPOCH
-     * (in ns since EPOCH).
-     */
-    int64_t timestamp_begin_ns = 0, timestamp_end_ns = 0;
+    /* Weak, belongs to ctf_fs_trace */
+    struct ctf_fs_ds_file_group *ds_file_group = nullptr;
 
-    /*
-     * Packet sequence number, or UINT64_MAX if not present in the index.
-     */
-    uint64_t packet_seq_num = 0;
+    /* Weak */
+    struct ctf_fs_component *ctf_fs = nullptr;
 };
 
-struct ctf_fs_ds_index
+struct ctf_fs_component
 {
-    /* Array of pointer to struct ctf_fs_ds_index_entry. */
-    GPtrArray *entries = nullptr;
-};
+    using UP = std::unique_ptr<ctf_fs_component>;
 
-struct ctf_fs_ds_file_group
-{
-    /*
-     * 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 = nullptr;
-
-    /* Owned by this */
-    struct ctf_stream_class *sc = nullptr;
-
-    /* Owned by this */
-    bt_stream *stream = nullptr;
-
-    /* Stream (instance) ID; -1ULL means none */
-    uint64_t stream_id = 0;
+    explicit ctf_fs_component(const ctf::src::ClkClsCfg& clkClsCfgParam,
+                              const bt2c::Logger& parentLogger) noexcept :
+        logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"},
+        clkClsCfg {clkClsCfgParam}
+    {
+    }
 
-    /* Weak, belongs to component */
-    struct ctf_fs_trace *ctf_fs_trace = nullptr;
+    bt2c::Logger logger;
 
-    /*
-     * Owned by this.
-     */
-    struct ctf_fs_ds_index *index = nullptr;
-};
+    std::vector<ctf_fs_port_data::UP> port_data;
 
-struct ctf_fs_port_data
-{
-    /* Weak, belongs to ctf_fs_trace */
-    struct ctf_fs_ds_file_group *ds_file_group = nullptr;
+    ctf_fs_trace::UP trace;
 
-    /* Weak */
-    struct ctf_fs_component *ctf_fs = nullptr;
+    ctf::src::ClkClsCfg clkClsCfg;
 };
 
 struct ctf_fs_msg_iter_data
 {
+    using UP = std::unique_ptr<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"}
@@ -206,8 +108,7 @@ struct ctf_fs_msg_iter_data
     /* Weak, belongs to ctf_fs_trace */
     struct ctf_fs_ds_file_group *ds_file_group = nullptr;
 
-    /* Owned by this */
-    struct ctf_msg_iter *msg_iter = nullptr;
+    ctf_msg_iter_up msg_iter;
 
     /*
      * Saved error.  If we hit an error in the _next method, but have some
@@ -218,7 +119,7 @@ struct ctf_fs_msg_iter_data
         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 = nullptr;
+    ctf_fs_ds_group_medops_data_up msg_iter_medops_data;
 };
 
 bt_component_class_initialize_method_status
@@ -246,10 +147,6 @@ ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const
 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.
@@ -263,36 +160,43 @@ ctf_fs_component::UP ctf_fs_component_create(const bt2c::Logger& parentLogger);
  */
 
 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,
+                                         bt2::ConstArrayValue pathsValue, const char *traceName,
                                          bt_self_component *selfComp);
 
-/* Free `ctf_fs` and everything it owns. */
+namespace ctf {
+namespace src {
+namespace fs {
 
-void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
+/* `src.ctf.fs` parameters */
+
+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);
+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 */
This page took 0.027379 seconds and 4 git commands to generate.