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 "common/macros.h"
  11 #include <babeltrace2/babeltrace.h>
  12 #include <stdbool.h>
  13 #include <glib.h>
  14
  15 struct fs_sink_comp
  16 {
  17     bt_logging_level log_level;
  18     bt_self_component *self_comp;
  19
  20     /* Owned by this */
  21     bt_message_iterator *upstream_iter;
  22
  23     /* Base output directory path */
  24     GString *output_dir_path;
  25
  26     /*
  27      * True if the component assumes that it will only write a
  28      * single CTF trace (which can contain one or more data
  29      * streams). This makes the component write the stream files
  30      * directly in the output directory (`output_dir_path` above).
  31      */
  32     bool assume_single_trace;
  33
  34     /* True to completely ignore discarded events messages */
  35     bool ignore_discarded_events;
  36
  37     /* True to completely ignore discarded packets messages */
  38     bool ignore_discarded_packets;
  39
  40     /*
  41      * True to make the component quiet (nothing printed to the
  42      * standard output).
  43      */
  44     bool quiet;
  45
  46     /*
  47      * Hash table of `const bt_trace *` (weak) to
  48      * `struct fs_sink_trace *` (owned by hash table).
  49      */
  50     GHashTable *traces;
  51 };
  52
  53 BT_HIDDEN
  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_HIDDEN
  59 bt_component_class_sink_consume_method_status
  60 ctf_fs_sink_consume(bt_self_component_sink *component);
  61
  62 BT_HIDDEN
  63 bt_component_class_sink_graph_is_configured_method_status
  64 ctf_fs_sink_graph_is_configured(bt_self_component_sink *component);
  65
  66 BT_HIDDEN
  67 void ctf_fs_sink_finalize(bt_self_component_sink *component);
  68
  69 #endif /* BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_H */