Commit | Line | Data |
---|---|---|
e98a2d6e | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
e98a2d6e | 3 | * |
0235b0db MJ |
4 | * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com> |
5 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
6 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation | |
e98a2d6e PP |
7 | */ |
8 | ||
c802cacb | 9 | #include <glib.h> |
c802cacb SM |
10 | #include <stdint.h> |
11 | #include <stdio.h> | |
c802cacb | 12 | |
83ad336c | 13 | #include "compat/endian.h" /* IWYU pragma: keep */ |
0f5c5d5c | 14 | #include "compat/mman.h" /* IWYU: pragma keep */ |
ffb66082 | 15 | #include "cpp-common/bt2c/glib-up.hpp" |
2cef6403 | 16 | #include "cpp-common/bt2s/make-unique.hpp" |
0f5c5d5c | 17 | #include "cpp-common/vendor/fmt/format.h" |
c802cacb | 18 | |
5656cea5 | 19 | #include "../common/src/msg-iter/msg-iter.hpp" |
087cd0f5 | 20 | #include "data-stream-file.hpp" |
c802cacb | 21 | #include "file.hpp" |
c7e1be4b SM |
22 | #include "fs.hpp" |
23 | #include "lttng-index.hpp" | |
e98a2d6e | 24 | |
4164020e | 25 | static inline size_t remaining_mmap_bytes(struct ctf_fs_ds_file *ds_file) |
e98a2d6e | 26 | { |
4164020e SM |
27 | BT_ASSERT_DBG(ds_file->mmap_len >= ds_file->request_offset_in_mapping); |
28 | return ds_file->mmap_len - ds_file->request_offset_in_mapping; | |
e98a2d6e PP |
29 | } |
30 | ||
127e2341 SM |
31 | /* |
32 | * Return true if `offset_in_file` is in the current mapping. | |
33 | */ | |
34 | ||
4164020e | 35 | static bool offset_ist_mapped(struct ctf_fs_ds_file *ds_file, off_t offset_in_file) |
127e2341 | 36 | { |
4164020e SM |
37 | return offset_in_file >= ds_file->mmap_offset_in_file && |
38 | offset_in_file < (ds_file->mmap_offset_in_file + ds_file->mmap_len); | |
127e2341 SM |
39 | } |
40 | ||
4164020e | 41 | static enum ctf_msg_iter_medium_status ds_file_munmap(struct ctf_fs_ds_file *ds_file) |
e98a2d6e | 42 | { |
4164020e | 43 | enum ctf_msg_iter_medium_status status; |
4164020e SM |
44 | |
45 | BT_ASSERT(ds_file); | |
46 | ||
47 | if (!ds_file->mmap_addr) { | |
48 | status = CTF_MSG_ITER_MEDIUM_STATUS_OK; | |
49 | goto end; | |
50 | } | |
51 | ||
52 | if (bt_munmap(ds_file->mmap_addr, ds_file->mmap_len)) { | |
0f5c5d5c SM |
53 | BT_CPPLOGE_ERRNO_SPEC(ds_file->logger, "Cannot memory-unmap file", |
54 | ": address={}, size={}, file_path=\"{}\", file={}", | |
55 | fmt::ptr(ds_file->mmap_addr), ds_file->mmap_len, | |
a39d9817 | 56 | ds_file->file ? ds_file->file->path : "NULL", |
0f5c5d5c | 57 | ds_file->file ? fmt::ptr(ds_file->file->fp) : NULL); |
4164020e SM |
58 | status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR; |
59 | goto end; | |
60 | } | |
61 | ||
62 | ds_file->mmap_addr = NULL; | |
63 | ||
64 | status = CTF_MSG_ITER_MEDIUM_STATUS_OK; | |
fc9a526c | 65 | end: |
4164020e | 66 | return status; |
e98a2d6e PP |
67 | } |
68 | ||
127e2341 SM |
69 | /* |
70 | * mmap a region of `ds_file` such that `requested_offset_in_file` is in the | |
71 | * mapping. If the currently mmap-ed region already contains | |
72 | * `requested_offset_in_file`, the mapping is kept. | |
73 | * | |
f6e68e70 SM |
74 | * Set `ds_file->requested_offset_in_mapping` based on `request_offset_in_file`, |
75 | * such that the next call to `request_bytes` will return bytes starting at that | |
76 | * position. | |
127e2341 SM |
77 | * |
78 | * `requested_offset_in_file` must be a valid offset in the file. | |
79 | */ | |
4164020e SM |
80 | static enum ctf_msg_iter_medium_status ds_file_mmap(struct ctf_fs_ds_file *ds_file, |
81 | off_t requested_offset_in_file) | |
e98a2d6e | 82 | { |
4164020e | 83 | enum ctf_msg_iter_medium_status status; |
4164020e SM |
84 | |
85 | /* Ensure the requested offset is in the file range. */ | |
86 | BT_ASSERT(requested_offset_in_file >= 0); | |
87 | BT_ASSERT(requested_offset_in_file < ds_file->file->size); | |
88 | ||
89 | /* | |
90 | * If the mapping already contains the requested offset, just adjust | |
91 | * requested_offset_in_mapping. | |
92 | */ | |
93 | if (offset_ist_mapped(ds_file, requested_offset_in_file)) { | |
94 | ds_file->request_offset_in_mapping = | |
95 | requested_offset_in_file - ds_file->mmap_offset_in_file; | |
96 | status = CTF_MSG_ITER_MEDIUM_STATUS_OK; | |
97 | goto end; | |
98 | } | |
99 | ||
100 | /* Unmap old region */ | |
101 | status = ds_file_munmap(ds_file); | |
102 | if (status != CTF_MSG_ITER_MEDIUM_STATUS_OK) { | |
103 | goto end; | |
104 | } | |
105 | ||
106 | /* | |
107 | * Compute a mapping that has the required alignment properties and | |
108 | * contains `requested_offset_in_file`. | |
109 | */ | |
110 | ds_file->request_offset_in_mapping = | |
0f5c5d5c SM |
111 | requested_offset_in_file % |
112 | bt_mmap_get_offset_align_size(static_cast<int>(ds_file->logger.level())); | |
4164020e SM |
113 | ds_file->mmap_offset_in_file = requested_offset_in_file - ds_file->request_offset_in_mapping; |
114 | ds_file->mmap_len = | |
115 | MIN(ds_file->file->size - ds_file->mmap_offset_in_file, ds_file->mmap_max_len); | |
116 | ||
117 | BT_ASSERT(ds_file->mmap_len > 0); | |
118 | ||
119 | ds_file->mmap_addr = | |
85a25425 | 120 | bt_mmap(ds_file->mmap_len, PROT_READ, MAP_PRIVATE, fileno(ds_file->file->fp.get()), |
0f5c5d5c | 121 | ds_file->mmap_offset_in_file, static_cast<int>(ds_file->logger.level())); |
4164020e | 122 | if (ds_file->mmap_addr == MAP_FAILED) { |
0f5c5d5c SM |
123 | BT_CPPLOGE_SPEC(ds_file->logger, |
124 | "Cannot memory-map address (size {}) of file \"{}\" ({}) at offset {}: {}", | |
a39d9817 | 125 | ds_file->mmap_len, ds_file->file->path, fmt::ptr(ds_file->file->fp), |
0f5c5d5c | 126 | (intmax_t) ds_file->mmap_offset_in_file, strerror(errno)); |
4164020e SM |
127 | status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR; |
128 | goto end; | |
129 | } | |
130 | ||
131 | status = CTF_MSG_ITER_MEDIUM_STATUS_OK; | |
127e2341 SM |
132 | |
133 | end: | |
4164020e | 134 | return status; |
127e2341 SM |
135 | } |
136 | ||
137 | /* | |
138 | * Change the mapping of the file to read the region that follows the current | |
139 | * mapping. | |
140 | * | |
141 | * If the file hasn't been mapped yet, then everything (mmap_offset_in_file, | |
142 | * mmap_len, request_offset_in_mapping) should have the value 0, which will | |
143 | * result in the beginning of the file getting mapped. | |
144 | * | |
145 | * return _EOF if the current mapping is the end of the file. | |
146 | */ | |
147 | ||
4164020e | 148 | static enum ctf_msg_iter_medium_status ds_file_mmap_next(struct ctf_fs_ds_file *ds_file) |
127e2341 | 149 | { |
4164020e SM |
150 | enum ctf_msg_iter_medium_status status; |
151 | ||
152 | /* | |
153 | * If we're called, it's because more bytes are requested but we have | |
154 | * given all the bytes of the current mapping. | |
155 | */ | |
156 | BT_ASSERT(ds_file->request_offset_in_mapping == ds_file->mmap_len); | |
157 | ||
158 | /* | |
159 | * If the current mapping coincides with the end of the file, there is | |
160 | * no next mapping. | |
161 | */ | |
162 | if (ds_file->mmap_offset_in_file + ds_file->mmap_len == ds_file->file->size) { | |
163 | status = CTF_MSG_ITER_MEDIUM_STATUS_EOF; | |
164 | goto end; | |
165 | } | |
166 | ||
167 | status = ds_file_mmap(ds_file, ds_file->mmap_offset_in_file + ds_file->mmap_len); | |
127e2341 | 168 | |
e98a2d6e | 169 | end: |
4164020e | 170 | return status; |
e98a2d6e PP |
171 | } |
172 | ||
4164020e SM |
173 | static enum ctf_msg_iter_medium_status medop_request_bytes(size_t request_sz, uint8_t **buffer_addr, |
174 | size_t *buffer_sz, void *data) | |
e98a2d6e | 175 | { |
4164020e SM |
176 | enum ctf_msg_iter_medium_status status = CTF_MSG_ITER_MEDIUM_STATUS_OK; |
177 | struct ctf_fs_ds_file *ds_file = (struct ctf_fs_ds_file *) data; | |
4164020e SM |
178 | |
179 | BT_ASSERT(request_sz > 0); | |
180 | ||
181 | /* | |
182 | * Check if we have at least one memory-mapped byte left. If we don't, | |
183 | * mmap the next file. | |
184 | */ | |
185 | if (remaining_mmap_bytes(ds_file) == 0) { | |
186 | /* Are we at the end of the file? */ | |
187 | if (ds_file->mmap_offset_in_file >= ds_file->file->size) { | |
a39d9817 SM |
188 | BT_CPPLOGD_SPEC(ds_file->logger, "Reached end of file \"{}\" ({})", ds_file->file->path, |
189 | fmt::ptr(ds_file->file->fp)); | |
4164020e SM |
190 | status = CTF_MSG_ITER_MEDIUM_STATUS_EOF; |
191 | goto end; | |
192 | } | |
193 | ||
194 | status = ds_file_mmap_next(ds_file); | |
195 | switch (status) { | |
196 | case CTF_MSG_ITER_MEDIUM_STATUS_OK: | |
197 | break; | |
198 | case CTF_MSG_ITER_MEDIUM_STATUS_EOF: | |
199 | goto end; | |
200 | default: | |
0f5c5d5c | 201 | BT_CPPLOGE_SPEC(ds_file->logger, "Cannot memory-map next region of file \"{}\" ({})", |
a39d9817 | 202 | ds_file->file->path, fmt::ptr(ds_file->file->fp)); |
4164020e SM |
203 | goto error; |
204 | } | |
205 | } | |
206 | ||
207 | BT_ASSERT(remaining_mmap_bytes(ds_file) > 0); | |
208 | *buffer_sz = MIN(remaining_mmap_bytes(ds_file), request_sz); | |
209 | ||
210 | BT_ASSERT(ds_file->mmap_addr); | |
211 | *buffer_addr = ((uint8_t *) ds_file->mmap_addr) + ds_file->request_offset_in_mapping; | |
212 | ||
213 | ds_file->request_offset_in_mapping += *buffer_sz; | |
214 | goto end; | |
e98a2d6e PP |
215 | |
216 | error: | |
4164020e | 217 | status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR; |
e98a2d6e PP |
218 | |
219 | end: | |
4164020e | 220 | return status; |
e98a2d6e PP |
221 | } |
222 | ||
ecd7492f | 223 | static bt_stream *medop_borrow_stream(bt_stream_class *stream_class, int64_t, void *data) |
e98a2d6e | 224 | { |
4164020e SM |
225 | struct ctf_fs_ds_file *ds_file = (struct ctf_fs_ds_file *) data; |
226 | bt_stream_class *ds_file_stream_class; | |
227 | bt_stream *stream = NULL; | |
e5be10ef | 228 | |
265d4ba2 | 229 | ds_file_stream_class = ds_file->stream->cls().libObjPtr(); |
94cf822e | 230 | |
4164020e SM |
231 | if (stream_class != ds_file_stream_class) { |
232 | /* | |
233 | * Not supported: two packets described by two different | |
234 | * stream classes within the same data stream file. | |
235 | */ | |
236 | goto end; | |
237 | } | |
e98a2d6e | 238 | |
265d4ba2 | 239 | stream = ds_file->stream->libObjPtr(); |
94cf822e PP |
240 | |
241 | end: | |
4164020e | 242 | return stream; |
e98a2d6e PP |
243 | } |
244 | ||
4164020e | 245 | static enum ctf_msg_iter_medium_status medop_seek(off_t offset, void *data) |
9e0c8dbb | 246 | { |
4164020e | 247 | struct ctf_fs_ds_file *ds_file = (struct ctf_fs_ds_file *) data; |
9e0c8dbb | 248 | |
4164020e SM |
249 | BT_ASSERT(offset >= 0); |
250 | BT_ASSERT(offset < ds_file->file->size); | |
9e0c8dbb | 251 | |
4164020e | 252 | return ds_file_mmap(ds_file, offset); |
9e0c8dbb JG |
253 | } |
254 | ||
18a1979b | 255 | struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops = { |
4164020e SM |
256 | medop_request_bytes, |
257 | medop_seek, | |
258 | nullptr, | |
259 | medop_borrow_stream, | |
e98a2d6e | 260 | }; |
6de92955 | 261 | |
4164020e SM |
262 | struct ctf_fs_ds_group_medops_data |
263 | { | |
0f5c5d5c SM |
264 | explicit ctf_fs_ds_group_medops_data(const bt2c::Logger& parentLogger) : |
265 | logger {parentLogger, "PLUGIN/SRC.CTF.FS/DS-GROUP-MEDOPS"} | |
266 | { | |
267 | } | |
268 | ||
269 | bt2c::Logger logger; | |
270 | ||
4164020e | 271 | /* Weak, set once at creation time. */ |
afb0f12b | 272 | struct ctf_fs_ds_file_group *ds_file_group = nullptr; |
4164020e SM |
273 | |
274 | /* | |
275 | * Index (as in element rank) of the index entry of ds_file_groups' | |
276 | * index we will read next (so, the one after the one we are reading | |
277 | * right now). | |
278 | */ | |
afb0f12b | 279 | guint next_index_entry_index = 0; |
4164020e SM |
280 | |
281 | /* | |
282 | * File we are currently reading. Changes whenever we switch to | |
283 | * reading another data file. | |
4164020e | 284 | */ |
55ea683f | 285 | ctf_fs_ds_file::UP file; |
4164020e SM |
286 | |
287 | /* Weak, for context / logging / appending causes. */ | |
afb0f12b | 288 | bt_self_message_iterator *self_msg_iter = nullptr; |
f6e68e70 SM |
289 | }; |
290 | ||
4164020e SM |
291 | static enum ctf_msg_iter_medium_status medop_group_request_bytes(size_t request_sz, |
292 | uint8_t **buffer_addr, | |
293 | size_t *buffer_sz, void *void_data) | |
f6e68e70 | 294 | { |
4164020e | 295 | struct ctf_fs_ds_group_medops_data *data = (struct ctf_fs_ds_group_medops_data *) void_data; |
f6e68e70 | 296 | |
4164020e | 297 | /* Return bytes from the current file. */ |
55ea683f | 298 | return medop_request_bytes(request_sz, buffer_addr, buffer_sz, data->file.get()); |
f6e68e70 SM |
299 | } |
300 | ||
4164020e SM |
301 | static bt_stream *medop_group_borrow_stream(bt_stream_class *stream_class, int64_t stream_id, |
302 | void *void_data) | |
f6e68e70 | 303 | { |
4164020e | 304 | struct ctf_fs_ds_group_medops_data *data = (struct ctf_fs_ds_group_medops_data *) void_data; |
f6e68e70 | 305 | |
55ea683f | 306 | return medop_borrow_stream(stream_class, stream_id, data->file.get()); |
f6e68e70 SM |
307 | } |
308 | ||
309 | /* | |
310 | * Set `data->file` to prepare it to read the packet described | |
311 | * by `index_entry`. | |
312 | */ | |
313 | ||
4164020e SM |
314 | static enum ctf_msg_iter_medium_status |
315 | ctf_fs_ds_group_medops_set_file(struct ctf_fs_ds_group_medops_data *data, | |
0f5c5d5c | 316 | struct ctf_fs_ds_index_entry *index_entry) |
f6e68e70 | 317 | { |
4164020e SM |
318 | enum ctf_msg_iter_medium_status status; |
319 | ||
320 | BT_ASSERT(data); | |
321 | BT_ASSERT(index_entry); | |
322 | ||
323 | /* Check if that file is already the one mapped. */ | |
a39d9817 | 324 | if (!data->file || data->file->file->path != index_entry->path) { |
4164020e | 325 | /* Create the new file. */ |
265d4ba2 SM |
326 | data->file = |
327 | ctf_fs_ds_file_create(data->ds_file_group->ctf_fs_trace, data->ds_file_group->stream, | |
55ea683f | 328 | index_entry->path, data->logger); |
4164020e | 329 | if (!data->file) { |
0f5c5d5c | 330 | BT_CPPLOGE_APPEND_CAUSE_SPEC(data->logger, "failed to create ctf_fs_ds_file."); |
4164020e SM |
331 | status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR; |
332 | goto end; | |
333 | } | |
334 | } | |
335 | ||
336 | /* | |
337 | * Ensure the right portion of the file will be returned on the next | |
338 | * request_bytes call. | |
339 | */ | |
55ea683f | 340 | status = ds_file_mmap(data->file.get(), index_entry->offset.bytes()); |
4164020e SM |
341 | if (status != CTF_MSG_ITER_MEDIUM_STATUS_OK) { |
342 | goto end; | |
343 | } | |
344 | ||
345 | status = CTF_MSG_ITER_MEDIUM_STATUS_OK; | |
f6e68e70 SM |
346 | |
347 | end: | |
4164020e | 348 | return status; |
f6e68e70 SM |
349 | } |
350 | ||
4164020e | 351 | static enum ctf_msg_iter_medium_status medop_group_switch_packet(void *void_data) |
f6e68e70 | 352 | { |
4164020e SM |
353 | struct ctf_fs_ds_group_medops_data *data = (struct ctf_fs_ds_group_medops_data *) void_data; |
354 | struct ctf_fs_ds_index_entry *index_entry; | |
355 | enum ctf_msg_iter_medium_status status; | |
356 | ||
357 | /* If we have gone through all index entries, we are done. */ | |
2fb7af12 | 358 | if (data->next_index_entry_index >= data->ds_file_group->index->entries.size()) { |
4164020e SM |
359 | status = CTF_MSG_ITER_MEDIUM_STATUS_EOF; |
360 | goto end; | |
361 | } | |
362 | ||
363 | /* | |
364 | * Otherwise, look up the next index entry / packet and prepare it | |
365 | * for reading. | |
366 | */ | |
2fb7af12 | 367 | index_entry = data->ds_file_group->index->entries[data->next_index_entry_index].get(); |
4164020e | 368 | |
0f5c5d5c | 369 | status = ctf_fs_ds_group_medops_set_file(data, index_entry); |
4164020e SM |
370 | if (status != CTF_MSG_ITER_MEDIUM_STATUS_OK) { |
371 | goto end; | |
372 | } | |
373 | ||
374 | data->next_index_entry_index++; | |
375 | ||
376 | status = CTF_MSG_ITER_MEDIUM_STATUS_OK; | |
f6e68e70 | 377 | end: |
4164020e | 378 | return status; |
f6e68e70 SM |
379 | } |
380 | ||
3cf88182 SM |
381 | void ctf_fs_ds_group_medops_data_deleter::operator()(ctf_fs_ds_group_medops_data *data) noexcept |
382 | { | |
2db013e0 | 383 | delete data; |
3cf88182 SM |
384 | } |
385 | ||
f6e68e70 | 386 | enum ctf_msg_iter_medium_status ctf_fs_ds_group_medops_data_create( |
4164020e | 387 | struct ctf_fs_ds_file_group *ds_file_group, bt_self_message_iterator *self_msg_iter, |
3cf88182 | 388 | const bt2c::Logger& parentLogger, ctf_fs_ds_group_medops_data_up& out) |
f6e68e70 | 389 | { |
4164020e SM |
390 | BT_ASSERT(self_msg_iter); |
391 | BT_ASSERT(ds_file_group); | |
392 | BT_ASSERT(ds_file_group->index); | |
2fb7af12 | 393 | BT_ASSERT(!ds_file_group->index->entries.empty()); |
4164020e | 394 | |
3cf88182 SM |
395 | out.reset(new ctf_fs_ds_group_medops_data {parentLogger}); |
396 | ||
397 | out->ds_file_group = ds_file_group; | |
398 | out->self_msg_iter = self_msg_iter; | |
4164020e SM |
399 | |
400 | /* | |
401 | * No need to prepare the first file. ctf_msg_iter will call | |
402 | * switch_packet before reading the first packet, it will be | |
403 | * done then. | |
404 | */ | |
405 | ||
afb0f12b | 406 | return CTF_MSG_ITER_MEDIUM_STATUS_OK; |
f6e68e70 SM |
407 | } |
408 | ||
409 | void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data *data) | |
410 | { | |
4164020e | 411 | data->next_index_entry_index = 0; |
f6e68e70 SM |
412 | } |
413 | ||
414 | struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops = { | |
4164020e | 415 | .request_bytes = medop_group_request_bytes, |
f6e68e70 | 416 | |
4164020e SM |
417 | /* |
418 | * We don't support seeking using this medops. It would probably be | |
419 | * possible, but it's not needed at the moment. | |
420 | */ | |
421 | .seek = NULL, | |
087cd0f5 | 422 | |
4164020e SM |
423 | .switch_packet = medop_group_switch_packet, |
424 | .borrow_stream = medop_group_borrow_stream, | |
f6e68e70 SM |
425 | }; |
426 | ||
c05e1405 SM |
427 | static ctf_fs_ds_index_entry::UP ctf_fs_ds_index_entry_create(const bt2c::DataLen offset, |
428 | const bt2c::DataLen packetSize) | |
afb0f12b | 429 | { |
c05e1405 | 430 | ctf_fs_ds_index_entry::UP entry = bt2s::make_unique<ctf_fs_ds_index_entry>(offset, packetSize); |
ef7d7ac2 | 431 | |
4164020e | 432 | entry->packet_seq_num = UINT64_MAX; |
6834784d | 433 | |
4164020e | 434 | return entry; |
6834784d SM |
435 | } |
436 | ||
4164020e | 437 | static int convert_cycles_to_ns(struct ctf_clock_class *clock_class, uint64_t cycles, int64_t *ns) |
b6c3dcb2 | 438 | { |
4164020e SM |
439 | return bt_util_clock_cycles_to_ns_from_origin(cycles, clock_class->frequency, |
440 | clock_class->offset_seconds, | |
441 | clock_class->offset_cycles, ns); | |
97ade20b JG |
442 | } |
443 | ||
441fa755 SM |
444 | static ctf_fs_ds_index::UP build_index_from_idx_file(struct ctf_fs_ds_file *ds_file, |
445 | struct ctf_fs_ds_file_info *file_info, | |
446 | struct ctf_msg_iter *msg_iter) | |
97ade20b | 447 | { |
4164020e | 448 | int ret; |
ffb66082 SM |
449 | bt2c::GCharUP directory; |
450 | bt2c::GCharUP basename; | |
a6d50870 | 451 | std::string index_basename; |
ffb66082 | 452 | bt2c::GCharUP index_file_path; |
fbd12812 | 453 | bt2c::GMappedFileUP mapped_file; |
4164020e SM |
454 | gsize filesize; |
455 | const char *mmap_begin = NULL, *file_pos = NULL; | |
456 | const struct ctf_packet_index_file_hdr *header = NULL; | |
441fa755 | 457 | ctf_fs_ds_index::UP index; |
c05e1405 SM |
458 | ctf_fs_ds_index_entry::UP index_entry; |
459 | ctf_fs_ds_index_entry *prev_index_entry = NULL; | |
ef7d7ac2 | 460 | auto totalPacketsSize = bt2c::DataLen::fromBytes(0); |
4164020e SM |
461 | size_t file_index_entry_size; |
462 | size_t file_entry_count; | |
463 | size_t i; | |
464 | struct ctf_stream_class *sc; | |
465 | struct ctf_msg_iter_packet_properties props; | |
466 | uint32_t version_major, version_minor; | |
4164020e | 467 | |
0f5c5d5c | 468 | BT_CPPLOGI_SPEC(ds_file->logger, "Building index from .idx file of stream file {}", |
a39d9817 | 469 | ds_file->file->path); |
4164020e SM |
470 | ret = ctf_msg_iter_get_packet_properties(msg_iter, &props); |
471 | if (ret) { | |
0f5c5d5c SM |
472 | BT_CPPLOGI_STR_SPEC(ds_file->logger, |
473 | "Cannot read first packet's header and context fields."); | |
4164020e SM |
474 | goto error; |
475 | } | |
476 | ||
477 | sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, props.stream_class_id); | |
478 | BT_ASSERT(sc); | |
479 | if (!sc->default_clock_class) { | |
0f5c5d5c | 480 | BT_CPPLOGI_STR_SPEC(ds_file->logger, "Cannot find stream class's default clock class."); |
4164020e SM |
481 | goto error; |
482 | } | |
483 | ||
484 | /* Look for index file in relative path index/name.idx. */ | |
ffb66082 | 485 | basename.reset(g_path_get_basename(ds_file->file->path.c_str())); |
4164020e | 486 | if (!basename) { |
0f5c5d5c | 487 | BT_CPPLOGE_SPEC(ds_file->logger, "Cannot get the basename of datastream file {}", |
a39d9817 | 488 | ds_file->file->path); |
4164020e SM |
489 | goto error; |
490 | } | |
491 | ||
ffb66082 | 492 | directory.reset(g_path_get_dirname(ds_file->file->path.c_str())); |
4164020e | 493 | if (!directory) { |
0f5c5d5c | 494 | BT_CPPLOGE_SPEC(ds_file->logger, "Cannot get dirname of datastream file {}", |
a39d9817 | 495 | ds_file->file->path); |
4164020e SM |
496 | goto error; |
497 | } | |
498 | ||
a6d50870 SM |
499 | index_basename = fmt::format("{}.idx", basename.get()); |
500 | index_file_path.reset(g_build_filename(directory.get(), "index", index_basename.c_str(), NULL)); | |
fbd12812 | 501 | mapped_file.reset(g_mapped_file_new(index_file_path.get(), FALSE, NULL)); |
4164020e | 502 | if (!mapped_file) { |
ffb66082 | 503 | BT_CPPLOGD_SPEC(ds_file->logger, "Cannot create new mapped file {}", index_file_path.get()); |
4164020e SM |
504 | goto error; |
505 | } | |
506 | ||
507 | /* | |
508 | * The g_mapped_file API limits us to 4GB files on 32-bit. | |
509 | * Traces with such large indexes have never been seen in the wild, | |
510 | * but this would need to be adjusted to support them. | |
511 | */ | |
fbd12812 | 512 | filesize = g_mapped_file_get_length(mapped_file.get()); |
4164020e | 513 | if (filesize < sizeof(*header)) { |
0f5c5d5c SM |
514 | BT_CPPLOGW_SPEC(ds_file->logger, |
515 | "Invalid LTTng trace index file: " | |
516 | "file size ({} bytes) < header size ({} bytes)", | |
517 | filesize, sizeof(*header)); | |
4164020e SM |
518 | goto error; |
519 | } | |
520 | ||
fbd12812 | 521 | mmap_begin = g_mapped_file_get_contents(mapped_file.get()); |
4164020e SM |
522 | header = (struct ctf_packet_index_file_hdr *) mmap_begin; |
523 | ||
fbd12812 | 524 | file_pos = g_mapped_file_get_contents(mapped_file.get()) + sizeof(*header); |
4164020e | 525 | if (be32toh(header->magic) != CTF_INDEX_MAGIC) { |
0f5c5d5c SM |
526 | BT_CPPLOGW_STR_SPEC(ds_file->logger, |
527 | "Invalid LTTng trace index: \"magic\" field validation failed"); | |
4164020e SM |
528 | goto error; |
529 | } | |
530 | ||
531 | version_major = be32toh(header->index_major); | |
532 | version_minor = be32toh(header->index_minor); | |
533 | if (version_major != 1) { | |
0f5c5d5c SM |
534 | BT_CPPLOGW_SPEC(ds_file->logger, "Unknown LTTng trace index version: major={}, minor={}", |
535 | version_major, version_minor); | |
4164020e SM |
536 | goto error; |
537 | } | |
538 | ||
539 | file_index_entry_size = be32toh(header->packet_index_len); | |
540 | if (file_index_entry_size < CTF_INDEX_1_0_SIZE) { | |
0f5c5d5c SM |
541 | BT_CPPLOGW_SPEC( |
542 | ds_file->logger, | |
4164020e | 543 | "Invalid `packet_index_len` in LTTng trace index file (`packet_index_len` < CTF index 1.0 index entry size): " |
0f5c5d5c | 544 | "packet_index_len={}, CTF_INDEX_1_0_SIZE={}", |
4164020e SM |
545 | file_index_entry_size, CTF_INDEX_1_0_SIZE); |
546 | goto error; | |
547 | } | |
548 | ||
549 | file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size; | |
550 | if ((filesize - sizeof(*header)) % file_index_entry_size) { | |
0f5c5d5c SM |
551 | BT_CPPLOGW_SPEC(ds_file->logger, |
552 | "Invalid LTTng trace index: the index's size after the header " | |
553 | "({} bytes) is not a multiple of the index entry size " | |
554 | "({} bytes)", | |
555 | (filesize - sizeof(*header)), sizeof(*header)); | |
4164020e SM |
556 | goto error; |
557 | } | |
558 | ||
19d9bb23 | 559 | index = bt2s::make_unique<ctf_fs_ds_index>(); |
4164020e SM |
560 | |
561 | for (i = 0; i < file_entry_count; i++) { | |
562 | struct ctf_packet_index *file_index = (struct ctf_packet_index *) file_pos; | |
ef7d7ac2 | 563 | const auto packetSize = bt2c::DataLen::fromBits(be64toh(file_index->packet_size)); |
4164020e | 564 | |
ef7d7ac2 | 565 | if (packetSize.hasExtraBits()) { |
0f5c5d5c SM |
566 | BT_CPPLOGW_SPEC(ds_file->logger, |
567 | "Invalid packet size encountered in LTTng trace index file"); | |
4164020e SM |
568 | goto error; |
569 | } | |
570 | ||
ef7d7ac2 SM |
571 | const auto offset = bt2c::DataLen::fromBytes(be64toh(file_index->offset)); |
572 | ||
573 | if (i != 0 && offset < prev_index_entry->offset) { | |
574 | BT_CPPLOGW_SPEC( | |
575 | ds_file->logger, | |
576 | "Invalid, non-monotonic, packet offset encountered in LTTng trace index file: " | |
577 | "previous offset={} bytes, current offset={} bytes", | |
578 | prev_index_entry->offset.bytes(), offset.bytes()); | |
579 | goto error; | |
580 | } | |
581 | ||
582 | index_entry = ctf_fs_ds_index_entry_create(offset, packetSize); | |
4164020e | 583 | if (!index_entry) { |
0f5c5d5c SM |
584 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ds_file->logger, |
585 | "Failed to create a ctf_fs_ds_index_entry."); | |
4164020e SM |
586 | goto error; |
587 | } | |
588 | ||
589 | /* Set path to stream file. */ | |
4d199954 | 590 | index_entry->path = file_info->path.c_str(); |
4164020e | 591 | |
4164020e SM |
592 | index_entry->timestamp_begin = be64toh(file_index->timestamp_begin); |
593 | index_entry->timestamp_end = be64toh(file_index->timestamp_end); | |
594 | if (index_entry->timestamp_end < index_entry->timestamp_begin) { | |
0f5c5d5c SM |
595 | BT_CPPLOGW_SPEC( |
596 | ds_file->logger, | |
4164020e | 597 | "Invalid packet time bounds encountered in LTTng trace index file (begin > end): " |
0f5c5d5c | 598 | "timestamp_begin={}, timestamp_end={}", |
4164020e SM |
599 | index_entry->timestamp_begin, index_entry->timestamp_end); |
600 | goto error; | |
601 | } | |
602 | ||
603 | /* Convert the packet's bound to nanoseconds since Epoch. */ | |
604 | ret = convert_cycles_to_ns(sc->default_clock_class, index_entry->timestamp_begin, | |
605 | &index_entry->timestamp_begin_ns); | |
606 | if (ret) { | |
0f5c5d5c SM |
607 | BT_CPPLOGI_STR_SPEC( |
608 | ds_file->logger, | |
4164020e SM |
609 | "Failed to convert raw timestamp to nanoseconds since Epoch during index parsing"); |
610 | goto error; | |
611 | } | |
612 | ret = convert_cycles_to_ns(sc->default_clock_class, index_entry->timestamp_end, | |
613 | &index_entry->timestamp_end_ns); | |
614 | if (ret) { | |
0f5c5d5c SM |
615 | BT_CPPLOGI_STR_SPEC( |
616 | ds_file->logger, | |
4164020e SM |
617 | "Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing"); |
618 | goto error; | |
619 | } | |
620 | ||
621 | if (version_minor >= 1) { | |
622 | index_entry->packet_seq_num = be64toh(file_index->packet_seq_num); | |
623 | } | |
624 | ||
ef7d7ac2 | 625 | totalPacketsSize += packetSize; |
4164020e SM |
626 | file_pos += file_index_entry_size; |
627 | ||
c05e1405 | 628 | prev_index_entry = index_entry.get(); |
4164020e | 629 | |
2fb7af12 | 630 | index->entries.emplace_back(std::move(index_entry)); |
4164020e SM |
631 | } |
632 | ||
633 | /* Validate that the index addresses the complete stream. */ | |
ef7d7ac2 | 634 | if (ds_file->file->size != totalPacketsSize.bytes()) { |
0f5c5d5c SM |
635 | BT_CPPLOGW_SPEC(ds_file->logger, |
636 | "Invalid LTTng trace index file; indexed size != stream file size: " | |
ef7d7ac2 SM |
637 | "file-size={} bytes, total-packets-size={} bytes", |
638 | ds_file->file->size, totalPacketsSize.bytes()); | |
4164020e SM |
639 | goto error; |
640 | } | |
b6c3dcb2 | 641 | end: |
4164020e | 642 | return index; |
97ade20b | 643 | error: |
441fa755 | 644 | index.reset(); |
4164020e | 645 | goto end; |
b6c3dcb2 JG |
646 | } |
647 | ||
4164020e | 648 | static int init_index_entry(struct ctf_fs_ds_index_entry *entry, struct ctf_fs_ds_file *ds_file, |
ef7d7ac2 | 649 | struct ctf_msg_iter_packet_properties *props) |
9e0c8dbb | 650 | { |
4164020e SM |
651 | int ret = 0; |
652 | struct ctf_stream_class *sc; | |
4164020e SM |
653 | |
654 | sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, props->stream_class_id); | |
655 | BT_ASSERT(sc); | |
4164020e SM |
656 | |
657 | if (props->snapshots.beginning_clock != UINT64_C(-1)) { | |
658 | entry->timestamp_begin = props->snapshots.beginning_clock; | |
659 | ||
660 | /* Convert the packet's bound to nanoseconds since Epoch. */ | |
661 | ret = convert_cycles_to_ns(sc->default_clock_class, props->snapshots.beginning_clock, | |
662 | &entry->timestamp_begin_ns); | |
663 | if (ret) { | |
0f5c5d5c SM |
664 | BT_CPPLOGI_STR_SPEC(ds_file->logger, |
665 | "Failed to convert raw timestamp to nanoseconds since Epoch."); | |
4164020e SM |
666 | goto end; |
667 | } | |
668 | } else { | |
669 | entry->timestamp_begin = UINT64_C(-1); | |
670 | entry->timestamp_begin_ns = UINT64_C(-1); | |
671 | } | |
672 | ||
673 | if (props->snapshots.end_clock != UINT64_C(-1)) { | |
674 | entry->timestamp_end = props->snapshots.end_clock; | |
675 | ||
676 | /* Convert the packet's bound to nanoseconds since Epoch. */ | |
677 | ret = convert_cycles_to_ns(sc->default_clock_class, props->snapshots.end_clock, | |
678 | &entry->timestamp_end_ns); | |
679 | if (ret) { | |
0f5c5d5c SM |
680 | BT_CPPLOGI_STR_SPEC(ds_file->logger, |
681 | "Failed to convert raw timestamp to nanoseconds since Epoch."); | |
4164020e SM |
682 | goto end; |
683 | } | |
684 | } else { | |
685 | entry->timestamp_end = UINT64_C(-1); | |
686 | entry->timestamp_end_ns = UINT64_C(-1); | |
687 | } | |
0b29603d | 688 | |
9e0c8dbb | 689 | end: |
4164020e | 690 | return ret; |
9e0c8dbb JG |
691 | } |
692 | ||
441fa755 SM |
693 | static ctf_fs_ds_index::UP build_index_from_stream_file(struct ctf_fs_ds_file *ds_file, |
694 | struct ctf_fs_ds_file_info *file_info, | |
695 | struct ctf_msg_iter *msg_iter) | |
9e0c8dbb | 696 | { |
4164020e | 697 | int ret; |
4164020e | 698 | enum ctf_msg_iter_status iter_status = CTF_MSG_ITER_STATUS_OK; |
ef7d7ac2 | 699 | auto currentPacketOffset = bt2c::DataLen::fromBytes(0); |
4164020e | 700 | |
a39d9817 | 701 | BT_CPPLOGI_SPEC(ds_file->logger, "Indexing stream file {}", ds_file->file->path); |
4164020e | 702 | |
19d9bb23 | 703 | ctf_fs_ds_index::UP index = bt2s::make_unique<ctf_fs_ds_index>(); |
4164020e SM |
704 | |
705 | while (true) { | |
4164020e SM |
706 | struct ctf_msg_iter_packet_properties props; |
707 | ||
ef7d7ac2 | 708 | if (currentPacketOffset.bytes() > ds_file->file->size) { |
0f5c5d5c SM |
709 | BT_CPPLOGE_STR_SPEC(ds_file->logger, |
710 | "Unexpected current packet's offset (larger than file)."); | |
4164020e | 711 | goto error; |
ef7d7ac2 | 712 | } else if (currentPacketOffset.bytes() == ds_file->file->size) { |
4164020e SM |
713 | /* No more data */ |
714 | break; | |
715 | } | |
716 | ||
ef7d7ac2 | 717 | iter_status = ctf_msg_iter_seek(msg_iter, currentPacketOffset.bytes()); |
4164020e SM |
718 | if (iter_status != CTF_MSG_ITER_STATUS_OK) { |
719 | goto error; | |
720 | } | |
721 | ||
722 | iter_status = ctf_msg_iter_get_packet_properties(msg_iter, &props); | |
723 | if (iter_status != CTF_MSG_ITER_STATUS_OK) { | |
724 | goto error; | |
725 | } | |
726 | ||
ef7d7ac2 SM |
727 | /* |
728 | * Get the current packet size from the packet header, if set. Else, | |
729 | * assume there is a single packet in the file, so take the file size | |
730 | * as the packet size. | |
731 | */ | |
732 | const auto currentPacketSize = props.exp_packet_total_size >= 0 ? | |
733 | bt2c::DataLen::fromBits(props.exp_packet_total_size) : | |
734 | bt2c::DataLen::fromBytes(ds_file->file->size); | |
4164020e | 735 | |
ef7d7ac2 | 736 | if ((currentPacketOffset + currentPacketSize).bytes() > ds_file->file->size) { |
0f5c5d5c SM |
737 | BT_CPPLOGW_SPEC(ds_file->logger, |
738 | "Invalid packet size reported in file: stream=\"{}\", " | |
ef7d7ac2 SM |
739 | "packet-offset-bytes={}, packet-size-bytes={}, " |
740 | "file-size-bytes={}", | |
a39d9817 | 741 | ds_file->file->path, currentPacketOffset.bytes(), |
ef7d7ac2 | 742 | currentPacketSize.bytes(), ds_file->file->size); |
4164020e SM |
743 | goto error; |
744 | } | |
745 | ||
c05e1405 | 746 | auto index_entry = ctf_fs_ds_index_entry_create(currentPacketOffset, currentPacketSize); |
4164020e | 747 | if (!index_entry) { |
0f5c5d5c SM |
748 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ds_file->logger, |
749 | "Failed to create a ctf_fs_ds_index_entry."); | |
4164020e SM |
750 | goto error; |
751 | } | |
752 | ||
753 | /* Set path to stream file. */ | |
4d199954 | 754 | index_entry->path = file_info->path.c_str(); |
4164020e | 755 | |
c05e1405 | 756 | ret = init_index_entry(index_entry.get(), ds_file, &props); |
4164020e | 757 | if (ret) { |
4164020e SM |
758 | goto error; |
759 | } | |
760 | ||
2fb7af12 | 761 | index->entries.emplace_back(std::move(index_entry)); |
4164020e | 762 | |
ef7d7ac2 | 763 | currentPacketOffset += currentPacketSize; |
0f5c5d5c | 764 | BT_CPPLOGD_SPEC(ds_file->logger, |
ef7d7ac2 SM |
765 | "Seeking to next packet: current-packet-offset-bytes={}, " |
766 | "next-packet-offset-bytes={}", | |
767 | (currentPacketOffset - currentPacketSize).bytes(), | |
768 | currentPacketOffset.bytes()); | |
4164020e | 769 | } |
312c056a | 770 | |
9e0c8dbb | 771 | end: |
4164020e | 772 | return index; |
312c056a | 773 | |
9e0c8dbb | 774 | error: |
441fa755 | 775 | index.reset(); |
4164020e | 776 | goto end; |
9e0c8dbb JG |
777 | } |
778 | ||
89f88383 SM |
779 | ctf_fs_ds_file::UP ctf_fs_ds_file_create(struct ctf_fs_trace *ctf_fs_trace, |
780 | bt2::Stream::Shared stream, const char *path, | |
781 | const bt2c::Logger& parentLogger) | |
e98a2d6e | 782 | { |
4164020e | 783 | int ret; |
89f88383 | 784 | auto ds_file = bt2s::make_unique<ctf_fs_ds_file>(parentLogger); |
0f5c5d5c | 785 | size_t offset_align; |
4164020e | 786 | |
4726b1ee | 787 | ds_file->file = bt2s::make_unique<ctf_fs_file>(parentLogger); |
265d4ba2 | 788 | ds_file->stream = std::move(stream); |
2dba3a29 | 789 | ds_file->metadata = ctf_fs_trace->metadata.get(); |
a39d9817 | 790 | ds_file->file->path = path; |
c44dc433 | 791 | ret = ctf_fs_file_open(ds_file->file.get(), "rb"); |
4164020e SM |
792 | if (ret) { |
793 | goto error; | |
794 | } | |
795 | ||
0f5c5d5c | 796 | offset_align = bt_mmap_get_offset_align_size(static_cast<int>(ds_file->logger.level())); |
4164020e SM |
797 | ds_file->mmap_max_len = offset_align * 2048; |
798 | ||
799 | goto end; | |
1a9f7075 | 800 | |
e98a2d6e | 801 | error: |
4164020e | 802 | /* Do not touch "borrowed" file. */ |
89f88383 | 803 | ds_file.reset(); |
1a9f7075 | 804 | |
e98a2d6e | 805 | end: |
4164020e | 806 | return ds_file; |
e98a2d6e PP |
807 | } |
808 | ||
441fa755 SM |
809 | ctf_fs_ds_index::UP ctf_fs_ds_file_build_index(struct ctf_fs_ds_file *ds_file, |
810 | struct ctf_fs_ds_file_info *file_info, | |
811 | struct ctf_msg_iter *msg_iter) | |
97ade20b | 812 | { |
441fa755 | 813 | auto index = build_index_from_idx_file(ds_file, file_info, msg_iter); |
4164020e SM |
814 | if (index) { |
815 | goto end; | |
816 | } | |
817 | ||
0f5c5d5c SM |
818 | BT_CPPLOGI_SPEC(ds_file->logger, "Failed to build index from .index file; " |
819 | "falling back to stream indexing."); | |
4164020e | 820 | index = build_index_from_stream_file(ds_file, file_info, msg_iter); |
9e0c8dbb | 821 | end: |
4164020e | 822 | return index; |
97ade20b JG |
823 | } |
824 | ||
3199f1ba | 825 | ctf_fs_ds_file::~ctf_fs_ds_file() |
e98a2d6e | 826 | { |
3199f1ba | 827 | (void) ds_file_munmap(this); |
e98a2d6e | 828 | } |
4f1f88a6 | 829 | |
2cef6403 | 830 | ctf_fs_ds_file_info::UP ctf_fs_ds_file_info_create(const char *path, int64_t begin_ns) |
873c329a | 831 | { |
2cef6403 | 832 | ctf_fs_ds_file_info::UP ds_file_info = bt2s::make_unique<ctf_fs_ds_file_info>(); |
873c329a | 833 | |
4d199954 | 834 | ds_file_info->path = path; |
873c329a | 835 | ds_file_info->begin_ns = begin_ns; |
873c329a SM |
836 | return ds_file_info; |
837 | } | |
838 | ||
fe2e19c4 SM |
839 | ctf_fs_ds_file_group::UP ctf_fs_ds_file_group_create(struct ctf_fs_trace *ctf_fs_trace, |
840 | struct ctf_stream_class *sc, | |
841 | uint64_t stream_instance_id, | |
fe2f9cda | 842 | ctf_fs_ds_index::UP index) |
fe2e19c4 SM |
843 | { |
844 | ctf_fs_ds_file_group::UP ds_file_group {new ctf_fs_ds_file_group}; | |
845 | ||
fe2f9cda | 846 | ds_file_group->index = std::move(index); |
873c329a SM |
847 | |
848 | ds_file_group->stream_id = stream_instance_id; | |
849 | BT_ASSERT(sc); | |
850 | ds_file_group->sc = sc; | |
851 | ds_file_group->ctf_fs_trace = ctf_fs_trace; | |
873c329a | 852 | |
873c329a SM |
853 | return ds_file_group; |
854 | } |