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 int create_sock(void *data
, int *out_fd
)
440 struct lttcomm_sock
*sock
= data
;
442 ret
= lttcomm_create_sock(sock
);
453 int close_sock(void *data
, int *in_fd
)
455 struct lttcomm_sock
*sock
= data
;
457 return sock
->ops
->close(sock
);
461 * Create and init socket from uri.
464 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
, const char *name
)
467 struct lttcomm_sock
*sock
= NULL
;
468 char uri_str
[PATH_MAX
];
469 char *formated_name
= NULL
;
471 sock
= lttcomm_alloc_sock_from_uri(uri
);
473 ERR("Allocating socket");
478 * Don't fail to create the socket if the name can't be built as it is
479 * only used for debugging purposes.
481 ret
= uri_to_str_url(uri
, uri_str
, sizeof(uri_str
));
482 uri_str
[sizeof(uri_str
) - 1] = '\0';
484 ret
= asprintf(&formated_name
, "%s socket @ %s", name
,
487 formated_name
= NULL
;
491 ret
= fd_tracker_open_unsuspendable_fd(the_fd_tracker
, &sock_fd
,
492 (const char **) (formated_name
? &formated_name
: NULL
),
493 1, create_sock
, sock
);
495 DBG("Listening on %s socket %d", name
, sock
->fd
);
497 ret
= sock
->ops
->bind(sock
);
502 ret
= sock
->ops
->listen(sock
, -1);
512 lttcomm_destroy_sock(sock
);
518 * This thread manages the listening for new connections on the network
521 void *thread_listener(void *data
)
523 int i
, ret
, pollfd
, err
= -1;
524 uint32_t revents
, nb_fd
;
525 struct lttng_poll_event events
;
526 struct lttcomm_sock
*live_control_sock
;
528 DBG("[thread] Relay live listener started");
530 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
532 health_code_update();
534 live_control_sock
= init_socket(live_uri
, "Live listener");
535 if (!live_control_sock
) {
536 goto error_sock_control
;
539 /* Pass 2 as size here for the thread quit pipe and control sockets. */
540 ret
= create_named_thread_poll_set(&events
, 2,
541 "Live listener thread epoll");
543 goto error_create_poll
;
546 /* Add the control socket */
547 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
552 lttng_relay_notify_ready();
554 if (testpoint(relayd_thread_live_listener
)) {
555 goto error_testpoint
;
559 health_code_update();
561 DBG("Listener accepting live viewers connections");
565 ret
= lttng_poll_wait(&events
, -1);
569 * Restart interrupted system call.
571 if (errno
== EINTR
) {
578 DBG("Relay new viewer connection received");
579 for (i
= 0; i
< nb_fd
; i
++) {
580 health_code_update();
582 /* Fetch once the poll data */
583 revents
= LTTNG_POLL_GETEV(&events
, i
);
584 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
587 /* No activity for this FD (poll implementation). */
591 /* Thread quit pipe has been closed. Killing thread. */
592 ret
= check_thread_quit_pipe(pollfd
, revents
);
598 if (revents
& LPOLLIN
) {
600 * A new connection is requested, therefore a
601 * viewer connection is allocated in this
602 * thread, enqueued to a global queue and
603 * dequeued (and freed) in the worker thread.
606 struct relay_connection
*new_conn
;
607 struct lttcomm_sock
*newsock
;
609 newsock
= live_control_sock
->ops
->accept(live_control_sock
);
611 PERROR("accepting control sock");
614 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
616 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
619 PERROR("setsockopt inet");
620 lttcomm_destroy_sock(newsock
);
623 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
625 lttcomm_destroy_sock(newsock
);
628 /* Ownership assumed by the connection. */
631 /* Enqueue request for the dispatcher thread. */
632 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
636 * Wake the dispatch queue futex.
637 * Implicit memory barrier with the
638 * exchange in cds_wfcq_enqueue.
640 futex_nto1_wake(&viewer_conn_queue
.futex
);
641 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
642 ERR("socket poll error");
645 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
655 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
657 if (live_control_sock
->fd
>= 0) {
658 ret
= fd_tracker_close_unsuspendable_fd(the_fd_tracker
,
659 &live_control_sock
->fd
, 1, close_sock
,
665 lttcomm_destroy_sock(live_control_sock
);
669 DBG("Live viewer listener thread exited with error");
671 health_unregister(health_relayd
);
672 DBG("Live viewer listener thread cleanup complete");
673 if (lttng_relay_stop_threads()) {
674 ERR("Error stopping threads");
680 * This thread manages the dispatching of the requests to worker threads
683 void *thread_dispatcher(void *data
)
687 struct cds_wfcq_node
*node
;
688 struct relay_connection
*conn
= NULL
;
690 DBG("[thread] Live viewer relay dispatcher started");
692 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
694 if (testpoint(relayd_thread_live_dispatcher
)) {
695 goto error_testpoint
;
698 health_code_update();
701 health_code_update();
703 /* Atomically prepare the queue futex */
704 futex_nto1_prepare(&viewer_conn_queue
.futex
);
706 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
711 health_code_update();
713 /* Dequeue commands */
714 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
715 &viewer_conn_queue
.tail
);
717 DBG("Woken up but nothing in the live-viewer "
718 "relay command queue");
719 /* Continue thread execution */
722 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
723 DBG("Dispatching viewer request waiting on sock %d",
727 * Inform worker thread of the new request. This
728 * call is blocking so we can be assured that
729 * the data will be read at some point in time
730 * or wait to the end of the world :)
732 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
734 PERROR("write conn pipe");
735 connection_put(conn
);
738 } while (node
!= NULL
);
740 /* Futex wait on queue. Blocking call on futex() */
742 futex_nto1_wait(&viewer_conn_queue
.futex
);
746 /* Normal exit, no error */
753 ERR("Health error occurred in %s", __func__
);
755 health_unregister(health_relayd
);
756 DBG("Live viewer dispatch thread dying");
757 if (lttng_relay_stop_threads()) {
758 ERR("Error stopping threads");
764 * Establish connection with the viewer and check the versions.
766 * Return 0 on success or else negative value.
769 int viewer_connect(struct relay_connection
*conn
)
772 struct lttng_viewer_connect reply
, msg
;
774 conn
->version_check_done
= 1;
776 health_code_update();
778 DBG("Viewer is establishing a connection to the relayd.");
780 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
785 health_code_update();
787 memset(&reply
, 0, sizeof(reply
));
788 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
789 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
791 /* Major versions must be the same */
792 if (reply
.major
!= be32toh(msg
.major
)) {
793 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
794 reply
.major
, be32toh(msg
.major
));
799 conn
->major
= reply
.major
;
800 /* We adapt to the lowest compatible version */
801 if (reply
.minor
<= be32toh(msg
.minor
)) {
802 conn
->minor
= reply
.minor
;
804 conn
->minor
= be32toh(msg
.minor
);
807 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
808 conn
->type
= RELAY_VIEWER_COMMAND
;
809 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
810 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
812 ERR("Unknown connection type : %u", be32toh(msg
.type
));
817 reply
.major
= htobe32(reply
.major
);
818 reply
.minor
= htobe32(reply
.minor
);
819 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
821 * Increment outside of htobe64 macro, because the argument can
822 * be used more than once within the macro, and thus the
823 * operation may be undefined.
825 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
826 last_relay_viewer_session_id
++;
827 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
828 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
831 health_code_update();
833 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
838 health_code_update();
840 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
848 * Send the viewer the list of current sessions.
849 * We need to create a copy of the hash table content because otherwise
850 * we cannot assume the number of entries stays the same between getting
851 * the number of HT elements and iteration over the HT.
853 * Return 0 on success or else a negative value.
856 int viewer_list_sessions(struct relay_connection
*conn
)
859 struct lttng_viewer_list_sessions session_list
;
860 struct lttng_ht_iter iter
;
861 struct relay_session
*session
;
862 struct lttng_viewer_session
*send_session_buf
= NULL
;
863 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
866 DBG("List sessions received");
868 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
869 if (!send_session_buf
) {
874 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
876 struct lttng_viewer_session
*send_session
;
878 health_code_update();
880 if (count
>= buf_count
) {
881 struct lttng_viewer_session
*newbuf
;
882 uint32_t new_buf_count
= buf_count
<< 1;
884 newbuf
= realloc(send_session_buf
,
885 new_buf_count
* sizeof(*send_session_buf
));
890 send_session_buf
= newbuf
;
891 buf_count
= new_buf_count
;
893 send_session
= &send_session_buf
[count
];
894 if (lttng_strncpy(send_session
->session_name
,
895 session
->session_name
,
896 sizeof(send_session
->session_name
))) {
900 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
901 sizeof(send_session
->hostname
))) {
905 send_session
->id
= htobe64(session
->id
);
906 send_session
->live_timer
= htobe32(session
->live_timer
);
907 if (session
->viewer_attached
) {
908 send_session
->clients
= htobe32(1);
910 send_session
->clients
= htobe32(0);
912 send_session
->streams
= htobe32(session
->stream_count
);
920 session_list
.sessions_count
= htobe32(count
);
922 health_code_update();
924 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
929 health_code_update();
931 ret
= send_response(conn
->sock
, send_session_buf
,
932 count
* sizeof(*send_session_buf
));
936 health_code_update();
940 free(send_session_buf
);
945 * Send the viewer the list of current streams.
948 int viewer_get_new_streams(struct relay_connection
*conn
)
950 int ret
, send_streams
= 0;
951 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
952 struct lttng_viewer_new_streams_request request
;
953 struct lttng_viewer_new_streams_response response
;
954 struct relay_session
*session
;
960 DBG("Get new streams received");
962 health_code_update();
964 /* Receive the request from the connected client. */
965 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
969 session_id
= be64toh(request
.session_id
);
971 health_code_update();
973 memset(&response
, 0, sizeof(response
));
975 session
= session_get_by_id(session_id
);
977 DBG("Relay session %" PRIu64
" not found", session_id
);
978 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
982 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
984 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
989 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
991 ret
= make_viewer_streams(session
, LTTNG_VIEWER_SEEK_LAST
, &nb_total
, &nb_unsent
,
992 &nb_created
, &closed
);
994 goto end_put_session
;
996 /* Only send back the newly created streams with the unsent ones. */
997 nb_streams
= nb_created
+ nb_unsent
;
998 response
.streams_count
= htobe32(nb_streams
);
1001 * If the session is closed, HUP when there are no more streams
1004 if (closed
&& nb_total
== 0) {
1006 response
.streams_count
= 0;
1007 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
1012 health_code_update();
1013 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1015 goto end_put_session
;
1017 health_code_update();
1020 * Unknown or empty session, just return gracefully, the viewer
1021 * knows what is happening.
1023 if (!send_streams
|| !nb_streams
) {
1025 goto end_put_session
;
1029 * Send stream and *DON'T* ignore the sent flag so every viewer
1030 * streams that were not sent from that point will be sent to
1033 ret
= send_viewer_streams(conn
->sock
, session
, 0);
1035 goto end_put_session
;
1040 session_put(session
);
1047 * Send the viewer the list of current sessions.
1050 int viewer_attach_session(struct relay_connection
*conn
)
1052 int send_streams
= 0;
1054 uint32_t nb_streams
= 0;
1055 enum lttng_viewer_seek seek_type
;
1056 struct lttng_viewer_attach_session_request request
;
1057 struct lttng_viewer_attach_session_response response
;
1058 struct relay_session
*session
= NULL
;
1059 bool closed
= false;
1063 health_code_update();
1065 /* Receive the request from the connected client. */
1066 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1071 health_code_update();
1073 memset(&response
, 0, sizeof(response
));
1075 if (!conn
->viewer_session
) {
1076 DBG("Client trying to attach before creating a live viewer session");
1077 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1081 session
= session_get_by_id(be64toh(request
.session_id
));
1083 DBG("Relay session %" PRIu64
" not found",
1084 (uint64_t) be64toh(request
.session_id
));
1085 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1088 DBG("Attach session ID %" PRIu64
" received",
1089 (uint64_t) be64toh(request
.session_id
));
1091 if (session
->live_timer
== 0) {
1092 DBG("Not live session");
1093 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1098 ret
= viewer_session_attach(conn
->viewer_session
, session
);
1100 DBG("Already a viewer attached");
1101 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_ALREADY
);
1105 switch (be32toh(request
.seek
)) {
1106 case LTTNG_VIEWER_SEEK_BEGINNING
:
1107 case LTTNG_VIEWER_SEEK_LAST
:
1108 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1109 seek_type
= be32toh(request
.seek
);
1112 ERR("Wrong seek parameter");
1113 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1118 ret
= make_viewer_streams(session
, seek_type
, &nb_streams
, NULL
,
1121 goto end_put_session
;
1123 response
.streams_count
= htobe32(nb_streams
);
1126 * If the session is closed when the viewer is attaching, it
1127 * means some of the streams may have been concurrently removed,
1128 * so we don't allow the viewer to attach, even if there are
1129 * streams available.
1133 response
.streams_count
= 0;
1134 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
1139 health_code_update();
1140 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1142 goto end_put_session
;
1144 health_code_update();
1147 * Unknown or empty session, just return gracefully, the viewer
1148 * knows what is happening.
1150 if (!send_streams
|| !nb_streams
) {
1152 goto end_put_session
;
1155 /* Send stream and ignore the sent flag. */
1156 ret
= send_viewer_streams(conn
->sock
, session
, 1);
1158 goto end_put_session
;
1163 session_put(session
);
1170 * Open the index file if needed for the given vstream.
1172 * If an index file is successfully opened, the vstream will set it as its
1173 * current index file.
1175 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1177 * Called with rstream lock held.
1179 static int try_open_index(struct relay_viewer_stream
*vstream
,
1180 struct relay_stream
*rstream
)
1184 if (vstream
->index_file
) {
1189 * First time, we open the index file and at least one index is ready.
1191 if (rstream
->index_received_seqcount
== 0) {
1195 vstream
->index_file
= lttng_index_file_open(vstream
->path_name
,
1196 vstream
->channel_name
,
1197 vstream
->stream
->tracefile_count
,
1198 vstream
->current_tracefile_id
);
1199 if (!vstream
->index_file
) {
1208 * Check the status of the index for the given stream. This function
1209 * updates the index structure if needed and can put (close) the vstream
1210 * in the HUP situation.
1212 * Return 0 means that we can proceed with the index. A value of 1 means
1213 * that the index has been updated and is ready to be sent to the
1214 * client. A negative value indicates an error that can't be handled.
1216 * Called with rstream lock held.
1218 static int check_index_status(struct relay_viewer_stream
*vstream
,
1219 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1220 struct lttng_viewer_index
*index
)
1224 if (trace
->session
->connection_closed
1225 && rstream
->index_received_seqcount
1226 == vstream
->index_sent_seqcount
) {
1227 /* Last index sent and session connection is closed. */
1228 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1230 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1231 rstream
->index_received_seqcount
1232 == vstream
->index_sent_seqcount
) {
1234 * We've received a synchronization beacon and the last index
1235 * available has been sent, the index for now is inactive.
1237 * In this case, we have received a beacon which allows us to
1238 * inform the client of a time interval during which we can
1239 * guarantee that there are no events to read (and never will
1242 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1243 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1244 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1246 } else if (rstream
->index_received_seqcount
1247 == vstream
->index_sent_seqcount
) {
1249 * This checks whether received == sent seqcount. In
1250 * this case, we have not received a beacon. Therefore,
1251 * we can only ask the client to retry later.
1253 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1255 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1256 vstream
->current_tracefile_id
,
1257 vstream
->index_sent_seqcount
)) {
1259 * The next index we want to send cannot be read either
1260 * because we need to perform a rotation, or due to
1261 * the producer having overwritten its trace file.
1263 DBG("Viewer stream %" PRIu64
" rotation",
1264 vstream
->stream
->stream_handle
);
1265 ret
= viewer_stream_rotate(vstream
);
1268 } else if (ret
== 1) {
1269 /* EOF across entire stream. */
1270 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1274 * If we have been pushed due to overwrite, it
1275 * necessarily means there is data that can be read in
1276 * the stream. If we rotated because we reached the end
1277 * of a tracefile, it means the following tracefile
1278 * needs to contain at least one index, else we would
1279 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1280 * viewer. The updated index_sent_seqcount needs to
1281 * point to a readable index entry now.
1283 * In the case where we "rotate" on a single file, we
1284 * can end up in a case where the requested index is
1285 * still unavailable.
1287 if (rstream
->tracefile_count
== 1 &&
1288 !tracefile_array_seq_in_file(
1290 vstream
->current_tracefile_id
,
1291 vstream
->index_sent_seqcount
)) {
1292 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1295 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1296 vstream
->current_tracefile_id
,
1297 vstream
->index_sent_seqcount
));
1299 /* ret == 0 means successful so we continue. */
1305 viewer_stream_put(vstream
);
1311 * Send the next index for a stream.
1313 * Return 0 on success or else a negative value.
1316 int viewer_get_next_index(struct relay_connection
*conn
)
1319 struct lttng_viewer_get_next_index request_index
;
1320 struct lttng_viewer_index viewer_index
;
1321 struct ctf_packet_index packet_index
;
1322 struct relay_viewer_stream
*vstream
= NULL
;
1323 struct relay_stream
*rstream
= NULL
;
1324 struct ctf_trace
*ctf_trace
= NULL
;
1325 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1329 DBG("Viewer get next index");
1331 memset(&viewer_index
, 0, sizeof(viewer_index
));
1332 health_code_update();
1334 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1338 health_code_update();
1340 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1342 DBG("Client requested index of unknown stream id %" PRIu64
,
1343 (uint64_t) be64toh(request_index
.stream_id
));
1344 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1348 /* Use back. ref. Protected by refcounts. */
1349 rstream
= vstream
->stream
;
1350 ctf_trace
= rstream
->trace
;
1352 /* metadata_viewer_stream may be NULL. */
1353 metadata_viewer_stream
=
1354 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1356 pthread_mutex_lock(&rstream
->lock
);
1359 * The viewer should not ask for index on metadata stream.
1361 if (rstream
->is_metadata
) {
1362 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1366 /* Try to open an index if one is needed for that stream. */
1367 ret
= try_open_index(vstream
, rstream
);
1369 if (ret
== -ENOENT
) {
1371 * The index is created only when the first data
1372 * packet arrives, it might not be ready at the
1373 * beginning of the session
1375 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1377 /* Unhandled error. */
1378 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1383 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1386 } else if (ret
== 1) {
1388 * We have no index to send and check_index_status has populated
1389 * viewer_index's status.
1393 /* At this point, ret is 0 thus we will be able to read the index. */
1397 * vstream->stream_fd may be NULL if it has been closed by
1398 * tracefile rotation, or if we are at the beginning of the
1399 * stream. We open the data stream file here to protect against
1400 * overwrite caused by tracefile rotation (in association with
1401 * unlink performed before overwrite).
1403 if (!vstream
->stream_fd
) {
1404 char fullpath
[PATH_MAX
];
1406 if (vstream
->stream
->tracefile_count
> 0) {
1407 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s_%" PRIu64
,
1409 vstream
->channel_name
,
1410 vstream
->current_tracefile_id
);
1412 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s",
1414 vstream
->channel_name
);
1419 ret
= open(fullpath
, O_RDONLY
);
1421 PERROR("Relay opening trace file");
1424 vstream
->stream_fd
= stream_fd_create(ret
);
1425 if (!vstream
->stream_fd
) {
1433 ret
= check_new_streams(conn
);
1435 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1437 } else if (ret
== 1) {
1438 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1441 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1443 ERR("Relay error reading index file %d",
1444 vstream
->index_file
->fd
);
1445 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1448 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1449 vstream
->index_sent_seqcount
++;
1453 * Indexes are stored in big endian, no need to switch before sending.
1455 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1456 rstream
->stream_handle
,
1457 (uint64_t) be64toh(packet_index
.offset
));
1458 viewer_index
.offset
= packet_index
.offset
;
1459 viewer_index
.packet_size
= packet_index
.packet_size
;
1460 viewer_index
.content_size
= packet_index
.content_size
;
1461 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1462 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1463 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1464 viewer_index
.stream_id
= packet_index
.stream_id
;
1468 pthread_mutex_unlock(&rstream
->lock
);
1471 if (metadata_viewer_stream
) {
1472 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1473 DBG("get next index metadata check: recv %" PRIu64
1475 metadata_viewer_stream
->stream
->metadata_received
,
1476 metadata_viewer_stream
->metadata_sent
);
1477 if (!metadata_viewer_stream
->stream
->metadata_received
||
1478 metadata_viewer_stream
->stream
->metadata_received
>
1479 metadata_viewer_stream
->metadata_sent
) {
1480 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1482 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1485 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1486 health_code_update();
1488 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1492 health_code_update();
1495 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1496 vstream
->index_sent_seqcount
,
1497 vstream
->stream
->stream_handle
);
1500 if (metadata_viewer_stream
) {
1501 viewer_stream_put(metadata_viewer_stream
);
1504 viewer_stream_put(vstream
);
1509 pthread_mutex_unlock(&rstream
->lock
);
1510 if (metadata_viewer_stream
) {
1511 viewer_stream_put(metadata_viewer_stream
);
1513 viewer_stream_put(vstream
);
1518 * Send the next index for a stream
1520 * Return 0 on success or else a negative value.
1523 int viewer_get_packet(struct relay_connection
*conn
)
1528 struct lttng_viewer_get_packet get_packet_info
;
1529 struct lttng_viewer_trace_packet reply_header
;
1530 struct relay_viewer_stream
*vstream
= NULL
;
1531 uint32_t reply_size
= sizeof(reply_header
);
1532 uint32_t packet_data_len
= 0;
1535 DBG2("Relay get data packet");
1537 health_code_update();
1539 ret
= recv_request(conn
->sock
, &get_packet_info
,
1540 sizeof(get_packet_info
));
1544 health_code_update();
1546 /* From this point on, the error label can be reached. */
1547 memset(&reply_header
, 0, sizeof(reply_header
));
1549 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1551 DBG("Client requested packet of unknown stream id %" PRIu64
,
1552 (uint64_t) be64toh(get_packet_info
.stream_id
));
1553 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1554 goto send_reply_nolock
;
1556 packet_data_len
= be32toh(get_packet_info
.len
);
1557 reply_size
+= packet_data_len
;
1560 reply
= zmalloc(reply_size
);
1562 PERROR("packet reply zmalloc");
1563 reply_size
= sizeof(reply_header
);
1567 pthread_mutex_lock(&vstream
->stream
->lock
);
1568 lseek_ret
= lseek(vstream
->stream_fd
->fd
, be64toh(get_packet_info
.offset
),
1570 if (lseek_ret
< 0) {
1571 PERROR("lseek fd %d to offset %" PRIu64
, vstream
->stream_fd
->fd
,
1572 (uint64_t) be64toh(get_packet_info
.offset
));
1575 read_len
= lttng_read(vstream
->stream_fd
->fd
,
1576 reply
+ sizeof(reply_header
),
1578 if (read_len
< packet_data_len
) {
1579 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1580 vstream
->stream_fd
->fd
,
1581 (uint64_t) be64toh(get_packet_info
.offset
));
1584 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1585 reply_header
.len
= htobe32(packet_data_len
);
1589 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1593 pthread_mutex_unlock(&vstream
->stream
->lock
);
1597 health_code_update();
1600 memcpy(reply
, &reply_header
, sizeof(reply_header
));
1601 ret
= send_response(conn
->sock
, reply
, reply_size
);
1603 /* No reply to send. */
1604 ret
= send_response(conn
->sock
, &reply_header
,
1608 health_code_update();
1610 PERROR("sendmsg of packet data failed");
1614 DBG("Sent %u bytes for stream %" PRIu64
, reply_size
,
1615 (uint64_t) be64toh(get_packet_info
.stream_id
));
1621 viewer_stream_put(vstream
);
1627 * Send the session's metadata
1629 * Return 0 on success else a negative value.
1632 int viewer_get_metadata(struct relay_connection
*conn
)
1638 struct lttng_viewer_get_metadata request
;
1639 struct lttng_viewer_metadata_packet reply
;
1640 struct relay_viewer_stream
*vstream
= NULL
;
1644 DBG("Relay get metadata");
1646 health_code_update();
1648 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1652 health_code_update();
1654 memset(&reply
, 0, sizeof(reply
));
1656 vstream
= viewer_stream_get_by_id(be64toh(request
.stream_id
));
1659 * The metadata stream can be closed by a CLOSE command
1660 * just before we attach. It can also be closed by
1661 * per-pid tracing during tracing. Therefore, it is
1662 * possible that we cannot find this viewer stream.
1663 * Reply back to the client with an error if we cannot
1666 DBG("Client requested metadata of unknown stream id %" PRIu64
,
1667 (uint64_t) be64toh(request
.stream_id
));
1668 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1671 pthread_mutex_lock(&vstream
->stream
->lock
);
1672 if (!vstream
->stream
->is_metadata
) {
1673 ERR("Invalid metadata stream");
1677 assert(vstream
->metadata_sent
<= vstream
->stream
->metadata_received
);
1679 len
= vstream
->stream
->metadata_received
- vstream
->metadata_sent
;
1681 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1685 /* first time, we open the metadata file */
1686 if (!vstream
->stream_fd
) {
1687 char fullpath
[PATH_MAX
];
1689 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s", vstream
->path_name
,
1690 vstream
->channel_name
);
1694 ret
= open(fullpath
, O_RDONLY
);
1696 PERROR("Relay opening metadata file");
1699 vstream
->stream_fd
= stream_fd_create(ret
);
1700 if (!vstream
->stream_fd
) {
1708 reply
.len
= htobe64(len
);
1709 data
= zmalloc(len
);
1711 PERROR("viewer metadata zmalloc");
1715 read_len
= lttng_read(vstream
->stream_fd
->fd
, data
, len
);
1716 if (read_len
< len
) {
1717 PERROR("Relay reading metadata file");
1720 vstream
->metadata_sent
+= read_len
;
1721 if (vstream
->metadata_sent
== vstream
->stream
->metadata_received
1722 && vstream
->stream
->closed
) {
1723 /* Release ownership for the viewer metadata stream. */
1724 viewer_stream_put(vstream
);
1727 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1732 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1735 health_code_update();
1737 pthread_mutex_unlock(&vstream
->stream
->lock
);
1739 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1743 health_code_update();
1746 ret
= send_response(conn
->sock
, data
, len
);
1752 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1753 (uint64_t) be64toh(request
.stream_id
));
1755 DBG("Metadata sent");
1761 viewer_stream_put(vstream
);
1767 * Create a viewer session.
1769 * Return 0 on success or else a negative value.
1772 int viewer_create_session(struct relay_connection
*conn
)
1775 struct lttng_viewer_create_session_response resp
;
1777 DBG("Viewer create session received");
1779 memset(&resp
, 0, sizeof(resp
));
1780 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
1781 conn
->viewer_session
= viewer_session_create();
1782 if (!conn
->viewer_session
) {
1783 ERR("Allocation viewer session");
1784 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
1789 health_code_update();
1790 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
1794 health_code_update();
1802 * Detach a viewer session.
1804 * Return 0 on success or else a negative value.
1807 int viewer_detach_session(struct relay_connection
*conn
)
1810 struct lttng_viewer_detach_session_response response
;
1811 struct lttng_viewer_detach_session_request request
;
1812 struct relay_session
*session
= NULL
;
1813 uint64_t viewer_session_to_close
;
1815 DBG("Viewer detach session received");
1819 health_code_update();
1821 /* Receive the request from the connected client. */
1822 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1826 viewer_session_to_close
= be64toh(request
.session_id
);
1828 if (!conn
->viewer_session
) {
1829 DBG("Client trying to detach before creating a live viewer session");
1830 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1834 health_code_update();
1836 memset(&response
, 0, sizeof(response
));
1837 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
1839 session
= session_get_by_id(be64toh(request
.session_id
));
1841 DBG("Relay session %" PRIu64
" not found",
1842 (uint64_t) be64toh(request
.session_id
));
1843 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
1847 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
1849 DBG("Not attached to this session");
1850 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1851 goto send_reply_put
;
1854 viewer_session_close_one_session(conn
->viewer_session
, session
);
1855 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
1856 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
1859 session_put(session
);
1862 health_code_update();
1863 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1867 health_code_update();
1875 * live_relay_unknown_command: send -1 if received unknown command
1878 void live_relay_unknown_command(struct relay_connection
*conn
)
1880 struct lttcomm_relayd_generic_reply reply
;
1882 memset(&reply
, 0, sizeof(reply
));
1883 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1884 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
1888 * Process the commands received on the control socket
1891 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1892 struct relay_connection
*conn
)
1897 msg_value
= be32toh(recv_hdr
->cmd
);
1900 * Make sure we've done the version check before any command other then a
1901 * new client connection.
1903 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
1904 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
1909 switch (msg_value
) {
1910 case LTTNG_VIEWER_CONNECT
:
1911 ret
= viewer_connect(conn
);
1913 case LTTNG_VIEWER_LIST_SESSIONS
:
1914 ret
= viewer_list_sessions(conn
);
1916 case LTTNG_VIEWER_ATTACH_SESSION
:
1917 ret
= viewer_attach_session(conn
);
1919 case LTTNG_VIEWER_GET_NEXT_INDEX
:
1920 ret
= viewer_get_next_index(conn
);
1922 case LTTNG_VIEWER_GET_PACKET
:
1923 ret
= viewer_get_packet(conn
);
1925 case LTTNG_VIEWER_GET_METADATA
:
1926 ret
= viewer_get_metadata(conn
);
1928 case LTTNG_VIEWER_GET_NEW_STREAMS
:
1929 ret
= viewer_get_new_streams(conn
);
1931 case LTTNG_VIEWER_CREATE_SESSION
:
1932 ret
= viewer_create_session(conn
);
1934 case LTTNG_VIEWER_DETACH_SESSION
:
1935 ret
= viewer_detach_session(conn
);
1938 ERR("Received unknown viewer command (%u)",
1939 be32toh(recv_hdr
->cmd
));
1940 live_relay_unknown_command(conn
);
1950 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
1954 (void) lttng_poll_del(events
, pollfd
);
1956 ret
= close(pollfd
);
1958 ERR("Closing pollfd %d", pollfd
);
1963 * This thread does the actual work
1966 void *thread_worker(void *data
)
1970 struct lttng_poll_event events
;
1971 struct lttng_ht
*viewer_connections_ht
;
1972 struct lttng_ht_iter iter
;
1973 struct lttng_viewer_cmd recv_hdr
;
1974 struct relay_connection
*destroy_conn
;
1976 DBG("[thread] Live viewer relay worker started");
1978 rcu_register_thread();
1980 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
1982 if (testpoint(relayd_thread_live_worker
)) {
1983 goto error_testpoint
;
1986 /* table of connections indexed on socket */
1987 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1988 if (!viewer_connections_ht
) {
1989 goto viewer_connections_ht_error
;
1992 ret
= create_named_thread_poll_set(&events
, 2,
1993 "Live viewer worker thread epoll");
1995 goto error_poll_create
;
1998 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2007 health_code_update();
2009 /* Infinite blocking call, waiting for transmission */
2010 DBG3("Relayd live viewer worker thread polling...");
2011 health_poll_entry();
2012 ret
= lttng_poll_wait(&events
, -1);
2016 * Restart interrupted system call.
2018 if (errno
== EINTR
) {
2027 * Process control. The control connection is prioritised so we don't
2028 * starve it with high throughput tracing data on the data
2031 for (i
= 0; i
< nb_fd
; i
++) {
2032 /* Fetch once the poll data */
2033 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2034 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2036 health_code_update();
2039 /* No activity for this FD (poll implementation). */
2043 /* Thread quit pipe has been closed. Killing thread. */
2044 ret
= check_thread_quit_pipe(pollfd
, revents
);
2050 /* Inspect the relay conn pipe for new connection. */
2051 if (pollfd
== live_conn_pipe
[0]) {
2052 if (revents
& LPOLLIN
) {
2053 struct relay_connection
*conn
;
2055 ret
= lttng_read(live_conn_pipe
[0],
2056 &conn
, sizeof(conn
));
2060 lttng_poll_add(&events
, conn
->sock
->fd
,
2061 LPOLLIN
| LPOLLRDHUP
);
2062 connection_ht_add(viewer_connections_ht
, conn
);
2063 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2064 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2065 ERR("Relay live pipe error");
2068 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2072 /* Connection activity. */
2073 struct relay_connection
*conn
;
2075 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2080 if (revents
& LPOLLIN
) {
2081 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2082 sizeof(recv_hdr
), 0);
2084 /* Connection closed. */
2085 cleanup_connection_pollfd(&events
, pollfd
);
2086 /* Put "create" ownership reference. */
2087 connection_put(conn
);
2088 DBG("Viewer control conn closed with %d", pollfd
);
2090 ret
= process_control(&recv_hdr
, conn
);
2092 /* Clear the session on error. */
2093 cleanup_connection_pollfd(&events
, pollfd
);
2094 /* Put "create" ownership reference. */
2095 connection_put(conn
);
2096 DBG("Viewer connection closed with %d", pollfd
);
2099 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2100 cleanup_connection_pollfd(&events
, pollfd
);
2101 /* Put "create" ownership reference. */
2102 connection_put(conn
);
2104 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2105 connection_put(conn
);
2108 /* Put local "get_by_sock" reference. */
2109 connection_put(conn
);
2116 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
2118 /* Cleanup reamaining connection object. */
2120 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2123 health_code_update();
2124 connection_put(destroy_conn
);
2128 lttng_ht_destroy(viewer_connections_ht
);
2129 viewer_connections_ht_error
:
2130 /* Close relay conn pipes */
2131 (void) fd_tracker_util_pipe_close(the_fd_tracker
, live_conn_pipe
);
2133 DBG("Viewer worker thread exited with error");
2135 DBG("Viewer worker thread cleanup complete");
2139 ERR("Health error occurred in %s", __func__
);
2141 health_unregister(health_relayd
);
2142 if (lttng_relay_stop_threads()) {
2143 ERR("Error stopping threads");
2145 rcu_unregister_thread();
2150 * Create the relay command pipe to wake thread_manage_apps.
2151 * Closed in cleanup().
2153 static int create_conn_pipe(void)
2155 return fd_tracker_util_pipe_open_cloexec(the_fd_tracker
,
2156 "Live connection pipe", live_conn_pipe
);
2159 int relayd_live_join(void)
2161 int ret
, retval
= 0;
2164 ret
= pthread_join(live_listener_thread
, &status
);
2167 PERROR("pthread_join live listener");
2171 ret
= pthread_join(live_worker_thread
, &status
);
2174 PERROR("pthread_join live worker");
2178 ret
= pthread_join(live_dispatcher_thread
, &status
);
2181 PERROR("pthread_join live dispatcher");
2185 cleanup_relayd_live();
2193 int relayd_live_create(struct lttng_uri
*uri
)
2195 int ret
= 0, retval
= 0;
2201 goto exit_init_data
;
2205 /* Check if daemon is UID = 0 */
2206 is_root
= !getuid();
2209 if (live_uri
->port
< 1024) {
2210 ERR("Need to be root to use ports < 1024");
2212 goto exit_init_data
;
2216 /* Setup the thread apps communication pipe. */
2217 if (create_conn_pipe()) {
2219 goto exit_init_data
;
2222 /* Init relay command queue. */
2223 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2225 /* Set up max poll set size */
2226 if (lttng_poll_set_max_size()) {
2228 goto exit_init_data
;
2231 /* Setup the dispatcher thread */
2232 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2233 thread_dispatcher
, (void *) NULL
);
2236 PERROR("pthread_create viewer dispatcher");
2238 goto exit_dispatcher_thread
;
2241 /* Setup the worker thread */
2242 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2243 thread_worker
, NULL
);
2246 PERROR("pthread_create viewer worker");
2248 goto exit_worker_thread
;
2251 /* Setup the listener thread */
2252 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2253 thread_listener
, (void *) NULL
);
2256 PERROR("pthread_create viewer listener");
2258 goto exit_listener_thread
;
2262 * All OK, started all threads.
2267 * Join on the live_listener_thread should anything be added after
2268 * the live_listener thread's creation.
2271 exit_listener_thread
:
2273 ret
= pthread_join(live_worker_thread
, &status
);
2276 PERROR("pthread_join live worker");
2281 ret
= pthread_join(live_dispatcher_thread
, &status
);
2284 PERROR("pthread_join live dispatcher");
2287 exit_dispatcher_thread
:
2290 cleanup_relayd_live();