src/plugins/ctf/fs-src/fs.h

   1 #ifndef BABELTRACE_PLUGIN_CTF_FS_H
   2 #define BABELTRACE_PLUGIN_CTF_FS_H
   3
   4 /*
   5  * BabelTrace - CTF on File System Component
   6  *
   7  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a copy
  13  * of this software and associated documentation files (the "Software"), to deal
  14  * in the Software without restriction, including without limitation the rights
  15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16  * copies of the Software, and to permit persons to whom the Software is
  17  * furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included in
  20  * all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  25  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28  * SOFTWARE.
  29  */
  30
  31 #include <stdbool.h>
  32 #include "common/macros.h"
  33 #include <babeltrace2/babeltrace.h>
  34 #include "data-stream-file.h"
  35 #include "metadata.h"
  36 #include "../common/metadata/decoder.h"
  37
  38 BT_HIDDEN
  39 extern bool ctf_fs_debug;
  40
  41 struct ctf_fs_file {
  42         bt_logging_level log_level;
  43
  44         /* Owned by this */
  45         GString *path;
  46
  47         /* Owned by this */
  48         FILE *fp;
  49
  50         off_t size;
  51 };
  52
  53 struct ctf_fs_metadata {
  54         /* Owned by this */
  55         struct ctf_metadata_decoder *decoder;
  56
  57         /* Owned by this */
  58         bt_trace_class *trace_class;
  59
  60         /* Weak (owned by `decoder` above) */
  61         struct ctf_trace_class *tc;
  62
  63         /* Owned by this */
  64
  65         /* Owned by this */
  66         char *text;
  67
  68         int bo;
  69 };
  70
  71 struct ctf_fs_component {
  72         bt_logging_level log_level;
  73
  74         /* Weak, guaranteed to exist */
  75         bt_self_component_source *self_comp;
  76
  77         /* Array of struct ctf_fs_port_data *, owned by this */
  78         GPtrArray *port_data;
  79
  80         /* Array of struct ctf_fs_trace *, owned by this */
  81         GPtrArray *traces;
  82
  83         struct ctf_fs_metadata_config metadata_config;
  84 };
  85
  86 struct ctf_fs_trace {
  87         bt_logging_level log_level;
  88
  89         /* Owned by this */
  90         struct ctf_fs_metadata *metadata;
  91
  92         /* Owned by this */
  93         bt_trace *trace;
  94
  95         /* Array of struct ctf_fs_ds_file_group *, owned by this */
  96         GPtrArray *ds_file_groups;
  97
  98         /* Owned by this */
  99         GString *path;
 100
 101         /* Owned by this */
 102         GString *name;
 103
 104         /* Next automatic stream ID when not provided by packet header */
 105         uint64_t next_stream_id;
 106 };
 107
 108 struct ctf_fs_ds_index_entry {
 109         /* Position, in bytes, of the packet from the beginning of the file. */
 110         uint64_t offset;
 111
 112         /* Size of the packet, in bytes. */
 113         uint64_t packet_size;
 114
 115         /*
 116          * Extracted from the packet context, relative to the respective fields'
 117          * mapped clock classes (in cycles).
 118          */
 119         uint64_t timestamp_begin, timestamp_end;
 120
 121         /*
 122          * Converted from the packet context, relative to the trace's EPOCH
 123          * (in ns since EPOCH).
 124          */
 125         int64_t timestamp_begin_ns, timestamp_end_ns;
 126 };
 127
 128 struct ctf_fs_ds_index {
 129         /* Array of pointer to struct ctf_fs_fd_index_entry. */
 130         GPtrArray *entries;
 131 };
 132
 133 struct ctf_fs_ds_file_group {
 134         /*
 135          * Array of struct ctf_fs_ds_file_info, owned by this.
 136          *
 137          * This is an _ordered_ array of data stream file infos which
 138          * belong to this group (a single stream instance).
 139          *
 140          * You can call ctf_fs_ds_file_create() with one of those paths
 141          * and the trace IR stream below.
 142          */
 143         GPtrArray *ds_file_infos;
 144
 145         /* Owned by this */
 146         struct ctf_stream_class *sc;
 147
 148         /* Owned by this */
 149         bt_stream *stream;
 150
 151         /* Stream (instance) ID; -1ULL means none */
 152         uint64_t stream_id;
 153
 154         /* Weak, belongs to component */
 155         struct ctf_fs_trace *ctf_fs_trace;
 156
 157         /*
 158          * Owned by this. May be NULL.
 159          *
 160          * A stream cannot be assumed to be indexed as the indexing might have
 161          * been skipped. Moreover, the index's fields may not all be available
 162          * depending on the producer (e.g. timestamp_begin/end are not
 163          * mandatory).
 164          */
 165         struct ctf_fs_ds_index *index;
 166 };
 167
 168 struct ctf_fs_port_data {
 169         /* Weak, belongs to ctf_fs_trace */
 170         struct ctf_fs_ds_file_group *ds_file_group;
 171
 172         /* Weak */
 173         struct ctf_fs_component *ctf_fs;
 174 };
 175
 176 struct ctf_fs_msg_iter_data {
 177         bt_logging_level log_level;
 178
 179         /* Weak */
 180         bt_self_message_iterator *pc_msg_iter;
 181
 182         /* Weak, belongs to ctf_fs_trace */
 183         struct ctf_fs_ds_file_group *ds_file_group;
 184
 185         /* Owned by this */
 186         struct ctf_fs_ds_file *ds_file;
 187
 188         /* Which file the iterator is _currently_ operating on */
 189         size_t ds_file_info_index;
 190
 191         /* Owned by this */
 192         struct bt_msg_iter *msg_iter;
 193 };
 194
 195 BT_HIDDEN
 196 bt_self_component_status ctf_fs_init(
 197                 bt_self_component_source *source,
 198                 const bt_value *params, void *init_method_data);
 199
 200 BT_HIDDEN
 201 void ctf_fs_finalize(bt_self_component_source *component);
 202
 203 BT_HIDDEN
 204 bt_query_status ctf_fs_query(
 205                 bt_self_component_class_source *comp_class,
 206                 const bt_query_executor *query_exec,
 207                 const char *object, const bt_value *params,
 208                 bt_logging_level log_level,
 209                 const bt_value **result);
 210
 211 BT_HIDDEN
 212 bt_self_message_iterator_status ctf_fs_iterator_init(
 213                 bt_self_message_iterator *self_msg_iter,
 214                 bt_self_component_source *self_comp,
 215                 bt_self_component_port_output *self_port);
 216
 217 BT_HIDDEN
 218 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
 219
 220 BT_HIDDEN
 221 bt_self_message_iterator_status ctf_fs_iterator_next(
 222                 bt_self_message_iterator *iterator,
 223                 bt_message_array_const msgs, uint64_t capacity,
 224                 uint64_t *count);
 225
 226 BT_HIDDEN
 227 bt_self_message_iterator_status ctf_fs_iterator_seek_beginning(
 228                 bt_self_message_iterator *message_iterator);
 229
 230 /* Create and initialize a new, empty ctf_fs_component. */
 231
 232 BT_HIDDEN
 233 struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level);
 234
 235 /*
 236  * Search recursively under all paths in `paths_value` (an array of strings),
 237  * for CTF traces. For each CTF trace found, create a ctf_fs_trace in
 238  * `ctf_fs` representing that trace.
 239  */
 240
 241 BT_HIDDEN
 242 int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp,
 243                 struct ctf_fs_component *ctf_fs,
 244                 const bt_value *paths_value);
 245
 246 /* Free `ctf_fs` and everything it owns. */
 247
 248 BT_HIDDEN
 249 void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
 250
 251 /*
 252  * Read and validate parameters taken by the src.ctf.fs plugin.
 253  *
 254  *  - The mandatory `paths` parameter is returned in `*paths`.
 255  *  - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
 256  *    present, are recorded in the `ctf_fs` structure.
 257  *
 258  * Return true on success, false if any parameter didn't pass validation.
 259  */
 260
 261 BT_HIDDEN
 262 bool read_src_fs_parameters(const bt_value *params,
 263                 const bt_value **paths, struct ctf_fs_component *ctf_fs);
 264
 265 /*
 266  * Generate the port name to be used for a given data stream file group.
 267  *
 268  * The result must be freed using g_free by the caller.
 269  */
 270
 271 BT_HIDDEN
 272 gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
 273
 274 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */