plugins/ctf/fs-src/fs.h

   1 #ifndef BABELTRACE_PLUGIN_CTF_FS_H
   2 #define BABELTRACE_PLUGIN_CTF_FS_H
   3
   4 /*
   5  * BabelTrace - CTF on File System Component
   6  *
   7  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a copy
  13  * of this software and associated documentation files (the "Software"), to deal
  14  * in the Software without restriction, including without limitation the rights
  15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16  * copies of the Software, and to permit persons to whom the Software is
  17  * furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included in
  20  * all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  25  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28  * SOFTWARE.
  29  */
  30
  31 #include <stdbool.h>
  32 #include <babeltrace/babeltrace-internal.h>
  33 #include <babeltrace/graph/component.h>
  34 #include <babeltrace/graph/clock-class-priority-map.h>
  35 #include "data-stream-file.h"
  36
  37 BT_HIDDEN
  38 extern bool ctf_fs_debug;
  39
  40 struct ctf_fs_file {
  41         /* Weak, belongs to component */
  42         struct ctf_fs_component *ctf_fs;
  43
  44         /* Owned by this */
  45         GString *path;
  46
  47         /* Owned by this */
  48         FILE *fp;
  49
  50         off_t size;
  51 };
  52
  53 struct ctf_fs_metadata {
  54         /* Owned by this */
  55         struct bt_ctf_trace *trace;
  56
  57         /* Owned by this */
  58         char *text;
  59
  60         uint8_t uuid[16];
  61         bool is_uuid_set;
  62         int bo;
  63 };
  64
  65 struct ctf_fs_ds_file_info {
  66         GString *path;
  67         uint64_t begin_ns;
  68 };
  69
  70 struct ctf_fs_ds_file {
  71         /* Owned by this */
  72         struct ctf_fs_file *file;
  73
  74         /* Owned by this */
  75         struct bt_ctf_stream *stream;
  76
  77         /* Owned by this */
  78         struct bt_clock_class_priority_map *cc_prio_map;
  79
  80         /* Owned by this */
  81         struct bt_ctf_notif_iter *notif_iter;
  82
  83         /* A stream is assumed to be indexed. */
  84         struct index index;
  85         void *mmap_addr;
  86         /* Max length of chunk to mmap() when updating the current mapping. */
  87         size_t mmap_max_len;
  88         /* Length of the current mapping. */
  89         size_t mmap_len;
  90         /* Length of the current mapping which *exists* in the backing file. */
  91         size_t mmap_valid_len;
  92         /* Offset in the file where the current mapping starts. */
  93         off_t mmap_offset;
  94         /*
  95          * Offset, in the current mapping, of the address to return on the next
  96          * request.
  97          */
  98         off_t request_offset;
  99         bool end_reached;
 100 };
 101
 102 struct ctf_fs_component_options {
 103         uint64_t clock_offset;
 104         uint64_t clock_offset_ns;
 105 };
 106
 107 struct ctf_fs_component {
 108         /* Weak, guaranteed to exist */
 109         struct bt_private_component *priv_comp;
 110
 111         /* Array of struct ctf_fs_port_data *, owned by this */
 112         GPtrArray *port_data;
 113
 114         /* Array of struct ctf_fs_trace *, owned by this */
 115         GPtrArray *traces;
 116
 117         struct ctf_fs_component_options options;
 118         FILE *error_fp;
 119         size_t page_size;
 120 };
 121
 122 struct ctf_fs_trace {
 123         /* Weak, belongs to component */
 124         struct ctf_fs_component *ctf_fs;
 125
 126         /* Owned by this */
 127         struct ctf_fs_metadata *metadata;
 128
 129         /* Owned by this */
 130         struct bt_clock_class_priority_map *cc_prio_map;
 131
 132         /* Array of struct ctf_fs_ds_file_group *, owned by this */
 133         GPtrArray *ds_file_groups;
 134
 135         /* Owned by this */
 136         GString *path;
 137
 138         /* Owned by this */
 139         GString *name;
 140 };
 141
 142 struct ctf_fs_ds_file_group {
 143         /*
 144          * Array of struct ctf_fs_ds_file_info, owned by this.
 145          *
 146          * This is an _ordered_ array of data stream file infos which
 147          * belong to this group (a single stream instance).
 148          *
 149          * You can call ctf_fs_ds_file_create() with one of those paths
 150          * and the CTF IR stream below.
 151          */
 152         GPtrArray *ds_file_infos;
 153
 154         /* Owned by this */
 155         struct bt_ctf_stream *stream;
 156
 157         /* Weak, belongs to component */
 158         struct ctf_fs_trace *ctf_fs_trace;
 159 };
 160
 161 struct ctf_fs_port_data {
 162         /* Weak, belongs to ctf_fs_trace */
 163         struct ctf_fs_ds_file_group *ds_file_group;
 164 };
 165
 166 struct ctf_fs_notif_iter_data {
 167         /* Weak, belongs to ctf_fs_trace */
 168         struct ctf_fs_ds_file_group *ds_file_group;
 169
 170         /* Owned by this */
 171         struct ctf_fs_ds_file *ds_file;
 172
 173         /* Which file the iterator is _currently_ operating on */
 174         size_t ds_file_info_index;
 175 };
 176
 177 BT_HIDDEN
 178 enum bt_component_status ctf_fs_init(struct bt_private_component *source,
 179                 struct bt_value *params, void *init_method_data);
 180
 181 BT_HIDDEN
 182 void ctf_fs_finalize(struct bt_private_component *component);
 183
 184 BT_HIDDEN
 185 enum bt_notification_iterator_status ctf_fs_iterator_init(
 186                 struct bt_private_notification_iterator *it,
 187                 struct bt_private_port *port);
 188
 189 void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it);
 190
 191 struct bt_notification_iterator_next_return ctf_fs_iterator_next(
 192                 struct bt_private_notification_iterator *iterator);
 193
 194 BT_HIDDEN
 195 struct bt_value *ctf_fs_query(struct bt_component_class *comp_class,
 196                 const char *object, struct bt_value *params);
 197
 198 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */