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

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright (C) 2016 Philippe Proulx <pproulx@efficios.com>
   5  */
   6
   7 #ifndef CTF_FS_DS_FILE_H
   8 #define CTF_FS_DS_FILE_H
   9
  10 #include <stdio.h>
  11 #include <stdbool.h>
  12 #include <glib.h>
  13 #include "common/macros.h"
  14 #include <babeltrace2/babeltrace.h>
  15
  16 #include "../common/msg-iter/msg-iter.hpp"
  17 #include "lttng-index.hpp"
  18
  19 struct ctf_fs_component;
  20 struct ctf_fs_file;
  21 struct ctf_fs_trace;
  22 struct ctf_fs_ds_file;
  23 struct ctf_fs_ds_file_group;
  24 struct ctf_fs_ds_group_medops_data;
  25
  26 struct ctf_fs_ds_file_info
  27 {
  28     /* Owned by this. */
  29     GString *path;
  30
  31     /* Guaranteed to be set, as opposed to the index. */
  32     int64_t begin_ns;
  33 };
  34
  35 struct ctf_fs_metadata;
  36
  37 struct ctf_fs_ds_file
  38 {
  39     bt_logging_level log_level;
  40
  41     /* Weak */
  42     bt_self_component *self_comp;
  43
  44     /* Weak */
  45     bt_self_message_iterator *self_msg_iter;
  46
  47     /* Weak */
  48     struct ctf_fs_metadata *metadata;
  49
  50     /* Owned by this */
  51     struct ctf_fs_file *file;
  52
  53     /* Owned by this */
  54     bt_stream *stream;
  55
  56     void *mmap_addr;
  57
  58     /*
  59      * Max length of chunk to mmap() when updating the current mapping.
  60      * This value must be page-aligned.
  61      */
  62     size_t mmap_max_len;
  63
  64     /* Length of the current mapping. Never exceeds the file's length. */
  65     size_t mmap_len;
  66
  67     /* Offset in the file where the current mapping starts. */
  68     off_t mmap_offset_in_file;
  69
  70     /*
  71      * Offset, in the current mapping, of the address to return on the next
  72      * request.
  73      */
  74     off_t request_offset_in_mapping;
  75 };
  76
  77 BT_HIDDEN
  78 struct ctf_fs_ds_file *ctf_fs_ds_file_create(struct ctf_fs_trace *ctf_fs_trace,
  79                                              bt_self_message_iterator *self_msg_iter,
  80                                              bt_stream *stream, const char *path,
  81                                              bt_logging_level log_level);
  82
  83 BT_HIDDEN
  84 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);
  85
  86 BT_HIDDEN
  87 struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(struct ctf_fs_ds_file *ds_file,
  88                                                    struct ctf_fs_ds_file_info *ds_file_info,
  89                                                    struct ctf_msg_iter *msg_iter);
  90
  91 BT_HIDDEN
  92 struct ctf_fs_ds_index *ctf_fs_ds_index_create(bt_logging_level log_level,
  93                                                bt_self_component *self_comp);
  94
  95 BT_HIDDEN
  96 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index);
  97
  98 /*
  99  * Medium operations to iterate on a single ctf_fs_ds_file.
 100  *
 101  * The data pointer when using this must be a pointer to the ctf_fs_ds_file.
 102  */
 103 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops;
 104
 105 /*
 106  * Medium operations to iterate on the packet of a ctf_fs_ds_group.
 107  *
 108  * The iteration is done based on the index of the group.
 109  *
 110  * The data pointer when using these medops must be a pointer to a ctf_fs_ds
 111  * group_medops_data structure.
 112  */
 113 BT_HIDDEN
 114 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops;
 115
 116 BT_HIDDEN
 117 enum ctf_msg_iter_medium_status ctf_fs_ds_group_medops_data_create(
 118     struct ctf_fs_ds_file_group *ds_file_group, bt_self_message_iterator *self_msg_iter,
 119     bt_logging_level log_level, struct ctf_fs_ds_group_medops_data **out);
 120
 121 BT_HIDDEN
 122 void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data *data);
 123
 124 BT_HIDDEN
 125 void ctf_fs_ds_group_medops_data_destroy(struct ctf_fs_ds_group_medops_data *data);
 126
 127 #endif /* CTF_FS_DS_FILE_H */