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