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