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