2 * SPDX-License-Identifier: MIT
4 * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
5 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
12 #include <babeltrace2/babeltrace.h>
14 #include "common/common.h"
15 #include "compat/endian.h" /* IWYU pragma: keep */
16 #include "cpp-common/bt2s/make-unique.hpp"
18 #include "data-stream.hpp"
19 #include "lttng-live.hpp"
20 #include "lttng-viewer-abi.hpp"
21 #include "metadata.hpp"
22 #include "viewer-connection.hpp"
24 #define viewer_handle_send_recv_status(_status, _action, _msg_str) \
27 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED: \
29 case LTTNG_LIVE_VIEWER_STATUS_ERROR: \
30 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection->logger, \
31 "Error " _action " " _msg_str); \
38 #define viewer_handle_send_status(_status, _msg_str) \
39 viewer_handle_send_recv_status(_status, "sending", _msg_str)
41 #define viewer_handle_recv_status(_status, _msg_str) \
42 viewer_handle_send_recv_status(_status, "receiving", _msg_str)
44 #define LTTNG_LIVE_CPPLOGE_APPEND_CAUSE_ERRNO(_msg, _fmt, ...) \
46 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection->logger, _msg ": {}" _fmt, \
47 bt_socket_errormsg(), ##__VA_ARGS__); \
50 static inline enum lttng_live_iterator_status
51 viewer_status_to_live_iterator_status(enum lttng_live_viewer_status viewer_status
)
53 switch (viewer_status
) {
54 case LTTNG_LIVE_VIEWER_STATUS_OK
:
55 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
56 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
:
57 return LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
58 case LTTNG_LIVE_VIEWER_STATUS_ERROR
:
59 return LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
65 static inline enum ctf_msg_iter_medium_status
66 viewer_status_to_ctf_msg_iter_medium_status(enum lttng_live_viewer_status viewer_status
)
68 switch (viewer_status
) {
69 case LTTNG_LIVE_VIEWER_STATUS_OK
:
70 return CTF_MSG_ITER_MEDIUM_STATUS_OK
;
71 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
:
72 return CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
;
73 case LTTNG_LIVE_VIEWER_STATUS_ERROR
:
74 return CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
80 static inline void viewer_connection_close_socket(struct live_viewer_connection
*viewer_connection
)
82 int ret
= bt_socket_close(viewer_connection
->control_sock
);
84 BT_CPPLOGW_ERRNO_SPEC(viewer_connection
->logger
,
85 "Error closing viewer connection socket: ", ".");
88 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
92 * This function receives a message from the Relay daemon.
93 * If it received the entire message, it returns _OK,
94 * If it's interrupted, it returns _INTERRUPTED,
95 * otherwise, it returns _ERROR.
97 static enum lttng_live_viewer_status
98 lttng_live_recv(struct live_viewer_connection
*viewer_connection
, void *buf
, size_t len
)
101 size_t total_received
= 0, to_receive
= len
;
102 struct lttng_live_msg_iter
*lttng_live_msg_iter
= viewer_connection
->lttng_live_msg_iter
;
103 enum lttng_live_viewer_status status
;
104 BT_SOCKET sock
= viewer_connection
->control_sock
;
107 * Receive a message from the Relay.
110 received
= bt_socket_recv(sock
, (char *) buf
+ total_received
, to_receive
, 0);
111 if (received
== BT_SOCKET_ERROR
) {
112 if (bt_socket_interrupted()) {
113 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
115 * This interruption was due to a
116 * SIGINT and the graph is being torn
119 status
= LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
;
120 lttng_live_msg_iter
->was_interrupted
= true;
124 * A signal was received, but the graph
125 * is not being torn down. Carry on.
131 * For any other types of socket error, close
132 * the socket and return an error.
134 LTTNG_LIVE_CPPLOGE_APPEND_CAUSE_ERRNO("Error receiving from Relay", ".");
136 viewer_connection_close_socket(viewer_connection
);
137 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
140 } else if (received
== 0) {
142 * The recv() call returned 0. This means the
143 * connection was orderly shutdown from the other peer.
144 * If that happens when we are trying to receive
145 * a message from it, it means something when wrong.
146 * Close the socket and return an error.
148 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
149 "Remote side has closed connection");
150 viewer_connection_close_socket(viewer_connection
);
151 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
155 BT_ASSERT(received
<= to_receive
);
156 total_received
+= received
;
157 to_receive
-= received
;
159 } while (to_receive
> 0);
161 BT_ASSERT(total_received
== len
);
162 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
169 * This function sends a message to the Relay daemon.
170 * If it send the message, it returns _OK,
171 * If it's interrupted, it returns _INTERRUPTED,
172 * otherwise, it returns _ERROR.
174 static enum lttng_live_viewer_status
175 lttng_live_send(struct live_viewer_connection
*viewer_connection
, const void *buf
, size_t len
)
177 enum lttng_live_viewer_status status
;
178 struct lttng_live_msg_iter
*lttng_live_msg_iter
= viewer_connection
->lttng_live_msg_iter
;
179 BT_SOCKET sock
= viewer_connection
->control_sock
;
180 size_t to_send
= len
;
181 ssize_t total_sent
= 0;
184 ssize_t sent
= bt_socket_send_nosigpipe(sock
, (char *) buf
+ total_sent
, to_send
);
185 if (sent
== BT_SOCKET_ERROR
) {
186 if (bt_socket_interrupted()) {
187 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
189 * This interruption was a SIGINT and
190 * the graph is being teared down.
192 status
= LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
;
193 lttng_live_msg_iter
->was_interrupted
= true;
197 * A signal was received, but the graph
198 * is not being teared down. Carry on.
204 * For any other types of socket error, close
205 * the socket and return an error.
207 LTTNG_LIVE_CPPLOGE_APPEND_CAUSE_ERRNO("Error sending to Relay", ".");
209 viewer_connection_close_socket(viewer_connection
);
210 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
215 BT_ASSERT(sent
<= to_send
);
219 } while (to_send
> 0);
221 BT_ASSERT(total_sent
== len
);
222 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
228 static int parse_url(struct live_viewer_connection
*viewer_connection
)
230 char error_buf
[256] = {0};
231 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= {};
232 bt_common_lttng_live_url_parts_deleter partsDeleter
{lttng_live_url_parts
};
235 if (viewer_connection
->url
.empty()) {
239 lttng_live_url_parts
= bt_common_parse_lttng_live_url(viewer_connection
->url
.c_str(), error_buf
,
241 if (!lttng_live_url_parts
.proto
) {
242 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Invalid LTTng live URL format: {}",
246 viewer_connection
->proto
.reset(lttng_live_url_parts
.proto
);
247 lttng_live_url_parts
.proto
= NULL
;
249 viewer_connection
->relay_hostname
.reset(lttng_live_url_parts
.hostname
);
250 lttng_live_url_parts
.hostname
= NULL
;
252 if (lttng_live_url_parts
.port
>= 0) {
253 viewer_connection
->port
= lttng_live_url_parts
.port
;
255 viewer_connection
->port
= LTTNG_DEFAULT_NETWORK_VIEWER_PORT
;
258 viewer_connection
->target_hostname
.reset(lttng_live_url_parts
.target_hostname
);
259 lttng_live_url_parts
.target_hostname
= NULL
;
261 if (lttng_live_url_parts
.session_name
) {
262 viewer_connection
->session_name
.reset(lttng_live_url_parts
.session_name
);
263 lttng_live_url_parts
.session_name
= NULL
;
272 static enum lttng_live_viewer_status
273 lttng_live_handshake(struct live_viewer_connection
*viewer_connection
)
275 struct lttng_viewer_cmd cmd
;
276 struct lttng_viewer_connect connect
;
277 enum lttng_live_viewer_status status
;
278 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(connect
);
279 char cmd_buf
[cmd_buf_len
];
281 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
282 "Handshaking with the relay daemon: cmd={}, major-version={}, minor-version={}",
283 LTTNG_VIEWER_CONNECT
, LTTNG_LIVE_MAJOR
, LTTNG_LIVE_MINOR
);
285 cmd
.cmd
= htobe32(LTTNG_VIEWER_CONNECT
);
286 cmd
.data_size
= htobe64((uint64_t) sizeof(connect
));
287 cmd
.cmd_version
= htobe32(0);
289 connect
.viewer_session_id
= -1ULL; /* will be set on recv */
290 connect
.major
= htobe32(LTTNG_LIVE_MAJOR
);
291 connect
.minor
= htobe32(LTTNG_LIVE_MINOR
);
292 connect
.type
= htobe32(LTTNG_VIEWER_CLIENT_COMMAND
);
295 * Merge the cmd and connection request to prevent a write-write
296 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
297 * second write to be performed quickly in presence of Nagle's algorithm
299 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
300 memcpy(cmd_buf
+ sizeof(cmd
), &connect
, sizeof(connect
));
302 status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
303 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
304 viewer_handle_send_status(status
, "viewer connect command");
308 status
= lttng_live_recv(viewer_connection
, &connect
, sizeof(connect
));
309 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
310 viewer_handle_recv_status(status
, "viewer connect reply");
314 BT_CPPLOGI_SPEC(viewer_connection
->logger
, "Received viewer session ID : {}",
315 (uint64_t) be64toh(connect
.viewer_session_id
));
316 BT_CPPLOGI_SPEC(viewer_connection
->logger
, "Relayd version : {}.{}", be32toh(connect
.major
),
317 be32toh(connect
.minor
));
319 if (LTTNG_LIVE_MAJOR
!= be32toh(connect
.major
)) {
320 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
321 "Incompatible lttng-relayd protocol");
322 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
325 /* Use the smallest protocol version implemented. */
326 if (LTTNG_LIVE_MINOR
> be32toh(connect
.minor
)) {
327 viewer_connection
->minor
= be32toh(connect
.minor
);
329 viewer_connection
->minor
= LTTNG_LIVE_MINOR
;
331 viewer_connection
->major
= LTTNG_LIVE_MAJOR
;
333 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
341 static enum lttng_live_viewer_status
342 lttng_live_connect_viewer(struct live_viewer_connection
*viewer_connection
)
344 struct hostent
*host
;
345 struct sockaddr_in server_addr
;
346 enum lttng_live_viewer_status status
;
348 if (parse_url(viewer_connection
)) {
349 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Failed to parse URL");
350 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
355 viewer_connection
->logger
,
356 "Connecting to hostname : {}, port : {}, target hostname : {}, session name : {}, proto : {}",
357 viewer_connection
->relay_hostname
->str
, viewer_connection
->port
,
358 !viewer_connection
->target_hostname
? "<none>" : viewer_connection
->target_hostname
->str
,
359 !viewer_connection
->session_name
? "<none>" : viewer_connection
->session_name
->str
,
360 viewer_connection
->proto
->str
);
362 host
= gethostbyname(viewer_connection
->relay_hostname
->str
);
364 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
365 "Cannot lookup hostname: hostname=\"{}\"",
366 viewer_connection
->relay_hostname
->str
);
367 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
371 if ((viewer_connection
->control_sock
= socket(AF_INET
, SOCK_STREAM
, 0)) == BT_INVALID_SOCKET
) {
372 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Socket creation failed: {}",
373 bt_socket_errormsg());
374 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
378 server_addr
.sin_family
= AF_INET
;
379 server_addr
.sin_port
= htons(viewer_connection
->port
);
380 server_addr
.sin_addr
= *((struct in_addr
*) host
->h_addr
);
381 memset(&(server_addr
.sin_zero
), 0, 8);
383 if (connect(viewer_connection
->control_sock
, (struct sockaddr
*) &server_addr
,
384 sizeof(struct sockaddr
)) == BT_SOCKET_ERROR
) {
385 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Connection failed: {}",
386 bt_socket_errormsg());
387 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
391 status
= lttng_live_handshake(viewer_connection
);
394 * Only print error and append cause in case of error. not in case of
397 if (status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
398 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Viewer handshake failed");
400 } else if (status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
407 if (viewer_connection
->control_sock
!= BT_INVALID_SOCKET
) {
408 if (bt_socket_close(viewer_connection
->control_sock
) == BT_SOCKET_ERROR
) {
409 BT_CPPLOGW_SPEC(viewer_connection
->logger
, "Error closing socket: {}.",
410 bt_socket_errormsg());
413 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
418 static void lttng_live_disconnect_viewer(struct live_viewer_connection
*viewer_connection
)
420 if (viewer_connection
->control_sock
== BT_INVALID_SOCKET
) {
423 if (bt_socket_close(viewer_connection
->control_sock
) == BT_SOCKET_ERROR
) {
424 BT_CPPLOGW_SPEC(viewer_connection
->logger
, "Error closing socket: {}",
425 bt_socket_errormsg());
426 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
430 static int list_update_session(bt_value
*results
, const struct lttng_viewer_session
*session
,
431 bool *_found
, struct live_viewer_connection
*viewer_connection
)
435 bt_value
*map
= NULL
;
436 bt_value
*hostname
= NULL
;
437 bt_value
*session_name
= NULL
;
438 bt_value
*btval
= NULL
;
441 len
= bt_value_array_get_length(results
);
442 for (i
= 0; i
< len
; i
++) {
443 const char *hostname_str
= NULL
;
444 const char *session_name_str
= NULL
;
446 map
= bt_value_array_borrow_element_by_index(results
, i
);
447 hostname
= bt_value_map_borrow_entry_value(map
, "target-hostname");
449 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
450 "Error borrowing \"target-hostname\" entry.");
454 session_name
= bt_value_map_borrow_entry_value(map
, "session-name");
456 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
457 "Error borrowing \"session-name\" entry.");
461 hostname_str
= bt_value_string_get(hostname
);
462 session_name_str
= bt_value_string_get(session_name
);
464 if (strcmp(session
->hostname
, hostname_str
) == 0 &&
465 strcmp(session
->session_name
, session_name_str
) == 0) {
467 uint32_t streams
= be32toh(session
->streams
);
468 uint32_t clients
= be32toh(session
->clients
);
472 btval
= bt_value_map_borrow_entry_value(map
, "stream-count");
474 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
475 "Error borrowing \"stream-count\" entry.");
479 val
= bt_value_integer_unsigned_get(btval
);
482 bt_value_integer_unsigned_set(btval
, val
);
484 btval
= bt_value_map_borrow_entry_value(map
, "client-count");
486 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
487 "Error borrowing \"client-count\" entry.");
491 val
= bt_value_integer_unsigned_get(btval
);
493 val
= bt_max_t(int64_t, clients
, val
);
494 bt_value_integer_unsigned_set(btval
, val
);
506 static int list_append_session(bt_value
*results
, const std::string
& base_url
,
507 const struct lttng_viewer_session
*session
,
508 struct live_viewer_connection
*viewer_connection
)
511 bt_value_map_insert_entry_status insert_status
;
512 bt_value_array_append_element_status append_status
;
513 bt_value
*map
= NULL
;
517 * If the session already exists, add the stream count to it,
518 * and do max of client counts.
520 ret
= list_update_session(results
, session
, &found
, viewer_connection
);
525 map
= bt_value_map_create();
527 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error creating map value.");
532 if (base_url
.empty()) {
533 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
534 "Error: base_url length smaller than 1.");
543 insert_status
= bt_value_map_insert_string_entry(
545 fmt::format("{}/host/{}/{}", base_url
, session
->hostname
, session
->session_name
).c_str());
546 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
547 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error inserting \"url\" entry.");
553 * key = "target-hostname",
556 insert_status
= bt_value_map_insert_string_entry(map
, "target-hostname", session
->hostname
);
557 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
558 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
559 "Error inserting \"target-hostname\" entry.");
565 * key = "session-name",
568 insert_status
= bt_value_map_insert_string_entry(map
, "session-name", session
->session_name
);
569 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
570 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
571 "Error inserting \"session-name\" entry.");
581 uint32_t live_timer
= be32toh(session
->live_timer
);
583 insert_status
= bt_value_map_insert_unsigned_integer_entry(map
, "timer-us", live_timer
);
584 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
585 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
586 "Error inserting \"timer-us\" entry.");
593 * key = "stream-count",
597 uint32_t streams
= be32toh(session
->streams
);
599 insert_status
= bt_value_map_insert_unsigned_integer_entry(map
, "stream-count", streams
);
600 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
601 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
602 "Error inserting \"stream-count\" entry.");
609 * key = "client-count",
613 uint32_t clients
= be32toh(session
->clients
);
615 insert_status
= bt_value_map_insert_unsigned_integer_entry(map
, "client-count", clients
);
616 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
617 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
618 "Error inserting \"client-count\" entry.");
624 append_status
= bt_value_array_append_element(results
, map
);
625 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
626 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error appending map to results.");
631 BT_VALUE_PUT_REF_AND_RESET(map
);
636 * Data structure returned:
647 * key = "target-hostname",
651 * key = "session-name",
659 * key = "stream-count",
663 * key = "client-count",
671 bt_component_class_query_method_status
672 live_viewer_connection_list_sessions(struct live_viewer_connection
*viewer_connection
,
673 const bt_value
**user_result
)
675 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
676 bt_value
*result
= NULL
;
677 enum lttng_live_viewer_status viewer_status
;
678 struct lttng_viewer_cmd cmd
;
679 struct lttng_viewer_list_sessions list
;
680 uint32_t i
, sessions_count
;
682 result
= bt_value_array_create();
684 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error creating array");
685 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
689 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Requesting list of sessions: cmd={}",
690 LTTNG_VIEWER_LIST_SESSIONS
);
692 cmd
.cmd
= htobe32(LTTNG_VIEWER_LIST_SESSIONS
);
693 cmd
.data_size
= htobe64((uint64_t) 0);
694 cmd
.cmd_version
= htobe32(0);
696 viewer_status
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
697 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
698 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
699 "Error sending list sessions command");
700 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
702 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
703 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
707 viewer_status
= lttng_live_recv(viewer_connection
, &list
, sizeof(list
));
708 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
709 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error receiving session list");
710 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
712 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
713 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
717 sessions_count
= be32toh(list
.sessions_count
);
718 for (i
= 0; i
< sessions_count
; i
++) {
719 struct lttng_viewer_session lsession
;
721 viewer_status
= lttng_live_recv(viewer_connection
, &lsession
, sizeof(lsession
));
722 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
723 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error receiving session:");
724 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
726 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
727 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
731 lsession
.hostname
[LTTNG_VIEWER_HOST_NAME_MAX
- 1] = '\0';
732 lsession
.session_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
733 if (list_append_session(result
, viewer_connection
->url
, &lsession
, viewer_connection
)) {
734 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error appending session");
735 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
740 *user_result
= result
;
743 BT_VALUE_PUT_REF_AND_RESET(result
);
748 static enum lttng_live_viewer_status
749 lttng_live_query_session_ids(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
751 struct lttng_viewer_cmd cmd
;
752 struct lttng_viewer_list_sessions list
;
753 struct lttng_viewer_session lsession
;
754 uint32_t i
, sessions_count
;
756 enum lttng_live_viewer_status status
;
757 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
759 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
760 "Asking the relay daemon for the list of sessions: cmd={}",
761 LTTNG_VIEWER_LIST_SESSIONS
);
763 cmd
.cmd
= htobe32(LTTNG_VIEWER_LIST_SESSIONS
);
764 cmd
.data_size
= htobe64((uint64_t) 0);
765 cmd
.cmd_version
= htobe32(0);
767 status
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
768 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
769 viewer_handle_send_status(status
, "list sessions command");
773 status
= lttng_live_recv(viewer_connection
, &list
, sizeof(list
));
774 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
775 viewer_handle_recv_status(status
, "session list reply");
779 sessions_count
= be32toh(list
.sessions_count
);
780 for (i
= 0; i
< sessions_count
; i
++) {
781 status
= lttng_live_recv(viewer_connection
, &lsession
, sizeof(lsession
));
782 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
783 viewer_handle_recv_status(status
, "session reply");
786 lsession
.hostname
[LTTNG_VIEWER_HOST_NAME_MAX
- 1] = '\0';
787 lsession
.session_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
788 session_id
= be64toh(lsession
.id
);
790 BT_CPPLOGI_SPEC(viewer_connection
->logger
,
791 "Adding session to internal list: "
792 "session-id={}, hostname=\"{}\", session-name=\"{}\"",
793 session_id
, lsession
.hostname
, lsession
.session_name
);
795 if ((strncmp(lsession
.session_name
, viewer_connection
->session_name
->str
,
796 LTTNG_VIEWER_NAME_MAX
) == 0) &&
797 (strncmp(lsession
.hostname
, viewer_connection
->target_hostname
->str
,
798 LTTNG_VIEWER_HOST_NAME_MAX
) == 0)) {
799 if (lttng_live_add_session(lttng_live_msg_iter
, session_id
, lsession
.hostname
,
800 lsession
.session_name
)) {
801 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
802 "Failed to add live session");
803 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
809 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
815 enum lttng_live_viewer_status
816 lttng_live_create_viewer_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
818 struct lttng_viewer_cmd cmd
;
819 struct lttng_viewer_create_session_response resp
;
820 enum lttng_live_viewer_status status
;
821 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
823 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Creating a viewer session: cmd={}",
824 LTTNG_VIEWER_CREATE_SESSION
);
826 cmd
.cmd
= htobe32(LTTNG_VIEWER_CREATE_SESSION
);
827 cmd
.data_size
= htobe64((uint64_t) 0);
828 cmd
.cmd_version
= htobe32(0);
830 status
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
831 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
832 viewer_handle_send_status(status
, "create session command");
836 status
= lttng_live_recv(viewer_connection
, &resp
, sizeof(resp
));
837 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
838 viewer_handle_recv_status(status
, "create session reply");
842 if (be32toh(resp
.status
) != LTTNG_VIEWER_CREATE_SESSION_OK
) {
843 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error creating viewer session");
844 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
848 status
= lttng_live_query_session_ids(lttng_live_msg_iter
);
849 if (status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
850 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
851 "Failed to query live viewer session ids");
853 } else if (status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
861 static enum lttng_live_viewer_status
receive_streams(struct lttng_live_session
*session
,
862 uint32_t stream_count
,
863 bt_self_message_iterator
*self_msg_iter
)
866 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
867 enum lttng_live_viewer_status status
;
868 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
870 BT_CPPLOGI_SPEC(viewer_connection
->logger
, "Getting {} new streams", stream_count
);
871 for (i
= 0; i
< stream_count
; i
++) {
872 struct lttng_viewer_stream stream
;
873 struct lttng_live_stream_iterator
*live_stream
;
875 uint64_t ctf_trace_id
;
877 status
= lttng_live_recv(viewer_connection
, &stream
, sizeof(stream
));
878 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
879 viewer_handle_recv_status(status
, "stream reply");
882 stream
.path_name
[LTTNG_VIEWER_PATH_MAX
- 1] = '\0';
883 stream
.channel_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
884 stream_id
= be64toh(stream
.id
);
885 ctf_trace_id
= be64toh(stream
.ctf_trace_id
);
887 if (stream
.metadata_flag
) {
888 BT_CPPLOGI_SPEC(viewer_connection
->logger
, " metadata stream {} : {}/{}", stream_id
,
889 stream
.path_name
, stream
.channel_name
);
890 if (lttng_live_metadata_create_stream(session
, ctf_trace_id
, stream_id
)) {
891 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
892 "Error creating metadata stream");
893 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
896 session
->lazy_stream_msg_init
= true;
898 BT_CPPLOGI_SPEC(viewer_connection
->logger
, " stream {} : {}/{}", stream_id
,
899 stream
.path_name
, stream
.channel_name
);
901 lttng_live_stream_iterator_create(session
, ctf_trace_id
, stream_id
, self_msg_iter
);
903 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error creating stream");
904 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
909 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
915 enum lttng_live_viewer_status
lttng_live_session_attach(struct lttng_live_session
*session
,
916 bt_self_message_iterator
*self_msg_iter
)
918 struct lttng_viewer_cmd cmd
;
919 enum lttng_live_viewer_status status
;
920 struct lttng_viewer_attach_session_request rq
;
921 struct lttng_viewer_attach_session_response rp
;
922 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
923 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
924 uint64_t session_id
= session
->id
;
925 uint32_t streams_count
;
926 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
927 char cmd_buf
[cmd_buf_len
];
929 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
930 "Attaching to session: cmd={}, session-id={}, seek={}",
931 LTTNG_VIEWER_ATTACH_SESSION
, session_id
, LTTNG_VIEWER_SEEK_LAST
);
933 cmd
.cmd
= htobe32(LTTNG_VIEWER_ATTACH_SESSION
);
934 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
935 cmd
.cmd_version
= htobe32(0);
937 memset(&rq
, 0, sizeof(rq
));
938 rq
.session_id
= htobe64(session_id
);
939 // TODO: add cmd line parameter to select seek beginning
940 // rq.seek = htobe32(LTTNG_VIEWER_SEEK_BEGINNING);
941 rq
.seek
= htobe32(LTTNG_VIEWER_SEEK_LAST
);
944 * Merge the cmd and connection request to prevent a write-write
945 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
946 * second write to be performed quickly in presence of Nagle's algorithm.
948 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
949 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
950 status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
951 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
952 viewer_handle_send_status(status
, "attach session command");
956 status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
957 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
958 viewer_handle_recv_status(status
, "attach session reply");
962 streams_count
= be32toh(rp
.streams_count
);
963 switch (be32toh(rp
.status
)) {
964 case LTTNG_VIEWER_ATTACH_OK
:
966 case LTTNG_VIEWER_ATTACH_UNK
:
967 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Session id {} is unknown",
969 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
971 case LTTNG_VIEWER_ATTACH_ALREADY
:
972 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
973 "There is already a viewer attached to this session");
974 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
976 case LTTNG_VIEWER_ATTACH_NOT_LIVE
:
977 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Not a live session");
978 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
980 case LTTNG_VIEWER_ATTACH_SEEK_ERR
:
981 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Wrong seek parameter");
982 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
985 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Unknown attach return code {}",
987 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
991 /* We receive the initial list of streams. */
992 status
= receive_streams(session
, streams_count
, self_msg_iter
);
994 case LTTNG_LIVE_VIEWER_STATUS_OK
:
996 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
:
998 case LTTNG_LIVE_VIEWER_STATUS_ERROR
:
999 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error receiving streams");
1005 session
->attached
= true;
1006 session
->new_streams_needed
= false;
1012 enum lttng_live_viewer_status
lttng_live_session_detach(struct lttng_live_session
*session
)
1014 struct lttng_viewer_cmd cmd
;
1015 enum lttng_live_viewer_status status
;
1016 struct lttng_viewer_detach_session_request rq
;
1017 struct lttng_viewer_detach_session_response rp
;
1018 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
1019 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
1020 uint64_t session_id
= session
->id
;
1021 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1022 char cmd_buf
[cmd_buf_len
];
1025 * The session might already be detached and the viewer socket might
1026 * already been closed. This happens when calling this function when
1027 * tearing down the graph after an error.
1029 if (!session
->attached
|| viewer_connection
->control_sock
== BT_INVALID_SOCKET
) {
1030 return LTTNG_LIVE_VIEWER_STATUS_OK
;
1033 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Detaching from session: cmd={}, session-id={}",
1034 LTTNG_VIEWER_DETACH_SESSION
, session_id
);
1036 cmd
.cmd
= htobe32(LTTNG_VIEWER_DETACH_SESSION
);
1037 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1038 cmd
.cmd_version
= htobe32(0);
1040 memset(&rq
, 0, sizeof(rq
));
1041 rq
.session_id
= htobe64(session_id
);
1044 * Merge the cmd and connection request to prevent a write-write
1045 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1046 * second write to be performed quickly in presence of Nagle's algorithm.
1048 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1049 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1050 status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1051 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1052 viewer_handle_send_status(status
, "detach session command");
1056 status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1057 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1058 viewer_handle_recv_status(status
, "detach session reply");
1062 switch (be32toh(rp
.status
)) {
1063 case LTTNG_VIEWER_DETACH_SESSION_OK
:
1065 case LTTNG_VIEWER_DETACH_SESSION_UNK
:
1066 BT_CPPLOGW_SPEC(viewer_connection
->logger
, "Session id {} is unknown", session_id
);
1067 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1069 case LTTNG_VIEWER_DETACH_SESSION_ERR
:
1070 BT_CPPLOGW_SPEC(viewer_connection
->logger
, "Error detaching session id {}", session_id
);
1071 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1074 BT_CPPLOGE_SPEC(viewer_connection
->logger
, "Unknown detach return code {}",
1075 be32toh(rp
.status
));
1076 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1080 session
->attached
= false;
1082 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
1088 enum lttng_live_get_one_metadata_status
1089 lttng_live_get_one_metadata_packet(struct lttng_live_trace
*trace
, std::vector
<char>& buf
)
1092 enum lttng_live_get_one_metadata_status status
;
1093 enum lttng_live_viewer_status viewer_status
;
1094 struct lttng_viewer_cmd cmd
;
1095 struct lttng_viewer_get_metadata rq
;
1096 struct lttng_viewer_metadata_packet rp
;
1097 std::vector
<char> data
;
1098 struct lttng_live_session
*session
= trace
->session
;
1099 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
1100 struct lttng_live_metadata
*metadata
= trace
->metadata
.get();
1101 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
1102 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1103 char cmd_buf
[cmd_buf_len
];
1105 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1106 "Requesting new metadata for trace:"
1107 "cmd={}, trace-id={}, metadata-stream-id={}",
1108 LTTNG_VIEWER_GET_METADATA
, trace
->id
, metadata
->stream_id
);
1110 rq
.stream_id
= htobe64(metadata
->stream_id
);
1111 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_METADATA
);
1112 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1113 cmd
.cmd_version
= htobe32(0);
1116 * Merge the cmd and connection request to prevent a write-write
1117 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1118 * second write to be performed quickly in presence of Nagle's algorithm.
1120 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1121 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1122 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1123 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1124 viewer_handle_send_status(viewer_status
, "get metadata command");
1125 status
= (enum lttng_live_get_one_metadata_status
) viewer_status
;
1129 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1130 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1131 viewer_handle_recv_status(viewer_status
, "get metadata reply");
1132 status
= (enum lttng_live_get_one_metadata_status
) viewer_status
;
1136 switch (be32toh(rp
.status
)) {
1137 case LTTNG_VIEWER_METADATA_OK
:
1138 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_metadata response: ok");
1140 case LTTNG_VIEWER_NO_NEW_METADATA
:
1141 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_metadata response: no new");
1142 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_END
;
1144 case LTTNG_VIEWER_METADATA_ERR
:
1146 * The Relayd cannot find this stream id. Maybe its
1147 * gone already. This can happen in short lived UST app
1148 * in a per-pid session.
1150 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_metadata response: error");
1151 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED
;
1154 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1155 "Received get_metadata response: unknown");
1156 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR
;
1160 len
= be64toh(rp
.len
);
1163 * We received a `LTTNG_VIEWER_METADATA_OK` with a packet
1164 * length of 0. This means we must try again. This scenario
1165 * arises when a clear command is performed on an lttng session.
1168 viewer_connection
->logger
,
1169 "Expecting a metadata packet of size 0. Retry to get a packet from the relay.");
1170 goto empty_metadata_packet_retry
;
1173 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Writing {} bytes to metadata", len
);
1175 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Erroneous response length");
1176 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR
;
1182 viewer_status
= lttng_live_recv(viewer_connection
, data
.data(), len
);
1183 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1184 viewer_handle_recv_status(viewer_status
, "get metadata packet");
1185 status
= (enum lttng_live_get_one_metadata_status
) viewer_status
;
1190 * Write the metadata to the file handle.
1192 buf
.insert(buf
.end(), data
.begin(), data
.end());
1194 empty_metadata_packet_retry
:
1195 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK
;
1202 * Assign the fields from a lttng_viewer_index to a packet_index.
1204 static void lttng_index_to_packet_index(struct lttng_viewer_index
*lindex
,
1205 struct packet_index
*pindex
)
1210 pindex
->offset
= be64toh(lindex
->offset
);
1211 pindex
->packet_size
= be64toh(lindex
->packet_size
);
1212 pindex
->content_size
= be64toh(lindex
->content_size
);
1213 pindex
->ts_cycles
.timestamp_begin
= be64toh(lindex
->timestamp_begin
);
1214 pindex
->ts_cycles
.timestamp_end
= be64toh(lindex
->timestamp_end
);
1215 pindex
->events_discarded
= be64toh(lindex
->events_discarded
);
1218 static void lttng_live_need_new_streams(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
1220 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
1221 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1222 "Marking session as needing new streams: "
1225 session
->new_streams_needed
= true;
1229 enum lttng_live_iterator_status
1230 lttng_live_get_next_index(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1231 struct lttng_live_stream_iterator
*stream
, struct packet_index
*index
)
1233 struct lttng_viewer_cmd cmd
;
1234 struct lttng_viewer_get_next_index rq
;
1235 enum lttng_live_viewer_status viewer_status
;
1236 struct lttng_viewer_index rp
;
1237 enum lttng_live_iterator_status status
;
1238 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
1239 struct lttng_live_trace
*trace
= stream
->trace
;
1240 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1241 char cmd_buf
[cmd_buf_len
];
1242 uint32_t flags
, rp_status
;
1244 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1245 "Requesting next index for stream: cmd={}, "
1246 "viewer-stream-id={}",
1247 LTTNG_VIEWER_GET_NEXT_INDEX
, stream
->viewer_stream_id
);
1248 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_NEXT_INDEX
);
1249 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1250 cmd
.cmd_version
= htobe32(0);
1252 memset(&rq
, 0, sizeof(rq
));
1253 rq
.stream_id
= htobe64(stream
->viewer_stream_id
);
1256 * Merge the cmd and connection request to prevent a write-write
1257 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1258 * second write to be performed quickly in presence of Nagle's algorithm.
1260 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1261 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1263 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1264 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1265 viewer_handle_send_status(viewer_status
, "get next index command");
1269 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1270 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1271 viewer_handle_recv_status(viewer_status
, "get next index reply");
1275 flags
= be32toh(rp
.flags
);
1276 rp_status
= be32toh(rp
.status
);
1279 viewer_connection
->logger
, "Received response from relay daemon: cmd=%s, response={}",
1280 LTTNG_VIEWER_GET_NEXT_INDEX
, static_cast<lttng_viewer_next_index_return_code
>(rp_status
));
1282 if (flags
& LTTNG_VIEWER_FLAG_NEW_STREAM
) {
1283 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1284 "Marking all sessions as possibly needing new streams: "
1285 "response={}, response-flag=NEW_STREAM",
1286 static_cast<lttng_viewer_next_index_return_code
>(rp_status
));
1287 lttng_live_need_new_streams(lttng_live_msg_iter
);
1290 switch (rp_status
) {
1291 case LTTNG_VIEWER_INDEX_INACTIVE
:
1293 uint64_t ctf_stream_class_id
;
1295 memset(index
, 0, sizeof(struct packet_index
));
1296 index
->ts_cycles
.timestamp_end
= be64toh(rp
.timestamp_end
);
1297 stream
->current_inactivity_ts
= index
->ts_cycles
.timestamp_end
;
1298 ctf_stream_class_id
= be64toh(rp
.stream_id
);
1299 if (stream
->ctf_stream_class_id
.is_set
) {
1300 BT_ASSERT(stream
->ctf_stream_class_id
.value
== ctf_stream_class_id
);
1302 stream
->ctf_stream_class_id
.value
= ctf_stream_class_id
;
1303 stream
->ctf_stream_class_id
.is_set
= true;
1305 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_QUIESCENT
);
1306 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1309 case LTTNG_VIEWER_INDEX_OK
:
1311 uint64_t ctf_stream_class_id
;
1313 lttng_index_to_packet_index(&rp
, index
);
1314 ctf_stream_class_id
= be64toh(rp
.stream_id
);
1315 if (stream
->ctf_stream_class_id
.is_set
) {
1316 BT_ASSERT(stream
->ctf_stream_class_id
.value
== ctf_stream_class_id
);
1318 stream
->ctf_stream_class_id
.value
= ctf_stream_class_id
;
1319 stream
->ctf_stream_class_id
.is_set
= true;
1321 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_DATA
);
1323 if (flags
& LTTNG_VIEWER_FLAG_NEW_METADATA
) {
1324 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1325 "Marking trace as needing new metadata: "
1326 "response={}, response-flag=NEW_METADATA, trace-id={}",
1327 static_cast<lttng_viewer_next_index_return_code
>(rp_status
), trace
->id
);
1328 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
1330 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1333 case LTTNG_VIEWER_INDEX_RETRY
:
1334 memset(index
, 0, sizeof(struct packet_index
));
1335 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
);
1336 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1338 case LTTNG_VIEWER_INDEX_HUP
:
1339 memset(index
, 0, sizeof(struct packet_index
));
1340 index
->offset
= EOF
;
1341 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_EOF
);
1342 stream
->has_stream_hung_up
= true;
1343 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1345 case LTTNG_VIEWER_INDEX_ERR
:
1346 memset(index
, 0, sizeof(struct packet_index
));
1347 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
);
1348 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1351 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1352 "Received get_next_index response: unknown value");
1353 memset(index
, 0, sizeof(struct packet_index
));
1354 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
);
1355 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1362 status
= viewer_status_to_live_iterator_status(viewer_status
);
1367 enum ctf_msg_iter_medium_status
1368 lttng_live_get_stream_bytes(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1369 struct lttng_live_stream_iterator
*stream
, uint8_t *buf
,
1370 uint64_t offset
, uint64_t req_len
, uint64_t *recv_len
)
1372 enum ctf_msg_iter_medium_status status
;
1373 enum lttng_live_viewer_status viewer_status
;
1374 struct lttng_viewer_trace_packet rp
;
1375 struct lttng_viewer_cmd cmd
;
1376 struct lttng_viewer_get_packet rq
;
1377 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
1378 struct lttng_live_trace
*trace
= stream
->trace
;
1379 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1380 char cmd_buf
[cmd_buf_len
];
1381 uint32_t flags
, rp_status
;
1383 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1384 "Requesting data from stream: cmd={}, "
1385 "offset={}, request-len={}",
1386 LTTNG_VIEWER_GET_PACKET
, offset
, req_len
);
1388 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_PACKET
);
1389 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1390 cmd
.cmd_version
= htobe32(0);
1392 memset(&rq
, 0, sizeof(rq
));
1393 rq
.stream_id
= htobe64(stream
->viewer_stream_id
);
1394 rq
.offset
= htobe64(offset
);
1395 rq
.len
= htobe32(req_len
);
1398 * Merge the cmd and connection request to prevent a write-write
1399 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1400 * second write to be performed quickly in presence of Nagle's algorithm.
1402 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1403 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1405 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1406 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1407 viewer_handle_send_status(viewer_status
, "get data packet command");
1408 goto error_convert_status
;
1411 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1412 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1413 viewer_handle_recv_status(viewer_status
, "get data packet reply");
1414 goto error_convert_status
;
1417 flags
= be32toh(rp
.flags
);
1418 rp_status
= be32toh(rp
.status
);
1421 viewer_connection
->logger
, "Received response from relay daemon: cmd={}, response={}",
1422 LTTNG_VIEWER_GET_PACKET
, static_cast<lttng_viewer_get_packet_return_code
>(rp_status
));
1423 switch (rp_status
) {
1424 case LTTNG_VIEWER_GET_PACKET_OK
:
1425 req_len
= be32toh(rp
.len
);
1426 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1427 "Got packet from relay daemon: response={}, packet-len={}",
1428 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
), req_len
);
1430 case LTTNG_VIEWER_GET_PACKET_RETRY
:
1431 /* Unimplemented by relay daemon */
1432 status
= CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
;
1434 case LTTNG_VIEWER_GET_PACKET_ERR
:
1435 if (flags
& LTTNG_VIEWER_FLAG_NEW_METADATA
) {
1436 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1437 "Marking trace as needing new metadata: "
1438 "response={}, response-flag=NEW_METADATA, trace-id={}",
1439 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
), trace
->id
);
1440 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
1442 if (flags
& LTTNG_VIEWER_FLAG_NEW_STREAM
) {
1443 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1444 "Marking all sessions as possibly needing new streams: "
1445 "response={}, response-flag=NEW_STREAM",
1446 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
));
1447 lttng_live_need_new_streams(lttng_live_msg_iter
);
1449 if (flags
& (LTTNG_VIEWER_FLAG_NEW_METADATA
| LTTNG_VIEWER_FLAG_NEW_STREAM
)) {
1450 status
= CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
;
1451 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1452 "Reply with any one flags set means we should retry: response={}",
1453 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
));
1456 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1457 "Received get_data_packet response: error");
1458 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
1460 case LTTNG_VIEWER_GET_PACKET_EOF
:
1461 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
1464 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1465 "Received get_data_packet response: unknown ({})", rp_status
);
1466 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
1471 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
1475 viewer_status
= lttng_live_recv(viewer_connection
, buf
, req_len
);
1476 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1477 viewer_handle_recv_status(viewer_status
, "get data packet");
1478 goto error_convert_status
;
1480 *recv_len
= req_len
;
1482 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
1485 error_convert_status
:
1486 status
= viewer_status_to_ctf_msg_iter_medium_status(viewer_status
);
1492 * Request new streams for a session.
1494 enum lttng_live_iterator_status
1495 lttng_live_session_get_new_streams(struct lttng_live_session
*session
,
1496 bt_self_message_iterator
*self_msg_iter
)
1498 enum lttng_live_iterator_status status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1499 struct lttng_viewer_cmd cmd
;
1500 struct lttng_viewer_new_streams_request rq
;
1501 struct lttng_viewer_new_streams_response rp
;
1502 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
1503 enum lttng_live_viewer_status viewer_status
;
1504 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
1505 uint32_t streams_count
;
1506 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1507 char cmd_buf
[cmd_buf_len
];
1509 if (!session
->new_streams_needed
) {
1510 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1514 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1515 "Requesting new streams for session: cmd={}, session-id={}",
1516 LTTNG_VIEWER_GET_NEW_STREAMS
, session
->id
);
1518 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_NEW_STREAMS
);
1519 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1520 cmd
.cmd_version
= htobe32(0);
1522 memset(&rq
, 0, sizeof(rq
));
1523 rq
.session_id
= htobe64(session
->id
);
1526 * Merge the cmd and connection request to prevent a write-write
1527 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1528 * second write to be performed quickly in presence of Nagle's algorithm.
1530 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1531 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1533 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1534 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1535 viewer_handle_send_status(viewer_status
, "get new streams command");
1536 status
= viewer_status_to_live_iterator_status(viewer_status
);
1540 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1541 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1542 viewer_handle_recv_status(viewer_status
, "get new streams reply");
1543 status
= viewer_status_to_live_iterator_status(viewer_status
);
1547 streams_count
= be32toh(rp
.streams_count
);
1549 switch (be32toh(rp
.status
)) {
1550 case LTTNG_VIEWER_NEW_STREAMS_OK
:
1551 session
->new_streams_needed
= false;
1553 case LTTNG_VIEWER_NEW_STREAMS_NO_NEW
:
1554 session
->new_streams_needed
= false;
1556 case LTTNG_VIEWER_NEW_STREAMS_HUP
:
1557 session
->new_streams_needed
= false;
1558 session
->closed
= true;
1559 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1561 case LTTNG_VIEWER_NEW_STREAMS_ERR
:
1562 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_new_streams response: error");
1563 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1566 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1567 "Received get_new_streams response: Unknown:"
1569 be32toh(rp
.status
));
1570 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1574 viewer_status
= receive_streams(session
, streams_count
, self_msg_iter
);
1575 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1576 viewer_handle_recv_status(viewer_status
, "new streams");
1577 status
= viewer_status_to_live_iterator_status(viewer_status
);
1581 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1586 enum lttng_live_viewer_status
1587 live_viewer_connection_create(const char *url
, bool in_query
,
1588 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1589 const bt2c::Logger
& parentLogger
, live_viewer_connection::UP
& viewer
)
1591 auto viewer_connection
= bt2s::make_unique
<live_viewer_connection
>(parentLogger
);
1593 if (bt_socket_init(viewer_connection
->logger
) != 0) {
1594 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Failed to init socket");
1595 return LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1598 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
1599 viewer_connection
->port
= -1;
1600 viewer_connection
->in_query
= in_query
;
1601 viewer_connection
->lttng_live_msg_iter
= lttng_live_msg_iter
;
1602 viewer_connection
->url
= url
;
1604 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Establishing connection to url \"{}\"...", url
);
1605 const auto status
= lttng_live_connect_viewer(viewer_connection
.get());
1608 * Only print error and append cause in case of error. not in case of
1611 if (status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1612 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1613 "Failed to establish connection: "
1617 } else if (status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1620 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Connection to url \"{}\" is established", url
);
1622 viewer
= std::move(viewer_connection
);
1623 return LTTNG_LIVE_VIEWER_STATUS_OK
;
1626 live_viewer_connection::~live_viewer_connection()
1628 BT_CPPLOGD_SPEC(this->logger
, "Closing connection to relay: relay-url=\"{}\"", this->url
);
1630 lttng_live_disconnect_viewer(this);