src.ctf.lttng-live: make queries report errors with exceptions

[deliverable/babeltrace.git] / src / plugins / ctf / lttng-live / viewer-connection.hpp

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 */

#ifndef LTTNG_LIVE_VIEWER_CONNECTION_H
#define LTTNG_LIVE_VIEWER_CONNECTION_H

#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <string>

#include <glib.h>

#include <babeltrace2/babeltrace.h>

#include "common/macros.h"
#include "compat/socket.h"
#include "cpp-common/bt2/value.hpp"
#include "cpp-common/glib-up.hpp"
#include "cpp-common/optional.hpp"
#include "cpp-common/log-cfg.hpp"

#define LTTNG_DEFAULT_NETWORK_VIEWER_PORT 5344

#define LTTNG_LIVE_MAJOR 2
#define LTTNG_LIVE_MINOR 4

enum lttng_live_viewer_status
{
    LTTNG_LIVE_VIEWER_STATUS_OK = 0,
    LTTNG_LIVE_VIEWER_STATUS_ERROR = -1,
    LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED = -2,
};

enum lttng_live_get_one_metadata_status
{
    /* The end of the metadata stream was reached. */
    LTTNG_LIVE_GET_ONE_METADATA_STATUS_END = 1,
    /* One metadata packet was received and written to file. */
    LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK = LTTNG_LIVE_VIEWER_STATUS_OK,
    /*
     * A critical error occurred when contacting the relay or while
     * handling its response.
     */
    LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR = LTTNG_LIVE_VIEWER_STATUS_ERROR,

    LTTNG_LIVE_GET_ONE_METADATA_STATUS_INTERRUPTED = LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED,

    /* The metadata stream was not found on the relay. */
    LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED = -3,
};

struct lttng_live_component;

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

    explicit live_viewer_connection(const bt2_common::LogCfg& logCfgParam) noexcept :
        logCfg {logCfgParam}
    {
    }

    ~live_viewer_connection();

    const bt2_common::LogCfg logCfg;

    std::string url;

    bt2_common::GStringUP relay_hostname;
    bt2_common::GStringUP target_hostname;
    bt2_common::GStringUP session_name;
    bt2_common::GStringUP proto;

    BT_SOCKET control_sock {};
    int port = 0;

    int32_t major = 0;
    int32_t minor = 0;

    bool in_query = false;
    struct lttng_live_msg_iter *lttng_live_msg_iter = nullptr;
};

struct packet_index_time
{
    uint64_t timestamp_begin;
    uint64_t timestamp_end;
};

struct packet_index
{
    off_t offset;          /* offset of the packet in the file, in bytes */
    int64_t data_offset;   /* offset of data within the packet, in bits */
    uint64_t packet_size;  /* packet size, in bits */
    uint64_t content_size; /* content size, in bits */
    uint64_t events_discarded;
    uint64_t events_discarded_len;      /* length of the field, in bits */
    struct packet_index_time ts_cycles; /* timestamp in cycles */
    struct packet_index_time ts_real;   /* realtime timestamp */
    /* CTF_INDEX 1.0 limit */
    uint64_t stream_instance_id; /* ID of the channel instance */
    uint64_t packet_seq_num;     /* packet sequence number */
};

enum lttng_live_viewer_status
live_viewer_connection_create(const char *url, bool in_query,
                              struct lttng_live_msg_iter *lttng_live_msg_iter,
                              const bt2_common::LogCfg& logCfg, live_viewer_connection::UP& viewer);

enum lttng_live_viewer_status
lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter);

bt2::Value::Shared
live_viewer_connection_list_sessions(struct live_viewer_connection *viewer_connection);

#endif /* LTTNG_LIVE_VIEWER_CONNECTION_H */