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