cpp-common/bt2c/fmt.hpp: use `wise_enum::string_type` in `EnableIfIsWiseEnum` definition

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

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
 */

#ifndef BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_TRACE_H
#define BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_TRACE_H

#include <glib.h>

#include <babeltrace2/babeltrace.h>

#include "cpp-common/bt2c/logging.hpp"

struct fs_sink_comp;
struct fs_sink_ctf_trace;

struct fs_sink_trace
{
    explicit fs_sink_trace(const bt2c::Logger& parentLogger) :
        logger {parentLogger, "PLUGIN/SINK.CTF.FS/TRACE"}
    {
    }

    bt2c::Logger logger;
    fs_sink_comp *fs_sink = nullptr;

    /* Owned by this */
    fs_sink_ctf_trace *trace = nullptr;

    /*
     * Weak reference: this object does not own it, and `trace`
     * above does not own its trace IR trace and 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 = nullptr;

    bt_listener_id ir_trace_destruction_listener_id = 0;

    /* Trace's directory */
    GString *path = nullptr;

    /* `metadata` file path */
    GString *metadata_path = nullptr;

    /*
     * Hash table of `const bt_stream *` (weak) to
     * `struct fs_sink_stream *` (owned by hash table).
     */
    GHashTable *streams = nullptr;
};

struct fs_sink_trace *fs_sink_trace_create(struct fs_sink_comp *fs_sink, const bt_trace *ir_trace);

void fs_sink_trace_destroy(struct fs_sink_trace *trace);

#endif /* BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_TRACE_H */