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

#include <babeltrace2/babeltrace.h>

#include "common/macros.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 lttng_live_component;

struct live_viewer_connection
{
    bt_logging_level log_level;
    bt_self_component *self_comp;
    bt_self_component_class *self_comp_class;

    GString *url;

    GString *relay_hostname;
    GString *target_hostname;
    GString *session_name;
    GString *proto;

    BT_SOCKET control_sock;
    int port;

    int32_t major;
    int32_t minor;

    bool in_query;
    struct lttng_live_msg_iter *lttng_live_msg_iter;
};

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