src/plugins/ctf/fs-src/fs.hpp

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * BabelTrace - CTF on File System Component
   8  */
   9
  10 #ifndef BABELTRACE_PLUGIN_CTF_FS_H
  11 #define BABELTRACE_PLUGIN_CTF_FS_H
  12
  13 #include <glib.h>
  14
  15 #include <babeltrace2/babeltrace.h>
  16
  17 #include "cpp-common/bt2c/logging.hpp"
  18
  19 #include "metadata.hpp"
  20
  21 extern bool ctf_fs_debug;
  22
  23 struct ctf_fs_file
  24 {
  25     explicit ctf_fs_file(const bt2c::Logger& parentLogger) :
  26         logger {parentLogger, "PLUGIN/SRC.CTF.FS/FILE"}
  27     {
  28     }
  29
  30     bt2c::Logger logger;
  31
  32     /* Owned by this */
  33     GString *path = nullptr;
  34
  35     /* Owned by this */
  36     FILE *fp = nullptr;
  37
  38     off_t size = 0;
  39 };
  40
  41 struct ctf_fs_metadata
  42 {
  43     /* Owned by this */
  44     struct ctf_metadata_decoder *decoder = nullptr;
  45
  46     /* Owned by this */
  47     bt_trace_class *trace_class = nullptr;
  48
  49     /* Weak (owned by `decoder` above) */
  50     struct ctf_trace_class *tc = nullptr;
  51
  52     /* Owned by this */
  53     char *text = nullptr;
  54
  55     int bo = 0;
  56 };
  57
  58 struct ctf_fs_component_deleter
  59 {
  60     void operator()(struct ctf_fs_component *);
  61 };
  62
  63 struct ctf_fs_component
  64 {
  65     using UP = std::unique_ptr<ctf_fs_component, ctf_fs_component_deleter>;
  66
  67     explicit ctf_fs_component(const bt2c::Logger& parentLogger) :
  68         logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"}
  69     {
  70     }
  71
  72     bt2c::Logger logger;
  73
  74     /* Array of struct ctf_fs_port_data *, owned by this */
  75     GPtrArray *port_data = nullptr;
  76
  77     /* Owned by this */
  78     struct ctf_fs_trace *trace = nullptr;
  79
  80     struct ctf_fs_metadata_config metadata_config;
  81 };
  82
  83 struct ctf_fs_trace
  84 {
  85     explicit ctf_fs_trace(const bt2c::Logger& parentLogger) :
  86         logger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"}
  87     {
  88     }
  89
  90     bt2c::Logger logger;
  91
  92     /* Owned by this */
  93     struct ctf_fs_metadata *metadata = nullptr;
  94
  95     /* Owned by this */
  96     bt_trace *trace = nullptr;
  97
  98     /* Array of struct ctf_fs_ds_file_group *, owned by this */
  99     GPtrArray *ds_file_groups = nullptr;
 100
 101     /* Owned by this */
 102     GString *path = nullptr;
 103
 104     /* Next automatic stream ID when not provided by packet header */
 105     uint64_t next_stream_id = 0;
 106 };
 107
 108 struct ctf_fs_ds_index_entry
 109 {
 110     /* Weak, belongs to ctf_fs_ds_file_info. */
 111     const char *path = nullptr;
 112
 113     /* Position, in bytes, of the packet from the beginning of the file. */
 114     uint64_t offset = 0;
 115
 116     /* Size of the packet, in bytes. */
 117     uint64_t packet_size = 0;
 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 = 0, timestamp_end = 0;
 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 = 0, timestamp_end_ns = 0;
 130
 131     /*
 132      * Packet sequence number, or UINT64_MAX if not present in the index.
 133      */
 134     uint64_t packet_seq_num = 0;
 135 };
 136
 137 struct ctf_fs_ds_index
 138 {
 139     /* Array of pointer to struct ctf_fs_ds_index_entry. */
 140     GPtrArray *entries = nullptr;
 141 };
 142
 143 struct ctf_fs_ds_file_group
 144 {
 145     /*
 146      * Array of struct ctf_fs_ds_file_info, owned by this.
 147      *
 148      * This is an _ordered_ array of data stream file infos which
 149      * belong to this group (a single stream instance).
 150      *
 151      * You can call ctf_fs_ds_file_create() with one of those paths
 152      * and the trace IR stream below.
 153      */
 154     GPtrArray *ds_file_infos = nullptr;
 155
 156     /* Owned by this */
 157     struct ctf_stream_class *sc = nullptr;
 158
 159     /* Owned by this */
 160     bt_stream *stream = nullptr;
 161
 162     /* Stream (instance) ID; -1ULL means none */
 163     uint64_t stream_id = 0;
 164
 165     /* Weak, belongs to component */
 166     struct ctf_fs_trace *ctf_fs_trace = nullptr;
 167
 168     /*
 169      * Owned by this.
 170      */
 171     struct ctf_fs_ds_index *index = nullptr;
 172 };
 173
 174 struct ctf_fs_port_data
 175 {
 176     /* Weak, belongs to ctf_fs_trace */
 177     struct ctf_fs_ds_file_group *ds_file_group = nullptr;
 178
 179     /* Weak */
 180     struct ctf_fs_component *ctf_fs = nullptr;
 181 };
 182
 183 struct ctf_fs_msg_iter_data
 184 {
 185     explicit ctf_fs_msg_iter_data(bt_self_message_iterator *selfMsgIter) :
 186         self_msg_iter {selfMsgIter}, logger {bt2::SelfMessageIterator {self_msg_iter},
 187                                              "PLUGIN/SRC.CTF.FS/MSG-ITER"}
 188     {
 189     }
 190
 191     /* Weak */
 192     bt_self_message_iterator *self_msg_iter = nullptr;
 193
 194     bt2c::Logger logger;
 195
 196     /* Weak, belongs to ctf_fs_trace */
 197     struct ctf_fs_ds_file_group *ds_file_group = nullptr;
 198
 199     /* Owned by this */
 200     struct ctf_msg_iter *msg_iter = nullptr;
 201
 202     /*
 203      * Saved error.  If we hit an error in the _next method, but have some
 204      * messages ready to return, we save the error here and return it on
 205      * the next _next call.
 206      */
 207     bt_message_iterator_class_next_method_status next_saved_status =
 208         BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
 209     const struct bt_error *next_saved_error = nullptr;
 210
 211     struct ctf_fs_ds_group_medops_data *msg_iter_medops_data = nullptr;
 212 };
 213
 214 bt_component_class_initialize_method_status
 215 ctf_fs_init(bt_self_component_source *source, bt_self_component_source_configuration *config,
 216             const bt_value *params, void *init_method_data);
 217
 218 void ctf_fs_finalize(bt_self_component_source *component);
 219
 220 bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class,
 221                                                     bt_private_query_executor *priv_query_exec,
 222                                                     const char *object, const bt_value *params,
 223                                                     void *method_data, const bt_value **result);
 224
 225 bt_message_iterator_class_initialize_method_status
 226 ctf_fs_iterator_init(bt_self_message_iterator *self_msg_iter,
 227                      bt_self_message_iterator_configuration *config,
 228                      bt_self_component_port_output *self_port);
 229
 230 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
 231
 232 bt_message_iterator_class_next_method_status
 233 ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const msgs,
 234                      uint64_t capacity, uint64_t *count);
 235
 236 bt_message_iterator_class_seek_beginning_method_status
 237 ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator);
 238
 239 /* Create and initialize a new, empty ctf_fs_component. */
 240
 241 ctf_fs_component::UP ctf_fs_component_create(const bt2c::Logger& parentLogger);
 242
 243 /*
 244  * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
 245  * the same UUID.
 246  *
 247  * `paths_value` must be an array of strings,
 248  *
 249  * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
 250  *
 251  * `self_comp` and `self_comp_class` are used for logging, only one of them
 252  * should be set.
 253  */
 254
 255 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs,
 256                                          const bt_value *paths_value,
 257                                          const bt_value *trace_name_value,
 258                                          bt_self_component *selfComp);
 259
 260 /* Free `ctf_fs` and everything it owns. */
 261
 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  *  - The optional `trace-name` parameter is returned in `*trace_name` if
 271  *    present, else `*trace_name` is set to NULL.
 272  *
 273  * `self_comp` and `self_comp_class` are used for logging, only one of them
 274  * should be set.
 275  *
 276  * Return true on success, false if any parameter didn't pass validation.
 277  */
 278
 279 bool read_src_fs_parameters(const bt_value *params, const bt_value **paths,
 280                             const bt_value **trace_name, struct ctf_fs_component *ctf_fs);
 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 gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
 289
 290 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */