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>
56 #include <common/fd-tracker/utils.h>
60 #include "lttng-relayd.h"
62 #include "health-relayd.h"
63 #include "testpoint.h"
64 #include "viewer-stream.h"
67 #include "ctf-trace.h"
68 #include "connection.h"
69 #include "viewer-session.h"
71 #define SESSION_BUF_DEFAULT_COUNT 16
73 static struct lttng_uri
*live_uri
;
76 * This pipe is used to inform the worker thread that a command is queued and
77 * ready to be processed.
79 static int live_conn_pipe
[2] = { -1, -1 };
81 /* Shared between threads */
82 static int live_dispatch_thread_exit
;
84 static pthread_t live_listener_thread
;
85 static pthread_t live_dispatcher_thread
;
86 static pthread_t live_worker_thread
;
89 * Relay command queue.
91 * The live_thread_listener and live_thread_dispatcher communicate with this
94 static struct relay_conn_queue viewer_conn_queue
;
96 static uint64_t last_relay_viewer_session_id
;
97 static pthread_mutex_t last_relay_viewer_session_id_lock
=
98 PTHREAD_MUTEX_INITIALIZER
;
104 void cleanup_relayd_live(void)
112 * Receive a request buffer using a given socket, destination allocated buffer
115 * Return the size of the received message or else a negative value on error
116 * with errno being set by recvmsg() syscall.
119 ssize_t
recv_request(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
123 ret
= sock
->ops
->recvmsg(sock
, buf
, size
, 0);
124 if (ret
< 0 || ret
!= size
) {
126 /* Orderly shutdown. Not necessary to print an error. */
127 DBG("Socket %d did an orderly shutdown", sock
->fd
);
129 ERR("Relay failed to receive request.");
138 * Send a response buffer using a given socket, source allocated buffer of
141 * Return the size of the sent message or else a negative value on error with
142 * errno being set by sendmsg() syscall.
145 ssize_t
send_response(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
149 ret
= sock
->ops
->sendmsg(sock
, buf
, size
, 0);
151 ERR("Relayd failed to send response.");
158 * Atomically check if new streams got added in one of the sessions attached
159 * and reset the flag to 0.
161 * Returns 1 if new streams got added, 0 if nothing changed, a negative value
165 int check_new_streams(struct relay_connection
*conn
)
167 struct relay_session
*session
;
168 unsigned long current_val
;
171 if (!conn
->viewer_session
) {
175 cds_list_for_each_entry_rcu(session
,
176 &conn
->viewer_session
->session_list
,
177 viewer_session_node
) {
178 if (!session_get(session
)) {
181 current_val
= uatomic_cmpxchg(&session
->new_streams
, 1, 0);
183 session_put(session
);
194 * Send viewer streams to the given socket. The ignore_sent_flag indicates if
195 * this function should ignore the sent flag or not.
197 * Return 0 on success or else a negative value.
200 ssize_t
send_viewer_streams(struct lttcomm_sock
*sock
,
201 struct relay_session
*session
, unsigned int ignore_sent_flag
)
204 struct lttng_viewer_stream send_stream
;
205 struct lttng_ht_iter iter
;
206 struct relay_viewer_stream
*vstream
;
210 cds_lfht_for_each_entry(viewer_streams_ht
->ht
, &iter
.iter
, vstream
,
212 struct ctf_trace
*ctf_trace
;
214 health_code_update();
216 if (!viewer_stream_get(vstream
)) {
220 pthread_mutex_lock(&vstream
->stream
->lock
);
221 /* Ignore if not the same session. */
222 if (vstream
->stream
->trace
->session
->id
!= session
->id
||
223 (!ignore_sent_flag
&& vstream
->sent_flag
)) {
224 pthread_mutex_unlock(&vstream
->stream
->lock
);
225 viewer_stream_put(vstream
);
229 ctf_trace
= vstream
->stream
->trace
;
230 send_stream
.id
= htobe64(vstream
->stream
->stream_handle
);
231 send_stream
.ctf_trace_id
= htobe64(ctf_trace
->id
);
232 send_stream
.metadata_flag
= htobe32(
233 vstream
->stream
->is_metadata
);
234 if (lttng_strncpy(send_stream
.path_name
, vstream
->path_name
,
235 sizeof(send_stream
.path_name
))) {
236 pthread_mutex_unlock(&vstream
->stream
->lock
);
237 viewer_stream_put(vstream
);
238 ret
= -1; /* Error. */
241 if (lttng_strncpy(send_stream
.channel_name
,
242 vstream
->channel_name
,
243 sizeof(send_stream
.channel_name
))) {
244 pthread_mutex_unlock(&vstream
->stream
->lock
);
245 viewer_stream_put(vstream
);
246 ret
= -1; /* Error. */
250 DBG("Sending stream %" PRIu64
" to viewer",
251 vstream
->stream
->stream_handle
);
252 vstream
->sent_flag
= 1;
253 pthread_mutex_unlock(&vstream
->stream
->lock
);
255 ret
= send_response(sock
, &send_stream
, sizeof(send_stream
));
256 viewer_stream_put(vstream
);
270 * Create every viewer stream possible for the given session with the seek
271 * type. Three counters *can* be return which are in order the total amount of
272 * viewer stream of the session, the number of unsent stream and the number of
273 * stream created. Those counters can be NULL and thus will be ignored.
275 * Return 0 on success or else a negative value.
278 int make_viewer_streams(struct relay_session
*session
,
279 enum lttng_viewer_seek seek_t
, uint32_t *nb_total
, uint32_t *nb_unsent
,
280 uint32_t *nb_created
, bool *closed
)
283 struct lttng_ht_iter iter
;
284 struct ctf_trace
*ctf_trace
;
289 * Hold the session lock to ensure that we see either none or
290 * all initial streams for a session, but no intermediate state.
292 pthread_mutex_lock(&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
, seek_t
);
330 ctf_trace_put(ctf_trace
);
336 /* Update number of created stream counter. */
340 * Ensure a self-reference is preserved even
341 * after we have put our local reference.
343 if (!viewer_stream_get(vstream
)) {
344 ERR("Unable to get self-reference on viewer stream, logic error.");
348 if (!vstream
->sent_flag
&& nb_unsent
) {
349 /* Update number of unsent stream counter. */
353 /* Update number of total stream counter. */
355 if (stream
->is_metadata
) {
356 if (!stream
->closed
||
357 stream
->metadata_received
> vstream
->metadata_sent
) {
361 if (!stream
->closed
||
362 !(((int64_t) (stream
->prev_seq
- stream
->last_net_seq_num
)) >= 0)) {
368 /* Put local reference. */
369 viewer_stream_put(vstream
);
373 ctf_trace_put(ctf_trace
);
380 pthread_mutex_unlock(&session
->lock
);
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_named_thread_poll_set(struct lttng_poll_event
*events
,
397 int size
, const char *name
)
401 if (events
== NULL
|| size
== 0) {
406 ret
= fd_tracker_util_poll_create(the_fd_tracker
,
407 name
, events
, 1, LTTNG_CLOEXEC
);
410 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
422 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
425 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
427 return create_named_thread_poll_set(events
, size
, "Unknown epoll");
431 * Check if the thread quit pipe was triggered.
433 * Return 1 if it was triggered else 0;
436 int check_thread_quit_pipe(int fd
, uint32_t events
)
438 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
446 * Create and init socket from uri.
449 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
)
452 struct lttcomm_sock
*sock
= NULL
;
454 sock
= lttcomm_alloc_sock_from_uri(uri
);
456 ERR("Allocating socket");
460 ret
= lttcomm_create_sock(sock
);
464 DBG("Listening on sock %d for live", sock
->fd
);
466 ret
= sock
->ops
->bind(sock
);
471 ret
= sock
->ops
->listen(sock
, -1);
481 lttcomm_destroy_sock(sock
);
487 * This thread manages the listening for new connections on the network
490 void *thread_listener(void *data
)
492 int i
, ret
, pollfd
, err
= -1;
493 uint32_t revents
, nb_fd
;
494 struct lttng_poll_event events
;
495 struct lttcomm_sock
*live_control_sock
;
497 DBG("[thread] Relay live listener started");
499 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
501 health_code_update();
503 live_control_sock
= init_socket(live_uri
);
504 if (!live_control_sock
) {
505 goto error_sock_control
;
508 /* Pass 2 as size here for the thread quit pipe and control sockets. */
509 ret
= create_named_thread_poll_set(&events
, 2,
510 "Live listener thread epoll");
512 goto error_create_poll
;
515 /* Add the control socket */
516 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
521 lttng_relay_notify_ready();
523 if (testpoint(relayd_thread_live_listener
)) {
524 goto error_testpoint
;
528 health_code_update();
530 DBG("Listener accepting live viewers connections");
534 ret
= lttng_poll_wait(&events
, -1);
538 * Restart interrupted system call.
540 if (errno
== EINTR
) {
547 DBG("Relay new viewer connection received");
548 for (i
= 0; i
< nb_fd
; i
++) {
549 health_code_update();
551 /* Fetch once the poll data */
552 revents
= LTTNG_POLL_GETEV(&events
, i
);
553 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
556 /* No activity for this FD (poll implementation). */
560 /* Thread quit pipe has been closed. Killing thread. */
561 ret
= check_thread_quit_pipe(pollfd
, revents
);
567 if (revents
& LPOLLIN
) {
569 * A new connection is requested, therefore a
570 * viewer connection is allocated in this
571 * thread, enqueued to a global queue and
572 * dequeued (and freed) in the worker thread.
575 struct relay_connection
*new_conn
;
576 struct lttcomm_sock
*newsock
;
578 newsock
= live_control_sock
->ops
->accept(live_control_sock
);
580 PERROR("accepting control sock");
583 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
585 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
588 PERROR("setsockopt inet");
589 lttcomm_destroy_sock(newsock
);
592 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
594 lttcomm_destroy_sock(newsock
);
597 /* Ownership assumed by the connection. */
600 /* Enqueue request for the dispatcher thread. */
601 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
605 * Wake the dispatch queue futex.
606 * Implicit memory barrier with the
607 * exchange in cds_wfcq_enqueue.
609 futex_nto1_wake(&viewer_conn_queue
.futex
);
610 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
611 ERR("socket poll error");
614 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
624 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
626 if (live_control_sock
->fd
>= 0) {
627 ret
= live_control_sock
->ops
->close(live_control_sock
);
632 lttcomm_destroy_sock(live_control_sock
);
636 DBG("Live viewer listener thread exited with error");
638 health_unregister(health_relayd
);
639 DBG("Live viewer listener thread cleanup complete");
640 if (lttng_relay_stop_threads()) {
641 ERR("Error stopping threads");
647 * This thread manages the dispatching of the requests to worker threads
650 void *thread_dispatcher(void *data
)
654 struct cds_wfcq_node
*node
;
655 struct relay_connection
*conn
= NULL
;
657 DBG("[thread] Live viewer relay dispatcher started");
659 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
661 if (testpoint(relayd_thread_live_dispatcher
)) {
662 goto error_testpoint
;
665 health_code_update();
668 health_code_update();
670 /* Atomically prepare the queue futex */
671 futex_nto1_prepare(&viewer_conn_queue
.futex
);
673 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
678 health_code_update();
680 /* Dequeue commands */
681 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
682 &viewer_conn_queue
.tail
);
684 DBG("Woken up but nothing in the live-viewer "
685 "relay command queue");
686 /* Continue thread execution */
689 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
690 DBG("Dispatching viewer request waiting on sock %d",
694 * Inform worker thread of the new request. This
695 * call is blocking so we can be assured that
696 * the data will be read at some point in time
697 * or wait to the end of the world :)
699 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
701 PERROR("write conn pipe");
702 connection_put(conn
);
705 } while (node
!= NULL
);
707 /* Futex wait on queue. Blocking call on futex() */
709 futex_nto1_wait(&viewer_conn_queue
.futex
);
713 /* Normal exit, no error */
720 ERR("Health error occurred in %s", __func__
);
722 health_unregister(health_relayd
);
723 DBG("Live viewer dispatch thread dying");
724 if (lttng_relay_stop_threads()) {
725 ERR("Error stopping threads");
731 * Establish connection with the viewer and check the versions.
733 * Return 0 on success or else negative value.
736 int viewer_connect(struct relay_connection
*conn
)
739 struct lttng_viewer_connect reply
, msg
;
741 conn
->version_check_done
= 1;
743 health_code_update();
745 DBG("Viewer is establishing a connection to the relayd.");
747 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
752 health_code_update();
754 memset(&reply
, 0, sizeof(reply
));
755 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
756 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
758 /* Major versions must be the same */
759 if (reply
.major
!= be32toh(msg
.major
)) {
760 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
761 reply
.major
, be32toh(msg
.major
));
766 conn
->major
= reply
.major
;
767 /* We adapt to the lowest compatible version */
768 if (reply
.minor
<= be32toh(msg
.minor
)) {
769 conn
->minor
= reply
.minor
;
771 conn
->minor
= be32toh(msg
.minor
);
774 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
775 conn
->type
= RELAY_VIEWER_COMMAND
;
776 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
777 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
779 ERR("Unknown connection type : %u", be32toh(msg
.type
));
784 reply
.major
= htobe32(reply
.major
);
785 reply
.minor
= htobe32(reply
.minor
);
786 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
788 * Increment outside of htobe64 macro, because the argument can
789 * be used more than once within the macro, and thus the
790 * operation may be undefined.
792 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
793 last_relay_viewer_session_id
++;
794 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
795 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
798 health_code_update();
800 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
805 health_code_update();
807 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
815 * Send the viewer the list of current sessions.
816 * We need to create a copy of the hash table content because otherwise
817 * we cannot assume the number of entries stays the same between getting
818 * the number of HT elements and iteration over the HT.
820 * Return 0 on success or else a negative value.
823 int viewer_list_sessions(struct relay_connection
*conn
)
826 struct lttng_viewer_list_sessions session_list
;
827 struct lttng_ht_iter iter
;
828 struct relay_session
*session
;
829 struct lttng_viewer_session
*send_session_buf
= NULL
;
830 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
833 DBG("List sessions received");
835 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
836 if (!send_session_buf
) {
841 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
843 struct lttng_viewer_session
*send_session
;
845 health_code_update();
847 if (count
>= buf_count
) {
848 struct lttng_viewer_session
*newbuf
;
849 uint32_t new_buf_count
= buf_count
<< 1;
851 newbuf
= realloc(send_session_buf
,
852 new_buf_count
* sizeof(*send_session_buf
));
857 send_session_buf
= newbuf
;
858 buf_count
= new_buf_count
;
860 send_session
= &send_session_buf
[count
];
861 if (lttng_strncpy(send_session
->session_name
,
862 session
->session_name
,
863 sizeof(send_session
->session_name
))) {
867 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
868 sizeof(send_session
->hostname
))) {
872 send_session
->id
= htobe64(session
->id
);
873 send_session
->live_timer
= htobe32(session
->live_timer
);
874 if (session
->viewer_attached
) {
875 send_session
->clients
= htobe32(1);
877 send_session
->clients
= htobe32(0);
879 send_session
->streams
= htobe32(session
->stream_count
);
887 session_list
.sessions_count
= htobe32(count
);
889 health_code_update();
891 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
896 health_code_update();
898 ret
= send_response(conn
->sock
, send_session_buf
,
899 count
* sizeof(*send_session_buf
));
903 health_code_update();
907 free(send_session_buf
);
912 * Send the viewer the list of current streams.
915 int viewer_get_new_streams(struct relay_connection
*conn
)
917 int ret
, send_streams
= 0;
918 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
919 struct lttng_viewer_new_streams_request request
;
920 struct lttng_viewer_new_streams_response response
;
921 struct relay_session
*session
;
927 DBG("Get new streams received");
929 health_code_update();
931 /* Receive the request from the connected client. */
932 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
936 session_id
= be64toh(request
.session_id
);
938 health_code_update();
940 memset(&response
, 0, sizeof(response
));
942 session
= session_get_by_id(session_id
);
944 DBG("Relay session %" PRIu64
" not found", session_id
);
945 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
949 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
951 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
956 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
958 ret
= make_viewer_streams(session
, LTTNG_VIEWER_SEEK_LAST
, &nb_total
, &nb_unsent
,
959 &nb_created
, &closed
);
961 goto end_put_session
;
963 /* Only send back the newly created streams with the unsent ones. */
964 nb_streams
= nb_created
+ nb_unsent
;
965 response
.streams_count
= htobe32(nb_streams
);
968 * If the session is closed, HUP when there are no more streams
971 if (closed
&& nb_total
== 0) {
973 response
.streams_count
= 0;
974 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
979 health_code_update();
980 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
982 goto end_put_session
;
984 health_code_update();
987 * Unknown or empty session, just return gracefully, the viewer
988 * knows what is happening.
990 if (!send_streams
|| !nb_streams
) {
992 goto end_put_session
;
996 * Send stream and *DON'T* ignore the sent flag so every viewer
997 * streams that were not sent from that point will be sent to
1000 ret
= send_viewer_streams(conn
->sock
, session
, 0);
1002 goto end_put_session
;
1007 session_put(session
);
1014 * Send the viewer the list of current sessions.
1017 int viewer_attach_session(struct relay_connection
*conn
)
1019 int send_streams
= 0;
1021 uint32_t nb_streams
= 0;
1022 enum lttng_viewer_seek seek_type
;
1023 struct lttng_viewer_attach_session_request request
;
1024 struct lttng_viewer_attach_session_response response
;
1025 struct relay_session
*session
= NULL
;
1026 bool closed
= false;
1030 health_code_update();
1032 /* Receive the request from the connected client. */
1033 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1038 health_code_update();
1040 memset(&response
, 0, sizeof(response
));
1042 if (!conn
->viewer_session
) {
1043 DBG("Client trying to attach before creating a live viewer session");
1044 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1048 session
= session_get_by_id(be64toh(request
.session_id
));
1050 DBG("Relay session %" PRIu64
" not found",
1051 (uint64_t) be64toh(request
.session_id
));
1052 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1055 DBG("Attach session ID %" PRIu64
" received",
1056 (uint64_t) be64toh(request
.session_id
));
1058 if (session
->live_timer
== 0) {
1059 DBG("Not live session");
1060 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1065 ret
= viewer_session_attach(conn
->viewer_session
, session
);
1067 DBG("Already a viewer attached");
1068 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_ALREADY
);
1072 switch (be32toh(request
.seek
)) {
1073 case LTTNG_VIEWER_SEEK_BEGINNING
:
1074 case LTTNG_VIEWER_SEEK_LAST
:
1075 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1076 seek_type
= be32toh(request
.seek
);
1079 ERR("Wrong seek parameter");
1080 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1085 ret
= make_viewer_streams(session
, seek_type
, &nb_streams
, NULL
,
1088 goto end_put_session
;
1090 response
.streams_count
= htobe32(nb_streams
);
1093 * If the session is closed when the viewer is attaching, it
1094 * means some of the streams may have been concurrently removed,
1095 * so we don't allow the viewer to attach, even if there are
1096 * streams available.
1100 response
.streams_count
= 0;
1101 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
1106 health_code_update();
1107 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1109 goto end_put_session
;
1111 health_code_update();
1114 * Unknown or empty session, just return gracefully, the viewer
1115 * knows what is happening.
1117 if (!send_streams
|| !nb_streams
) {
1119 goto end_put_session
;
1122 /* Send stream and ignore the sent flag. */
1123 ret
= send_viewer_streams(conn
->sock
, session
, 1);
1125 goto end_put_session
;
1130 session_put(session
);
1137 * Open the index file if needed for the given vstream.
1139 * If an index file is successfully opened, the vstream will set it as its
1140 * current index file.
1142 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1144 * Called with rstream lock held.
1146 static int try_open_index(struct relay_viewer_stream
*vstream
,
1147 struct relay_stream
*rstream
)
1151 if (vstream
->index_file
) {
1156 * First time, we open the index file and at least one index is ready.
1158 if (rstream
->index_received_seqcount
== 0) {
1162 vstream
->index_file
= lttng_index_file_open(vstream
->path_name
,
1163 vstream
->channel_name
,
1164 vstream
->stream
->tracefile_count
,
1165 vstream
->current_tracefile_id
);
1166 if (!vstream
->index_file
) {
1175 * Check the status of the index for the given stream. This function
1176 * updates the index structure if needed and can put (close) the vstream
1177 * in the HUP situation.
1179 * Return 0 means that we can proceed with the index. A value of 1 means
1180 * that the index has been updated and is ready to be sent to the
1181 * client. A negative value indicates an error that can't be handled.
1183 * Called with rstream lock held.
1185 static int check_index_status(struct relay_viewer_stream
*vstream
,
1186 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1187 struct lttng_viewer_index
*index
)
1191 if (trace
->session
->connection_closed
1192 && rstream
->index_received_seqcount
1193 == vstream
->index_sent_seqcount
) {
1194 /* Last index sent and session connection is closed. */
1195 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1197 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1198 rstream
->index_received_seqcount
1199 == vstream
->index_sent_seqcount
) {
1201 * We've received a synchronization beacon and the last index
1202 * available has been sent, the index for now is inactive.
1204 * In this case, we have received a beacon which allows us to
1205 * inform the client of a time interval during which we can
1206 * guarantee that there are no events to read (and never will
1209 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1210 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1211 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1213 } else if (rstream
->index_received_seqcount
1214 == vstream
->index_sent_seqcount
) {
1216 * This checks whether received == sent seqcount. In
1217 * this case, we have not received a beacon. Therefore,
1218 * we can only ask the client to retry later.
1220 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1222 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1223 vstream
->current_tracefile_id
,
1224 vstream
->index_sent_seqcount
)) {
1226 * The next index we want to send cannot be read either
1227 * because we need to perform a rotation, or due to
1228 * the producer having overwritten its trace file.
1230 DBG("Viewer stream %" PRIu64
" rotation",
1231 vstream
->stream
->stream_handle
);
1232 ret
= viewer_stream_rotate(vstream
);
1235 } else if (ret
== 1) {
1236 /* EOF across entire stream. */
1237 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1241 * If we have been pushed due to overwrite, it
1242 * necessarily means there is data that can be read in
1243 * the stream. If we rotated because we reached the end
1244 * of a tracefile, it means the following tracefile
1245 * needs to contain at least one index, else we would
1246 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1247 * viewer. The updated index_sent_seqcount needs to
1248 * point to a readable index entry now.
1250 * In the case where we "rotate" on a single file, we
1251 * can end up in a case where the requested index is
1252 * still unavailable.
1254 if (rstream
->tracefile_count
== 1 &&
1255 !tracefile_array_seq_in_file(
1257 vstream
->current_tracefile_id
,
1258 vstream
->index_sent_seqcount
)) {
1259 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1262 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1263 vstream
->current_tracefile_id
,
1264 vstream
->index_sent_seqcount
));
1266 /* ret == 0 means successful so we continue. */
1272 viewer_stream_put(vstream
);
1278 * Send the next index for a stream.
1280 * Return 0 on success or else a negative value.
1283 int viewer_get_next_index(struct relay_connection
*conn
)
1286 struct lttng_viewer_get_next_index request_index
;
1287 struct lttng_viewer_index viewer_index
;
1288 struct ctf_packet_index packet_index
;
1289 struct relay_viewer_stream
*vstream
= NULL
;
1290 struct relay_stream
*rstream
= NULL
;
1291 struct ctf_trace
*ctf_trace
= NULL
;
1292 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1296 DBG("Viewer get next index");
1298 memset(&viewer_index
, 0, sizeof(viewer_index
));
1299 health_code_update();
1301 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1305 health_code_update();
1307 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1309 DBG("Client requested index of unknown stream id %" PRIu64
,
1310 (uint64_t) be64toh(request_index
.stream_id
));
1311 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1315 /* Use back. ref. Protected by refcounts. */
1316 rstream
= vstream
->stream
;
1317 ctf_trace
= rstream
->trace
;
1319 /* metadata_viewer_stream may be NULL. */
1320 metadata_viewer_stream
=
1321 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1323 pthread_mutex_lock(&rstream
->lock
);
1326 * The viewer should not ask for index on metadata stream.
1328 if (rstream
->is_metadata
) {
1329 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1333 /* Try to open an index if one is needed for that stream. */
1334 ret
= try_open_index(vstream
, rstream
);
1336 if (ret
== -ENOENT
) {
1338 * The index is created only when the first data
1339 * packet arrives, it might not be ready at the
1340 * beginning of the session
1342 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1344 /* Unhandled error. */
1345 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1350 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1353 } else if (ret
== 1) {
1355 * We have no index to send and check_index_status has populated
1356 * viewer_index's status.
1360 /* At this point, ret is 0 thus we will be able to read the index. */
1364 * vstream->stream_fd may be NULL if it has been closed by
1365 * tracefile rotation, or if we are at the beginning of the
1366 * stream. We open the data stream file here to protect against
1367 * overwrite caused by tracefile rotation (in association with
1368 * unlink performed before overwrite).
1370 if (!vstream
->stream_fd
) {
1371 char fullpath
[PATH_MAX
];
1373 if (vstream
->stream
->tracefile_count
> 0) {
1374 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s_%" PRIu64
,
1376 vstream
->channel_name
,
1377 vstream
->current_tracefile_id
);
1379 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s",
1381 vstream
->channel_name
);
1386 ret
= open(fullpath
, O_RDONLY
);
1388 PERROR("Relay opening trace file");
1391 vstream
->stream_fd
= stream_fd_create(ret
);
1392 if (!vstream
->stream_fd
) {
1400 ret
= check_new_streams(conn
);
1402 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1404 } else if (ret
== 1) {
1405 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1408 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1410 ERR("Relay error reading index file %d",
1411 vstream
->index_file
->fd
);
1412 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1415 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1416 vstream
->index_sent_seqcount
++;
1420 * Indexes are stored in big endian, no need to switch before sending.
1422 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1423 rstream
->stream_handle
,
1424 (uint64_t) be64toh(packet_index
.offset
));
1425 viewer_index
.offset
= packet_index
.offset
;
1426 viewer_index
.packet_size
= packet_index
.packet_size
;
1427 viewer_index
.content_size
= packet_index
.content_size
;
1428 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1429 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1430 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1431 viewer_index
.stream_id
= packet_index
.stream_id
;
1435 pthread_mutex_unlock(&rstream
->lock
);
1438 if (metadata_viewer_stream
) {
1439 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1440 DBG("get next index metadata check: recv %" PRIu64
1442 metadata_viewer_stream
->stream
->metadata_received
,
1443 metadata_viewer_stream
->metadata_sent
);
1444 if (!metadata_viewer_stream
->stream
->metadata_received
||
1445 metadata_viewer_stream
->stream
->metadata_received
>
1446 metadata_viewer_stream
->metadata_sent
) {
1447 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1449 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1452 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1453 health_code_update();
1455 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1459 health_code_update();
1462 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1463 vstream
->index_sent_seqcount
,
1464 vstream
->stream
->stream_handle
);
1467 if (metadata_viewer_stream
) {
1468 viewer_stream_put(metadata_viewer_stream
);
1471 viewer_stream_put(vstream
);
1476 pthread_mutex_unlock(&rstream
->lock
);
1477 if (metadata_viewer_stream
) {
1478 viewer_stream_put(metadata_viewer_stream
);
1480 viewer_stream_put(vstream
);
1485 * Send the next index for a stream
1487 * Return 0 on success or else a negative value.
1490 int viewer_get_packet(struct relay_connection
*conn
)
1495 struct lttng_viewer_get_packet get_packet_info
;
1496 struct lttng_viewer_trace_packet reply_header
;
1497 struct relay_viewer_stream
*vstream
= NULL
;
1498 uint32_t reply_size
= sizeof(reply_header
);
1499 uint32_t packet_data_len
= 0;
1502 DBG2("Relay get data packet");
1504 health_code_update();
1506 ret
= recv_request(conn
->sock
, &get_packet_info
,
1507 sizeof(get_packet_info
));
1511 health_code_update();
1513 /* From this point on, the error label can be reached. */
1514 memset(&reply_header
, 0, sizeof(reply_header
));
1516 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1518 DBG("Client requested packet of unknown stream id %" PRIu64
,
1519 (uint64_t) be64toh(get_packet_info
.stream_id
));
1520 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1521 goto send_reply_nolock
;
1523 packet_data_len
= be32toh(get_packet_info
.len
);
1524 reply_size
+= packet_data_len
;
1527 reply
= zmalloc(reply_size
);
1529 PERROR("packet reply zmalloc");
1530 reply_size
= sizeof(reply_header
);
1534 pthread_mutex_lock(&vstream
->stream
->lock
);
1535 lseek_ret
= lseek(vstream
->stream_fd
->fd
, be64toh(get_packet_info
.offset
),
1537 if (lseek_ret
< 0) {
1538 PERROR("lseek fd %d to offset %" PRIu64
, vstream
->stream_fd
->fd
,
1539 (uint64_t) be64toh(get_packet_info
.offset
));
1542 read_len
= lttng_read(vstream
->stream_fd
->fd
,
1543 reply
+ sizeof(reply_header
),
1545 if (read_len
< packet_data_len
) {
1546 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1547 vstream
->stream_fd
->fd
,
1548 (uint64_t) be64toh(get_packet_info
.offset
));
1551 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1552 reply_header
.len
= htobe32(packet_data_len
);
1556 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1560 pthread_mutex_unlock(&vstream
->stream
->lock
);
1564 health_code_update();
1567 memcpy(reply
, &reply_header
, sizeof(reply_header
));
1568 ret
= send_response(conn
->sock
, reply
, reply_size
);
1570 /* No reply to send. */
1571 ret
= send_response(conn
->sock
, &reply_header
,
1575 health_code_update();
1577 PERROR("sendmsg of packet data failed");
1581 DBG("Sent %u bytes for stream %" PRIu64
, reply_size
,
1582 (uint64_t) be64toh(get_packet_info
.stream_id
));
1588 viewer_stream_put(vstream
);
1594 * Send the session's metadata
1596 * Return 0 on success else a negative value.
1599 int viewer_get_metadata(struct relay_connection
*conn
)
1605 struct lttng_viewer_get_metadata request
;
1606 struct lttng_viewer_metadata_packet reply
;
1607 struct relay_viewer_stream
*vstream
= NULL
;
1611 DBG("Relay get metadata");
1613 health_code_update();
1615 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1619 health_code_update();
1621 memset(&reply
, 0, sizeof(reply
));
1623 vstream
= viewer_stream_get_by_id(be64toh(request
.stream_id
));
1626 * The metadata stream can be closed by a CLOSE command
1627 * just before we attach. It can also be closed by
1628 * per-pid tracing during tracing. Therefore, it is
1629 * possible that we cannot find this viewer stream.
1630 * Reply back to the client with an error if we cannot
1633 DBG("Client requested metadata of unknown stream id %" PRIu64
,
1634 (uint64_t) be64toh(request
.stream_id
));
1635 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1638 pthread_mutex_lock(&vstream
->stream
->lock
);
1639 if (!vstream
->stream
->is_metadata
) {
1640 ERR("Invalid metadata stream");
1644 assert(vstream
->metadata_sent
<= vstream
->stream
->metadata_received
);
1646 len
= vstream
->stream
->metadata_received
- vstream
->metadata_sent
;
1648 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1652 /* first time, we open the metadata file */
1653 if (!vstream
->stream_fd
) {
1654 char fullpath
[PATH_MAX
];
1656 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s", vstream
->path_name
,
1657 vstream
->channel_name
);
1661 ret
= open(fullpath
, O_RDONLY
);
1663 PERROR("Relay opening metadata file");
1666 vstream
->stream_fd
= stream_fd_create(ret
);
1667 if (!vstream
->stream_fd
) {
1675 reply
.len
= htobe64(len
);
1676 data
= zmalloc(len
);
1678 PERROR("viewer metadata zmalloc");
1682 read_len
= lttng_read(vstream
->stream_fd
->fd
, data
, len
);
1683 if (read_len
< len
) {
1684 PERROR("Relay reading metadata file");
1687 vstream
->metadata_sent
+= read_len
;
1688 if (vstream
->metadata_sent
== vstream
->stream
->metadata_received
1689 && vstream
->stream
->closed
) {
1690 /* Release ownership for the viewer metadata stream. */
1691 viewer_stream_put(vstream
);
1694 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1699 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1702 health_code_update();
1704 pthread_mutex_unlock(&vstream
->stream
->lock
);
1706 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1710 health_code_update();
1713 ret
= send_response(conn
->sock
, data
, len
);
1719 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1720 (uint64_t) be64toh(request
.stream_id
));
1722 DBG("Metadata sent");
1728 viewer_stream_put(vstream
);
1734 * Create a viewer session.
1736 * Return 0 on success or else a negative value.
1739 int viewer_create_session(struct relay_connection
*conn
)
1742 struct lttng_viewer_create_session_response resp
;
1744 DBG("Viewer create session received");
1746 memset(&resp
, 0, sizeof(resp
));
1747 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
1748 conn
->viewer_session
= viewer_session_create();
1749 if (!conn
->viewer_session
) {
1750 ERR("Allocation viewer session");
1751 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
1756 health_code_update();
1757 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
1761 health_code_update();
1769 * Detach a viewer session.
1771 * Return 0 on success or else a negative value.
1774 int viewer_detach_session(struct relay_connection
*conn
)
1777 struct lttng_viewer_detach_session_response response
;
1778 struct lttng_viewer_detach_session_request request
;
1779 struct relay_session
*session
= NULL
;
1780 uint64_t viewer_session_to_close
;
1782 DBG("Viewer detach session received");
1786 health_code_update();
1788 /* Receive the request from the connected client. */
1789 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1793 viewer_session_to_close
= be64toh(request
.session_id
);
1795 if (!conn
->viewer_session
) {
1796 DBG("Client trying to detach before creating a live viewer session");
1797 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1801 health_code_update();
1803 memset(&response
, 0, sizeof(response
));
1804 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
1806 session
= session_get_by_id(be64toh(request
.session_id
));
1808 DBG("Relay session %" PRIu64
" not found",
1809 (uint64_t) be64toh(request
.session_id
));
1810 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
1814 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
1816 DBG("Not attached to this session");
1817 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1818 goto send_reply_put
;
1821 viewer_session_close_one_session(conn
->viewer_session
, session
);
1822 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
1823 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
1826 session_put(session
);
1829 health_code_update();
1830 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1834 health_code_update();
1842 * live_relay_unknown_command: send -1 if received unknown command
1845 void live_relay_unknown_command(struct relay_connection
*conn
)
1847 struct lttcomm_relayd_generic_reply reply
;
1849 memset(&reply
, 0, sizeof(reply
));
1850 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1851 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
1855 * Process the commands received on the control socket
1858 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1859 struct relay_connection
*conn
)
1864 msg_value
= be32toh(recv_hdr
->cmd
);
1867 * Make sure we've done the version check before any command other then a
1868 * new client connection.
1870 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
1871 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
1876 switch (msg_value
) {
1877 case LTTNG_VIEWER_CONNECT
:
1878 ret
= viewer_connect(conn
);
1880 case LTTNG_VIEWER_LIST_SESSIONS
:
1881 ret
= viewer_list_sessions(conn
);
1883 case LTTNG_VIEWER_ATTACH_SESSION
:
1884 ret
= viewer_attach_session(conn
);
1886 case LTTNG_VIEWER_GET_NEXT_INDEX
:
1887 ret
= viewer_get_next_index(conn
);
1889 case LTTNG_VIEWER_GET_PACKET
:
1890 ret
= viewer_get_packet(conn
);
1892 case LTTNG_VIEWER_GET_METADATA
:
1893 ret
= viewer_get_metadata(conn
);
1895 case LTTNG_VIEWER_GET_NEW_STREAMS
:
1896 ret
= viewer_get_new_streams(conn
);
1898 case LTTNG_VIEWER_CREATE_SESSION
:
1899 ret
= viewer_create_session(conn
);
1901 case LTTNG_VIEWER_DETACH_SESSION
:
1902 ret
= viewer_detach_session(conn
);
1905 ERR("Received unknown viewer command (%u)",
1906 be32toh(recv_hdr
->cmd
));
1907 live_relay_unknown_command(conn
);
1917 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
1921 (void) lttng_poll_del(events
, pollfd
);
1923 ret
= close(pollfd
);
1925 ERR("Closing pollfd %d", pollfd
);
1930 * This thread does the actual work
1933 void *thread_worker(void *data
)
1937 struct lttng_poll_event events
;
1938 struct lttng_ht
*viewer_connections_ht
;
1939 struct lttng_ht_iter iter
;
1940 struct lttng_viewer_cmd recv_hdr
;
1941 struct relay_connection
*destroy_conn
;
1943 DBG("[thread] Live viewer relay worker started");
1945 rcu_register_thread();
1947 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
1949 if (testpoint(relayd_thread_live_worker
)) {
1950 goto error_testpoint
;
1953 /* table of connections indexed on socket */
1954 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1955 if (!viewer_connections_ht
) {
1956 goto viewer_connections_ht_error
;
1959 ret
= create_thread_poll_set(&events
, 2);
1961 goto error_poll_create
;
1964 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1973 health_code_update();
1975 /* Infinite blocking call, waiting for transmission */
1976 DBG3("Relayd live viewer worker thread polling...");
1977 health_poll_entry();
1978 ret
= lttng_poll_wait(&events
, -1);
1982 * Restart interrupted system call.
1984 if (errno
== EINTR
) {
1993 * Process control. The control connection is prioritised so we don't
1994 * starve it with high throughput tracing data on the data
1997 for (i
= 0; i
< nb_fd
; i
++) {
1998 /* Fetch once the poll data */
1999 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2000 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2002 health_code_update();
2005 /* No activity for this FD (poll implementation). */
2009 /* Thread quit pipe has been closed. Killing thread. */
2010 ret
= check_thread_quit_pipe(pollfd
, revents
);
2016 /* Inspect the relay conn pipe for new connection. */
2017 if (pollfd
== live_conn_pipe
[0]) {
2018 if (revents
& LPOLLIN
) {
2019 struct relay_connection
*conn
;
2021 ret
= lttng_read(live_conn_pipe
[0],
2022 &conn
, sizeof(conn
));
2026 lttng_poll_add(&events
, conn
->sock
->fd
,
2027 LPOLLIN
| LPOLLRDHUP
);
2028 connection_ht_add(viewer_connections_ht
, conn
);
2029 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2030 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2031 ERR("Relay live pipe error");
2034 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2038 /* Connection activity. */
2039 struct relay_connection
*conn
;
2041 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2046 if (revents
& LPOLLIN
) {
2047 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2048 sizeof(recv_hdr
), 0);
2050 /* Connection closed. */
2051 cleanup_connection_pollfd(&events
, pollfd
);
2052 /* Put "create" ownership reference. */
2053 connection_put(conn
);
2054 DBG("Viewer control conn closed with %d", pollfd
);
2056 ret
= process_control(&recv_hdr
, conn
);
2058 /* Clear the session on error. */
2059 cleanup_connection_pollfd(&events
, pollfd
);
2060 /* Put "create" ownership reference. */
2061 connection_put(conn
);
2062 DBG("Viewer connection closed with %d", pollfd
);
2065 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2066 cleanup_connection_pollfd(&events
, pollfd
);
2067 /* Put "create" ownership reference. */
2068 connection_put(conn
);
2070 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2071 connection_put(conn
);
2074 /* Put local "get_by_sock" reference. */
2075 connection_put(conn
);
2082 lttng_poll_clean(&events
);
2084 /* Cleanup reamaining connection object. */
2086 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2089 health_code_update();
2090 connection_put(destroy_conn
);
2094 lttng_ht_destroy(viewer_connections_ht
);
2095 viewer_connections_ht_error
:
2096 /* Close relay conn pipes */
2097 (void) fd_tracker_util_pipe_close(the_fd_tracker
, live_conn_pipe
);
2099 DBG("Viewer worker thread exited with error");
2101 DBG("Viewer worker thread cleanup complete");
2105 ERR("Health error occurred in %s", __func__
);
2107 health_unregister(health_relayd
);
2108 if (lttng_relay_stop_threads()) {
2109 ERR("Error stopping threads");
2111 rcu_unregister_thread();
2116 * Create the relay command pipe to wake thread_manage_apps.
2117 * Closed in cleanup().
2119 static int create_conn_pipe(void)
2121 return fd_tracker_util_pipe_open_cloexec(the_fd_tracker
,
2122 "Live connection pipe", live_conn_pipe
);
2125 int relayd_live_join(void)
2127 int ret
, retval
= 0;
2130 ret
= pthread_join(live_listener_thread
, &status
);
2133 PERROR("pthread_join live listener");
2137 ret
= pthread_join(live_worker_thread
, &status
);
2140 PERROR("pthread_join live worker");
2144 ret
= pthread_join(live_dispatcher_thread
, &status
);
2147 PERROR("pthread_join live dispatcher");
2151 cleanup_relayd_live();
2159 int relayd_live_create(struct lttng_uri
*uri
)
2161 int ret
= 0, retval
= 0;
2167 goto exit_init_data
;
2171 /* Check if daemon is UID = 0 */
2172 is_root
= !getuid();
2175 if (live_uri
->port
< 1024) {
2176 ERR("Need to be root to use ports < 1024");
2178 goto exit_init_data
;
2182 /* Setup the thread apps communication pipe. */
2183 if (create_conn_pipe()) {
2185 goto exit_init_data
;
2188 /* Init relay command queue. */
2189 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2191 /* Set up max poll set size */
2192 if (lttng_poll_set_max_size()) {
2194 goto exit_init_data
;
2197 /* Setup the dispatcher thread */
2198 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2199 thread_dispatcher
, (void *) NULL
);
2202 PERROR("pthread_create viewer dispatcher");
2204 goto exit_dispatcher_thread
;
2207 /* Setup the worker thread */
2208 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2209 thread_worker
, NULL
);
2212 PERROR("pthread_create viewer worker");
2214 goto exit_worker_thread
;
2217 /* Setup the listener thread */
2218 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2219 thread_listener
, (void *) NULL
);
2222 PERROR("pthread_create viewer listener");
2224 goto exit_listener_thread
;
2228 * All OK, started all threads.
2233 * Join on the live_listener_thread should anything be added after
2234 * the live_listener thread's creation.
2237 exit_listener_thread
:
2239 ret
= pthread_join(live_worker_thread
, &status
);
2242 PERROR("pthread_join live worker");
2247 ret
= pthread_join(live_dispatcher_thread
, &status
);
2250 PERROR("pthread_join live dispatcher");
2253 exit_dispatcher_thread
:
2256 cleanup_relayd_live();