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