2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
4 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 #include <sys/mount.h>
31 #include <sys/resource.h>
32 #include <sys/socket.h>
34 #include <sys/types.h>
37 #include <urcu/futex.h>
38 #include <urcu/uatomic.h>
39 #include <urcu/rculist.h>
43 #include <lttng/lttng.h>
44 #include <common/common.h>
45 #include <common/compat/poll.h>
46 #include <common/compat/socket.h>
47 #include <common/compat/endian.h>
48 #include <common/defaults.h>
49 #include <common/futex.h>
50 #include <common/index/index.h>
51 #include <common/sessiond-comm/sessiond-comm.h>
52 #include <common/sessiond-comm/inet.h>
53 #include <common/sessiond-comm/relayd.h>
54 #include <common/uri.h>
55 #include <common/utils.h>
59 #include "lttng-relayd.h"
61 #include "health-relayd.h"
62 #include "testpoint.h"
63 #include "viewer-stream.h"
66 #include "ctf-trace.h"
67 #include "connection.h"
68 #include "viewer-session.h"
70 #define SESSION_BUF_DEFAULT_COUNT 16
72 static struct lttng_uri
*live_uri
;
75 * This pipe is used to inform the worker thread that a command is queued and
76 * ready to be processed.
78 static int live_conn_pipe
[2] = { -1, -1 };
80 /* Shared between threads */
81 static int live_dispatch_thread_exit
;
83 static pthread_t live_listener_thread
;
84 static pthread_t live_dispatcher_thread
;
85 static pthread_t live_worker_thread
;
88 * Relay command queue.
90 * The live_thread_listener and live_thread_dispatcher communicate with this
93 static struct relay_conn_queue viewer_conn_queue
;
95 static uint64_t last_relay_viewer_session_id
;
96 static pthread_mutex_t last_relay_viewer_session_id_lock
=
97 PTHREAD_MUTEX_INITIALIZER
;
103 void cleanup_relayd_live(void)
111 * Receive a request buffer using a given socket, destination allocated buffer
114 * Return the size of the received message or else a negative value on error
115 * with errno being set by recvmsg() syscall.
118 ssize_t
recv_request(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
122 ret
= sock
->ops
->recvmsg(sock
, buf
, size
, 0);
123 if (ret
< 0 || ret
!= size
) {
125 /* Orderly shutdown. Not necessary to print an error. */
126 DBG("Socket %d did an orderly shutdown", sock
->fd
);
128 ERR("Relay failed to receive request.");
137 * Send a response buffer using a given socket, source allocated buffer of
140 * Return the size of the sent message or else a negative value on error with
141 * errno being set by sendmsg() syscall.
144 ssize_t
send_response(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
148 ret
= sock
->ops
->sendmsg(sock
, buf
, size
, 0);
150 ERR("Relayd failed to send response.");
157 * Atomically check if new streams got added in one of the sessions attached
158 * and reset the flag to 0.
160 * Returns 1 if new streams got added, 0 if nothing changed, a negative value
164 int check_new_streams(struct relay_connection
*conn
)
166 struct relay_session
*session
;
167 unsigned long current_val
;
170 if (!conn
->viewer_session
) {
174 cds_list_for_each_entry_rcu(session
,
175 &conn
->viewer_session
->session_list
,
176 viewer_session_node
) {
177 if (!session_get(session
)) {
180 current_val
= uatomic_cmpxchg(&session
->new_streams
, 1, 0);
182 session_put(session
);
193 * Send viewer streams to the given socket. The ignore_sent_flag indicates if
194 * this function should ignore the sent flag or not.
196 * Return 0 on success or else a negative value.
199 ssize_t
send_viewer_streams(struct lttcomm_sock
*sock
,
200 uint64_t session_id
, unsigned int ignore_sent_flag
)
203 struct lttng_viewer_stream send_stream
;
204 struct lttng_ht_iter iter
;
205 struct relay_viewer_stream
*vstream
;
209 cds_lfht_for_each_entry(viewer_streams_ht
->ht
, &iter
.iter
, vstream
,
211 struct ctf_trace
*ctf_trace
;
213 health_code_update();
215 if (!viewer_stream_get(vstream
)) {
219 pthread_mutex_lock(&vstream
->stream
->lock
);
220 /* Ignore if not the same session. */
221 if (vstream
->stream
->trace
->session
->id
!= session_id
||
222 (!ignore_sent_flag
&& vstream
->sent_flag
)) {
223 pthread_mutex_unlock(&vstream
->stream
->lock
);
224 viewer_stream_put(vstream
);
228 ctf_trace
= vstream
->stream
->trace
;
229 send_stream
.id
= htobe64(vstream
->stream
->stream_handle
);
230 send_stream
.ctf_trace_id
= htobe64(ctf_trace
->id
);
231 send_stream
.metadata_flag
= htobe32(
232 vstream
->stream
->is_metadata
);
233 if (lttng_strncpy(send_stream
.path_name
, vstream
->path_name
,
234 sizeof(send_stream
.path_name
))) {
235 pthread_mutex_unlock(&vstream
->stream
->lock
);
236 viewer_stream_put(vstream
);
237 ret
= -1; /* Error. */
240 if (lttng_strncpy(send_stream
.channel_name
,
241 vstream
->channel_name
,
242 sizeof(send_stream
.channel_name
))) {
243 pthread_mutex_unlock(&vstream
->stream
->lock
);
244 viewer_stream_put(vstream
);
245 ret
= -1; /* Error. */
249 DBG("Sending stream %" PRIu64
" to viewer",
250 vstream
->stream
->stream_handle
);
251 vstream
->sent_flag
= 1;
252 pthread_mutex_unlock(&vstream
->stream
->lock
);
254 ret
= send_response(sock
, &send_stream
, sizeof(send_stream
));
255 viewer_stream_put(vstream
);
269 * Create every viewer stream possible for the given session with the seek
270 * type. Three counters *can* be return which are in order the total amount of
271 * viewer stream of the session, the number of unsent stream and the number of
272 * stream created. Those counters can be NULL and thus will be ignored.
274 * session must be locked to ensure that we see either none or all initial
275 * streams for a session, but no intermediate state..
277 * Return 0 on success or else a negative value.
279 static int make_viewer_streams(struct relay_session
*session
,
280 struct lttng_trace_chunk
*viewer_trace_chunk
,
281 enum lttng_viewer_seek seek_t
,
284 uint32_t *nb_created
,
288 struct lttng_ht_iter iter
;
289 struct ctf_trace
*ctf_trace
;
292 ASSERT_LOCKED(session
->lock
);
294 if (session
->connection_closed
) {
299 * Create viewer streams for relay streams that are ready to be
300 * used for a the given session id only.
303 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
, &iter
.iter
, ctf_trace
,
305 struct relay_stream
*stream
;
307 health_code_update();
309 if (!ctf_trace_get(ctf_trace
)) {
313 cds_list_for_each_entry_rcu(stream
, &ctf_trace
->stream_list
, stream_node
) {
314 struct relay_viewer_stream
*vstream
;
316 if (!stream_get(stream
)) {
320 * stream published is protected by the session lock.
322 if (!stream
->published
) {
325 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
327 vstream
= viewer_stream_create(stream
,
328 viewer_trace_chunk
, seek_t
);
331 ctf_trace_put(ctf_trace
);
337 /* Update number of created stream counter. */
341 * Ensure a self-reference is preserved even
342 * after we have put our local reference.
344 if (!viewer_stream_get(vstream
)) {
345 ERR("Unable to get self-reference on viewer stream, logic error.");
349 if (!vstream
->sent_flag
&& nb_unsent
) {
350 /* Update number of unsent stream counter. */
354 /* Update number of total stream counter. */
356 if (stream
->is_metadata
) {
357 if (!stream
->closed
||
358 stream
->metadata_received
> vstream
->metadata_sent
) {
362 if (!stream
->closed
||
363 !(((int64_t) (stream
->prev_data_seq
- stream
->last_net_seq_num
)) >= 0)) {
369 /* Put local reference. */
370 viewer_stream_put(vstream
);
374 ctf_trace_put(ctf_trace
);
384 int relayd_live_stop(void)
386 /* Stop dispatch thread */
387 CMM_STORE_SHARED(live_dispatch_thread_exit
, 1);
388 futex_nto1_wake(&viewer_conn_queue
.futex
);
393 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
396 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
400 if (events
== NULL
|| size
== 0) {
405 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
411 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
423 * Check if the thread quit pipe was triggered.
425 * Return 1 if it was triggered else 0;
428 int check_thread_quit_pipe(int fd
, uint32_t events
)
430 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
438 * Create and init socket from uri.
441 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
)
444 struct lttcomm_sock
*sock
= NULL
;
446 sock
= lttcomm_alloc_sock_from_uri(uri
);
448 ERR("Allocating socket");
452 ret
= lttcomm_create_sock(sock
);
456 DBG("Listening on sock %d for lttng-live", sock
->fd
);
458 ret
= sock
->ops
->bind(sock
);
460 PERROR("Failed to bind lttng-live socket");
464 ret
= sock
->ops
->listen(sock
, -1);
474 lttcomm_destroy_sock(sock
);
480 * This thread manages the listening for new connections on the network
483 void *thread_listener(void *data
)
485 int i
, ret
, pollfd
, err
= -1;
486 uint32_t revents
, nb_fd
;
487 struct lttng_poll_event events
;
488 struct lttcomm_sock
*live_control_sock
;
490 DBG("[thread] Relay live listener started");
492 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
494 health_code_update();
496 live_control_sock
= init_socket(live_uri
);
497 if (!live_control_sock
) {
498 goto error_sock_control
;
501 /* Pass 2 as size here for the thread quit pipe and control sockets. */
502 ret
= create_thread_poll_set(&events
, 2);
504 goto error_create_poll
;
507 /* Add the control socket */
508 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
513 lttng_relay_notify_ready();
515 if (testpoint(relayd_thread_live_listener
)) {
516 goto error_testpoint
;
520 health_code_update();
522 DBG("Listener accepting live viewers connections");
526 ret
= lttng_poll_wait(&events
, -1);
530 * Restart interrupted system call.
532 if (errno
== EINTR
) {
539 DBG("Relay new viewer connection received");
540 for (i
= 0; i
< nb_fd
; i
++) {
541 health_code_update();
543 /* Fetch once the poll data */
544 revents
= LTTNG_POLL_GETEV(&events
, i
);
545 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
547 /* Thread quit pipe has been closed. Killing thread. */
548 ret
= check_thread_quit_pipe(pollfd
, revents
);
554 if (revents
& LPOLLIN
) {
556 * A new connection is requested, therefore a
557 * viewer connection is allocated in this
558 * thread, enqueued to a global queue and
559 * dequeued (and freed) in the worker thread.
562 struct relay_connection
*new_conn
;
563 struct lttcomm_sock
*newsock
;
565 newsock
= live_control_sock
->ops
->accept(live_control_sock
);
567 PERROR("accepting control sock");
570 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
572 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
575 PERROR("setsockopt inet");
576 lttcomm_destroy_sock(newsock
);
579 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
581 lttcomm_destroy_sock(newsock
);
584 /* Ownership assumed by the connection. */
587 /* Enqueue request for the dispatcher thread. */
588 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
592 * Wake the dispatch queue futex.
593 * Implicit memory barrier with the
594 * exchange in cds_wfcq_enqueue.
596 futex_nto1_wake(&viewer_conn_queue
.futex
);
597 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
598 ERR("socket poll error");
601 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
611 lttng_poll_clean(&events
);
613 if (live_control_sock
->fd
>= 0) {
614 ret
= live_control_sock
->ops
->close(live_control_sock
);
619 lttcomm_destroy_sock(live_control_sock
);
623 DBG("Live viewer listener thread exited with error");
625 health_unregister(health_relayd
);
626 DBG("Live viewer listener thread cleanup complete");
627 if (lttng_relay_stop_threads()) {
628 ERR("Error stopping threads");
634 * This thread manages the dispatching of the requests to worker threads
637 void *thread_dispatcher(void *data
)
641 struct cds_wfcq_node
*node
;
642 struct relay_connection
*conn
= NULL
;
644 DBG("[thread] Live viewer relay dispatcher started");
646 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
648 if (testpoint(relayd_thread_live_dispatcher
)) {
649 goto error_testpoint
;
652 health_code_update();
655 health_code_update();
657 /* Atomically prepare the queue futex */
658 futex_nto1_prepare(&viewer_conn_queue
.futex
);
660 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
665 health_code_update();
667 /* Dequeue commands */
668 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
669 &viewer_conn_queue
.tail
);
671 DBG("Woken up but nothing in the live-viewer "
672 "relay command queue");
673 /* Continue thread execution */
676 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
677 DBG("Dispatching viewer request waiting on sock %d",
681 * Inform worker thread of the new request. This
682 * call is blocking so we can be assured that
683 * the data will be read at some point in time
684 * or wait to the end of the world :)
686 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
688 PERROR("write conn pipe");
689 connection_put(conn
);
692 } while (node
!= NULL
);
694 /* Futex wait on queue. Blocking call on futex() */
696 futex_nto1_wait(&viewer_conn_queue
.futex
);
700 /* Normal exit, no error */
707 ERR("Health error occurred in %s", __func__
);
709 health_unregister(health_relayd
);
710 DBG("Live viewer dispatch thread dying");
711 if (lttng_relay_stop_threads()) {
712 ERR("Error stopping threads");
718 * Establish connection with the viewer and check the versions.
720 * Return 0 on success or else negative value.
723 int viewer_connect(struct relay_connection
*conn
)
726 struct lttng_viewer_connect reply
, msg
;
728 conn
->version_check_done
= 1;
730 health_code_update();
732 DBG("Viewer is establishing a connection to the relayd.");
734 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
739 health_code_update();
741 memset(&reply
, 0, sizeof(reply
));
742 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
743 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
745 /* Major versions must be the same */
746 if (reply
.major
!= be32toh(msg
.major
)) {
747 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
748 reply
.major
, be32toh(msg
.major
));
753 conn
->major
= reply
.major
;
754 /* We adapt to the lowest compatible version */
755 if (reply
.minor
<= be32toh(msg
.minor
)) {
756 conn
->minor
= reply
.minor
;
758 conn
->minor
= be32toh(msg
.minor
);
761 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
762 conn
->type
= RELAY_VIEWER_COMMAND
;
763 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
764 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
766 ERR("Unknown connection type : %u", be32toh(msg
.type
));
771 reply
.major
= htobe32(reply
.major
);
772 reply
.minor
= htobe32(reply
.minor
);
773 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
775 * Increment outside of htobe64 macro, because the argument can
776 * be used more than once within the macro, and thus the
777 * operation may be undefined.
779 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
780 last_relay_viewer_session_id
++;
781 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
782 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
785 health_code_update();
787 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
792 health_code_update();
794 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
802 * Send the viewer the list of current sessions.
803 * We need to create a copy of the hash table content because otherwise
804 * we cannot assume the number of entries stays the same between getting
805 * the number of HT elements and iteration over the HT.
807 * Return 0 on success or else a negative value.
810 int viewer_list_sessions(struct relay_connection
*conn
)
813 struct lttng_viewer_list_sessions session_list
;
814 struct lttng_ht_iter iter
;
815 struct relay_session
*session
;
816 struct lttng_viewer_session
*send_session_buf
= NULL
;
817 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
820 DBG("List sessions received");
822 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
823 if (!send_session_buf
) {
828 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
830 struct lttng_viewer_session
*send_session
;
832 health_code_update();
834 if (session
->connection_closed
) {
835 /* Skip closed session */
839 if (count
>= buf_count
) {
840 struct lttng_viewer_session
*newbuf
;
841 uint32_t new_buf_count
= buf_count
<< 1;
843 newbuf
= realloc(send_session_buf
,
844 new_buf_count
* sizeof(*send_session_buf
));
849 send_session_buf
= newbuf
;
850 buf_count
= new_buf_count
;
852 send_session
= &send_session_buf
[count
];
853 if (lttng_strncpy(send_session
->session_name
,
854 session
->session_name
,
855 sizeof(send_session
->session_name
))) {
859 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
860 sizeof(send_session
->hostname
))) {
864 send_session
->id
= htobe64(session
->id
);
865 send_session
->live_timer
= htobe32(session
->live_timer
);
866 if (session
->viewer_attached
) {
867 send_session
->clients
= htobe32(1);
869 send_session
->clients
= htobe32(0);
871 send_session
->streams
= htobe32(session
->stream_count
);
879 session_list
.sessions_count
= htobe32(count
);
881 health_code_update();
883 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
888 health_code_update();
890 ret
= send_response(conn
->sock
, send_session_buf
,
891 count
* sizeof(*send_session_buf
));
895 health_code_update();
899 free(send_session_buf
);
904 * Send the viewer the list of current streams.
907 int viewer_get_new_streams(struct relay_connection
*conn
)
909 int ret
, send_streams
= 0;
910 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
911 struct lttng_viewer_new_streams_request request
;
912 struct lttng_viewer_new_streams_response response
;
913 struct relay_session
*session
= NULL
;
919 DBG("Get new streams received");
921 health_code_update();
923 /* Receive the request from the connected client. */
924 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
928 session_id
= be64toh(request
.session_id
);
930 health_code_update();
932 memset(&response
, 0, sizeof(response
));
934 session
= session_get_by_id(session_id
);
936 DBG("Relay session %" PRIu64
" not found", session_id
);
937 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
941 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
943 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
948 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
950 pthread_mutex_lock(&session
->lock
);
951 if (!conn
->viewer_session
->current_trace_chunk
&&
952 session
->current_trace_chunk
) {
953 ret
= viewer_session_set_trace_chunk(conn
->viewer_session
,
954 session
->current_trace_chunk
);
956 goto error_unlock_session
;
959 ret
= make_viewer_streams(session
,
960 conn
->viewer_session
->current_trace_chunk
,
961 LTTNG_VIEWER_SEEK_LAST
, &nb_total
, &nb_unsent
,
962 &nb_created
, &closed
);
964 goto error_unlock_session
;
966 pthread_mutex_unlock(&session
->lock
);
968 /* Only send back the newly created streams with the unsent ones. */
969 nb_streams
= nb_created
+ nb_unsent
;
970 response
.streams_count
= htobe32(nb_streams
);
973 * If the session is closed, HUP when there are no more streams
976 if (closed
&& nb_total
== 0) {
978 response
.streams_count
= 0;
979 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
984 health_code_update();
985 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
987 goto end_put_session
;
989 health_code_update();
992 * Unknown or empty session, just return gracefully, the viewer
993 * knows what is happening.
995 if (!send_streams
|| !nb_streams
) {
997 goto end_put_session
;
1001 * Send stream and *DON'T* ignore the sent flag so every viewer
1002 * streams that were not sent from that point will be sent to
1005 ret
= send_viewer_streams(conn
->sock
, session_id
, 0);
1007 goto end_put_session
;
1012 session_put(session
);
1016 error_unlock_session
:
1017 pthread_mutex_unlock(&session
->lock
);
1018 session_put(session
);
1023 * Send the viewer the list of current sessions.
1026 int viewer_attach_session(struct relay_connection
*conn
)
1028 int send_streams
= 0;
1030 uint32_t nb_streams
= 0;
1031 enum lttng_viewer_seek seek_type
;
1032 struct lttng_viewer_attach_session_request request
;
1033 struct lttng_viewer_attach_session_response response
;
1034 struct relay_session
*session
= NULL
;
1035 bool closed
= false;
1036 uint64_t session_id
;
1040 health_code_update();
1042 /* Receive the request from the connected client. */
1043 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1048 session_id
= be64toh(request
.session_id
);
1049 health_code_update();
1051 memset(&response
, 0, sizeof(response
));
1053 if (!conn
->viewer_session
) {
1054 DBG("Client trying to attach before creating a live viewer session");
1055 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1059 session
= session_get_by_id(session_id
);
1061 DBG("Relay session %" PRIu64
" not found", session_id
);
1062 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1065 DBG("Attach session ID %" PRIu64
" received", session_id
);
1067 pthread_mutex_lock(&session
->lock
);
1068 if (session
->live_timer
== 0) {
1069 DBG("Not live session");
1070 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1075 ret
= viewer_session_attach(conn
->viewer_session
, session
);
1077 DBG("Already a viewer attached");
1078 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_ALREADY
);
1082 switch (be32toh(request
.seek
)) {
1083 case LTTNG_VIEWER_SEEK_BEGINNING
:
1084 case LTTNG_VIEWER_SEEK_LAST
:
1085 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1086 seek_type
= be32toh(request
.seek
);
1089 ERR("Wrong seek parameter");
1090 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1095 if (!conn
->viewer_session
->current_trace_chunk
&&
1096 session
->current_trace_chunk
) {
1097 ret
= viewer_session_set_trace_chunk(conn
->viewer_session
,
1098 session
->current_trace_chunk
);
1100 goto end_put_session
;
1103 ret
= make_viewer_streams(session
,
1104 conn
->viewer_session
->current_trace_chunk
, seek_type
,
1105 &nb_streams
, NULL
, NULL
, &closed
);
1107 goto end_put_session
;
1109 pthread_mutex_unlock(&session
->lock
);
1110 session_put(session
);
1113 response
.streams_count
= htobe32(nb_streams
);
1115 * If the session is closed when the viewer is attaching, it
1116 * means some of the streams may have been concurrently removed,
1117 * so we don't allow the viewer to attach, even if there are
1118 * streams available.
1122 response
.streams_count
= 0;
1123 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1128 health_code_update();
1129 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1131 goto end_put_session
;
1133 health_code_update();
1136 * Unknown or empty session, just return gracefully, the viewer
1137 * knows what is happening.
1139 if (!send_streams
|| !nb_streams
) {
1141 goto end_put_session
;
1144 /* Send stream and ignore the sent flag. */
1145 ret
= send_viewer_streams(conn
->sock
, session_id
, 1);
1147 goto end_put_session
;
1152 pthread_mutex_unlock(&session
->lock
);
1153 session_put(session
);
1160 * Open the index file if needed for the given vstream.
1162 * If an index file is successfully opened, the vstream will set it as its
1163 * current index file.
1165 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1167 * Called with rstream lock held.
1169 static int try_open_index(struct relay_viewer_stream
*vstream
,
1170 struct relay_stream
*rstream
)
1173 const uint32_t connection_major
= rstream
->trace
->session
->major
;
1174 const uint32_t connection_minor
= rstream
->trace
->session
->minor
;
1176 if (vstream
->index_file
) {
1181 * First time, we open the index file and at least one index is ready.
1183 if (rstream
->index_received_seqcount
== 0) {
1187 vstream
->index_file
= lttng_index_file_create_from_trace_chunk_read_only(
1188 vstream
->stream_file
.trace_chunk
, rstream
->path_name
,
1189 rstream
->channel_name
, rstream
->tracefile_size
,
1190 vstream
->current_tracefile_id
,
1191 lttng_to_index_major(connection_major
, connection_minor
),
1192 lttng_to_index_minor(connection_major
, connection_minor
));
1193 if (!vstream
->index_file
) {
1202 * Check the status of the index for the given stream. This function
1203 * updates the index structure if needed and can put (close) the vstream
1204 * in the HUP situation.
1206 * Return 0 means that we can proceed with the index. A value of 1 means
1207 * that the index has been updated and is ready to be sent to the
1208 * client. A negative value indicates an error that can't be handled.
1210 * Called with rstream lock held.
1212 static int check_index_status(struct relay_viewer_stream
*vstream
,
1213 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1214 struct lttng_viewer_index
*index
)
1218 if ((trace
->session
->connection_closed
|| rstream
->closed
)
1219 && rstream
->index_received_seqcount
1220 == vstream
->index_sent_seqcount
) {
1222 * Last index sent and session connection or relay
1223 * stream are closed.
1225 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1227 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1228 rstream
->index_received_seqcount
1229 == vstream
->index_sent_seqcount
) {
1231 * We've received a synchronization beacon and the last index
1232 * available has been sent, the index for now is inactive.
1234 * In this case, we have received a beacon which allows us to
1235 * inform the client of a time interval during which we can
1236 * guarantee that there are no events to read (and never will
1239 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1240 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1241 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1243 } else if (rstream
->index_received_seqcount
1244 == vstream
->index_sent_seqcount
) {
1246 * This checks whether received == sent seqcount. In
1247 * this case, we have not received a beacon. Therefore,
1248 * we can only ask the client to retry later.
1250 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1252 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1253 vstream
->current_tracefile_id
,
1254 vstream
->index_sent_seqcount
)) {
1256 * The next index we want to send cannot be read either
1257 * because we need to perform a rotation, or due to
1258 * the producer having overwritten its trace file.
1260 DBG("Viewer stream %" PRIu64
" rotation",
1261 vstream
->stream
->stream_handle
);
1262 ret
= viewer_stream_rotate(vstream
);
1265 } else if (ret
== 1) {
1266 /* EOF across entire stream. */
1267 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1271 * If we have been pushed due to overwrite, it
1272 * necessarily means there is data that can be read in
1273 * the stream. If we rotated because we reached the end
1274 * of a tracefile, it means the following tracefile
1275 * needs to contain at least one index, else we would
1276 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1277 * viewer. The updated index_sent_seqcount needs to
1278 * point to a readable index entry now.
1280 * In the case where we "rotate" on a single file, we
1281 * can end up in a case where the requested index is
1282 * still unavailable.
1284 if (rstream
->tracefile_count
== 1 &&
1285 !tracefile_array_seq_in_file(
1287 vstream
->current_tracefile_id
,
1288 vstream
->index_sent_seqcount
)) {
1289 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1292 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1293 vstream
->current_tracefile_id
,
1294 vstream
->index_sent_seqcount
));
1296 /* ret == 0 means successful so we continue. */
1302 viewer_stream_put(vstream
);
1308 * Send the next index for a stream.
1310 * Return 0 on success or else a negative value.
1313 int viewer_get_next_index(struct relay_connection
*conn
)
1316 struct lttng_viewer_get_next_index request_index
;
1317 struct lttng_viewer_index viewer_index
;
1318 struct ctf_packet_index packet_index
;
1319 struct relay_viewer_stream
*vstream
= NULL
;
1320 struct relay_stream
*rstream
= NULL
;
1321 struct ctf_trace
*ctf_trace
= NULL
;
1322 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1326 DBG("Viewer get next index");
1328 memset(&viewer_index
, 0, sizeof(viewer_index
));
1329 health_code_update();
1331 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1335 health_code_update();
1337 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1339 DBG("Client requested index of unknown stream id %" PRIu64
,
1340 (uint64_t) be64toh(request_index
.stream_id
));
1341 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1345 /* Use back. ref. Protected by refcounts. */
1346 rstream
= vstream
->stream
;
1347 ctf_trace
= rstream
->trace
;
1349 /* metadata_viewer_stream may be NULL. */
1350 metadata_viewer_stream
=
1351 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1353 pthread_mutex_lock(&rstream
->lock
);
1356 * The viewer should not ask for index on metadata stream.
1358 if (rstream
->is_metadata
) {
1359 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1363 /* Try to open an index if one is needed for that stream. */
1364 ret
= try_open_index(vstream
, rstream
);
1366 if (ret
== -ENOENT
) {
1368 * The index is created only when the first data
1369 * packet arrives, it might not be ready at the
1370 * beginning of the session
1372 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1374 /* Unhandled error. */
1375 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1380 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1383 } else if (ret
== 1) {
1385 * We have no index to send and check_index_status has populated
1386 * viewer_index's status.
1390 /* At this point, ret is 0 thus we will be able to read the index. */
1394 * vstream->stream_fd may be NULL if it has been closed by
1395 * tracefile rotation, or if we are at the beginning of the
1396 * stream. We open the data stream file here to protect against
1397 * overwrite caused by tracefile rotation (in association with
1398 * unlink performed before overwrite).
1400 if (!vstream
->stream_file
.fd
) {
1402 char file_path
[LTTNG_PATH_MAX
];
1403 enum lttng_trace_chunk_status status
;
1405 ret
= utils_stream_file_path(rstream
->path_name
,
1406 rstream
->channel_name
, rstream
->tracefile_size
,
1407 vstream
->current_tracefile_id
, NULL
, file_path
,
1413 status
= lttng_trace_chunk_open_file(
1414 vstream
->stream_file
.trace_chunk
,
1415 file_path
, O_RDONLY
, 0, &fd
);
1416 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1417 PERROR("Failed to open trace file for viewer stream");
1420 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1421 if (!vstream
->stream_file
.fd
) {
1423 PERROR("Failed to close viewer stream file");
1429 ret
= check_new_streams(conn
);
1431 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1433 } else if (ret
== 1) {
1434 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1437 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1439 ERR("Relay error reading index file %d",
1440 vstream
->index_file
->fd
);
1441 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1444 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1445 vstream
->index_sent_seqcount
++;
1449 * Indexes are stored in big endian, no need to switch before sending.
1451 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1452 rstream
->stream_handle
,
1453 (uint64_t) be64toh(packet_index
.offset
));
1454 viewer_index
.offset
= packet_index
.offset
;
1455 viewer_index
.packet_size
= packet_index
.packet_size
;
1456 viewer_index
.content_size
= packet_index
.content_size
;
1457 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1458 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1459 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1460 viewer_index
.stream_id
= packet_index
.stream_id
;
1464 pthread_mutex_unlock(&rstream
->lock
);
1467 if (metadata_viewer_stream
) {
1468 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1469 DBG("get next index metadata check: recv %" PRIu64
1471 metadata_viewer_stream
->stream
->metadata_received
,
1472 metadata_viewer_stream
->metadata_sent
);
1473 if (!metadata_viewer_stream
->stream
->metadata_received
||
1474 metadata_viewer_stream
->stream
->metadata_received
>
1475 metadata_viewer_stream
->metadata_sent
) {
1476 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1478 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1481 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1482 health_code_update();
1484 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1488 health_code_update();
1491 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1492 vstream
->index_sent_seqcount
,
1493 vstream
->stream
->stream_handle
);
1496 if (metadata_viewer_stream
) {
1497 viewer_stream_put(metadata_viewer_stream
);
1500 viewer_stream_put(vstream
);
1505 pthread_mutex_unlock(&rstream
->lock
);
1506 if (metadata_viewer_stream
) {
1507 viewer_stream_put(metadata_viewer_stream
);
1509 viewer_stream_put(vstream
);
1514 * Send the next index for a stream
1516 * Return 0 on success or else a negative value.
1519 int viewer_get_packet(struct relay_connection
*conn
)
1524 struct lttng_viewer_get_packet get_packet_info
;
1525 struct lttng_viewer_trace_packet reply_header
;
1526 struct relay_viewer_stream
*vstream
= NULL
;
1527 uint32_t reply_size
= sizeof(reply_header
);
1528 uint32_t packet_data_len
= 0;
1531 DBG2("Relay get data packet");
1533 health_code_update();
1535 ret
= recv_request(conn
->sock
, &get_packet_info
,
1536 sizeof(get_packet_info
));
1540 health_code_update();
1542 /* From this point on, the error label can be reached. */
1543 memset(&reply_header
, 0, sizeof(reply_header
));
1545 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1547 DBG("Client requested packet of unknown stream id %" PRIu64
,
1548 (uint64_t) be64toh(get_packet_info
.stream_id
));
1549 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1550 goto send_reply_nolock
;
1552 packet_data_len
= be32toh(get_packet_info
.len
);
1553 reply_size
+= packet_data_len
;
1556 reply
= zmalloc(reply_size
);
1558 PERROR("packet reply zmalloc");
1559 reply_size
= sizeof(reply_header
);
1563 pthread_mutex_lock(&vstream
->stream
->lock
);
1564 lseek_ret
= lseek(vstream
->stream_file
.fd
->fd
,
1565 be64toh(get_packet_info
.offset
), SEEK_SET
);
1566 if (lseek_ret
< 0) {
1567 PERROR("lseek fd %d to offset %" PRIu64
,
1568 vstream
->stream_file
.fd
->fd
,
1569 (uint64_t) be64toh(get_packet_info
.offset
));
1572 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
,
1573 reply
+ sizeof(reply_header
), packet_data_len
);
1574 if (read_len
< packet_data_len
) {
1575 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1576 vstream
->stream_file
.fd
->fd
,
1577 (uint64_t) be64toh(get_packet_info
.offset
));
1580 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1581 reply_header
.len
= htobe32(packet_data_len
);
1585 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1589 pthread_mutex_unlock(&vstream
->stream
->lock
);
1593 health_code_update();
1596 memcpy(reply
, &reply_header
, sizeof(reply_header
));
1597 ret
= send_response(conn
->sock
, reply
, reply_size
);
1599 /* No reply to send. */
1600 ret
= send_response(conn
->sock
, &reply_header
,
1604 health_code_update();
1606 PERROR("sendmsg of packet data failed");
1610 DBG("Sent %u bytes for stream %" PRIu64
, reply_size
,
1611 (uint64_t) be64toh(get_packet_info
.stream_id
));
1617 viewer_stream_put(vstream
);
1623 * Send the session's metadata
1625 * Return 0 on success else a negative value.
1628 int viewer_get_metadata(struct relay_connection
*conn
)
1634 struct lttng_viewer_get_metadata request
;
1635 struct lttng_viewer_metadata_packet reply
;
1636 struct relay_viewer_stream
*vstream
= NULL
;
1640 DBG("Relay get metadata");
1642 health_code_update();
1644 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1648 health_code_update();
1650 memset(&reply
, 0, sizeof(reply
));
1652 vstream
= viewer_stream_get_by_id(be64toh(request
.stream_id
));
1655 * The metadata stream can be closed by a CLOSE command
1656 * just before we attach. It can also be closed by
1657 * per-pid tracing during tracing. Therefore, it is
1658 * possible that we cannot find this viewer stream.
1659 * Reply back to the client with an error if we cannot
1662 DBG("Client requested metadata of unknown stream id %" PRIu64
,
1663 (uint64_t) be64toh(request
.stream_id
));
1664 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1667 pthread_mutex_lock(&vstream
->stream
->lock
);
1668 if (!vstream
->stream
->is_metadata
) {
1669 ERR("Invalid metadata stream");
1673 assert(vstream
->metadata_sent
<= vstream
->stream
->metadata_received
);
1675 len
= vstream
->stream
->metadata_received
- vstream
->metadata_sent
;
1677 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1681 /* first time, we open the metadata file */
1682 if (!vstream
->stream_file
.fd
) {
1684 char file_path
[LTTNG_PATH_MAX
];
1685 enum lttng_trace_chunk_status status
;
1686 struct relay_stream
*rstream
= vstream
->stream
;
1688 ret
= utils_stream_file_path(rstream
->path_name
,
1689 rstream
->channel_name
, rstream
->tracefile_size
,
1690 vstream
->current_tracefile_id
, NULL
, file_path
,
1696 status
= lttng_trace_chunk_open_file(
1697 vstream
->stream_file
.trace_chunk
,
1698 file_path
, O_RDONLY
, 0, &fd
);
1699 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1700 PERROR("Failed to open metadata file for viewer stream");
1703 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1704 if (!vstream
->stream_file
.fd
) {
1706 PERROR("Failed to close viewer metadata file");
1712 reply
.len
= htobe64(len
);
1713 data
= zmalloc(len
);
1715 PERROR("viewer metadata zmalloc");
1719 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
, data
, len
);
1720 if (read_len
< len
) {
1721 PERROR("Relay reading metadata file");
1724 vstream
->metadata_sent
+= read_len
;
1725 if (vstream
->metadata_sent
== vstream
->stream
->metadata_received
1726 && vstream
->stream
->closed
) {
1727 /* Release ownership for the viewer metadata stream. */
1728 viewer_stream_put(vstream
);
1731 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1736 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1739 health_code_update();
1741 pthread_mutex_unlock(&vstream
->stream
->lock
);
1743 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1747 health_code_update();
1750 ret
= send_response(conn
->sock
, data
, len
);
1756 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1757 (uint64_t) be64toh(request
.stream_id
));
1759 DBG("Metadata sent");
1765 viewer_stream_put(vstream
);
1771 * Create a viewer session.
1773 * Return 0 on success or else a negative value.
1776 int viewer_create_session(struct relay_connection
*conn
)
1779 struct lttng_viewer_create_session_response resp
;
1781 DBG("Viewer create session received");
1783 memset(&resp
, 0, sizeof(resp
));
1784 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
1785 conn
->viewer_session
= viewer_session_create();
1786 if (!conn
->viewer_session
) {
1787 ERR("Allocation viewer session");
1788 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
1793 health_code_update();
1794 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
1798 health_code_update();
1806 * Detach a viewer session.
1808 * Return 0 on success or else a negative value.
1811 int viewer_detach_session(struct relay_connection
*conn
)
1814 struct lttng_viewer_detach_session_response response
;
1815 struct lttng_viewer_detach_session_request request
;
1816 struct relay_session
*session
= NULL
;
1817 uint64_t viewer_session_to_close
;
1819 DBG("Viewer detach session received");
1823 health_code_update();
1825 /* Receive the request from the connected client. */
1826 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1830 viewer_session_to_close
= be64toh(request
.session_id
);
1832 if (!conn
->viewer_session
) {
1833 DBG("Client trying to detach before creating a live viewer session");
1834 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1838 health_code_update();
1840 memset(&response
, 0, sizeof(response
));
1841 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
1843 session
= session_get_by_id(be64toh(request
.session_id
));
1845 DBG("Relay session %" PRIu64
" not found",
1846 (uint64_t) be64toh(request
.session_id
));
1847 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
1851 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
1853 DBG("Not attached to this session");
1854 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1855 goto send_reply_put
;
1858 viewer_session_close_one_session(conn
->viewer_session
, session
);
1859 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
1860 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
1863 session_put(session
);
1866 health_code_update();
1867 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1871 health_code_update();
1879 * live_relay_unknown_command: send -1 if received unknown command
1882 void live_relay_unknown_command(struct relay_connection
*conn
)
1884 struct lttcomm_relayd_generic_reply reply
;
1886 memset(&reply
, 0, sizeof(reply
));
1887 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1888 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
1892 * Process the commands received on the control socket
1895 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1896 struct relay_connection
*conn
)
1901 msg_value
= be32toh(recv_hdr
->cmd
);
1904 * Make sure we've done the version check before any command other then a
1905 * new client connection.
1907 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
1908 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
1913 switch (msg_value
) {
1914 case LTTNG_VIEWER_CONNECT
:
1915 ret
= viewer_connect(conn
);
1917 case LTTNG_VIEWER_LIST_SESSIONS
:
1918 ret
= viewer_list_sessions(conn
);
1920 case LTTNG_VIEWER_ATTACH_SESSION
:
1921 ret
= viewer_attach_session(conn
);
1923 case LTTNG_VIEWER_GET_NEXT_INDEX
:
1924 ret
= viewer_get_next_index(conn
);
1926 case LTTNG_VIEWER_GET_PACKET
:
1927 ret
= viewer_get_packet(conn
);
1929 case LTTNG_VIEWER_GET_METADATA
:
1930 ret
= viewer_get_metadata(conn
);
1932 case LTTNG_VIEWER_GET_NEW_STREAMS
:
1933 ret
= viewer_get_new_streams(conn
);
1935 case LTTNG_VIEWER_CREATE_SESSION
:
1936 ret
= viewer_create_session(conn
);
1938 case LTTNG_VIEWER_DETACH_SESSION
:
1939 ret
= viewer_detach_session(conn
);
1942 ERR("Received unknown viewer command (%u)",
1943 be32toh(recv_hdr
->cmd
));
1944 live_relay_unknown_command(conn
);
1954 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
1958 (void) lttng_poll_del(events
, pollfd
);
1960 ret
= close(pollfd
);
1962 ERR("Closing pollfd %d", pollfd
);
1967 * This thread does the actual work
1970 void *thread_worker(void *data
)
1974 struct lttng_poll_event events
;
1975 struct lttng_ht
*viewer_connections_ht
;
1976 struct lttng_ht_iter iter
;
1977 struct lttng_viewer_cmd recv_hdr
;
1978 struct relay_connection
*destroy_conn
;
1980 DBG("[thread] Live viewer relay worker started");
1982 rcu_register_thread();
1984 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
1986 if (testpoint(relayd_thread_live_worker
)) {
1987 goto error_testpoint
;
1990 /* table of connections indexed on socket */
1991 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1992 if (!viewer_connections_ht
) {
1993 goto viewer_connections_ht_error
;
1996 ret
= create_thread_poll_set(&events
, 2);
1998 goto error_poll_create
;
2001 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2010 health_code_update();
2012 /* Infinite blocking call, waiting for transmission */
2013 DBG3("Relayd live viewer worker thread polling...");
2014 health_poll_entry();
2015 ret
= lttng_poll_wait(&events
, -1);
2019 * Restart interrupted system call.
2021 if (errno
== EINTR
) {
2030 * Process control. The control connection is prioritised so we don't
2031 * starve it with high throughput tracing data on the data
2034 for (i
= 0; i
< nb_fd
; i
++) {
2035 /* Fetch once the poll data */
2036 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2037 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2039 health_code_update();
2041 /* Thread quit pipe has been closed. Killing thread. */
2042 ret
= check_thread_quit_pipe(pollfd
, revents
);
2048 /* Inspect the relay conn pipe for new connection. */
2049 if (pollfd
== live_conn_pipe
[0]) {
2050 if (revents
& LPOLLIN
) {
2051 struct relay_connection
*conn
;
2053 ret
= lttng_read(live_conn_pipe
[0],
2054 &conn
, sizeof(conn
));
2058 ret
= lttng_poll_add(&events
,
2060 LPOLLIN
| LPOLLRDHUP
);
2062 ERR("Failed to add new live connection file descriptor to poll set");
2065 connection_ht_add(viewer_connections_ht
, conn
);
2066 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2067 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2068 ERR("Relay live pipe error");
2071 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2075 /* Connection activity. */
2076 struct relay_connection
*conn
;
2078 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2083 if (revents
& LPOLLIN
) {
2084 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2085 sizeof(recv_hdr
), 0);
2087 /* Connection closed. */
2088 cleanup_connection_pollfd(&events
, pollfd
);
2089 /* Put "create" ownership reference. */
2090 connection_put(conn
);
2091 DBG("Viewer control conn closed with %d", pollfd
);
2093 ret
= process_control(&recv_hdr
, conn
);
2095 /* Clear the session on error. */
2096 cleanup_connection_pollfd(&events
, pollfd
);
2097 /* Put "create" ownership reference. */
2098 connection_put(conn
);
2099 DBG("Viewer connection closed with %d", pollfd
);
2102 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2103 cleanup_connection_pollfd(&events
, pollfd
);
2104 /* Put "create" ownership reference. */
2105 connection_put(conn
);
2107 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2108 connection_put(conn
);
2111 /* Put local "get_by_sock" reference. */
2112 connection_put(conn
);
2119 lttng_poll_clean(&events
);
2121 /* Cleanup remaining connection object. */
2123 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2126 health_code_update();
2127 connection_put(destroy_conn
);
2131 lttng_ht_destroy(viewer_connections_ht
);
2132 viewer_connections_ht_error
:
2133 /* Close relay conn pipes */
2134 utils_close_pipe(live_conn_pipe
);
2136 DBG("Viewer worker thread exited with error");
2138 DBG("Viewer worker thread cleanup complete");
2142 ERR("Health error occurred in %s", __func__
);
2144 health_unregister(health_relayd
);
2145 if (lttng_relay_stop_threads()) {
2146 ERR("Error stopping threads");
2148 rcu_unregister_thread();
2153 * Create the relay command pipe to wake thread_manage_apps.
2154 * Closed in cleanup().
2156 static int create_conn_pipe(void)
2158 return utils_create_pipe_cloexec(live_conn_pipe
);
2161 int relayd_live_join(void)
2163 int ret
, retval
= 0;
2166 ret
= pthread_join(live_listener_thread
, &status
);
2169 PERROR("pthread_join live listener");
2173 ret
= pthread_join(live_worker_thread
, &status
);
2176 PERROR("pthread_join live worker");
2180 ret
= pthread_join(live_dispatcher_thread
, &status
);
2183 PERROR("pthread_join live dispatcher");
2187 cleanup_relayd_live();
2195 int relayd_live_create(struct lttng_uri
*uri
)
2197 int ret
= 0, retval
= 0;
2203 goto exit_init_data
;
2207 /* Check if daemon is UID = 0 */
2208 is_root
= !getuid();
2211 if (live_uri
->port
< 1024) {
2212 ERR("Need to be root to use ports < 1024");
2214 goto exit_init_data
;
2218 /* Setup the thread apps communication pipe. */
2219 if (create_conn_pipe()) {
2221 goto exit_init_data
;
2224 /* Init relay command queue. */
2225 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2227 /* Set up max poll set size */
2228 if (lttng_poll_set_max_size()) {
2230 goto exit_init_data
;
2233 /* Setup the dispatcher thread */
2234 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2235 thread_dispatcher
, (void *) NULL
);
2238 PERROR("pthread_create viewer dispatcher");
2240 goto exit_dispatcher_thread
;
2243 /* Setup the worker thread */
2244 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2245 thread_worker
, NULL
);
2248 PERROR("pthread_create viewer worker");
2250 goto exit_worker_thread
;
2253 /* Setup the listener thread */
2254 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2255 thread_listener
, (void *) NULL
);
2258 PERROR("pthread_create viewer listener");
2260 goto exit_listener_thread
;
2264 * All OK, started all threads.
2269 * Join on the live_listener_thread should anything be added after
2270 * the live_listener thread's creation.
2273 exit_listener_thread
:
2275 ret
= pthread_join(live_worker_thread
, &status
);
2278 PERROR("pthread_join live worker");
2283 ret
= pthread_join(live_dispatcher_thread
, &status
);
2286 PERROR("pthread_join live dispatcher");
2289 exit_dispatcher_thread
:
2292 cleanup_relayd_live();