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(const bt2::ArrayValue results
,
431 const struct lttng_viewer_session
*session
, bool *_found
,
432 struct live_viewer_connection
*viewer_connection
)
436 for (const auto value
: results
) {
437 const auto map
= value
.asMap();
438 const auto hostnameVal
= map
["target-hostname"];
441 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
442 "Error borrowing \"target-hostname\" entry.");
446 const auto sessionNameVal
= map
["session-name"];
448 if (!sessionNameVal
) {
449 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
450 "Error borrowing \"session-name\" entry.");
454 const auto hostname_str
= hostnameVal
->asString().value();
455 const auto session_name_str
= sessionNameVal
->asString().value();
457 if (strcmp(session
->hostname
, hostname_str
) == 0 &&
458 strcmp(session
->session_name
, session_name_str
) == 0) {
459 uint32_t streams
= be32toh(session
->streams
);
460 uint32_t clients
= be32toh(session
->clients
);
464 const auto streamCountVal
= map
["stream-count"];
466 if (!streamCountVal
) {
467 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
468 "Error borrowing \"stream-count\" entry.");
472 auto val
= streamCountVal
->asUnsignedInteger().value();
476 streamCountVal
->asUnsignedInteger().value(val
);
478 const auto clientCountVal
= map
["client-count"];
480 if (!clientCountVal
) {
481 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
482 "Error borrowing \"client-count\" entry.");
486 val
= clientCountVal
->asUnsignedInteger().value();
489 val
= std::max
<uint64_t>(clients
, val
);
490 clientCountVal
->asUnsignedInteger().value(val
);
502 static int list_append_session(const bt2::ArrayValue results
, const std::string
& base_url
,
503 const struct lttng_viewer_session
*session
,
504 struct live_viewer_connection
*viewer_connection
)
510 * If the session already exists, add the stream count to it,
511 * and do max of client counts.
513 ret
= list_update_session(results
, session
, &found
, viewer_connection
);
518 const auto map
= bt2::MapValue::create();
520 if (base_url
.empty()) {
521 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error: base_url empty.");
530 fmt::format("{}/host/{}/{}", base_url
, session
->hostname
, session
->session_name
));
533 * key = "target-hostname",
536 map
->insert("target-hostname", session
->hostname
);
539 * key = "session-name",
542 map
->insert("session-name", session
->session_name
);
549 uint32_t live_timer
= be32toh(session
->live_timer
);
551 map
->insert("timer-us", (uint64_t) live_timer
);
555 * key = "stream-count",
559 uint32_t streams
= be32toh(session
->streams
);
561 map
->insert("stream-count", (uint64_t) streams
);
565 * key = "client-count",
569 uint32_t clients
= be32toh(session
->clients
);
571 map
->insert("client-count", (uint64_t) clients
);
574 results
.append(*map
);
579 * Data structure returned:
590 * key = "target-hostname",
594 * key = "session-name",
602 * key = "stream-count",
606 * key = "client-count",
615 live_viewer_connection_list_sessions(struct live_viewer_connection
*viewer_connection
)
617 enum lttng_live_viewer_status viewer_status
;
618 struct lttng_viewer_cmd cmd
;
619 struct lttng_viewer_list_sessions list
;
620 uint32_t i
, sessions_count
;
621 auto result
= bt2::ArrayValue::create();
623 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Requesting list of sessions: cmd={}",
624 LTTNG_VIEWER_LIST_SESSIONS
);
626 cmd
.cmd
= htobe32(LTTNG_VIEWER_LIST_SESSIONS
);
627 cmd
.data_size
= htobe64((uint64_t) 0);
628 cmd
.cmd_version
= htobe32(0);
630 viewer_status
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
631 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
632 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(viewer_connection
->logger
, bt2::Error
,
633 "Error sending list sessions command");
634 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
635 throw bt2c::TryAgain
{};
638 viewer_status
= lttng_live_recv(viewer_connection
, &list
, sizeof(list
));
639 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
640 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(viewer_connection
->logger
, bt2::Error
,
641 "Error receiving session list");
642 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
643 throw bt2c::TryAgain
{};
646 sessions_count
= be32toh(list
.sessions_count
);
647 for (i
= 0; i
< sessions_count
; i
++) {
648 struct lttng_viewer_session lsession
;
650 viewer_status
= lttng_live_recv(viewer_connection
, &lsession
, sizeof(lsession
));
651 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
652 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(viewer_connection
->logger
, bt2::Error
,
653 "Error receiving session:");
654 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
655 throw bt2c::TryAgain
{};
658 lsession
.hostname
[LTTNG_VIEWER_HOST_NAME_MAX
- 1] = '\0';
659 lsession
.session_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
660 if (list_append_session(*result
, viewer_connection
->url
, &lsession
, viewer_connection
)) {
661 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(viewer_connection
->logger
, bt2::Error
,
662 "Error appending session");
669 static enum lttng_live_viewer_status
670 lttng_live_query_session_ids(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
672 struct lttng_viewer_cmd cmd
;
673 struct lttng_viewer_list_sessions list
;
674 struct lttng_viewer_session lsession
;
675 uint32_t i
, sessions_count
;
677 enum lttng_live_viewer_status status
;
678 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
680 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
681 "Asking the relay daemon for the list of sessions: cmd={}",
682 LTTNG_VIEWER_LIST_SESSIONS
);
684 cmd
.cmd
= htobe32(LTTNG_VIEWER_LIST_SESSIONS
);
685 cmd
.data_size
= htobe64((uint64_t) 0);
686 cmd
.cmd_version
= htobe32(0);
688 status
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
689 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
690 viewer_handle_send_status(status
, "list sessions command");
694 status
= lttng_live_recv(viewer_connection
, &list
, sizeof(list
));
695 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
696 viewer_handle_recv_status(status
, "session list reply");
700 sessions_count
= be32toh(list
.sessions_count
);
701 for (i
= 0; i
< sessions_count
; i
++) {
702 status
= lttng_live_recv(viewer_connection
, &lsession
, sizeof(lsession
));
703 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
704 viewer_handle_recv_status(status
, "session reply");
707 lsession
.hostname
[LTTNG_VIEWER_HOST_NAME_MAX
- 1] = '\0';
708 lsession
.session_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
709 session_id
= be64toh(lsession
.id
);
711 BT_CPPLOGI_SPEC(viewer_connection
->logger
,
712 "Adding session to internal list: "
713 "session-id={}, hostname=\"{}\", session-name=\"{}\"",
714 session_id
, lsession
.hostname
, lsession
.session_name
);
716 if ((strncmp(lsession
.session_name
, viewer_connection
->session_name
->str
,
717 LTTNG_VIEWER_NAME_MAX
) == 0) &&
718 (strncmp(lsession
.hostname
, viewer_connection
->target_hostname
->str
,
719 LTTNG_VIEWER_HOST_NAME_MAX
) == 0)) {
720 if (lttng_live_add_session(lttng_live_msg_iter
, session_id
, lsession
.hostname
,
721 lsession
.session_name
)) {
722 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
723 "Failed to add live session");
724 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
730 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
736 enum lttng_live_viewer_status
737 lttng_live_create_viewer_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
739 struct lttng_viewer_cmd cmd
;
740 struct lttng_viewer_create_session_response resp
;
741 enum lttng_live_viewer_status status
;
742 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
744 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Creating a viewer session: cmd={}",
745 LTTNG_VIEWER_CREATE_SESSION
);
747 cmd
.cmd
= htobe32(LTTNG_VIEWER_CREATE_SESSION
);
748 cmd
.data_size
= htobe64((uint64_t) 0);
749 cmd
.cmd_version
= htobe32(0);
751 status
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
752 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
753 viewer_handle_send_status(status
, "create session command");
757 status
= lttng_live_recv(viewer_connection
, &resp
, sizeof(resp
));
758 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
759 viewer_handle_recv_status(status
, "create session reply");
763 if (be32toh(resp
.status
) != LTTNG_VIEWER_CREATE_SESSION_OK
) {
764 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error creating viewer session");
765 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
769 status
= lttng_live_query_session_ids(lttng_live_msg_iter
);
770 if (status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
771 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
772 "Failed to query live viewer session ids");
774 } else if (status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
782 static enum lttng_live_viewer_status
receive_streams(struct lttng_live_session
*session
,
783 uint32_t stream_count
,
784 bt_self_message_iterator
*self_msg_iter
)
787 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
788 enum lttng_live_viewer_status status
;
789 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
791 BT_CPPLOGI_SPEC(viewer_connection
->logger
, "Getting {} new streams", stream_count
);
792 for (i
= 0; i
< stream_count
; i
++) {
793 struct lttng_viewer_stream stream
;
794 struct lttng_live_stream_iterator
*live_stream
;
796 uint64_t ctf_trace_id
;
798 status
= lttng_live_recv(viewer_connection
, &stream
, sizeof(stream
));
799 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
800 viewer_handle_recv_status(status
, "stream reply");
803 stream
.path_name
[LTTNG_VIEWER_PATH_MAX
- 1] = '\0';
804 stream
.channel_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
805 stream_id
= be64toh(stream
.id
);
806 ctf_trace_id
= be64toh(stream
.ctf_trace_id
);
808 if (stream
.metadata_flag
) {
809 BT_CPPLOGI_SPEC(viewer_connection
->logger
, " metadata stream {} : {}/{}", stream_id
,
810 stream
.path_name
, stream
.channel_name
);
811 if (lttng_live_metadata_create_stream(session
, ctf_trace_id
, stream_id
)) {
812 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
813 "Error creating metadata stream");
814 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
817 session
->lazy_stream_msg_init
= true;
819 BT_CPPLOGI_SPEC(viewer_connection
->logger
, " stream {} : {}/{}", stream_id
,
820 stream
.path_name
, stream
.channel_name
);
822 lttng_live_stream_iterator_create(session
, ctf_trace_id
, stream_id
, self_msg_iter
);
824 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error creating stream");
825 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
830 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
836 enum lttng_live_viewer_status
lttng_live_session_attach(struct lttng_live_session
*session
,
837 bt_self_message_iterator
*self_msg_iter
)
839 struct lttng_viewer_cmd cmd
;
840 enum lttng_live_viewer_status status
;
841 struct lttng_viewer_attach_session_request rq
;
842 struct lttng_viewer_attach_session_response rp
;
843 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
844 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
845 uint64_t session_id
= session
->id
;
846 uint32_t streams_count
;
847 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
848 char cmd_buf
[cmd_buf_len
];
850 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
851 "Attaching to session: cmd={}, session-id={}, seek={}",
852 LTTNG_VIEWER_ATTACH_SESSION
, session_id
, LTTNG_VIEWER_SEEK_LAST
);
854 cmd
.cmd
= htobe32(LTTNG_VIEWER_ATTACH_SESSION
);
855 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
856 cmd
.cmd_version
= htobe32(0);
858 memset(&rq
, 0, sizeof(rq
));
859 rq
.session_id
= htobe64(session_id
);
860 // TODO: add cmd line parameter to select seek beginning
861 // rq.seek = htobe32(LTTNG_VIEWER_SEEK_BEGINNING);
862 rq
.seek
= htobe32(LTTNG_VIEWER_SEEK_LAST
);
865 * Merge the cmd and connection request to prevent a write-write
866 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
867 * second write to be performed quickly in presence of Nagle's algorithm.
869 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
870 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
871 status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
872 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
873 viewer_handle_send_status(status
, "attach session command");
877 status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
878 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
879 viewer_handle_recv_status(status
, "attach session reply");
883 streams_count
= be32toh(rp
.streams_count
);
884 switch (be32toh(rp
.status
)) {
885 case LTTNG_VIEWER_ATTACH_OK
:
887 case LTTNG_VIEWER_ATTACH_UNK
:
888 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Session id {} is unknown",
890 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
892 case LTTNG_VIEWER_ATTACH_ALREADY
:
893 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
894 "There is already a viewer attached to this session");
895 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
897 case LTTNG_VIEWER_ATTACH_NOT_LIVE
:
898 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Not a live session");
899 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
901 case LTTNG_VIEWER_ATTACH_SEEK_ERR
:
902 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Wrong seek parameter");
903 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
906 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Unknown attach return code {}",
908 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
912 /* We receive the initial list of streams. */
913 status
= receive_streams(session
, streams_count
, self_msg_iter
);
915 case LTTNG_LIVE_VIEWER_STATUS_OK
:
917 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
:
919 case LTTNG_LIVE_VIEWER_STATUS_ERROR
:
920 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Error receiving streams");
926 session
->attached
= true;
927 session
->new_streams_needed
= false;
933 enum lttng_live_viewer_status
lttng_live_session_detach(struct lttng_live_session
*session
)
935 struct lttng_viewer_cmd cmd
;
936 enum lttng_live_viewer_status status
;
937 struct lttng_viewer_detach_session_request rq
;
938 struct lttng_viewer_detach_session_response rp
;
939 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
940 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
941 uint64_t session_id
= session
->id
;
942 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
943 char cmd_buf
[cmd_buf_len
];
946 * The session might already be detached and the viewer socket might
947 * already been closed. This happens when calling this function when
948 * tearing down the graph after an error.
950 if (!session
->attached
|| viewer_connection
->control_sock
== BT_INVALID_SOCKET
) {
951 return LTTNG_LIVE_VIEWER_STATUS_OK
;
954 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Detaching from session: cmd={}, session-id={}",
955 LTTNG_VIEWER_DETACH_SESSION
, session_id
);
957 cmd
.cmd
= htobe32(LTTNG_VIEWER_DETACH_SESSION
);
958 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
959 cmd
.cmd_version
= htobe32(0);
961 memset(&rq
, 0, sizeof(rq
));
962 rq
.session_id
= htobe64(session_id
);
965 * Merge the cmd and connection request to prevent a write-write
966 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
967 * second write to be performed quickly in presence of Nagle's algorithm.
969 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
970 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
971 status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
972 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
973 viewer_handle_send_status(status
, "detach session command");
977 status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
978 if (status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
979 viewer_handle_recv_status(status
, "detach session reply");
983 switch (be32toh(rp
.status
)) {
984 case LTTNG_VIEWER_DETACH_SESSION_OK
:
986 case LTTNG_VIEWER_DETACH_SESSION_UNK
:
987 BT_CPPLOGW_SPEC(viewer_connection
->logger
, "Session id {} is unknown", session_id
);
988 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
990 case LTTNG_VIEWER_DETACH_SESSION_ERR
:
991 BT_CPPLOGW_SPEC(viewer_connection
->logger
, "Error detaching session id {}", session_id
);
992 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
995 BT_CPPLOGE_SPEC(viewer_connection
->logger
, "Unknown detach return code {}",
997 status
= LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1001 session
->attached
= false;
1003 status
= LTTNG_LIVE_VIEWER_STATUS_OK
;
1009 enum lttng_live_get_one_metadata_status
1010 lttng_live_get_one_metadata_packet(struct lttng_live_trace
*trace
, std::vector
<char>& buf
)
1013 enum lttng_live_get_one_metadata_status status
;
1014 enum lttng_live_viewer_status viewer_status
;
1015 struct lttng_viewer_cmd cmd
;
1016 struct lttng_viewer_get_metadata rq
;
1017 struct lttng_viewer_metadata_packet rp
;
1018 std::vector
<char> data
;
1019 struct lttng_live_session
*session
= trace
->session
;
1020 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
1021 struct lttng_live_metadata
*metadata
= trace
->metadata
.get();
1022 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
1023 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1024 char cmd_buf
[cmd_buf_len
];
1026 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1027 "Requesting new metadata for trace:"
1028 "cmd={}, trace-id={}, metadata-stream-id={}",
1029 LTTNG_VIEWER_GET_METADATA
, trace
->id
, metadata
->stream_id
);
1031 rq
.stream_id
= htobe64(metadata
->stream_id
);
1032 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_METADATA
);
1033 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1034 cmd
.cmd_version
= htobe32(0);
1037 * Merge the cmd and connection request to prevent a write-write
1038 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1039 * second write to be performed quickly in presence of Nagle's algorithm.
1041 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1042 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1043 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1044 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1045 viewer_handle_send_status(viewer_status
, "get metadata command");
1046 status
= (enum lttng_live_get_one_metadata_status
) viewer_status
;
1050 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1051 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1052 viewer_handle_recv_status(viewer_status
, "get metadata reply");
1053 status
= (enum lttng_live_get_one_metadata_status
) viewer_status
;
1057 switch (be32toh(rp
.status
)) {
1058 case LTTNG_VIEWER_METADATA_OK
:
1059 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_metadata response: ok");
1061 case LTTNG_VIEWER_NO_NEW_METADATA
:
1062 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_metadata response: no new");
1063 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_END
;
1065 case LTTNG_VIEWER_METADATA_ERR
:
1067 * The Relayd cannot find this stream id. Maybe its
1068 * gone already. This can happen in short lived UST app
1069 * in a per-pid session.
1071 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_metadata response: error");
1072 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED
;
1075 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1076 "Received get_metadata response: unknown");
1077 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR
;
1081 len
= be64toh(rp
.len
);
1084 * We received a `LTTNG_VIEWER_METADATA_OK` with a packet
1085 * length of 0. This means we must try again. This scenario
1086 * arises when a clear command is performed on an lttng session.
1089 viewer_connection
->logger
,
1090 "Expecting a metadata packet of size 0. Retry to get a packet from the relay.");
1091 goto empty_metadata_packet_retry
;
1094 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Writing {} bytes to metadata", len
);
1096 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Erroneous response length");
1097 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR
;
1103 viewer_status
= lttng_live_recv(viewer_connection
, data
.data(), len
);
1104 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1105 viewer_handle_recv_status(viewer_status
, "get metadata packet");
1106 status
= (enum lttng_live_get_one_metadata_status
) viewer_status
;
1111 * Write the metadata to the file handle.
1113 buf
.insert(buf
.end(), data
.begin(), data
.end());
1115 empty_metadata_packet_retry
:
1116 status
= LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK
;
1123 * Assign the fields from a lttng_viewer_index to a packet_index.
1125 static void lttng_index_to_packet_index(struct lttng_viewer_index
*lindex
,
1126 struct packet_index
*pindex
)
1131 pindex
->offset
= be64toh(lindex
->offset
);
1132 pindex
->packet_size
= be64toh(lindex
->packet_size
);
1133 pindex
->content_size
= be64toh(lindex
->content_size
);
1134 pindex
->ts_cycles
.timestamp_begin
= be64toh(lindex
->timestamp_begin
);
1135 pindex
->ts_cycles
.timestamp_end
= be64toh(lindex
->timestamp_end
);
1136 pindex
->events_discarded
= be64toh(lindex
->events_discarded
);
1139 static void lttng_live_need_new_streams(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
1141 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
1142 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1143 "Marking session as needing new streams: "
1146 session
->new_streams_needed
= true;
1150 enum lttng_live_iterator_status
1151 lttng_live_get_next_index(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1152 struct lttng_live_stream_iterator
*stream
, struct packet_index
*index
)
1154 struct lttng_viewer_cmd cmd
;
1155 struct lttng_viewer_get_next_index rq
;
1156 enum lttng_live_viewer_status viewer_status
;
1157 struct lttng_viewer_index rp
;
1158 enum lttng_live_iterator_status status
;
1159 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
1160 struct lttng_live_trace
*trace
= stream
->trace
;
1161 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1162 char cmd_buf
[cmd_buf_len
];
1163 uint32_t flags
, rp_status
;
1165 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1166 "Requesting next index for stream: cmd={}, "
1167 "viewer-stream-id={}",
1168 LTTNG_VIEWER_GET_NEXT_INDEX
, stream
->viewer_stream_id
);
1169 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_NEXT_INDEX
);
1170 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1171 cmd
.cmd_version
= htobe32(0);
1173 memset(&rq
, 0, sizeof(rq
));
1174 rq
.stream_id
= htobe64(stream
->viewer_stream_id
);
1177 * Merge the cmd and connection request to prevent a write-write
1178 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1179 * second write to be performed quickly in presence of Nagle's algorithm.
1181 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1182 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1184 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1185 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1186 viewer_handle_send_status(viewer_status
, "get next index command");
1190 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1191 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1192 viewer_handle_recv_status(viewer_status
, "get next index reply");
1196 flags
= be32toh(rp
.flags
);
1197 rp_status
= be32toh(rp
.status
);
1200 viewer_connection
->logger
, "Received response from relay daemon: cmd=%s, response={}",
1201 LTTNG_VIEWER_GET_NEXT_INDEX
, static_cast<lttng_viewer_next_index_return_code
>(rp_status
));
1203 if (flags
& LTTNG_VIEWER_FLAG_NEW_STREAM
) {
1204 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1205 "Marking all sessions as possibly needing new streams: "
1206 "response={}, response-flag=NEW_STREAM",
1207 static_cast<lttng_viewer_next_index_return_code
>(rp_status
));
1208 lttng_live_need_new_streams(lttng_live_msg_iter
);
1211 switch (rp_status
) {
1212 case LTTNG_VIEWER_INDEX_INACTIVE
:
1214 uint64_t ctf_stream_class_id
;
1216 memset(index
, 0, sizeof(struct packet_index
));
1217 index
->ts_cycles
.timestamp_end
= be64toh(rp
.timestamp_end
);
1218 stream
->current_inactivity_ts
= index
->ts_cycles
.timestamp_end
;
1219 ctf_stream_class_id
= be64toh(rp
.stream_id
);
1220 if (stream
->ctf_stream_class_id
.is_set
) {
1221 BT_ASSERT(stream
->ctf_stream_class_id
.value
== ctf_stream_class_id
);
1223 stream
->ctf_stream_class_id
.value
= ctf_stream_class_id
;
1224 stream
->ctf_stream_class_id
.is_set
= true;
1226 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_QUIESCENT
);
1227 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1230 case LTTNG_VIEWER_INDEX_OK
:
1232 uint64_t ctf_stream_class_id
;
1234 lttng_index_to_packet_index(&rp
, index
);
1235 ctf_stream_class_id
= be64toh(rp
.stream_id
);
1236 if (stream
->ctf_stream_class_id
.is_set
) {
1237 BT_ASSERT(stream
->ctf_stream_class_id
.value
== ctf_stream_class_id
);
1239 stream
->ctf_stream_class_id
.value
= ctf_stream_class_id
;
1240 stream
->ctf_stream_class_id
.is_set
= true;
1242 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_DATA
);
1244 if (flags
& LTTNG_VIEWER_FLAG_NEW_METADATA
) {
1245 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1246 "Marking trace as needing new metadata: "
1247 "response={}, response-flag=NEW_METADATA, trace-id={}",
1248 static_cast<lttng_viewer_next_index_return_code
>(rp_status
), trace
->id
);
1249 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
1251 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1254 case LTTNG_VIEWER_INDEX_RETRY
:
1255 memset(index
, 0, sizeof(struct packet_index
));
1256 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
);
1257 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1259 case LTTNG_VIEWER_INDEX_HUP
:
1260 memset(index
, 0, sizeof(struct packet_index
));
1261 index
->offset
= EOF
;
1262 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_EOF
);
1263 stream
->has_stream_hung_up
= true;
1264 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1266 case LTTNG_VIEWER_INDEX_ERR
:
1267 memset(index
, 0, sizeof(struct packet_index
));
1268 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
);
1269 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1272 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1273 "Received get_next_index response: unknown value");
1274 memset(index
, 0, sizeof(struct packet_index
));
1275 lttng_live_stream_iterator_set_state(stream
, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
);
1276 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1283 status
= viewer_status_to_live_iterator_status(viewer_status
);
1288 enum ctf_msg_iter_medium_status
1289 lttng_live_get_stream_bytes(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1290 struct lttng_live_stream_iterator
*stream
, uint8_t *buf
,
1291 uint64_t offset
, uint64_t req_len
, uint64_t *recv_len
)
1293 enum ctf_msg_iter_medium_status status
;
1294 enum lttng_live_viewer_status viewer_status
;
1295 struct lttng_viewer_trace_packet rp
;
1296 struct lttng_viewer_cmd cmd
;
1297 struct lttng_viewer_get_packet rq
;
1298 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
1299 struct lttng_live_trace
*trace
= stream
->trace
;
1300 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1301 char cmd_buf
[cmd_buf_len
];
1302 uint32_t flags
, rp_status
;
1304 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1305 "Requesting data from stream: cmd={}, "
1306 "offset={}, request-len={}",
1307 LTTNG_VIEWER_GET_PACKET
, offset
, req_len
);
1309 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_PACKET
);
1310 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1311 cmd
.cmd_version
= htobe32(0);
1313 memset(&rq
, 0, sizeof(rq
));
1314 rq
.stream_id
= htobe64(stream
->viewer_stream_id
);
1315 rq
.offset
= htobe64(offset
);
1316 rq
.len
= htobe32(req_len
);
1319 * Merge the cmd and connection request to prevent a write-write
1320 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1321 * second write to be performed quickly in presence of Nagle's algorithm.
1323 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1324 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1326 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1327 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1328 viewer_handle_send_status(viewer_status
, "get data packet command");
1329 goto error_convert_status
;
1332 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1333 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1334 viewer_handle_recv_status(viewer_status
, "get data packet reply");
1335 goto error_convert_status
;
1338 flags
= be32toh(rp
.flags
);
1339 rp_status
= be32toh(rp
.status
);
1342 viewer_connection
->logger
, "Received response from relay daemon: cmd={}, response={}",
1343 LTTNG_VIEWER_GET_PACKET
, static_cast<lttng_viewer_get_packet_return_code
>(rp_status
));
1344 switch (rp_status
) {
1345 case LTTNG_VIEWER_GET_PACKET_OK
:
1346 req_len
= be32toh(rp
.len
);
1347 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1348 "Got packet from relay daemon: response={}, packet-len={}",
1349 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
), req_len
);
1351 case LTTNG_VIEWER_GET_PACKET_RETRY
:
1352 /* Unimplemented by relay daemon */
1353 status
= CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
;
1355 case LTTNG_VIEWER_GET_PACKET_ERR
:
1356 if (flags
& LTTNG_VIEWER_FLAG_NEW_METADATA
) {
1357 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1358 "Marking trace as needing new metadata: "
1359 "response={}, response-flag=NEW_METADATA, trace-id={}",
1360 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
), trace
->id
);
1361 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
1363 if (flags
& LTTNG_VIEWER_FLAG_NEW_STREAM
) {
1364 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1365 "Marking all sessions as possibly needing new streams: "
1366 "response={}, response-flag=NEW_STREAM",
1367 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
));
1368 lttng_live_need_new_streams(lttng_live_msg_iter
);
1370 if (flags
& (LTTNG_VIEWER_FLAG_NEW_METADATA
| LTTNG_VIEWER_FLAG_NEW_STREAM
)) {
1371 status
= CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
;
1372 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1373 "Reply with any one flags set means we should retry: response={}",
1374 static_cast<lttng_viewer_get_packet_return_code
>(rp_status
));
1377 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1378 "Received get_data_packet response: error");
1379 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
1381 case LTTNG_VIEWER_GET_PACKET_EOF
:
1382 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
1385 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1386 "Received get_data_packet response: unknown ({})", rp_status
);
1387 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
1392 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
1396 viewer_status
= lttng_live_recv(viewer_connection
, buf
, req_len
);
1397 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1398 viewer_handle_recv_status(viewer_status
, "get data packet");
1399 goto error_convert_status
;
1401 *recv_len
= req_len
;
1403 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
1406 error_convert_status
:
1407 status
= viewer_status_to_ctf_msg_iter_medium_status(viewer_status
);
1413 * Request new streams for a session.
1415 enum lttng_live_iterator_status
1416 lttng_live_session_get_new_streams(struct lttng_live_session
*session
,
1417 bt_self_message_iterator
*self_msg_iter
)
1419 enum lttng_live_iterator_status status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1420 struct lttng_viewer_cmd cmd
;
1421 struct lttng_viewer_new_streams_request rq
;
1422 struct lttng_viewer_new_streams_response rp
;
1423 struct lttng_live_msg_iter
*lttng_live_msg_iter
= session
->lttng_live_msg_iter
;
1424 enum lttng_live_viewer_status viewer_status
;
1425 live_viewer_connection
*viewer_connection
= lttng_live_msg_iter
->viewer_connection
.get();
1426 uint32_t streams_count
;
1427 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1428 char cmd_buf
[cmd_buf_len
];
1430 if (!session
->new_streams_needed
) {
1431 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1435 BT_CPPLOGD_SPEC(viewer_connection
->logger
,
1436 "Requesting new streams for session: cmd={}, session-id={}",
1437 LTTNG_VIEWER_GET_NEW_STREAMS
, session
->id
);
1439 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_NEW_STREAMS
);
1440 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1441 cmd
.cmd_version
= htobe32(0);
1443 memset(&rq
, 0, sizeof(rq
));
1444 rq
.session_id
= htobe64(session
->id
);
1447 * Merge the cmd and connection request to prevent a write-write
1448 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1449 * second write to be performed quickly in presence of Nagle's algorithm.
1451 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1452 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1454 viewer_status
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1455 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1456 viewer_handle_send_status(viewer_status
, "get new streams command");
1457 status
= viewer_status_to_live_iterator_status(viewer_status
);
1461 viewer_status
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1462 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1463 viewer_handle_recv_status(viewer_status
, "get new streams reply");
1464 status
= viewer_status_to_live_iterator_status(viewer_status
);
1468 streams_count
= be32toh(rp
.streams_count
);
1470 switch (be32toh(rp
.status
)) {
1471 case LTTNG_VIEWER_NEW_STREAMS_OK
:
1472 session
->new_streams_needed
= false;
1474 case LTTNG_VIEWER_NEW_STREAMS_NO_NEW
:
1475 session
->new_streams_needed
= false;
1477 case LTTNG_VIEWER_NEW_STREAMS_HUP
:
1478 session
->new_streams_needed
= false;
1479 session
->closed
= true;
1480 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1482 case LTTNG_VIEWER_NEW_STREAMS_ERR
:
1483 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Received get_new_streams response: error");
1484 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1487 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1488 "Received get_new_streams response: Unknown:"
1490 be32toh(rp
.status
));
1491 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1495 viewer_status
= receive_streams(session
, streams_count
, self_msg_iter
);
1496 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1497 viewer_handle_recv_status(viewer_status
, "new streams");
1498 status
= viewer_status_to_live_iterator_status(viewer_status
);
1502 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1507 enum lttng_live_viewer_status
1508 live_viewer_connection_create(const char *url
, bool in_query
,
1509 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1510 const bt2c::Logger
& parentLogger
, live_viewer_connection::UP
& viewer
)
1512 auto viewer_connection
= bt2s::make_unique
<live_viewer_connection
>(parentLogger
);
1514 if (bt_socket_init(viewer_connection
->logger
) != 0) {
1515 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
, "Failed to init socket");
1516 return LTTNG_LIVE_VIEWER_STATUS_ERROR
;
1519 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
1520 viewer_connection
->port
= -1;
1521 viewer_connection
->in_query
= in_query
;
1522 viewer_connection
->lttng_live_msg_iter
= lttng_live_msg_iter
;
1523 viewer_connection
->url
= url
;
1525 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Establishing connection to url \"{}\"...", url
);
1526 const auto status
= lttng_live_connect_viewer(viewer_connection
.get());
1529 * Only print error and append cause in case of error. not in case of
1532 if (status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1533 BT_CPPLOGE_APPEND_CAUSE_SPEC(viewer_connection
->logger
,
1534 "Failed to establish connection: "
1538 } else if (status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1541 BT_CPPLOGD_SPEC(viewer_connection
->logger
, "Connection to url \"{}\" is established", url
);
1543 viewer
= std::move(viewer_connection
);
1544 return LTTNG_LIVE_VIEWER_STATUS_OK
;
1547 live_viewer_connection::~live_viewer_connection()
1549 BT_CPPLOGD_SPEC(this->logger
, "Closing connection to relay: relay-url=\"{}\"", this->url
);
1551 lttng_live_disconnect_viewer(this);