src/plugins/ctf/fs-src/data-stream-file.hpp

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright (C) 2016 Philippe Proulx <pproulx@efficios.com>
   5  */
   6
   7 #ifndef CTF_FS_DS_FILE_H
   8 #define CTF_FS_DS_FILE_H
   9
  10 #include <memory>
  11 #include <string>
  12 #include <vector>
  13
  14 #include <glib.h>
  15 #include <stdio.h>
  16
  17 #include <babeltrace2/babeltrace.h>
  18
  19 #include "cpp-common/bt2/trace-ir.hpp"
  20 #include "cpp-common/bt2c/data-len.hpp"
  21 #include "cpp-common/bt2c/logging.hpp"
  22
  23 #include "../common/src/msg-iter/msg-iter.hpp"
  24 #include "file.hpp"
  25
  26 struct ctf_fs_ds_file_info
  27 {
  28     using UP = std::unique_ptr<ctf_fs_ds_file_info>;
  29
  30     std::string path;
  31
  32     /* Guaranteed to be set, as opposed to the index. */
  33     int64_t begin_ns = 0;
  34 };
  35
  36 struct ctf_fs_ds_file
  37 {
  38     using UP = std::unique_ptr<ctf_fs_ds_file>;
  39
  40     explicit ctf_fs_ds_file(const bt2c::Logger& parentLogger) :
  41         logger {parentLogger, "PLUGIN/SRC.CTF.FS/DS"}
  42     {
  43     }
  44
  45     ctf_fs_ds_file(const ctf_fs_ds_file&) = delete;
  46     ctf_fs_ds_file& operator=(const ctf_fs_ds_file&) = delete;
  47     ~ctf_fs_ds_file();
  48
  49     bt2c::Logger logger;
  50
  51     /* Weak */
  52     struct ctf_fs_metadata *metadata = nullptr;
  53
  54     ctf_fs_file::UP file;
  55
  56     bt2::Stream::Shared stream;
  57
  58     void *mmap_addr = nullptr;
  59
  60     /*
  61      * Max length of chunk to mmap() when updating the current mapping.
  62      * This value must be page-aligned.
  63      */
  64     size_t mmap_max_len = 0;
  65
  66     /* Length of the current mapping. Never exceeds the file's length. */
  67     size_t mmap_len = 0;
  68
  69     /* Offset in the file where the current mapping starts. */
  70     off_t mmap_offset_in_file = 0;
  71
  72     /*
  73      * Offset, in the current mapping, of the address to return on the next
  74      * request.
  75      */
  76     off_t request_offset_in_mapping = 0;
  77 };
  78
  79 struct ctf_fs_ds_index_entry
  80 {
  81     using UP = std::unique_ptr<ctf_fs_ds_index_entry>;
  82
  83     explicit ctf_fs_ds_index_entry(const bt2c::DataLen offsetParam,
  84                                    const bt2c::DataLen packetSizeParam) noexcept :
  85         offset(offsetParam),
  86         packetSize(packetSizeParam)
  87     {
  88     }
  89
  90     /* Weak, belongs to ctf_fs_ds_file_info. */
  91     const char *path = nullptr;
  92
  93     /* Position of the packet from the beginning of the file. */
  94     bt2c::DataLen offset;
  95
  96     /* Size of the packet. */
  97     bt2c::DataLen packetSize;
  98
  99     /*
 100      * Extracted from the packet context, relative to the respective fields'
 101      * mapped clock classes (in cycles).
 102      */
 103     uint64_t timestamp_begin = 0, timestamp_end = 0;
 104
 105     /*
 106      * Converted from the packet context, relative to the trace's EPOCH
 107      * (in ns since EPOCH).
 108      */
 109     int64_t timestamp_begin_ns = 0, timestamp_end_ns = 0;
 110
 111     /*
 112      * Packet sequence number, or UINT64_MAX if not present in the index.
 113      */
 114     uint64_t packet_seq_num = 0;
 115 };
 116
 117 struct ctf_fs_ds_index
 118 {
 119     using UP = std::unique_ptr<ctf_fs_ds_index>;
 120
 121     std::vector<ctf_fs_ds_index_entry::UP> entries;
 122 };
 123
 124 struct ctf_fs_ds_file_group
 125 {
 126     using UP = std::unique_ptr<ctf_fs_ds_file_group>;
 127
 128     /*
 129      * This is an _ordered_ array of data stream file infos which
 130      * belong to this group (a single stream instance).
 131      *
 132      * You can call ctf_fs_ds_file_create() with one of those paths
 133      * and the trace IR stream below.
 134      */
 135     std::vector<ctf_fs_ds_file_info::UP> ds_file_infos;
 136
 137     /* Owned by this */
 138     struct ctf_stream_class *sc = nullptr;
 139
 140     bt2::Stream::Shared stream;
 141
 142     /* Stream (instance) ID; -1ULL means none */
 143     uint64_t stream_id = 0;
 144
 145     /* Weak, belongs to component */
 146     struct ctf_fs_trace *ctf_fs_trace = nullptr;
 147
 148     ctf_fs_ds_index::UP index;
 149 };
 150
 151 ctf_fs_ds_file::UP ctf_fs_ds_file_create(ctf_fs_trace *ctf_fs_trace, bt2::Stream::Shared stream,
 152                                          const char *path, const bt2c::Logger& logger);
 153
 154 ctf_fs_ds_index::UP ctf_fs_ds_file_build_index(struct ctf_fs_ds_file *ds_file,
 155                                                struct ctf_fs_ds_file_info *ds_file_info,
 156                                                struct ctf_msg_iter *msg_iter);
 157
 158 ctf_fs_ds_index::UP ctf_fs_ds_index_create();
 159
 160 ctf_fs_ds_file_info::UP ctf_fs_ds_file_info_create(const char *path, int64_t begin_ns);
 161
 162 ctf_fs_ds_file_group::UP ctf_fs_ds_file_group_create(struct ctf_fs_trace *ctf_fs_trace,
 163                                                      struct ctf_stream_class *sc,
 164                                                      uint64_t stream_instance_id,
 165                                                      ctf_fs_ds_index::UP index);
 166
 167 /*
 168  * Medium operations to iterate on a single ctf_fs_ds_file.
 169  *
 170  * The data pointer when using this must be a pointer to the ctf_fs_ds_file.
 171  */
 172 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops;
 173
 174 /*
 175  * Medium operations to iterate on the packet of a ctf_fs_ds_group.
 176  *
 177  * The iteration is done based on the index of the group.
 178  *
 179  * The data pointer when using these medops must be a pointer to a ctf_fs_ds
 180  * group_medops_data structure.
 181  */
 182 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops;
 183
 184 struct ctf_fs_ds_group_medops_data_deleter
 185 {
 186     void operator()(struct ctf_fs_ds_group_medops_data *data) noexcept;
 187 };
 188
 189 using ctf_fs_ds_group_medops_data_up =
 190     std::unique_ptr<ctf_fs_ds_group_medops_data, ctf_fs_ds_group_medops_data_deleter>;
 191
 192 enum ctf_msg_iter_medium_status
 193 ctf_fs_ds_group_medops_data_create(struct ctf_fs_ds_file_group *ds_file_group,
 194                                    bt_self_message_iterator *self_msg_iter,
 195                                    const bt2c::Logger& logger, ctf_fs_ds_group_medops_data_up& out);
 196
 197 void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data *data);
 198
 199 #endif /* CTF_FS_DS_FILE_H */