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 (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
,
328 viewer_trace_chunk
, seek_t
);
331 ctf_trace_put(ctf_trace
);
337 /* Update number of created stream counter. */
341 * Ensure a self-reference is preserved even
342 * after we have put our local reference.
344 if (!viewer_stream_get(vstream
)) {
345 ERR("Unable to get self-reference on viewer stream, logic error.");
349 if (!vstream
->sent_flag
&& nb_unsent
) {
350 /* Update number of unsent stream counter. */
354 /* Update number of total stream counter. */
356 if (stream
->is_metadata
) {
357 if (!stream
->closed
||
358 stream
->metadata_received
> vstream
->metadata_sent
) {
362 if (!stream
->closed
||
363 !(((int64_t) (stream
->prev_data_seq
- stream
->last_net_seq_num
)) >= 0)) {
369 /* Put local reference. */
370 viewer_stream_put(vstream
);
374 ctf_trace_put(ctf_trace
);
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_thread_poll_set(struct lttng_poll_event
*events
, int size
)
400 if (events
== NULL
|| size
== 0) {
405 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
411 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
423 * Check if the thread quit pipe was triggered.
425 * Return 1 if it was triggered else 0;
428 int check_thread_quit_pipe(int fd
, uint32_t events
)
430 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
438 * Create and init socket from uri.
441 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
)
444 struct lttcomm_sock
*sock
= NULL
;
446 sock
= lttcomm_alloc_sock_from_uri(uri
);
448 ERR("Allocating socket");
452 ret
= lttcomm_create_sock(sock
);
456 DBG("Listening on sock %d for lttng-live", sock
->fd
);
458 ret
= sock
->ops
->bind(sock
);
460 PERROR("Failed to bind lttng-live socket");
464 ret
= sock
->ops
->listen(sock
, -1);
474 lttcomm_destroy_sock(sock
);
480 * This thread manages the listening for new connections on the network
483 void *thread_listener(void *data
)
485 int i
, ret
, pollfd
, err
= -1;
486 uint32_t revents
, nb_fd
;
487 struct lttng_poll_event events
;
488 struct lttcomm_sock
*live_control_sock
;
490 DBG("[thread] Relay live listener started");
492 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
494 health_code_update();
496 live_control_sock
= init_socket(live_uri
);
497 if (!live_control_sock
) {
498 goto error_sock_control
;
501 /* Pass 2 as size here for the thread quit pipe and control sockets. */
502 ret
= create_thread_poll_set(&events
, 2);
504 goto error_create_poll
;
507 /* Add the control socket */
508 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
513 lttng_relay_notify_ready();
515 if (testpoint(relayd_thread_live_listener
)) {
516 goto error_testpoint
;
520 health_code_update();
522 DBG("Listener accepting live viewers connections");
526 ret
= lttng_poll_wait(&events
, -1);
530 * Restart interrupted system call.
532 if (errno
== EINTR
) {
539 DBG("Relay new viewer connection received");
540 for (i
= 0; i
< nb_fd
; i
++) {
541 health_code_update();
543 /* Fetch once the poll data */
544 revents
= LTTNG_POLL_GETEV(&events
, i
);
545 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
547 /* Thread quit pipe has been closed. Killing thread. */
548 ret
= check_thread_quit_pipe(pollfd
, revents
);
554 if (revents
& LPOLLIN
) {
556 * A new connection is requested, therefore a
557 * viewer connection is allocated in this
558 * thread, enqueued to a global queue and
559 * dequeued (and freed) in the worker thread.
562 struct relay_connection
*new_conn
;
563 struct lttcomm_sock
*newsock
;
565 newsock
= live_control_sock
->ops
->accept(live_control_sock
);
567 PERROR("accepting control sock");
570 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
572 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
575 PERROR("setsockopt inet");
576 lttcomm_destroy_sock(newsock
);
579 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
581 lttcomm_destroy_sock(newsock
);
584 /* Ownership assumed by the connection. */
587 /* Enqueue request for the dispatcher thread. */
588 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
592 * Wake the dispatch queue futex.
593 * Implicit memory barrier with the
594 * exchange in cds_wfcq_enqueue.
596 futex_nto1_wake(&viewer_conn_queue
.futex
);
597 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
598 ERR("socket poll error");
601 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
611 lttng_poll_clean(&events
);
613 if (live_control_sock
->fd
>= 0) {
614 ret
= live_control_sock
->ops
->close(live_control_sock
);
619 lttcomm_destroy_sock(live_control_sock
);
623 DBG("Live viewer listener thread exited with error");
625 health_unregister(health_relayd
);
626 DBG("Live viewer listener thread cleanup complete");
627 if (lttng_relay_stop_threads()) {
628 ERR("Error stopping threads");
634 * This thread manages the dispatching of the requests to worker threads
637 void *thread_dispatcher(void *data
)
641 struct cds_wfcq_node
*node
;
642 struct relay_connection
*conn
= NULL
;
644 DBG("[thread] Live viewer relay dispatcher started");
646 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
648 if (testpoint(relayd_thread_live_dispatcher
)) {
649 goto error_testpoint
;
652 health_code_update();
655 health_code_update();
657 /* Atomically prepare the queue futex */
658 futex_nto1_prepare(&viewer_conn_queue
.futex
);
660 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
665 health_code_update();
667 /* Dequeue commands */
668 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
669 &viewer_conn_queue
.tail
);
671 DBG("Woken up but nothing in the live-viewer "
672 "relay command queue");
673 /* Continue thread execution */
676 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
677 DBG("Dispatching viewer request waiting on sock %d",
681 * Inform worker thread of the new request. This
682 * call is blocking so we can be assured that
683 * the data will be read at some point in time
684 * or wait to the end of the world :)
686 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
688 PERROR("write conn pipe");
689 connection_put(conn
);
692 } while (node
!= NULL
);
694 /* Futex wait on queue. Blocking call on futex() */
696 futex_nto1_wait(&viewer_conn_queue
.futex
);
700 /* Normal exit, no error */
707 ERR("Health error occurred in %s", __func__
);
709 health_unregister(health_relayd
);
710 DBG("Live viewer dispatch thread dying");
711 if (lttng_relay_stop_threads()) {
712 ERR("Error stopping threads");
718 * Establish connection with the viewer and check the versions.
720 * Return 0 on success or else negative value.
723 int viewer_connect(struct relay_connection
*conn
)
726 struct lttng_viewer_connect reply
, msg
;
728 conn
->version_check_done
= 1;
730 health_code_update();
732 DBG("Viewer is establishing a connection to the relayd.");
734 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
739 health_code_update();
741 memset(&reply
, 0, sizeof(reply
));
742 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
743 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
745 /* Major versions must be the same */
746 if (reply
.major
!= be32toh(msg
.major
)) {
747 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
748 reply
.major
, be32toh(msg
.major
));
753 conn
->major
= reply
.major
;
754 /* We adapt to the lowest compatible version */
755 if (reply
.minor
<= be32toh(msg
.minor
)) {
756 conn
->minor
= reply
.minor
;
758 conn
->minor
= be32toh(msg
.minor
);
761 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
762 conn
->type
= RELAY_VIEWER_COMMAND
;
763 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
764 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
766 ERR("Unknown connection type : %u", be32toh(msg
.type
));
771 reply
.major
= htobe32(reply
.major
);
772 reply
.minor
= htobe32(reply
.minor
);
773 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
775 * Increment outside of htobe64 macro, because the argument can
776 * be used more than once within the macro, and thus the
777 * operation may be undefined.
779 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
780 last_relay_viewer_session_id
++;
781 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
782 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
785 health_code_update();
787 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
792 health_code_update();
794 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
802 * Send the viewer the list of current sessions.
803 * We need to create a copy of the hash table content because otherwise
804 * we cannot assume the number of entries stays the same between getting
805 * the number of HT elements and iteration over the HT.
807 * Return 0 on success or else a negative value.
810 int viewer_list_sessions(struct relay_connection
*conn
)
813 struct lttng_viewer_list_sessions session_list
;
814 struct lttng_ht_iter iter
;
815 struct relay_session
*session
;
816 struct lttng_viewer_session
*send_session_buf
= NULL
;
817 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
820 DBG("List sessions received");
822 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
823 if (!send_session_buf
) {
828 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
830 struct lttng_viewer_session
*send_session
;
832 health_code_update();
834 pthread_mutex_lock(&session
->lock
);
835 if (session
->connection_closed
) {
836 /* Skip closed session */
839 if (!session
->current_trace_chunk
) {
841 * Skip un-attachable session. It is either
842 * being destroyed or has not had a trace
843 * chunk created against it yet.
848 if (count
>= buf_count
) {
849 struct lttng_viewer_session
*newbuf
;
850 uint32_t new_buf_count
= buf_count
<< 1;
852 newbuf
= realloc(send_session_buf
,
853 new_buf_count
* sizeof(*send_session_buf
));
858 send_session_buf
= newbuf
;
859 buf_count
= new_buf_count
;
861 send_session
= &send_session_buf
[count
];
862 if (lttng_strncpy(send_session
->session_name
,
863 session
->session_name
,
864 sizeof(send_session
->session_name
))) {
868 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
869 sizeof(send_session
->hostname
))) {
873 send_session
->id
= htobe64(session
->id
);
874 send_session
->live_timer
= htobe32(session
->live_timer
);
875 if (session
->viewer_attached
) {
876 send_session
->clients
= htobe32(1);
878 send_session
->clients
= htobe32(0);
880 send_session
->streams
= htobe32(session
->stream_count
);
883 pthread_mutex_unlock(&session
->lock
);
886 pthread_mutex_unlock(&session
->lock
);
894 session_list
.sessions_count
= htobe32(count
);
896 health_code_update();
898 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
903 health_code_update();
905 ret
= send_response(conn
->sock
, send_session_buf
,
906 count
* sizeof(*send_session_buf
));
910 health_code_update();
914 free(send_session_buf
);
919 * Send the viewer the list of current streams.
922 int viewer_get_new_streams(struct relay_connection
*conn
)
924 int ret
, send_streams
= 0;
925 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
926 struct lttng_viewer_new_streams_request request
;
927 struct lttng_viewer_new_streams_response response
;
928 struct relay_session
*session
= NULL
;
934 DBG("Get new streams received");
936 health_code_update();
938 /* Receive the request from the connected client. */
939 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
943 session_id
= be64toh(request
.session_id
);
945 health_code_update();
947 memset(&response
, 0, sizeof(response
));
949 session
= session_get_by_id(session_id
);
951 DBG("Relay session %" PRIu64
" not found", session_id
);
952 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
956 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
957 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
961 pthread_mutex_lock(&session
->lock
);
962 if (!session
->current_trace_chunk
) {
964 * Means the session is being destroyed. React the same way
965 * as if it could not be found at all.
967 DBG("Relay session %" PRIu64
" has no current trace chunk, replying LTTNG_VIEWER_NEW_STREAMS_ERR",
969 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
970 goto send_reply_unlock
;
973 if (!conn
->viewer_session
->current_trace_chunk
&&
974 session
->current_trace_chunk
) {
975 ret
= viewer_session_set_trace_chunk(conn
->viewer_session
,
976 session
->current_trace_chunk
);
978 goto error_unlock_session
;
981 ret
= make_viewer_streams(session
,
982 conn
->viewer_session
->current_trace_chunk
,
983 LTTNG_VIEWER_SEEK_LAST
, &nb_total
, &nb_unsent
,
984 &nb_created
, &closed
);
986 goto error_unlock_session
;
989 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
991 /* Only send back the newly created streams with the unsent ones. */
992 nb_streams
= nb_created
+ nb_unsent
;
993 response
.streams_count
= htobe32(nb_streams
);
996 * If the session is closed, HUP when there are no more streams
999 if (closed
&& nb_total
== 0) {
1001 response
.streams_count
= 0;
1002 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
1003 goto send_reply_unlock
;
1006 pthread_mutex_unlock(&session
->lock
);
1009 health_code_update();
1010 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1012 goto end_put_session
;
1014 health_code_update();
1017 * Unknown or empty session, just return gracefully, the viewer
1018 * knows what is happening.
1020 if (!send_streams
|| !nb_streams
) {
1022 goto end_put_session
;
1026 * Send stream and *DON'T* ignore the sent flag so every viewer
1027 * streams that were not sent from that point will be sent to
1030 ret
= send_viewer_streams(conn
->sock
, session_id
, 0);
1032 goto end_put_session
;
1037 session_put(session
);
1041 error_unlock_session
:
1042 pthread_mutex_unlock(&session
->lock
);
1043 session_put(session
);
1048 * Send the viewer the list of current sessions.
1051 int viewer_attach_session(struct relay_connection
*conn
)
1053 int send_streams
= 0;
1055 uint32_t nb_streams
= 0;
1056 enum lttng_viewer_seek seek_type
;
1057 struct lttng_viewer_attach_session_request request
;
1058 struct lttng_viewer_attach_session_response response
;
1059 struct relay_session
*session
= NULL
;
1060 bool closed
= false;
1061 uint64_t session_id
;
1065 health_code_update();
1067 /* Receive the request from the connected client. */
1068 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1073 session_id
= be64toh(request
.session_id
);
1074 health_code_update();
1076 memset(&response
, 0, sizeof(response
));
1078 if (!conn
->viewer_session
) {
1079 DBG("Client trying to attach before creating a live viewer session");
1080 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1084 session
= session_get_by_id(session_id
);
1086 DBG("Relay session %" PRIu64
" not found", session_id
);
1087 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1090 DBG("Attach session ID %" PRIu64
" received", session_id
);
1092 pthread_mutex_lock(&session
->lock
);
1093 if (!session
->current_trace_chunk
) {
1095 * Session is either being destroyed or it never had a trace
1096 * chunk created against it.
1098 DBG("Session requested by live client has no current trace chunk, returning unknown session");
1099 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1102 if (session
->live_timer
== 0) {
1103 DBG("Not live session");
1104 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1109 ret
= viewer_session_attach(conn
->viewer_session
, session
);
1111 DBG("Already a viewer attached");
1112 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_ALREADY
);
1116 switch (be32toh(request
.seek
)) {
1117 case LTTNG_VIEWER_SEEK_BEGINNING
:
1118 case LTTNG_VIEWER_SEEK_LAST
:
1119 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1120 seek_type
= be32toh(request
.seek
);
1123 ERR("Wrong seek parameter");
1124 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1129 if (!conn
->viewer_session
->current_trace_chunk
&&
1130 session
->current_trace_chunk
) {
1131 ret
= viewer_session_set_trace_chunk(conn
->viewer_session
,
1132 session
->current_trace_chunk
);
1134 goto end_put_session
;
1137 ret
= make_viewer_streams(session
,
1138 conn
->viewer_session
->current_trace_chunk
, seek_type
,
1139 &nb_streams
, NULL
, NULL
, &closed
);
1141 goto end_put_session
;
1143 pthread_mutex_unlock(&session
->lock
);
1144 session_put(session
);
1147 response
.streams_count
= htobe32(nb_streams
);
1149 * If the session is closed when the viewer is attaching, it
1150 * means some of the streams may have been concurrently removed,
1151 * so we don't allow the viewer to attach, even if there are
1152 * streams available.
1156 response
.streams_count
= 0;
1157 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1162 health_code_update();
1163 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1165 goto end_put_session
;
1167 health_code_update();
1170 * Unknown or empty session, just return gracefully, the viewer
1171 * knows what is happening.
1173 if (!send_streams
|| !nb_streams
) {
1175 goto end_put_session
;
1178 /* Send stream and ignore the sent flag. */
1179 ret
= send_viewer_streams(conn
->sock
, session_id
, 1);
1181 goto end_put_session
;
1186 pthread_mutex_unlock(&session
->lock
);
1187 session_put(session
);
1194 * Open the index file if needed for the given vstream.
1196 * If an index file is successfully opened, the vstream will set it as its
1197 * current index file.
1199 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1201 * Called with rstream lock held.
1203 static int try_open_index(struct relay_viewer_stream
*vstream
,
1204 struct relay_stream
*rstream
)
1207 const uint32_t connection_major
= rstream
->trace
->session
->major
;
1208 const uint32_t connection_minor
= rstream
->trace
->session
->minor
;
1210 if (vstream
->index_file
) {
1215 * First time, we open the index file and at least one index is ready.
1217 if (rstream
->index_received_seqcount
== 0) {
1221 vstream
->index_file
= lttng_index_file_create_from_trace_chunk_read_only(
1222 vstream
->stream_file
.trace_chunk
, rstream
->path_name
,
1223 rstream
->channel_name
, rstream
->tracefile_size
,
1224 vstream
->current_tracefile_id
,
1225 lttng_to_index_major(connection_major
, connection_minor
),
1226 lttng_to_index_minor(connection_major
, connection_minor
));
1227 if (!vstream
->index_file
) {
1236 * Check the status of the index for the given stream. This function
1237 * updates the index structure if needed and can put (close) the vstream
1238 * in the HUP situation.
1240 * Return 0 means that we can proceed with the index. A value of 1 means
1241 * that the index has been updated and is ready to be sent to the
1242 * client. A negative value indicates an error that can't be handled.
1244 * Called with rstream lock held.
1246 static int check_index_status(struct relay_viewer_stream
*vstream
,
1247 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1248 struct lttng_viewer_index
*index
)
1252 if ((trace
->session
->connection_closed
|| rstream
->closed
)
1253 && rstream
->index_received_seqcount
1254 == vstream
->index_sent_seqcount
) {
1256 * Last index sent and session connection or relay
1257 * stream are closed.
1259 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1261 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1262 rstream
->index_received_seqcount
1263 == vstream
->index_sent_seqcount
) {
1265 * We've received a synchronization beacon and the last index
1266 * available has been sent, the index for now is inactive.
1268 * In this case, we have received a beacon which allows us to
1269 * inform the client of a time interval during which we can
1270 * guarantee that there are no events to read (and never will
1273 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1274 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1275 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1277 } else if (rstream
->index_received_seqcount
1278 == vstream
->index_sent_seqcount
) {
1280 * This checks whether received == sent seqcount. In
1281 * this case, we have not received a beacon. Therefore,
1282 * we can only ask the client to retry later.
1284 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1286 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1287 vstream
->current_tracefile_id
,
1288 vstream
->index_sent_seqcount
)) {
1290 * The next index we want to send cannot be read either
1291 * because we need to perform a rotation, or due to
1292 * the producer having overwritten its trace file.
1294 DBG("Viewer stream %" PRIu64
" rotation",
1295 vstream
->stream
->stream_handle
);
1296 ret
= viewer_stream_rotate(vstream
);
1299 } else if (ret
== 1) {
1300 /* EOF across entire stream. */
1301 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1305 * If we have been pushed due to overwrite, it
1306 * necessarily means there is data that can be read in
1307 * the stream. If we rotated because we reached the end
1308 * of a tracefile, it means the following tracefile
1309 * needs to contain at least one index, else we would
1310 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1311 * viewer. The updated index_sent_seqcount needs to
1312 * point to a readable index entry now.
1314 * In the case where we "rotate" on a single file, we
1315 * can end up in a case where the requested index is
1316 * still unavailable.
1318 if (rstream
->tracefile_count
== 1 &&
1319 !tracefile_array_seq_in_file(
1321 vstream
->current_tracefile_id
,
1322 vstream
->index_sent_seqcount
)) {
1323 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1326 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1327 vstream
->current_tracefile_id
,
1328 vstream
->index_sent_seqcount
));
1330 /* ret == 0 means successful so we continue. */
1336 viewer_stream_put(vstream
);
1342 * Send the next index for a stream.
1344 * Return 0 on success or else a negative value.
1347 int viewer_get_next_index(struct relay_connection
*conn
)
1350 struct lttng_viewer_get_next_index request_index
;
1351 struct lttng_viewer_index viewer_index
;
1352 struct ctf_packet_index packet_index
;
1353 struct relay_viewer_stream
*vstream
= NULL
;
1354 struct relay_stream
*rstream
= NULL
;
1355 struct ctf_trace
*ctf_trace
= NULL
;
1356 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1360 DBG("Viewer get next index");
1362 memset(&viewer_index
, 0, sizeof(viewer_index
));
1363 health_code_update();
1365 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1369 health_code_update();
1371 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1373 DBG("Client requested index of unknown stream id %" PRIu64
,
1374 (uint64_t) be64toh(request_index
.stream_id
));
1375 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1379 /* Use back. ref. Protected by refcounts. */
1380 rstream
= vstream
->stream
;
1381 ctf_trace
= rstream
->trace
;
1383 /* metadata_viewer_stream may be NULL. */
1384 metadata_viewer_stream
=
1385 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1387 pthread_mutex_lock(&rstream
->lock
);
1390 * The viewer should not ask for index on metadata stream.
1392 if (rstream
->is_metadata
) {
1393 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1397 /* Try to open an index if one is needed for that stream. */
1398 ret
= try_open_index(vstream
, rstream
);
1400 if (ret
== -ENOENT
) {
1402 * The index is created only when the first data
1403 * packet arrives, it might not be ready at the
1404 * beginning of the session
1406 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1408 /* Unhandled error. */
1409 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1414 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1417 } else if (ret
== 1) {
1419 * We have no index to send and check_index_status has populated
1420 * viewer_index's status.
1424 /* At this point, ret is 0 thus we will be able to read the index. */
1428 * vstream->stream_fd may be NULL if it has been closed by
1429 * tracefile rotation, or if we are at the beginning of the
1430 * stream. We open the data stream file here to protect against
1431 * overwrite caused by tracefile rotation (in association with
1432 * unlink performed before overwrite).
1434 if (!vstream
->stream_file
.fd
) {
1436 char file_path
[LTTNG_PATH_MAX
];
1437 enum lttng_trace_chunk_status status
;
1439 ret
= utils_stream_file_path(rstream
->path_name
,
1440 rstream
->channel_name
, rstream
->tracefile_size
,
1441 vstream
->current_tracefile_id
, NULL
, file_path
,
1447 status
= lttng_trace_chunk_open_file(
1448 vstream
->stream_file
.trace_chunk
,
1449 file_path
, O_RDONLY
, 0, &fd
);
1450 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1451 PERROR("Failed to open trace file for viewer stream");
1454 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1455 if (!vstream
->stream_file
.fd
) {
1457 PERROR("Failed to close viewer stream file");
1463 ret
= check_new_streams(conn
);
1465 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1467 } else if (ret
== 1) {
1468 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1471 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1473 ERR("Relay error reading index file %d",
1474 vstream
->index_file
->fd
);
1475 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1478 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1479 vstream
->index_sent_seqcount
++;
1483 * Indexes are stored in big endian, no need to switch before sending.
1485 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1486 rstream
->stream_handle
,
1487 (uint64_t) be64toh(packet_index
.offset
));
1488 viewer_index
.offset
= packet_index
.offset
;
1489 viewer_index
.packet_size
= packet_index
.packet_size
;
1490 viewer_index
.content_size
= packet_index
.content_size
;
1491 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1492 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1493 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1494 viewer_index
.stream_id
= packet_index
.stream_id
;
1498 pthread_mutex_unlock(&rstream
->lock
);
1501 if (metadata_viewer_stream
) {
1502 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1503 DBG("get next index metadata check: recv %" PRIu64
1505 metadata_viewer_stream
->stream
->metadata_received
,
1506 metadata_viewer_stream
->metadata_sent
);
1507 if (!metadata_viewer_stream
->stream
->metadata_received
||
1508 metadata_viewer_stream
->stream
->metadata_received
>
1509 metadata_viewer_stream
->metadata_sent
) {
1510 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1512 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1515 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1516 health_code_update();
1518 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1522 health_code_update();
1525 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1526 vstream
->index_sent_seqcount
,
1527 vstream
->stream
->stream_handle
);
1530 if (metadata_viewer_stream
) {
1531 viewer_stream_put(metadata_viewer_stream
);
1534 viewer_stream_put(vstream
);
1539 pthread_mutex_unlock(&rstream
->lock
);
1540 if (metadata_viewer_stream
) {
1541 viewer_stream_put(metadata_viewer_stream
);
1543 viewer_stream_put(vstream
);
1548 * Send the next index for a stream
1550 * Return 0 on success or else a negative value.
1553 int viewer_get_packet(struct relay_connection
*conn
)
1558 struct lttng_viewer_get_packet get_packet_info
;
1559 struct lttng_viewer_trace_packet reply_header
;
1560 struct relay_viewer_stream
*vstream
= NULL
;
1561 uint32_t reply_size
= sizeof(reply_header
);
1562 uint32_t packet_data_len
= 0;
1565 DBG2("Relay get data packet");
1567 health_code_update();
1569 ret
= recv_request(conn
->sock
, &get_packet_info
,
1570 sizeof(get_packet_info
));
1574 health_code_update();
1576 /* From this point on, the error label can be reached. */
1577 memset(&reply_header
, 0, sizeof(reply_header
));
1579 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1581 DBG("Client requested packet of unknown stream id %" PRIu64
,
1582 (uint64_t) be64toh(get_packet_info
.stream_id
));
1583 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1584 goto send_reply_nolock
;
1586 packet_data_len
= be32toh(get_packet_info
.len
);
1587 reply_size
+= packet_data_len
;
1590 reply
= zmalloc(reply_size
);
1592 PERROR("packet reply zmalloc");
1593 reply_size
= sizeof(reply_header
);
1597 pthread_mutex_lock(&vstream
->stream
->lock
);
1598 lseek_ret
= lseek(vstream
->stream_file
.fd
->fd
,
1599 be64toh(get_packet_info
.offset
), SEEK_SET
);
1600 if (lseek_ret
< 0) {
1601 PERROR("lseek fd %d to offset %" PRIu64
,
1602 vstream
->stream_file
.fd
->fd
,
1603 (uint64_t) be64toh(get_packet_info
.offset
));
1606 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
,
1607 reply
+ sizeof(reply_header
), packet_data_len
);
1608 if (read_len
< packet_data_len
) {
1609 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1610 vstream
->stream_file
.fd
->fd
,
1611 (uint64_t) be64toh(get_packet_info
.offset
));
1614 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1615 reply_header
.len
= htobe32(packet_data_len
);
1619 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1623 pthread_mutex_unlock(&vstream
->stream
->lock
);
1627 health_code_update();
1630 memcpy(reply
, &reply_header
, sizeof(reply_header
));
1631 ret
= send_response(conn
->sock
, reply
, reply_size
);
1633 /* No reply to send. */
1634 ret
= send_response(conn
->sock
, &reply_header
,
1638 health_code_update();
1640 PERROR("sendmsg of packet data failed");
1644 DBG("Sent %u bytes for stream %" PRIu64
, reply_size
,
1645 (uint64_t) be64toh(get_packet_info
.stream_id
));
1651 viewer_stream_put(vstream
);
1657 * Send the session's metadata
1659 * Return 0 on success else a negative value.
1662 int viewer_get_metadata(struct relay_connection
*conn
)
1668 struct lttng_viewer_get_metadata request
;
1669 struct lttng_viewer_metadata_packet reply
;
1670 struct relay_viewer_stream
*vstream
= NULL
;
1674 DBG("Relay get metadata");
1676 health_code_update();
1678 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1682 health_code_update();
1684 memset(&reply
, 0, sizeof(reply
));
1686 vstream
= viewer_stream_get_by_id(be64toh(request
.stream_id
));
1689 * The metadata stream can be closed by a CLOSE command
1690 * just before we attach. It can also be closed by
1691 * per-pid tracing during tracing. Therefore, it is
1692 * possible that we cannot find this viewer stream.
1693 * Reply back to the client with an error if we cannot
1696 DBG("Client requested metadata of unknown stream id %" PRIu64
,
1697 (uint64_t) be64toh(request
.stream_id
));
1698 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1701 pthread_mutex_lock(&vstream
->stream
->lock
);
1702 if (!vstream
->stream
->is_metadata
) {
1703 ERR("Invalid metadata stream");
1707 assert(vstream
->metadata_sent
<= vstream
->stream
->metadata_received
);
1709 len
= vstream
->stream
->metadata_received
- vstream
->metadata_sent
;
1711 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1715 /* first time, we open the metadata file */
1716 if (!vstream
->stream_file
.fd
) {
1718 char file_path
[LTTNG_PATH_MAX
];
1719 enum lttng_trace_chunk_status status
;
1720 struct relay_stream
*rstream
= vstream
->stream
;
1722 ret
= utils_stream_file_path(rstream
->path_name
,
1723 rstream
->channel_name
, rstream
->tracefile_size
,
1724 vstream
->current_tracefile_id
, NULL
, file_path
,
1730 status
= lttng_trace_chunk_open_file(
1731 vstream
->stream_file
.trace_chunk
,
1732 file_path
, O_RDONLY
, 0, &fd
);
1733 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1734 PERROR("Failed to open metadata file for viewer stream");
1737 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1738 if (!vstream
->stream_file
.fd
) {
1740 PERROR("Failed to close viewer metadata file");
1746 reply
.len
= htobe64(len
);
1747 data
= zmalloc(len
);
1749 PERROR("viewer metadata zmalloc");
1753 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
, data
, len
);
1754 if (read_len
< len
) {
1755 PERROR("Relay reading metadata file");
1758 vstream
->metadata_sent
+= read_len
;
1759 if (vstream
->metadata_sent
== vstream
->stream
->metadata_received
1760 && vstream
->stream
->closed
) {
1761 /* Release ownership for the viewer metadata stream. */
1762 viewer_stream_put(vstream
);
1765 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1770 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1773 health_code_update();
1775 pthread_mutex_unlock(&vstream
->stream
->lock
);
1777 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1781 health_code_update();
1784 ret
= send_response(conn
->sock
, data
, len
);
1790 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1791 (uint64_t) be64toh(request
.stream_id
));
1793 DBG("Metadata sent");
1799 viewer_stream_put(vstream
);
1805 * Create a viewer session.
1807 * Return 0 on success or else a negative value.
1810 int viewer_create_session(struct relay_connection
*conn
)
1813 struct lttng_viewer_create_session_response resp
;
1815 DBG("Viewer create session received");
1817 memset(&resp
, 0, sizeof(resp
));
1818 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
1819 conn
->viewer_session
= viewer_session_create();
1820 if (!conn
->viewer_session
) {
1821 ERR("Allocation viewer session");
1822 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
1827 health_code_update();
1828 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
1832 health_code_update();
1840 * Detach a viewer session.
1842 * Return 0 on success or else a negative value.
1845 int viewer_detach_session(struct relay_connection
*conn
)
1848 struct lttng_viewer_detach_session_response response
;
1849 struct lttng_viewer_detach_session_request request
;
1850 struct relay_session
*session
= NULL
;
1851 uint64_t viewer_session_to_close
;
1853 DBG("Viewer detach session received");
1857 health_code_update();
1859 /* Receive the request from the connected client. */
1860 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1864 viewer_session_to_close
= be64toh(request
.session_id
);
1866 if (!conn
->viewer_session
) {
1867 DBG("Client trying to detach before creating a live viewer session");
1868 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1872 health_code_update();
1874 memset(&response
, 0, sizeof(response
));
1875 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
1877 session
= session_get_by_id(be64toh(request
.session_id
));
1879 DBG("Relay session %" PRIu64
" not found",
1880 (uint64_t) be64toh(request
.session_id
));
1881 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
1885 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
1887 DBG("Not attached to this session");
1888 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1889 goto send_reply_put
;
1892 viewer_session_close_one_session(conn
->viewer_session
, session
);
1893 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
1894 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
1897 session_put(session
);
1900 health_code_update();
1901 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1905 health_code_update();
1913 * live_relay_unknown_command: send -1 if received unknown command
1916 void live_relay_unknown_command(struct relay_connection
*conn
)
1918 struct lttcomm_relayd_generic_reply reply
;
1920 memset(&reply
, 0, sizeof(reply
));
1921 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1922 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
1926 * Process the commands received on the control socket
1929 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1930 struct relay_connection
*conn
)
1935 msg_value
= be32toh(recv_hdr
->cmd
);
1938 * Make sure we've done the version check before any command other then a
1939 * new client connection.
1941 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
1942 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
1947 switch (msg_value
) {
1948 case LTTNG_VIEWER_CONNECT
:
1949 ret
= viewer_connect(conn
);
1951 case LTTNG_VIEWER_LIST_SESSIONS
:
1952 ret
= viewer_list_sessions(conn
);
1954 case LTTNG_VIEWER_ATTACH_SESSION
:
1955 ret
= viewer_attach_session(conn
);
1957 case LTTNG_VIEWER_GET_NEXT_INDEX
:
1958 ret
= viewer_get_next_index(conn
);
1960 case LTTNG_VIEWER_GET_PACKET
:
1961 ret
= viewer_get_packet(conn
);
1963 case LTTNG_VIEWER_GET_METADATA
:
1964 ret
= viewer_get_metadata(conn
);
1966 case LTTNG_VIEWER_GET_NEW_STREAMS
:
1967 ret
= viewer_get_new_streams(conn
);
1969 case LTTNG_VIEWER_CREATE_SESSION
:
1970 ret
= viewer_create_session(conn
);
1972 case LTTNG_VIEWER_DETACH_SESSION
:
1973 ret
= viewer_detach_session(conn
);
1976 ERR("Received unknown viewer command (%u)",
1977 be32toh(recv_hdr
->cmd
));
1978 live_relay_unknown_command(conn
);
1988 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
1992 (void) lttng_poll_del(events
, pollfd
);
1994 ret
= close(pollfd
);
1996 ERR("Closing pollfd %d", pollfd
);
2001 * This thread does the actual work
2004 void *thread_worker(void *data
)
2008 struct lttng_poll_event events
;
2009 struct lttng_ht
*viewer_connections_ht
;
2010 struct lttng_ht_iter iter
;
2011 struct lttng_viewer_cmd recv_hdr
;
2012 struct relay_connection
*destroy_conn
;
2014 DBG("[thread] Live viewer relay worker started");
2016 rcu_register_thread();
2018 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
2020 if (testpoint(relayd_thread_live_worker
)) {
2021 goto error_testpoint
;
2024 /* table of connections indexed on socket */
2025 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2026 if (!viewer_connections_ht
) {
2027 goto viewer_connections_ht_error
;
2030 ret
= create_thread_poll_set(&events
, 2);
2032 goto error_poll_create
;
2035 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2044 health_code_update();
2046 /* Infinite blocking call, waiting for transmission */
2047 DBG3("Relayd live viewer worker thread polling...");
2048 health_poll_entry();
2049 ret
= lttng_poll_wait(&events
, -1);
2053 * Restart interrupted system call.
2055 if (errno
== EINTR
) {
2064 * Process control. The control connection is prioritised so we don't
2065 * starve it with high throughput tracing data on the data
2068 for (i
= 0; i
< nb_fd
; i
++) {
2069 /* Fetch once the poll data */
2070 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2071 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2073 health_code_update();
2075 /* Thread quit pipe has been closed. Killing thread. */
2076 ret
= check_thread_quit_pipe(pollfd
, revents
);
2082 /* Inspect the relay conn pipe for new connection. */
2083 if (pollfd
== live_conn_pipe
[0]) {
2084 if (revents
& LPOLLIN
) {
2085 struct relay_connection
*conn
;
2087 ret
= lttng_read(live_conn_pipe
[0],
2088 &conn
, sizeof(conn
));
2092 ret
= lttng_poll_add(&events
,
2094 LPOLLIN
| LPOLLRDHUP
);
2096 ERR("Failed to add new live connection file descriptor to poll set");
2099 connection_ht_add(viewer_connections_ht
, conn
);
2100 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2101 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2102 ERR("Relay live pipe error");
2105 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2109 /* Connection activity. */
2110 struct relay_connection
*conn
;
2112 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2117 if (revents
& LPOLLIN
) {
2118 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2119 sizeof(recv_hdr
), 0);
2121 /* Connection closed. */
2122 cleanup_connection_pollfd(&events
, pollfd
);
2123 /* Put "create" ownership reference. */
2124 connection_put(conn
);
2125 DBG("Viewer control conn closed with %d", pollfd
);
2127 ret
= process_control(&recv_hdr
, conn
);
2129 /* Clear the session on error. */
2130 cleanup_connection_pollfd(&events
, pollfd
);
2131 /* Put "create" ownership reference. */
2132 connection_put(conn
);
2133 DBG("Viewer connection closed with %d", pollfd
);
2136 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2137 cleanup_connection_pollfd(&events
, pollfd
);
2138 /* Put "create" ownership reference. */
2139 connection_put(conn
);
2141 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2142 connection_put(conn
);
2145 /* Put local "get_by_sock" reference. */
2146 connection_put(conn
);
2153 lttng_poll_clean(&events
);
2155 /* Cleanup remaining connection object. */
2157 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2160 health_code_update();
2161 connection_put(destroy_conn
);
2165 lttng_ht_destroy(viewer_connections_ht
);
2166 viewer_connections_ht_error
:
2167 /* Close relay conn pipes */
2168 utils_close_pipe(live_conn_pipe
);
2170 DBG("Viewer worker thread exited with error");
2172 DBG("Viewer worker thread cleanup complete");
2176 ERR("Health error occurred in %s", __func__
);
2178 health_unregister(health_relayd
);
2179 if (lttng_relay_stop_threads()) {
2180 ERR("Error stopping threads");
2182 rcu_unregister_thread();
2187 * Create the relay command pipe to wake thread_manage_apps.
2188 * Closed in cleanup().
2190 static int create_conn_pipe(void)
2192 return utils_create_pipe_cloexec(live_conn_pipe
);
2195 int relayd_live_join(void)
2197 int ret
, retval
= 0;
2200 ret
= pthread_join(live_listener_thread
, &status
);
2203 PERROR("pthread_join live listener");
2207 ret
= pthread_join(live_worker_thread
, &status
);
2210 PERROR("pthread_join live worker");
2214 ret
= pthread_join(live_dispatcher_thread
, &status
);
2217 PERROR("pthread_join live dispatcher");
2221 cleanup_relayd_live();
2229 int relayd_live_create(struct lttng_uri
*uri
)
2231 int ret
= 0, retval
= 0;
2237 goto exit_init_data
;
2241 /* Check if daemon is UID = 0 */
2242 is_root
= !getuid();
2245 if (live_uri
->port
< 1024) {
2246 ERR("Need to be root to use ports < 1024");
2248 goto exit_init_data
;
2252 /* Setup the thread apps communication pipe. */
2253 if (create_conn_pipe()) {
2255 goto exit_init_data
;
2258 /* Init relay command queue. */
2259 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2261 /* Set up max poll set size */
2262 if (lttng_poll_set_max_size()) {
2264 goto exit_init_data
;
2267 /* Setup the dispatcher thread */
2268 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2269 thread_dispatcher
, (void *) NULL
);
2272 PERROR("pthread_create viewer dispatcher");
2274 goto exit_dispatcher_thread
;
2277 /* Setup the worker thread */
2278 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2279 thread_worker
, NULL
);
2282 PERROR("pthread_create viewer worker");
2284 goto exit_worker_thread
;
2287 /* Setup the listener thread */
2288 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2289 thread_listener
, (void *) NULL
);
2292 PERROR("pthread_create viewer listener");
2294 goto exit_listener_thread
;
2298 * All OK, started all threads.
2303 * Join on the live_listener_thread should anything be added after
2304 * the live_listener thread's creation.
2307 exit_listener_thread
:
2309 ret
= pthread_join(live_worker_thread
, &status
);
2312 PERROR("pthread_join live worker");
2317 ret
= pthread_join(live_dispatcher_thread
, &status
);
2320 PERROR("pthread_join live dispatcher");
2323 exit_dispatcher_thread
:
2326 cleanup_relayd_live();