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 */
17 #include "data-stream.hpp"
18 #include "lttng-live.hpp"
19 #include "lttng-viewer-abi.hpp"
20 #include "metadata.hpp"
21 #include "viewer-connection.hpp"
23 #define viewer_handle_send_recv_status(_status, _action, _msg_str) \
26 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED: \
28 case LTTNG_LIVE_VIEWER_STATUS_ERROR: \
29 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection->logger, \
30 "Error " _action " " _msg_str); \
37 #define viewer_handle_send_status(_status, _msg_str) \
38 viewer_handle_send_recv_status(_status, "sending", _msg_str)
40 #define viewer_handle_recv_status(_status, _msg_str) \
41 viewer_handle_send_recv_status(_status, "receiving", _msg_str)
43 #define LTTNG_LIVE_CPPLOGE_APPEND_CAUSE_ERRNO(_msg, _fmt, ...) \
45 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection->logger, _msg ": {}" _fmt, \
46 bt_socket_errormsg(), ##__VA_ARGS__); \
49 static inline enum lttng_live_iterator_status
50 viewer_status_to_live_iterator_status(enum lttng_live_viewer_status viewer_status
)
52 switch (viewer_status
) {
53 case LTTNG_LIVE_VIEWER_STATUS_OK
:
54 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
55 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
:
56 return LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
57 case LTTNG_LIVE_VIEWER_STATUS_ERROR
:
58 return LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
64 static inline enum ctf_msg_iter_medium_status
65 viewer_status_to_ctf_msg_iter_medium_status(enum lttng_live_viewer_status viewer_status
)
67 switch (viewer_status
) {
68 case LTTNG_LIVE_VIEWER_STATUS_OK
:
69 return CTF_MSG_ITER_MEDIUM_STATUS_OK
;
70 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
:
71 return CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
;
72 case LTTNG_LIVE_VIEWER_STATUS_ERROR
:
73 return CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
79 static inline void viewer_connection_close_socket(struct live_viewer_connection
*viewer_connection
)
81 int ret
= bt_socket_close(viewer_connection
->control_sock
);
83 BT_CPPLOGW_ERRNO_SPEC(viewer_connection
->logger
,
84 "Error closing viewer connection socket: ", ".");
87 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
91 * This function receives a message from the Relay daemon.
92 * If it received the entire message, it returns _OK,
93 * If it's interrupted, it returns _INTERRUPTED,
94 * otherwise, it returns _ERROR.
96 static enum lttng_live_viewer_status
97 lttng_live_recv(struct live_viewer_connection
*viewer_connection
, void *buf
, size_t len
)
100 size_t total_received
= 0, to_receive
= len
;
101 struct lttng_live_msg_iter
*lttng_live_msg_iter
= viewer_connection
->lttng_live_msg_iter
;
102 enum lttng_live_viewer_status status
;
103 BT_SOCKET sock
= viewer_connection
->control_sock
;
106 * Receive a message from the Relay.
109 received
= bt_socket_recv(sock
, (char *) buf
+ total_received
, to_receive
, 0);
110 if (received
== BT_SOCKET_ERROR
) {
111 if (bt_socket_interrupted()) {
112 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
114 * This interruption was due to a
115 * SIGINT and the graph is being torn
118 status
= LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
;
119 lttng_live_msg_iter
->was_interrupted
= true;
123 * A signal was received, but the graph
124 * is not being torn down. Carry on.
130 * For any other types of socket error, close
131 * the socket and return an error.
133 LTTNG_LIVE_CPPLOGE_APPEND_CAUSE_ERRNO("Error receiving from Relay", ".");
135 viewer_connection_close_socket(viewer_connection
);
136 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
139 } else if (received
== 0) {
141 * The recv() call returned 0. This means the
142 * connection was orderly shutdown from the other peer.
143 * If that happens when we are trying to receive
144 * a message from it, it means something when wrong.
145 * Close the socket and return an error.
147 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
148 "Remote side has closed connection");
149 viewer_connection_close_socket(viewer_connection
);
150 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
154 BT_ASSERT(received
<= to_receive
);
155 total_received
+= received
;
156 to_receive
-= received
;
158 } while (to_receive
> 0);
160 BT_ASSERT(total_received
== len
);
161 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
168 * This function sends a message to the Relay daemon.
169 * If it send the message, it returns _OK,
170 * If it's interrupted, it returns _INTERRUPTED,
171 * otherwise, it returns _ERROR.
173 static enum lttng_live_viewer_status
174 lttng_live_send(struct live_viewer_connection
*viewer_connection
, const void *buf
, size_t len
)
176 enum lttng_live_viewer_status status
;
177 struct lttng_live_msg_iter
*lttng_live_msg_iter
= viewer_connection
->lttng_live_msg_iter
;
178 BT_SOCKET sock
= viewer_connection
->control_sock
;
179 size_t to_send
= len
;
180 ssize_t total_sent
= 0;
183 ssize_t sent
= bt_socket_send_nosigpipe(sock
, (char *) buf
+ total_sent
, to_send
);
184 if (sent
== BT_SOCKET_ERROR
) {
185 if (bt_socket_interrupted()) {
186 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
188 * This interruption was a SIGINT and
189 * the graph is being teared down.
191 status
= LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
;
192 lttng_live_msg_iter
->was_interrupted
= true;
196 * A signal was received, but the graph
197 * is not being teared down. Carry on.
203 * For any other types of socket error, close
204 * the socket and return an error.
206 LTTNG_LIVE_CPPLOGE_APPEND_CAUSE_ERRNO("Error sending to Relay", ".");
208 viewer_connection_close_socket(viewer_connection
);
209 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
214 BT_ASSERT(sent
<= to_send
);
218 } while (to_send
> 0);
220 BT_ASSERT(total_sent
== len
);
221 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
227 static int parse_url(struct live_viewer_connection
*viewer_connection
)
229 char error_buf
[256] = {0};
230 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= {};
232 const char *path
= viewer_connection
->url
->str
;
238 lttng_live_url_parts
= bt_common_parse_lttng_live_url(path
, error_buf
, sizeof(error_buf
));
239 if (!lttng_live_url_parts
.proto
) {
240 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Invalid LTTng live URL format: {}",
244 viewer_connection
->proto
= lttng_live_url_parts
.proto
;
245 lttng_live_url_parts
.proto
= NULL
;
247 viewer_connection
->relay_hostname
= lttng_live_url_parts
.hostname
;
248 lttng_live_url_parts
.hostname
= NULL
;
250 if (lttng_live_url_parts
.port
>= 0) {
251 viewer_connection
->port
= lttng_live_url_parts
.port
;
253 viewer_connection
->port
= LTTNG_DEFAULT_NETWORK_VIEWER_PORT
;
256 viewer_connection
->target_hostname
= lttng_live_url_parts
.target_hostname
;
257 lttng_live_url_parts
.target_hostname
= NULL
;
259 if (lttng_live_url_parts
.session_name
) {
260 viewer_connection
->session_name
= lttng_live_url_parts
.session_name
;
261 lttng_live_url_parts
.session_name
= NULL
;
267 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
271 static enum lttng_live_viewer_status
272 lttng_live_handshake(struct live_viewer_connection
*viewer_connection
)
274 struct lttng_viewer_cmd cmd
;
275 struct lttng_viewer_connect connect
;
276 enum lttng_live_viewer_status status
;
277 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(connect
);
278 char cmd_buf
[cmd_buf_len
];
280 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
281 "Handshaking with the relay daemon: cmd={}, major-version={}, minor-version={}",
282 LTTNG_VIEWER_CONNECT
, LTTNG_LIVE_MAJOR
, LTTNG_LIVE_MINOR
);
284 cmd
.cmd
= htobe32(LTTNG_VIEWER_CONNECT
);
285 cmd
.data_size
= htobe64((uint64_t) sizeof(connect
));
286 cmd
.cmd_version
= htobe32(0);
288 connect
.viewer_session_id
= -1ULL; /* will be set on recv */
289 connect
.major
= htobe32(LTTNG_LIVE_MAJOR
);
290 connect
.minor
= htobe32(LTTNG_LIVE_MINOR
);
291 connect
.type
= htobe32(LTTNG_VIEWER_CLIENT_COMMAND
);
294 * Merge the cmd and connection request to prevent a write-write
295 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
296 * second write to be performed quickly in presence of Nagle's algorithm
298 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
299 memcpy(cmd_buf
+ sizeof(cmd
), &connect
, sizeof(connect
));
301 status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
302 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
303 viewer_handle_send_status(status
, "viewer connect command");
307 status
= lttng_live_recv(viewer_connection
, &connect
, sizeof(connect
));
308 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
309 viewer_handle_recv_status(status
, "viewer connect reply");
313 BT_CPPLOGI_SPEC(viewer_connection
->logger
, "Received viewer session ID : {}",
314 (uint64_t) be64toh(connect
.viewer_session_id
));
315 BT_CPPLOGI_SPEC(viewer_connection
->logger
, "Relayd version : {}.{}", be32toh(connect
.major
),
316 be32toh(connect
.minor
));
318 if (LTTNG_LIVE_MAJOR
!= be32toh(connect
.major
)) {
319 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
320 "Incompatible lttng-relayd protocol");
321 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
324 /* Use the smallest protocol version implemented. */
325 if (LTTNG_LIVE_MINOR
> be32toh(connect
.minor
)) {
326 viewer_connection
->minor
= be32toh(connect
.minor
);
328 viewer_connection
->minor
= LTTNG_LIVE_MINOR
;
330 viewer_connection
->major
= LTTNG_LIVE_MAJOR
;
332 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
340 static enum lttng_live_viewer_status
341 lttng_live_connect_viewer(struct live_viewer_connection
*viewer_connection
)
343 struct hostent
*host
;
344 struct sockaddr_in server_addr
;
345 enum lttng_live_viewer_status status
;
347 if (parse_url(viewer_connection
)) {
348 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Failed to parse URL");
349 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
354 viewer_connection
->logger
,
355 "Connecting to hostname : {}, port : {}, target hostname : {}, session name : {}, proto : {}",
356 viewer_connection
->relay_hostname
->str
, viewer_connection
->port
,
357 !viewer_connection
->target_hostname
? "<none>" : viewer_connection
->target_hostname
->str
,
358 !viewer_connection
->session_name
? "<none>" : viewer_connection
->session_name
->str
,
359 viewer_connection
->proto
->str
);
361 host
= gethostbyname(viewer_connection
->relay_hostname
->str
);
363 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
364 "Cannot lookup hostname: hostname=\"{}\"",
365 viewer_connection
->relay_hostname
->str
);
366 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
370 if ((viewer_connection
->control_sock
= socket(AF_INET
, SOCK_STREAM
, 0)) == BT_INVALID_SOCKET
) {
371 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Socket creation failed: {}",
372 bt_socket_errormsg());
373 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
377 server_addr
.sin_family
= AF_INET
;
378 server_addr
.sin_port
= htons(viewer_connection
->port
);
379 server_addr
.sin_addr
= *((struct in_addr
*) host
->h_addr
);
380 memset(&(server_addr
.sin_zero
), 0, 8);
382 if (connect(viewer_connection
->control_sock
, (struct sockaddr
*) &server_addr
,
383 sizeof(struct sockaddr
)) == BT_SOCKET_ERROR
) {
384 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Connection failed: {}",
385 bt_socket_errormsg());
386 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
390 status
= lttng_live_handshake(viewer_connection
);
393 * Only print error and append cause in case of error. not in case of
396 if (status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
397 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Viewer handshake failed");
399 } else if (status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
406 if (viewer_connection
->control_sock
!= BT_INVALID_SOCKET
) {
407 if (bt_socket_close(viewer_connection
->control_sock
) == BT_SOCKET_ERROR
) {
408 BT_CPPLOGW_SPEC(viewer_connection
->logger
, "Error closing socket: {}.",
409 bt_socket_errormsg());
412 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
417 static void lttng_live_disconnect_viewer(struct live_viewer_connection
*viewer_connection
)
419 if (viewer_connection
->control_sock
== BT_INVALID_SOCKET
) {
422 if (bt_socket_close(viewer_connection
->control_sock
) == BT_SOCKET_ERROR
) {
423 BT_CPPLOGW_SPEC(viewer_connection
->logger
, "Error closing socket: {}",
424 bt_socket_errormsg());
425 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
429 static int list_update_session(bt_value
*results
, const struct lttng_viewer_session
*session
,
430 bool *_found
, struct live_viewer_connection
*viewer_connection
)
434 bt_value
*map
= NULL
;
435 bt_value
*hostname
= NULL
;
436 bt_value
*session_name
= NULL
;
437 bt_value
*btval
= NULL
;
440 len
= bt_value_array_get_length(results
);
441 for (i
= 0; i
< len
; i
++) {
442 const char *hostname_str
= NULL
;
443 const char *session_name_str
= NULL
;
445 map
= bt_value_array_borrow_element_by_index(results
, i
);
446 hostname
= bt_value_map_borrow_entry_value(map
, "target-hostname");
448 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
449 "Error borrowing \"target-hostname\" entry.");
453 session_name
= bt_value_map_borrow_entry_value(map
, "session-name");
455 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
456 "Error borrowing \"session-name\" entry.");
460 hostname_str
= bt_value_string_get(hostname
);
461 session_name_str
= bt_value_string_get(session_name
);
463 if (strcmp(session
->hostname
, hostname_str
) == 0 &&
464 strcmp(session
->session_name
, session_name_str
) == 0) {
466 uint32_t streams
= be32toh(session
->streams
);
467 uint32_t clients
= be32toh(session
->clients
);
471 btval
= bt_value_map_borrow_entry_value(map
, "stream-count");
473 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
474 "Error borrowing \"stream-count\" entry.");
478 val
= bt_value_integer_unsigned_get(btval
);
481 bt_value_integer_unsigned_set(btval
, val
);
483 btval
= bt_value_map_borrow_entry_value(map
, "client-count");
485 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
486 "Error borrowing \"client-count\" entry.");
490 val
= bt_value_integer_unsigned_get(btval
);
492 val
= bt_max_t(int64_t, clients
, val
);
493 bt_value_integer_unsigned_set(btval
, val
);
505 static int list_append_session(bt_value
*results
, GString
*base_url
,
506 const struct lttng_viewer_session
*session
,
507 struct live_viewer_connection
*viewer_connection
)
510 bt_value_map_insert_entry_status insert_status
;
511 bt_value_array_append_element_status append_status
;
512 bt_value
*map
= NULL
;
516 * If the session already exists, add the stream count to it,
517 * and do max of client counts.
519 ret
= list_update_session(results
, session
, &found
, viewer_connection
);
524 map
= bt_value_map_create();
526 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error creating map value.");
531 if (base_url
->len
< 1) {
532 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
533 "Error: base_url length smaller than 1.");
541 insert_status
= bt_value_map_insert_string_entry(
543 fmt::format("{}/host/{}/{}", base_url
->str
, session
->hostname
, session
->session_name
)
545 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
546 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error inserting \"url\" entry.");
552 * key = "target-hostname",
555 insert_status
= bt_value_map_insert_string_entry(map
, "target-hostname", session
->hostname
);
556 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
557 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
558 "Error inserting \"target-hostname\" entry.");
564 * key = "session-name",
567 insert_status
= bt_value_map_insert_string_entry(map
, "session-name", session
->session_name
);
568 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
569 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
570 "Error inserting \"session-name\" entry.");
580 uint32_t live_timer
= be32toh(session
->live_timer
);
582 insert_status
= bt_value_map_insert_unsigned_integer_entry(map
, "timer-us", live_timer
);
583 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
584 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
585 "Error inserting \"timer-us\" entry.");
592 * key = "stream-count",
596 uint32_t streams
= be32toh(session
->streams
);
598 insert_status
= bt_value_map_insert_unsigned_integer_entry(map
, "stream-count", streams
);
599 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
600 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
601 "Error inserting \"stream-count\" entry.");
608 * key = "client-count",
612 uint32_t clients
= be32toh(session
->clients
);
614 insert_status
= bt_value_map_insert_unsigned_integer_entry(map
, "client-count", clients
);
615 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
616 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
617 "Error inserting \"client-count\" entry.");
623 append_status
= bt_value_array_append_element(results
, map
);
624 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
625 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error appending map to results.");
630 BT_VALUE_PUT_REF_AND_RESET(map
);
635 * Data structure returned:
646 * key = "target-hostname",
650 * key = "session-name",
658 * key = "stream-count",
662 * key = "client-count",
670 bt_component_class_query_method_status
671 live_viewer_connection_list_sessions(struct live_viewer_connection
*viewer_connection
,
672 const bt_value
**user_result
)
674 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
675 bt_value
*result
= NULL
;
676 enum lttng_live_viewer_status viewer_status
;
677 struct lttng_viewer_cmd cmd
;
678 struct lttng_viewer_list_sessions list
;
679 uint32_t i
, sessions_count
;
681 result
= bt_value_array_create();
683 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error creating array");
684 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
688 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Requesting list of sessions: cmd={}",
689 LTTNG_VIEWER_LIST_SESSIONS
);
691 cmd
.cmd
= htobe32(LTTNG_VIEWER_LIST_SESSIONS
);
692 cmd
.data_size
= htobe64((uint64_t) 0);
693 cmd
.cmd_version
= htobe32(0);
695 viewer_status
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
696 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
697 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
698 "Error sending list sessions command");
699 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
701 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
702 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
706 viewer_status
= lttng_live_recv(viewer_connection
, &list
, sizeof(list
));
707 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
708 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error receiving session list");
709 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
711 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
712 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
716 sessions_count
= be32toh(list
.sessions_count
);
717 for (i
= 0; i
< sessions_count
; i
++) {
718 struct lttng_viewer_session lsession
;
720 viewer_status
= lttng_live_recv(viewer_connection
, &lsession
, sizeof(lsession
));
721 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
722 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error receiving session:");
723 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
725 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
726 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
730 lsession
.hostname
[LTTNG_VIEWER_HOST_NAME_MAX
- 1] = '\0';
731 lsession
.session_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
732 if (list_append_session(result
, viewer_connection
->url
, &lsession
, viewer_connection
)) {
733 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error appending session");
734 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
739 *user_result
= result
;
742 BT_VALUE_PUT_REF_AND_RESET(result
);
747 static enum lttng_live_viewer_status
748 lttng_live_query_session_ids(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
750 struct lttng_viewer_cmd cmd
;
751 struct lttng_viewer_list_sessions list
;
752 struct lttng_viewer_session lsession
;
753 uint32_t i
, sessions_count
;
755 enum lttng_live_viewer_status status
;
756 struct live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
;
758 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
759 "Asking the relay daemon for the list of sessions: cmd={}",
760 LTTNG_VIEWER_LIST_SESSIONS
);
762 cmd
.cmd
= htobe32(LTTNG_VIEWER_LIST_SESSIONS
);
763 cmd
.data_size
= htobe64((uint64_t) 0);
764 cmd
.cmd_version
= htobe32(0);
766 status
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
767 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
768 viewer_handle_send_status(status
, "list sessions command");
772 status
= lttng_live_recv(viewer_connection
, &list
, sizeof(list
));
773 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
774 viewer_handle_recv_status(status
, "session list reply");
778 sessions_count
= be32toh(list
.sessions_count
);
779 for (i
= 0; i
< sessions_count
; i
++) {
780 status
= lttng_live_recv(viewer_connection
, &lsession
, sizeof(lsession
));
781 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
782 viewer_handle_recv_status(status
, "session reply");
785 lsession
.hostname
[LTTNG_VIEWER_HOST_NAME_MAX
- 1] = '\0';
786 lsession
.session_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
787 session_id
= be64toh(lsession
.id
);
789 BT_CPPLOGI_SPEC(viewer_connection
->logger
,
790 "Adding session to internal list: "
791 "session-id={}, hostname=\"{}\", session-name=\"{}\"",
792 session_id
, lsession
.hostname
, lsession
.session_name
);
794 if ((strncmp(lsession
.session_name
, viewer_connection
->session_name
->str
,
795 LTTNG_VIEWER_NAME_MAX
) == 0) &&
796 (strncmp(lsession
.hostname
, viewer_connection
->target_hostname
->str
,
797 LTTNG_VIEWER_HOST_NAME_MAX
) == 0)) {
798 if (lttng_live_add_session(lttng_live_msg_iter
, session_id
, lsession
.hostname
,
799 lsession
.session_name
)) {
800 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
801 "Failed to add live session");
802 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
808 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
814 enum lttng_live_viewer_status
815 lttng_live_create_viewer_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
817 struct lttng_viewer_cmd cmd
;
818 struct lttng_viewer_create_session_response resp
;
819 enum lttng_live_viewer_status status
;
820 struct live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
;
822 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Creating a viewer session: cmd={}",
823 LTTNG_VIEWER_CREATE_SESSION
);
825 cmd
.cmd
= htobe32(LTTNG_VIEWER_CREATE_SESSION
);
826 cmd
.data_size
= htobe64((uint64_t) 0);
827 cmd
.cmd_version
= htobe32(0);
829 status
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
830 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
831 viewer_handle_send_status(status
, "create session command");
835 status
= lttng_live_recv(viewer_connection
, &resp
, sizeof(resp
));
836 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
837 viewer_handle_recv_status(status
, "create session reply");
841 if (be32toh(resp
.status
) != LTTNG_VIEWER_CREATE_SESSION_OK
) {
842 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error creating viewer session");
843 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
847 status
= lttng_live_query_session_ids(lttng_live_msg_iter
);
848 if (status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
849 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
850 "Failed to query live viewer session ids");
852 } else if (status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
860 static enum lttng_live_viewer_status
receive_streams(struct lttng_live_session
*session
,
861 uint32_t stream_count
,
862 bt_self_message_iterator
*self_msg_iter
)
865 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
866 enum lttng_live_viewer_status status
;
867 struct live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
;
869 BT_CPPLOGI_SPEC(viewer_connection
->logger
, "Getting {} new streams", stream_count
);
870 for (i
= 0; i
< stream_count
; i
++) {
871 struct lttng_viewer_stream stream
;
872 struct lttng_live_stream_iterator
*live_stream
;
874 uint64_t ctf_trace_id
;
876 status
= lttng_live_recv(viewer_connection
, &stream
, sizeof(stream
));
877 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
878 viewer_handle_recv_status(status
, "stream reply");
881 stream
.path_name
[LTTNG_VIEWER_PATH_MAX
- 1] = '\0';
882 stream
.channel_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
883 stream_id
= be64toh(stream
.id
);
884 ctf_trace_id
= be64toh(stream
.ctf_trace_id
);
886 if (stream
.metadata_flag
) {
887 BT_CPPLOGI_SPEC(viewer_connection
->logger
, " metadata stream {} : {}/{}", stream_id
,
888 stream
.path_name
, stream
.channel_name
);
889 if (lttng_live_metadata_create_stream(session
, ctf_trace_id
, stream_id
)) {
890 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
891 "Error creating metadata stream");
892 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
895 session
->lazy_stream_msg_init
= true;
897 BT_CPPLOGI_SPEC(viewer_connection
->logger
, " stream {} : {}/{}", stream_id
,
898 stream
.path_name
, stream
.channel_name
);
900 lttng_live_stream_iterator_create(session
, ctf_trace_id
, stream_id
, self_msg_iter
);
902 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error creating stream");
903 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
908 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
914 enum lttng_live_viewer_status
lttng_live_session_attach(struct lttng_live_session
*session
,
915 bt_self_message_iterator
*self_msg_iter
)
917 struct lttng_viewer_cmd cmd
;
918 enum lttng_live_viewer_status status
;
919 struct lttng_viewer_attach_session_request rq
;
920 struct lttng_viewer_attach_session_response rp
;
921 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
922 struct live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
;
923 uint64_t session_id
= session
->id
;
924 uint32_t streams_count
;
925 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
926 char cmd_buf
[cmd_buf_len
];
928 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
929 "Attaching to session: cmd={}, session-id={}, seek={}",
930 LTTNG_VIEWER_ATTACH_SESSION
, session_id
, LTTNG_VIEWER_SEEK_LAST
);
932 cmd
.cmd
= htobe32(LTTNG_VIEWER_ATTACH_SESSION
);
933 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
934 cmd
.cmd_version
= htobe32(0);
936 memset(&rq
, 0, sizeof(rq
));
937 rq
.session_id
= htobe64(session_id
);
938 // TODO: add cmd line parameter to select seek beginning
939 // rq.seek = htobe32(LTTNG_VIEWER_SEEK_BEGINNING);
940 rq
.seek
= htobe32(LTTNG_VIEWER_SEEK_LAST
);
943 * Merge the cmd and connection request to prevent a write-write
944 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
945 * second write to be performed quickly in presence of Nagle's algorithm.
947 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
948 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
949 status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
950 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
951 viewer_handle_send_status(status
, "attach session command");
955 status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
956 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
957 viewer_handle_recv_status(status
, "attach session reply");
961 streams_count
= be32toh(rp
.streams_count
);
962 switch (be32toh(rp
.status
)) {
963 case LTTNG_VIEWER_ATTACH_OK
:
965 case LTTNG_VIEWER_ATTACH_UNK
:
966 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Session id {} is unknown",
968 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
970 case LTTNG_VIEWER_ATTACH_ALREADY
:
971 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
972 "There is already a viewer attached to this session");
973 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
975 case LTTNG_VIEWER_ATTACH_NOT_LIVE
:
976 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Not a live session");
977 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
979 case LTTNG_VIEWER_ATTACH_SEEK_ERR
:
980 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Wrong seek parameter");
981 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
984 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Unknown attach return code {}",
986 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
990 /* We receive the initial list of streams. */
991 status
= receive_streams(session
, streams_count
, self_msg_iter
);
993 case LTTNG_LIVE_VIEWER_STATUS_OK
:
995 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
:
997 case LTTNG_LIVE_VIEWER_STATUS_ERROR
:
998 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error receiving streams");
1004 session
->attached
= true;
1005 session
->new_streams_needed
= false;
1011 enum lttng_live_viewer_status
lttng_live_session_detach(struct lttng_live_session
*session
)
1013 struct lttng_viewer_cmd cmd
;
1014 enum lttng_live_viewer_status status
;
1015 struct lttng_viewer_detach_session_request rq
;
1016 struct lttng_viewer_detach_session_response rp
;
1017 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
1018 struct live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
;
1019 uint64_t session_id
= session
->id
;
1020 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1021 char cmd_buf
[cmd_buf_len
];
1024 * The session might already be detached and the viewer socket might
1025 * already been closed. This happens when calling this function when
1026 * tearing down the graph after an error.
1028 if (!session
->attached
|| viewer_connection
->control_sock
== BT_INVALID_SOCKET
) {
1029 return LTTNG_LIVE_VIEWER_STATUS_OK
;
1032 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Detaching from session: cmd={}, session-id={}",
1033 LTTNG_VIEWER_DETACH_SESSION
, session_id
);
1035 cmd
.cmd
= htobe32(LTTNG_VIEWER_DETACH_SESSION
);
1036 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1037 cmd
.cmd_version
= htobe32(0);
1039 memset(&rq
, 0, sizeof(rq
));
1040 rq
.session_id
= htobe64(session_id
);
1043 * Merge the cmd and connection request to prevent a write-write
1044 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1045 * second write to be performed quickly in presence of Nagle's algorithm.
1047 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1048 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1049 status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1050 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1051 viewer_handle_send_status(status
, "detach session command");
1055 status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1056 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1057 viewer_handle_recv_status(status
, "detach session reply");
1061 switch (be32toh(rp
.status
)) {
1062 case LTTNG_VIEWER_DETACH_SESSION_OK
:
1064 case LTTNG_VIEWER_DETACH_SESSION_UNK
:
1065 BT_CPPLOGW_SPEC(viewer_connection
->logger
, "Session id {} is unknown", session_id
);
1066 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1068 case LTTNG_VIEWER_DETACH_SESSION_ERR
:
1069 BT_CPPLOGW_SPEC(viewer_connection
->logger
, "Error detaching session id {}", session_id
);
1070 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1073 BT_CPPLOGE_SPEC(viewer_connection
->logger
, "Unknown detach return code {}",
1074 be32toh(rp
.status
));
1075 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1079 session
->attached
= false;
1081 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
1087 enum lttng_live_get_one_metadata_status
1088 lttng_live_get_one_metadata_packet(struct lttng_live_trace
*trace
, std::vector
<char>& buf
)
1091 enum lttng_live_get_one_metadata_status status
;
1092 enum lttng_live_viewer_status viewer_status
;
1093 struct lttng_viewer_cmd cmd
;
1094 struct lttng_viewer_get_metadata rq
;
1095 struct lttng_viewer_metadata_packet rp
;
1096 std::vector
<char> data
;
1097 struct lttng_live_session
*session
= trace
->session
;
1098 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
1099 struct lttng_live_metadata
*metadata
= trace
->metadata
.get();
1100 struct live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
;
1101 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1102 char cmd_buf
[cmd_buf_len
];
1104 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1105 "Requesting new metadata for trace:"
1106 "cmd={}, trace-id={}, metadata-stream-id={}",
1107 LTTNG_VIEWER_GET_METADATA
, trace
->id
, metadata
->stream_id
);
1109 rq
.stream_id
= htobe64(metadata
->stream_id
);
1110 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_METADATA
);
1111 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1112 cmd
.cmd_version
= htobe32(0);
1115 * Merge the cmd and connection request to prevent a write-write
1116 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1117 * second write to be performed quickly in presence of Nagle's algorithm.
1119 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1120 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1121 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1122 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1123 viewer_handle_send_status(viewer_status
, "get metadata command");
1124 status
= (enum lttng_live_get_one_metadata_status
) viewer_status
;
1128 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1129 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1130 viewer_handle_recv_status(viewer_status
, "get metadata reply");
1131 status
= (enum lttng_live_get_one_metadata_status
) viewer_status
;
1135 switch (be32toh(rp
.status
)) {
1136 case LTTNG_VIEWER_METADATA_OK
:
1137 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_metadata response: ok");
1139 case LTTNG_VIEWER_NO_NEW_METADATA
:
1140 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_metadata response: no new");
1141 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_END
;
1143 case LTTNG_VIEWER_METADATA_ERR
:
1145 * The Relayd cannot find this stream id. Maybe its
1146 * gone already. This can happen in short lived UST app
1147 * in a per-pid session.
1149 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_metadata response: error");
1150 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED
;
1153 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1154 "Received get_metadata response: unknown");
1155 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR
;
1159 len
= be64toh(rp
.len
);
1162 * We received a `LTTNG_VIEWER_METADATA_OK` with a packet
1163 * length of 0. This means we must try again. This scenario
1164 * arises when a clear command is performed on an lttng session.
1167 viewer_connection
->logger
,
1168 "Expecting a metadata packet of size 0. Retry to get a packet from the relay.");
1169 goto empty_metadata_packet_retry
;
1172 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Writing {} bytes to metadata", len
);
1174 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Erroneous response length");
1175 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR
;
1181 viewer_status
= lttng_live_recv(viewer_connection
, data
.data(), len
);
1182 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1183 viewer_handle_recv_status(viewer_status
, "get metadata packet");
1184 status
= (enum lttng_live_get_one_metadata_status
) viewer_status
;
1189 * Write the metadata to the file handle.
1191 buf
.insert(buf
.end(), data
.begin(), data
.end());
1193 empty_metadata_packet_retry
:
1194 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK
;
1201 * Assign the fields from a lttng_viewer_index to a packet_index.
1203 static void lttng_index_to_packet_index(struct lttng_viewer_index
*lindex
,
1204 struct packet_index
*pindex
)
1209 pindex
->offset
= be64toh(lindex
->offset
);
1210 pindex
->packet_size
= be64toh(lindex
->packet_size
);
1211 pindex
->content_size
= be64toh(lindex
->content_size
);
1212 pindex
->ts_cycles
.timestamp_begin
= be64toh(lindex
->timestamp_begin
);
1213 pindex
->ts_cycles
.timestamp_end
= be64toh(lindex
->timestamp_end
);
1214 pindex
->events_discarded
= be64toh(lindex
->events_discarded
);
1217 static void lttng_live_need_new_streams(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
1219 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
1220 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1221 "Marking session as needing new streams: "
1224 session
->new_streams_needed
= true;
1228 enum lttng_live_iterator_status
1229 lttng_live_get_next_index(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1230 struct lttng_live_stream_iterator
*stream
, struct packet_index
*index
)
1232 struct lttng_viewer_cmd cmd
;
1233 struct lttng_viewer_get_next_index rq
;
1234 enum lttng_live_viewer_status viewer_status
;
1235 struct lttng_viewer_index rp
;
1236 enum lttng_live_iterator_status status
;
1237 struct live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
;
1238 struct lttng_live_trace
*trace
= stream
->trace
;
1239 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1240 char cmd_buf
[cmd_buf_len
];
1241 uint32_t flags
, rp_status
;
1243 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1244 "Requesting next index for stream: cmd={}, "
1245 "viewer-stream-id={}",
1246 LTTNG_VIEWER_GET_NEXT_INDEX
, stream
->viewer_stream_id
);
1247 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_NEXT_INDEX
);
1248 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1249 cmd
.cmd_version
= htobe32(0);
1251 memset(&rq
, 0, sizeof(rq
));
1252 rq
.stream_id
= htobe64(stream
->viewer_stream_id
);
1255 * Merge the cmd and connection request to prevent a write-write
1256 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1257 * second write to be performed quickly in presence of Nagle's algorithm.
1259 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1260 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1262 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1263 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1264 viewer_handle_send_status(viewer_status
, "get next index command");
1268 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1269 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1270 viewer_handle_recv_status(viewer_status
, "get next index reply");
1274 flags
= be32toh(rp
.flags
);
1275 rp_status
= be32toh(rp
.status
);
1278 viewer_connection
->logger
, "Received response from relay daemon: cmd=%s, response={}",
1279 LTTNG_VIEWER_GET_NEXT_INDEX
, static_cast<lttng_viewer_next_index_return_code
>(rp_status
));
1281 if (flags
& LTTNG_VIEWER_FLAG_NEW_STREAM
) {
1282 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1283 "Marking all sessions as possibly needing new streams: "
1284 "response={}, response-flag=NEW_STREAM",
1285 static_cast<lttng_viewer_next_index_return_code
>(rp_status
));
1286 lttng_live_need_new_streams(lttng_live_msg_iter
);
1289 switch (rp_status
) {
1290 case LTTNG_VIEWER_INDEX_INACTIVE
:
1292 uint64_t ctf_stream_class_id
;
1294 memset(index
, 0, sizeof(struct packet_index
));
1295 index
->ts_cycles
.timestamp_end
= be64toh(rp
.timestamp_end
);
1296 stream
->current_inactivity_ts
= index
->ts_cycles
.timestamp_end
;
1297 ctf_stream_class_id
= be64toh(rp
.stream_id
);
1298 if (stream
->ctf_stream_class_id
.is_set
) {
1299 BT_ASSERT(stream
->ctf_stream_class_id
.value
== ctf_stream_class_id
);
1301 stream
->ctf_stream_class_id
.value
= ctf_stream_class_id
;
1302 stream
->ctf_stream_class_id
.is_set
= true;
1304 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_QUIESCENT
);
1305 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1308 case LTTNG_VIEWER_INDEX_OK
:
1310 uint64_t ctf_stream_class_id
;
1312 lttng_index_to_packet_index(&rp
, index
);
1313 ctf_stream_class_id
= be64toh(rp
.stream_id
);
1314 if (stream
->ctf_stream_class_id
.is_set
) {
1315 BT_ASSERT(stream
->ctf_stream_class_id
.value
== ctf_stream_class_id
);
1317 stream
->ctf_stream_class_id
.value
= ctf_stream_class_id
;
1318 stream
->ctf_stream_class_id
.is_set
= true;
1320 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_DATA
);
1322 if (flags
& LTTNG_VIEWER_FLAG_NEW_METADATA
) {
1323 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1324 "Marking trace as needing new metadata: "
1325 "response={}, response-flag=NEW_METADATA, trace-id={}",
1326 static_cast<lttng_viewer_next_index_return_code
>(rp_status
), trace
->id
);
1327 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
1329 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1332 case LTTNG_VIEWER_INDEX_RETRY
:
1333 memset(index
, 0, sizeof(struct packet_index
));
1334 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
);
1335 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1337 case LTTNG_VIEWER_INDEX_HUP
:
1338 memset(index
, 0, sizeof(struct packet_index
));
1339 index
->offset
= EOF
;
1340 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_EOF
);
1341 stream
->has_stream_hung_up
= true;
1342 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1344 case LTTNG_VIEWER_INDEX_ERR
:
1345 memset(index
, 0, sizeof(struct packet_index
));
1346 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
);
1347 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1350 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1351 "Received get_next_index response: unknown value");
1352 memset(index
, 0, sizeof(struct packet_index
));
1353 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
);
1354 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1361 status
= viewer_status_to_live_iterator_status(viewer_status
);
1366 enum ctf_msg_iter_medium_status
1367 lttng_live_get_stream_bytes(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1368 struct lttng_live_stream_iterator
*stream
, uint8_t *buf
,
1369 uint64_t offset
, uint64_t req_len
, uint64_t *recv_len
)
1371 enum ctf_msg_iter_medium_status status
;
1372 enum lttng_live_viewer_status viewer_status
;
1373 struct lttng_viewer_trace_packet rp
;
1374 struct lttng_viewer_cmd cmd
;
1375 struct lttng_viewer_get_packet rq
;
1376 struct live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
;
1377 struct lttng_live_trace
*trace
= stream
->trace
;
1378 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1379 char cmd_buf
[cmd_buf_len
];
1380 uint32_t flags
, rp_status
;
1382 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1383 "Requesting data from stream: cmd={}, "
1384 "offset={}, request-len={}",
1385 LTTNG_VIEWER_GET_PACKET
, offset
, req_len
);
1387 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_PACKET
);
1388 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1389 cmd
.cmd_version
= htobe32(0);
1391 memset(&rq
, 0, sizeof(rq
));
1392 rq
.stream_id
= htobe64(stream
->viewer_stream_id
);
1393 rq
.offset
= htobe64(offset
);
1394 rq
.len
= htobe32(req_len
);
1397 * Merge the cmd and connection request to prevent a write-write
1398 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1399 * second write to be performed quickly in presence of Nagle's algorithm.
1401 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1402 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1404 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1405 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1406 viewer_handle_send_status(viewer_status
, "get data packet command");
1407 goto error_convert_status
;
1410 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1411 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1412 viewer_handle_recv_status(viewer_status
, "get data packet reply");
1413 goto error_convert_status
;
1416 flags
= be32toh(rp
.flags
);
1417 rp_status
= be32toh(rp
.status
);
1420 viewer_connection
->logger
, "Received response from relay daemon: cmd={}, response={}",
1421 LTTNG_VIEWER_GET_PACKET
, static_cast<lttng_viewer_get_packet_return_code
>(rp_status
));
1422 switch (rp_status
) {
1423 case LTTNG_VIEWER_GET_PACKET_OK
:
1424 req_len
= be32toh(rp
.len
);
1425 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1426 "Got packet from relay daemon: response={}, packet-len={}",
1427 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
), req_len
);
1429 case LTTNG_VIEWER_GET_PACKET_RETRY
:
1430 /* Unimplemented by relay daemon */
1431 status
= CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
;
1433 case LTTNG_VIEWER_GET_PACKET_ERR
:
1434 if (flags
& LTTNG_VIEWER_FLAG_NEW_METADATA
) {
1435 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1436 "Marking trace as needing new metadata: "
1437 "response={}, response-flag=NEW_METADATA, trace-id={}",
1438 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
), trace
->id
);
1439 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
1441 if (flags
& LTTNG_VIEWER_FLAG_NEW_STREAM
) {
1442 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1443 "Marking all sessions as possibly needing new streams: "
1444 "response={}, response-flag=NEW_STREAM",
1445 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
));
1446 lttng_live_need_new_streams(lttng_live_msg_iter
);
1448 if (flags
& (LTTNG_VIEWER_FLAG_NEW_METADATA
| LTTNG_VIEWER_FLAG_NEW_STREAM
)) {
1449 status
= CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
;
1450 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1451 "Reply with any one flags set means we should retry: response={}",
1452 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
));
1455 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1456 "Received get_data_packet response: error");
1457 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
1459 case LTTNG_VIEWER_GET_PACKET_EOF
:
1460 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
1463 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1464 "Received get_data_packet response: unknown ({})", rp_status
);
1465 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
1470 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
1474 viewer_status
= lttng_live_recv(viewer_connection
, buf
, req_len
);
1475 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1476 viewer_handle_recv_status(viewer_status
, "get data packet");
1477 goto error_convert_status
;
1479 *recv_len
= req_len
;
1481 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
1484 error_convert_status
:
1485 status
= viewer_status_to_ctf_msg_iter_medium_status(viewer_status
);
1491 * Request new streams for a session.
1493 enum lttng_live_iterator_status
1494 lttng_live_session_get_new_streams(struct lttng_live_session
*session
,
1495 bt_self_message_iterator
*self_msg_iter
)
1497 enum lttng_live_iterator_status status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1498 struct lttng_viewer_cmd cmd
;
1499 struct lttng_viewer_new_streams_request rq
;
1500 struct lttng_viewer_new_streams_response rp
;
1501 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
1502 enum lttng_live_viewer_status viewer_status
;
1503 struct live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
;
1504 uint32_t streams_count
;
1505 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1506 char cmd_buf
[cmd_buf_len
];
1508 if (!session
->new_streams_needed
) {
1509 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1513 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1514 "Requesting new streams for session: cmd={}, session-id={}",
1515 LTTNG_VIEWER_GET_NEW_STREAMS
, session
->id
);
1517 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_NEW_STREAMS
);
1518 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1519 cmd
.cmd_version
= htobe32(0);
1521 memset(&rq
, 0, sizeof(rq
));
1522 rq
.session_id
= htobe64(session
->id
);
1525 * Merge the cmd and connection request to prevent a write-write
1526 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1527 * second write to be performed quickly in presence of Nagle's algorithm.
1529 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1530 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1532 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1533 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1534 viewer_handle_send_status(viewer_status
, "get new streams command");
1535 status
= viewer_status_to_live_iterator_status(viewer_status
);
1539 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1540 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1541 viewer_handle_recv_status(viewer_status
, "get new streams reply");
1542 status
= viewer_status_to_live_iterator_status(viewer_status
);
1546 streams_count
= be32toh(rp
.streams_count
);
1548 switch (be32toh(rp
.status
)) {
1549 case LTTNG_VIEWER_NEW_STREAMS_OK
:
1550 session
->new_streams_needed
= false;
1552 case LTTNG_VIEWER_NEW_STREAMS_NO_NEW
:
1553 session
->new_streams_needed
= false;
1555 case LTTNG_VIEWER_NEW_STREAMS_HUP
:
1556 session
->new_streams_needed
= false;
1557 session
->closed
= true;
1558 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1560 case LTTNG_VIEWER_NEW_STREAMS_ERR
:
1561 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_new_streams response: error");
1562 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1565 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1566 "Received get_new_streams response: Unknown:"
1568 be32toh(rp
.status
));
1569 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1573 viewer_status
= receive_streams(session
, streams_count
, self_msg_iter
);
1574 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1575 viewer_handle_recv_status(viewer_status
, "new streams");
1576 status
= viewer_status_to_live_iterator_status(viewer_status
);
1580 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1585 enum lttng_live_viewer_status
live_viewer_connection_create(
1586 const char *url
, bool in_query
, struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1587 const bt2c::Logger
& parentLogger
, struct live_viewer_connection
**viewer
)
1589 enum lttng_live_viewer_status status
;
1591 live_viewer_connection
*viewer_connection
= new 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 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1599 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
1600 viewer_connection
->port
= -1;
1601 viewer_connection
->in_query
= in_query
;
1602 viewer_connection
->lttng_live_msg_iter
= lttng_live_msg_iter
;
1603 viewer_connection
->url
= g_string_new(url
);
1604 if (!viewer_connection
->url
) {
1605 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Failed to allocate URL buffer");
1606 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1610 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Establishing connection to url \"{}\"...", url
);
1611 status
= lttng_live_connect_viewer(viewer_connection
);
1613 * Only print error and append cause in case of error. not in case of
1616 if (status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1617 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1618 "Failed to establish connection: "
1622 } else if (status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1625 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Connection to url \"{}\" is established", url
);
1627 *viewer
= viewer_connection
;
1628 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
1632 if (viewer_connection
) {
1633 live_viewer_connection_destroy(viewer_connection
);
1639 void live_viewer_connection_destroy(struct live_viewer_connection
*viewer_connection
)
1641 if (!viewer_connection
) {
1645 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Closing connection to relay: relay-url=\"{}\"",
1646 viewer_connection
->url
->str
);
1648 lttng_live_disconnect_viewer(viewer_connection
);
1650 if (viewer_connection
->url
) {
1651 g_string_free(viewer_connection
->url
, true);
1654 if (viewer_connection
->relay_hostname
) {
1655 g_string_free(viewer_connection
->relay_hostname
, true);
1658 if (viewer_connection
->target_hostname
) {
1659 g_string_free(viewer_connection
->target_hostname
, true);
1662 if (viewer_connection
->session_name
) {
1663 g_string_free(viewer_connection
->session_name
, true);
1666 if (viewer_connection
->proto
) {
1667 g_string_free(viewer_connection
->proto
, true);
1670 delete viewer_connection
;