[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 <glib.h>
#include <stdint.h>

#include <babeltrace2/babeltrace.h>

#include "compat/socket.h"

#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
{
    bt_logging_level log_level = (bt_logging_level) 0;
    bt_self_component *self_comp = nullptr;
    bt_self_component_class *self_comp_class = nullptr;

    GString *url = nullptr;

    GString *relay_hostname = nullptr;
    GString *target_hostname = nullptr;
    GString *session_name = nullptr;
    GString *proto = nullptr;

    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(bt_self_component *self_comp,
                              bt_self_component_class *self_comp_class, bt_logging_level log_level,
                              const char *url, bool in_query,
                              struct lttng_live_msg_iter *lttng_live_msg_iter,
                              struct live_viewer_connection **viewer_connection);

void live_viewer_connection_destroy(struct live_viewer_connection *conn);

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 <glib.h>
	11	#include <stdint.h>
	12
	13	#include <babeltrace2/babeltrace.h>
	14
	15	#include "compat/socket.h"
	16
	17	#define LTTNG_DEFAULT_NETWORK_VIEWER_PORT 5344
	18
	19	#define LTTNG_LIVE_MAJOR 2
	20	#define LTTNG_LIVE_MINOR 4
	21
	22	enum lttng_live_viewer_status
	23	{
	24	LTTNG_LIVE_VIEWER_STATUS_OK = 0,
	25	LTTNG_LIVE_VIEWER_STATUS_ERROR = -1,
	26	LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED = -2,
	27	};
	28
	29	enum lttng_live_get_one_metadata_status
	30	{
	31	/* The end of the metadata stream was reached. */
	32	LTTNG_LIVE_GET_ONE_METADATA_STATUS_END = 1,
	33	/* One metadata packet was received and written to file. */
	34	LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK = LTTNG_LIVE_VIEWER_STATUS_OK,
	35	/*
	36	* A critical error occurred when contacting the relay or while
	37	* handling its response.
	38	*/
	39	LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR = LTTNG_LIVE_VIEWER_STATUS_ERROR,
	40
	41	LTTNG_LIVE_GET_ONE_METADATA_STATUS_INTERRUPTED = LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED,
	42
	43	/* The metadata stream was not found on the relay. */
	44	LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED = -3,
	45	};
	46
	47	struct live_viewer_connection
	48	{
	49	bt_logging_level log_level = (bt_logging_level) 0;
	50	bt_self_component *self_comp = nullptr;
	51	bt_self_component_class *self_comp_class = nullptr;
	52
	53	GString *url = nullptr;
	54
	55	GString *relay_hostname = nullptr;
	56	GString *target_hostname = nullptr;
	57	GString *session_name = nullptr;
	58	GString *proto = nullptr;
	59
	60	BT_SOCKET control_sock {};
	61	int port = 0;
	62
	63	int32_t major = 0;
	64	int32_t minor = 0;
	65
	66	bool in_query = false;
	67	struct lttng_live_msg_iter *lttng_live_msg_iter = nullptr;
	68	};
	69
	70	struct packet_index_time
	71	{
	72	uint64_t timestamp_begin;
	73	uint64_t timestamp_end;
	74	};
	75
	76	struct packet_index
	77	{
	78	off_t offset; /* offset of the packet in the file, in bytes */
	79	int64_t data_offset; /* offset of data within the packet, in bits */
	80	uint64_t packet_size; /* packet size, in bits */
	81	uint64_t content_size; /* content size, in bits */
	82	uint64_t events_discarded;
	83	uint64_t events_discarded_len; /* length of the field, in bits */
	84	struct packet_index_time ts_cycles; /* timestamp in cycles */
	85	struct packet_index_time ts_real; /* realtime timestamp */
	86	/* CTF_INDEX 1.0 limit */
	87	uint64_t stream_instance_id; /* ID of the channel instance */
	88	uint64_t packet_seq_num; /* packet sequence number */
	89	};
	90
	91	enum lttng_live_viewer_status
	92	live_viewer_connection_create(bt_self_component *self_comp,
	93	bt_self_component_class *self_comp_class, bt_logging_level log_level,
	94	const char *url, bool in_query,
	95	struct lttng_live_msg_iter *lttng_live_msg_iter,
	96	struct live_viewer_connection **viewer_connection);
	97
	98	void live_viewer_connection_destroy(struct live_viewer_connection *conn);
	99
	100	enum lttng_live_viewer_status
	101	lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter);
	102
	103	bt_component_class_query_method_status
	104	live_viewer_connection_list_sessions(struct live_viewer_connection *viewer_connection,
	105	const bt_value **user_result);
	106
	107	#endif /* LTTNG_LIVE_VIEWER_CONNECTION_H */