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
  59 {
  60     explicit ctf_fs_component(const bt2c::Logger& parentLogger) :
  61         logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"}
  62     {
  63     }
  64
  65     bt2c::Logger logger;
  66
  67     /* Array of struct ctf_fs_port_data *, owned by this */
  68     GPtrArray *port_data = nullptr;
  69
  70     /* Owned by this */
  71     struct ctf_fs_trace *trace = nullptr;
  72
  73     struct ctf_fs_metadata_config metadata_config;
  74 };
  75
  76 struct ctf_fs_trace
  77 {
  78     explicit ctf_fs_trace(const bt2c::Logger& parentLogger) :
  79         logger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"}
  80     {
  81     }
  82
  83     bt2c::Logger logger;
  84
  85     /* Owned by this */
  86     struct ctf_fs_metadata *metadata = nullptr;
  87
  88     /* Owned by this */
  89     bt_trace *trace = nullptr;
  90
  91     /* Array of struct ctf_fs_ds_file_group *, owned by this */
  92     GPtrArray *ds_file_groups = nullptr;
  93
  94     /* Owned by this */
  95     GString *path = nullptr;
  96
  97     /* Next automatic stream ID when not provided by packet header */
  98     uint64_t next_stream_id = 0;
  99 };
 100
 101 struct ctf_fs_ds_index_entry
 102 {
 103     /* Weak, belongs to ctf_fs_ds_file_info. */
 104     const char *path = nullptr;
 105
 106     /* Position, in bytes, of the packet from the beginning of the file. */
 107     uint64_t offset = 0;
 108
 109     /* Size of the packet, in bytes. */
 110     uint64_t packet_size = 0;
 111
 112     /*
 113      * Extracted from the packet context, relative to the respective fields'
 114      * mapped clock classes (in cycles).
 115      */
 116     uint64_t timestamp_begin = 0, timestamp_end = 0;
 117
 118     /*
 119      * Converted from the packet context, relative to the trace's EPOCH
 120      * (in ns since EPOCH).
 121      */
 122     int64_t timestamp_begin_ns = 0, timestamp_end_ns = 0;
 123
 124     /*
 125      * Packet sequence number, or UINT64_MAX if not present in the index.
 126      */
 127     uint64_t packet_seq_num = 0;
 128 };
 129
 130 struct ctf_fs_ds_index
 131 {
 132     /* Array of pointer to struct ctf_fs_ds_index_entry. */
 133     GPtrArray *entries = nullptr;
 134 };
 135
 136 struct ctf_fs_ds_file_group
 137 {
 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 = nullptr;
 148
 149     /* Owned by this */
 150     struct ctf_stream_class *sc = nullptr;
 151
 152     /* Owned by this */
 153     bt_stream *stream = nullptr;
 154
 155     /* Stream (instance) ID; -1ULL means none */
 156     uint64_t stream_id = 0;
 157
 158     /* Weak, belongs to component */
 159     struct ctf_fs_trace *ctf_fs_trace = nullptr;
 160
 161     /*
 162      * Owned by this.
 163      */
 164     struct ctf_fs_ds_index *index = nullptr;
 165 };
 166
 167 struct ctf_fs_port_data
 168 {
 169     /* Weak, belongs to ctf_fs_trace */
 170     struct ctf_fs_ds_file_group *ds_file_group = nullptr;
 171
 172     /* Weak */
 173     struct ctf_fs_component *ctf_fs = nullptr;
 174 };
 175
 176 struct ctf_fs_msg_iter_data
 177 {
 178     explicit ctf_fs_msg_iter_data(bt_self_message_iterator *selfMsgIter) :
 179         self_msg_iter {selfMsgIter}, logger {bt2::SelfMessageIterator {self_msg_iter},
 180                                              "PLUGIN/SRC.CTF.FS/MSG-ITER"}
 181     {
 182     }
 183
 184     /* Weak */
 185     bt_self_message_iterator *self_msg_iter = nullptr;
 186
 187     bt2c::Logger logger;
 188
 189     /* Weak, belongs to ctf_fs_trace */
 190     struct ctf_fs_ds_file_group *ds_file_group = nullptr;
 191
 192     /* Owned by this */
 193     struct ctf_msg_iter *msg_iter = nullptr;
 194
 195     /*
 196      * Saved error.  If we hit an error in the _next method, but have some
 197      * messages ready to return, we save the error here and return it on
 198      * the next _next call.
 199      */
 200     bt_message_iterator_class_next_method_status next_saved_status =
 201         BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
 202     const struct bt_error *next_saved_error = nullptr;
 203
 204     struct ctf_fs_ds_group_medops_data *msg_iter_medops_data = nullptr;
 205 };
 206
 207 bt_component_class_initialize_method_status
 208 ctf_fs_init(bt_self_component_source *source, bt_self_component_source_configuration *config,
 209             const bt_value *params, void *init_method_data);
 210
 211 void ctf_fs_finalize(bt_self_component_source *component);
 212
 213 bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class,
 214                                                     bt_private_query_executor *priv_query_exec,
 215                                                     const char *object, const bt_value *params,
 216                                                     void *method_data, const bt_value **result);
 217
 218 bt_message_iterator_class_initialize_method_status
 219 ctf_fs_iterator_init(bt_self_message_iterator *self_msg_iter,
 220                      bt_self_message_iterator_configuration *config,
 221                      bt_self_component_port_output *self_port);
 222
 223 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
 224
 225 bt_message_iterator_class_next_method_status
 226 ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const msgs,
 227                      uint64_t capacity, uint64_t *count);
 228
 229 bt_message_iterator_class_seek_beginning_method_status
 230 ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator);
 231
 232 /* Create and initialize a new, empty ctf_fs_component. */
 233
 234 ctf_fs_component *ctf_fs_component_create(const bt2c::Logger& parentLogger);
 235
 236 /*
 237  * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
 238  * the same UUID.
 239  *
 240  * `paths_value` must be an array of strings,
 241  *
 242  * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
 243  *
 244  * `self_comp` and `self_comp_class` are used for logging, only one of them
 245  * should be set.
 246  */
 247
 248 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs,
 249                                          const bt_value *paths_value,
 250                                          const bt_value *trace_name_value,
 251                                          bt_self_component *selfComp);
 252
 253 /* Free `ctf_fs` and everything it owns. */
 254
 255 void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
 256
 257 /*
 258  * Read and validate parameters taken by the src.ctf.fs plugin.
 259  *
 260  *  - The mandatory `paths` parameter is returned in `*paths`.
 261  *  - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
 262  *    present, are recorded in the `ctf_fs` structure.
 263  *  - The optional `trace-name` parameter is returned in `*trace_name` if
 264  *    present, else `*trace_name` is set to NULL.
 265  *
 266  * `self_comp` and `self_comp_class` are used for logging, only one of them
 267  * should be set.
 268  *
 269  * Return true on success, false if any parameter didn't pass validation.
 270  */
 271
 272 bool read_src_fs_parameters(const bt_value *params, const bt_value **paths,
 273                             const bt_value **trace_name, struct ctf_fs_component *ctf_fs);
 274
 275 /*
 276  * Generate the port name to be used for a given data stream file group.
 277  *
 278  * The result must be freed using g_free by the caller.
 279  */
 280
 281 gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
 282
 283 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */