1 #ifndef LTTNG_LIVE_VIEWER_CONNECTION_H
2 #define LTTNG_LIVE_VIEWER_CONNECTION_H
5 * Copyright 2016 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 #include <babeltrace2/babeltrace.h>
34 #include "common/macros.h"
35 #include "compat/socket.h"
37 #define LTTNG_DEFAULT_NETWORK_VIEWER_PORT 5344
39 #define LTTNG_LIVE_MAJOR 2
40 #define LTTNG_LIVE_MINOR 4
42 enum lttng_live_viewer_status
{
43 LTTNG_LIVE_VIEWER_STATUS_OK
= 0,
44 LTTNG_LIVE_VIEWER_STATUS_ERROR
= -1,
45 LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
= -2,
48 enum lttng_live_get_one_metadata_status
{
49 /* The end of the metadata stream was reached. */
50 LTTNG_LIVE_GET_ONE_METADATA_STATUS_END
= 1,
51 /* One metadata packet was received and written to file. */
52 LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK
= LTTNG_LIVE_VIEWER_STATUS_OK
,
54 * A critical error occurred when contacting the relay or while
55 * handling its response.
57 LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR
= LTTNG_LIVE_VIEWER_STATUS_ERROR
,
59 LTTNG_LIVE_GET_ONE_METADATA_STATUS_INTERRUPTED
= LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
,
61 /* The metadata stream was not found on the relay. */
62 LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED
= -3,
65 struct lttng_live_component
;
67 struct live_viewer_connection
{
68 bt_logging_level log_level
;
69 bt_self_component
*self_comp
;
70 bt_self_component_class
*self_comp_class
;
74 GString
*relay_hostname
;
75 GString
*target_hostname
;
76 GString
*session_name
;
78 BT_SOCKET control_sock
;
85 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
88 struct packet_index_time
{
89 uint64_t timestamp_begin
;
90 uint64_t timestamp_end
;
94 off_t offset
; /* offset of the packet in the file, in bytes */
95 int64_t data_offset
; /* offset of data within the packet, in bits */
96 uint64_t packet_size
; /* packet size, in bits */
97 uint64_t content_size
; /* content size, in bits */
98 uint64_t events_discarded
;
99 uint64_t events_discarded_len
; /* length of the field, in bits */
100 struct packet_index_time ts_cycles
; /* timestamp in cycles */
101 struct packet_index_time ts_real
; /* realtime timestamp */
102 /* CTF_INDEX 1.0 limit */
103 uint64_t stream_instance_id
; /* ID of the channel instance */
104 uint64_t packet_seq_num
; /* packet sequence number */
107 enum lttng_live_viewer_status
live_viewer_connection_create(
108 bt_self_component
*self_comp
,
109 bt_self_component_class
*self_comp_class
,
110 bt_logging_level log_level
,
111 const char *url
, bool in_query
,
112 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
113 struct live_viewer_connection
**viewer_connection
);
115 void live_viewer_connection_destroy(
116 struct live_viewer_connection
*conn
);
118 bt_component_class_query_method_status
live_viewer_connection_list_sessions(
119 struct live_viewer_connection
*viewer_connection
,
120 const bt_value
**user_result
);
122 #endif /* LTTNG_LIVE_VIEWER_CONNECTION_H */