Build CTF stream indexes from LTTng index files
[babeltrace.git] / plugins / ctf / fs / data-stream.c
CommitLineData
e98a2d6e
PP
1/*
2 * Copyright 2016 - 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
25#include <stdio.h>
26#include <stdint.h>
27#include <stdlib.h>
28#include <stdbool.h>
29#include <glib.h>
30#include <inttypes.h>
31#include <sys/mman.h>
32#include <babeltrace/ctf-ir/stream.h>
78586d8a
JG
33#include <babeltrace/plugin/notification/iterator.h>
34#include "file.h"
35#include "metadata.h"
36#include "../common/notif-iter/notif-iter.h"
37#include <assert.h>
5b29e799 38#include "data-stream.h"
e98a2d6e
PP
39
40#define PRINT_ERR_STREAM ctf_fs->error_fp
41#define PRINT_PREFIX "ctf-fs-data-stream"
42#include "print.h"
43
5b29e799
JG
44static
45size_t remaining_mmap_bytes(struct ctf_fs_stream *stream)
e98a2d6e 46{
fc9a526c 47 return stream->mmap_valid_len - stream->request_offset;
e98a2d6e
PP
48}
49
5b29e799
JG
50static
51int stream_munmap(struct ctf_fs_stream *stream)
e98a2d6e 52{
fc9a526c 53 int ret = 0;
56a1cced 54 struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;
e98a2d6e
PP
55
56 if (munmap(stream->mmap_addr, stream->mmap_len)) {
57 PERR("Cannot memory-unmap address %p (size %zu) of file \"%s\" (%p): %s\n",
58 stream->mmap_addr, stream->mmap_len,
59 stream->file->path->str, stream->file->fp,
60 strerror(errno));
fc9a526c
JG
61 ret = -1;
62 goto end;
e98a2d6e 63 }
fc9a526c
JG
64end:
65 return ret;
e98a2d6e
PP
66}
67
5b29e799
JG
68static
69int mmap_next(struct ctf_fs_stream *stream)
e98a2d6e 70{
e98a2d6e 71 int ret = 0;
fc9a526c 72 struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;
e98a2d6e
PP
73
74 /* Unmap old region */
75 if (stream->mmap_addr) {
76 if (stream_munmap(stream)) {
77 goto error;
78 }
79
fc9a526c
JG
80 stream->mmap_offset += stream->mmap_valid_len;
81 stream->request_offset = 0;
e98a2d6e
PP
82 }
83
fc9a526c
JG
84 stream->mmap_valid_len = MIN(stream->file->size - stream->mmap_offset,
85 stream->mmap_max_len);
86 /* Round up to next page, assuming page size being a power of 2. */
87 stream->mmap_len = (stream->mmap_valid_len + ctf_fs->page_size - 1)
88 & ~(ctf_fs->page_size - 1);
e98a2d6e
PP
89 /* Map new region */
90 stream->mmap_addr = mmap((void *) 0, stream->mmap_len,
78586d8a
JG
91 PROT_READ, MAP_PRIVATE, fileno(stream->file->fp),
92 stream->mmap_offset);
e98a2d6e
PP
93 if (stream->mmap_addr == MAP_FAILED) {
94 PERR("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s\n",
78586d8a
JG
95 stream->mmap_len, stream->file->path->str,
96 stream->file->fp, stream->mmap_offset,
97 strerror(errno));
e98a2d6e
PP
98 goto error;
99 }
100
101 goto end;
e98a2d6e
PP
102error:
103 stream_munmap(stream);
104 ret = -1;
e98a2d6e
PP
105end:
106 return ret;
107}
108
5b29e799
JG
109static
110enum bt_ctf_notif_iter_medium_status medop_request_bytes(
e98a2d6e
PP
111 size_t request_sz, uint8_t **buffer_addr,
112 size_t *buffer_sz, void *data)
113{
114 enum bt_ctf_notif_iter_medium_status status =
115 BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
116 struct ctf_fs_stream *stream = data;
56a1cced 117 struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;
e98a2d6e
PP
118
119 if (request_sz == 0) {
120 goto end;
121 }
122
e98a2d6e
PP
123 /* Check if we have at least one memory-mapped byte left */
124 if (remaining_mmap_bytes(stream) == 0) {
125 /* Are we at the end of the file? */
fc9a526c 126 if (stream->request_offset >= stream->file->size) {
e98a2d6e
PP
127 PDBG("Reached end of file \"%s\" (%p)\n",
128 stream->file->path->str, stream->file->fp);
129 status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
130 goto end;
131 }
132
133 if (mmap_next(stream)) {
134 PERR("Cannot memory-map next region of file \"%s\" (%p)\n",
135 stream->file->path->str, stream->file->fp);
136 goto error;
137 }
138 }
139
140 *buffer_sz = MIN(remaining_mmap_bytes(stream), request_sz);
fc9a526c 141 *buffer_addr = ((uint8_t *) stream->mmap_addr) + stream->request_offset;
e98a2d6e
PP
142 stream->request_offset += *buffer_sz;
143 goto end;
144
145error:
146 status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
147
148end:
149 return status;
150}
151
5b29e799
JG
152static
153struct bt_ctf_stream *medop_get_stream(
e98a2d6e
PP
154 struct bt_ctf_stream_class *stream_class, void *data)
155{
156 struct ctf_fs_stream *fs_stream = data;
56a1cced 157 struct ctf_fs_component *ctf_fs = fs_stream->file->ctf_fs;
e98a2d6e
PP
158
159 if (!fs_stream->stream) {
160 int64_t id = bt_ctf_stream_class_get_id(stream_class);
161
162 PDBG("Creating stream out of stream class %" PRId64 "\n", id);
163 fs_stream->stream = bt_ctf_stream_create(stream_class,
fc9a526c 164 fs_stream->file->path->str);
e98a2d6e
PP
165 if (!fs_stream->stream) {
166 PERR("Cannot create stream (stream class %" PRId64 ")\n",
fc9a526c 167 id);
e98a2d6e
PP
168 }
169 }
170
171 return fs_stream->stream;
172}
173
174static struct bt_ctf_notif_iter_medium_ops medops = {
175 .request_bytes = medop_request_bytes,
176 .get_stream = medop_get_stream,
177};
178
b6c3dcb2
JG
179static
180int build_index_from_idx_file(struct ctf_fs_stream *stream)
181{
182 int ret = 0;
183 gchar *directory = NULL;
184 gchar *basename = NULL;
185 GString *index_basename = NULL;
186 gchar *index_file_path = NULL;
187 GMappedFile *mapped_file = NULL;
188 gsize filesize;
189 const struct ctf_packet_index_file_hdr *header;
190 const char *mmap_begin, *file_pos;
191 struct index_entry *index;
192 uint64_t total_packets_size = 0;
193 size_t file_index_entry_size;
194 size_t file_entry_count;
195 size_t i;
196
197 /* Look for index file in relative path index/name.idx. */
198 basename = g_path_get_basename(stream->file->path->str);
199 if (!basename) {
200 ret = -1;
201 goto end;
202 }
203
204 directory = g_path_get_dirname(stream->file->path->str);
205 if (!directory) {
206 ret = -1;
207 goto end;
208 }
209
210 index_basename = g_string_new(basename);
211 if (!index_basename) {
212 ret = -1;
213 goto end;
214 }
215
216 g_string_append(index_basename, ".idx");
217 index_file_path = g_build_filename(directory, "index",
218 index_basename->str, NULL);
219 mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL);
220 filesize = g_mapped_file_get_length(mapped_file);
221 if (filesize < sizeof(*header)) {
222 printf_error("Invalid LTTng trace index: file size < header size");
223 ret = -1;
224 goto end;
225 }
226
227 mmap_begin = g_mapped_file_get_contents(mapped_file);
228 header = (struct ctf_packet_index_file_hdr *) mmap_begin;
229
230 file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header);
231 if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
232 printf_error("Invalid LTTng trace index: \"magic\" validation failed");
233 ret = -1;
234 goto end;
235 }
236 stream->index.version.major = be32toh(header->index_major);
237 stream->index.version.minor = be32toh(header->index_minor);
238
239 file_index_entry_size = be32toh(header->packet_index_len);
240 file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
241 if ((filesize - sizeof(*header)) % (file_entry_count * file_index_entry_size)) {
242 printf_error("Invalid index file size; not a multiple of index entry size");
243 ret = -1;
244 goto end;
245 }
246
247 stream->index.entries = g_array_sized_new(FALSE, TRUE,
248 sizeof(struct index_entry), file_entry_count);
249 if (!stream->index.entries) {
250 ret = -1;
251 goto end;
252 }
253 index = (struct index_entry *) stream->index.entries->data;
254 for (i = 0; i < file_entry_count; i++) {
255 struct ctf_packet_index *file_index =
256 (struct ctf_packet_index *) file_pos;
257 uint64_t packet_size = be64toh(file_index->packet_size);
258
259 if (packet_size % CHAR_BIT) {
260 ret = -1;
261 printf_error("Invalid packet size encountered in index file");
262 goto invalid_index;
263 }
264
265 /* Convert size in bits to bytes. */
266 packet_size /= CHAR_BIT;
267 index->packet_size = packet_size;
268
269 index->offset = be64toh(file_index->offset);
270 if (i != 0 && index->offset < (index - 1)->offset) {
271 printf_error("Invalid, non-monotonic, packet offset encountered in index file");
272 ret = -1;
273 goto invalid_index;
274 }
275
276 index->timestamp_begin = be64toh(file_index->timestamp_begin);
277 index->timestamp_end = be64toh(file_index->timestamp_end);
278 if (index->timestamp_end < index->timestamp_begin) {
279 printf_error("Invalid packet time bounds encountered in index file");
280 ret = -1;
281 goto invalid_index;
282 }
283
284 total_packets_size += packet_size;
285 file_pos += file_index_entry_size;
286 index++;
287 }
288
289 /* Validate that the index addresses the complete stream. */
290 if (stream->file->size != total_packets_size) {
291 printf_error("Invalid index; indexed size != stream file size");
292 ret = -1;
293 goto invalid_index;
294 }
295end:
296 g_free(directory);
297 g_free(basename);
298 g_free(index_file_path);
299 g_string_free(index_basename, TRUE);
300 g_mapped_file_unref(mapped_file);
301 return ret;
302invalid_index:
303 g_array_free(stream->index.entries, TRUE);
304 goto end;
305}
306
307static
308int build_index_from_stream(struct ctf_fs_stream *stream)
309{
310 int ret = 0;
311end:
312 return ret;
313}
314
315static
316int init_stream_index(struct ctf_fs_stream *stream)
317{
318 int ret;
319
320 ret = build_index_from_idx_file(stream);
321 if (!ret) {
322 goto end;
323 }
324
325 ret = build_index_from_stream(stream);
326end:
327 return ret;
328}
329
e7a4393b
JG
330BT_HIDDEN
331struct ctf_fs_stream *ctf_fs_stream_create(
56a1cced 332 struct ctf_fs_component *ctf_fs, struct ctf_fs_file *file)
e98a2d6e 333{
b6c3dcb2 334 int ret;
e98a2d6e
PP
335 struct ctf_fs_stream *stream = g_new0(struct ctf_fs_stream, 1);
336
337 if (!stream) {
338 goto error;
339 }
340
341 stream->file = file;
5b29e799 342 stream->notif_iter = bt_ctf_notif_iter_create(ctf_fs->metadata->trace,
e7a4393b 343 ctf_fs->page_size, medops, stream, ctf_fs->error_fp);
e98a2d6e
PP
344 if (!stream->notif_iter) {
345 goto error;
346 }
5b29e799 347
fc9a526c 348 stream->mmap_max_len = ctf_fs->page_size * 2048;
b6c3dcb2
JG
349 ret = init_stream_index(stream);
350 if (ret) {
351 goto error;
352 }
e98a2d6e 353 goto end;
e98a2d6e 354error:
78586d8a 355 /* Do not touch "borrowed" file. */
e98a2d6e
PP
356 stream->file = NULL;
357 ctf_fs_stream_destroy(stream);
358 stream = NULL;
e98a2d6e
PP
359end:
360 return stream;
361}
362
5b29e799
JG
363BT_HIDDEN
364void ctf_fs_stream_destroy(struct ctf_fs_stream *stream)
e98a2d6e 365{
5b29e799
JG
366 if (!stream) {
367 return;
043e2020
JG
368 }
369
5b29e799
JG
370 if (stream->file) {
371 ctf_fs_file_destroy(stream->file);
e98a2d6e
PP
372 }
373
5b29e799
JG
374 if (stream->stream) {
375 BT_PUT(stream->stream);
043e2020 376 }
5b29e799
JG
377
378 if (stream->notif_iter) {
379 bt_ctf_notif_iter_destroy(stream->notif_iter);
78586d8a 380 }
5b29e799 381
b6c3dcb2
JG
382 if (stream->index.entries) {
383 g_array_free(stream->index.entries, TRUE);
384 }
385
5b29e799 386 g_free(stream);
e98a2d6e 387}
This page took 0.041612 seconds and 4 git commands to generate.