src.ctf.fs: rename ctf_fs_ds_file_destroy to ~ctf_fs_ds_file

[babeltrace.git] / src / plugins / ctf / fs-src / data-stream-file.hpp

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2016 Philippe Proulx <pproulx@efficios.com>
 */

#ifndef CTF_FS_DS_FILE_H
#define CTF_FS_DS_FILE_H

#include <memory>
#include <string>
#include <vector>

#include <glib.h>
#include <stdio.h>

#include <babeltrace2/babeltrace.h>

#include "cpp-common/bt2/trace-ir.hpp"
#include "cpp-common/bt2c/data-len.hpp"
#include "cpp-common/bt2c/logging.hpp"

#include "../common/src/msg-iter/msg-iter.hpp"
#include "file.hpp"

struct ctf_fs_ds_file_info
{
    using UP = std::unique_ptr<ctf_fs_ds_file_info>;

    std::string path;

    /* Guaranteed to be set, as opposed to the index. */
    int64_t begin_ns = 0;
};

struct ctf_fs_ds_file
{
    explicit ctf_fs_ds_file(const bt2c::Logger& parentLogger) :
        logger {parentLogger, "PLUGIN/SRC.CTF.FS/DS"}
    {
    }

    ctf_fs_ds_file(const ctf_fs_ds_file&) = delete;
    ctf_fs_ds_file& operator=(const ctf_fs_ds_file&) = delete;
    ~ctf_fs_ds_file();

    bt2c::Logger logger;

    /* Weak */
    struct ctf_fs_metadata *metadata = nullptr;

    ctf_fs_file::UP file;

    bt2::Stream::Shared stream;

    void *mmap_addr = nullptr;

    /*
     * Max length of chunk to mmap() when updating the current mapping.
     * This value must be page-aligned.
     */
    size_t mmap_max_len = 0;

    /* Length of the current mapping. Never exceeds the file's length. */
    size_t mmap_len = 0;

    /* Offset in the file where the current mapping starts. */
    off_t mmap_offset_in_file = 0;

    /*
     * Offset, in the current mapping, of the address to return on the next
     * request.
     */
    off_t request_offset_in_mapping = 0;
};

struct ctf_fs_ds_index_entry
{
    using UP = std::unique_ptr<ctf_fs_ds_index_entry>;

    explicit ctf_fs_ds_index_entry(const bt2c::DataLen offsetParam,
                                   const bt2c::DataLen packetSizeParam) noexcept :
        offset(offsetParam),
        packetSize(packetSizeParam)
    {
    }

    /* Weak, belongs to ctf_fs_ds_file_info. */
    const char *path = nullptr;

    /* Position of the packet from the beginning of the file. */
    bt2c::DataLen offset;

    /* Size of the packet. */
    bt2c::DataLen packetSize;

    /*
     * Extracted from the packet context, relative to the respective fields'
     * mapped clock classes (in cycles).
     */
    uint64_t timestamp_begin = 0, timestamp_end = 0;

    /*
     * Converted from the packet context, relative to the trace's EPOCH
     * (in ns since EPOCH).
     */
    int64_t timestamp_begin_ns = 0, timestamp_end_ns = 0;

    /*
     * Packet sequence number, or UINT64_MAX if not present in the index.
     */
    uint64_t packet_seq_num = 0;
};

struct ctf_fs_ds_index
{
    using UP = std::unique_ptr<ctf_fs_ds_index>;

    std::vector<ctf_fs_ds_index_entry::UP> entries;
};

struct ctf_fs_ds_file_group
{
    using UP = std::unique_ptr<ctf_fs_ds_file_group>;

    /*
     * This is an _ordered_ array of data stream file infos which
     * belong to this group (a single stream instance).
     *
     * You can call ctf_fs_ds_file_create() with one of those paths
     * and the trace IR stream below.
     */
    std::vector<ctf_fs_ds_file_info::UP> ds_file_infos;

    /* Owned by this */
    struct ctf_stream_class *sc = nullptr;

    bt2::Stream::Shared stream;

    /* Stream (instance) ID; -1ULL means none */
    uint64_t stream_id = 0;

    /* Weak, belongs to component */
    struct ctf_fs_trace *ctf_fs_trace = nullptr;

    ctf_fs_ds_index::UP index;
};

struct ctf_fs_ds_file *ctf_fs_ds_file_create(ctf_fs_trace *ctf_fs_trace, bt2::Stream::Shared stream,
                                             const char *path, const bt2c::Logger& logger);

ctf_fs_ds_index::UP ctf_fs_ds_file_build_index(struct ctf_fs_ds_file *ds_file,
                                               struct ctf_fs_ds_file_info *ds_file_info,
                                               struct ctf_msg_iter *msg_iter);

ctf_fs_ds_index::UP ctf_fs_ds_index_create();

ctf_fs_ds_file_info::UP ctf_fs_ds_file_info_create(const char *path, int64_t begin_ns);

ctf_fs_ds_file_group::UP ctf_fs_ds_file_group_create(struct ctf_fs_trace *ctf_fs_trace,
                                                     struct ctf_stream_class *sc,
                                                     uint64_t stream_instance_id,
                                                     ctf_fs_ds_index::UP index);

/*
 * Medium operations to iterate on a single ctf_fs_ds_file.
 *
 * The data pointer when using this must be a pointer to the ctf_fs_ds_file.
 */
extern struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops;

/*
 * Medium operations to iterate on the packet of a ctf_fs_ds_group.
 *
 * The iteration is done based on the index of the group.
 *
 * The data pointer when using these medops must be a pointer to a ctf_fs_ds
 * group_medops_data structure.
 */
extern struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops;

enum ctf_msg_iter_medium_status ctf_fs_ds_group_medops_data_create(
    struct ctf_fs_ds_file_group *ds_file_group, bt_self_message_iterator *self_msg_iter,
    const bt2c::Logger& logger, struct ctf_fs_ds_group_medops_data **out);

void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data *data);

void ctf_fs_ds_group_medops_data_destroy(struct ctf_fs_ds_group_medops_data *data);

#endif /* CTF_FS_DS_FILE_H */