2 * SPDX-License-Identifier: MIT
4 * Copyright (C) 2016 Philippe Proulx <pproulx@efficios.com>
7 #ifndef CTF_FS_DS_FILE_H
8 #define CTF_FS_DS_FILE_H
17 #include <babeltrace2/babeltrace.h>
19 #include "cpp-common/bt2c/data-len.hpp"
20 #include "cpp-common/bt2c/logging.hpp"
22 #include "../common/src/msg-iter/msg-iter.hpp"
24 struct ctf_fs_ds_file_info
26 using UP = std::unique_ptr<ctf_fs_ds_file_info>;
30 /* Guaranteed to be set, as opposed to the index. */
36 explicit ctf_fs_ds_file(const bt2c::Logger& parentLogger) :
37 logger {parentLogger, "PLUGIN/SRC.CTF.FS/DS"}
44 struct ctf_fs_metadata *metadata = nullptr;
47 struct ctf_fs_file *file = nullptr;
50 bt_stream *stream = nullptr;
52 void *mmap_addr = nullptr;
55 * Max length of chunk to mmap() when updating the current mapping.
56 * This value must be page-aligned.
58 size_t mmap_max_len = 0;
60 /* Length of the current mapping. Never exceeds the file's length. */
63 /* Offset in the file where the current mapping starts. */
64 off_t mmap_offset_in_file = 0;
67 * Offset, in the current mapping, of the address to return on the next
70 off_t request_offset_in_mapping = 0;
73 struct ctf_fs_ds_index_entry
75 explicit ctf_fs_ds_index_entry(const bt2c::DataLen offsetParam,
76 const bt2c::DataLen packetSizeParam) noexcept :
78 packetSize(packetSizeParam)
82 /* Weak, belongs to ctf_fs_ds_file_info. */
83 const char *path = nullptr;
85 /* Position of the packet from the beginning of the file. */
88 /* Size of the packet. */
89 bt2c::DataLen packetSize;
92 * Extracted from the packet context, relative to the respective fields'
93 * mapped clock classes (in cycles).
95 uint64_t timestamp_begin = 0, timestamp_end = 0;
98 * Converted from the packet context, relative to the trace's EPOCH
99 * (in ns since EPOCH).
101 int64_t timestamp_begin_ns = 0, timestamp_end_ns = 0;
104 * Packet sequence number, or UINT64_MAX if not present in the index.
106 uint64_t packet_seq_num = 0;
109 struct ctf_fs_ds_index_deleter
111 void operator()(struct ctf_fs_ds_index *index) noexcept;
114 struct ctf_fs_ds_index
116 using UP = std::unique_ptr<ctf_fs_ds_index, ctf_fs_ds_index_deleter>;
118 /* Array of pointer to struct ctf_fs_ds_index_entry. */
119 GPtrArray *entries = nullptr;
122 struct ctf_fs_ds_file_group_deleter
124 void operator()(struct ctf_fs_ds_file_group *group) noexcept;
127 struct ctf_fs_ds_file_group
129 using UP = std::unique_ptr<ctf_fs_ds_file_group, ctf_fs_ds_file_group_deleter>;
132 * This is an _ordered_ array of data stream file infos which
133 * belong to this group (a single stream instance).
135 * You can call ctf_fs_ds_file_create() with one of those paths
136 * and the trace IR stream below.
138 std::vector<ctf_fs_ds_file_info::UP> ds_file_infos;
141 struct ctf_stream_class *sc = nullptr;
144 bt_stream *stream = nullptr;
146 /* Stream (instance) ID; -1ULL means none */
147 uint64_t stream_id = 0;
149 /* Weak, belongs to component */
150 struct ctf_fs_trace *ctf_fs_trace = nullptr;
152 ctf_fs_ds_index::UP index;
155 struct ctf_fs_ds_file *ctf_fs_ds_file_create(struct ctf_fs_trace *ctf_fs_trace, bt_stream *stream,
156 const char *path, const bt2c::Logger& logger);
158 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);
160 ctf_fs_ds_index::UP ctf_fs_ds_file_build_index(struct ctf_fs_ds_file *ds_file,
161 struct ctf_fs_ds_file_info *ds_file_info,
162 struct ctf_msg_iter *msg_iter);
164 ctf_fs_ds_index::UP ctf_fs_ds_index_create(const bt2c::Logger& logger);
166 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index);
168 ctf_fs_ds_file_info::UP ctf_fs_ds_file_info_create(const char *path, int64_t begin_ns);
170 ctf_fs_ds_file_group::UP ctf_fs_ds_file_group_create(struct ctf_fs_trace *ctf_fs_trace,
171 struct ctf_stream_class *sc,
172 uint64_t stream_instance_id,
173 ctf_fs_ds_index::UP index);
176 * Medium operations to iterate on a single ctf_fs_ds_file.
178 * The data pointer when using this must be a pointer to the ctf_fs_ds_file.
180 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops;
183 * Medium operations to iterate on the packet of a ctf_fs_ds_group.
185 * The iteration is done based on the index of the group.
187 * The data pointer when using these medops must be a pointer to a ctf_fs_ds
188 * group_medops_data structure.
190 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops;
192 enum ctf_msg_iter_medium_status ctf_fs_ds_group_medops_data_create(
193 struct ctf_fs_ds_file_group *ds_file_group, bt_self_message_iterator *self_msg_iter,
194 const bt2c::Logger& logger, struct ctf_fs_ds_group_medops_data **out);
196 void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data *data);
198 void ctf_fs_ds_group_medops_data_destroy(struct ctf_fs_ds_group_medops_data *data);
200 #endif /* CTF_FS_DS_FILE_H */