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/babeltrace.h>
  31
  32 #include "../common/msg-iter/msg-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 ctf_fs_ds_file_info {
  41         /* Owned by this. */
  42         GString *path;
  43
  44         /* Guaranteed to be set, as opposed to the index. */
  45         int64_t begin_ns;
  46 };
  47
  48 struct ctf_fs_metadata;
  49
  50 struct ctf_fs_ds_file {
  51         /* Weak */
  52         struct ctf_fs_metadata *metadata;
  53
  54         /* Weak */
  55         bt_self_message_iterator *pc_msg_iter;
  56
  57         /* Owned by this */
  58         struct ctf_fs_file *file;
  59
  60         /* Owned by this */
  61         bt_stream *stream;
  62
  63         /* Weak */
  64         struct bt_msg_iter *msg_iter;
  65
  66         void *mmap_addr;
  67
  68         /*
  69          * Max length of chunk to mmap() when updating the current mapping.
  70          * This value must be page-aligned.
  71          */
  72         size_t mmap_max_len;
  73
  74         /* Length of the current mapping. Never exceeds the file's length. */
  75         size_t mmap_len;
  76
  77         /* Offset in the file where the current mapping starts. */
  78         off_t mmap_offset;
  79
  80         /*
  81          * Offset, in the current mapping, of the address to return on the next
  82          * request.
  83          */
  84         off_t request_offset;
  85
  86         bool end_reached;
  87 };
  88
  89 BT_HIDDEN
  90 struct ctf_fs_ds_file *ctf_fs_ds_file_create(
  91                 struct ctf_fs_trace *ctf_fs_trace,
  92                 bt_self_message_iterator *pc_msg_iter,
  93                 struct bt_msg_iter *msg_iter,
  94                 bt_stream *stream, const char *path);
  95
  96 BT_HIDDEN
  97 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);
  98
  99 BT_HIDDEN
 100 bt_self_message_iterator_status ctf_fs_ds_file_next(
 101                 struct ctf_fs_ds_file *ds_file,
 102                 bt_message **msg);
 103
 104 BT_HIDDEN
 105 struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
 106                 struct ctf_fs_ds_file *ds_file);
 107
 108 BT_HIDDEN
 109 struct ctf_fs_ds_index *ctf_fs_ds_index_create();
 110
 111 BT_HIDDEN
 112 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index);
 113
 114 extern struct bt_msg_iter_medium_ops ctf_fs_ds_file_medops;
 115
 116 #endif /* CTF_FS_DS_FILE_H */