src/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 "common/macros.h"
  33 #include <babeltrace2/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         bt_logging_level log_level;
  43
  44         /* Weak */
  45         bt_self_component *self_comp;
  46
  47         /* Owned by this */
  48         GString *path;
  49
  50         /* Owned by this */
  51         FILE *fp;
  52
  53         off_t size;
  54 };
  55
  56 struct ctf_fs_metadata {
  57         /* Owned by this */
  58         struct ctf_metadata_decoder *decoder;
  59
  60         /* Owned by this */
  61         bt_trace_class *trace_class;
  62
  63         /* Weak (owned by `decoder` above) */
  64         struct ctf_trace_class *tc;
  65
  66         /* Owned by this */
  67
  68         /* Owned by this */
  69         char *text;
  70
  71         int bo;
  72 };
  73
  74 struct ctf_fs_component {
  75         bt_logging_level log_level;
  76
  77         /* Weak, guaranteed to exist */
  78         bt_self_component_source *self_comp_src;
  79
  80         /* Weak */
  81         bt_self_component *self_comp;
  82
  83         /* Array of struct ctf_fs_port_data *, owned by this */
  84         GPtrArray *port_data;
  85
  86         /* Array of struct ctf_fs_trace *, owned by this */
  87         GPtrArray *traces;
  88
  89         struct ctf_fs_metadata_config metadata_config;
  90 };
  91
  92 struct ctf_fs_trace {
  93         bt_logging_level log_level;
  94
  95         /* Weak */
  96         bt_self_component *self_comp;
  97
  98         /* Owned by this */
  99         struct ctf_fs_metadata *metadata;
 100
 101         /* Owned by this */
 102         bt_trace *trace;
 103
 104         /* Array of struct ctf_fs_ds_file_group *, owned by this */
 105         GPtrArray *ds_file_groups;
 106
 107         /* Owned by this */
 108         GString *path;
 109
 110         /* Owned by this */
 111         GString *name;
 112
 113         /* Next automatic stream ID when not provided by packet header */
 114         uint64_t next_stream_id;
 115 };
 116
 117 struct ctf_fs_ds_index_entry {
 118         /* Position, in bytes, of the packet from the beginning of the file. */
 119         uint64_t offset;
 120
 121         /* Size of the packet, in bytes. */
 122         uint64_t packet_size;
 123
 124         /*
 125          * Extracted from the packet context, relative to the respective fields'
 126          * mapped clock classes (in cycles).
 127          */
 128         uint64_t timestamp_begin, timestamp_end;
 129
 130         /*
 131          * Converted from the packet context, relative to the trace's EPOCH
 132          * (in ns since EPOCH).
 133          */
 134         int64_t timestamp_begin_ns, timestamp_end_ns;
 135 };
 136
 137 struct ctf_fs_ds_index {
 138         /* Array of pointer to struct ctf_fs_fd_index_entry. */
 139         GPtrArray *entries;
 140 };
 141
 142 struct ctf_fs_ds_file_group {
 143         /*
 144          * Array of struct ctf_fs_ds_file_info, owned by this.
 145          *
 146          * This is an _ordered_ array of data stream file infos which
 147          * belong to this group (a single stream instance).
 148          *
 149          * You can call ctf_fs_ds_file_create() with one of those paths
 150          * and the trace IR stream below.
 151          */
 152         GPtrArray *ds_file_infos;
 153
 154         /* Owned by this */
 155         struct ctf_stream_class *sc;
 156
 157         /* Owned by this */
 158         bt_stream *stream;
 159
 160         /* Stream (instance) ID; -1ULL means none */
 161         uint64_t stream_id;
 162
 163         /* Weak, belongs to component */
 164         struct ctf_fs_trace *ctf_fs_trace;
 165
 166         /*
 167          * Owned by this. May be NULL.
 168          *
 169          * A stream cannot be assumed to be indexed as the indexing might have
 170          * been skipped. Moreover, the index's fields may not all be available
 171          * depending on the producer (e.g. timestamp_begin/end are not
 172          * mandatory).
 173          */
 174         struct ctf_fs_ds_index *index;
 175 };
 176
 177 struct ctf_fs_port_data {
 178         /* Weak, belongs to ctf_fs_trace */
 179         struct ctf_fs_ds_file_group *ds_file_group;
 180
 181         /* Weak */
 182         struct ctf_fs_component *ctf_fs;
 183 };
 184
 185 struct ctf_fs_msg_iter_data {
 186         bt_logging_level log_level;
 187
 188         /* Weak */
 189         bt_self_component *self_comp;
 190
 191         /* Weak */
 192         bt_self_message_iterator *pc_msg_iter;
 193
 194         /* Weak, belongs to ctf_fs_trace */
 195         struct ctf_fs_ds_file_group *ds_file_group;
 196
 197         /* Owned by this */
 198         struct ctf_fs_ds_file *ds_file;
 199
 200         /* Which file the iterator is _currently_ operating on */
 201         size_t ds_file_info_index;
 202
 203         /* Owned by this */
 204         struct bt_msg_iter *msg_iter;
 205 };
 206
 207 BT_HIDDEN
 208 bt_component_class_init_method_status ctf_fs_init(
 209                 bt_self_component_source *source,
 210                 const bt_value *params, void *init_method_data);
 211
 212 BT_HIDDEN
 213 void ctf_fs_finalize(bt_self_component_source *component);
 214
 215 BT_HIDDEN
 216 bt_component_class_query_method_status ctf_fs_query(
 217                 bt_self_component_class_source *comp_class,
 218                 const bt_query_executor *query_exec,
 219                 const char *object, const bt_value *params,
 220                 bt_logging_level log_level,
 221                 const bt_value **result);
 222
 223 BT_HIDDEN
 224 bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init(
 225                 bt_self_message_iterator *self_msg_iter,
 226                 bt_self_component_source *self_comp,
 227                 bt_self_component_port_output *self_port);
 228
 229 BT_HIDDEN
 230 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
 231
 232 BT_HIDDEN
 233 bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next(
 234                 bt_self_message_iterator *iterator,
 235                 bt_message_array_const msgs, uint64_t capacity,
 236                 uint64_t *count);
 237
 238 BT_HIDDEN
 239 bt_component_class_message_iterator_seek_beginning_method_status ctf_fs_iterator_seek_beginning(
 240                 bt_self_message_iterator *message_iterator);
 241
 242 /* Create and initialize a new, empty ctf_fs_component. */
 243
 244 BT_HIDDEN
 245 struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level,
 246                 bt_self_component *self_comp);
 247
 248 /*
 249  * Search recursively under all paths in `paths_value` (an array of strings),
 250  * for CTF traces. For each CTF trace found, create a ctf_fs_trace in
 251  * `ctf_fs` representing that trace.
 252  */
 253
 254 BT_HIDDEN
 255 int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp,
 256                 struct ctf_fs_component *ctf_fs,
 257                 const bt_value *paths_value);
 258
 259 /* Free `ctf_fs` and everything it owns. */
 260
 261 BT_HIDDEN
 262 void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
 263
 264 /*
 265  * Read and validate parameters taken by the src.ctf.fs plugin.
 266  *
 267  *  - The mandatory `paths` parameter is returned in `*paths`.
 268  *  - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
 269  *    present, are recorded in the `ctf_fs` structure.
 270  *
 271  * Return true on success, false if any parameter didn't pass validation.
 272  */
 273
 274 BT_HIDDEN
 275 bool read_src_fs_parameters(const bt_value *params,
 276                 const bt_value **paths, struct ctf_fs_component *ctf_fs);
 277
 278 /*
 279  * Generate the port name to be used for a given data stream file group.
 280  *
 281  * The result must be freed using g_free by the caller.
 282  */
 283
 284 BT_HIDDEN
 285 gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
 286
 287 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */