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/babeltrace.h>
  34 #include "data-stream-file.h"
  35 #include "metadata.h"
  36
  37 BT_HIDDEN
  38 extern bool ctf_fs_debug;
  39
  40 struct ctf_fs_file {
  41         /* Owned by this */
  42         GString *path;
  43
  44         /* Owned by this */
  45         FILE *fp;
  46
  47         off_t size;
  48 };
  49
  50 struct ctf_fs_metadata {
  51         /* Owned by this */
  52         struct bt_trace *trace;
  53
  54         /* Owned by this */
  55         char *text;
  56
  57         uint8_t uuid[16];
  58         bool is_uuid_set;
  59         int bo;
  60 };
  61
  62 struct ctf_fs_component {
  63         /* Weak, guaranteed to exist */
  64         struct bt_private_component *priv_comp;
  65
  66         /* Array of struct ctf_fs_port_data *, owned by this */
  67         GPtrArray *port_data;
  68
  69         /* Array of struct ctf_fs_trace *, owned by this */
  70         GPtrArray *traces;
  71
  72         struct ctf_fs_metadata_config metadata_config;
  73 };
  74
  75 struct ctf_fs_trace {
  76         /* Owned by this */
  77         struct ctf_fs_metadata *metadata;
  78
  79         /* Owned by this */
  80         struct bt_clock_class_priority_map *cc_prio_map;
  81
  82         /* Array of struct ctf_fs_ds_file_group *, owned by this */
  83         GPtrArray *ds_file_groups;
  84
  85         /* Owned by this */
  86         GString *path;
  87
  88         /* Owned by this */
  89         GString *name;
  90
  91         /* Next automatic stream ID when not provided by packet header */
  92         uint64_t next_stream_id;
  93 };
  94
  95 struct ctf_fs_ds_file_group {
  96         /*
  97          * Array of struct ctf_fs_ds_file_info, owned by this.
  98          *
  99          * This is an _ordered_ array of data stream file infos which
 100          * belong to this group (a single stream instance).
 101          *
 102          * You can call ctf_fs_ds_file_create() with one of those paths
 103          * and the CTF IR stream below.
 104          */
 105         GPtrArray *ds_file_infos;
 106
 107         /* Owned by this */
 108         struct bt_stream_class *stream_class;
 109
 110         /* Owned by this */
 111         struct bt_stream *stream;
 112
 113         /* Stream (instance) ID; -1ULL means none */
 114         uint64_t stream_id;
 115
 116         /* Weak, belongs to component */
 117         struct ctf_fs_trace *ctf_fs_trace;
 118 };
 119
 120 struct ctf_fs_port_data {
 121         /* Weak, belongs to ctf_fs_trace */
 122         struct ctf_fs_ds_file_group *ds_file_group;
 123
 124         /* Weak */
 125         struct ctf_fs_component *ctf_fs;
 126 };
 127
 128 struct ctf_fs_notif_iter_data {
 129         /* Weak */
 130         struct bt_private_connection_private_notification_iterator *pc_notif_iter;
 131
 132         /* Weak, belongs to ctf_fs_trace */
 133         struct ctf_fs_ds_file_group *ds_file_group;
 134
 135         /* Owned by this */
 136         struct ctf_fs_ds_file *ds_file;
 137
 138         /* Which file the iterator is _currently_ operating on */
 139         size_t ds_file_info_index;
 140
 141         /* Owned by this */
 142         struct bt_notif_iter *notif_iter;
 143
 144         /* True to skip BT_NOTIFICATION_TYPE_STREAM_BEGIN notifications */
 145         bool skip_stream_begin_notifs;
 146 };
 147
 148 BT_HIDDEN
 149 enum bt_component_status ctf_fs_init(struct bt_private_component *source,
 150                 struct bt_value *params, void *init_method_data);
 151
 152 BT_HIDDEN
 153 void ctf_fs_finalize(struct bt_private_component *component);
 154
 155 BT_HIDDEN
 156 struct bt_component_class_query_method_return ctf_fs_query(
 157                 struct bt_component_class *comp_class,
 158                 struct bt_query_executor *query_exec,
 159                 const char *object, struct bt_value *params);
 160
 161 BT_HIDDEN
 162 struct ctf_fs_trace *ctf_fs_trace_create(const char *path, const char *name,
 163                 struct ctf_fs_metadata_config *config, struct bt_graph *graph);
 164
 165 BT_HIDDEN
 166 void ctf_fs_trace_destroy(struct ctf_fs_trace *trace);
 167
 168 BT_HIDDEN
 169 int ctf_fs_find_traces(GList **trace_paths, const char *start_path);
 170
 171 BT_HIDDEN
 172 GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path);
 173
 174 BT_HIDDEN
 175 enum bt_notification_iterator_status ctf_fs_iterator_init(
 176                 struct bt_private_connection_private_notification_iterator *it,
 177                 struct bt_private_port *port);
 178 BT_HIDDEN
 179 void ctf_fs_iterator_finalize(struct bt_private_connection_private_notification_iterator *it);
 180
 181 BT_HIDDEN
 182 enum bt_notification_iterator_status ctf_fs_iterator_next(
 183                 struct bt_private_connection_private_notification_iterator *iterator,
 184                 bt_notification_array notifs, uint64_t capacity,
 185                 uint64_t *count);
 186
 187 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */