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 * 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_named_thread_poll_set(&events
, 2,
501 "Live listener thread epoll");
503 goto error_create_poll
;
506 /* Add the control socket */
507 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
512 lttng_relay_notify_ready();
514 if (testpoint(relayd_thread_live_listener
)) {
515 goto error_testpoint
;
519 health_code_update();
521 DBG("Listener accepting live viewers connections");
525 ret
= lttng_poll_wait(&events
, -1);
529 * Restart interrupted system call.
531 if (errno
== EINTR
) {
538 DBG("Relay new viewer connection received");
539 for (i
= 0; i
< nb_fd
; i
++) {
540 health_code_update();
542 /* Fetch once the poll data */
543 revents
= LTTNG_POLL_GETEV(&events
, i
);
544 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
547 /* No activity for this FD (poll implementation). */
551 /* Thread quit pipe has been closed. Killing thread. */
552 ret
= check_thread_quit_pipe(pollfd
, revents
);
558 if (revents
& LPOLLIN
) {
560 * A new connection is requested, therefore a
561 * viewer connection is allocated in this
562 * thread, enqueued to a global queue and
563 * dequeued (and freed) in the worker thread.
566 struct relay_connection
*new_conn
;
567 struct lttcomm_sock
*newsock
;
569 newsock
= live_control_sock
->ops
->accept(live_control_sock
);
571 PERROR("accepting control sock");
574 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
576 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
579 PERROR("setsockopt inet");
580 lttcomm_destroy_sock(newsock
);
583 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
585 lttcomm_destroy_sock(newsock
);
588 /* Ownership assumed by the connection. */
591 /* Enqueue request for the dispatcher thread. */
592 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
596 * Wake the dispatch queue futex.
597 * Implicit memory barrier with the
598 * exchange in cds_wfcq_enqueue.
600 futex_nto1_wake(&viewer_conn_queue
.futex
);
601 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
602 ERR("socket poll error");
605 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
615 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
617 if (live_control_sock
->fd
>= 0) {
618 ret
= live_control_sock
->ops
->close(live_control_sock
);
623 lttcomm_destroy_sock(live_control_sock
);
627 DBG("Live viewer listener thread exited with error");
629 health_unregister(health_relayd
);
630 DBG("Live viewer listener thread cleanup complete");
631 if (lttng_relay_stop_threads()) {
632 ERR("Error stopping threads");
638 * This thread manages the dispatching of the requests to worker threads
641 void *thread_dispatcher(void *data
)
645 struct cds_wfcq_node
*node
;
646 struct relay_connection
*conn
= NULL
;
648 DBG("[thread] Live viewer relay dispatcher started");
650 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
652 if (testpoint(relayd_thread_live_dispatcher
)) {
653 goto error_testpoint
;
656 health_code_update();
659 health_code_update();
661 /* Atomically prepare the queue futex */
662 futex_nto1_prepare(&viewer_conn_queue
.futex
);
664 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
669 health_code_update();
671 /* Dequeue commands */
672 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
673 &viewer_conn_queue
.tail
);
675 DBG("Woken up but nothing in the live-viewer "
676 "relay command queue");
677 /* Continue thread execution */
680 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
681 DBG("Dispatching viewer request waiting on sock %d",
685 * Inform worker thread of the new request. This
686 * call is blocking so we can be assured that
687 * the data will be read at some point in time
688 * or wait to the end of the world :)
690 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
692 PERROR("write conn pipe");
693 connection_put(conn
);
696 } while (node
!= NULL
);
698 /* Futex wait on queue. Blocking call on futex() */
700 futex_nto1_wait(&viewer_conn_queue
.futex
);
704 /* Normal exit, no error */
711 ERR("Health error occurred in %s", __func__
);
713 health_unregister(health_relayd
);
714 DBG("Live viewer dispatch thread dying");
715 if (lttng_relay_stop_threads()) {
716 ERR("Error stopping threads");
722 * Establish connection with the viewer and check the versions.
724 * Return 0 on success or else negative value.
727 int viewer_connect(struct relay_connection
*conn
)
730 struct lttng_viewer_connect reply
, msg
;
732 conn
->version_check_done
= 1;
734 health_code_update();
736 DBG("Viewer is establishing a connection to the relayd.");
738 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
743 health_code_update();
745 memset(&reply
, 0, sizeof(reply
));
746 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
747 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
749 /* Major versions must be the same */
750 if (reply
.major
!= be32toh(msg
.major
)) {
751 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
752 reply
.major
, be32toh(msg
.major
));
757 conn
->major
= reply
.major
;
758 /* We adapt to the lowest compatible version */
759 if (reply
.minor
<= be32toh(msg
.minor
)) {
760 conn
->minor
= reply
.minor
;
762 conn
->minor
= be32toh(msg
.minor
);
765 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
766 conn
->type
= RELAY_VIEWER_COMMAND
;
767 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
768 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
770 ERR("Unknown connection type : %u", be32toh(msg
.type
));
775 reply
.major
= htobe32(reply
.major
);
776 reply
.minor
= htobe32(reply
.minor
);
777 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
779 * Increment outside of htobe64 macro, because the argument can
780 * be used more than once within the macro, and thus the
781 * operation may be undefined.
783 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
784 last_relay_viewer_session_id
++;
785 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
786 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
789 health_code_update();
791 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
796 health_code_update();
798 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
806 * Send the viewer the list of current sessions.
807 * We need to create a copy of the hash table content because otherwise
808 * we cannot assume the number of entries stays the same between getting
809 * the number of HT elements and iteration over the HT.
811 * Return 0 on success or else a negative value.
814 int viewer_list_sessions(struct relay_connection
*conn
)
817 struct lttng_viewer_list_sessions session_list
;
818 struct lttng_ht_iter iter
;
819 struct relay_session
*session
;
820 struct lttng_viewer_session
*send_session_buf
= NULL
;
821 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
824 DBG("List sessions received");
826 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
827 if (!send_session_buf
) {
832 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
834 struct lttng_viewer_session
*send_session
;
836 health_code_update();
838 if (count
>= buf_count
) {
839 struct lttng_viewer_session
*newbuf
;
840 uint32_t new_buf_count
= buf_count
<< 1;
842 newbuf
= realloc(send_session_buf
,
843 new_buf_count
* sizeof(*send_session_buf
));
848 send_session_buf
= newbuf
;
849 buf_count
= new_buf_count
;
851 send_session
= &send_session_buf
[count
];
852 if (lttng_strncpy(send_session
->session_name
,
853 session
->session_name
,
854 sizeof(send_session
->session_name
))) {
858 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
859 sizeof(send_session
->hostname
))) {
863 send_session
->id
= htobe64(session
->id
);
864 send_session
->live_timer
= htobe32(session
->live_timer
);
865 if (session
->viewer_attached
) {
866 send_session
->clients
= htobe32(1);
868 send_session
->clients
= htobe32(0);
870 send_session
->streams
= htobe32(session
->stream_count
);
878 session_list
.sessions_count
= htobe32(count
);
880 health_code_update();
882 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
887 health_code_update();
889 ret
= send_response(conn
->sock
, send_session_buf
,
890 count
* sizeof(*send_session_buf
));
894 health_code_update();
898 free(send_session_buf
);
903 * Send the viewer the list of current streams.
906 int viewer_get_new_streams(struct relay_connection
*conn
)
908 int ret
, send_streams
= 0;
909 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
910 struct lttng_viewer_new_streams_request request
;
911 struct lttng_viewer_new_streams_response response
;
912 struct relay_session
*session
;
918 DBG("Get new streams received");
920 health_code_update();
922 /* Receive the request from the connected client. */
923 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
927 session_id
= be64toh(request
.session_id
);
929 health_code_update();
931 memset(&response
, 0, sizeof(response
));
933 session
= session_get_by_id(session_id
);
935 DBG("Relay session %" PRIu64
" not found", session_id
);
936 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
940 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
942 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
947 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
949 ret
= make_viewer_streams(session
, LTTNG_VIEWER_SEEK_LAST
, &nb_total
, &nb_unsent
,
950 &nb_created
, &closed
);
952 goto end_put_session
;
954 /* Only send back the newly created streams with the unsent ones. */
955 nb_streams
= nb_created
+ nb_unsent
;
956 response
.streams_count
= htobe32(nb_streams
);
959 * If the session is closed, HUP when there are no more streams
962 if (closed
&& nb_total
== 0) {
964 response
.streams_count
= 0;
965 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
970 health_code_update();
971 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
973 goto end_put_session
;
975 health_code_update();
978 * Unknown or empty session, just return gracefully, the viewer
979 * knows what is happening.
981 if (!send_streams
|| !nb_streams
) {
983 goto end_put_session
;
987 * Send stream and *DON'T* ignore the sent flag so every viewer
988 * streams that were not sent from that point will be sent to
991 ret
= send_viewer_streams(conn
->sock
, session
, 0);
993 goto end_put_session
;
998 session_put(session
);
1005 * Send the viewer the list of current sessions.
1008 int viewer_attach_session(struct relay_connection
*conn
)
1010 int send_streams
= 0;
1012 uint32_t nb_streams
= 0;
1013 enum lttng_viewer_seek seek_type
;
1014 struct lttng_viewer_attach_session_request request
;
1015 struct lttng_viewer_attach_session_response response
;
1016 struct relay_session
*session
= NULL
;
1017 bool closed
= false;
1021 health_code_update();
1023 /* Receive the request from the connected client. */
1024 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1029 health_code_update();
1031 memset(&response
, 0, sizeof(response
));
1033 if (!conn
->viewer_session
) {
1034 DBG("Client trying to attach before creating a live viewer session");
1035 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1039 session
= session_get_by_id(be64toh(request
.session_id
));
1041 DBG("Relay session %" PRIu64
" not found",
1042 (uint64_t) be64toh(request
.session_id
));
1043 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1046 DBG("Attach session ID %" PRIu64
" received",
1047 (uint64_t) be64toh(request
.session_id
));
1049 if (session
->live_timer
== 0) {
1050 DBG("Not live session");
1051 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1056 ret
= viewer_session_attach(conn
->viewer_session
, session
);
1058 DBG("Already a viewer attached");
1059 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_ALREADY
);
1063 switch (be32toh(request
.seek
)) {
1064 case LTTNG_VIEWER_SEEK_BEGINNING
:
1065 case LTTNG_VIEWER_SEEK_LAST
:
1066 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1067 seek_type
= be32toh(request
.seek
);
1070 ERR("Wrong seek parameter");
1071 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1076 ret
= make_viewer_streams(session
, seek_type
, &nb_streams
, NULL
,
1079 goto end_put_session
;
1081 response
.streams_count
= htobe32(nb_streams
);
1084 * If the session is closed when the viewer is attaching, it
1085 * means some of the streams may have been concurrently removed,
1086 * so we don't allow the viewer to attach, even if there are
1087 * streams available.
1091 response
.streams_count
= 0;
1092 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
1097 health_code_update();
1098 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1100 goto end_put_session
;
1102 health_code_update();
1105 * Unknown or empty session, just return gracefully, the viewer
1106 * knows what is happening.
1108 if (!send_streams
|| !nb_streams
) {
1110 goto end_put_session
;
1113 /* Send stream and ignore the sent flag. */
1114 ret
= send_viewer_streams(conn
->sock
, session
, 1);
1116 goto end_put_session
;
1121 session_put(session
);
1128 * Open the index file if needed for the given vstream.
1130 * If an index file is successfully opened, the vstream will set it as its
1131 * current index file.
1133 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1135 * Called with rstream lock held.
1137 static int try_open_index(struct relay_viewer_stream
*vstream
,
1138 struct relay_stream
*rstream
)
1142 if (vstream
->index_file
) {
1147 * First time, we open the index file and at least one index is ready.
1149 if (rstream
->index_received_seqcount
== 0) {
1153 vstream
->index_file
= lttng_index_file_open(vstream
->path_name
,
1154 vstream
->channel_name
,
1155 vstream
->stream
->tracefile_count
,
1156 vstream
->current_tracefile_id
);
1157 if (!vstream
->index_file
) {
1166 * Check the status of the index for the given stream. This function
1167 * updates the index structure if needed and can put (close) the vstream
1168 * in the HUP situation.
1170 * Return 0 means that we can proceed with the index. A value of 1 means
1171 * that the index has been updated and is ready to be sent to the
1172 * client. A negative value indicates an error that can't be handled.
1174 * Called with rstream lock held.
1176 static int check_index_status(struct relay_viewer_stream
*vstream
,
1177 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1178 struct lttng_viewer_index
*index
)
1182 if (trace
->session
->connection_closed
1183 && rstream
->index_received_seqcount
1184 == vstream
->index_sent_seqcount
) {
1185 /* Last index sent and session connection is closed. */
1186 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1188 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1189 rstream
->index_received_seqcount
1190 == vstream
->index_sent_seqcount
) {
1192 * We've received a synchronization beacon and the last index
1193 * available has been sent, the index for now is inactive.
1195 * In this case, we have received a beacon which allows us to
1196 * inform the client of a time interval during which we can
1197 * guarantee that there are no events to read (and never will
1200 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1201 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1202 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1204 } else if (rstream
->index_received_seqcount
1205 == vstream
->index_sent_seqcount
) {
1207 * This checks whether received == sent seqcount. In
1208 * this case, we have not received a beacon. Therefore,
1209 * we can only ask the client to retry later.
1211 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1213 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1214 vstream
->current_tracefile_id
,
1215 vstream
->index_sent_seqcount
)) {
1217 * The next index we want to send cannot be read either
1218 * because we need to perform a rotation, or due to
1219 * the producer having overwritten its trace file.
1221 DBG("Viewer stream %" PRIu64
" rotation",
1222 vstream
->stream
->stream_handle
);
1223 ret
= viewer_stream_rotate(vstream
);
1226 } else if (ret
== 1) {
1227 /* EOF across entire stream. */
1228 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1232 * If we have been pushed due to overwrite, it
1233 * necessarily means there is data that can be read in
1234 * the stream. If we rotated because we reached the end
1235 * of a tracefile, it means the following tracefile
1236 * needs to contain at least one index, else we would
1237 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1238 * viewer. The updated index_sent_seqcount needs to
1239 * point to a readable index entry now.
1241 * In the case where we "rotate" on a single file, we
1242 * can end up in a case where the requested index is
1243 * still unavailable.
1245 if (rstream
->tracefile_count
== 1 &&
1246 !tracefile_array_seq_in_file(
1248 vstream
->current_tracefile_id
,
1249 vstream
->index_sent_seqcount
)) {
1250 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1253 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1254 vstream
->current_tracefile_id
,
1255 vstream
->index_sent_seqcount
));
1257 /* ret == 0 means successful so we continue. */
1263 viewer_stream_put(vstream
);
1269 * Send the next index for a stream.
1271 * Return 0 on success or else a negative value.
1274 int viewer_get_next_index(struct relay_connection
*conn
)
1277 struct lttng_viewer_get_next_index request_index
;
1278 struct lttng_viewer_index viewer_index
;
1279 struct ctf_packet_index packet_index
;
1280 struct relay_viewer_stream
*vstream
= NULL
;
1281 struct relay_stream
*rstream
= NULL
;
1282 struct ctf_trace
*ctf_trace
= NULL
;
1283 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1287 DBG("Viewer get next index");
1289 memset(&viewer_index
, 0, sizeof(viewer_index
));
1290 health_code_update();
1292 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1296 health_code_update();
1298 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1300 DBG("Client requested index of unknown stream id %" PRIu64
,
1301 (uint64_t) be64toh(request_index
.stream_id
));
1302 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1306 /* Use back. ref. Protected by refcounts. */
1307 rstream
= vstream
->stream
;
1308 ctf_trace
= rstream
->trace
;
1310 /* metadata_viewer_stream may be NULL. */
1311 metadata_viewer_stream
=
1312 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1314 pthread_mutex_lock(&rstream
->lock
);
1317 * The viewer should not ask for index on metadata stream.
1319 if (rstream
->is_metadata
) {
1320 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1324 /* Try to open an index if one is needed for that stream. */
1325 ret
= try_open_index(vstream
, rstream
);
1327 if (ret
== -ENOENT
) {
1329 * The index is created only when the first data
1330 * packet arrives, it might not be ready at the
1331 * beginning of the session
1333 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1335 /* Unhandled error. */
1336 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1341 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1344 } else if (ret
== 1) {
1346 * We have no index to send and check_index_status has populated
1347 * viewer_index's status.
1351 /* At this point, ret is 0 thus we will be able to read the index. */
1355 * vstream->stream_fd may be NULL if it has been closed by
1356 * tracefile rotation, or if we are at the beginning of the
1357 * stream. We open the data stream file here to protect against
1358 * overwrite caused by tracefile rotation (in association with
1359 * unlink performed before overwrite).
1361 if (!vstream
->stream_fd
) {
1362 char fullpath
[PATH_MAX
];
1364 if (vstream
->stream
->tracefile_count
> 0) {
1365 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s_%" PRIu64
,
1367 vstream
->channel_name
,
1368 vstream
->current_tracefile_id
);
1370 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s",
1372 vstream
->channel_name
);
1377 ret
= open(fullpath
, O_RDONLY
);
1379 PERROR("Relay opening trace file");
1382 vstream
->stream_fd
= stream_fd_create(ret
);
1383 if (!vstream
->stream_fd
) {
1391 ret
= check_new_streams(conn
);
1393 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1395 } else if (ret
== 1) {
1396 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1399 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1401 ERR("Relay error reading index file %d",
1402 vstream
->index_file
->fd
);
1403 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1406 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1407 vstream
->index_sent_seqcount
++;
1411 * Indexes are stored in big endian, no need to switch before sending.
1413 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1414 rstream
->stream_handle
,
1415 (uint64_t) be64toh(packet_index
.offset
));
1416 viewer_index
.offset
= packet_index
.offset
;
1417 viewer_index
.packet_size
= packet_index
.packet_size
;
1418 viewer_index
.content_size
= packet_index
.content_size
;
1419 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1420 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1421 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1422 viewer_index
.stream_id
= packet_index
.stream_id
;
1426 pthread_mutex_unlock(&rstream
->lock
);
1429 if (metadata_viewer_stream
) {
1430 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1431 DBG("get next index metadata check: recv %" PRIu64
1433 metadata_viewer_stream
->stream
->metadata_received
,
1434 metadata_viewer_stream
->metadata_sent
);
1435 if (!metadata_viewer_stream
->stream
->metadata_received
||
1436 metadata_viewer_stream
->stream
->metadata_received
>
1437 metadata_viewer_stream
->metadata_sent
) {
1438 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1440 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1443 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1444 health_code_update();
1446 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1450 health_code_update();
1453 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1454 vstream
->index_sent_seqcount
,
1455 vstream
->stream
->stream_handle
);
1458 if (metadata_viewer_stream
) {
1459 viewer_stream_put(metadata_viewer_stream
);
1462 viewer_stream_put(vstream
);
1467 pthread_mutex_unlock(&rstream
->lock
);
1468 if (metadata_viewer_stream
) {
1469 viewer_stream_put(metadata_viewer_stream
);
1471 viewer_stream_put(vstream
);
1476 * Send the next index for a stream
1478 * Return 0 on success or else a negative value.
1481 int viewer_get_packet(struct relay_connection
*conn
)
1486 struct lttng_viewer_get_packet get_packet_info
;
1487 struct lttng_viewer_trace_packet reply_header
;
1488 struct relay_viewer_stream
*vstream
= NULL
;
1489 uint32_t reply_size
= sizeof(reply_header
);
1490 uint32_t packet_data_len
= 0;
1493 DBG2("Relay get data packet");
1495 health_code_update();
1497 ret
= recv_request(conn
->sock
, &get_packet_info
,
1498 sizeof(get_packet_info
));
1502 health_code_update();
1504 /* From this point on, the error label can be reached. */
1505 memset(&reply_header
, 0, sizeof(reply_header
));
1507 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1509 DBG("Client requested packet of unknown stream id %" PRIu64
,
1510 (uint64_t) be64toh(get_packet_info
.stream_id
));
1511 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1512 goto send_reply_nolock
;
1514 packet_data_len
= be32toh(get_packet_info
.len
);
1515 reply_size
+= packet_data_len
;
1518 reply
= zmalloc(reply_size
);
1520 PERROR("packet reply zmalloc");
1521 reply_size
= sizeof(reply_header
);
1525 pthread_mutex_lock(&vstream
->stream
->lock
);
1526 lseek_ret
= lseek(vstream
->stream_fd
->fd
, be64toh(get_packet_info
.offset
),
1528 if (lseek_ret
< 0) {
1529 PERROR("lseek fd %d to offset %" PRIu64
, vstream
->stream_fd
->fd
,
1530 (uint64_t) be64toh(get_packet_info
.offset
));
1533 read_len
= lttng_read(vstream
->stream_fd
->fd
,
1534 reply
+ sizeof(reply_header
),
1536 if (read_len
< packet_data_len
) {
1537 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1538 vstream
->stream_fd
->fd
,
1539 (uint64_t) be64toh(get_packet_info
.offset
));
1542 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1543 reply_header
.len
= htobe32(packet_data_len
);
1547 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1551 pthread_mutex_unlock(&vstream
->stream
->lock
);
1555 health_code_update();
1558 memcpy(reply
, &reply_header
, sizeof(reply_header
));
1559 ret
= send_response(conn
->sock
, reply
, reply_size
);
1561 /* No reply to send. */
1562 ret
= send_response(conn
->sock
, &reply_header
,
1566 health_code_update();
1568 PERROR("sendmsg of packet data failed");
1572 DBG("Sent %u bytes for stream %" PRIu64
, reply_size
,
1573 (uint64_t) be64toh(get_packet_info
.stream_id
));
1579 viewer_stream_put(vstream
);
1585 * Send the session's metadata
1587 * Return 0 on success else a negative value.
1590 int viewer_get_metadata(struct relay_connection
*conn
)
1596 struct lttng_viewer_get_metadata request
;
1597 struct lttng_viewer_metadata_packet reply
;
1598 struct relay_viewer_stream
*vstream
= NULL
;
1602 DBG("Relay get metadata");
1604 health_code_update();
1606 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1610 health_code_update();
1612 memset(&reply
, 0, sizeof(reply
));
1614 vstream
= viewer_stream_get_by_id(be64toh(request
.stream_id
));
1617 * The metadata stream can be closed by a CLOSE command
1618 * just before we attach. It can also be closed by
1619 * per-pid tracing during tracing. Therefore, it is
1620 * possible that we cannot find this viewer stream.
1621 * Reply back to the client with an error if we cannot
1624 DBG("Client requested metadata of unknown stream id %" PRIu64
,
1625 (uint64_t) be64toh(request
.stream_id
));
1626 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1629 pthread_mutex_lock(&vstream
->stream
->lock
);
1630 if (!vstream
->stream
->is_metadata
) {
1631 ERR("Invalid metadata stream");
1635 assert(vstream
->metadata_sent
<= vstream
->stream
->metadata_received
);
1637 len
= vstream
->stream
->metadata_received
- vstream
->metadata_sent
;
1639 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1643 /* first time, we open the metadata file */
1644 if (!vstream
->stream_fd
) {
1645 char fullpath
[PATH_MAX
];
1647 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s", vstream
->path_name
,
1648 vstream
->channel_name
);
1652 ret
= open(fullpath
, O_RDONLY
);
1654 PERROR("Relay opening metadata file");
1657 vstream
->stream_fd
= stream_fd_create(ret
);
1658 if (!vstream
->stream_fd
) {
1666 reply
.len
= htobe64(len
);
1667 data
= zmalloc(len
);
1669 PERROR("viewer metadata zmalloc");
1673 read_len
= lttng_read(vstream
->stream_fd
->fd
, data
, len
);
1674 if (read_len
< len
) {
1675 PERROR("Relay reading metadata file");
1678 vstream
->metadata_sent
+= read_len
;
1679 if (vstream
->metadata_sent
== vstream
->stream
->metadata_received
1680 && vstream
->stream
->closed
) {
1681 /* Release ownership for the viewer metadata stream. */
1682 viewer_stream_put(vstream
);
1685 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1690 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1693 health_code_update();
1695 pthread_mutex_unlock(&vstream
->stream
->lock
);
1697 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1701 health_code_update();
1704 ret
= send_response(conn
->sock
, data
, len
);
1710 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1711 (uint64_t) be64toh(request
.stream_id
));
1713 DBG("Metadata sent");
1719 viewer_stream_put(vstream
);
1725 * Create a viewer session.
1727 * Return 0 on success or else a negative value.
1730 int viewer_create_session(struct relay_connection
*conn
)
1733 struct lttng_viewer_create_session_response resp
;
1735 DBG("Viewer create session received");
1737 memset(&resp
, 0, sizeof(resp
));
1738 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
1739 conn
->viewer_session
= viewer_session_create();
1740 if (!conn
->viewer_session
) {
1741 ERR("Allocation viewer session");
1742 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
1747 health_code_update();
1748 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
1752 health_code_update();
1760 * Detach a viewer session.
1762 * Return 0 on success or else a negative value.
1765 int viewer_detach_session(struct relay_connection
*conn
)
1768 struct lttng_viewer_detach_session_response response
;
1769 struct lttng_viewer_detach_session_request request
;
1770 struct relay_session
*session
= NULL
;
1771 uint64_t viewer_session_to_close
;
1773 DBG("Viewer detach session received");
1777 health_code_update();
1779 /* Receive the request from the connected client. */
1780 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1784 viewer_session_to_close
= be64toh(request
.session_id
);
1786 if (!conn
->viewer_session
) {
1787 DBG("Client trying to detach before creating a live viewer session");
1788 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1792 health_code_update();
1794 memset(&response
, 0, sizeof(response
));
1795 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
1797 session
= session_get_by_id(be64toh(request
.session_id
));
1799 DBG("Relay session %" PRIu64
" not found",
1800 (uint64_t) be64toh(request
.session_id
));
1801 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
1805 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
1807 DBG("Not attached to this session");
1808 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1809 goto send_reply_put
;
1812 viewer_session_close_one_session(conn
->viewer_session
, session
);
1813 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
1814 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
1817 session_put(session
);
1820 health_code_update();
1821 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1825 health_code_update();
1833 * live_relay_unknown_command: send -1 if received unknown command
1836 void live_relay_unknown_command(struct relay_connection
*conn
)
1838 struct lttcomm_relayd_generic_reply reply
;
1840 memset(&reply
, 0, sizeof(reply
));
1841 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1842 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
1846 * Process the commands received on the control socket
1849 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1850 struct relay_connection
*conn
)
1855 msg_value
= be32toh(recv_hdr
->cmd
);
1858 * Make sure we've done the version check before any command other then a
1859 * new client connection.
1861 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
1862 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
1867 switch (msg_value
) {
1868 case LTTNG_VIEWER_CONNECT
:
1869 ret
= viewer_connect(conn
);
1871 case LTTNG_VIEWER_LIST_SESSIONS
:
1872 ret
= viewer_list_sessions(conn
);
1874 case LTTNG_VIEWER_ATTACH_SESSION
:
1875 ret
= viewer_attach_session(conn
);
1877 case LTTNG_VIEWER_GET_NEXT_INDEX
:
1878 ret
= viewer_get_next_index(conn
);
1880 case LTTNG_VIEWER_GET_PACKET
:
1881 ret
= viewer_get_packet(conn
);
1883 case LTTNG_VIEWER_GET_METADATA
:
1884 ret
= viewer_get_metadata(conn
);
1886 case LTTNG_VIEWER_GET_NEW_STREAMS
:
1887 ret
= viewer_get_new_streams(conn
);
1889 case LTTNG_VIEWER_CREATE_SESSION
:
1890 ret
= viewer_create_session(conn
);
1892 case LTTNG_VIEWER_DETACH_SESSION
:
1893 ret
= viewer_detach_session(conn
);
1896 ERR("Received unknown viewer command (%u)",
1897 be32toh(recv_hdr
->cmd
));
1898 live_relay_unknown_command(conn
);
1908 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
1912 (void) lttng_poll_del(events
, pollfd
);
1914 ret
= close(pollfd
);
1916 ERR("Closing pollfd %d", pollfd
);
1921 * This thread does the actual work
1924 void *thread_worker(void *data
)
1928 struct lttng_poll_event events
;
1929 struct lttng_ht
*viewer_connections_ht
;
1930 struct lttng_ht_iter iter
;
1931 struct lttng_viewer_cmd recv_hdr
;
1932 struct relay_connection
*destroy_conn
;
1934 DBG("[thread] Live viewer relay worker started");
1936 rcu_register_thread();
1938 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
1940 if (testpoint(relayd_thread_live_worker
)) {
1941 goto error_testpoint
;
1944 /* table of connections indexed on socket */
1945 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1946 if (!viewer_connections_ht
) {
1947 goto viewer_connections_ht_error
;
1950 ret
= create_named_thread_poll_set(&events
, 2,
1951 "Live viewer worker thread epoll");
1953 goto error_poll_create
;
1956 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1965 health_code_update();
1967 /* Infinite blocking call, waiting for transmission */
1968 DBG3("Relayd live viewer worker thread polling...");
1969 health_poll_entry();
1970 ret
= lttng_poll_wait(&events
, -1);
1974 * Restart interrupted system call.
1976 if (errno
== EINTR
) {
1985 * Process control. The control connection is prioritised so we don't
1986 * starve it with high throughput tracing data on the data
1989 for (i
= 0; i
< nb_fd
; i
++) {
1990 /* Fetch once the poll data */
1991 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
1992 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1994 health_code_update();
1997 /* No activity for this FD (poll implementation). */
2001 /* Thread quit pipe has been closed. Killing thread. */
2002 ret
= check_thread_quit_pipe(pollfd
, revents
);
2008 /* Inspect the relay conn pipe for new connection. */
2009 if (pollfd
== live_conn_pipe
[0]) {
2010 if (revents
& LPOLLIN
) {
2011 struct relay_connection
*conn
;
2013 ret
= lttng_read(live_conn_pipe
[0],
2014 &conn
, sizeof(conn
));
2018 lttng_poll_add(&events
, conn
->sock
->fd
,
2019 LPOLLIN
| LPOLLRDHUP
);
2020 connection_ht_add(viewer_connections_ht
, conn
);
2021 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2022 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2023 ERR("Relay live pipe error");
2026 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2030 /* Connection activity. */
2031 struct relay_connection
*conn
;
2033 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2038 if (revents
& LPOLLIN
) {
2039 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2040 sizeof(recv_hdr
), 0);
2042 /* Connection closed. */
2043 cleanup_connection_pollfd(&events
, pollfd
);
2044 /* Put "create" ownership reference. */
2045 connection_put(conn
);
2046 DBG("Viewer control conn closed with %d", pollfd
);
2048 ret
= process_control(&recv_hdr
, conn
);
2050 /* Clear the session on error. */
2051 cleanup_connection_pollfd(&events
, pollfd
);
2052 /* Put "create" ownership reference. */
2053 connection_put(conn
);
2054 DBG("Viewer connection closed with %d", pollfd
);
2057 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2058 cleanup_connection_pollfd(&events
, pollfd
);
2059 /* Put "create" ownership reference. */
2060 connection_put(conn
);
2062 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2063 connection_put(conn
);
2066 /* Put local "get_by_sock" reference. */
2067 connection_put(conn
);
2074 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
2076 /* Cleanup reamaining connection object. */
2078 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2081 health_code_update();
2082 connection_put(destroy_conn
);
2086 lttng_ht_destroy(viewer_connections_ht
);
2087 viewer_connections_ht_error
:
2088 /* Close relay conn pipes */
2089 (void) fd_tracker_util_pipe_close(the_fd_tracker
, live_conn_pipe
);
2091 DBG("Viewer worker thread exited with error");
2093 DBG("Viewer worker thread cleanup complete");
2097 ERR("Health error occurred in %s", __func__
);
2099 health_unregister(health_relayd
);
2100 if (lttng_relay_stop_threads()) {
2101 ERR("Error stopping threads");
2103 rcu_unregister_thread();
2108 * Create the relay command pipe to wake thread_manage_apps.
2109 * Closed in cleanup().
2111 static int create_conn_pipe(void)
2113 return fd_tracker_util_pipe_open_cloexec(the_fd_tracker
,
2114 "Live connection pipe", live_conn_pipe
);
2117 int relayd_live_join(void)
2119 int ret
, retval
= 0;
2122 ret
= pthread_join(live_listener_thread
, &status
);
2125 PERROR("pthread_join live listener");
2129 ret
= pthread_join(live_worker_thread
, &status
);
2132 PERROR("pthread_join live worker");
2136 ret
= pthread_join(live_dispatcher_thread
, &status
);
2139 PERROR("pthread_join live dispatcher");
2143 cleanup_relayd_live();
2151 int relayd_live_create(struct lttng_uri
*uri
)
2153 int ret
= 0, retval
= 0;
2159 goto exit_init_data
;
2163 /* Check if daemon is UID = 0 */
2164 is_root
= !getuid();
2167 if (live_uri
->port
< 1024) {
2168 ERR("Need to be root to use ports < 1024");
2170 goto exit_init_data
;
2174 /* Setup the thread apps communication pipe. */
2175 if (create_conn_pipe()) {
2177 goto exit_init_data
;
2180 /* Init relay command queue. */
2181 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2183 /* Set up max poll set size */
2184 if (lttng_poll_set_max_size()) {
2186 goto exit_init_data
;
2189 /* Setup the dispatcher thread */
2190 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2191 thread_dispatcher
, (void *) NULL
);
2194 PERROR("pthread_create viewer dispatcher");
2196 goto exit_dispatcher_thread
;
2199 /* Setup the worker thread */
2200 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2201 thread_worker
, NULL
);
2204 PERROR("pthread_create viewer worker");
2206 goto exit_worker_thread
;
2209 /* Setup the listener thread */
2210 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2211 thread_listener
, (void *) NULL
);
2214 PERROR("pthread_create viewer listener");
2216 goto exit_listener_thread
;
2220 * All OK, started all threads.
2225 * Join on the live_listener_thread should anything be added after
2226 * the live_listener thread's creation.
2229 exit_listener_thread
:
2231 ret
= pthread_join(live_worker_thread
, &status
);
2234 PERROR("pthread_join live worker");
2239 ret
= pthread_join(live_dispatcher_thread
, &status
);
2242 PERROR("pthread_join live dispatcher");
2245 exit_dispatcher_thread
:
2248 cleanup_relayd_live();