2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
4 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 #include <sys/mount.h>
31 #include <sys/resource.h>
32 #include <sys/socket.h>
34 #include <sys/types.h>
37 #include <urcu/futex.h>
38 #include <urcu/uatomic.h>
39 #include <urcu/rculist.h>
43 #include <lttng/lttng.h>
44 #include <common/common.h>
45 #include <common/compat/poll.h>
46 #include <common/compat/socket.h>
47 #include <common/compat/endian.h>
48 #include <common/defaults.h>
49 #include <common/futex.h>
50 #include <common/index/index.h>
51 #include <common/sessiond-comm/sessiond-comm.h>
52 #include <common/sessiond-comm/inet.h>
53 #include <common/sessiond-comm/relayd.h>
54 #include <common/uri.h>
55 #include <common/utils.h>
59 #include "lttng-relayd.h"
61 #include "health-relayd.h"
62 #include "testpoint.h"
63 #include "viewer-stream.h"
66 #include "ctf-trace.h"
67 #include "connection.h"
68 #include "viewer-session.h"
70 #define SESSION_BUF_DEFAULT_COUNT 16
72 static struct lttng_uri
*live_uri
;
75 * This pipe is used to inform the worker thread that a command is queued and
76 * ready to be processed.
78 static int live_conn_pipe
[2] = { -1, -1 };
80 /* Shared between threads */
81 static int live_dispatch_thread_exit
;
83 static pthread_t live_listener_thread
;
84 static pthread_t live_dispatcher_thread
;
85 static pthread_t live_worker_thread
;
88 * Relay command queue.
90 * The live_thread_listener and live_thread_dispatcher communicate with this
93 static struct relay_conn_queue viewer_conn_queue
;
95 static uint64_t last_relay_viewer_session_id
;
96 static pthread_mutex_t last_relay_viewer_session_id_lock
=
97 PTHREAD_MUTEX_INITIALIZER
;
103 void cleanup_relayd_live(void)
111 * Receive a request buffer using a given socket, destination allocated buffer
114 * Return the size of the received message or else a negative value on error
115 * with errno being set by recvmsg() syscall.
118 ssize_t
recv_request(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
122 ret
= sock
->ops
->recvmsg(sock
, buf
, size
, 0);
123 if (ret
< 0 || ret
!= size
) {
125 /* Orderly shutdown. Not necessary to print an error. */
126 DBG("Socket %d did an orderly shutdown", sock
->fd
);
128 ERR("Relay failed to receive request.");
137 * Send a response buffer using a given socket, source allocated buffer of
140 * Return the size of the sent message or else a negative value on error with
141 * errno being set by sendmsg() syscall.
144 ssize_t
send_response(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
148 ret
= sock
->ops
->sendmsg(sock
, buf
, size
, 0);
150 ERR("Relayd failed to send response.");
157 * Atomically check if new streams got added in one of the sessions attached
158 * and reset the flag to 0.
160 * Returns 1 if new streams got added, 0 if nothing changed, a negative value
164 int check_new_streams(struct relay_connection
*conn
)
166 struct relay_session
*session
;
167 unsigned long current_val
;
170 if (!conn
->viewer_session
) {
174 cds_list_for_each_entry_rcu(session
,
175 &conn
->viewer_session
->session_list
,
176 viewer_session_node
) {
177 if (!session_get(session
)) {
180 current_val
= uatomic_cmpxchg(&session
->new_streams
, 1, 0);
182 session_put(session
);
193 * Send viewer streams to the given socket. The ignore_sent_flag indicates if
194 * this function should ignore the sent flag or not.
196 * Return 0 on success or else a negative value.
199 ssize_t
send_viewer_streams(struct lttcomm_sock
*sock
,
200 uint64_t session_id
, unsigned int ignore_sent_flag
)
203 struct lttng_viewer_stream send_stream
;
204 struct lttng_ht_iter iter
;
205 struct relay_viewer_stream
*vstream
;
209 cds_lfht_for_each_entry(viewer_streams_ht
->ht
, &iter
.iter
, vstream
,
211 struct ctf_trace
*ctf_trace
;
213 health_code_update();
215 if (!viewer_stream_get(vstream
)) {
219 pthread_mutex_lock(&vstream
->stream
->lock
);
220 /* Ignore if not the same session. */
221 if (vstream
->stream
->trace
->session
->id
!= session_id
||
222 (!ignore_sent_flag
&& vstream
->sent_flag
)) {
223 pthread_mutex_unlock(&vstream
->stream
->lock
);
224 viewer_stream_put(vstream
);
228 ctf_trace
= vstream
->stream
->trace
;
229 send_stream
.id
= htobe64(vstream
->stream
->stream_handle
);
230 send_stream
.ctf_trace_id
= htobe64(ctf_trace
->id
);
231 send_stream
.metadata_flag
= htobe32(
232 vstream
->stream
->is_metadata
);
233 if (lttng_strncpy(send_stream
.path_name
, vstream
->path_name
,
234 sizeof(send_stream
.path_name
))) {
235 pthread_mutex_unlock(&vstream
->stream
->lock
);
236 viewer_stream_put(vstream
);
237 ret
= -1; /* Error. */
240 if (lttng_strncpy(send_stream
.channel_name
,
241 vstream
->channel_name
,
242 sizeof(send_stream
.channel_name
))) {
243 pthread_mutex_unlock(&vstream
->stream
->lock
);
244 viewer_stream_put(vstream
);
245 ret
= -1; /* Error. */
249 DBG("Sending stream %" PRIu64
" to viewer",
250 vstream
->stream
->stream_handle
);
251 vstream
->sent_flag
= 1;
252 pthread_mutex_unlock(&vstream
->stream
->lock
);
254 ret
= send_response(sock
, &send_stream
, sizeof(send_stream
));
255 viewer_stream_put(vstream
);
269 * Create every viewer stream possible for the given session with the seek
270 * type. Three counters *can* be return which are in order the total amount of
271 * viewer stream of the session, the number of unsent stream and the number of
272 * stream created. Those counters can be NULL and thus will be ignored.
274 * session must be locked to ensure that we see either none or all initial
275 * streams for a session, but no intermediate state..
277 * Return 0 on success or else a negative value.
279 static int make_viewer_streams(struct relay_session
*session
,
280 struct lttng_trace_chunk
*viewer_trace_chunk
,
281 enum lttng_viewer_seek seek_t
,
284 uint32_t *nb_created
,
288 struct lttng_ht_iter iter
;
289 struct ctf_trace
*ctf_trace
;
292 ASSERT_LOCKED(session
->lock
);
294 if (!viewer_trace_chunk
) {
295 ERR("Internal error: viewer session associated with session \"%s\" has a NULL trace chunk",
296 session
->session_name
);
301 if (session
->connection_closed
) {
306 * Create viewer streams for relay streams that are ready to be
307 * used for a the given session id only.
310 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
, &iter
.iter
, ctf_trace
,
312 struct relay_stream
*stream
;
314 health_code_update();
316 if (!ctf_trace_get(ctf_trace
)) {
320 cds_list_for_each_entry_rcu(stream
, &ctf_trace
->stream_list
, stream_node
) {
321 struct relay_viewer_stream
*vstream
;
323 if (!stream_get(stream
)) {
327 * stream published is protected by the session lock.
329 if (!stream
->published
) {
332 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
334 vstream
= viewer_stream_create(stream
,
335 viewer_trace_chunk
, seek_t
);
338 ctf_trace_put(ctf_trace
);
344 /* Update number of created stream counter. */
348 * Ensure a self-reference is preserved even
349 * after we have put our local reference.
351 if (!viewer_stream_get(vstream
)) {
352 ERR("Unable to get self-reference on viewer stream, logic error.");
356 if (!vstream
->sent_flag
&& nb_unsent
) {
357 /* Update number of unsent stream counter. */
361 /* Update number of total stream counter. */
363 if (stream
->is_metadata
) {
364 if (!stream
->closed
||
365 stream
->metadata_received
> vstream
->metadata_sent
) {
369 if (!stream
->closed
||
370 !(((int64_t) (stream
->prev_data_seq
- stream
->last_net_seq_num
)) >= 0)) {
376 /* Put local reference. */
377 viewer_stream_put(vstream
);
381 ctf_trace_put(ctf_trace
);
392 int relayd_live_stop(void)
394 /* Stop dispatch thread */
395 CMM_STORE_SHARED(live_dispatch_thread_exit
, 1);
396 futex_nto1_wake(&viewer_conn_queue
.futex
);
401 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
404 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
408 if (events
== NULL
|| size
== 0) {
413 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
419 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
431 * Check if the thread quit pipe was triggered.
433 * Return 1 if it was triggered else 0;
436 int check_thread_quit_pipe(int fd
, uint32_t events
)
438 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
446 * Create and init socket from uri.
449 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
)
452 struct lttcomm_sock
*sock
= NULL
;
454 sock
= lttcomm_alloc_sock_from_uri(uri
);
456 ERR("Allocating socket");
460 ret
= lttcomm_create_sock(sock
);
464 DBG("Listening on sock %d for lttng-live", sock
->fd
);
466 ret
= sock
->ops
->bind(sock
);
468 PERROR("Failed to bind lttng-live socket");
472 ret
= sock
->ops
->listen(sock
, -1);
482 lttcomm_destroy_sock(sock
);
488 * This thread manages the listening for new connections on the network
491 void *thread_listener(void *data
)
493 int i
, ret
, pollfd
, err
= -1;
494 uint32_t revents
, nb_fd
;
495 struct lttng_poll_event events
;
496 struct lttcomm_sock
*live_control_sock
;
498 DBG("[thread] Relay live listener started");
500 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
502 health_code_update();
504 live_control_sock
= init_socket(live_uri
);
505 if (!live_control_sock
) {
506 goto error_sock_control
;
509 /* Pass 2 as size here for the thread quit pipe and control sockets. */
510 ret
= create_thread_poll_set(&events
, 2);
512 goto error_create_poll
;
515 /* Add the control socket */
516 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
521 lttng_relay_notify_ready();
523 if (testpoint(relayd_thread_live_listener
)) {
524 goto error_testpoint
;
528 health_code_update();
530 DBG("Listener accepting live viewers connections");
534 ret
= lttng_poll_wait(&events
, -1);
538 * Restart interrupted system call.
540 if (errno
== EINTR
) {
547 DBG("Relay new viewer connection received");
548 for (i
= 0; i
< nb_fd
; i
++) {
549 health_code_update();
551 /* Fetch once the poll data */
552 revents
= LTTNG_POLL_GETEV(&events
, i
);
553 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
555 /* Thread quit pipe has been closed. Killing thread. */
556 ret
= check_thread_quit_pipe(pollfd
, revents
);
562 if (revents
& LPOLLIN
) {
564 * A new connection is requested, therefore a
565 * viewer connection is allocated in this
566 * thread, enqueued to a global queue and
567 * dequeued (and freed) in the worker thread.
570 struct relay_connection
*new_conn
;
571 struct lttcomm_sock
*newsock
;
573 newsock
= live_control_sock
->ops
->accept(live_control_sock
);
575 PERROR("accepting control sock");
578 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
580 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
583 PERROR("setsockopt inet");
584 lttcomm_destroy_sock(newsock
);
587 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
589 lttcomm_destroy_sock(newsock
);
592 /* Ownership assumed by the connection. */
595 /* Enqueue request for the dispatcher thread. */
596 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
600 * Wake the dispatch queue futex.
601 * Implicit memory barrier with the
602 * exchange in cds_wfcq_enqueue.
604 futex_nto1_wake(&viewer_conn_queue
.futex
);
605 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
606 ERR("socket poll error");
609 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
619 lttng_poll_clean(&events
);
621 if (live_control_sock
->fd
>= 0) {
622 ret
= live_control_sock
->ops
->close(live_control_sock
);
627 lttcomm_destroy_sock(live_control_sock
);
631 DBG("Live viewer listener thread exited with error");
633 health_unregister(health_relayd
);
634 DBG("Live viewer listener thread cleanup complete");
635 if (lttng_relay_stop_threads()) {
636 ERR("Error stopping threads");
642 * This thread manages the dispatching of the requests to worker threads
645 void *thread_dispatcher(void *data
)
649 struct cds_wfcq_node
*node
;
650 struct relay_connection
*conn
= NULL
;
652 DBG("[thread] Live viewer relay dispatcher started");
654 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
656 if (testpoint(relayd_thread_live_dispatcher
)) {
657 goto error_testpoint
;
660 health_code_update();
663 health_code_update();
665 /* Atomically prepare the queue futex */
666 futex_nto1_prepare(&viewer_conn_queue
.futex
);
668 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
673 health_code_update();
675 /* Dequeue commands */
676 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
677 &viewer_conn_queue
.tail
);
679 DBG("Woken up but nothing in the live-viewer "
680 "relay command queue");
681 /* Continue thread execution */
684 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
685 DBG("Dispatching viewer request waiting on sock %d",
689 * Inform worker thread of the new request. This
690 * call is blocking so we can be assured that
691 * the data will be read at some point in time
692 * or wait to the end of the world :)
694 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
696 PERROR("write conn pipe");
697 connection_put(conn
);
700 } while (node
!= NULL
);
702 /* Futex wait on queue. Blocking call on futex() */
704 futex_nto1_wait(&viewer_conn_queue
.futex
);
708 /* Normal exit, no error */
715 ERR("Health error occurred in %s", __func__
);
717 health_unregister(health_relayd
);
718 DBG("Live viewer dispatch thread dying");
719 if (lttng_relay_stop_threads()) {
720 ERR("Error stopping threads");
726 * Establish connection with the viewer and check the versions.
728 * Return 0 on success or else negative value.
731 int viewer_connect(struct relay_connection
*conn
)
734 struct lttng_viewer_connect reply
, msg
;
736 conn
->version_check_done
= 1;
738 health_code_update();
740 DBG("Viewer is establishing a connection to the relayd.");
742 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
747 health_code_update();
749 memset(&reply
, 0, sizeof(reply
));
750 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
751 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
753 /* Major versions must be the same */
754 if (reply
.major
!= be32toh(msg
.major
)) {
755 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
756 reply
.major
, be32toh(msg
.major
));
761 conn
->major
= reply
.major
;
762 /* We adapt to the lowest compatible version */
763 if (reply
.minor
<= be32toh(msg
.minor
)) {
764 conn
->minor
= reply
.minor
;
766 conn
->minor
= be32toh(msg
.minor
);
769 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
770 conn
->type
= RELAY_VIEWER_COMMAND
;
771 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
772 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
774 ERR("Unknown connection type : %u", be32toh(msg
.type
));
779 reply
.major
= htobe32(reply
.major
);
780 reply
.minor
= htobe32(reply
.minor
);
781 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
783 * Increment outside of htobe64 macro, because the argument can
784 * be used more than once within the macro, and thus the
785 * operation may be undefined.
787 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
788 last_relay_viewer_session_id
++;
789 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
790 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
793 health_code_update();
795 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
800 health_code_update();
802 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
810 * Send the viewer the list of current sessions.
811 * We need to create a copy of the hash table content because otherwise
812 * we cannot assume the number of entries stays the same between getting
813 * the number of HT elements and iteration over the HT.
815 * Return 0 on success or else a negative value.
818 int viewer_list_sessions(struct relay_connection
*conn
)
821 struct lttng_viewer_list_sessions session_list
;
822 struct lttng_ht_iter iter
;
823 struct relay_session
*session
;
824 struct lttng_viewer_session
*send_session_buf
= NULL
;
825 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
828 DBG("List sessions received");
830 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
831 if (!send_session_buf
) {
836 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
838 struct lttng_viewer_session
*send_session
;
840 health_code_update();
842 pthread_mutex_lock(&session
->lock
);
843 if (session
->connection_closed
) {
844 /* Skip closed session */
847 if (!session
->current_trace_chunk
) {
849 * Skip un-attachable session. It is either
850 * being destroyed or has not had a trace
851 * chunk created against it yet.
856 if (count
>= buf_count
) {
857 struct lttng_viewer_session
*newbuf
;
858 uint32_t new_buf_count
= buf_count
<< 1;
860 newbuf
= realloc(send_session_buf
,
861 new_buf_count
* sizeof(*send_session_buf
));
866 send_session_buf
= newbuf
;
867 buf_count
= new_buf_count
;
869 send_session
= &send_session_buf
[count
];
870 if (lttng_strncpy(send_session
->session_name
,
871 session
->session_name
,
872 sizeof(send_session
->session_name
))) {
876 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
877 sizeof(send_session
->hostname
))) {
881 send_session
->id
= htobe64(session
->id
);
882 send_session
->live_timer
= htobe32(session
->live_timer
);
883 if (session
->viewer_attached
) {
884 send_session
->clients
= htobe32(1);
886 send_session
->clients
= htobe32(0);
888 send_session
->streams
= htobe32(session
->stream_count
);
891 pthread_mutex_unlock(&session
->lock
);
894 pthread_mutex_unlock(&session
->lock
);
902 session_list
.sessions_count
= htobe32(count
);
904 health_code_update();
906 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
911 health_code_update();
913 ret
= send_response(conn
->sock
, send_session_buf
,
914 count
* sizeof(*send_session_buf
));
918 health_code_update();
922 free(send_session_buf
);
927 * Send the viewer the list of current streams.
930 int viewer_get_new_streams(struct relay_connection
*conn
)
932 int ret
, send_streams
= 0;
933 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
934 struct lttng_viewer_new_streams_request request
;
935 struct lttng_viewer_new_streams_response response
;
936 struct relay_session
*session
= NULL
;
942 DBG("Get new streams received");
944 health_code_update();
946 /* Receive the request from the connected client. */
947 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
951 session_id
= be64toh(request
.session_id
);
953 health_code_update();
955 memset(&response
, 0, sizeof(response
));
957 session
= session_get_by_id(session_id
);
959 DBG("Relay session %" PRIu64
" not found", session_id
);
960 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
964 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
965 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
969 pthread_mutex_lock(&session
->lock
);
970 ret
= make_viewer_streams(session
,
971 conn
->viewer_session
->current_trace_chunk
,
972 LTTNG_VIEWER_SEEK_LAST
, &nb_total
, &nb_unsent
,
973 &nb_created
, &closed
);
975 goto error_unlock_session
;
978 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
980 /* Only send back the newly created streams with the unsent ones. */
981 nb_streams
= nb_created
+ nb_unsent
;
982 response
.streams_count
= htobe32(nb_streams
);
985 * If the session is closed, HUP when there are no more streams
988 if (closed
&& nb_total
== 0) {
990 response
.streams_count
= 0;
991 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
992 goto send_reply_unlock
;
995 pthread_mutex_unlock(&session
->lock
);
998 health_code_update();
999 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1001 goto end_put_session
;
1003 health_code_update();
1006 * Unknown or empty session, just return gracefully, the viewer
1007 * knows what is happening.
1009 if (!send_streams
|| !nb_streams
) {
1011 goto end_put_session
;
1015 * Send stream and *DON'T* ignore the sent flag so every viewer
1016 * streams that were not sent from that point will be sent to
1019 ret
= send_viewer_streams(conn
->sock
, session_id
, 0);
1021 goto end_put_session
;
1026 session_put(session
);
1030 error_unlock_session
:
1031 pthread_mutex_unlock(&session
->lock
);
1032 session_put(session
);
1037 * Send the viewer the list of current sessions.
1040 int viewer_attach_session(struct relay_connection
*conn
)
1042 int send_streams
= 0;
1044 uint32_t nb_streams
= 0;
1045 enum lttng_viewer_seek seek_type
;
1046 struct lttng_viewer_attach_session_request request
;
1047 struct lttng_viewer_attach_session_response response
;
1048 struct relay_session
*session
= NULL
;
1049 enum lttng_viewer_attach_return_code viewer_attach_status
;
1050 bool closed
= false;
1051 uint64_t session_id
;
1055 health_code_update();
1057 /* Receive the request from the connected client. */
1058 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1063 session_id
= be64toh(request
.session_id
);
1064 health_code_update();
1066 memset(&response
, 0, sizeof(response
));
1068 if (!conn
->viewer_session
) {
1069 DBG("Client trying to attach before creating a live viewer session");
1070 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1074 session
= session_get_by_id(session_id
);
1076 DBG("Relay session %" PRIu64
" not found", session_id
);
1077 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1080 DBG("Attach session ID %" PRIu64
" received", session_id
);
1082 pthread_mutex_lock(&session
->lock
);
1083 if (!session
->current_trace_chunk
) {
1085 * Session is either being destroyed or it never had a trace
1086 * chunk created against it.
1088 DBG("Session requested by live client has no current trace chunk, returning unknown session");
1089 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1092 if (session
->live_timer
== 0) {
1093 DBG("Not live session");
1094 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1099 viewer_attach_status
= viewer_session_attach(conn
->viewer_session
,
1101 if (viewer_attach_status
!= LTTNG_VIEWER_ATTACH_OK
) {
1102 response
.status
= htobe32(viewer_attach_status
);
1106 switch (be32toh(request
.seek
)) {
1107 case LTTNG_VIEWER_SEEK_BEGINNING
:
1108 case LTTNG_VIEWER_SEEK_LAST
:
1109 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1110 seek_type
= be32toh(request
.seek
);
1113 ERR("Wrong seek parameter");
1114 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1119 ret
= make_viewer_streams(session
,
1120 conn
->viewer_session
->current_trace_chunk
, seek_type
,
1121 &nb_streams
, NULL
, NULL
, &closed
);
1123 goto end_put_session
;
1125 pthread_mutex_unlock(&session
->lock
);
1126 session_put(session
);
1129 response
.streams_count
= htobe32(nb_streams
);
1131 * If the session is closed when the viewer is attaching, it
1132 * means some of the streams may have been concurrently removed,
1133 * so we don't allow the viewer to attach, even if there are
1134 * streams available.
1138 response
.streams_count
= 0;
1139 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1144 health_code_update();
1145 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1147 goto end_put_session
;
1149 health_code_update();
1152 * Unknown or empty session, just return gracefully, the viewer
1153 * knows what is happening.
1155 if (!send_streams
|| !nb_streams
) {
1157 goto end_put_session
;
1160 /* Send stream and ignore the sent flag. */
1161 ret
= send_viewer_streams(conn
->sock
, session_id
, 1);
1163 goto end_put_session
;
1168 pthread_mutex_unlock(&session
->lock
);
1169 session_put(session
);
1176 * Open the index file if needed for the given vstream.
1178 * If an index file is successfully opened, the vstream will set it as its
1179 * current index file.
1181 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1183 * Called with rstream lock held.
1185 static int try_open_index(struct relay_viewer_stream
*vstream
,
1186 struct relay_stream
*rstream
)
1189 const uint32_t connection_major
= rstream
->trace
->session
->major
;
1190 const uint32_t connection_minor
= rstream
->trace
->session
->minor
;
1192 if (vstream
->index_file
) {
1197 * First time, we open the index file and at least one index is ready.
1199 if (rstream
->index_received_seqcount
== 0) {
1203 vstream
->index_file
= lttng_index_file_create_from_trace_chunk_read_only(
1204 vstream
->stream_file
.trace_chunk
, rstream
->path_name
,
1205 rstream
->channel_name
, rstream
->tracefile_size
,
1206 vstream
->current_tracefile_id
,
1207 lttng_to_index_major(connection_major
, connection_minor
),
1208 lttng_to_index_minor(connection_major
, connection_minor
));
1209 if (!vstream
->index_file
) {
1218 * Check the status of the index for the given stream. This function
1219 * updates the index structure if needed and can put (close) the vstream
1220 * in the HUP situation.
1222 * Return 0 means that we can proceed with the index. A value of 1 means
1223 * that the index has been updated and is ready to be sent to the
1224 * client. A negative value indicates an error that can't be handled.
1226 * Called with rstream lock held.
1228 static int check_index_status(struct relay_viewer_stream
*vstream
,
1229 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1230 struct lttng_viewer_index
*index
)
1234 if ((trace
->session
->connection_closed
|| rstream
->closed
)
1235 && rstream
->index_received_seqcount
1236 == vstream
->index_sent_seqcount
) {
1238 * Last index sent and session connection or relay
1239 * stream are closed.
1241 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1243 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1244 rstream
->index_received_seqcount
1245 == vstream
->index_sent_seqcount
) {
1247 * We've received a synchronization beacon and the last index
1248 * available has been sent, the index for now is inactive.
1250 * In this case, we have received a beacon which allows us to
1251 * inform the client of a time interval during which we can
1252 * guarantee that there are no events to read (and never will
1255 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1256 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1257 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1259 } else if (rstream
->index_received_seqcount
1260 == vstream
->index_sent_seqcount
) {
1262 * This checks whether received == sent seqcount. In
1263 * this case, we have not received a beacon. Therefore,
1264 * we can only ask the client to retry later.
1266 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1268 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1269 vstream
->current_tracefile_id
,
1270 vstream
->index_sent_seqcount
)) {
1272 * The next index we want to send cannot be read either
1273 * because we need to perform a rotation, or due to
1274 * the producer having overwritten its trace file.
1276 DBG("Viewer stream %" PRIu64
" rotation",
1277 vstream
->stream
->stream_handle
);
1278 ret
= viewer_stream_rotate(vstream
);
1281 } else if (ret
== 1) {
1282 /* EOF across entire stream. */
1283 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1287 * If we have been pushed due to overwrite, it
1288 * necessarily means there is data that can be read in
1289 * the stream. If we rotated because we reached the end
1290 * of a tracefile, it means the following tracefile
1291 * needs to contain at least one index, else we would
1292 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1293 * viewer. The updated index_sent_seqcount needs to
1294 * point to a readable index entry now.
1296 * In the case where we "rotate" on a single file, we
1297 * can end up in a case where the requested index is
1298 * still unavailable.
1300 if (rstream
->tracefile_count
== 1 &&
1301 !tracefile_array_seq_in_file(
1303 vstream
->current_tracefile_id
,
1304 vstream
->index_sent_seqcount
)) {
1305 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1308 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1309 vstream
->current_tracefile_id
,
1310 vstream
->index_sent_seqcount
));
1312 /* ret == 0 means successful so we continue. */
1318 viewer_stream_put(vstream
);
1324 * Send the next index for a stream.
1326 * Return 0 on success or else a negative value.
1329 int viewer_get_next_index(struct relay_connection
*conn
)
1332 struct lttng_viewer_get_next_index request_index
;
1333 struct lttng_viewer_index viewer_index
;
1334 struct ctf_packet_index packet_index
;
1335 struct relay_viewer_stream
*vstream
= NULL
;
1336 struct relay_stream
*rstream
= NULL
;
1337 struct ctf_trace
*ctf_trace
= NULL
;
1338 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1342 DBG("Viewer get next index");
1344 memset(&viewer_index
, 0, sizeof(viewer_index
));
1345 health_code_update();
1347 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1351 health_code_update();
1353 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1355 DBG("Client requested index of unknown stream id %" PRIu64
,
1356 (uint64_t) be64toh(request_index
.stream_id
));
1357 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1361 /* Use back. ref. Protected by refcounts. */
1362 rstream
= vstream
->stream
;
1363 ctf_trace
= rstream
->trace
;
1365 /* metadata_viewer_stream may be NULL. */
1366 metadata_viewer_stream
=
1367 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1369 pthread_mutex_lock(&rstream
->lock
);
1372 * The viewer should not ask for index on metadata stream.
1374 if (rstream
->is_metadata
) {
1375 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1379 /* Try to open an index if one is needed for that stream. */
1380 ret
= try_open_index(vstream
, rstream
);
1382 if (ret
== -ENOENT
) {
1384 * The index is created only when the first data
1385 * packet arrives, it might not be ready at the
1386 * beginning of the session
1388 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1390 /* Unhandled error. */
1391 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1396 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1399 } else if (ret
== 1) {
1401 * We have no index to send and check_index_status has populated
1402 * viewer_index's status.
1406 /* At this point, ret is 0 thus we will be able to read the index. */
1410 * vstream->stream_fd may be NULL if it has been closed by
1411 * tracefile rotation, or if we are at the beginning of the
1412 * stream. We open the data stream file here to protect against
1413 * overwrite caused by tracefile rotation (in association with
1414 * unlink performed before overwrite).
1416 if (!vstream
->stream_file
.fd
) {
1418 char file_path
[LTTNG_PATH_MAX
];
1419 enum lttng_trace_chunk_status status
;
1421 ret
= utils_stream_file_path(rstream
->path_name
,
1422 rstream
->channel_name
, rstream
->tracefile_size
,
1423 vstream
->current_tracefile_id
, NULL
, file_path
,
1429 status
= lttng_trace_chunk_open_file(
1430 vstream
->stream_file
.trace_chunk
,
1431 file_path
, O_RDONLY
, 0, &fd
);
1432 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1433 PERROR("Failed to open trace file for viewer stream");
1436 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1437 if (!vstream
->stream_file
.fd
) {
1439 PERROR("Failed to close viewer stream file");
1445 ret
= check_new_streams(conn
);
1447 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1449 } else if (ret
== 1) {
1450 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1453 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1455 ERR("Relay error reading index file %d",
1456 vstream
->index_file
->fd
);
1457 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1460 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1461 vstream
->index_sent_seqcount
++;
1465 * Indexes are stored in big endian, no need to switch before sending.
1467 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1468 rstream
->stream_handle
,
1469 (uint64_t) be64toh(packet_index
.offset
));
1470 viewer_index
.offset
= packet_index
.offset
;
1471 viewer_index
.packet_size
= packet_index
.packet_size
;
1472 viewer_index
.content_size
= packet_index
.content_size
;
1473 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1474 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1475 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1476 viewer_index
.stream_id
= packet_index
.stream_id
;
1480 pthread_mutex_unlock(&rstream
->lock
);
1483 if (metadata_viewer_stream
) {
1484 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1485 DBG("get next index metadata check: recv %" PRIu64
1487 metadata_viewer_stream
->stream
->metadata_received
,
1488 metadata_viewer_stream
->metadata_sent
);
1489 if (!metadata_viewer_stream
->stream
->metadata_received
||
1490 metadata_viewer_stream
->stream
->metadata_received
>
1491 metadata_viewer_stream
->metadata_sent
) {
1492 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1494 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1497 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1498 health_code_update();
1500 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1504 health_code_update();
1507 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1508 vstream
->index_sent_seqcount
,
1509 vstream
->stream
->stream_handle
);
1512 if (metadata_viewer_stream
) {
1513 viewer_stream_put(metadata_viewer_stream
);
1516 viewer_stream_put(vstream
);
1521 pthread_mutex_unlock(&rstream
->lock
);
1522 if (metadata_viewer_stream
) {
1523 viewer_stream_put(metadata_viewer_stream
);
1525 viewer_stream_put(vstream
);
1530 * Send the next index for a stream
1532 * Return 0 on success or else a negative value.
1535 int viewer_get_packet(struct relay_connection
*conn
)
1540 struct lttng_viewer_get_packet get_packet_info
;
1541 struct lttng_viewer_trace_packet reply_header
;
1542 struct relay_viewer_stream
*vstream
= NULL
;
1543 uint32_t reply_size
= sizeof(reply_header
);
1544 uint32_t packet_data_len
= 0;
1547 DBG2("Relay get data packet");
1549 health_code_update();
1551 ret
= recv_request(conn
->sock
, &get_packet_info
,
1552 sizeof(get_packet_info
));
1556 health_code_update();
1558 /* From this point on, the error label can be reached. */
1559 memset(&reply_header
, 0, sizeof(reply_header
));
1561 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1563 DBG("Client requested packet of unknown stream id %" PRIu64
,
1564 (uint64_t) be64toh(get_packet_info
.stream_id
));
1565 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1566 goto send_reply_nolock
;
1568 packet_data_len
= be32toh(get_packet_info
.len
);
1569 reply_size
+= packet_data_len
;
1572 reply
= zmalloc(reply_size
);
1574 PERROR("packet reply zmalloc");
1575 reply_size
= sizeof(reply_header
);
1579 pthread_mutex_lock(&vstream
->stream
->lock
);
1580 lseek_ret
= lseek(vstream
->stream_file
.fd
->fd
,
1581 be64toh(get_packet_info
.offset
), SEEK_SET
);
1582 if (lseek_ret
< 0) {
1583 PERROR("lseek fd %d to offset %" PRIu64
,
1584 vstream
->stream_file
.fd
->fd
,
1585 (uint64_t) be64toh(get_packet_info
.offset
));
1588 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
,
1589 reply
+ sizeof(reply_header
), packet_data_len
);
1590 if (read_len
< packet_data_len
) {
1591 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1592 vstream
->stream_file
.fd
->fd
,
1593 (uint64_t) be64toh(get_packet_info
.offset
));
1596 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1597 reply_header
.len
= htobe32(packet_data_len
);
1601 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1605 pthread_mutex_unlock(&vstream
->stream
->lock
);
1609 health_code_update();
1612 memcpy(reply
, &reply_header
, sizeof(reply_header
));
1613 ret
= send_response(conn
->sock
, reply
, reply_size
);
1615 /* No reply to send. */
1616 ret
= send_response(conn
->sock
, &reply_header
,
1620 health_code_update();
1622 PERROR("sendmsg of packet data failed");
1626 DBG("Sent %u bytes for stream %" PRIu64
, reply_size
,
1627 (uint64_t) be64toh(get_packet_info
.stream_id
));
1633 viewer_stream_put(vstream
);
1639 * Send the session's metadata
1641 * Return 0 on success else a negative value.
1644 int viewer_get_metadata(struct relay_connection
*conn
)
1650 struct lttng_viewer_get_metadata request
;
1651 struct lttng_viewer_metadata_packet reply
;
1652 struct relay_viewer_stream
*vstream
= NULL
;
1656 DBG("Relay get metadata");
1658 health_code_update();
1660 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1664 health_code_update();
1666 memset(&reply
, 0, sizeof(reply
));
1668 vstream
= viewer_stream_get_by_id(be64toh(request
.stream_id
));
1671 * The metadata stream can be closed by a CLOSE command
1672 * just before we attach. It can also be closed by
1673 * per-pid tracing during tracing. Therefore, it is
1674 * possible that we cannot find this viewer stream.
1675 * Reply back to the client with an error if we cannot
1678 DBG("Client requested metadata of unknown stream id %" PRIu64
,
1679 (uint64_t) be64toh(request
.stream_id
));
1680 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1683 pthread_mutex_lock(&vstream
->stream
->lock
);
1684 if (!vstream
->stream
->is_metadata
) {
1685 ERR("Invalid metadata stream");
1689 assert(vstream
->metadata_sent
<= vstream
->stream
->metadata_received
);
1691 len
= vstream
->stream
->metadata_received
- vstream
->metadata_sent
;
1693 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1697 /* first time, we open the metadata file */
1698 if (!vstream
->stream_file
.fd
) {
1700 char file_path
[LTTNG_PATH_MAX
];
1701 enum lttng_trace_chunk_status status
;
1702 struct relay_stream
*rstream
= vstream
->stream
;
1704 ret
= utils_stream_file_path(rstream
->path_name
,
1705 rstream
->channel_name
, rstream
->tracefile_size
,
1706 vstream
->current_tracefile_id
, NULL
, file_path
,
1712 status
= lttng_trace_chunk_open_file(
1713 vstream
->stream_file
.trace_chunk
,
1714 file_path
, O_RDONLY
, 0, &fd
);
1715 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1716 PERROR("Failed to open metadata file for viewer stream");
1719 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1720 if (!vstream
->stream_file
.fd
) {
1722 PERROR("Failed to close viewer metadata file");
1728 reply
.len
= htobe64(len
);
1729 data
= zmalloc(len
);
1731 PERROR("viewer metadata zmalloc");
1735 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
, data
, len
);
1736 if (read_len
< len
) {
1737 PERROR("Relay reading metadata file");
1740 vstream
->metadata_sent
+= read_len
;
1741 if (vstream
->metadata_sent
== vstream
->stream
->metadata_received
1742 && vstream
->stream
->closed
) {
1743 /* Release ownership for the viewer metadata stream. */
1744 viewer_stream_put(vstream
);
1747 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1752 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1755 health_code_update();
1757 pthread_mutex_unlock(&vstream
->stream
->lock
);
1759 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1763 health_code_update();
1766 ret
= send_response(conn
->sock
, data
, len
);
1772 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1773 (uint64_t) be64toh(request
.stream_id
));
1775 DBG("Metadata sent");
1781 viewer_stream_put(vstream
);
1787 * Create a viewer session.
1789 * Return 0 on success or else a negative value.
1792 int viewer_create_session(struct relay_connection
*conn
)
1795 struct lttng_viewer_create_session_response resp
;
1797 DBG("Viewer create session received");
1799 memset(&resp
, 0, sizeof(resp
));
1800 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
1801 conn
->viewer_session
= viewer_session_create();
1802 if (!conn
->viewer_session
) {
1803 ERR("Allocation viewer session");
1804 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
1809 health_code_update();
1810 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
1814 health_code_update();
1822 * Detach a viewer session.
1824 * Return 0 on success or else a negative value.
1827 int viewer_detach_session(struct relay_connection
*conn
)
1830 struct lttng_viewer_detach_session_response response
;
1831 struct lttng_viewer_detach_session_request request
;
1832 struct relay_session
*session
= NULL
;
1833 uint64_t viewer_session_to_close
;
1835 DBG("Viewer detach session received");
1839 health_code_update();
1841 /* Receive the request from the connected client. */
1842 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1846 viewer_session_to_close
= be64toh(request
.session_id
);
1848 if (!conn
->viewer_session
) {
1849 DBG("Client trying to detach before creating a live viewer session");
1850 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1854 health_code_update();
1856 memset(&response
, 0, sizeof(response
));
1857 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
1859 session
= session_get_by_id(be64toh(request
.session_id
));
1861 DBG("Relay session %" PRIu64
" not found",
1862 (uint64_t) be64toh(request
.session_id
));
1863 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
1867 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
1869 DBG("Not attached to this session");
1870 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1871 goto send_reply_put
;
1874 viewer_session_close_one_session(conn
->viewer_session
, session
);
1875 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
1876 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
1879 session_put(session
);
1882 health_code_update();
1883 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1887 health_code_update();
1895 * live_relay_unknown_command: send -1 if received unknown command
1898 void live_relay_unknown_command(struct relay_connection
*conn
)
1900 struct lttcomm_relayd_generic_reply reply
;
1902 memset(&reply
, 0, sizeof(reply
));
1903 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1904 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
1908 * Process the commands received on the control socket
1911 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1912 struct relay_connection
*conn
)
1917 msg_value
= be32toh(recv_hdr
->cmd
);
1920 * Make sure we've done the version check before any command other then a
1921 * new client connection.
1923 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
1924 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
1929 switch (msg_value
) {
1930 case LTTNG_VIEWER_CONNECT
:
1931 ret
= viewer_connect(conn
);
1933 case LTTNG_VIEWER_LIST_SESSIONS
:
1934 ret
= viewer_list_sessions(conn
);
1936 case LTTNG_VIEWER_ATTACH_SESSION
:
1937 ret
= viewer_attach_session(conn
);
1939 case LTTNG_VIEWER_GET_NEXT_INDEX
:
1940 ret
= viewer_get_next_index(conn
);
1942 case LTTNG_VIEWER_GET_PACKET
:
1943 ret
= viewer_get_packet(conn
);
1945 case LTTNG_VIEWER_GET_METADATA
:
1946 ret
= viewer_get_metadata(conn
);
1948 case LTTNG_VIEWER_GET_NEW_STREAMS
:
1949 ret
= viewer_get_new_streams(conn
);
1951 case LTTNG_VIEWER_CREATE_SESSION
:
1952 ret
= viewer_create_session(conn
);
1954 case LTTNG_VIEWER_DETACH_SESSION
:
1955 ret
= viewer_detach_session(conn
);
1958 ERR("Received unknown viewer command (%u)",
1959 be32toh(recv_hdr
->cmd
));
1960 live_relay_unknown_command(conn
);
1970 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
1974 (void) lttng_poll_del(events
, pollfd
);
1976 ret
= close(pollfd
);
1978 ERR("Closing pollfd %d", pollfd
);
1983 * This thread does the actual work
1986 void *thread_worker(void *data
)
1990 struct lttng_poll_event events
;
1991 struct lttng_ht
*viewer_connections_ht
;
1992 struct lttng_ht_iter iter
;
1993 struct lttng_viewer_cmd recv_hdr
;
1994 struct relay_connection
*destroy_conn
;
1996 DBG("[thread] Live viewer relay worker started");
1998 rcu_register_thread();
2000 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
2002 if (testpoint(relayd_thread_live_worker
)) {
2003 goto error_testpoint
;
2006 /* table of connections indexed on socket */
2007 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2008 if (!viewer_connections_ht
) {
2009 goto viewer_connections_ht_error
;
2012 ret
= create_thread_poll_set(&events
, 2);
2014 goto error_poll_create
;
2017 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2026 health_code_update();
2028 /* Infinite blocking call, waiting for transmission */
2029 DBG3("Relayd live viewer worker thread polling...");
2030 health_poll_entry();
2031 ret
= lttng_poll_wait(&events
, -1);
2035 * Restart interrupted system call.
2037 if (errno
== EINTR
) {
2046 * Process control. The control connection is prioritised so we don't
2047 * starve it with high throughput tracing data on the data
2050 for (i
= 0; i
< nb_fd
; i
++) {
2051 /* Fetch once the poll data */
2052 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2053 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2055 health_code_update();
2057 /* Thread quit pipe has been closed. Killing thread. */
2058 ret
= check_thread_quit_pipe(pollfd
, revents
);
2064 /* Inspect the relay conn pipe for new connection. */
2065 if (pollfd
== live_conn_pipe
[0]) {
2066 if (revents
& LPOLLIN
) {
2067 struct relay_connection
*conn
;
2069 ret
= lttng_read(live_conn_pipe
[0],
2070 &conn
, sizeof(conn
));
2074 ret
= lttng_poll_add(&events
,
2076 LPOLLIN
| LPOLLRDHUP
);
2078 ERR("Failed to add new live connection file descriptor to poll set");
2081 connection_ht_add(viewer_connections_ht
, conn
);
2082 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2083 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2084 ERR("Relay live pipe error");
2087 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2091 /* Connection activity. */
2092 struct relay_connection
*conn
;
2094 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2099 if (revents
& LPOLLIN
) {
2100 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2101 sizeof(recv_hdr
), 0);
2103 /* Connection closed. */
2104 cleanup_connection_pollfd(&events
, pollfd
);
2105 /* Put "create" ownership reference. */
2106 connection_put(conn
);
2107 DBG("Viewer control conn closed with %d", pollfd
);
2109 ret
= process_control(&recv_hdr
, conn
);
2111 /* Clear the session on error. */
2112 cleanup_connection_pollfd(&events
, pollfd
);
2113 /* Put "create" ownership reference. */
2114 connection_put(conn
);
2115 DBG("Viewer connection closed with %d", pollfd
);
2118 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2119 cleanup_connection_pollfd(&events
, pollfd
);
2120 /* Put "create" ownership reference. */
2121 connection_put(conn
);
2123 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2124 connection_put(conn
);
2127 /* Put local "get_by_sock" reference. */
2128 connection_put(conn
);
2135 lttng_poll_clean(&events
);
2137 /* Cleanup remaining connection object. */
2139 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2142 health_code_update();
2143 connection_put(destroy_conn
);
2147 lttng_ht_destroy(viewer_connections_ht
);
2148 viewer_connections_ht_error
:
2149 /* Close relay conn pipes */
2150 utils_close_pipe(live_conn_pipe
);
2152 DBG("Viewer worker thread exited with error");
2154 DBG("Viewer worker thread cleanup complete");
2158 ERR("Health error occurred in %s", __func__
);
2160 health_unregister(health_relayd
);
2161 if (lttng_relay_stop_threads()) {
2162 ERR("Error stopping threads");
2164 rcu_unregister_thread();
2169 * Create the relay command pipe to wake thread_manage_apps.
2170 * Closed in cleanup().
2172 static int create_conn_pipe(void)
2174 return utils_create_pipe_cloexec(live_conn_pipe
);
2177 int relayd_live_join(void)
2179 int ret
, retval
= 0;
2182 ret
= pthread_join(live_listener_thread
, &status
);
2185 PERROR("pthread_join live listener");
2189 ret
= pthread_join(live_worker_thread
, &status
);
2192 PERROR("pthread_join live worker");
2196 ret
= pthread_join(live_dispatcher_thread
, &status
);
2199 PERROR("pthread_join live dispatcher");
2203 cleanup_relayd_live();
2211 int relayd_live_create(struct lttng_uri
*uri
)
2213 int ret
= 0, retval
= 0;
2219 goto exit_init_data
;
2223 /* Check if daemon is UID = 0 */
2224 is_root
= !getuid();
2227 if (live_uri
->port
< 1024) {
2228 ERR("Need to be root to use ports < 1024");
2230 goto exit_init_data
;
2234 /* Setup the thread apps communication pipe. */
2235 if (create_conn_pipe()) {
2237 goto exit_init_data
;
2240 /* Init relay command queue. */
2241 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2243 /* Set up max poll set size */
2244 if (lttng_poll_set_max_size()) {
2246 goto exit_init_data
;
2249 /* Setup the dispatcher thread */
2250 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2251 thread_dispatcher
, (void *) NULL
);
2254 PERROR("pthread_create viewer dispatcher");
2256 goto exit_dispatcher_thread
;
2259 /* Setup the worker thread */
2260 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2261 thread_worker
, NULL
);
2264 PERROR("pthread_create viewer worker");
2266 goto exit_worker_thread
;
2269 /* Setup the listener thread */
2270 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2271 thread_listener
, (void *) NULL
);
2274 PERROR("pthread_create viewer listener");
2276 goto exit_listener_thread
;
2280 * All OK, started all threads.
2285 * Join on the live_listener_thread should anything be added after
2286 * the live_listener thread's creation.
2289 exit_listener_thread
:
2291 ret
= pthread_join(live_worker_thread
, &status
);
2294 PERROR("pthread_join live worker");
2299 ret
= pthread_join(live_dispatcher_thread
, &status
);
2302 PERROR("pthread_join live dispatcher");
2305 exit_dispatcher_thread
:
2308 cleanup_relayd_live();