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/glib-up.hpp"
  18 #include "cpp-common/bt2c/logging.hpp"
  19
  20 #include "data-stream-file.hpp"
  21 #include "plugins/ctf/common/src/metadata/tsdl/decoder.hpp"
  22
  23 extern bool ctf_fs_debug;
  24
  25 struct ctf_fs_metadata
  26 {
  27     /* Owned by this */
  28     ctf_metadata_decoder_up decoder;
  29
  30     /* Owned by this */
  31     bt_trace_class *trace_class = nullptr;
  32
  33     /* Weak (owned by `decoder` above) */
  34     struct ctf_trace_class *tc = nullptr;
  35
  36     int bo = 0;
  37 };
  38
  39 struct ctf_fs_trace_deleter
  40 {
  41     void operator()(ctf_fs_trace *) noexcept;
  42 };
  43
  44 struct ctf_fs_trace
  45 {
  46     using UP = std::unique_ptr<ctf_fs_trace, ctf_fs_trace_deleter>;
  47
  48     explicit ctf_fs_trace(const bt2c::Logger& parentLogger) :
  49         logger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"}
  50     {
  51     }
  52
  53     bt2c::Logger logger;
  54
  55     /* Owned by this */
  56     struct ctf_fs_metadata *metadata = nullptr;
  57
  58     bt2::Trace::Shared trace;
  59
  60     std::vector<ctf_fs_ds_file_group::UP> ds_file_groups;
  61
  62     std::string path;
  63
  64     /* Next automatic stream ID when not provided by packet header */
  65     uint64_t next_stream_id = 0;
  66 };
  67
  68 struct ctf_fs_port_data
  69 {
  70     using UP = std::unique_ptr<ctf_fs_port_data>;
  71
  72     /* Weak, belongs to ctf_fs_trace */
  73     struct ctf_fs_ds_file_group *ds_file_group = nullptr;
  74
  75     /* Weak */
  76     struct ctf_fs_component *ctf_fs = nullptr;
  77 };
  78
  79 struct ctf_fs_component
  80 {
  81     using UP = std::unique_ptr<ctf_fs_component>;
  82
  83     explicit ctf_fs_component(const bt2c::Logger& parentLogger) noexcept :
  84         logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"}
  85     {
  86     }
  87
  88     bt2c::Logger logger;
  89
  90     std::vector<ctf_fs_port_data::UP> port_data;
  91
  92     ctf_fs_trace::UP trace;
  93
  94     ctf::src::ClkClsCfg clkClsCfg;
  95 };
  96
  97 struct ctf_fs_msg_iter_data
  98 {
  99     using UP = std::unique_ptr<ctf_fs_msg_iter_data>;
 100
 101     explicit ctf_fs_msg_iter_data(bt_self_message_iterator *selfMsgIter) :
 102         self_msg_iter {selfMsgIter}, logger {bt2::SelfMessageIterator {self_msg_iter},
 103                                              "PLUGIN/SRC.CTF.FS/MSG-ITER"}
 104     {
 105     }
 106
 107     /* Weak */
 108     bt_self_message_iterator *self_msg_iter = nullptr;
 109
 110     bt2c::Logger logger;
 111
 112     /* Weak, belongs to ctf_fs_trace */
 113     struct ctf_fs_ds_file_group *ds_file_group = nullptr;
 114
 115     ctf_msg_iter_up msg_iter;
 116
 117     /*
 118      * Saved error.  If we hit an error in the _next method, but have some
 119      * messages ready to return, we save the error here and return it on
 120      * the next _next call.
 121      */
 122     bt_message_iterator_class_next_method_status next_saved_status =
 123         BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
 124     const struct bt_error *next_saved_error = nullptr;
 125
 126     ctf_fs_ds_group_medops_data_up msg_iter_medops_data;
 127 };
 128
 129 bt_component_class_initialize_method_status
 130 ctf_fs_init(bt_self_component_source *source, bt_self_component_source_configuration *config,
 131             const bt_value *params, void *init_method_data);
 132
 133 void ctf_fs_finalize(bt_self_component_source *component);
 134
 135 bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class,
 136                                                     bt_private_query_executor *priv_query_exec,
 137                                                     const char *object, const bt_value *params,
 138                                                     void *method_data, const bt_value **result);
 139
 140 bt_message_iterator_class_initialize_method_status
 141 ctf_fs_iterator_init(bt_self_message_iterator *self_msg_iter,
 142                      bt_self_message_iterator_configuration *config,
 143                      bt_self_component_port_output *self_port);
 144
 145 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
 146
 147 bt_message_iterator_class_next_method_status
 148 ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const msgs,
 149                      uint64_t capacity, uint64_t *count);
 150
 151 bt_message_iterator_class_seek_beginning_method_status
 152 ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator);
 153
 154 /* Create and initialize a new, empty ctf_fs_component. */
 155
 156 ctf_fs_component::UP ctf_fs_component_create(const bt2c::Logger& parentLogger);
 157
 158 /*
 159  * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
 160  * the same UUID.
 161  *
 162  * `paths_value` must be an array of strings,
 163  *
 164  * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
 165  *
 166  * `self_comp` and `self_comp_class` are used for logging, only one of them
 167  * should be set.
 168  */
 169
 170 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs,
 171                                          const bt_value *paths_value,
 172                                          const bt_value *trace_name_value,
 173                                          bt_self_component *selfComp);
 174
 175 /*
 176  * Read and validate parameters taken by the src.ctf.fs plugin.
 177  *
 178  *  - The mandatory `paths` parameter is returned in `*paths`.
 179  *  - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
 180  *    present, are recorded in the `ctf_fs` structure.
 181  *  - The optional `trace-name` parameter is returned in `*trace_name` if
 182  *    present, else `*trace_name` is set to NULL.
 183  *
 184  * `self_comp` and `self_comp_class` are used for logging, only one of them
 185  * should be set.
 186  *
 187  * Return true on success, false if any parameter didn't pass validation.
 188  */
 189
 190 bool read_src_fs_parameters(const bt_value *params, const bt_value **paths,
 191                             const bt_value **trace_name, struct ctf_fs_component *ctf_fs);
 192
 193 /*
 194  * Generate the port name to be used for a given data stream file group.
 195  */
 196
 197 bt2c::GCharUP ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
 198
 199 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */