doc/api/libbabeltrace2/DoxygenLayout.xml: use `topics` tab
[babeltrace.git] / src / plugins / ctf / fs-src / data-stream-file.hpp
index a163f1dc88ef040a13aa58c1e07605a7b591ffbd..05a6db13538049d4ab194dd0695e03fa9a3f852e 100644 (file)
 #ifndef CTF_FS_DS_FILE_H
 #define CTF_FS_DS_FILE_H
 
-#include <stdio.h>
-#include <stdbool.h>
+#include <memory>
+#include <string>
+#include <vector>
+
 #include <glib.h>
-#include "common/macros.h"
+#include <stdio.h>
+
 #include <babeltrace2/babeltrace.h>
 
-#include "../common/msg-iter/msg-iter.hpp"
-#include "lttng-index.hpp"
+#include "cpp-common/bt2/trace-ir.hpp"
+#include "cpp-common/bt2c/data-len.hpp"
+#include "cpp-common/bt2c/logging.hpp"
 
-struct ctf_fs_component;
-struct ctf_fs_file;
-struct ctf_fs_trace;
-struct ctf_fs_ds_file;
-struct ctf_fs_ds_file_group;
-struct ctf_fs_ds_group_medops_data;
+#include "../common/src/msg-iter/msg-iter.hpp"
+#include "file.hpp"
 
 struct ctf_fs_ds_file_info
 {
-    /* Owned by this. */
-    GString *path;
+    using UP = std::unique_ptr<ctf_fs_ds_file_info>;
+
+    std::string path;
 
     /* Guaranteed to be set, as opposed to the index. */
-    int64_t begin_ns;
+    int64_t begin_ns = 0;
 };
 
-struct ctf_fs_metadata;
-
 struct ctf_fs_ds_file
 {
-    bt_logging_level log_level;
+    using UP = std::unique_ptr<ctf_fs_ds_file>;
 
-    /* Weak */
-    bt_self_component *self_comp;
+    explicit ctf_fs_ds_file(const bt2c::Logger& parentLogger) :
+        logger {parentLogger, "PLUGIN/SRC.CTF.FS/DS"}
+    {
+    }
+
+    ctf_fs_ds_file(const ctf_fs_ds_file&) = delete;
+    ctf_fs_ds_file& operator=(const ctf_fs_ds_file&) = delete;
+    ~ctf_fs_ds_file();
+
+    bt2c::Logger logger;
 
     /* Weak */
-    struct ctf_fs_metadata *metadata;
+    struct ctf_fs_metadata *metadata = nullptr;
 
-    /* Owned by this */
-    struct ctf_fs_file *file;
+    ctf_fs_file::UP file;
 
-    /* Owned by this */
-    bt_stream *stream;
+    bt2::Stream::Shared stream;
 
-    void *mmap_addr;
+    void *mmap_addr = nullptr;
 
     /*
      * Max length of chunk to mmap() when updating the current mapping.
      * This value must be page-aligned.
      */
-    size_t mmap_max_len;
+    size_t mmap_max_len = 0;
 
     /* Length of the current mapping. Never exceeds the file's length. */
-    size_t mmap_len;
+    size_t mmap_len = 0;
 
     /* Offset in the file where the current mapping starts. */
-    off_t mmap_offset_in_file;
+    off_t mmap_offset_in_file = 0;
 
     /*
      * Offset, in the current mapping, of the address to return on the next
      * request.
      */
-    off_t request_offset_in_mapping;
+    off_t request_offset_in_mapping = 0;
+};
+
+struct ctf_fs_ds_index_entry
+{
+    ctf_fs_ds_index_entry(const bt2c::CStringView pathParam, const bt2c::DataLen offsetParam,
+                          const bt2c::DataLen packetSizeParam) noexcept :
+        path {pathParam},
+        offset {offsetParam}, packetSize {packetSizeParam}
+    {
+    }
+
+    /* Weak, belongs to ctf_fs_ds_file_info. */
+    const char *path;
+
+    /* 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;
+
+    /*
+     * 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;
+
+    /*
+     * Packet sequence number, or UINT64_MAX if not present in the index.
+     */
+    uint64_t packet_seq_num = UINT64_MAX;
 };
 
