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 "metadata.hpp"
  18
  19 extern bool ctf_fs_debug;
  20
  21 struct ctf_fs_file
  22 {
  23     bt_logging_level log_level = (bt_logging_level) 0;
  24
  25     /* Weak */
  26     bt_self_component *self_comp = nullptr;
  27
  28     /* Owned by this */
  29     GString *path = nullptr;
  30
  31     /* Owned by this */
  32     FILE *fp = nullptr;
  33
  34     off_t size = 0;
  35 };
  36
  37 struct ctf_fs_metadata
  38 {
  39     /* Owned by this */
  40     struct ctf_metadata_decoder *decoder = nullptr;
  41
  42     /* Owned by this */
  43     bt_trace_class *trace_class = nullptr;
  44
  45     /* Weak (owned by `decoder` above) */
  46     struct ctf_trace_class *tc = nullptr;
  47
  48     /* Owned by this */
  49     char *text = nullptr;
  50
  51     int bo = 0;
  52 };
  53
  54 struct ctf_fs_component
  55 {
  56     bt_logging_level log_level = (bt_logging_level) 0;
  57
  58     /* Array of struct ctf_fs_port_data *, owned by this */
  59     GPtrArray *port_data = nullptr;
  60
  61     /* Owned by this */
  62     struct ctf_fs_trace *trace = nullptr;
  63
  64     struct ctf_fs_metadata_config metadata_config;
  65 };
  66
  67 struct ctf_fs_trace
  68 {
  69     bt_logging_level log_level = (bt_logging_level) 0;
  70
  71     /*
  72      * Weak. These are mostly used to generate log messages or to append
  73      * error causes. They are mutually exclusive, only one of them must be
  74      * set.
  75      */
  76     bt_self_component *self_comp = nullptr;
  77     bt_self_component_class *self_comp_class = nullptr;
  78
  79     /* Owned by this */
  80     struct ctf_fs_metadata *metadata = nullptr;
  81
  82     /* Owned by this */
  83     bt_trace *trace = nullptr;
  84
  85     /* Array of struct ctf_fs_ds_file_group *, owned by this */
  86     GPtrArray *ds_file_groups = nullptr;
  87
  88     /* Owned by this */
  89     GString *path = nullptr;
  90
  91     /* Next automatic stream ID when not provided by packet header */
  92     uint64_t next_stream_id = 0;
  93 };
  94
  95 struct ctf_fs_ds_index_entry
  96 {
  97     /* Weak, belongs to ctf_fs_ds_file_info. */
  98     const char *path = nullptr;
  99
 100     /* Position, in bytes, of the packet from the beginning of the file. */
 101     uint64_t offset = 0;
 102
 103     /* Size of the packet, in bytes. */
 104     uint64_t packet_size = 0;
 105
 106     /*
 107      * Extracted from the packet context, relative to the respective fields'
 108      * mapped clock classes (in cycles).
 109      */
 110     uint64_t timestamp_begin = 0, timestamp_end = 0;
 111
 112     /*
 113      * Converted from the packet context, relative to the trace's EPOCH
 114      * (in ns since EPOCH).
 115      */
 116     int64_t timestamp_begin_ns = 0, timestamp_end_ns = 0;
 117
 118     /*
 119      * Packet sequence number, or UINT64_MAX if not present in the index.
 120      */
 121     uint64_t packet_seq_num = 0;
 122 };
 123
 124 struct ctf_fs_ds_index
 125 {
 126     /* Array of pointer to struct ctf_fs_ds_index_entry. */
 127     GPtrArray *entries = nullptr;
 128 };
 129
 130 struct ctf_fs_ds_file_group
 131 {
 132     /*
 133      * Array of struct ctf_fs_ds_file_info, owned by this.
 134      *
 135      * This is an _ordered_ array of data stream file infos which
 136      * belong to this group (a single stream instance).
 137      *
 138      * You can call ctf_fs_ds_file_create() with one of those paths
 139      * and the trace IR stream below.
 140      */
 141     GPtrArray *ds_file_infos = nullptr;
 142
 143     /* Owned by this */
 144     struct ctf_stream_class *sc = nullptr;
 145
 146     /* Owned by this */
 147     bt_stream *stream = nullptr;
 148
 149     /* Stream (instance) ID; -1ULL means none */
 150     uint64_t stream_id = 0;
 151
 152     /* Weak, belongs to component */
 153     struct ctf_fs_trace *ctf_fs_trace = nullptr;
 154
 155     /*
 156      * Owned by this.
 157      */
 158     struct ctf_fs_ds_index *index = nullptr;
 159 };
 160
 161 struct ctf_fs_port_data
 162 {
 163     /* Weak, belongs to ctf_fs_trace */
 164     struct ctf_fs_ds_file_group *ds_file_group = nullptr;
 165
 166     /* Weak */
 167     struct ctf_fs_component *ctf_fs = nullptr;
 168 };
 169
 170 struct ctf_fs_msg_iter_data
 171 {
 172     bt_logging_level log_level = (bt_logging_level) 0;
 173
 174     /* Weak */
 175     bt_self_component *self_comp = nullptr;
 176
 177     /* Weak */
 178     bt_self_message_iterator *self_msg_iter = nullptr;
 179
 180     /* Weak, belongs to ctf_fs_trace */
 181     struct ctf_fs_ds_file_group *ds_file_group = nullptr;
 182
 183     /* Owned by this */
 184     struct ctf_msg_iter *msg_iter = nullptr;
 185
 186     /*
 187      * Saved error.  If we hit an error in the _next method, but have some
 188      * messages ready to return, we save the error here and return it on
 189      * the next _next call.
 190      */
 191     bt_message_iterator_class_next_method_status next_saved_status =
 192         BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
 193     const struct bt_error *next_saved_error = nullptr;
 194
 195     struct ctf_fs_ds_group_medops_data *msg_iter_medops_data = nullptr;
 196 };
 197
 198 bt_component_class_initialize_method_status
 199 ctf_fs_init(bt_self_component_source *source, bt_self_component_source_configuration *config,
 200             const bt_value *params, void *init_method_data);
 201
 202 void ctf_fs_finalize(bt_self_component_source *component);
 203
 204 bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class,
 205                                                     bt_private_query_executor *priv_query_exec,
 206                                                     const char *object, const bt_value *params,
 207                                                     void *method_data, const bt_value **result);
 208
 209 bt_message_iterator_class_initialize_method_status
 210 ctf_fs_iterator_init(bt_self_message_iterator *self_msg_iter,
 211                      bt_self_message_iterator_configuration *config,
 212                      bt_self_component_port_output *self_port);
 213
 214 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
 215
 216 bt_message_iterator_class_next_method_status
 217 ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const msgs,
 218                      uint64_t capacity, uint64_t *count);
 219
 220 bt_message_iterator_class_seek_beginning_method_status
 221 ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator);
 222
 223 /* Create and initialize a new, empty ctf_fs_component. */
 224
 225 struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level);
 226
 227 /*
 228  * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
 229  * the same UUID.
 230  *
 231  * `paths_value` must be an array of strings,
 232  *
 233  * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
 234  *
 235  * `self_comp` and `self_comp_class` are used for logging, only one of them
 236  * should be set.
 237  */
 238
 239 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs,
 240                                          const bt_value *paths_value,
 241                                          const bt_value *trace_name_value,
 242                                          bt_self_component *self_comp,
 243                                          bt_self_component_class *self_comp_class);
 244
 245 /* Free `ctf_fs` and everything it owns. */
 246
 247 void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
 248
 249 /*
 250  * Read and validate parameters taken by the src.ctf.fs plugin.
 251  *
 252  *  - The mandatory `paths` parameter is returned in `*paths`.
 253  *  - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
 254  *    present, are recorded in the `ctf_fs` structure.
 255  *  - The optional `trace-name` parameter is returned in `*trace_name` if
 256  *    present, else `*trace_name` is set to NULL.
 257  *
 258  * `self_comp` and `self_comp_class` are used for logging, only one of them
 259  * should be set.
 260  *
 261  * Return true on success, false if any parameter didn't pass validation.
 262  */
 263
 264 bool read_src_fs_parameters(const bt_value *params, const bt_value **paths,
 265                             const bt_value **trace_name, struct ctf_fs_component *ctf_fs,
 266                             bt_self_component *self_comp, bt_self_component_class *self_comp_class);
 267
 268 /*
 269  * Generate the port name to be used for a given data stream file group.
 270  *
 271  * The result must be freed using g_free by the caller.
 272  */
 273
 274 gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
 275
 276 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */