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