Adapt `sink.ctf.fs` to current API

[babeltrace.git] / plugins / ctf / fs-sink / fs-sink-trace.h

diff --git a/plugins/ctf/fs-sink/fs-sink-trace.h b/plugins/ctf/fs-sink/fs-sink-trace.h
new file mode 100644 (file)
index 0000000..b95e6b1
--- /dev/null
+++ b/plugins/ctf/fs-sink/fs-sink-trace.h
@@ -0,0 +1,79 @@
+#ifndef BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_TRACE_H
+#define BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_TRACE_H
+
+/*
+ * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include <babeltrace/babeltrace-internal.h>
+#include <babeltrace/babeltrace.h>
+#include <babeltrace/ctfser-internal.h>
+#include <glib.h>
+#include <stdbool.h>
+#include <stdint.h>
+
+#include "fs-sink-ctf-meta.h"
+
+struct fs_sink_comp;
+
+struct fs_sink_trace {
+       struct fs_sink_comp *fs_sink;
+
+       /* Owned by this */
+       struct fs_sink_ctf_trace_class *tc;
+
+       /*
+        * Weak reference: this object does not own it, and `tc` above
+        * does not own its trace IR trace class either. Instead, we add
+        * a "trace destruction" listener (in create_trace()) so that
+        * this object gets destroyed when the trace object is
+        * destroyed.
+        *
+        * Otherwise (with a strong reference), we would keep this trace
+        * object alive until the upstream message iterator ends. This
+        * could "leak" resources (memory, file descriptors) associated
+        * to traces and streams which otherwise would not exist.
+        */
+       const bt_trace *ir_trace;
+
+       uint64_t ir_trace_destruction_listener_id;
+
+       /* Trace's directory */
+       GString *path;
+
+       /* `metadata` file path */
+       GString *metadata_path;
+
+       /*
+        * Hash table of `const bt_stream *` (weak) to
+        * `struct fs_sink_stream *` (owned by hash table).
+        */
+       GHashTable *streams;
+};
+
+BT_HIDDEN
+struct fs_sink_trace *fs_sink_trace_create(struct fs_sink_comp *fs_sink,
+               const bt_trace *ir_trace);
+
+BT_HIDDEN
+void fs_sink_trace_destroy(struct fs_sink_trace *trace);
+
+#endif /* BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_TRACE_H */