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.h"
  36
  37 BT_HIDDEN
  38 extern bool ctf_fs_debug;
  39
  40 struct ctf_fs_file {
  41         /* Weak */
  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_stream {
  66         /* Owned by this */
  67         struct ctf_fs_file *file;
  68
  69         /* Owned by this */
  70         struct bt_ctf_stream *stream;
  71
  72         /* Owned by this */
  73         struct bt_clock_class_priority_map *cc_prio_map;
  74
  75         /* Owned by this */
  76         struct bt_ctf_notif_iter *notif_iter;
  77
  78         /* A stream is assumed to be indexed. */
  79         struct index index;
  80         void *mmap_addr;
  81         /* Max length of chunk to mmap() when updating the current mapping. */
  82         size_t mmap_max_len;
  83         /* Length of the current mapping. */
  84         size_t mmap_len;
  85         /* Length of the current mapping which *exists* in the backing file. */
  86         size_t mmap_valid_len;
  87         /* Offset in the file where the current mapping starts. */
  88         off_t mmap_offset;
  89         /*
  90          * Offset, in the current mapping, of the address to return on the next
  91          * request.
  92          */
  93         off_t request_offset;
  94         bool end_reached;
  95 };
  96
  97 struct ctf_fs_component_options {
  98         uint64_t clock_offset;
  99         uint64_t clock_offset_ns;
 100 };
 101
 102 struct ctf_fs_component {
 103         /* Weak */
 104         struct bt_private_component *priv_comp;
 105
 106         /* Array of struct ctf_fs_port_data *, owned by this */
 107         GPtrArray *port_data;
 108
 109         /* Array of struct ctf_fs_trace *, owned by this */
 110         GPtrArray *traces;
 111
 112         struct ctf_fs_component_options options;
 113         FILE *error_fp;
 114         size_t page_size;
 115 };
 116
 117 struct ctf_fs_trace {
 118         /* Weak */
 119         struct ctf_fs_component *ctf_fs;
 120
 121         /* Owned by this */
 122         struct ctf_fs_metadata *metadata;
 123
 124         /* Owned by this */
 125         struct bt_clock_class_priority_map *cc_prio_map;
 126
 127         /* Owned by this */
 128         GString *path;
 129
 130         /* Owned by this */
 131         GString *name;
 132 };
 133
 134 struct ctf_fs_port_data {
 135         /* Owned by this */
 136         GString *path;
 137
 138         /* Weak */
 139         struct ctf_fs_trace *ctf_fs_trace;
 140 };
 141
 142 BT_HIDDEN
 143 enum bt_component_status ctf_fs_init(struct bt_private_component *source,
 144                 struct bt_value *params, void *init_method_data);
 145
 146 BT_HIDDEN
 147 void ctf_fs_finalize(struct bt_private_component *component);
 148
 149 BT_HIDDEN
 150 enum bt_notification_iterator_status ctf_fs_iterator_init(
 151                 struct bt_private_notification_iterator *it,
 152                 struct bt_private_port *port);
 153
 154 void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it);
 155
 156 struct bt_notification_iterator_next_return ctf_fs_iterator_next(
 157                 struct bt_private_notification_iterator *iterator);
 158
 159 BT_HIDDEN
 160 struct bt_value *ctf_fs_query(struct bt_component_class *comp_class,
 161                 const char *object, struct bt_value *params);
 162
 163 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */