[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 <string>

#include <glib.h>
#include <stdint.h>

#include <babeltrace2/babeltrace.h>

#include "compat/socket.hpp"
#include "cpp-common/bt2c/glib-up.hpp"
#include "cpp-common/bt2c/logging.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 live_viewer_connection
{
    explicit live_viewer_connection(const bt2c::Logger& parentLogger) :
        logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/VIEWER"}
    {
    }

    ~live_viewer_connection();

    bt2c::Logger logger;

    std::string url;

    bt2c::GStringUP relay_hostname;
    bt2c::GStringUP target_hostname;
    bt2c::GStringUP session_name;
    bt2c::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 bt2c::Logger& parentLogger, struct live_viewer_connection **viewer);

enum lttng_live_viewer_status
lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter);

bt_component_class_query_method_status
live_viewer_connection_list_sessions(struct live_viewer_connection *viewer_connection,
                                     const bt_value **user_result);

#endif /* LTTNG_LIVE_VIEWER_CONNECTION_H */
Commit	Line	Data
	1	/*
	2	* SPDX-License-Identifier: MIT
	3	*
	4	* Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	5	*/
	6
	7	#ifndef LTTNG_LIVE_VIEWER_CONNECTION_H
	8	#define LTTNG_LIVE_VIEWER_CONNECTION_H
	9
	10	#include <string>
	11
	12	#include <glib.h>
	13	#include <stdint.h>
	14
	15	#include <babeltrace2/babeltrace.h>
	16
	17	#include "compat/socket.hpp"
	18	#include "cpp-common/bt2c/glib-up.hpp"
	19	#include "cpp-common/bt2c/logging.hpp"
	20
	21	#define LTTNG_DEFAULT_NETWORK_VIEWER_PORT 5344
	22
	23	#define LTTNG_LIVE_MAJOR 2
	24	#define LTTNG_LIVE_MINOR 4
	25
	26	enum lttng_live_viewer_status
	27	{
	28	LTTNG_LIVE_VIEWER_STATUS_OK = 0,
	29	LTTNG_LIVE_VIEWER_STATUS_ERROR = -1,
	30	LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED = -2,
	31	};
	32
	33	enum lttng_live_get_one_metadata_status
	34	{
	35	/* The end of the metadata stream was reached. */
	36	LTTNG_LIVE_GET_ONE_METADATA_STATUS_END = 1,
	37	/* One metadata packet was received and written to file. */
	38	LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK = LTTNG_LIVE_VIEWER_STATUS_OK,
	39	/*
	40	* A critical error occurred when contacting the relay or while
	41	* handling its response.
	42	*/
	43	LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR = LTTNG_LIVE_VIEWER_STATUS_ERROR,
	44
	45	LTTNG_LIVE_GET_ONE_METADATA_STATUS_INTERRUPTED = LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED,
	46
	47	/* The metadata stream was not found on the relay. */
	48	LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED = -3,
	49	};
	50
	51	struct live_viewer_connection
	52	{
	53	explicit live_viewer_connection(const bt2c::Logger& parentLogger) :
	54	logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/VIEWER"}
	55	{
	56	}
	57
	58	~live_viewer_connection();
	59
	60	bt2c::Logger logger;
	61
	62	std::string url;
	63
	64	bt2c::GStringUP relay_hostname;
	65	bt2c::GStringUP target_hostname;
	66	bt2c::GStringUP session_name;
	67	bt2c::GStringUP proto;
	68
	69	BT_SOCKET control_sock {};
	70	int port = 0;
	71
	72	int32_t major = 0;
	73	int32_t minor = 0;
	74
	75	bool in_query = false;
	76	struct lttng_live_msg_iter *lttng_live_msg_iter = nullptr;
	77	};
	78
	79	struct packet_index_time
	80	{
	81	uint64_t timestamp_begin;
	82	uint64_t timestamp_end;
	83	};
	84
	85	struct packet_index
	86	{
	87	off_t offset; /* offset of the packet in the file, in bytes */
	88	int64_t data_offset; /* offset of data within the packet, in bits */
	89	uint64_t packet_size; /* packet size, in bits */
	90	uint64_t content_size; /* content size, in bits */
	91	uint64_t events_discarded;
	92	uint64_t events_discarded_len; /* length of the field, in bits */
	93	struct packet_index_time ts_cycles; /* timestamp in cycles */
	94	struct packet_index_time ts_real; /* realtime timestamp */
	95	/* CTF_INDEX 1.0 limit */
	96	uint64_t stream_instance_id; /* ID of the channel instance */
	97	uint64_t packet_seq_num; /* packet sequence number */
	98	};
	99
	100	enum lttng_live_viewer_status live_viewer_connection_create(
	101	const char url, bool in_query, struct lttng_live_msg_iter lttng_live_msg_iter,
	102	const bt2c::Logger& parentLogger, struct live_viewer_connection **viewer);
	103
	104	enum lttng_live_viewer_status
	105	lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter);
	106
	107	bt_component_class_query_method_status
	108	live_viewer_connection_list_sessions(struct live_viewer_connection *viewer_connection,
	109	const bt_value **user_result);
	110
	111	#endif /* LTTNG_LIVE_VIEWER_CONNECTION_H */