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 struct relay_session
*session
, 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 * Return 0 on success or else a negative value.
277 int make_viewer_streams(struct relay_session
*session
,
278 enum lttng_viewer_seek seek_t
, uint32_t *nb_total
, uint32_t *nb_unsent
,
279 uint32_t *nb_created
, bool *closed
)
282 struct lttng_ht_iter iter
;
283 struct ctf_trace
*ctf_trace
;
288 * Hold the session lock to ensure that we see either none or
289 * all initial streams for a session, but no intermediate state.
291 pthread_mutex_lock(&session
->lock
);
293 if (session
->connection_closed
) {
298 * Create viewer streams for relay streams that are ready to be
299 * used for a the given session id only.
302 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
, &iter
.iter
, ctf_trace
,
304 struct relay_stream
*stream
;
306 health_code_update();
308 if (!ctf_trace_get(ctf_trace
)) {
312 cds_list_for_each_entry_rcu(stream
, &ctf_trace
->stream_list
, stream_node
) {
313 struct relay_viewer_stream
*vstream
;
315 if (!stream_get(stream
)) {
319 * stream published is protected by the session lock.
321 if (!stream
->published
) {
324 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
326 vstream
= viewer_stream_create(stream
, seek_t
);
329 ctf_trace_put(ctf_trace
);
335 /* Update number of created stream counter. */
339 * Ensure a self-reference is preserved even
340 * after we have put our local reference.
342 if (!viewer_stream_get(vstream
)) {
343 ERR("Unable to get self-reference on viewer stream, logic error.");
347 if (!vstream
->sent_flag
&& nb_unsent
) {
348 /* Update number of unsent stream counter. */
352 /* Update number of total stream counter. */
354 if (stream
->is_metadata
) {
355 if (!stream
->closed
||
356 stream
->metadata_received
> vstream
->metadata_sent
) {
360 if (!stream
->closed
||
361 !(((int64_t) (stream
->prev_seq
- stream
->last_net_seq_num
)) >= 0)) {
367 /* Put local reference. */
368 viewer_stream_put(vstream
);
372 ctf_trace_put(ctf_trace
);
379 pthread_mutex_unlock(&session
->lock
);
383 int relayd_live_stop(void)
385 /* Stop dispatch thread */
386 CMM_STORE_SHARED(live_dispatch_thread_exit
, 1);
387 futex_nto1_wake(&viewer_conn_queue
.futex
);
392 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
395 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
399 if (events
== NULL
|| size
== 0) {
404 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
410 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
422 * Check if the thread quit pipe was triggered.
424 * Return 1 if it was triggered else 0;
427 int check_thread_quit_pipe(int fd
, uint32_t events
)
429 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
437 * Create and init socket from uri.
440 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
)
443 struct lttcomm_sock
*sock
= NULL
;
445 sock
= lttcomm_alloc_sock_from_uri(uri
);
447 ERR("Allocating socket");
451 ret
= lttcomm_create_sock(sock
);
455 DBG("Listening on sock %d for live", sock
->fd
);
457 ret
= sock
->ops
->bind(sock
);
462 ret
= sock
->ops
->listen(sock
, -1);
472 lttcomm_destroy_sock(sock
);
478 * This thread manages the listening for new connections on the network
481 void *thread_listener(void *data
)
483 int i
, ret
, pollfd
, err
= -1;
484 uint32_t revents
, nb_fd
;
485 struct lttng_poll_event events
;
486 struct lttcomm_sock
*live_control_sock
;
488 DBG("[thread] Relay live listener started");
490 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
492 health_code_update();
494 live_control_sock
= init_socket(live_uri
);
495 if (!live_control_sock
) {
496 goto error_sock_control
;
499 /* Pass 2 as size here for the thread quit pipe and control sockets. */
500 ret
= create_thread_poll_set(&events
, 2);
502 goto error_create_poll
;
505 /* Add the control socket */
506 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
511 lttng_relay_notify_ready();
513 if (testpoint(relayd_thread_live_listener
)) {
514 goto error_testpoint
;
518 health_code_update();
520 DBG("Listener accepting live viewers connections");
524 ret
= lttng_poll_wait(&events
, -1);
528 * Restart interrupted system call.
530 if (errno
== EINTR
) {
537 DBG("Relay new viewer connection received");
538 for (i
= 0; i
< nb_fd
; i
++) {
539 health_code_update();
541 /* Fetch once the poll data */
542 revents
= LTTNG_POLL_GETEV(&events
, i
);
543 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
546 /* No activity for this FD (poll implementation). */
550 /* Thread quit pipe has been closed. Killing thread. */
551 ret
= check_thread_quit_pipe(pollfd
, revents
);
557 if (revents
& LPOLLIN
) {
559 * A new connection is requested, therefore a
560 * viewer connection is allocated in this
561 * thread, enqueued to a global queue and
562 * dequeued (and freed) in the worker thread.
565 struct relay_connection
*new_conn
;
566 struct lttcomm_sock
*newsock
;
568 newsock
= live_control_sock
->ops
->accept(live_control_sock
);
570 PERROR("accepting control sock");
573 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
575 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
578 PERROR("setsockopt inet");
579 lttcomm_destroy_sock(newsock
);
582 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
584 lttcomm_destroy_sock(newsock
);
587 /* Ownership assumed by the connection. */
590 /* Enqueue request for the dispatcher thread. */
591 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
595 * Wake the dispatch queue futex.
596 * Implicit memory barrier with the
597 * exchange in cds_wfcq_enqueue.
599 futex_nto1_wake(&viewer_conn_queue
.futex
);
600 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
601 ERR("socket poll error");
604 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
614 lttng_poll_clean(&events
);
616 if (live_control_sock
->fd
>= 0) {
617 ret
= live_control_sock
->ops
->close(live_control_sock
);
622 lttcomm_destroy_sock(live_control_sock
);
626 DBG("Live viewer listener thread exited with error");
628 health_unregister(health_relayd
);
629 DBG("Live viewer listener thread cleanup complete");
630 if (lttng_relay_stop_threads()) {
631 ERR("Error stopping threads");
637 * This thread manages the dispatching of the requests to worker threads
640 void *thread_dispatcher(void *data
)
644 struct cds_wfcq_node
*node
;
645 struct relay_connection
*conn
= NULL
;
647 DBG("[thread] Live viewer relay dispatcher started");
649 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
651 if (testpoint(relayd_thread_live_dispatcher
)) {
652 goto error_testpoint
;
655 health_code_update();
658 health_code_update();
660 /* Atomically prepare the queue futex */
661 futex_nto1_prepare(&viewer_conn_queue
.futex
);
663 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
668 health_code_update();
670 /* Dequeue commands */
671 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
672 &viewer_conn_queue
.tail
);
674 DBG("Woken up but nothing in the live-viewer "
675 "relay command queue");
676 /* Continue thread execution */
679 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
680 DBG("Dispatching viewer request waiting on sock %d",
684 * Inform worker thread of the new request. This
685 * call is blocking so we can be assured that
686 * the data will be read at some point in time
687 * or wait to the end of the world :)
689 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
691 PERROR("write conn pipe");
692 connection_put(conn
);
695 } while (node
!= NULL
);
697 /* Futex wait on queue. Blocking call on futex() */
699 futex_nto1_wait(&viewer_conn_queue
.futex
);
703 /* Normal exit, no error */
710 ERR("Health error occurred in %s", __func__
);
712 health_unregister(health_relayd
);
713 DBG("Live viewer dispatch thread dying");
714 if (lttng_relay_stop_threads()) {
715 ERR("Error stopping threads");
721 * Establish connection with the viewer and check the versions.
723 * Return 0 on success or else negative value.
726 int viewer_connect(struct relay_connection
*conn
)
729 struct lttng_viewer_connect reply
, msg
;
731 conn
->version_check_done
= 1;
733 health_code_update();
735 DBG("Viewer is establishing a connection to the relayd.");
737 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
742 health_code_update();
744 memset(&reply
, 0, sizeof(reply
));
745 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
746 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
748 /* Major versions must be the same */
749 if (reply
.major
!= be32toh(msg
.major
)) {
750 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
751 reply
.major
, be32toh(msg
.major
));
756 conn
->major
= reply
.major
;
757 /* We adapt to the lowest compatible version */
758 if (reply
.minor
<= be32toh(msg
.minor
)) {
759 conn
->minor
= reply
.minor
;
761 conn
->minor
= be32toh(msg
.minor
);
764 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
765 conn
->type
= RELAY_VIEWER_COMMAND
;
766 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
767 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
769 ERR("Unknown connection type : %u", be32toh(msg
.type
));
774 reply
.major
= htobe32(reply
.major
);
775 reply
.minor
= htobe32(reply
.minor
);
776 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
778 * Increment outside of htobe64 macro, because the argument can
779 * be used more than once within the macro, and thus the
780 * operation may be undefined.
782 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
783 last_relay_viewer_session_id
++;
784 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
785 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
788 health_code_update();
790 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
795 health_code_update();
797 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
805 * Send the viewer the list of current sessions.
806 * We need to create a copy of the hash table content because otherwise
807 * we cannot assume the number of entries stays the same between getting
808 * the number of HT elements and iteration over the HT.
810 * Return 0 on success or else a negative value.
813 int viewer_list_sessions(struct relay_connection
*conn
)
816 struct lttng_viewer_list_sessions session_list
;
817 struct lttng_ht_iter iter
;
818 struct relay_session
*session
;
819 struct lttng_viewer_session
*send_session_buf
= NULL
;
820 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
823 DBG("List sessions received");
825 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
826 if (!send_session_buf
) {
831 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
833 struct lttng_viewer_session
*send_session
;
835 health_code_update();
837 if (session
->connection_closed
) {
838 /* Skip closed session */
842 if (count
>= buf_count
) {
843 struct lttng_viewer_session
*newbuf
;
844 uint32_t new_buf_count
= buf_count
<< 1;
846 newbuf
= realloc(send_session_buf
,
847 new_buf_count
* sizeof(*send_session_buf
));
852 send_session_buf
= newbuf
;
853 buf_count
= new_buf_count
;
855 send_session
= &send_session_buf
[count
];
856 if (lttng_strncpy(send_session
->session_name
,
857 session
->session_name
,
858 sizeof(send_session
->session_name
))) {
862 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
863 sizeof(send_session
->hostname
))) {
867 send_session
->id
= htobe64(session
->id
);
868 send_session
->live_timer
= htobe32(session
->live_timer
);
869 if (session
->viewer_attached
) {
870 send_session
->clients
= htobe32(1);
872 send_session
->clients
= htobe32(0);
874 send_session
->streams
= htobe32(session
->stream_count
);
882 session_list
.sessions_count
= htobe32(count
);
884 health_code_update();
886 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
891 health_code_update();
893 ret
= send_response(conn
->sock
, send_session_buf
,
894 count
* sizeof(*send_session_buf
));
898 health_code_update();
902 free(send_session_buf
);
907 * Send the viewer the list of current streams.
910 int viewer_get_new_streams(struct relay_connection
*conn
)
912 int ret
, send_streams
= 0;
913 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
914 struct lttng_viewer_new_streams_request request
;
915 struct lttng_viewer_new_streams_response response
;
916 struct relay_session
*session
;
922 DBG("Get new streams received");
924 health_code_update();
926 /* Receive the request from the connected client. */
927 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
931 session_id
= be64toh(request
.session_id
);
933 health_code_update();
935 memset(&response
, 0, sizeof(response
));
937 session
= session_get_by_id(session_id
);
939 DBG("Relay session %" PRIu64
" not found", session_id
);
940 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
944 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
946 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
951 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
953 ret
= make_viewer_streams(session
, LTTNG_VIEWER_SEEK_LAST
, &nb_total
, &nb_unsent
,
954 &nb_created
, &closed
);
956 goto end_put_session
;
958 /* Only send back the newly created streams with the unsent ones. */
959 nb_streams
= nb_created
+ nb_unsent
;
960 response
.streams_count
= htobe32(nb_streams
);
963 * If the session is closed, HUP when there are no more streams
966 if (closed
&& nb_total
== 0) {
968 response
.streams_count
= 0;
969 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
974 health_code_update();
975 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
977 goto end_put_session
;
979 health_code_update();
982 * Unknown or empty session, just return gracefully, the viewer
983 * knows what is happening.
985 if (!send_streams
|| !nb_streams
) {
987 goto end_put_session
;
991 * Send stream and *DON'T* ignore the sent flag so every viewer
992 * streams that were not sent from that point will be sent to
995 ret
= send_viewer_streams(conn
->sock
, session
, 0);
997 goto end_put_session
;
1002 session_put(session
);
1009 * Send the viewer the list of current sessions.
1012 int viewer_attach_session(struct relay_connection
*conn
)
1014 int send_streams
= 0;
1016 uint32_t nb_streams
= 0;
1017 enum lttng_viewer_seek seek_type
;
1018 struct lttng_viewer_attach_session_request request
;
1019 struct lttng_viewer_attach_session_response response
;
1020 struct relay_session
*session
= NULL
;
1021 bool closed
= false;
1025 health_code_update();
1027 /* Receive the request from the connected client. */
1028 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1033 health_code_update();
1035 memset(&response
, 0, sizeof(response
));
1037 if (!conn
->viewer_session
) {
1038 DBG("Client trying to attach before creating a live viewer session");
1039 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1043 session
= session_get_by_id(be64toh(request
.session_id
));
1045 DBG("Relay session %" PRIu64
" not found",
1046 (uint64_t) be64toh(request
.session_id
));
1047 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1050 DBG("Attach session ID %" PRIu64
" received",
1051 (uint64_t) be64toh(request
.session_id
));
1053 if (session
->live_timer
== 0) {
1054 DBG("Not live session");
1055 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1060 ret
= viewer_session_attach(conn
->viewer_session
, session
);
1062 DBG("Already a viewer attached");
1063 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_ALREADY
);
1067 switch (be32toh(request
.seek
)) {
1068 case LTTNG_VIEWER_SEEK_BEGINNING
:
1069 case LTTNG_VIEWER_SEEK_LAST
:
1070 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1071 seek_type
= be32toh(request
.seek
);
1074 ERR("Wrong seek parameter");
1075 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1080 ret
= make_viewer_streams(session
, seek_type
, &nb_streams
, NULL
,
1083 goto end_put_session
;
1085 response
.streams_count
= htobe32(nb_streams
);
1088 * If the session is closed when the viewer is attaching, it
1089 * means some of the streams may have been concurrently removed,
1090 * so we don't allow the viewer to attach, even if there are
1091 * streams available.
1095 response
.streams_count
= 0;
1096 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1101 health_code_update();
1102 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1104 goto end_put_session
;
1106 health_code_update();
1109 * Unknown or empty session, just return gracefully, the viewer
1110 * knows what is happening.
1112 if (!send_streams
|| !nb_streams
) {
1114 goto end_put_session
;
1117 /* Send stream and ignore the sent flag. */
1118 ret
= send_viewer_streams(conn
->sock
, session
, 1);
1120 goto end_put_session
;
1125 session_put(session
);
1132 * Open the index file if needed for the given vstream.
1134 * If an index file is successfully opened, the vstream will set it as its
1135 * current index file.
1137 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1139 * Called with rstream lock held.
1141 static int try_open_index(struct relay_viewer_stream
*vstream
,
1142 struct relay_stream
*rstream
)
1146 if (vstream
->index_file
) {
1151 * First time, we open the index file and at least one index is ready.
1153 if (rstream
->index_received_seqcount
== 0) {
1157 vstream
->index_file
= lttng_index_file_open(vstream
->path_name
,
1158 vstream
->channel_name
,
1159 vstream
->stream
->tracefile_count
,
1160 vstream
->current_tracefile_id
);
1161 if (!vstream
->index_file
) {
1170 * Check the status of the index for the given stream. This function
1171 * updates the index structure if needed and can put (close) the vstream
1172 * in the HUP situation.
1174 * Return 0 means that we can proceed with the index. A value of 1 means
1175 * that the index has been updated and is ready to be sent to the
1176 * client. A negative value indicates an error that can't be handled.
1178 * Called with rstream lock held.
1180 static int check_index_status(struct relay_viewer_stream
*vstream
,
1181 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1182 struct lttng_viewer_index
*index
)
1186 if (trace
->session
->connection_closed
1187 && rstream
->index_received_seqcount
1188 == vstream
->index_sent_seqcount
) {
1189 /* Last index sent and session connection is closed. */
1190 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1192 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1193 rstream
->index_received_seqcount
1194 == vstream
->index_sent_seqcount
) {
1196 * We've received a synchronization beacon and the last index
1197 * available has been sent, the index for now is inactive.
1199 * In this case, we have received a beacon which allows us to
1200 * inform the client of a time interval during which we can
1201 * guarantee that there are no events to read (and never will
1204 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1205 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1206 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1208 } else if (rstream
->index_received_seqcount
1209 == vstream
->index_sent_seqcount
) {
1211 * This checks whether received == sent seqcount. In
1212 * this case, we have not received a beacon. Therefore,
1213 * we can only ask the client to retry later.
1215 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1217 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1218 vstream
->current_tracefile_id
,
1219 vstream
->index_sent_seqcount
)) {
1221 * The next index we want to send cannot be read either
1222 * because we need to perform a rotation, or due to
1223 * the producer having overwritten its trace file.
1225 DBG("Viewer stream %" PRIu64
" rotation",
1226 vstream
->stream
->stream_handle
);
1227 ret
= viewer_stream_rotate(vstream
);
1230 } else if (ret
== 1) {
1231 /* EOF across entire stream. */
1232 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1236 * If we have been pushed due to overwrite, it
1237 * necessarily means there is data that can be read in
1238 * the stream. If we rotated because we reached the end
1239 * of a tracefile, it means the following tracefile
1240 * needs to contain at least one index, else we would
1241 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1242 * viewer. The updated index_sent_seqcount needs to
1243 * point to a readable index entry now.
1245 * In the case where we "rotate" on a single file, we
1246 * can end up in a case where the requested index is
1247 * still unavailable.
1249 if (rstream
->tracefile_count
== 1 &&
1250 !tracefile_array_seq_in_file(
1252 vstream
->current_tracefile_id
,
1253 vstream
->index_sent_seqcount
)) {
1254 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1257 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1258 vstream
->current_tracefile_id
,
1259 vstream
->index_sent_seqcount
));
1261 /* ret == 0 means successful so we continue. */
1267 viewer_stream_put(vstream
);
1273 * Send the next index for a stream.
1275 * Return 0 on success or else a negative value.
1278 int viewer_get_next_index(struct relay_connection
*conn
)
1281 struct lttng_viewer_get_next_index request_index
;
1282 struct lttng_viewer_index viewer_index
;
1283 struct ctf_packet_index packet_index
;
1284 struct relay_viewer_stream
*vstream
= NULL
;
1285 struct relay_stream
*rstream
= NULL
;
1286 struct ctf_trace
*ctf_trace
= NULL
;
1287 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1291 DBG("Viewer get next index");
1293 memset(&viewer_index
, 0, sizeof(viewer_index
));
1294 health_code_update();
1296 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1300 health_code_update();
1302 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1304 DBG("Client requested index of unknown stream id %" PRIu64
,
1305 (uint64_t) be64toh(request_index
.stream_id
));
1306 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1310 /* Use back. ref. Protected by refcounts. */
1311 rstream
= vstream
->stream
;
1312 ctf_trace
= rstream
->trace
;
1314 /* metadata_viewer_stream may be NULL. */
1315 metadata_viewer_stream
=
1316 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1318 pthread_mutex_lock(&rstream
->lock
);
1321 * The viewer should not ask for index on metadata stream.
1323 if (rstream
->is_metadata
) {
1324 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1328 /* Try to open an index if one is needed for that stream. */
1329 ret
= try_open_index(vstream
, rstream
);
1331 if (ret
== -ENOENT
) {
1333 * The index is created only when the first data
1334 * packet arrives, it might not be ready at the
1335 * beginning of the session
1337 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1339 /* Unhandled error. */
1340 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1345 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1348 } else if (ret
== 1) {
1350 * We have no index to send and check_index_status has populated
1351 * viewer_index's status.
1355 /* At this point, ret is 0 thus we will be able to read the index. */
1359 * vstream->stream_fd may be NULL if it has been closed by
1360 * tracefile rotation, or if we are at the beginning of the
1361 * stream. We open the data stream file here to protect against
1362 * overwrite caused by tracefile rotation (in association with
1363 * unlink performed before overwrite).
1365 if (!vstream
->stream_fd
) {
1366 char fullpath
[PATH_MAX
];
1368 if (vstream
->stream
->tracefile_count
> 0) {
1369 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s_%" PRIu64
,
1371 vstream
->channel_name
,
1372 vstream
->current_tracefile_id
);
1374 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s",
1376 vstream
->channel_name
);
1381 ret
= open(fullpath
, O_RDONLY
);
1383 PERROR("Relay opening trace file");
1386 vstream
->stream_fd
= stream_fd_create(ret
);
1387 if (!vstream
->stream_fd
) {
1395 ret
= check_new_streams(conn
);
1397 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1399 } else if (ret
== 1) {
1400 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1403 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1405 ERR("Relay error reading index file %d",
1406 vstream
->index_file
->fd
);
1407 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1410 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1411 vstream
->index_sent_seqcount
++;
1415 * Indexes are stored in big endian, no need to switch before sending.
1417 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1418 rstream
->stream_handle
,
1419 (uint64_t) be64toh(packet_index
.offset
));
1420 viewer_index
.offset
= packet_index
.offset
;
1421 viewer_index
.packet_size
= packet_index
.packet_size
;
1422 viewer_index
.content_size
= packet_index
.content_size
;
1423 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1424 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1425 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1426 viewer_index
.stream_id
= packet_index
.stream_id
;
1430 pthread_mutex_unlock(&rstream
->lock
);
1433 if (metadata_viewer_stream
) {
1434 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1435 DBG("get next index metadata check: recv %" PRIu64
1437 metadata_viewer_stream
->stream
->metadata_received
,
1438 metadata_viewer_stream
->metadata_sent
);
1439 if (!metadata_viewer_stream
->stream
->metadata_received
||
1440 metadata_viewer_stream
->stream
->metadata_received
>
1441 metadata_viewer_stream
->metadata_sent
) {
1442 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1444 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1447 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1448 health_code_update();
1450 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1454 health_code_update();
1457 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1458 vstream
->index_sent_seqcount
,
1459 vstream
->stream
->stream_handle
);
1462 if (metadata_viewer_stream
) {
1463 viewer_stream_put(metadata_viewer_stream
);
1466 viewer_stream_put(vstream
);
1471 pthread_mutex_unlock(&rstream
->lock
);
1472 if (metadata_viewer_stream
) {
1473 viewer_stream_put(metadata_viewer_stream
);
1475 viewer_stream_put(vstream
);
1480 * Send the next index for a stream
1482 * Return 0 on success or else a negative value.
1485 int viewer_get_packet(struct relay_connection
*conn
)
1490 struct lttng_viewer_get_packet get_packet_info
;
1491 struct lttng_viewer_trace_packet reply_header
;
1492 struct relay_viewer_stream
*vstream
= NULL
;
1493 uint32_t reply_size
= sizeof(reply_header
);
1494 uint32_t packet_data_len
= 0;
1497 DBG2("Relay get data packet");
1499 health_code_update();
1501 ret
= recv_request(conn
->sock
, &get_packet_info
,
1502 sizeof(get_packet_info
));
1506 health_code_update();
1508 /* From this point on, the error label can be reached. */
1509 memset(&reply_header
, 0, sizeof(reply_header
));
1511 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1513 DBG("Client requested packet of unknown stream id %" PRIu64
,
1514 (uint64_t) be64toh(get_packet_info
.stream_id
));
1515 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1516 goto send_reply_nolock
;
1518 packet_data_len
= be32toh(get_packet_info
.len
);
1519 reply_size
+= packet_data_len
;
1522 reply
= zmalloc(reply_size
);
1524 PERROR("packet reply zmalloc");
1525 reply_size
= sizeof(reply_header
);
1529 pthread_mutex_lock(&vstream
->stream
->lock
);
1530 lseek_ret
= lseek(vstream
->stream_fd
->fd
, be64toh(get_packet_info
.offset
),
1532 if (lseek_ret
< 0) {
1533 PERROR("lseek fd %d to offset %" PRIu64
, vstream
->stream_fd
->fd
,
1534 (uint64_t) be64toh(get_packet_info
.offset
));
1537 read_len
= lttng_read(vstream
->stream_fd
->fd
,
1538 reply
+ sizeof(reply_header
),
1540 if (read_len
< packet_data_len
) {
1541 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1542 vstream
->stream_fd
->fd
,
1543 (uint64_t) be64toh(get_packet_info
.offset
));
1546 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1547 reply_header
.len
= htobe32(packet_data_len
);
1551 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1555 pthread_mutex_unlock(&vstream
->stream
->lock
);
1559 health_code_update();
1562 memcpy(reply
, &reply_header
, sizeof(reply_header
));
1563 ret
= send_response(conn
->sock
, reply
, reply_size
);
1565 /* No reply to send. */
1566 ret
= send_response(conn
->sock
, &reply_header
,
1570 health_code_update();
1572 PERROR("sendmsg of packet data failed");
1576 DBG("Sent %u bytes for stream %" PRIu64
, reply_size
,
1577 (uint64_t) be64toh(get_packet_info
.stream_id
));
1583 viewer_stream_put(vstream
);
1589 * Send the session's metadata
1591 * Return 0 on success else a negative value.
1594 int viewer_get_metadata(struct relay_connection
*conn
)
1600 struct lttng_viewer_get_metadata request
;
1601 struct lttng_viewer_metadata_packet reply
;
1602 struct relay_viewer_stream
*vstream
= NULL
;
1606 DBG("Relay get metadata");
1608 health_code_update();
1610 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1614 health_code_update();
1616 memset(&reply
, 0, sizeof(reply
));
1618 vstream
= viewer_stream_get_by_id(be64toh(request
.stream_id
));
1621 * The metadata stream can be closed by a CLOSE command
1622 * just before we attach. It can also be closed by
1623 * per-pid tracing during tracing. Therefore, it is
1624 * possible that we cannot find this viewer stream.
1625 * Reply back to the client with an error if we cannot
1628 DBG("Client requested metadata of unknown stream id %" PRIu64
,
1629 (uint64_t) be64toh(request
.stream_id
));
1630 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1633 pthread_mutex_lock(&vstream
->stream
->lock
);
1634 if (!vstream
->stream
->is_metadata
) {
1635 ERR("Invalid metadata stream");
1639 assert(vstream
->metadata_sent
<= vstream
->stream
->metadata_received
);
1641 len
= vstream
->stream
->metadata_received
- vstream
->metadata_sent
;
1643 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1647 /* first time, we open the metadata file */
1648 if (!vstream
->stream_fd
) {
1649 char fullpath
[PATH_MAX
];
1651 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s", vstream
->path_name
,
1652 vstream
->channel_name
);
1656 ret
= open(fullpath
, O_RDONLY
);
1658 PERROR("Relay opening metadata file");
1661 vstream
->stream_fd
= stream_fd_create(ret
);
1662 if (!vstream
->stream_fd
) {
1670 reply
.len
= htobe64(len
);
1671 data
= zmalloc(len
);
1673 PERROR("viewer metadata zmalloc");
1677 read_len
= lttng_read(vstream
->stream_fd
->fd
, data
, len
);
1678 if (read_len
< len
) {
1679 PERROR("Relay reading metadata file");
1682 vstream
->metadata_sent
+= read_len
;
1683 if (vstream
->metadata_sent
== vstream
->stream
->metadata_received
1684 && vstream
->stream
->closed
) {
1685 /* Release ownership for the viewer metadata stream. */
1686 viewer_stream_put(vstream
);
1689 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1694 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1697 health_code_update();
1699 pthread_mutex_unlock(&vstream
->stream
->lock
);
1701 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1705 health_code_update();
1708 ret
= send_response(conn
->sock
, data
, len
);
1714 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1715 (uint64_t) be64toh(request
.stream_id
));
1717 DBG("Metadata sent");
1723 viewer_stream_put(vstream
);
1729 * Create a viewer session.
1731 * Return 0 on success or else a negative value.
1734 int viewer_create_session(struct relay_connection
*conn
)
1737 struct lttng_viewer_create_session_response resp
;
1739 DBG("Viewer create session received");
1741 memset(&resp
, 0, sizeof(resp
));
1742 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
1743 conn
->viewer_session
= viewer_session_create();
1744 if (!conn
->viewer_session
) {
1745 ERR("Allocation viewer session");
1746 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
1751 health_code_update();
1752 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
1756 health_code_update();
1764 * Detach a viewer session.
1766 * Return 0 on success or else a negative value.
1769 int viewer_detach_session(struct relay_connection
*conn
)
1772 struct lttng_viewer_detach_session_response response
;
1773 struct lttng_viewer_detach_session_request request
;
1774 struct relay_session
*session
= NULL
;
1775 uint64_t viewer_session_to_close
;
1777 DBG("Viewer detach session received");
1781 health_code_update();
1783 /* Receive the request from the connected client. */
1784 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1788 viewer_session_to_close
= be64toh(request
.session_id
);
1790 if (!conn
->viewer_session
) {
1791 DBG("Client trying to detach before creating a live viewer session");
1792 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1796 health_code_update();
1798 memset(&response
, 0, sizeof(response
));
1799 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
1801 session
= session_get_by_id(be64toh(request
.session_id
));
1803 DBG("Relay session %" PRIu64
" not found",
1804 (uint64_t) be64toh(request
.session_id
));
1805 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
1809 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
1811 DBG("Not attached to this session");
1812 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1813 goto send_reply_put
;
1816 viewer_session_close_one_session(conn
->viewer_session
, session
);
1817 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
1818 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
1821 session_put(session
);
1824 health_code_update();
1825 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1829 health_code_update();
1837 * live_relay_unknown_command: send -1 if received unknown command
1840 void live_relay_unknown_command(struct relay_connection
*conn
)
1842 struct lttcomm_relayd_generic_reply reply
;
1844 memset(&reply
, 0, sizeof(reply
));
1845 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1846 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
1850 * Process the commands received on the control socket
1853 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1854 struct relay_connection
*conn
)
1859 msg_value
= be32toh(recv_hdr
->cmd
);
1862 * Make sure we've done the version check before any command other then a
1863 * new client connection.
1865 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
1866 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
1871 switch (msg_value
) {
1872 case LTTNG_VIEWER_CONNECT
:
1873 ret
= viewer_connect(conn
);
1875 case LTTNG_VIEWER_LIST_SESSIONS
:
1876 ret
= viewer_list_sessions(conn
);
1878 case LTTNG_VIEWER_ATTACH_SESSION
:
1879 ret
= viewer_attach_session(conn
);
1881 case LTTNG_VIEWER_GET_NEXT_INDEX
:
1882 ret
= viewer_get_next_index(conn
);
1884 case LTTNG_VIEWER_GET_PACKET
:
1885 ret
= viewer_get_packet(conn
);
1887 case LTTNG_VIEWER_GET_METADATA
:
1888 ret
= viewer_get_metadata(conn
);
1890 case LTTNG_VIEWER_GET_NEW_STREAMS
:
1891 ret
= viewer_get_new_streams(conn
);
1893 case LTTNG_VIEWER_CREATE_SESSION
:
1894 ret
= viewer_create_session(conn
);
1896 case LTTNG_VIEWER_DETACH_SESSION
:
1897 ret
= viewer_detach_session(conn
);
1900 ERR("Received unknown viewer command (%u)",
1901 be32toh(recv_hdr
->cmd
));
1902 live_relay_unknown_command(conn
);
1912 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
1916 (void) lttng_poll_del(events
, pollfd
);
1918 ret
= close(pollfd
);
1920 ERR("Closing pollfd %d", pollfd
);
1925 * This thread does the actual work
1928 void *thread_worker(void *data
)
1932 struct lttng_poll_event events
;
1933 struct lttng_ht
*viewer_connections_ht
;
1934 struct lttng_ht_iter iter
;
1935 struct lttng_viewer_cmd recv_hdr
;
1936 struct relay_connection
*destroy_conn
;
1938 DBG("[thread] Live viewer relay worker started");
1940 rcu_register_thread();
1942 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
1944 if (testpoint(relayd_thread_live_worker
)) {
1945 goto error_testpoint
;
1948 /* table of connections indexed on socket */
1949 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1950 if (!viewer_connections_ht
) {
1951 goto viewer_connections_ht_error
;
1954 ret
= create_thread_poll_set(&events
, 2);
1956 goto error_poll_create
;
1959 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1968 health_code_update();
1970 /* Infinite blocking call, waiting for transmission */
1971 DBG3("Relayd live viewer worker thread polling...");
1972 health_poll_entry();
1973 ret
= lttng_poll_wait(&events
, -1);
1977 * Restart interrupted system call.
1979 if (errno
== EINTR
) {
1988 * Process control. The control connection is prioritised so we don't
1989 * starve it with high throughput tracing data on the data
1992 for (i
= 0; i
< nb_fd
; i
++) {
1993 /* Fetch once the poll data */
1994 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
1995 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1997 health_code_update();
2000 /* No activity for this FD (poll implementation). */
2004 /* Thread quit pipe has been closed. Killing thread. */
2005 ret
= check_thread_quit_pipe(pollfd
, revents
);
2011 /* Inspect the relay conn pipe for new connection. */
2012 if (pollfd
== live_conn_pipe
[0]) {
2013 if (revents
& LPOLLIN
) {
2014 struct relay_connection
*conn
;
2016 ret
= lttng_read(live_conn_pipe
[0],
2017 &conn
, sizeof(conn
));
2021 lttng_poll_add(&events
, conn
->sock
->fd
,
2022 LPOLLIN
| LPOLLRDHUP
);
2023 connection_ht_add(viewer_connections_ht
, conn
);
2024 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2025 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2026 ERR("Relay live pipe error");
2029 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2033 /* Connection activity. */
2034 struct relay_connection
*conn
;
2036 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2041 if (revents
& LPOLLIN
) {
2042 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2043 sizeof(recv_hdr
), 0);
2045 /* Connection closed. */
2046 cleanup_connection_pollfd(&events
, pollfd
);
2047 /* Put "create" ownership reference. */
2048 connection_put(conn
);
2049 DBG("Viewer control conn closed with %d", pollfd
);
2051 ret
= process_control(&recv_hdr
, conn
);
2053 /* Clear the session on error. */
2054 cleanup_connection_pollfd(&events
, pollfd
);
2055 /* Put "create" ownership reference. */
2056 connection_put(conn
);
2057 DBG("Viewer connection closed with %d", pollfd
);
2060 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2061 cleanup_connection_pollfd(&events
, pollfd
);
2062 /* Put "create" ownership reference. */
2063 connection_put(conn
);
2065 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2066 connection_put(conn
);
2069 /* Put local "get_by_sock" reference. */
2070 connection_put(conn
);
2077 lttng_poll_clean(&events
);
2079 /* Cleanup reamaining connection object. */
2081 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2084 health_code_update();
2085 connection_put(destroy_conn
);
2089 lttng_ht_destroy(viewer_connections_ht
);
2090 viewer_connections_ht_error
:
2091 /* Close relay conn pipes */
2092 utils_close_pipe(live_conn_pipe
);
2094 DBG("Viewer worker thread exited with error");
2096 DBG("Viewer worker thread cleanup complete");
2100 ERR("Health error occurred in %s", __func__
);
2102 health_unregister(health_relayd
);
2103 if (lttng_relay_stop_threads()) {
2104 ERR("Error stopping threads");
2106 rcu_unregister_thread();
2111 * Create the relay command pipe to wake thread_manage_apps.
2112 * Closed in cleanup().
2114 static int create_conn_pipe(void)
2116 return utils_create_pipe_cloexec(live_conn_pipe
);
2119 int relayd_live_join(void)
2121 int ret
, retval
= 0;
2124 ret
= pthread_join(live_listener_thread
, &status
);
2127 PERROR("pthread_join live listener");
2131 ret
= pthread_join(live_worker_thread
, &status
);
2134 PERROR("pthread_join live worker");
2138 ret
= pthread_join(live_dispatcher_thread
, &status
);
2141 PERROR("pthread_join live dispatcher");
2145 cleanup_relayd_live();
2153 int relayd_live_create(struct lttng_uri
*uri
)
2155 int ret
= 0, retval
= 0;
2161 goto exit_init_data
;
2165 /* Check if daemon is UID = 0 */
2166 is_root
= !getuid();
2169 if (live_uri
->port
< 1024) {
2170 ERR("Need to be root to use ports < 1024");
2172 goto exit_init_data
;
2176 /* Setup the thread apps communication pipe. */
2177 if (create_conn_pipe()) {
2179 goto exit_init_data
;
2182 /* Init relay command queue. */
2183 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2185 /* Set up max poll set size */
2186 if (lttng_poll_set_max_size()) {
2188 goto exit_init_data
;
2191 /* Setup the dispatcher thread */
2192 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2193 thread_dispatcher
, (void *) NULL
);
2196 PERROR("pthread_create viewer dispatcher");
2198 goto exit_dispatcher_thread
;
2201 /* Setup the worker thread */
2202 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2203 thread_worker
, NULL
);
2206 PERROR("pthread_create viewer worker");
2208 goto exit_worker_thread
;
2211 /* Setup the listener thread */
2212 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2213 thread_listener
, (void *) NULL
);
2216 PERROR("pthread_create viewer listener");
2218 goto exit_listener_thread
;
2222 * All OK, started all threads.
2227 * Join on the live_listener_thread should anything be added after
2228 * the live_listener thread's creation.
2231 exit_listener_thread
:
2233 ret
= pthread_join(live_worker_thread
, &status
);
2236 PERROR("pthread_join live worker");
2241 ret
= pthread_join(live_dispatcher_thread
, &status
);
2244 PERROR("pthread_join live dispatcher");
2247 exit_dispatcher_thread
:
2250 cleanup_relayd_live();