2 * SPDX-License-Identifier: MIT
4 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 #ifndef LTTNG_LIVE_VIEWER_CONNECTION_H
8 #define LTTNG_LIVE_VIEWER_CONNECTION_H
16 #include <babeltrace2/babeltrace.h>
18 #include "common/macros.h"
19 #include "compat/socket.h"
21 #define LTTNG_DEFAULT_NETWORK_VIEWER_PORT 5344
23 #define LTTNG_LIVE_MAJOR 2
24 #define LTTNG_LIVE_MINOR 4
26 enum lttng_live_viewer_status
{
27 LTTNG_LIVE_VIEWER_STATUS_OK
= 0,
28 LTTNG_LIVE_VIEWER_STATUS_ERROR
= -1,
29 LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
= -2,
32 enum lttng_live_get_one_metadata_status
{
33 /* The end of the metadata stream was reached. */
34 LTTNG_LIVE_GET_ONE_METADATA_STATUS_END
= 1,
35 /* One metadata packet was received and written to file. */
36 LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK
= LTTNG_LIVE_VIEWER_STATUS_OK
,
38 * A critical error occurred when contacting the relay or while
39 * handling its response.
41 LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR
= LTTNG_LIVE_VIEWER_STATUS_ERROR
,
43 LTTNG_LIVE_GET_ONE_METADATA_STATUS_INTERRUPTED
= LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
,
45 /* The metadata stream was not found on the relay. */
46 LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED
= -3,
49 struct lttng_live_component
;
51 struct live_viewer_connection
{
52 bt_logging_level log_level
;
53 bt_self_component
*self_comp
;
54 bt_self_component_class
*self_comp_class
;
58 GString
*relay_hostname
;
59 GString
*target_hostname
;
60 GString
*session_name
;
63 BT_SOCKET control_sock
;
70 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
73 struct packet_index_time
{
74 uint64_t timestamp_begin
;
75 uint64_t timestamp_end
;
79 off_t offset
; /* offset of the packet in the file, in bytes */
80 int64_t data_offset
; /* offset of data within the packet, in bits */
81 uint64_t packet_size
; /* packet size, in bits */
82 uint64_t content_size
; /* content size, in bits */
83 uint64_t events_discarded
;
84 uint64_t events_discarded_len
; /* length of the field, in bits */
85 struct packet_index_time ts_cycles
; /* timestamp in cycles */
86 struct packet_index_time ts_real
; /* realtime timestamp */
87 /* CTF_INDEX 1.0 limit */
88 uint64_t stream_instance_id
; /* ID of the channel instance */
89 uint64_t packet_seq_num
; /* packet sequence number */
92 enum lttng_live_viewer_status
live_viewer_connection_create(
93 bt_self_component
*self_comp
,
94 bt_self_component_class
*self_comp_class
,
95 bt_logging_level log_level
,
96 const char *url
, bool in_query
,
97 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
98 struct live_viewer_connection
**viewer_connection
);
100 void live_viewer_connection_destroy(
101 struct live_viewer_connection
*conn
);
103 enum lttng_live_viewer_status
lttng_live_create_viewer_session(
104 struct lttng_live_msg_iter
*lttng_live_msg_iter
);
106 bt_component_class_query_method_status
live_viewer_connection_list_sessions(
107 struct live_viewer_connection
*viewer_connection
,
108 const bt_value
**user_result
);
110 #endif /* LTTNG_LIVE_VIEWER_CONNECTION_H */