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         char *text;
  68
  69         int bo;
  70 };
  71
  72 struct ctf_fs_component {
  73         bt_logging_level log_level;
  74
  75         /* Weak, guaranteed to exist */
  76         bt_self_component_source *self_comp_src;
  77
  78         /* Weak */
  79         bt_self_component *self_comp;
  80
  81         /* Array of struct ctf_fs_port_data *, owned by this */
  82         GPtrArray *port_data;
  83
  84         /* Array of struct ctf_fs_trace *, owned by this */
  85         GPtrArray *traces;
  86
  87         struct ctf_fs_metadata_config metadata_config;
  88 };
  89
  90 struct ctf_fs_trace {
  91         bt_logging_level log_level;
  92
  93         /* Weak */
  94         bt_self_component *self_comp;
  95
  96         /* Owned by this */
  97         struct ctf_fs_metadata *metadata;
  98
  99         /* Owned by this */
 100         bt_trace *trace;
 101
 102         /* Array of struct ctf_fs_ds_file_group *, owned by this */
 103         GPtrArray *ds_file_groups;
 104
 105         /* Owned by this */
 106         GString *path;
 107
 108         /* Owned by this */
 109         GString *name;
 110
 111         /* Next automatic stream ID when not provided by packet header */
 112         uint64_t next_stream_id;
 113 };
 114
 115 struct ctf_fs_ds_index_entry {
 116         /* Weak, belongs to ctf_fs_ds_file_info. */
 117         const char *path;
 118
 119         /* Position, in bytes, of the packet from the beginning of the file. */
 120         uint64_t offset;
 121
 122         /* Size of the packet, in bytes. */
 123         uint64_t packet_size;
 124
 125         /*
 126          * Extracted from the packet context, relative to the respective fields'
 127          * mapped clock classes (in cycles).
 128          */
 129         uint64_t timestamp_begin, timestamp_end;
 130
 131         /*
 132          * Converted from the packet context, relative to the trace's EPOCH
 133          * (in ns since EPOCH).
 134          */
 135         int64_t timestamp_begin_ns, timestamp_end_ns;
 136 };
 137
 138 struct ctf_fs_ds_index {
 139         /* Array of pointer to struct ctf_fs_fd_index_entry. */
 140         GPtrArray *entries;
 141 };
 142
 143 struct ctf_fs_ds_file_group {
 144         /*
 145          * Array of struct ctf_fs_ds_file_info, owned by this.
 146          *
 147          * This is an _ordered_ array of data stream file infos which
 148          * belong to this group (a single stream instance).
 149          *
 150          * You can call ctf_fs_ds_file_create() with one of those paths
 151          * and the trace IR stream below.
 152          */
 153         GPtrArray *ds_file_infos;
 154
 155         /* Owned by this */
 156         struct ctf_stream_class *sc;
 157
 158         /* Owned by this */
 159         bt_stream *stream;
 160
 161         /* Stream (instance) ID; -1ULL means none */
 162         uint64_t stream_id;
 163
 164         /* Weak, belongs to component */
 165         struct ctf_fs_trace *ctf_fs_trace;
 166
 167         /*
 168          * Owned by this. May be NULL.
 169          *
 170          * A stream cannot be assumed to be indexed as the indexing might have
 171          * been skipped. Moreover, the index's fields may not all be available
 172          * depending on the producer (e.g. timestamp_begin/end are not
 173          * mandatory).
 174          */
 175         struct ctf_fs_ds_index *index;
 176 };
 177
 178 struct ctf_fs_port_data {
 179         /* Weak, belongs to ctf_fs_trace */
 180         struct ctf_fs_ds_file_group *ds_file_group;
 181
 182         /* Weak */
 183         struct ctf_fs_component *ctf_fs;
 184 };
 185
 186 struct ctf_fs_msg_iter_data {
 187         bt_logging_level log_level;
 188
 189         /* Weak */
 190         bt_self_component *self_comp;
 191
 192         /* Weak */
 193         bt_self_message_iterator *pc_msg_iter;
 194
 195         /* Weak, belongs to ctf_fs_trace */
 196         struct ctf_fs_ds_file_group *ds_file_group;
 197
 198         /* Owned by this */
 199         struct ctf_fs_ds_file *ds_file;
 200
 201         /* Which file the iterator is _currently_ operating on */
 202         size_t ds_file_info_index;
 203
 204         /* Owned by this */
 205         struct bt_msg_iter *msg_iter;
 206 };
 207
 208 BT_HIDDEN
 209 bt_component_class_init_method_status ctf_fs_init(
 210                 bt_self_component_source *source,
 211                 const bt_value *params, void *init_method_data);
 212
 213 BT_HIDDEN
 214 void ctf_fs_finalize(bt_self_component_source *component);
 215
 216 BT_HIDDEN
 217 bt_component_class_query_method_status ctf_fs_query(
 218                 bt_self_component_class_source *comp_class,
 219                 bt_private_query_executor *priv_query_exec,
 220                 const char *object, const bt_value *params,
 221                 void *method_data, 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 */