-struct ctf_fs_ds_file *ctf_fs_ds_file_create(struct ctf_fs_trace *ctf_fs_trace, bt_stream *stream,
-                                             const char *path, bt_logging_level log_level);
+struct ctf_fs_ds_index
+{
+    std::vector<ctf_fs_ds_index_entry> entries;
+};
 
-void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);
+struct ctf_fs_ds_file_group
+{
+    using UP = std::unique_ptr<ctf_fs_ds_file_group>;
 
-struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(struct ctf_fs_ds_file *ds_file,
-                                                   struct ctf_fs_ds_file_info *ds_file_info,
-                                                   struct ctf_msg_iter *msg_iter);
+    explicit ctf_fs_ds_file_group(struct ctf_fs_trace * const trace,
+                                  ctf_stream_class * const scParam, const uint64_t streamInstanceId,
+                                  ctf_fs_ds_index indexParam) noexcept :
 
-struct ctf_fs_ds_index *ctf_fs_ds_index_create(bt_logging_level log_level,
-                                               bt_self_component *self_comp);
+        sc {scParam},
+        stream_id(streamInstanceId), ctf_fs_trace {trace}, index {std::move(indexParam)}
+
+    {
+    }
+
+    /*
+     * Insert ds_file_info in the list of ds_file_infos at the right
+     * place to keep it sorted.
+     */
+    void insert_ds_file_info_sorted(ctf_fs_ds_file_info::UP ds_file_info);
+
+    /*
+     * 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.
+     */
+    std::vector<ctf_fs_ds_file_info::UP> ds_file_infos;
+
+    /* Owned by this */
+    struct ctf_stream_class *sc = nullptr;
 
-void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index);
+    bt2::Stream::Shared stream;
+
+    /* Stream (instance) ID; -1ULL means none */
+    uint64_t stream_id = 0;
+
+    /* Weak, belongs to component */
+    struct ctf_fs_trace *ctf_fs_trace = nullptr;
+
+    ctf_fs_ds_index index;
+};
+
+ctf_fs_ds_file::UP ctf_fs_ds_file_create(ctf_fs_trace *ctf_fs_trace, bt2::Stream::Shared stream,
+                                         const char *path, const bt2c::Logger& logger);
+
+bt2s::optional<ctf_fs_ds_index> ctf_fs_ds_file_build_index(struct ctf_fs_ds_file *ds_file,
+                                                           struct ctf_fs_ds_file_info *ds_file_info,
+                                                           struct ctf_msg_iter *msg_iter);
+
+ctf_fs_ds_file_info::UP ctf_fs_ds_file_info_create(const char *path, int64_t begin_ns);
 
 /*
  * Medium operations to iterate on a single ctf_fs_ds_file.
@@ -102,12 +186,19 @@ extern struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops;
  */
 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops;
 
-enum ctf_msg_iter_medium_status ctf_fs_ds_group_medops_data_create(
-    struct ctf_fs_ds_file_group *ds_file_group, bt_self_message_iterator *self_msg_iter,
-    bt_logging_level log_level, struct ctf_fs_ds_group_medops_data **out);
+struct ctf_fs_ds_group_medops_data_deleter
+{
+    void operator()(struct ctf_fs_ds_group_medops_data *data) noexcept;
+};
+
+using ctf_fs_ds_group_medops_data_up =
+    std::unique_ptr<ctf_fs_ds_group_medops_data, ctf_fs_ds_group_medops_data_deleter>;
 
-void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data *data);
+enum ctf_msg_iter_medium_status
+ctf_fs_ds_group_medops_data_create(struct ctf_fs_ds_file_group *ds_file_group,
+                                   bt_self_message_iterator *self_msg_iter,
+                                   const bt2c::Logger& logger, ctf_fs_ds_group_medops_data_up& out);
 
-void ctf_fs_ds_group_medops_data_destroy(struct ctf_fs_ds_group_medops_data *data);
+void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data *data);
 
 #endif /* CTF_FS_DS_FILE_H */
This page took 0.026008 seconds and 4 git commands to generate.