plugins/ctf/fs/data-stream.c

   1 /*
   2  * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
   5  *
   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>
  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>
  38 #include "data-stream.h"
  39
  40 #define PRINT_ERR_STREAM        ctf_fs->error_fp
  41 #define PRINT_PREFIX            "ctf-fs-data-stream"
  42 #include "print.h"
  43
  44 static
  45 size_t remaining_mmap_bytes(struct ctf_fs_stream *stream)
  46 {
  47         return stream->mmap_valid_len - stream->request_offset;
  48 }
  49
  50 static
  51 int stream_munmap(struct ctf_fs_stream *stream)
  52 {
  53         int ret = 0;
  54         struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;
  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));
  61                 ret = -1;
  62                 goto end;
  63         }
  64 end:
  65         return ret;
  66 }
  67
  68 static
  69 int mmap_next(struct ctf_fs_stream *stream)
  70 {
  71         int ret = 0;
  72         struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;
  73
  74         /* Unmap old region */
  75         if (stream->mmap_addr) {
  76                 if (stream_munmap(stream)) {
  77                         goto error;
  78                 }
  79
  80                 stream->mmap_offset += stream->mmap_valid_len;
  81                 stream->request_offset = 0;
  82         }
  83
  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);
  89         /* Map new region */
  90         stream->mmap_addr = mmap((void *) 0, stream->mmap_len,
  91                         PROT_READ, MAP_PRIVATE, fileno(stream->file->fp),
  92                         stream->mmap_offset);
  93         if (stream->mmap_addr == MAP_FAILED) {
  94                 PERR("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s\n",
  95                                 stream->mmap_len, stream->file->path->str,
  96                                 stream->file->fp, stream->mmap_offset,
  97                                 strerror(errno));
  98                 goto error;
  99         }
 100
 101         goto end;
 102 error:
 103         stream_munmap(stream);
 104         ret = -1;
 105 end:
 106         return ret;
 107 }
 108
 109 static
 110 enum bt_ctf_notif_iter_medium_status medop_request_bytes(
 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;
 117         struct ctf_fs_component *ctf_fs = stream->file->ctf_fs;
 118
 119         if (request_sz == 0) {
 120                 goto end;
 121         }
 122
 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? */
 126                 if (stream->request_offset >= stream->file->size) {
 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);
 141         *buffer_addr = ((uint8_t *) stream->mmap_addr) + stream->request_offset;
 142         stream->request_offset += *buffer_sz;
 143         goto end;
 144
 145 error:
 146         status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
 147
 148 end:
 149         return status;
 150 }
 151
 152 static
 153 struct bt_ctf_stream *medop_get_stream(
 154                 struct bt_ctf_stream_class *stream_class, void *data)
 155 {
 156         struct ctf_fs_stream *fs_stream = data;
 157         struct ctf_fs_component *ctf_fs = fs_stream->file->ctf_fs;
 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,
 164                                 fs_stream->file->path->str);
 165                 if (!fs_stream->stream) {
 166                         PERR("Cannot create stream (stream class %" PRId64 ")\n",
 167                                         id);
 168                 }
 169         }
 170
 171         return fs_stream->stream;
 172 }
 173
 174 static struct bt_ctf_notif_iter_medium_ops medops = {
 175         .request_bytes = medop_request_bytes,
 176         .get_stream = medop_get_stream,
 177 };
 178
 179 static
 180 int 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
 237         file_index_entry_size = be32toh(header->packet_index_len);
 238         file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
 239         if ((filesize - sizeof(*header)) % (file_entry_count * file_index_entry_size)) {
 240                 printf_error("Invalid index file size; not a multiple of index entry size");
 241                 ret = -1;
 242                 goto end;
 243         }
 244
 245         stream->index.entries = g_array_sized_new(FALSE, TRUE,
 246                         sizeof(struct index_entry), file_entry_count);
 247         if (!stream->index.entries) {
 248                 ret = -1;
 249                 goto end;
 250         }
 251         index = (struct index_entry *) stream->index.entries->data;
 252         for (i = 0; i < file_entry_count; i++) {
 253                 struct ctf_packet_index *file_index =
 254                                 (struct ctf_packet_index *) file_pos;
 255                 uint64_t packet_size = be64toh(file_index->packet_size);
 256
 257                 if (packet_size % CHAR_BIT) {
 258                         ret = -1;
 259                         printf_error("Invalid packet size encountered in index file");
 260                         goto invalid_index;
 261                 }
 262
 263                 /* Convert size in bits to bytes. */
 264                 packet_size /= CHAR_BIT;
 265                 index->packet_size = packet_size;
 266
 267                 index->offset = be64toh(file_index->offset);
 268                 if (i != 0 && index->offset < (index - 1)->offset) {
 269                         printf_error("Invalid, non-monotonic, packet offset encountered in index file");
 270                         ret = -1;
 271                         goto invalid_index;
 272                 }
 273
 274                 index->timestamp_begin = be64toh(file_index->timestamp_begin);
 275                 index->timestamp_end = be64toh(file_index->timestamp_end);
 276                 if (index->timestamp_end < index->timestamp_begin) {
 277                         printf_error("Invalid packet time bounds encountered in index file");
 278                         ret = -1;
 279                         goto invalid_index;
 280                 }
 281
 282                 total_packets_size += packet_size;
 283                 file_pos += file_index_entry_size;
 284                 index++;
 285         }
 286
 287         /* Validate that the index addresses the complete stream. */
 288         if (stream->file->size != total_packets_size) {
 289                 printf_error("Invalid index; indexed size != stream file size");
 290                 ret = -1;
 291                 goto invalid_index;
 292         }
 293 end:
 294         g_free(directory);
 295         g_free(basename);
 296         g_free(index_file_path);
 297         g_string_free(index_basename, TRUE);
 298         g_mapped_file_unref(mapped_file);
 299         return ret;
 300 invalid_index:
 301         g_array_free(stream->index.entries, TRUE);
 302         goto end;
 303 }
 304
 305 static
 306 int build_index_from_stream(struct ctf_fs_stream *stream)
 307 {
 308         int ret = 0;
 309 end:
 310         return ret;
 311 }
 312
 313 static
 314 int init_stream_index(struct ctf_fs_stream *stream)
 315 {
 316         int ret;
 317
 318         ret = build_index_from_idx_file(stream);
 319         if (!ret) {
 320                 goto end;
 321         }
 322
 323         ret = build_index_from_stream(stream);
 324 end:
 325         return ret;
 326 }
 327
 328 BT_HIDDEN
 329 struct ctf_fs_stream *ctf_fs_stream_create(
 330                 struct ctf_fs_component *ctf_fs, struct ctf_fs_file *file)
 331 {
 332         int ret;
 333         struct ctf_fs_stream *stream = g_new0(struct ctf_fs_stream, 1);
 334
 335         if (!stream) {
 336                 goto error;
 337         }
 338
 339         stream->file = file;
 340         stream->notif_iter = bt_ctf_notif_iter_create(ctf_fs->metadata->trace,
 341                         ctf_fs->page_size, medops, stream, ctf_fs->error_fp);
 342         if (!stream->notif_iter) {
 343                 goto error;
 344         }
 345
 346         stream->mmap_max_len = ctf_fs->page_size * 2048;
 347         ret = init_stream_index(stream);
 348         if (ret) {
 349                 goto error;
 350         }
 351         goto end;
 352 error:
 353         /* Do not touch "borrowed" file. */
 354         stream->file = NULL;
 355         ctf_fs_stream_destroy(stream);
 356         stream = NULL;
 357 end:
 358         return stream;
 359 }
 360
 361 BT_HIDDEN
 362 void ctf_fs_stream_destroy(struct ctf_fs_stream *stream)
 363 {
 364         if (!stream) {
 365                 return;
 366         }
 367
 368         if (stream->file) {
 369                 ctf_fs_file_destroy(stream->file);
 370         }
 371
 372         if (stream->stream) {
 373                 BT_PUT(stream->stream);
 374         }
 375
 376         if (stream->notif_iter) {
 377                 bt_ctf_notif_iter_destroy(stream->notif_iter);
 378         }
 379
 380         if (stream->index.entries) {
 381                 g_array_free(stream->index.entries, TRUE);
 382         }
 383
 384         g_free(stream);
 385 }