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 <babeltrace/babeltrace-internal.h>
  32 #include <babeltrace/graph/component.h>
  33 #include <babeltrace/graph/clock-class-priority-map.h>
  34 #include "data-stream.h"
  35
  36 BT_HIDDEN
  37 extern bool ctf_fs_debug;
  38
  39 struct ctf_fs_file {
  40         struct ctf_fs_component *ctf_fs;
  41         GString *path;
  42         FILE *fp;
  43         off_t size;
  44 };
  45
  46 struct ctf_fs_metadata {
  47         struct bt_ctf_trace *trace;
  48         uint8_t uuid[16];
  49         bool is_uuid_set;
  50         int bo;
  51         char *text;
  52 };
  53
  54 struct ctf_fs_stream {
  55         struct ctf_fs_file *file;
  56         struct bt_ctf_stream *stream;
  57         struct bt_clock_class_priority_map *cc_prio_map;
  58         struct bt_ctf_notif_iter *notif_iter;
  59         /* A stream is assumed to be indexed. */
  60         struct index index;
  61         void *mmap_addr;
  62         /* Max length of chunk to mmap() when updating the current mapping. */
  63         size_t mmap_max_len;
  64         /* Length of the current mapping. */
  65         size_t mmap_len;
  66         /* Length of the current mapping which *exists* in the backing file. */
  67         size_t mmap_valid_len;
  68         /* Offset in the file where the current mapping starts. */
  69         off_t mmap_offset;
  70         /*
  71          * Offset, in the current mapping, of the address to return on the next
  72          * request.
  73          */
  74         off_t request_offset;
  75         bool end_reached;
  76 };
  77
  78 struct ctf_fs_component_options {
  79         uint64_t clock_offset;
  80         uint64_t clock_offset_ns;
  81 };
  82
  83 struct ctf_fs_port_data {
  84         GString *path;
  85 };
  86
  87 struct ctf_fs_component {
  88         struct bt_private_component *priv_comp;
  89         GString *trace_path;
  90         FILE *error_fp;
  91         size_t page_size;
  92         struct ctf_fs_component_options options;
  93         struct ctf_fs_metadata *metadata;
  94         struct bt_clock_class_priority_map *cc_prio_map;
  95
  96         /* Array of struct ctf_fs_port_data *, owned by this */
  97         GPtrArray *port_data;
  98 };
  99
 100 BT_HIDDEN
 101 enum bt_component_status ctf_fs_init(struct bt_private_component *source,
 102                 struct bt_value *params, void *init_method_data);
 103
 104 BT_HIDDEN
 105 void ctf_fs_finalize(struct bt_private_component *component);
 106
 107 BT_HIDDEN
 108 enum bt_notification_iterator_status ctf_fs_iterator_init(
 109                 struct bt_private_notification_iterator *it,
 110                 struct bt_private_port *port);
 111
 112 void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it);
 113
 114 struct bt_notification_iterator_next_return ctf_fs_iterator_next(
 115                 struct bt_private_notification_iterator *iterator);
 116
 117 BT_HIDDEN
 118 struct bt_value *ctf_fs_query(struct bt_component_class *comp_class,
 119                 const char *object, struct bt_value *params);
 120
 121 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */