src/plugins/ctf/fs-sink/fs-sink.hpp

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
   5  */
   6
   7 #ifndef BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_H
   8 #define BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_H
   9
  10 #include <glib.h>
  11
  12 #include <babeltrace2/babeltrace.h>
  13
  14 #include "common/macros.h"
  15
  16 struct fs_sink_comp
  17 {
  18     bt_logging_level log_level;
  19     bt_self_component *self_comp;
  20
  21     /* Owned by this */
  22     bt_message_iterator *upstream_iter;
  23
  24     /* Base output directory path */
  25     GString *output_dir_path;
  26
  27     /*
  28      * True if the component assumes that it will only write a
  29      * single CTF trace (which can contain one or more data
  30      * streams). This makes the component write the stream files
  31      * directly in the output directory (`output_dir_path` above).
  32      */
  33     bool assume_single_trace;
  34
  35     /* True to completely ignore discarded events messages */
  36     bool ignore_discarded_events;
  37
  38     /* True to completely ignore discarded packets messages */
  39     bool ignore_discarded_packets;
  40
  41     /*
  42      * True to make the component quiet (nothing printed to the
  43      * standard output).
  44      */
  45     bool quiet;
  46
  47     /*
  48      * Hash table of `const bt_trace *` (weak) to
  49      * `struct fs_sink_trace *` (owned by hash table).
  50      */
  51     GHashTable *traces;
  52 };
  53
  54 bt_component_class_initialize_method_status
  55 ctf_fs_sink_init(bt_self_component_sink *component, bt_self_component_sink_configuration *config,
  56                  const bt_value *params, void *init_method_data);
  57
  58 bt_component_class_sink_consume_method_status
  59 ctf_fs_sink_consume(bt_self_component_sink *component);
  60
  61 bt_component_class_sink_graph_is_configured_method_status
  62 ctf_fs_sink_graph_is_configured(bt_self_component_sink *component);
  63
  64 void ctf_fs_sink_finalize(bt_self_component_sink *component);
  65
  66 #endif /* BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_H */