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