plugins/ctf/fs/fs.h

   1 #ifndef BABELTRACE_PLUGIN_CTF_FS_INTERNAL_H
   2 #define BABELTRACE_PLUGIN_CTF_FS_INTERNAL_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/plugin/component.h>
  33
  34 #define CTF_FS_COMPONENT_NAME "fs"
  35 #define CTF_FS_COMPONENT_DESCRIPTION \
  36         "Component used to read a CTF trace located on a file system."
  37
  38 static bool ctf_fs_debug;
  39
  40 struct bt_notification_heap;
  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         /* FIXME There should be many and ctf_fs_stream should not own them. */
  61         struct bt_ctf_notif_iter *notif_iter;
  62         void *mmap_addr;
  63         size_t mmap_len;
  64         off_t mmap_offset;
  65         off_t request_offset;
  66 };
  67
  68 struct ctf_fs_data_stream {
  69         GPtrArray *streams;
  70 };
  71
  72 struct ctf_fs_iterator {
  73         struct bt_notification_heap *pending_notifications;
  74 };
  75
  76 struct ctf_fs_component_options {
  77         bool opt_dummy : 1;
  78 };
  79
  80 struct ctf_fs_component {
  81         GString *trace_path;
  82         FILE *error_fp;
  83         size_t page_size;
  84         struct bt_notification *current_notification;
  85         struct ctf_fs_metadata metadata;
  86         struct ctf_fs_data_stream data_stream;
  87         struct ctf_fs_component_options options;
  88 };
  89
  90 BT_HIDDEN
  91 enum bt_component_status ctf_fs_init(struct bt_component *source,
  92                 struct bt_value *params);
  93
  94 #endif /* BABELTRACE_PLUGIN_CTF_FS_INTERNAL_H */