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