Commit | Line | Data |
---|---|---|
e98a2d6e | 1 | /* |
94cf822e | 2 | * Copyright 2016-2017 - Philippe Proulx <pproulx@efficios.com> |
fc9a526c | 3 | * Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com> |
e98a2d6e PP |
4 | * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation |
5 | * | |
e98a2d6e PP |
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
7 | * of this software and associated documentation files (the "Software"), to deal | |
8 | * in the Software without restriction, including without limitation the rights | |
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
10 | * copies of the Software, and to permit persons to whom the Software is | |
11 | * furnished to do so, subject to the following conditions: | |
12 | * | |
13 | * The above copyright notice and this permission notice shall be included in | |
14 | * all copies or substantial portions of the Software. | |
15 | * | |
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
22 | * SOFTWARE. | |
23 | */ | |
24 | ||
d7bc0973 SM |
25 | #define BT_COMP_LOG_SELF_COMP (self_comp) |
26 | #define BT_LOG_OUTPUT_LEVEL (log_level) | |
3d731ea9 | 27 | #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/DS" |
3fa1b6a3 | 28 | #include "logging/comp-logging.h" |
3d731ea9 | 29 | |
0fbb9a9f | 30 | #include <stdlib.h> |
e98a2d6e PP |
31 | #include <stdio.h> |
32 | #include <stdint.h> | |
33 | #include <stdlib.h> | |
e98a2d6e PP |
34 | #include <glib.h> |
35 | #include <inttypes.h> | |
57952005 MJ |
36 | #include "compat/mman.h" |
37 | #include "compat/endian.h" | |
71c5da58 | 38 | #include <babeltrace2/babeltrace.h> |
57952005 | 39 | #include "common/common.h" |
78586d8a JG |
40 | #include "file.h" |
41 | #include "metadata.h" | |
b09a5592 | 42 | #include "../common/msg-iter/msg-iter.h" |
57952005 | 43 | #include "common/assert.h" |
94cf822e | 44 | #include "data-stream-file.h" |
e9383dfd | 45 | #include <string.h> |
e98a2d6e | 46 | |
4f1f88a6 | 47 | static inline |
94cf822e | 48 | size_t remaining_mmap_bytes(struct ctf_fs_ds_file *ds_file) |
e98a2d6e | 49 | { |
43b07461 SM |
50 | BT_ASSERT_DBG(ds_file->mmap_len >= ds_file->request_offset_in_mapping); |
51 | return ds_file->mmap_len - ds_file->request_offset_in_mapping; | |
e98a2d6e PP |
52 | } |
53 | ||
5b29e799 | 54 | static |
3baf7da0 SM |
55 | enum ctf_msg_iter_medium_status ds_file_munmap( |
56 | struct ctf_fs_ds_file *ds_file) | |
e98a2d6e | 57 | { |
3baf7da0 | 58 | enum ctf_msg_iter_medium_status status; |
d7bc0973 SM |
59 | bt_self_component *self_comp = ds_file->self_comp; |
60 | bt_logging_level log_level = ds_file->log_level; | |
e98a2d6e | 61 | |
4bbea805 SM |
62 | BT_ASSERT(ds_file); |
63 | ||
64 | if (!ds_file->mmap_addr) { | |
3baf7da0 | 65 | status = CTF_MSG_ITER_MEDIUM_STATUS_OK; |
94cf822e PP |
66 | goto end; |
67 | } | |
68 | ||
a555e971 | 69 | if (bt_munmap(ds_file->mmap_addr, ds_file->mmap_len)) { |
f67894f9 | 70 | BT_COMP_LOGE_ERRNO("Cannot memory-unmap file", |
2a48e5ae | 71 | ": address=%p, size=%zu, file_path=\"%s\", file=%p", |
94cf822e | 72 | ds_file->mmap_addr, ds_file->mmap_len, |
bb230c9b | 73 | ds_file->file ? ds_file->file->path->str : "NULL", |
2a48e5ae | 74 | ds_file->file ? ds_file->file->fp : NULL); |
3baf7da0 | 75 | status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR; |
fc9a526c | 76 | goto end; |
e98a2d6e | 77 | } |
94cf822e PP |
78 | |
79 | ds_file->mmap_addr = NULL; | |
80 | ||
3baf7da0 | 81 | status = CTF_MSG_ITER_MEDIUM_STATUS_OK; |
fc9a526c | 82 | end: |
3baf7da0 | 83 | return status; |
e98a2d6e PP |
84 | } |
85 | ||
5b29e799 | 86 | static |
5d452e1f | 87 | enum ctf_msg_iter_medium_status ds_file_mmap_next( |
94cf822e | 88 | struct ctf_fs_ds_file *ds_file) |
e98a2d6e | 89 | { |
3baf7da0 | 90 | enum ctf_msg_iter_medium_status status; |
d7bc0973 SM |
91 | bt_self_component *self_comp = ds_file->self_comp; |
92 | bt_logging_level log_level = ds_file->log_level; | |
e98a2d6e PP |
93 | |
94 | /* Unmap old region */ | |
94cf822e | 95 | if (ds_file->mmap_addr) { |
3baf7da0 SM |
96 | status = ds_file_munmap(ds_file); |
97 | if (status != CTF_MSG_ITER_MEDIUM_STATUS_OK) { | |
98 | goto end; | |
e98a2d6e PP |
99 | } |
100 | ||
7b7d8091 | 101 | /* |
52eb1a72 | 102 | * mmap_len is guaranteed to be page-aligned except on the |
7b7d8091 JG |
103 | * last mapping where it may not be possible (since the file's |
104 | * size itself may not be a page multiple). | |
105 | */ | |
43b07461 SM |
106 | ds_file->mmap_offset_in_file += ds_file->mmap_len; |
107 | ds_file->request_offset_in_mapping = 0; | |
e98a2d6e PP |
108 | } |
109 | ||
43b07461 | 110 | ds_file->mmap_len = MIN(ds_file->file->size - ds_file->mmap_offset_in_file, |
94cf822e | 111 | ds_file->mmap_max_len); |
52eb1a72 | 112 | if (ds_file->mmap_len == 0) { |
3baf7da0 | 113 | status = CTF_MSG_ITER_MEDIUM_STATUS_EOF; |
e0f6a64a JG |
114 | goto end; |
115 | } | |
e98a2d6e | 116 | /* Map new region */ |
8b45963b | 117 | BT_ASSERT(ds_file->mmap_len); |
a555e971 | 118 | ds_file->mmap_addr = bt_mmap((void *) 0, ds_file->mmap_len, |
94cf822e | 119 | PROT_READ, MAP_PRIVATE, fileno(ds_file->file->fp), |
43b07461 | 120 | ds_file->mmap_offset_in_file, ds_file->log_level); |
94cf822e | 121 | if (ds_file->mmap_addr == MAP_FAILED) { |
f67894f9 | 122 | BT_COMP_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %jd: %s", |
94cf822e | 123 | ds_file->mmap_len, ds_file->file->path->str, |
43b07461 | 124 | ds_file->file->fp, (intmax_t) ds_file->mmap_offset_in_file, |
78586d8a | 125 | strerror(errno)); |
3baf7da0 SM |
126 | status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR; |
127 | goto end; | |
e98a2d6e PP |
128 | } |
129 | ||
3baf7da0 | 130 | status = CTF_MSG_ITER_MEDIUM_STATUS_OK; |
e98a2d6e | 131 | end: |
3baf7da0 | 132 | return status; |
e98a2d6e PP |
133 | } |
134 | ||
5b29e799 | 135 | static |
5d452e1f | 136 | enum ctf_msg_iter_medium_status medop_request_bytes( |
e98a2d6e PP |
137 | size_t request_sz, uint8_t **buffer_addr, |
138 | size_t *buffer_sz, void *data) | |
139 | { | |
5d452e1f SM |
140 | enum ctf_msg_iter_medium_status status = |
141 | CTF_MSG_ITER_MEDIUM_STATUS_OK; | |
94cf822e | 142 | struct ctf_fs_ds_file *ds_file = data; |
d7bc0973 SM |
143 | bt_self_component *self_comp = ds_file->self_comp; |
144 | bt_logging_level log_level = ds_file->log_level; | |
e98a2d6e | 145 | |
640a46fd | 146 | BT_ASSERT(request_sz > 0); |
e98a2d6e | 147 | |
f102bfaa FD |
148 | /* |
149 | * Check if we have at least one memory-mapped byte left. If we don't, | |
150 | * mmap the next file. | |
151 | */ | |
94cf822e | 152 | if (remaining_mmap_bytes(ds_file) == 0) { |
e98a2d6e | 153 | /* Are we at the end of the file? */ |
43b07461 | 154 | if (ds_file->mmap_offset_in_file >= ds_file->file->size) { |
f67894f9 | 155 | BT_COMP_LOGD("Reached end of file \"%s\" (%p)", |
94cf822e | 156 | ds_file->file->path->str, ds_file->file->fp); |
5d452e1f | 157 | status = CTF_MSG_ITER_MEDIUM_STATUS_EOF; |
e98a2d6e PP |
158 | goto end; |
159 | } | |
160 | ||
94cf822e | 161 | status = ds_file_mmap_next(ds_file); |
e0f6a64a | 162 | switch (status) { |
5d452e1f | 163 | case CTF_MSG_ITER_MEDIUM_STATUS_OK: |
e0f6a64a | 164 | break; |
5d452e1f | 165 | case CTF_MSG_ITER_MEDIUM_STATUS_EOF: |
e0f6a64a JG |
166 | goto end; |
167 | default: | |
f67894f9 | 168 | BT_COMP_LOGE("Cannot memory-map next region of file \"%s\" (%p)", |
94cf822e PP |
169 | ds_file->file->path->str, |
170 | ds_file->file->fp); | |
e98a2d6e PP |
171 | goto error; |
172 | } | |
173 | } | |
174 | ||
640a46fd | 175 | BT_ASSERT(remaining_mmap_bytes(ds_file) > 0); |
94cf822e | 176 | *buffer_sz = MIN(remaining_mmap_bytes(ds_file), request_sz); |
640a46fd | 177 | |
f102bfaa | 178 | BT_ASSERT(ds_file->mmap_addr); |
43b07461 | 179 | *buffer_addr = ((uint8_t *) ds_file->mmap_addr) + ds_file->request_offset_in_mapping; |
640a46fd | 180 | |
43b07461 | 181 | ds_file->request_offset_in_mapping += *buffer_sz; |
e98a2d6e PP |
182 | goto end; |
183 | ||
184 | error: | |
5d452e1f | 185 | status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR; |
e98a2d6e PP |
186 | |
187 | end: | |
188 | return status; | |
189 | } | |
190 | ||
5b29e799 | 191 | static |
bbbd35bf | 192 | bt_stream *medop_borrow_stream(bt_stream_class *stream_class, int64_t stream_id, |
0659c536 | 193 | void *data) |
e98a2d6e | 194 | { |
94cf822e | 195 | struct ctf_fs_ds_file *ds_file = data; |
8eee8ea2 PP |
196 | bt_stream_class *ds_file_stream_class; |
197 | bt_stream *stream = NULL; | |
9e550e5f | 198 | |
78cf9df6 | 199 | ds_file_stream_class = bt_stream_borrow_class( |
9e550e5f | 200 | ds_file->stream); |
94cf822e | 201 | |
94cf822e PP |
202 | if (stream_class != ds_file_stream_class) { |
203 | /* | |
204 | * Not supported: two packets described by two different | |
205 | * stream classes within the same data stream file. | |
206 | */ | |
207 | goto end; | |
e98a2d6e PP |
208 | } |
209 | ||
94cf822e PP |
210 | stream = ds_file->stream; |
211 | ||
212 | end: | |
213 | return stream; | |
e98a2d6e PP |
214 | } |
215 | ||
bb230c9b | 216 | static |
9a4c10a7 | 217 | enum ctf_msg_iter_medium_status medop_seek(off_t offset, void *data) |
bb230c9b | 218 | { |
3baf7da0 | 219 | enum ctf_msg_iter_medium_status status; |
bb230c9b | 220 | struct ctf_fs_ds_file *ds_file = data; |
f102bfaa | 221 | off_t offset_in_mapping, file_size = ds_file->file->size; |
d7bc0973 SM |
222 | bt_self_component *self_comp = ds_file->self_comp; |
223 | bt_logging_level log_level = ds_file->log_level; | |
bb230c9b | 224 | |
ebe4c684 SM |
225 | BT_ASSERT(offset >= 0); |
226 | BT_ASSERT(offset < file_size); | |
bb230c9b | 227 | |
f102bfaa FD |
228 | /* If there is no current mapping, map the right file directly. */ |
229 | if (!ds_file->mmap_addr) { | |
230 | goto map_requested_offset; | |
231 | } | |
232 | ||
bb230c9b JG |
233 | /* |
234 | * Determine whether or not the destination is contained within the | |
235 | * current mapping. | |
236 | */ | |
43b07461 SM |
237 | if (offset < ds_file->mmap_offset_in_file || |
238 | offset >= ds_file->mmap_offset_in_file + ds_file->mmap_len) { | |
f67894f9 | 239 | BT_COMP_LOGD("Medium seek request cannot be accomodated by the current " |
af5e91e4 | 240 | "file mapping: offset=%jd, mmap-offset=%jd, " |
43b07461 | 241 | "mmap-len=%zu", (intmax_t) offset, (intmax_t) ds_file->mmap_offset_in_file, |
bb230c9b | 242 | ds_file->mmap_len); |
3baf7da0 SM |
243 | status = ds_file_munmap(ds_file); |
244 | if (status != CTF_MSG_ITER_MEDIUM_STATUS_OK) { | |
bb230c9b JG |
245 | goto end; |
246 | } | |
f102bfaa | 247 | goto map_requested_offset; |
bb230c9b | 248 | } else { |
43b07461 | 249 | ds_file->request_offset_in_mapping = offset - ds_file->mmap_offset_in_file; |
f102bfaa FD |
250 | goto test_end; |
251 | } | |
252 | ||
253 | map_requested_offset: | |
254 | offset_in_mapping = offset % | |
c8ebf034 | 255 | bt_mmap_get_offset_align_size(ds_file->log_level); |
f102bfaa | 256 | |
43b07461 SM |
257 | ds_file->mmap_offset_in_file = offset - offset_in_mapping; |
258 | ds_file->request_offset_in_mapping = offset_in_mapping; | |
3baf7da0 SM |
259 | status = ds_file_mmap_next(ds_file); |
260 | if (status != CTF_MSG_ITER_MEDIUM_STATUS_OK) { | |
f102bfaa | 261 | goto end; |
bb230c9b JG |
262 | } |
263 | ||
f102bfaa | 264 | test_end: |
bb230c9b | 265 | ds_file->end_reached = (offset == file_size); |
3baf7da0 SM |
266 | |
267 | status = CTF_MSG_ITER_MEDIUM_STATUS_OK; | |
bb230c9b | 268 | end: |
3baf7da0 | 269 | return status; |
bb230c9b JG |
270 | } |
271 | ||
55fa6491 | 272 | BT_HIDDEN |
5d452e1f | 273 | struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops = { |
e98a2d6e | 274 | .request_bytes = medop_request_bytes, |
a6918753 | 275 | .borrow_stream = medop_borrow_stream, |
bb230c9b | 276 | .seek = medop_seek, |
e98a2d6e | 277 | }; |
55fa6491 | 278 | |
408c8c19 SM |
279 | static |
280 | struct ctf_fs_ds_index_entry *ctf_fs_ds_index_entry_create( | |
281 | bt_self_component *self_comp, bt_logging_level log_level) | |
282 | { | |
283 | struct ctf_fs_ds_index_entry *entry; | |
284 | ||
285 | entry = g_new0(struct ctf_fs_ds_index_entry, 1); | |
286 | if (!entry) { | |
287 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to allocate a ctf_fs_ds_index_entry."); | |
288 | goto end; | |
289 | } | |
290 | ||
291 | entry->packet_seq_num = UINT64_MAX; | |
292 | ||
293 | end: | |
294 | return entry; | |
295 | } | |
296 | ||
97ade20b | 297 | static |
35fa110e | 298 | int convert_cycles_to_ns(struct ctf_clock_class *clock_class, |
97ade20b | 299 | uint64_t cycles, int64_t *ns) |
b6c3dcb2 | 300 | { |
35fa110e PP |
301 | return bt_util_clock_cycles_to_ns_from_origin(cycles, |
302 | clock_class->frequency, clock_class->offset_seconds, | |
303 | clock_class->offset_cycles, ns); | |
97ade20b JG |
304 | } |
305 | ||
306 | static | |
307 | struct ctf_fs_ds_index *build_index_from_idx_file( | |
13772304 | 308 | struct ctf_fs_ds_file *ds_file, |
3b89958b SM |
309 | struct ctf_fs_ds_file_info *file_info, |
310 | struct ctf_msg_iter *msg_iter) | |
97ade20b JG |
311 | { |
312 | int ret; | |
b6c3dcb2 JG |
313 | gchar *directory = NULL; |
314 | gchar *basename = NULL; | |
315 | GString *index_basename = NULL; | |
316 | gchar *index_file_path = NULL; | |
317 | GMappedFile *mapped_file = NULL; | |
318 | gsize filesize; | |
97ade20b JG |
319 | const char *mmap_begin = NULL, *file_pos = NULL; |
320 | const struct ctf_packet_index_file_hdr *header = NULL; | |
321 | struct ctf_fs_ds_index *index = NULL; | |
e58dfd9c | 322 | struct ctf_fs_ds_index_entry *index_entry = NULL, *prev_index_entry = NULL; |
b6c3dcb2 JG |
323 | uint64_t total_packets_size = 0; |
324 | size_t file_index_entry_size; | |
325 | size_t file_entry_count; | |
326 | size_t i; | |
7b33a0e0 | 327 | struct ctf_stream_class *sc; |
5d452e1f | 328 | struct ctf_msg_iter_packet_properties props; |
2068d50b | 329 | uint32_t version_major, version_minor; |
d7bc0973 SM |
330 | bt_self_component *self_comp = ds_file->self_comp; |
331 | bt_logging_level log_level = ds_file->log_level; | |
97ade20b | 332 | |
f67894f9 | 333 | BT_COMP_LOGI("Building index from .idx file of stream file %s", |
97ade20b | 334 | ds_file->file->path->str); |
3b89958b | 335 | ret = ctf_msg_iter_get_packet_properties(msg_iter, &props); |
97ade20b | 336 | if (ret) { |
f67894f9 | 337 | BT_COMP_LOGI_STR("Cannot read first packet's header and context fields."); |
7b33a0e0 PP |
338 | goto error; |
339 | } | |
340 | ||
7b33a0e0 PP |
341 | sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, |
342 | props.stream_class_id); | |
343 | BT_ASSERT(sc); | |
344 | if (!sc->default_clock_class) { | |
f67894f9 | 345 | BT_COMP_LOGI_STR("Cannot find stream class's default clock class."); |
97ade20b JG |
346 | goto error; |
347 | } | |
b6c3dcb2 JG |
348 | |
349 | /* Look for index file in relative path index/name.idx. */ | |
94cf822e | 350 | basename = g_path_get_basename(ds_file->file->path->str); |
b6c3dcb2 | 351 | if (!basename) { |
f67894f9 | 352 | BT_COMP_LOGE("Cannot get the basename of datastream file %s", |
55314f2a | 353 | ds_file->file->path->str); |
97ade20b | 354 | goto error; |
b6c3dcb2 JG |
355 | } |
356 | ||
94cf822e | 357 | directory = g_path_get_dirname(ds_file->file->path->str); |
b6c3dcb2 | 358 | if (!directory) { |
f67894f9 | 359 | BT_COMP_LOGE("Cannot get dirname of datastream file %s", |
55314f2a | 360 | ds_file->file->path->str); |
97ade20b | 361 | goto error; |
b6c3dcb2 JG |
362 | } |
363 | ||
364 | index_basename = g_string_new(basename); | |
365 | if (!index_basename) { | |
f67894f9 | 366 | BT_COMP_LOGE_STR("Cannot allocate index file basename string"); |
97ade20b | 367 | goto error; |
b6c3dcb2 JG |
368 | } |
369 | ||
370 | g_string_append(index_basename, ".idx"); | |
371 | index_file_path = g_build_filename(directory, "index", | |
372 | index_basename->str, NULL); | |
373 | mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL); | |
06367fa3 | 374 | if (!mapped_file) { |
f67894f9 | 375 | BT_COMP_LOGD("Cannot create new mapped file %s", |
55314f2a | 376 | index_file_path); |
97ade20b | 377 | goto error; |
06367fa3 | 378 | } |
65cbebef JG |
379 | |
380 | /* | |
381 | * The g_mapped_file API limits us to 4GB files on 32-bit. | |
382 | * Traces with such large indexes have never been seen in the wild, | |
383 | * but this would need to be adjusted to support them. | |
384 | */ | |
b6c3dcb2 JG |
385 | filesize = g_mapped_file_get_length(mapped_file); |
386 | if (filesize < sizeof(*header)) { | |
f67894f9 | 387 | BT_COMP_LOGW("Invalid LTTng trace index file: " |
65cbebef JG |
388 | "file size (%zu bytes) < header size (%zu bytes)", |
389 | filesize, sizeof(*header)); | |
97ade20b | 390 | goto error; |
b6c3dcb2 JG |
391 | } |
392 | ||
393 | mmap_begin = g_mapped_file_get_contents(mapped_file); | |
394 | header = (struct ctf_packet_index_file_hdr *) mmap_begin; | |
395 | ||
396 | file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header); | |
397 | if (be32toh(header->magic) != CTF_INDEX_MAGIC) { | |
f67894f9 | 398 | BT_COMP_LOGW_STR("Invalid LTTng trace index: \"magic\" field validation failed"); |
97ade20b | 399 | goto error; |
b6c3dcb2 | 400 | } |
b6c3dcb2 | 401 | |
2068d50b SM |
402 | version_major = be32toh(header->index_major); |
403 | version_minor = be32toh(header->index_minor); | |
404 | if (version_major != 1) { | |
405 | BT_COMP_LOGW( | |
406 | "Unknown LTTng trace index version: " | |
407 | "major=%" PRIu32 ", minor=%" PRIu32, | |
408 | version_major, version_minor); | |
409 | goto error; | |
410 | } | |
411 | ||
b6c3dcb2 JG |
412 | file_index_entry_size = be32toh(header->packet_index_len); |
413 | file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size; | |
97ade20b | 414 | if ((filesize - sizeof(*header)) % file_index_entry_size) { |
f67894f9 | 415 | BT_COMP_LOGW("Invalid LTTng trace index: the index's size after the header " |
65cbebef JG |
416 | "(%zu bytes) is not a multiple of the index entry size " |
417 | "(%zu bytes)", (filesize - sizeof(*header)), | |
418 | sizeof(*header)); | |
97ade20b | 419 | goto error; |
b6c3dcb2 JG |
420 | } |
421 | ||
f67894f9 | 422 | index = ctf_fs_ds_index_create(ds_file->log_level, ds_file->self_comp); |
97ade20b JG |
423 | if (!index) { |
424 | goto error; | |
b6c3dcb2 | 425 | } |
97ade20b | 426 | |
b6c3dcb2 JG |
427 | for (i = 0; i < file_entry_count; i++) { |
428 | struct ctf_packet_index *file_index = | |
429 | (struct ctf_packet_index *) file_pos; | |
430 | uint64_t packet_size = be64toh(file_index->packet_size); | |
431 | ||
432 | if (packet_size % CHAR_BIT) { | |
f67894f9 | 433 | BT_COMP_LOGW("Invalid packet size encountered in LTTng trace index file"); |
97ade20b | 434 | goto error; |
b6c3dcb2 JG |
435 | } |
436 | ||
408c8c19 SM |
437 | index_entry = ctf_fs_ds_index_entry_create( |
438 | ds_file->self_comp, ds_file->log_level); | |
779f4a23 | 439 | if (!index_entry) { |
408c8c19 SM |
440 | BT_COMP_LOGE_APPEND_CAUSE(ds_file->self_comp, |
441 | "Failed to create a ctf_fs_ds_index_entry."); | |
779f4a23 FD |
442 | goto error; |
443 | } | |
444 | ||
13772304 FD |
445 | /* Set path to stream file. */ |
446 | index_entry->path = file_info->path->str; | |
447 | ||
b6c3dcb2 JG |
448 | /* Convert size in bits to bytes. */ |
449 | packet_size /= CHAR_BIT; | |
97ade20b | 450 | index_entry->packet_size = packet_size; |
b6c3dcb2 | 451 | |
97ade20b | 452 | index_entry->offset = be64toh(file_index->offset); |
e58dfd9c | 453 | if (i != 0 && index_entry->offset < prev_index_entry->offset) { |
f67894f9 | 454 | BT_COMP_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: " |
65cbebef | 455 | "previous offset=%" PRIu64 ", current offset=%" PRIu64, |
6cef4a7d | 456 | prev_index_entry->offset, index_entry->offset); |
97ade20b | 457 | goto error; |
b6c3dcb2 JG |
458 | } |
459 | ||
97ade20b JG |
460 | index_entry->timestamp_begin = be64toh(file_index->timestamp_begin); |
461 | index_entry->timestamp_end = be64toh(file_index->timestamp_end); | |
462 | if (index_entry->timestamp_end < index_entry->timestamp_begin) { | |
f67894f9 | 463 | BT_COMP_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): " |
65cbebef JG |
464 | "timestamp_begin=%" PRIu64 "timestamp_end=%" PRIu64, |
465 | index_entry->timestamp_begin, | |
466 | index_entry->timestamp_end); | |
97ade20b JG |
467 | goto error; |
468 | } | |
469 | ||
470 | /* Convert the packet's bound to nanoseconds since Epoch. */ | |
7b33a0e0 | 471 | ret = convert_cycles_to_ns(sc->default_clock_class, |
97ade20b JG |
472 | index_entry->timestamp_begin, |
473 | &index_entry->timestamp_begin_ns); | |
474 | if (ret) { | |
f67894f9 | 475 | BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing"); |
97ade20b JG |
476 | goto error; |
477 | } | |
7b33a0e0 | 478 | ret = convert_cycles_to_ns(sc->default_clock_class, |
97ade20b JG |
479 | index_entry->timestamp_end, |
480 | &index_entry->timestamp_end_ns); | |
481 | if (ret) { | |
f67894f9 | 482 | BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing"); |
97ade20b | 483 | goto error; |
b6c3dcb2 JG |
484 | } |
485 | ||
408c8c19 SM |
486 | if (version_minor >= 1) { |
487 | index_entry->packet_seq_num = be64toh(file_index->packet_seq_num); | |
488 | } | |
489 | ||
b6c3dcb2 JG |
490 | total_packets_size += packet_size; |
491 | file_pos += file_index_entry_size; | |
779f4a23 | 492 | |
e58dfd9c | 493 | prev_index_entry = index_entry; |
c0ba90e9 SM |
494 | |
495 | /* Give ownership of `index_entry` to `index->entries`. */ | |
496 | g_ptr_array_add(index->entries, index_entry); | |
497 | index_entry = NULL; | |
b6c3dcb2 JG |
498 | } |
499 | ||
500 | /* Validate that the index addresses the complete stream. */ | |
94cf822e | 501 | if (ds_file->file->size != total_packets_size) { |
f67894f9 | 502 | BT_COMP_LOGW("Invalid LTTng trace index file; indexed size != stream file size: " |
bb230c9b | 503 | "file-size=%" PRIu64 ", total-packets-size=%" PRIu64, |
65cbebef | 504 | ds_file->file->size, total_packets_size); |
97ade20b | 505 | goto error; |
b6c3dcb2 JG |
506 | } |
507 | end: | |
508 | g_free(directory); | |
509 | g_free(basename); | |
510 | g_free(index_file_path); | |
06367fa3 JG |
511 | if (index_basename) { |
512 | g_string_free(index_basename, TRUE); | |
513 | } | |
514 | if (mapped_file) { | |
515 | g_mapped_file_unref(mapped_file); | |
516 | } | |
97ade20b JG |
517 | return index; |
518 | error: | |
519 | ctf_fs_ds_index_destroy(index); | |
779f4a23 | 520 | g_free(index_entry); |
97ade20b | 521 | index = NULL; |
b6c3dcb2 JG |
522 | goto end; |
523 | } | |
524 | ||
bb230c9b JG |
525 | static |
526 | int init_index_entry(struct ctf_fs_ds_index_entry *entry, | |
7b33a0e0 | 527 | struct ctf_fs_ds_file *ds_file, |
5d452e1f | 528 | struct ctf_msg_iter_packet_properties *props, |
7b33a0e0 | 529 | off_t packet_size, off_t packet_offset) |
bb230c9b | 530 | { |
414ee0f4 | 531 | int ret = 0; |
7b33a0e0 | 532 | struct ctf_stream_class *sc; |
d7bc0973 SM |
533 | bt_self_component *self_comp = ds_file->self_comp; |
534 | bt_logging_level log_level = ds_file->log_level; | |
bb230c9b | 535 | |
7b33a0e0 PP |
536 | sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, |
537 | props->stream_class_id); | |
538 | BT_ASSERT(sc); | |
8b45963b | 539 | BT_ASSERT(packet_offset >= 0); |
bb230c9b | 540 | entry->offset = packet_offset; |
8b45963b | 541 | BT_ASSERT(packet_size >= 0); |
bb230c9b JG |
542 | entry->packet_size = packet_size; |
543 | ||
0476f6f7 | 544 | if (props->snapshots.beginning_clock != UINT64_C(-1)) { |
c2f37699 FD |
545 | entry->timestamp_begin = props->snapshots.beginning_clock; |
546 | ||
0476f6f7 PP |
547 | /* Convert the packet's bound to nanoseconds since Epoch. */ |
548 | ret = convert_cycles_to_ns(sc->default_clock_class, | |
549 | props->snapshots.beginning_clock, | |
550 | &entry->timestamp_begin_ns); | |
551 | if (ret) { | |
f67894f9 | 552 | BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch."); |
0476f6f7 PP |
553 | goto end; |
554 | } | |
555 | } else { | |
c2f37699 | 556 | entry->timestamp_begin = UINT64_C(-1); |
0476f6f7 | 557 | entry->timestamp_begin_ns = UINT64_C(-1); |
bb230c9b JG |
558 | } |
559 | ||
0476f6f7 | 560 | if (props->snapshots.end_clock != UINT64_C(-1)) { |
c2f37699 FD |
561 | entry->timestamp_end = props->snapshots.end_clock; |
562 | ||
563 | /* Convert the packet's bound to nanoseconds since Epoch. */ | |
0476f6f7 PP |
564 | ret = convert_cycles_to_ns(sc->default_clock_class, |
565 | props->snapshots.end_clock, | |
566 | &entry->timestamp_end_ns); | |
567 | if (ret) { | |
f67894f9 | 568 | BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch."); |
0476f6f7 PP |
569 | goto end; |
570 | } | |
571 | } else { | |
c2f37699 | 572 | entry->timestamp_end = UINT64_C(-1); |
0476f6f7 | 573 | entry->timestamp_end_ns = UINT64_C(-1); |
bb230c9b | 574 | } |
c43f6ee2 | 575 | |
bb230c9b | 576 | end: |
bb230c9b JG |
577 | return ret; |
578 | } | |
579 | ||
580 | static | |
581 | struct ctf_fs_ds_index *build_index_from_stream_file( | |
13772304 | 582 | struct ctf_fs_ds_file *ds_file, |
3b89958b SM |
583 | struct ctf_fs_ds_file_info *file_info, |
584 | struct ctf_msg_iter *msg_iter) | |
bb230c9b JG |
585 | { |
586 | int ret; | |
587 | struct ctf_fs_ds_index *index = NULL; | |
5d452e1f | 588 | enum ctf_msg_iter_status iter_status = CTF_MSG_ITER_STATUS_OK; |
bbbd35bf | 589 | off_t current_packet_offset_bytes = 0; |
d7bc0973 SM |
590 | bt_self_component *self_comp = ds_file->self_comp; |
591 | bt_logging_level log_level = ds_file->log_level; | |
bb230c9b | 592 | |
f67894f9 | 593 | BT_COMP_LOGI("Indexing stream file %s", ds_file->file->path->str); |
bb230c9b | 594 | |
f67894f9 | 595 | index = ctf_fs_ds_index_create(ds_file->log_level, ds_file->self_comp); |
bb230c9b JG |
596 | if (!index) { |
597 | goto error; | |
598 | } | |
599 | ||
5eb3f5e6 | 600 | while (true) { |
7b33a0e0 | 601 | off_t current_packet_size_bytes; |
779f4a23 | 602 | struct ctf_fs_ds_index_entry *index_entry; |
5d452e1f | 603 | struct ctf_msg_iter_packet_properties props; |
bb230c9b | 604 | |
bbbd35bf | 605 | if (current_packet_offset_bytes < 0) { |
f67894f9 | 606 | BT_COMP_LOGE_STR("Cannot get the current packet's offset."); |
bbbd35bf PP |
607 | goto error; |
608 | } else if (current_packet_offset_bytes > ds_file->file->size) { | |
f67894f9 | 609 | BT_COMP_LOGE_STR("Unexpected current packet's offset (larger than file)."); |
bbbd35bf PP |
610 | goto error; |
611 | } else if (current_packet_offset_bytes == ds_file->file->size) { | |
612 | /* No more data */ | |
613 | break; | |
614 | } | |
615 | ||
3b89958b | 616 | iter_status = ctf_msg_iter_seek(msg_iter, |
bbbd35bf | 617 | current_packet_offset_bytes); |
5d452e1f | 618 | if (iter_status != CTF_MSG_ITER_STATUS_OK) { |
bb230c9b JG |
619 | goto error; |
620 | } | |
a6918753 | 621 | |
5d452e1f | 622 | iter_status = ctf_msg_iter_get_packet_properties( |
3b89958b | 623 | msg_iter, &props); |
5d452e1f | 624 | if (iter_status != CTF_MSG_ITER_STATUS_OK) { |
bb230c9b JG |
625 | goto error; |
626 | } | |
627 | ||
bbbd35bf PP |
628 | if (props.exp_packet_total_size >= 0) { |
629 | current_packet_size_bytes = | |
630 | (uint64_t) props.exp_packet_total_size / 8; | |
631 | } else { | |
632 | current_packet_size_bytes = ds_file->file->size; | |
633 | } | |
bb230c9b | 634 | |
bbbd35bf | 635 | if (current_packet_offset_bytes + current_packet_size_bytes > |
bb230c9b | 636 | ds_file->file->size) { |
f67894f9 | 637 | BT_COMP_LOGW("Invalid packet size reported in file: stream=\"%s\", " |
bb230c9b JG |
638 | "packet-offset=%jd, packet-size-bytes=%jd, " |
639 | "file-size=%jd", | |
640 | ds_file->file->path->str, | |
2655783b JR |
641 | (intmax_t) current_packet_offset_bytes, |
642 | (intmax_t) current_packet_size_bytes, | |
643 | (intmax_t) ds_file->file->size); | |
bb230c9b JG |
644 | goto error; |
645 | } | |
646 | ||
408c8c19 SM |
647 | index_entry = ctf_fs_ds_index_entry_create( |
648 | ds_file->self_comp, ds_file->log_level); | |
779f4a23 | 649 | if (!index_entry) { |
408c8c19 SM |
650 | BT_COMP_LOGE_APPEND_CAUSE(ds_file->self_comp, |
651 | "Failed to create a ctf_fs_ds_index_entry."); | |
bb230c9b JG |
652 | goto error; |
653 | } | |
654 | ||
13772304 FD |
655 | /* Set path to stream file. */ |
656 | index_entry->path = file_info->path->str; | |
657 | ||
779f4a23 | 658 | ret = init_index_entry(index_entry, ds_file, &props, |
bbbd35bf | 659 | current_packet_size_bytes, current_packet_offset_bytes); |
bb230c9b | 660 | if (ret) { |
779f4a23 | 661 | g_free(index_entry); |
bb230c9b JG |
662 | goto error; |
663 | } | |
779f4a23 FD |
664 | |
665 | g_ptr_array_add(index->entries, index_entry); | |
666 | ||
9502dc00 | 667 | current_packet_offset_bytes += current_packet_size_bytes; |
f67894f9 | 668 | BT_COMP_LOGD("Seeking to next packet: current-packet-offset=%jd, " |
9502dc00 | 669 | "next-packet-offset=%jd", |
2655783b JR |
670 | (intmax_t) (current_packet_offset_bytes - current_packet_size_bytes), |
671 | (intmax_t) current_packet_offset_bytes); | |
bb230c9b | 672 | } |
a6918753 | 673 | |
bb230c9b | 674 | end: |
bb230c9b | 675 | return index; |
a6918753 | 676 | |
bb230c9b JG |
677 | error: |
678 | ctf_fs_ds_index_destroy(index); | |
679 | index = NULL; | |
680 | goto end; | |
681 | } | |
682 | ||
e7a4393b | 683 | BT_HIDDEN |
94cf822e PP |
684 | struct ctf_fs_ds_file *ctf_fs_ds_file_create( |
685 | struct ctf_fs_trace *ctf_fs_trace, | |
c7d8bfa1 | 686 | bt_self_message_iterator *self_msg_iter, |
3d731ea9 PP |
687 | bt_stream *stream, const char *path, |
688 | bt_logging_level log_level) | |
e98a2d6e | 689 | { |
b6c3dcb2 | 690 | int ret; |
c8ebf034 | 691 | const size_t offset_align = bt_mmap_get_offset_align_size(log_level); |
94cf822e | 692 | struct ctf_fs_ds_file *ds_file = g_new0(struct ctf_fs_ds_file, 1); |
e98a2d6e | 693 | |
94cf822e | 694 | if (!ds_file) { |
e98a2d6e PP |
695 | goto error; |
696 | } | |
697 | ||
3d731ea9 | 698 | ds_file->log_level = log_level; |
f67894f9 | 699 | ds_file->self_comp = ctf_fs_trace->self_comp; |
c7d8bfa1 | 700 | ds_file->self_msg_iter = self_msg_iter; |
f67894f9 | 701 | ds_file->file = ctf_fs_file_create(log_level, ds_file->self_comp); |
94cf822e | 702 | if (!ds_file->file) { |
4f1f88a6 PP |
703 | goto error; |
704 | } | |
705 | ||
4b70020d | 706 | ds_file->stream = stream; |
8c6884d9 | 707 | bt_stream_get_ref(ds_file->stream); |
7b33a0e0 | 708 | ds_file->metadata = ctf_fs_trace->metadata; |
94cf822e | 709 | g_string_assign(ds_file->file->path, path); |
55314f2a | 710 | ret = ctf_fs_file_open(ds_file->file, "rb"); |
4f1f88a6 PP |
711 | if (ret) { |
712 | goto error; | |
713 | } | |
714 | ||
c8ebf034 | 715 | ds_file->mmap_max_len = offset_align * 2048; |
94cf822e | 716 | |
e98a2d6e | 717 | goto end; |
1a9f7075 | 718 | |
e98a2d6e | 719 | error: |
78586d8a | 720 | /* Do not touch "borrowed" file. */ |
94cf822e PP |
721 | ctf_fs_ds_file_destroy(ds_file); |
722 | ds_file = NULL; | |
1a9f7075 | 723 | |
e98a2d6e | 724 | end: |
94cf822e | 725 | return ds_file; |
e98a2d6e PP |
726 | } |
727 | ||
97ade20b JG |
728 | BT_HIDDEN |
729 | struct ctf_fs_ds_index *ctf_fs_ds_file_build_index( | |
13772304 | 730 | struct ctf_fs_ds_file *ds_file, |
3b89958b SM |
731 | struct ctf_fs_ds_file_info *file_info, |
732 | struct ctf_msg_iter *msg_iter) | |
97ade20b | 733 | { |
bb230c9b | 734 | struct ctf_fs_ds_index *index; |
d7bc0973 SM |
735 | bt_self_component *self_comp = ds_file->self_comp; |
736 | bt_logging_level log_level = ds_file->log_level; | |
bb230c9b | 737 | |
3b89958b | 738 | index = build_index_from_idx_file(ds_file, file_info, msg_iter); |
bb230c9b JG |
739 | if (index) { |
740 | goto end; | |
741 | } | |
742 | ||
f67894f9 | 743 | BT_COMP_LOGI("Failed to build index from .index file; " |
bb230c9b | 744 | "falling back to stream indexing."); |
3b89958b | 745 | index = build_index_from_stream_file(ds_file, file_info, msg_iter); |
bb230c9b JG |
746 | end: |
747 | return index; | |
97ade20b JG |
748 | } |
749 | ||
779f4a23 | 750 | BT_HIDDEN |
f67894f9 PP |
751 | struct ctf_fs_ds_index *ctf_fs_ds_index_create(bt_logging_level log_level, |
752 | bt_self_component *self_comp) | |
779f4a23 FD |
753 | { |
754 | struct ctf_fs_ds_index *index = g_new0(struct ctf_fs_ds_index, 1); | |
755 | ||
756 | if (!index) { | |
f67894f9 | 757 | BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp, |
3d731ea9 | 758 | "Failed to allocate index"); |
779f4a23 FD |
759 | goto error; |
760 | } | |
761 | ||
762 | index->entries = g_ptr_array_new_with_free_func((GDestroyNotify) g_free); | |
763 | if (!index->entries) { | |
f67894f9 | 764 | BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp, |
3d731ea9 | 765 | "Failed to allocate index entries."); |
779f4a23 FD |
766 | goto error; |
767 | } | |
768 | ||
769 | goto end; | |
770 | ||
771 | error: | |
772 | ctf_fs_ds_index_destroy(index); | |
773 | index = NULL; | |
774 | end: | |
775 | return index; | |
776 | } | |
777 | ||
5b29e799 | 778 | BT_HIDDEN |
94cf822e | 779 | void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file) |
e98a2d6e | 780 | { |
94cf822e | 781 | if (!ds_file) { |
5b29e799 | 782 | return; |
043e2020 JG |
783 | } |
784 | ||
8c6884d9 | 785 | bt_stream_put_ref(ds_file->stream); |
94cf822e | 786 | (void) ds_file_munmap(ds_file); |
0982a26d | 787 | |
94cf822e PP |
788 | if (ds_file->file) { |
789 | ctf_fs_file_destroy(ds_file->file); | |
e98a2d6e PP |
790 | } |
791 | ||
94cf822e | 792 | g_free(ds_file); |
e98a2d6e | 793 | } |
4f1f88a6 | 794 | |
97ade20b JG |
795 | BT_HIDDEN |
796 | void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index) | |
797 | { | |
798 | if (!index) { | |
799 | return; | |
800 | } | |
801 | ||
802 | if (index->entries) { | |
779f4a23 | 803 | g_ptr_array_free(index->entries, TRUE); |
97ade20b JG |
804 | } |
805 | g_free(index); | |
806 | } |