2 * Copyright 2016 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 #define BT_LOG_TAG "PLUGIN-CTF-LTTNG-LIVE-SRC-VIEWER"
33 #include <sys/types.h>
36 #include <babeltrace/compat/socket-internal.h>
37 #include <babeltrace/endian-internal.h>
38 #include <babeltrace/compiler-internal.h>
39 #include <babeltrace/common-internal.h>
40 #include <babeltrace/babeltrace.h>
42 #include "lttng-live-internal.h"
43 #include "viewer-connection.h"
44 #include "lttng-viewer-abi.h"
45 #include "data-stream.h"
48 static ssize_t
lttng_live_recv(struct bt_live_viewer_connection
*viewer_connection
,
49 void *buf
, size_t len
)
52 size_t copied
= 0, to_copy
= len
;
53 struct lttng_live_component
*lttng_live
=
54 viewer_connection
->lttng_live
;
55 BT_SOCKET sock
= viewer_connection
->control_sock
;
58 ret
= bt_socket_recv(sock
, buf
+ copied
, to_copy
, 0);
60 assert(ret
<= to_copy
);
64 if (ret
== BT_SOCKET_ERROR
&& bt_socket_interrupted()) {
65 if (lttng_live_is_canceled(lttng_live
)) {
71 } while (ret
> 0 && to_copy
> 0);
74 /* ret = 0 means orderly shutdown, ret == BT_SOCKET_ERROR is error. */
78 static ssize_t
lttng_live_send(struct bt_live_viewer_connection
*viewer_connection
,
79 const void *buf
, size_t len
)
81 struct lttng_live_component
*lttng_live
=
82 viewer_connection
->lttng_live
;
83 BT_SOCKET sock
= viewer_connection
->control_sock
;
87 ret
= bt_socket_send_nosigpipe(sock
, buf
, len
);
88 if (ret
== BT_SOCKET_ERROR
&& bt_socket_interrupted()) {
89 if (lttng_live_is_canceled(lttng_live
)) {
101 static int parse_url(struct bt_live_viewer_connection
*viewer_connection
)
103 char error_buf
[256] = { 0 };
104 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= { 0 };
106 const char *path
= viewer_connection
->url
->str
;
112 lttng_live_url_parts
= bt_common_parse_lttng_live_url(path
,
113 error_buf
, sizeof(error_buf
));
114 if (!lttng_live_url_parts
.proto
) {
115 BT_LOGW("Invalid LTTng live URL format: %s", error_buf
);
119 viewer_connection
->relay_hostname
=
120 lttng_live_url_parts
.hostname
;
121 lttng_live_url_parts
.hostname
= NULL
;
123 if (lttng_live_url_parts
.port
>= 0) {
124 viewer_connection
->port
= lttng_live_url_parts
.port
;
126 viewer_connection
->port
= LTTNG_DEFAULT_NETWORK_VIEWER_PORT
;
129 viewer_connection
->target_hostname
=
130 lttng_live_url_parts
.target_hostname
;
131 lttng_live_url_parts
.target_hostname
= NULL
;
133 if (lttng_live_url_parts
.session_name
) {
134 viewer_connection
->session_name
=
135 lttng_live_url_parts
.session_name
;
136 lttng_live_url_parts
.session_name
= NULL
;
139 BT_LOGD("Connecting to hostname : %s, port : %d, "
140 "target hostname : %s, session name : %s, "
142 viewer_connection
->relay_hostname
->str
,
143 viewer_connection
->port
,
144 viewer_connection
->target_hostname
== NULL
?
145 "<none>" : viewer_connection
->target_hostname
->str
,
146 viewer_connection
->session_name
== NULL
?
147 "<none>" : viewer_connection
->session_name
->str
,
148 lttng_live_url_parts
.proto
->str
);
152 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
156 static int lttng_live_handshake(struct bt_live_viewer_connection
*viewer_connection
)
158 struct lttng_viewer_cmd cmd
;
159 struct lttng_viewer_connect connect
;
160 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(connect
);
161 char cmd_buf
[cmd_buf_len
];
165 cmd
.cmd
= htobe32(LTTNG_VIEWER_CONNECT
);
166 cmd
.data_size
= htobe64((uint64_t) sizeof(connect
));
167 cmd
.cmd_version
= htobe32(0);
169 connect
.viewer_session_id
= -1ULL; /* will be set on recv */
170 connect
.major
= htobe32(LTTNG_LIVE_MAJOR
);
171 connect
.minor
= htobe32(LTTNG_LIVE_MINOR
);
172 connect
.type
= htobe32(LTTNG_VIEWER_CLIENT_COMMAND
);
175 * Merge the cmd and connection request to prevent a write-write
176 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
177 * second write to be performed quickly in presence of Nagle's algorithm
179 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
180 memcpy(cmd_buf
+ sizeof(cmd
), &connect
, sizeof(connect
));
182 ret_len
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
183 if (ret_len
== BT_SOCKET_ERROR
) {
184 BT_LOGE("Error sending version: %s", bt_socket_errormsg());
187 assert(ret_len
== cmd_buf_len
);
189 ret_len
= lttng_live_recv(viewer_connection
, &connect
, sizeof(connect
));
191 BT_LOGI("Remote side has closed connection");
194 if (ret_len
== BT_SOCKET_ERROR
) {
195 BT_LOGE("Error receiving version: %s", bt_socket_errormsg());
198 assert(ret_len
== sizeof(connect
));
200 BT_LOGD("Received viewer session ID : %" PRIu64
,
201 (uint64_t) be64toh(connect
.viewer_session_id
));
202 BT_LOGD("Relayd version : %u.%u", be32toh(connect
.major
),
203 be32toh(connect
.minor
));
205 if (LTTNG_LIVE_MAJOR
!= be32toh(connect
.major
)) {
206 BT_LOGE("Incompatible lttng-relayd protocol");
209 /* Use the smallest protocol version implemented. */
210 if (LTTNG_LIVE_MINOR
> be32toh(connect
.minor
)) {
211 viewer_connection
->minor
= be32toh(connect
.minor
);
213 viewer_connection
->minor
= LTTNG_LIVE_MINOR
;
215 viewer_connection
->major
= LTTNG_LIVE_MAJOR
;
220 BT_LOGE("Unable to establish connection");
224 static int lttng_live_connect_viewer(struct bt_live_viewer_connection
*viewer_connection
)
226 struct hostent
*host
;
227 struct sockaddr_in server_addr
;
230 if (parse_url(viewer_connection
)) {
234 host
= gethostbyname(viewer_connection
->relay_hostname
->str
);
236 BT_LOGE("Cannot lookup hostname %s",
237 viewer_connection
->relay_hostname
->str
);
241 if ((viewer_connection
->control_sock
= socket(AF_INET
, SOCK_STREAM
, 0)) == BT_INVALID_SOCKET
) {
242 BT_LOGE("Socket creation failed: %s", bt_socket_errormsg());
246 server_addr
.sin_family
= AF_INET
;
247 server_addr
.sin_port
= htons(viewer_connection
->port
);
248 server_addr
.sin_addr
= *((struct in_addr
*) host
->h_addr
);
249 memset(&(server_addr
.sin_zero
), 0, 8);
251 if (connect(viewer_connection
->control_sock
, (struct sockaddr
*) &server_addr
,
252 sizeof(struct sockaddr
)) == BT_SOCKET_ERROR
) {
253 BT_LOGE("Connection failed: %s", bt_socket_errormsg());
256 if (lttng_live_handshake(viewer_connection
)) {
265 if (viewer_connection
->control_sock
!= BT_INVALID_SOCKET
) {
266 if (bt_socket_close(viewer_connection
->control_sock
) == BT_SOCKET_ERROR
) {
267 BT_LOGE("Close: %s", bt_socket_errormsg());
270 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
274 static void lttng_live_disconnect_viewer(struct bt_live_viewer_connection
*viewer_connection
)
276 if (viewer_connection
->control_sock
== BT_INVALID_SOCKET
) {
279 if (bt_socket_close(viewer_connection
->control_sock
) == BT_SOCKET_ERROR
) {
280 BT_LOGE("Close: %s", bt_socket_errormsg());
281 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
285 static void connection_release(struct bt_object
*obj
)
287 struct bt_live_viewer_connection
*conn
=
288 container_of(obj
, struct bt_live_viewer_connection
, obj
);
290 bt_live_viewer_connection_destroy(conn
);
294 enum bt_value_status
list_update_session(struct bt_value
*results
,
295 const struct lttng_viewer_session
*session
,
298 enum bt_value_status ret
= BT_VALUE_STATUS_OK
;
299 struct bt_value
*map
= NULL
;
300 struct bt_value
*hostname
= NULL
;
301 struct bt_value
*session_name
= NULL
;
302 struct bt_value
*btval
= NULL
;
306 len
= bt_value_array_size(results
);
308 ret
= BT_VALUE_STATUS_ERROR
;
311 for (i
= 0; i
< len
; i
++) {
312 const char *hostname_str
= NULL
;
313 const char *session_name_str
= NULL
;
315 map
= bt_value_array_get(results
, (size_t) i
);
317 ret
= BT_VALUE_STATUS_ERROR
;
320 hostname
= bt_value_map_get(map
, "target-hostname");
322 ret
= BT_VALUE_STATUS_ERROR
;
325 session_name
= bt_value_map_get(map
, "session-name");
327 ret
= BT_VALUE_STATUS_ERROR
;
330 ret
= bt_value_string_get(hostname
, &hostname_str
);
331 if (ret
!= BT_VALUE_STATUS_OK
) {
334 ret
= bt_value_string_get(session_name
, &session_name_str
);
335 if (ret
!= BT_VALUE_STATUS_OK
) {
339 if (!strcmp(session
->hostname
, hostname_str
)
340 && !strcmp(session
->session_name
,
343 uint32_t streams
= be32toh(session
->streams
);
344 uint32_t clients
= be32toh(session
->clients
);
348 btval
= bt_value_map_get(map
, "stream-count");
350 ret
= BT_VALUE_STATUS_ERROR
;
353 ret
= bt_value_integer_get(btval
, &val
);
354 if (ret
!= BT_VALUE_STATUS_OK
) {
359 ret
= bt_value_integer_set(btval
, val
);
360 if (ret
!= BT_VALUE_STATUS_OK
) {
365 btval
= bt_value_map_get(map
, "client-count");
367 ret
= BT_VALUE_STATUS_ERROR
;
370 ret
= bt_value_integer_get(btval
, &val
);
371 if (ret
!= BT_VALUE_STATUS_OK
) {
375 val
= max_t(int64_t, clients
, val
);
376 ret
= bt_value_integer_set(btval
, val
);
377 if (ret
!= BT_VALUE_STATUS_OK
) {
384 BT_PUT(session_name
);
394 BT_PUT(session_name
);
401 enum bt_value_status
list_append_session(struct bt_value
*results
,
403 const struct lttng_viewer_session
*session
)
405 enum bt_value_status ret
= BT_VALUE_STATUS_OK
;
406 struct bt_value
*map
= NULL
;
411 * If the session already exists, add the stream count to it,
412 * and do max of client counts.
414 ret
= list_update_session(results
, session
, &found
);
415 if (ret
!= BT_VALUE_STATUS_OK
|| found
) {
419 map
= bt_value_map_create();
421 ret
= BT_VALUE_STATUS_ERROR
;
425 if (base_url
->len
< 1) {
426 ret
= BT_VALUE_STATUS_ERROR
;
433 url
= g_string_new(base_url
->str
);
434 g_string_append(url
, "/host/");
435 g_string_append(url
, session
->hostname
);
436 g_string_append_c(url
, '/');
437 g_string_append(url
, session
->session_name
);
439 ret
= bt_value_map_insert_string(map
, "url", url
->str
);
440 if (ret
!= BT_VALUE_STATUS_OK
) {
445 * key = "target-hostname",
448 ret
= bt_value_map_insert_string(map
, "target-hostname",
450 if (ret
!= BT_VALUE_STATUS_OK
) {
455 * key = "session-name",
458 ret
= bt_value_map_insert_string(map
, "session-name",
459 session
->session_name
);
460 if (ret
!= BT_VALUE_STATUS_OK
) {
469 uint32_t live_timer
= be32toh(session
->live_timer
);
471 ret
= bt_value_map_insert_integer(map
, "timer-us",
473 if (ret
!= BT_VALUE_STATUS_OK
) {
479 * key = "stream-count",
483 uint32_t streams
= be32toh(session
->streams
);
485 ret
= bt_value_map_insert_integer(map
, "stream-count",
487 if (ret
!= BT_VALUE_STATUS_OK
) {
494 * key = "client-count",
498 uint32_t clients
= be32toh(session
->clients
);
500 ret
= bt_value_map_insert_integer(map
, "client-count",
502 if (ret
!= BT_VALUE_STATUS_OK
) {
507 ret
= bt_value_array_append(results
, map
);
510 g_string_free(url
, TRUE
);
517 * Data structure returned:
528 * key = "target-hostname",
532 * key = "session-name",
540 * key = "stream-count",
544 * key = "client-count",
553 struct bt_value
*bt_live_viewer_connection_list_sessions(struct bt_live_viewer_connection
*viewer_connection
)
555 struct bt_value
*results
= NULL
;
556 struct lttng_viewer_cmd cmd
;
557 struct lttng_viewer_list_sessions list
;
558 uint32_t i
, sessions_count
;
561 if (lttng_live_handshake(viewer_connection
)) {
565 results
= bt_value_array_create();
567 BT_LOGE("Error creating array");
571 cmd
.cmd
= htobe32(LTTNG_VIEWER_LIST_SESSIONS
);
572 cmd
.data_size
= htobe64((uint64_t) 0);
573 cmd
.cmd_version
= htobe32(0);
575 ret_len
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
576 if (ret_len
== BT_SOCKET_ERROR
) {
577 BT_LOGE("Error sending cmd: %s", bt_socket_errormsg());
580 assert(ret_len
== sizeof(cmd
));
582 ret_len
= lttng_live_recv(viewer_connection
, &list
, sizeof(list
));
584 BT_LOGI("Remote side has closed connection");
587 if (ret_len
== BT_SOCKET_ERROR
) {
588 BT_LOGE("Error receiving session list: %s", bt_socket_errormsg());
591 assert(ret_len
== sizeof(list
));
593 sessions_count
= be32toh(list
.sessions_count
);
594 for (i
= 0; i
< sessions_count
; i
++) {
595 struct lttng_viewer_session lsession
;
597 ret_len
= lttng_live_recv(viewer_connection
,
598 &lsession
, sizeof(lsession
));
600 BT_LOGI("Remote side has closed connection");
603 if (ret_len
== BT_SOCKET_ERROR
) {
604 BT_LOGE("Error receiving session: %s", bt_socket_errormsg());
607 assert(ret_len
== sizeof(lsession
));
608 lsession
.hostname
[LTTNG_VIEWER_HOST_NAME_MAX
- 1] = '\0';
609 lsession
.session_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
610 if (list_append_session(results
,
611 viewer_connection
->url
, &lsession
)
612 != BT_VALUE_STATUS_OK
) {
624 int lttng_live_query_session_ids(struct lttng_live_component
*lttng_live
)
626 struct lttng_viewer_cmd cmd
;
627 struct lttng_viewer_list_sessions list
;
628 struct lttng_viewer_session lsession
;
629 uint32_t i
, sessions_count
;
632 struct bt_live_viewer_connection
*viewer_connection
=
633 lttng_live
->viewer_connection
;
635 cmd
.cmd
= htobe32(LTTNG_VIEWER_LIST_SESSIONS
);
636 cmd
.data_size
= htobe64((uint64_t) 0);
637 cmd
.cmd_version
= htobe32(0);
639 ret_len
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
640 if (ret_len
== BT_SOCKET_ERROR
) {
641 BT_LOGE("Error sending cmd: %s", bt_socket_errormsg());
644 assert(ret_len
== sizeof(cmd
));
646 ret_len
= lttng_live_recv(viewer_connection
, &list
, sizeof(list
));
648 BT_LOGI("Remote side has closed connection");
651 if (ret_len
== BT_SOCKET_ERROR
) {
652 BT_LOGE("Error receiving session list: %s", bt_socket_errormsg());
655 assert(ret_len
== sizeof(list
));
657 sessions_count
= be32toh(list
.sessions_count
);
658 for (i
= 0; i
< sessions_count
; i
++) {
659 ret_len
= lttng_live_recv(viewer_connection
,
660 &lsession
, sizeof(lsession
));
662 BT_LOGI("Remote side has closed connection");
665 if (ret_len
== BT_SOCKET_ERROR
) {
666 BT_LOGE("Error receiving session: %s", bt_socket_errormsg());
669 assert(ret_len
== sizeof(lsession
));
670 lsession
.hostname
[LTTNG_VIEWER_HOST_NAME_MAX
- 1] = '\0';
671 lsession
.session_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
672 session_id
= be64toh(lsession
.id
);
674 BT_LOGD("Adding session %" PRIu64
" hostname: %s session_name: %s",
675 session_id
, lsession
.hostname
, lsession
.session_name
);
677 if ((strncmp(lsession
.session_name
,
678 viewer_connection
->session_name
->str
,
679 LTTNG_VIEWER_NAME_MAX
) == 0) && (strncmp(lsession
.hostname
,
680 viewer_connection
->target_hostname
->str
,
681 LTTNG_VIEWER_HOST_NAME_MAX
) == 0)) {
682 if (lttng_live_add_session(lttng_live
, session_id
,
684 lsession
.session_name
)) {
693 BT_LOGE("Unable to query session ids");
698 int lttng_live_create_viewer_session(struct lttng_live_component
*lttng_live
)
700 struct lttng_viewer_cmd cmd
;
701 struct lttng_viewer_create_session_response resp
;
703 struct bt_live_viewer_connection
*viewer_connection
=
704 lttng_live
->viewer_connection
;
706 cmd
.cmd
= htobe32(LTTNG_VIEWER_CREATE_SESSION
);
707 cmd
.data_size
= htobe64((uint64_t) 0);
708 cmd
.cmd_version
= htobe32(0);
710 ret_len
= lttng_live_send(viewer_connection
, &cmd
, sizeof(cmd
));
711 if (ret_len
== BT_SOCKET_ERROR
) {
712 BT_LOGE("Error sending cmd: %s", bt_socket_errormsg());
715 assert(ret_len
== sizeof(cmd
));
717 ret_len
= lttng_live_recv(viewer_connection
, &resp
, sizeof(resp
));
719 BT_LOGI("Remote side has closed connection");
722 if (ret_len
== BT_SOCKET_ERROR
) {
723 BT_LOGE("Error receiving create session reply: %s", bt_socket_errormsg());
726 assert(ret_len
== sizeof(resp
));
728 if (be32toh(resp
.status
) != LTTNG_VIEWER_CREATE_SESSION_OK
) {
729 BT_LOGE("Error creating viewer session");
732 if (lttng_live_query_session_ids(lttng_live
)) {
743 int receive_streams(struct lttng_live_session
*session
,
744 uint32_t stream_count
)
748 struct lttng_live_component
*lttng_live
= session
->lttng_live
;
749 struct bt_live_viewer_connection
*viewer_connection
=
750 lttng_live
->viewer_connection
;
752 BT_LOGD("Getting %" PRIu32
" new streams:", stream_count
);
753 for (i
= 0; i
< stream_count
; i
++) {
754 struct lttng_viewer_stream stream
;
755 struct lttng_live_stream_iterator
*live_stream
;
757 uint64_t ctf_trace_id
;
759 ret_len
= lttng_live_recv(viewer_connection
, &stream
, sizeof(stream
));
761 BT_LOGI("Remote side has closed connection");
764 if (ret_len
== BT_SOCKET_ERROR
) {
765 BT_LOGE("Error receiving stream");
768 assert(ret_len
== sizeof(stream
));
769 stream
.path_name
[LTTNG_VIEWER_PATH_MAX
- 1] = '\0';
770 stream
.channel_name
[LTTNG_VIEWER_NAME_MAX
- 1] = '\0';
771 stream_id
= be64toh(stream
.id
);
772 ctf_trace_id
= be64toh(stream
.ctf_trace_id
);
774 if (stream
.metadata_flag
) {
775 BT_LOGD(" metadata stream %" PRIu64
" : %s/%s",
776 stream_id
, stream
.path_name
,
777 stream
.channel_name
);
778 if (lttng_live_metadata_create_stream(session
,
779 ctf_trace_id
, stream_id
,
781 BT_LOGE("Error creating metadata stream");
785 session
->lazy_stream_notif_init
= true;
787 BT_LOGD(" stream %" PRIu64
" : %s/%s",
788 stream_id
, stream
.path_name
,
789 stream
.channel_name
);
790 live_stream
= lttng_live_stream_iterator_create(session
,
791 ctf_trace_id
, stream_id
);
793 BT_LOGE("Error creating streamn");
805 int lttng_live_attach_session(struct lttng_live_session
*session
)
807 struct lttng_viewer_cmd cmd
;
808 struct lttng_viewer_attach_session_request rq
;
809 struct lttng_viewer_attach_session_response rp
;
811 struct lttng_live_component
*lttng_live
= session
->lttng_live
;
812 struct bt_live_viewer_connection
*viewer_connection
=
813 lttng_live
->viewer_connection
;
814 uint64_t session_id
= session
->id
;
815 uint32_t streams_count
;
816 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
817 char cmd_buf
[cmd_buf_len
];
819 if (session
->attached
) {
823 cmd
.cmd
= htobe32(LTTNG_VIEWER_ATTACH_SESSION
);
824 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
825 cmd
.cmd_version
= htobe32(0);
827 memset(&rq
, 0, sizeof(rq
));
828 rq
.session_id
= htobe64(session_id
);
829 // TODO: add cmd line parameter to select seek beginning
830 // rq.seek = htobe32(LTTNG_VIEWER_SEEK_BEGINNING);
831 rq
.seek
= htobe32(LTTNG_VIEWER_SEEK_LAST
);
834 * Merge the cmd and connection request to prevent a write-write
835 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
836 * second write to be performed quickly in presence of Nagle's algorithm.
838 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
839 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
841 ret_len
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
842 if (ret_len
== BT_SOCKET_ERROR
) {
843 BT_LOGE("Error sending attach request: %s", bt_socket_errormsg());
846 assert(ret_len
== cmd_buf_len
);
848 ret_len
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
850 BT_LOGI("Remote side has closed connection");
853 if (ret_len
== BT_SOCKET_ERROR
) {
854 BT_LOGE("Error receiving attach response: %s", bt_socket_errormsg());
857 assert(ret_len
== sizeof(rp
));
859 streams_count
= be32toh(rp
.streams_count
);
860 switch(be32toh(rp
.status
)) {
861 case LTTNG_VIEWER_ATTACH_OK
:
863 case LTTNG_VIEWER_ATTACH_UNK
:
864 BT_LOGW("Session id %" PRIu64
" is unknown", session_id
);
866 case LTTNG_VIEWER_ATTACH_ALREADY
:
867 BT_LOGW("There is already a viewer attached to this session");
869 case LTTNG_VIEWER_ATTACH_NOT_LIVE
:
870 BT_LOGW("Not a live session");
872 case LTTNG_VIEWER_ATTACH_SEEK_ERR
:
873 BT_LOGE("Wrong seek parameter");
876 BT_LOGE("Unknown attach return code %u", be32toh(rp
.status
));
880 /* We receive the initial list of streams. */
881 if (receive_streams(session
, streams_count
)) {
885 session
->attached
= true;
886 session
->new_streams_needed
= false;
895 int lttng_live_detach_session(struct lttng_live_session
*session
)
897 struct lttng_viewer_cmd cmd
;
898 struct lttng_viewer_detach_session_request rq
;
899 struct lttng_viewer_detach_session_response rp
;
901 struct lttng_live_component
*lttng_live
= session
->lttng_live
;
902 struct bt_live_viewer_connection
*viewer_connection
=
903 lttng_live
->viewer_connection
;
904 uint64_t session_id
= session
->id
;
905 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
906 char cmd_buf
[cmd_buf_len
];
908 if (!session
->attached
) {
912 cmd
.cmd
= htobe32(LTTNG_VIEWER_DETACH_SESSION
);
913 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
914 cmd
.cmd_version
= htobe32(0);
916 memset(&rq
, 0, sizeof(rq
));
917 rq
.session_id
= htobe64(session_id
);
920 * Merge the cmd and connection request to prevent a write-write
921 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
922 * second write to be performed quickly in presence of Nagle's algorithm.
924 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
925 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
927 ret_len
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
928 if (ret_len
== BT_SOCKET_ERROR
) {
929 BT_LOGE("Error sending detach request: %s", bt_socket_errormsg());
932 assert(ret_len
== cmd_buf_len
);
934 ret_len
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
936 BT_LOGI("Remote side has closed connection");
939 if (ret_len
== BT_SOCKET_ERROR
) {
940 BT_LOGE("Error receiving detach response: %s", bt_socket_errormsg());
943 assert(ret_len
== sizeof(rp
));
945 switch(be32toh(rp
.status
)) {
946 case LTTNG_VIEWER_DETACH_SESSION_OK
:
948 case LTTNG_VIEWER_DETACH_SESSION_UNK
:
949 BT_LOGW("Session id %" PRIu64
" is unknown", session_id
);
951 case LTTNG_VIEWER_DETACH_SESSION_ERR
:
952 BT_LOGW("Error detaching session id %" PRIu64
"", session_id
);
955 BT_LOGE("Unknown detach return code %u", be32toh(rp
.status
));
959 session
->attached
= false;
968 ssize_t
lttng_live_get_one_metadata_packet(struct lttng_live_trace
*trace
,
973 struct lttng_viewer_cmd cmd
;
974 struct lttng_viewer_get_metadata rq
;
975 struct lttng_viewer_metadata_packet rp
;
978 struct lttng_live_session
*session
= trace
->session
;
979 struct lttng_live_component
*lttng_live
= session
->lttng_live
;
980 struct lttng_live_metadata
*metadata
= trace
->metadata
;
981 struct bt_live_viewer_connection
*viewer_connection
=
982 lttng_live
->viewer_connection
;
983 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
984 char cmd_buf
[cmd_buf_len
];
986 rq
.stream_id
= htobe64(metadata
->stream_id
);
987 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_METADATA
);
988 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
989 cmd
.cmd_version
= htobe32(0);
992 * Merge the cmd and connection request to prevent a write-write
993 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
994 * second write to be performed quickly in presence of Nagle's algorithm.
996 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
997 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
999 ret_len
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1000 if (ret_len
== BT_SOCKET_ERROR
) {
1001 BT_LOGE("Error sending get_metadata request: %s", bt_socket_errormsg());
1004 assert(ret_len
== cmd_buf_len
);
1006 ret_len
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1008 BT_LOGI("Remote side has closed connection");
1011 if (ret_len
== BT_SOCKET_ERROR
) {
1012 BT_LOGE("Error receiving get_metadata response: %s", bt_socket_errormsg());
1015 assert(ret_len
== sizeof(rp
));
1017 switch (be32toh(rp
.status
)) {
1018 case LTTNG_VIEWER_METADATA_OK
:
1019 BT_LOGD("get_metadata : OK");
1021 case LTTNG_VIEWER_NO_NEW_METADATA
:
1022 BT_LOGD("get_metadata : NO NEW");
1025 case LTTNG_VIEWER_METADATA_ERR
:
1026 BT_LOGD("get_metadata : ERR");
1029 BT_LOGD("get_metadata : UNKNOWN");
1033 len
= be64toh(rp
.len
);
1034 BT_LOGD("Writing %" PRIu64
" bytes to metadata", len
);
1039 data
= zmalloc(len
);
1041 BT_LOGE("relay data zmalloc: %s", strerror(errno
));
1044 ret_len
= lttng_live_recv(viewer_connection
, data
, len
);
1046 BT_LOGI("Remote side has closed connection");
1047 goto error_free_data
;
1049 if (ret_len
== BT_SOCKET_ERROR
) {
1050 BT_LOGE("Error receiving trace packet: %s", bt_socket_errormsg());
1051 goto error_free_data
;
1053 assert(ret_len
== len
);
1056 ret_len
= fwrite(data
, 1, len
, fp
);
1057 } while (ret_len
< 0 && errno
== EINTR
);
1059 BT_LOGE("Writing in the metadata fp");
1060 goto error_free_data
;
1062 assert(ret_len
== len
);
1075 * Assign the fields from a lttng_viewer_index to a packet_index.
1078 void lttng_index_to_packet_index(struct lttng_viewer_index
*lindex
,
1079 struct packet_index
*pindex
)
1084 pindex
->offset
= be64toh(lindex
->offset
);
1085 pindex
->packet_size
= be64toh(lindex
->packet_size
);
1086 pindex
->content_size
= be64toh(lindex
->content_size
);
1087 pindex
->ts_cycles
.timestamp_begin
= be64toh(lindex
->timestamp_begin
);
1088 pindex
->ts_cycles
.timestamp_end
= be64toh(lindex
->timestamp_end
);
1089 pindex
->events_discarded
= be64toh(lindex
->events_discarded
);
1093 enum bt_lttng_live_iterator_status
lttng_live_get_next_index(struct lttng_live_component
*lttng_live
,
1094 struct lttng_live_stream_iterator
*stream
,
1095 struct packet_index
*index
)
1097 struct lttng_viewer_cmd cmd
;
1098 struct lttng_viewer_get_next_index rq
;
1100 struct lttng_viewer_index rp
;
1101 uint32_t flags
, status
;
1102 enum bt_lttng_live_iterator_status retstatus
=
1103 BT_LTTNG_LIVE_ITERATOR_STATUS_OK
;
1104 struct bt_live_viewer_connection
*viewer_connection
=
1105 lttng_live
->viewer_connection
;
1106 struct lttng_live_trace
*trace
= stream
->trace
;
1107 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1108 char cmd_buf
[cmd_buf_len
];
1110 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_NEXT_INDEX
);
1111 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1112 cmd
.cmd_version
= htobe32(0);
1115 memset(&rq
, 0, sizeof(rq
));
1116 rq
.stream_id
= htobe64(stream
->viewer_stream_id
);
1119 * Merge the cmd and connection request to prevent a write-write
1120 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1121 * second write to be performed quickly in presence of Nagle's algorithm.
1123 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1124 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1126 ret_len
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1127 if (ret_len
== BT_SOCKET_ERROR
) {
1128 BT_LOGE("Error sending get_next_index request: %s", bt_socket_errormsg());
1131 assert(ret_len
== cmd_buf_len
);
1133 ret_len
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1135 BT_LOGI("Remote side has closed connection");
1138 if (ret_len
== BT_SOCKET_ERROR
) {
1139 BT_LOGE("Error receiving get_next_index response: %s", bt_socket_errormsg());
1142 assert(ret_len
== sizeof(rp
));
1144 flags
= be32toh(rp
.flags
);
1145 status
= be32toh(rp
.status
);
1148 case LTTNG_VIEWER_INDEX_INACTIVE
:
1150 uint64_t ctf_stream_class_id
;
1152 BT_LOGD("get_next_index: inactive");
1153 memset(index
, 0, sizeof(struct packet_index
));
1154 index
->ts_cycles
.timestamp_end
= be64toh(rp
.timestamp_end
);
1155 stream
->current_inactivity_timestamp
= index
->ts_cycles
.timestamp_end
;
1156 ctf_stream_class_id
= be64toh(rp
.stream_id
);
1157 if (stream
->ctf_stream_class_id
!= -1ULL) {
1158 assert(stream
->ctf_stream_class_id
==
1159 ctf_stream_class_id
);
1161 stream
->ctf_stream_class_id
= ctf_stream_class_id
;
1163 stream
->state
= LTTNG_LIVE_STREAM_QUIESCENT
;
1166 case LTTNG_VIEWER_INDEX_OK
:
1168 uint64_t ctf_stream_class_id
;
1170 BT_LOGD("get_next_index: OK");
1171 lttng_index_to_packet_index(&rp
, index
);
1172 ctf_stream_class_id
= be64toh(rp
.stream_id
);
1173 if (stream
->ctf_stream_class_id
!= -1ULL) {
1174 assert(stream
->ctf_stream_class_id
==
1175 ctf_stream_class_id
);
1177 stream
->ctf_stream_class_id
= ctf_stream_class_id
;
1180 stream
->state
= LTTNG_LIVE_STREAM_ACTIVE_DATA
;
1181 stream
->current_packet_end_timestamp
=
1182 index
->ts_cycles
.timestamp_end
;
1184 if (flags
& LTTNG_VIEWER_FLAG_NEW_METADATA
) {
1185 BT_LOGD("get_next_index: new metadata needed");
1186 trace
->new_metadata_needed
= true;
1188 if (flags
& LTTNG_VIEWER_FLAG_NEW_STREAM
) {
1189 BT_LOGD("get_next_index: new streams needed");
1190 lttng_live_need_new_streams(lttng_live
);
1194 case LTTNG_VIEWER_INDEX_RETRY
:
1195 BT_LOGD("get_next_index: retry");
1196 memset(index
, 0, sizeof(struct packet_index
));
1197 retstatus
= BT_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1198 stream
->state
= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
;
1200 case LTTNG_VIEWER_INDEX_HUP
:
1201 BT_LOGD("get_next_index: stream hung up");
1202 memset(index
, 0, sizeof(struct packet_index
));
1203 index
->offset
= EOF
;
1204 retstatus
= BT_LTTNG_LIVE_ITERATOR_STATUS_END
;
1205 stream
->state
= LTTNG_LIVE_STREAM_EOF
;
1207 case LTTNG_VIEWER_INDEX_ERR
:
1208 BT_LOGE("get_next_index: error");
1209 memset(index
, 0, sizeof(struct packet_index
));
1210 stream
->state
= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
;
1213 BT_LOGE("get_next_index: unknown value");
1214 memset(index
, 0, sizeof(struct packet_index
));
1215 stream
->state
= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
;
1222 if (lttng_live_is_canceled(lttng_live
)) {
1223 retstatus
= BT_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1225 retstatus
= BT_LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1231 enum bt_notif_iter_medium_status
lttng_live_get_stream_bytes(struct lttng_live_component
*lttng_live
,
1232 struct lttng_live_stream_iterator
*stream
, uint8_t *buf
, uint64_t offset
,
1233 uint64_t req_len
, uint64_t *recv_len
)
1235 enum bt_notif_iter_medium_status retstatus
= BT_NOTIF_ITER_MEDIUM_STATUS_OK
;
1236 struct lttng_viewer_cmd cmd
;
1237 struct lttng_viewer_get_packet rq
;
1238 struct lttng_viewer_trace_packet rp
;
1240 uint32_t flags
, status
;
1241 struct bt_live_viewer_connection
*viewer_connection
=
1242 lttng_live
->viewer_connection
;
1243 struct lttng_live_trace
*trace
= stream
->trace
;
1244 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1245 char cmd_buf
[cmd_buf_len
];
1247 BT_LOGD("lttng_live_get_stream_bytes: offset=%" PRIu64
", req_len=%" PRIu64
,
1249 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_PACKET
);
1250 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1251 cmd
.cmd_version
= htobe32(0);
1253 memset(&rq
, 0, sizeof(rq
));
1254 rq
.stream_id
= htobe64(stream
->viewer_stream_id
);
1255 rq
.offset
= htobe64(offset
);
1256 rq
.len
= htobe32(req_len
);
1259 * Merge the cmd and connection request to prevent a write-write
1260 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1261 * second write to be performed quickly in presence of Nagle's algorithm.
1263 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1264 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1266 ret_len
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1267 if (ret_len
== BT_SOCKET_ERROR
) {
1268 BT_LOGE("Error sending get_data request: %s", bt_socket_errormsg());
1271 assert(ret_len
== cmd_buf_len
);
1273 ret_len
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1275 BT_LOGI("Remote side has closed connection");
1278 if (ret_len
== BT_SOCKET_ERROR
) {
1279 BT_LOGE("Error receiving get_data response: %s", bt_socket_errormsg());
1282 if (ret_len
!= sizeof(rp
)) {
1283 BT_LOGE("get_data_packet: expected %zu"
1284 ", received %zd", sizeof(rp
),
1289 flags
= be32toh(rp
.flags
);
1290 status
= be32toh(rp
.status
);
1293 case LTTNG_VIEWER_GET_PACKET_OK
:
1294 req_len
= be32toh(rp
.len
);
1295 BT_LOGD("get_data_packet: Ok, packet size : %" PRIu64
"", req_len
);
1297 case LTTNG_VIEWER_GET_PACKET_RETRY
:
1298 /* Unimplemented by relay daemon */
1299 BT_LOGD("get_data_packet: retry");
1300 retstatus
= BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN
;
1302 case LTTNG_VIEWER_GET_PACKET_ERR
:
1303 if (flags
& LTTNG_VIEWER_FLAG_NEW_METADATA
) {
1304 BT_LOGD("get_data_packet: new metadata needed, try again later");
1305 trace
->new_metadata_needed
= true;
1307 if (flags
& LTTNG_VIEWER_FLAG_NEW_STREAM
) {
1308 BT_LOGD("get_data_packet: new streams needed, try again later");
1309 lttng_live_need_new_streams(lttng_live
);
1311 if (flags
& (LTTNG_VIEWER_FLAG_NEW_METADATA
1312 | LTTNG_VIEWER_FLAG_NEW_STREAM
)) {
1313 retstatus
= BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN
;
1316 BT_LOGE("get_data_packet: error");
1318 case LTTNG_VIEWER_GET_PACKET_EOF
:
1319 retstatus
= BT_NOTIF_ITER_MEDIUM_STATUS_EOF
;
1322 BT_LOGE("get_data_packet: unknown");
1330 ret_len
= lttng_live_recv(viewer_connection
, buf
, req_len
);
1332 BT_LOGI("Remote side has closed connection");
1335 if (ret_len
== BT_SOCKET_ERROR
) {
1336 BT_LOGE("Error receiving trace packet: %s", bt_socket_errormsg());
1339 assert(ret_len
== req_len
);
1340 *recv_len
= ret_len
;
1345 if (lttng_live_is_canceled(lttng_live
)) {
1346 retstatus
= BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN
;
1348 retstatus
= BT_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
1354 * Request new streams for a session.
1357 enum bt_lttng_live_iterator_status
lttng_live_get_new_streams(
1358 struct lttng_live_session
*session
)
1360 enum bt_lttng_live_iterator_status status
=
1361 BT_LTTNG_LIVE_ITERATOR_STATUS_OK
;
1362 struct lttng_viewer_cmd cmd
;
1363 struct lttng_viewer_new_streams_request rq
;
1364 struct lttng_viewer_new_streams_response rp
;
1366 struct lttng_live_component
*lttng_live
= session
->lttng_live
;
1367 struct bt_live_viewer_connection
*viewer_connection
=
1368 lttng_live
->viewer_connection
;
1369 uint32_t streams_count
;
1370 const size_t cmd_buf_len
= sizeof(cmd
) + sizeof(rq
);
1371 char cmd_buf
[cmd_buf_len
];
1373 if (!session
->new_streams_needed
) {
1374 return BT_LTTNG_LIVE_ITERATOR_STATUS_OK
;
1377 cmd
.cmd
= htobe32(LTTNG_VIEWER_GET_NEW_STREAMS
);
1378 cmd
.data_size
= htobe64((uint64_t) sizeof(rq
));
1379 cmd
.cmd_version
= htobe32(0);
1381 memset(&rq
, 0, sizeof(rq
));
1382 rq
.session_id
= htobe64(session
->id
);
1385 * Merge the cmd and connection request to prevent a write-write
1386 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1387 * second write to be performed quickly in presence of Nagle's algorithm.
1389 memcpy(cmd_buf
, &cmd
, sizeof(cmd
));
1390 memcpy(cmd_buf
+ sizeof(cmd
), &rq
, sizeof(rq
));
1392 ret_len
= lttng_live_send(viewer_connection
, &cmd_buf
, cmd_buf_len
);
1393 if (ret_len
== BT_SOCKET_ERROR
) {
1394 BT_LOGE("Error sending get_new_streams request: %s", bt_socket_errormsg());
1397 assert(ret_len
== cmd_buf_len
);
1399 ret_len
= lttng_live_recv(viewer_connection
, &rp
, sizeof(rp
));
1401 BT_LOGI("Remote side has closed connection");
1404 if (ret_len
== BT_SOCKET_ERROR
) {
1405 BT_LOGE("Error receiving get_new_streams response");
1408 assert(ret_len
== sizeof(rp
));
1410 streams_count
= be32toh(rp
.streams_count
);
1412 switch(be32toh(rp
.status
)) {
1413 case LTTNG_VIEWER_NEW_STREAMS_OK
:
1414 session
->new_streams_needed
= false;
1416 case LTTNG_VIEWER_NEW_STREAMS_NO_NEW
:
1417 session
->new_streams_needed
= false;
1419 case LTTNG_VIEWER_NEW_STREAMS_HUP
:
1420 session
->new_streams_needed
= false;
1421 session
->closed
= true;
1422 status
= BT_LTTNG_LIVE_ITERATOR_STATUS_END
;
1424 case LTTNG_VIEWER_NEW_STREAMS_ERR
:
1425 BT_LOGE("get_new_streams error");
1428 BT_LOGE("Unknown return code %u", be32toh(rp
.status
));
1432 if (receive_streams(session
, streams_count
)) {
1439 if (lttng_live_is_canceled(lttng_live
)) {
1440 status
= BT_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1442 status
= BT_LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1448 struct bt_live_viewer_connection
*
1449 bt_live_viewer_connection_create(const char *url
,
1450 struct lttng_live_component
*lttng_live
)
1452 struct bt_live_viewer_connection
*viewer_connection
;
1454 viewer_connection
= g_new0(struct bt_live_viewer_connection
, 1);
1456 if (bt_socket_init() != 0) {
1460 bt_object_init(&viewer_connection
->obj
, connection_release
);
1461 viewer_connection
->control_sock
= BT_INVALID_SOCKET
;
1462 viewer_connection
->port
= -1;
1463 viewer_connection
->lttng_live
= lttng_live
;
1464 viewer_connection
->url
= g_string_new(url
);
1465 if (!viewer_connection
->url
) {
1469 BT_LOGD("Establishing connection to url \"%s\"...", url
);
1470 if (lttng_live_connect_viewer(viewer_connection
)) {
1473 BT_LOGD("Connection to url \"%s\" is established", url
);
1474 return viewer_connection
;
1477 BT_LOGW("Failure to establish connection to url \"%s\"", url
);
1479 g_free(viewer_connection
);
1484 void bt_live_viewer_connection_destroy(struct bt_live_viewer_connection
*viewer_connection
)
1486 BT_LOGD("Closing connection to url \"%s\"", viewer_connection
->url
->str
);
1487 lttng_live_disconnect_viewer(viewer_connection
);
1488 g_string_free(viewer_connection
->url
, TRUE
);
1489 if (viewer_connection
->relay_hostname
) {
1490 g_string_free(viewer_connection
->relay_hostname
, TRUE
);
1492 if (viewer_connection
->target_hostname
) {
1493 g_string_free(viewer_connection
->target_hostname
, TRUE
);
1495 if (viewer_connection
->session_name
) {
1496 g_string_free(viewer_connection
->session_name
, TRUE
);
1498 g_free(viewer_connection
);