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