plugins/ctf/fs-sink/fs-sink.h

   1 #ifndef BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_H
   2 #define BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_H
   3
   4 /*
   5  * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <babeltrace2/babeltrace-internal.h>
  27 #include <babeltrace2/babeltrace.h>
  28 #include <stdbool.h>
  29 #include <glib.h>
  30
  31 struct fs_sink_comp {
  32         bt_self_component_sink *self_comp;
  33
  34         /* Owned by this */
  35         bt_self_component_port_input_message_iterator *upstream_iter;
  36
  37         /* Base output directory path */
  38         GString *output_dir_path;
  39
  40         /*
  41          * True if the component assumes that it will only write a
  42          * single CTF trace (which can contain one or more data
  43          * streams). This makes the component write the stream files
  44          * directly in the output directory (`output_dir_path` above).
  45          */
  46         bool assume_single_trace;
  47
  48         /* True to completely ignore discarded events messages */
  49         bool ignore_discarded_events;
  50
  51         /* True to completely ignore discarded packets messages */
  52         bool ignore_discarded_packets;
  53
  54         /*
  55          * True to make the component quiet (nothing printed to the
  56          * standard output).
  57          */
  58         bool quiet;
  59
  60         /*
  61          * Hash table of `const bt_trace *` (weak) to
  62          * `struct fs_sink_trace *` (owned by hash table).
  63          */
  64         GHashTable *traces;
  65 };
  66
  67 BT_HIDDEN
  68 bt_self_component_status ctf_fs_sink_init(
  69                 bt_self_component_sink *component,
  70                 const bt_value *params,
  71                 void *init_method_data);
  72
  73 BT_HIDDEN
  74 bt_self_component_status ctf_fs_sink_consume(
  75                 bt_self_component_sink *component);
  76
  77 BT_HIDDEN
  78 bt_self_component_status ctf_fs_sink_graph_is_configured(
  79                 bt_self_component_sink *component);
  80
  81 BT_HIDDEN
  82 void ctf_fs_sink_finalize(bt_self_component_sink *component);
  83
  84 #endif /* BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_H */