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 <babeltrace2/babeltrace-internal.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         /* Owned by this */
  43         GString *path;
  44
  45         /* Owned by this */
  46         FILE *fp;
  47
  48         off_t size;
  49 };
  50
  51 struct ctf_fs_metadata {
  52         /* Owned by this */
  53         struct ctf_metadata_decoder *decoder;
  54
  55         /* Owned by this */
  56         bt_trace_class *trace_class;
  57
  58         /* Weak (owned by `decoder` above) */
  59         struct ctf_trace_class *tc;
  60
  61         /* Owned by this */
  62
  63         /* Owned by this */
  64         char *text;
  65
  66         int bo;
  67 };
  68
  69 struct ctf_fs_component {
  70         /* Weak, guaranteed to exist */
  71         bt_self_component_source *self_comp;
  72
  73         /* Array of struct ctf_fs_port_data *, owned by this */
  74         GPtrArray *port_data;
  75
  76         /* Array of struct ctf_fs_trace *, owned by this */
  77         GPtrArray *traces;
  78
  79         struct ctf_fs_metadata_config metadata_config;
  80 };
  81
  82 struct ctf_fs_trace {
  83         /* Owned by this */
  84         struct ctf_fs_metadata *metadata;
  85
  86         /* Owned by this */
  87         bt_trace *trace;
  88
  89         /* Array of struct ctf_fs_ds_file_group *, owned by this */
  90         GPtrArray *ds_file_groups;
  91
  92         /* Owned by this */
  93         GString *path;
  94
  95         /* Owned by this */
  96         GString *name;
  97
  98         /* Next automatic stream ID when not provided by packet header */
  99         uint64_t next_stream_id;
 100 };
 101
 102 struct ctf_fs_ds_index_entry {
 103         /* Position, in bytes, of the packet from the beginning of the file. */
 104         uint64_t offset;
 105
 106         /* Size of the packet, in bytes. */
 107         uint64_t packet_size;
 108
 109         /*
 110          * Extracted from the packet context, relative to the respective fields'
 111          * mapped clock classes (in cycles).
 112          */
 113         uint64_t timestamp_begin, timestamp_end;
 114
 115         /*
 116          * Converted from the packet context, relative to the trace's EPOCH
 117          * (in ns since EPOCH).
 118          */
 119         int64_t timestamp_begin_ns, timestamp_end_ns;
 120 };
 121
 122 struct ctf_fs_ds_index {
 123         /* Array of pointer to struct ctf_fs_fd_index_entry. */
 124         GPtrArray *entries;
 125 };
 126
 127 struct ctf_fs_ds_file_group {
 128         /*
 129          * Array of struct ctf_fs_ds_file_info, owned by this.
 130          *
 131          * This is an _ordered_ array of data stream file infos which
 132          * belong to this group (a single stream instance).
 133          *
 134          * You can call ctf_fs_ds_file_create() with one of those paths
 135          * and the trace IR stream below.
 136          */
 137         GPtrArray *ds_file_infos;
 138
 139         /* Owned by this */
 140         struct ctf_stream_class *sc;
 141
 142         /* Owned by this */
 143         bt_stream *stream;
 144
 145         /* Stream (instance) ID; -1ULL means none */
 146         uint64_t stream_id;
 147
 148         /* Weak, belongs to component */
 149         struct ctf_fs_trace *ctf_fs_trace;
 150
 151         /*
 152          * Owned by this. May be NULL.
 153          *
 154          * A stream cannot be assumed to be indexed as the indexing might have
 155          * been skipped. Moreover, the index's fields may not all be available
 156          * depending on the producer (e.g. timestamp_begin/end are not
 157          * mandatory).
 158          *
 159          * FIXME In such cases (missing fields), the indexing is aborted as
 160          * no the index entries don't have a concept of fields being present
 161          * or not.
 162          */
 163         struct ctf_fs_ds_index *index;
 164 };
 165
 166 struct ctf_fs_port_data {
 167         /* Weak, belongs to ctf_fs_trace */
 168         struct ctf_fs_ds_file_group *ds_file_group;
 169
 170         /* Weak */
 171         struct ctf_fs_component *ctf_fs;
 172 };
 173
 174 struct ctf_fs_msg_iter_data {
 175         /* Weak */
 176         bt_self_message_iterator *pc_msg_iter;
 177
 178         /* Weak, belongs to ctf_fs_trace */
 179         struct ctf_fs_ds_file_group *ds_file_group;
 180
 181         /* Owned by this */
 182         struct ctf_fs_ds_file *ds_file;
 183
 184         /* Which file the iterator is _currently_ operating on */
 185         size_t ds_file_info_index;
 186
 187         /* Owned by this */
 188         struct bt_msg_iter *msg_iter;
 189 };
 190
 191 BT_HIDDEN
 192 bt_self_component_status ctf_fs_init(
 193                 bt_self_component_source *source,
 194                 const bt_value *params, void *init_method_data);
 195
 196 BT_HIDDEN
 197 void ctf_fs_finalize(bt_self_component_source *component);
 198
 199 BT_HIDDEN
 200 bt_query_status ctf_fs_query(
 201                 bt_self_component_class_source *comp_class,
 202                 const bt_query_executor *query_exec,
 203                 const char *object, const bt_value *params,
 204                 const bt_value **result);
 205
 206 BT_HIDDEN
 207 bt_self_message_iterator_status ctf_fs_iterator_init(
 208                 bt_self_message_iterator *self_msg_iter,
 209                 bt_self_component_source *self_comp,
 210                 bt_self_component_port_output *self_port);
 211
 212 BT_HIDDEN
 213 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
 214
 215 BT_HIDDEN
 216 bt_self_message_iterator_status ctf_fs_iterator_next(
 217                 bt_self_message_iterator *iterator,
 218                 bt_message_array_const msgs, uint64_t capacity,
 219                 uint64_t *count);
 220
 221 BT_HIDDEN
 222 bt_self_message_iterator_status ctf_fs_iterator_seek_beginning(
 223                 bt_self_message_iterator *message_iterator);
 224
 225 /* Create and initialize a new, empty ctf_fs_component. */
 226
 227 BT_HIDDEN
 228 struct ctf_fs_component *ctf_fs_component_create(void);
 229
 230 /*
 231  * Search recursively under all paths in `paths_value` (an array of strings),
 232  * for CTF traces. For each CTF trace found, create a ctf_fs_trace in
 233  * `ctf_fs` representing that trace.
 234  */
 235
 236 BT_HIDDEN
 237 int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp,
 238                 struct ctf_fs_component *ctf_fs,
 239                 const bt_value *paths_value);
 240
 241 /* Free `ctf_fs` and everything it owns. */
 242
 243 BT_HIDDEN
 244 void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
 245
 246 /*
 247  * Read and validate parameters taken by the src.ctf.fs plugin.
 248  *
 249  *  - The mandatory `paths` parameter is returned in `*paths`.
 250  *  - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
 251  *    present, are recorded in the `ctf_fs` structure.
 252  *
 253  * Return true on success, false if any parameter didn't pass validation.
 254  */
 255
 256 BT_HIDDEN
 257 bool read_src_fs_parameters(const bt_value *params,
 258                 const bt_value **paths, struct ctf_fs_component *ctf_fs);
 259
 260 /*
 261  * Generate the port name to be used for a given data stream file group.
 262  *
 263  * The result must be freed using g_free by the caller.
 264  */
 265
 266 BT_HIDDEN
 267 gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
 268
 269 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */