plugins/ctf/fs-src/data-stream-file.h

   1 #ifndef CTF_FS_DS_FILE_H
   2 #define CTF_FS_DS_FILE_H
   3
   4 /*
   5  * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <stdio.h>
  27 #include <stdbool.h>
  28 #include <glib.h>
  29 #include <babeltrace/babeltrace-internal.h>
  30 #include <babeltrace/ctf-ir/trace.h>
  31
  32 #include "../common/notif-iter/notif-iter.h"
  33 #include "lttng-index.h"
  34
  35 struct ctf_fs_component;
  36 struct ctf_fs_file;
  37 struct ctf_fs_trace;
  38 struct ctf_fs_ds_file;
  39
  40 struct index_entry {
  41         uint64_t offset; /* in bytes. */
  42         uint64_t packet_size; /* in bytes. */
  43         /* relative to the packet context field's mapped clock. */
  44         uint64_t timestamp_begin, timestamp_end;
  45 };
  46
  47 struct index {
  48         GArray *entries; /* Array of struct index_entry. */
  49 };
  50
  51 BT_HIDDEN
  52 struct ctf_fs_ds_file *ctf_fs_ds_file_create(
  53                 struct ctf_fs_trace *ctf_fs_trace,
  54                 struct bt_ctf_stream *stream, const char *path,
  55                 bool build_index);
  56
  57 BT_HIDDEN
  58 int ctf_fs_ds_file_get_packet_header_context_fields(
  59                 struct ctf_fs_trace *ctf_fs_trace, const char *path,
  60                 struct bt_ctf_field **packet_header_field,
  61                 struct bt_ctf_field **packet_context_field);
  62
  63 BT_HIDDEN
  64 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);
  65
  66 BT_HIDDEN
  67 struct bt_notification_iterator_next_return ctf_fs_ds_file_next(
  68                 struct ctf_fs_ds_file *stream);
  69
  70 #endif /* CTF_FS_DS_FILE_H */