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