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