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