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_ht_iter iter
;
204 struct relay_viewer_stream
*vstream
;
208 cds_lfht_for_each_entry(viewer_streams_ht
->ht
, &iter
.iter
, vstream
,
210 struct ctf_trace
*ctf_trace
;
211 struct lttng_viewer_stream send_stream
= {};
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 bool trace_has_metadata_stream
= false;
313 struct relay_stream
*stream
;
315 health_code_update();
317 if (!ctf_trace_get(ctf_trace
)) {
322 * Iterate over all the streams of the trace to see if we have a
325 cds_list_for_each_entry_rcu(
326 stream
, &ctf_trace
->stream_list
, stream_node
)
328 if (stream
->is_metadata
) {
329 trace_has_metadata_stream
= true;
335 * If there is no metadata stream in this trace at the moment
336 * and we never sent one to the viewer, skip the trace. We
337 * accept that the viewer will not see this trace at all.
339 if (!trace_has_metadata_stream
&&
340 !ctf_trace
->metadata_stream_sent_to_viewer
) {
341 ctf_trace_put(ctf_trace
);
345 cds_list_for_each_entry_rcu(stream
, &ctf_trace
->stream_list
, stream_node
) {
346 struct relay_viewer_stream
*vstream
;
348 if (!stream_get(stream
)) {
352 * stream published is protected by the session lock.
354 if (!stream
->published
) {
357 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
360 * Save that we sent the metadata stream to the
361 * viewer. So that we know what trace the viewer
364 if (stream
->is_metadata
) {
365 ctf_trace
->metadata_stream_sent_to_viewer
=
368 vstream
= viewer_stream_create(stream
,
369 viewer_trace_chunk
, seek_t
);
372 ctf_trace_put(ctf_trace
);
378 /* Update number of created stream counter. */
382 * Ensure a self-reference is preserved even
383 * after we have put our local reference.
385 if (!viewer_stream_get(vstream
)) {
386 ERR("Unable to get self-reference on viewer stream, logic error.");
390 if (!vstream
->sent_flag
&& nb_unsent
) {
391 /* Update number of unsent stream counter. */
395 /* Update number of total stream counter. */
397 if (stream
->is_metadata
) {
398 if (!stream
->closed
||
399 stream
->metadata_received
> vstream
->metadata_sent
) {
403 if (!stream
->closed
||
404 !(((int64_t) (stream
->prev_data_seq
- stream
->last_net_seq_num
)) >= 0)) {
410 /* Put local reference. */
411 viewer_stream_put(vstream
);
415 ctf_trace_put(ctf_trace
);
426 int relayd_live_stop(void)
428 /* Stop dispatch thread */
429 CMM_STORE_SHARED(live_dispatch_thread_exit
, 1);
430 futex_nto1_wake(&viewer_conn_queue
.futex
);
435 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
438 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
442 if (events
== NULL
|| size
== 0) {
447 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
453 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
465 * Check if the thread quit pipe was triggered.
467 * Return 1 if it was triggered else 0;
470 int check_thread_quit_pipe(int fd
, uint32_t events
)
472 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
480 * Create and init socket from uri.
483 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
)
486 struct lttcomm_sock
*sock
= NULL
;
488 sock
= lttcomm_alloc_sock_from_uri(uri
);
490 ERR("Allocating socket");
494 ret
= lttcomm_create_sock(sock
);
498 DBG("Listening on sock %d for lttng-live", sock
->fd
);
500 ret
= sock
->ops
->bind(sock
);
502 PERROR("Failed to bind lttng-live socket");
506 ret
= sock
->ops
->listen(sock
, -1);
516 lttcomm_destroy_sock(sock
);
522 * This thread manages the listening for new connections on the network
525 void *thread_listener(void *data
)
527 int i
, ret
, pollfd
, err
= -1;
528 uint32_t revents
, nb_fd
;
529 struct lttng_poll_event events
;
530 struct lttcomm_sock
*live_control_sock
;
532 DBG("[thread] Relay live listener started");
534 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
536 health_code_update();
538 live_control_sock
= init_socket(live_uri
);
539 if (!live_control_sock
) {
540 goto error_sock_control
;
543 /* Pass 2 as size here for the thread quit pipe and control sockets. */
544 ret
= create_thread_poll_set(&events
, 2);
546 goto error_create_poll
;
549 /* Add the control socket */
550 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
555 lttng_relay_notify_ready();
557 if (testpoint(relayd_thread_live_listener
)) {
558 goto error_testpoint
;
562 health_code_update();
564 DBG("Listener accepting live viewers connections");
568 ret
= lttng_poll_wait(&events
, -1);
572 * Restart interrupted system call.
574 if (errno
== EINTR
) {
581 DBG("Relay new viewer connection received");
582 for (i
= 0; i
< nb_fd
; i
++) {
583 health_code_update();
585 /* Fetch once the poll data */
586 revents
= LTTNG_POLL_GETEV(&events
, i
);
587 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
589 /* Thread quit pipe has been closed. Killing thread. */
590 ret
= check_thread_quit_pipe(pollfd
, revents
);
596 if (revents
& LPOLLIN
) {
598 * A new connection is requested, therefore a
599 * viewer connection is allocated in this
600 * thread, enqueued to a global queue and
601 * dequeued (and freed) in the worker thread.
604 struct relay_connection
*new_conn
;
605 struct lttcomm_sock
*newsock
;
607 newsock
= live_control_sock
->ops
->accept(live_control_sock
);
609 PERROR("accepting control sock");
612 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
614 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
617 PERROR("setsockopt inet");
618 lttcomm_destroy_sock(newsock
);
621 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
623 lttcomm_destroy_sock(newsock
);
626 /* Ownership assumed by the connection. */
629 /* Enqueue request for the dispatcher thread. */
630 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
634 * Wake the dispatch queue futex.
635 * Implicit memory barrier with the
636 * exchange in cds_wfcq_enqueue.
638 futex_nto1_wake(&viewer_conn_queue
.futex
);
639 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
640 ERR("socket poll error");
643 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
653 lttng_poll_clean(&events
);
655 if (live_control_sock
->fd
>= 0) {
656 ret
= live_control_sock
->ops
->close(live_control_sock
);
661 lttcomm_destroy_sock(live_control_sock
);
665 DBG("Live viewer listener thread exited with error");
667 health_unregister(health_relayd
);
668 DBG("Live viewer listener thread cleanup complete");
669 if (lttng_relay_stop_threads()) {
670 ERR("Error stopping threads");
676 * This thread manages the dispatching of the requests to worker threads
679 void *thread_dispatcher(void *data
)
683 struct cds_wfcq_node
*node
;
684 struct relay_connection
*conn
= NULL
;
686 DBG("[thread] Live viewer relay dispatcher started");
688 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
690 if (testpoint(relayd_thread_live_dispatcher
)) {
691 goto error_testpoint
;
694 health_code_update();
697 health_code_update();
699 /* Atomically prepare the queue futex */
700 futex_nto1_prepare(&viewer_conn_queue
.futex
);
702 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
707 health_code_update();
709 /* Dequeue commands */
710 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
711 &viewer_conn_queue
.tail
);
713 DBG("Woken up but nothing in the live-viewer "
714 "relay command queue");
715 /* Continue thread execution */
718 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
719 DBG("Dispatching viewer request waiting on sock %d",
723 * Inform worker thread of the new request. This
724 * call is blocking so we can be assured that
725 * the data will be read at some point in time
726 * or wait to the end of the world :)
728 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
730 PERROR("write conn pipe");
731 connection_put(conn
);
734 } while (node
!= NULL
);
736 /* Futex wait on queue. Blocking call on futex() */
738 futex_nto1_wait(&viewer_conn_queue
.futex
);
742 /* Normal exit, no error */
749 ERR("Health error occurred in %s", __func__
);
751 health_unregister(health_relayd
);
752 DBG("Live viewer dispatch thread dying");
753 if (lttng_relay_stop_threads()) {
754 ERR("Error stopping threads");
760 * Establish connection with the viewer and check the versions.
762 * Return 0 on success or else negative value.
765 int viewer_connect(struct relay_connection
*conn
)
768 struct lttng_viewer_connect reply
, msg
;
770 conn
->version_check_done
= 1;
772 health_code_update();
774 DBG("Viewer is establishing a connection to the relayd.");
776 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
781 health_code_update();
783 memset(&reply
, 0, sizeof(reply
));
784 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
785 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
787 /* Major versions must be the same */
788 if (reply
.major
!= be32toh(msg
.major
)) {
789 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
790 reply
.major
, be32toh(msg
.major
));
795 conn
->major
= reply
.major
;
796 /* We adapt to the lowest compatible version */
797 if (reply
.minor
<= be32toh(msg
.minor
)) {
798 conn
->minor
= reply
.minor
;
800 conn
->minor
= be32toh(msg
.minor
);
803 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
804 conn
->type
= RELAY_VIEWER_COMMAND
;
805 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
806 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
808 ERR("Unknown connection type : %u", be32toh(msg
.type
));
813 reply
.major
= htobe32(reply
.major
);
814 reply
.minor
= htobe32(reply
.minor
);
815 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
817 * Increment outside of htobe64 macro, because the argument can
818 * be used more than once within the macro, and thus the
819 * operation may be undefined.
821 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
822 last_relay_viewer_session_id
++;
823 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
824 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
827 health_code_update();
829 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
834 health_code_update();
836 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
844 * Send the viewer the list of current sessions.
845 * We need to create a copy of the hash table content because otherwise
846 * we cannot assume the number of entries stays the same between getting
847 * the number of HT elements and iteration over the HT.
849 * Return 0 on success or else a negative value.
852 int viewer_list_sessions(struct relay_connection
*conn
)
855 struct lttng_viewer_list_sessions session_list
;
856 struct lttng_ht_iter iter
;
857 struct relay_session
*session
;
858 struct lttng_viewer_session
*send_session_buf
= NULL
;
859 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
862 DBG("List sessions received");
864 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
865 if (!send_session_buf
) {
870 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
872 struct lttng_viewer_session
*send_session
;
874 health_code_update();
876 pthread_mutex_lock(&session
->lock
);
877 if (session
->connection_closed
) {
878 /* Skip closed session */
881 if (!session
->current_trace_chunk
) {
883 * Skip un-attachable session. It is either
884 * being destroyed or has not had a trace
885 * chunk created against it yet.
890 if (count
>= buf_count
) {
891 struct lttng_viewer_session
*newbuf
;
892 uint32_t new_buf_count
= buf_count
<< 1;
894 newbuf
= realloc(send_session_buf
,
895 new_buf_count
* sizeof(*send_session_buf
));
900 send_session_buf
= newbuf
;
901 buf_count
= new_buf_count
;
903 send_session
= &send_session_buf
[count
];
904 if (lttng_strncpy(send_session
->session_name
,
905 session
->session_name
,
906 sizeof(send_session
->session_name
))) {
910 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
911 sizeof(send_session
->hostname
))) {
915 send_session
->id
= htobe64(session
->id
);
916 send_session
->live_timer
= htobe32(session
->live_timer
);
917 if (session
->viewer_attached
) {
918 send_session
->clients
= htobe32(1);
920 send_session
->clients
= htobe32(0);
922 send_session
->streams
= htobe32(session
->stream_count
);
925 pthread_mutex_unlock(&session
->lock
);
928 pthread_mutex_unlock(&session
->lock
);
936 session_list
.sessions_count
= htobe32(count
);
938 health_code_update();
940 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
945 health_code_update();
947 ret
= send_response(conn
->sock
, send_session_buf
,
948 count
* sizeof(*send_session_buf
));
952 health_code_update();
956 free(send_session_buf
);
961 * Send the viewer the list of current streams.
964 int viewer_get_new_streams(struct relay_connection
*conn
)
966 int ret
, send_streams
= 0;
967 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
968 struct lttng_viewer_new_streams_request request
;
969 struct lttng_viewer_new_streams_response response
;
970 struct relay_session
*session
= NULL
;
976 DBG("Get new streams received");
978 health_code_update();
980 /* Receive the request from the connected client. */
981 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
985 session_id
= be64toh(request
.session_id
);
987 health_code_update();
989 memset(&response
, 0, sizeof(response
));
991 session
= session_get_by_id(session_id
);
993 DBG("Relay session %" PRIu64
" not found", session_id
);
994 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
998 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
999 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
1004 * For any new stream, create it with LTTNG_VIEWER_SEEK_BEGINNING since
1005 * that at this point the client is already attached to the session.Aany
1006 * initial stream will have been created with the seek type at attach
1007 * time (for now most readers use the LTTNG_VIEWER_SEEK_LAST on attach).
1008 * Otherwise any event happening in a new stream between the attach and
1009 * a call to viewer_get_new_streams will be "lost" (never received) from
1010 * the viewer's point of view.
1012 pthread_mutex_lock(&session
->lock
);
1013 ret
= make_viewer_streams(session
,
1014 conn
->viewer_session
->current_trace_chunk
,
1015 LTTNG_VIEWER_SEEK_BEGINNING
, &nb_total
, &nb_unsent
,
1016 &nb_created
, &closed
);
1018 goto error_unlock_session
;
1021 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
1023 /* Only send back the newly created streams with the unsent ones. */
1024 nb_streams
= nb_created
+ nb_unsent
;
1025 response
.streams_count
= htobe32(nb_streams
);
1028 * If the session is closed, HUP when there are no more streams
1031 if (closed
&& nb_total
== 0) {
1033 response
.streams_count
= 0;
1034 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
1035 goto send_reply_unlock
;
1038 pthread_mutex_unlock(&session
->lock
);
1041 health_code_update();
1042 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1044 goto end_put_session
;
1046 health_code_update();
1049 * Unknown or empty session, just return gracefully, the viewer
1050 * knows what is happening.
1052 if (!send_streams
|| !nb_streams
) {
1054 goto end_put_session
;
1058 * Send stream and *DON'T* ignore the sent flag so every viewer
1059 * streams that were not sent from that point will be sent to
1062 ret
= send_viewer_streams(conn
->sock
, session_id
, 0);
1064 goto end_put_session
;
1069 session_put(session
);
1073 error_unlock_session
:
1074 pthread_mutex_unlock(&session
->lock
);
1075 session_put(session
);
1080 * Send the viewer the list of current sessions.
1083 int viewer_attach_session(struct relay_connection
*conn
)
1085 int send_streams
= 0;
1087 uint32_t nb_streams
= 0;
1088 enum lttng_viewer_seek seek_type
;
1089 struct lttng_viewer_attach_session_request request
;
1090 struct lttng_viewer_attach_session_response response
;
1091 struct relay_session
*session
= NULL
;
1092 enum lttng_viewer_attach_return_code viewer_attach_status
;
1093 bool closed
= false;
1094 uint64_t session_id
;
1098 health_code_update();
1100 /* Receive the request from the connected client. */
1101 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1106 session_id
= be64toh(request
.session_id
);
1107 health_code_update();
1109 memset(&response
, 0, sizeof(response
));
1111 if (!conn
->viewer_session
) {
1112 DBG("Client trying to attach before creating a live viewer session");
1113 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1117 session
= session_get_by_id(session_id
);
1119 DBG("Relay session %" PRIu64
" not found", session_id
);
1120 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1123 DBG("Attach session ID %" PRIu64
" received", session_id
);
1125 pthread_mutex_lock(&session
->lock
);
1126 if (!session
->current_trace_chunk
) {
1128 * Session is either being destroyed or it never had a trace
1129 * chunk created against it.
1131 DBG("Session requested by live client has no current trace chunk, returning unknown session");
1132 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1135 if (session
->live_timer
== 0) {
1136 DBG("Not live session");
1137 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1142 viewer_attach_status
= viewer_session_attach(conn
->viewer_session
,
1144 if (viewer_attach_status
!= LTTNG_VIEWER_ATTACH_OK
) {
1145 response
.status
= htobe32(viewer_attach_status
);
1149 switch (be32toh(request
.seek
)) {
1150 case LTTNG_VIEWER_SEEK_BEGINNING
:
1151 case LTTNG_VIEWER_SEEK_LAST
:
1152 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1153 seek_type
= be32toh(request
.seek
);
1156 ERR("Wrong seek parameter");
1157 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1162 ret
= make_viewer_streams(session
,
1163 conn
->viewer_session
->current_trace_chunk
, seek_type
,
1164 &nb_streams
, NULL
, NULL
, &closed
);
1166 goto end_put_session
;
1168 pthread_mutex_unlock(&session
->lock
);
1169 session_put(session
);
1172 response
.streams_count
= htobe32(nb_streams
);
1174 * If the session is closed when the viewer is attaching, it
1175 * means some of the streams may have been concurrently removed,
1176 * so we don't allow the viewer to attach, even if there are
1177 * streams available.
1181 response
.streams_count
= 0;
1182 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1187 health_code_update();
1188 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1190 goto end_put_session
;
1192 health_code_update();
1195 * Unknown or empty session, just return gracefully, the viewer
1196 * knows what is happening.
1198 if (!send_streams
|| !nb_streams
) {
1200 goto end_put_session
;
1203 /* Send stream and ignore the sent flag. */
1204 ret
= send_viewer_streams(conn
->sock
, session_id
, 1);
1206 goto end_put_session
;
1211 pthread_mutex_unlock(&session
->lock
);
1212 session_put(session
);
1219 * Open the index file if needed for the given vstream.
1221 * If an index file is successfully opened, the vstream will set it as its
1222 * current index file.
1224 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1226 * Called with rstream lock held.
1228 static int try_open_index(struct relay_viewer_stream
*vstream
,
1229 struct relay_stream
*rstream
)
1232 const uint32_t connection_major
= rstream
->trace
->session
->major
;
1233 const uint32_t connection_minor
= rstream
->trace
->session
->minor
;
1235 if (vstream
->index_file
) {
1240 * First time, we open the index file and at least one index is ready.
1242 if (rstream
->index_received_seqcount
== 0) {
1246 vstream
->index_file
= lttng_index_file_create_from_trace_chunk_read_only(
1247 vstream
->stream_file
.trace_chunk
, rstream
->path_name
,
1248 rstream
->channel_name
, rstream
->tracefile_size
,
1249 vstream
->current_tracefile_id
,
1250 lttng_to_index_major(connection_major
, connection_minor
),
1251 lttng_to_index_minor(connection_major
, connection_minor
));
1252 if (!vstream
->index_file
) {
1261 * Check the status of the index for the given stream. This function
1262 * updates the index structure if needed and can put (close) the vstream
1263 * in the HUP situation.
1265 * Return 0 means that we can proceed with the index. A value of 1 means
1266 * that the index has been updated and is ready to be sent to the
1267 * client. A negative value indicates an error that can't be handled.
1269 * Called with rstream lock held.
1271 static int check_index_status(struct relay_viewer_stream
*vstream
,
1272 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1273 struct lttng_viewer_index
*index
)
1277 if ((trace
->session
->connection_closed
|| rstream
->closed
)
1278 && rstream
->index_received_seqcount
1279 == vstream
->index_sent_seqcount
) {
1281 * Last index sent and session connection or relay
1282 * stream are closed.
1284 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1286 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1287 rstream
->index_received_seqcount
1288 == vstream
->index_sent_seqcount
) {
1290 * We've received a synchronization beacon and the last index
1291 * available has been sent, the index for now is inactive.
1293 * In this case, we have received a beacon which allows us to
1294 * inform the client of a time interval during which we can
1295 * guarantee that there are no events to read (and never will
1298 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1299 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1300 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1302 } else if (rstream
->index_received_seqcount
1303 == vstream
->index_sent_seqcount
) {
1305 * This checks whether received == sent seqcount. In
1306 * this case, we have not received a beacon. Therefore,
1307 * we can only ask the client to retry later.
1309 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1311 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1312 vstream
->current_tracefile_id
,
1313 vstream
->index_sent_seqcount
)) {
1315 * The next index we want to send cannot be read either
1316 * because we need to perform a rotation, or due to
1317 * the producer having overwritten its trace file.
1319 DBG("Viewer stream %" PRIu64
" rotation",
1320 vstream
->stream
->stream_handle
);
1321 ret
= viewer_stream_rotate(vstream
);
1324 } else if (ret
== 1) {
1325 /* EOF across entire stream. */
1326 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1330 * If we have been pushed due to overwrite, it
1331 * necessarily means there is data that can be read in
1332 * the stream. If we rotated because we reached the end
1333 * of a tracefile, it means the following tracefile
1334 * needs to contain at least one index, else we would
1335 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1336 * viewer. The updated index_sent_seqcount needs to
1337 * point to a readable index entry now.
1339 * In the case where we "rotate" on a single file, we
1340 * can end up in a case where the requested index is
1341 * still unavailable.
1343 if (rstream
->tracefile_count
== 1 &&
1344 !tracefile_array_seq_in_file(
1346 vstream
->current_tracefile_id
,
1347 vstream
->index_sent_seqcount
)) {
1348 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1351 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1352 vstream
->current_tracefile_id
,
1353 vstream
->index_sent_seqcount
));
1355 /* ret == 0 means successful so we continue. */
1361 viewer_stream_put(vstream
);
1367 * Send the next index for a stream.
1369 * Return 0 on success or else a negative value.
1372 int viewer_get_next_index(struct relay_connection
*conn
)
1375 struct lttng_viewer_get_next_index request_index
;
1376 struct lttng_viewer_index viewer_index
;
1377 struct ctf_packet_index packet_index
;
1378 struct relay_viewer_stream
*vstream
= NULL
;
1379 struct relay_stream
*rstream
= NULL
;
1380 struct ctf_trace
*ctf_trace
= NULL
;
1381 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1385 DBG("Viewer get next index");
1387 memset(&viewer_index
, 0, sizeof(viewer_index
));
1388 health_code_update();
1390 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1394 health_code_update();
1396 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1398 DBG("Client requested index of unknown stream id %" PRIu64
,
1399 (uint64_t) be64toh(request_index
.stream_id
));
1400 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1404 /* Use back. ref. Protected by refcounts. */
1405 rstream
= vstream
->stream
;
1406 ctf_trace
= rstream
->trace
;
1408 /* metadata_viewer_stream may be NULL. */
1409 metadata_viewer_stream
=
1410 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1412 pthread_mutex_lock(&rstream
->lock
);
1415 * The viewer should not ask for index on metadata stream.
1417 if (rstream
->is_metadata
) {
1418 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1422 /* Try to open an index if one is needed for that stream. */
1423 ret
= try_open_index(vstream
, rstream
);
1425 if (ret
== -ENOENT
) {
1427 * The index is created only when the first data
1428 * packet arrives, it might not be ready at the
1429 * beginning of the session
1431 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1433 /* Unhandled error. */
1434 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1439 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1442 } else if (ret
== 1) {
1444 * We have no index to send and check_index_status has populated
1445 * viewer_index's status.
1449 /* At this point, ret is 0 thus we will be able to read the index. */
1453 * vstream->stream_fd may be NULL if it has been closed by
1454 * tracefile rotation, or if we are at the beginning of the
1455 * stream. We open the data stream file here to protect against
1456 * overwrite caused by tracefile rotation (in association with
1457 * unlink performed before overwrite).
1459 if (!vstream
->stream_file
.fd
) {
1461 char file_path
[LTTNG_PATH_MAX
];
1462 enum lttng_trace_chunk_status status
;
1464 ret
= utils_stream_file_path(rstream
->path_name
,
1465 rstream
->channel_name
, rstream
->tracefile_size
,
1466 vstream
->current_tracefile_id
, NULL
, file_path
,
1472 status
= lttng_trace_chunk_open_file(
1473 vstream
->stream_file
.trace_chunk
,
1474 file_path
, O_RDONLY
, 0, &fd
);
1475 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1476 PERROR("Failed to open trace file for viewer stream");
1479 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1480 if (!vstream
->stream_file
.fd
) {
1482 PERROR("Failed to close viewer stream file");
1488 ret
= check_new_streams(conn
);
1490 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1492 } else if (ret
== 1) {
1493 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1496 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1498 ERR("Relay error reading index file %d",
1499 vstream
->index_file
->fd
);
1500 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1503 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1504 vstream
->index_sent_seqcount
++;
1508 * Indexes are stored in big endian, no need to switch before sending.
1510 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1511 rstream
->stream_handle
,
1512 (uint64_t) be64toh(packet_index
.offset
));
1513 viewer_index
.offset
= packet_index
.offset
;
1514 viewer_index
.packet_size
= packet_index
.packet_size
;
1515 viewer_index
.content_size
= packet_index
.content_size
;
1516 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1517 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1518 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1519 viewer_index
.stream_id
= packet_index
.stream_id
;
1523 pthread_mutex_unlock(&rstream
->lock
);
1526 if (metadata_viewer_stream
) {
1527 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1528 DBG("get next index metadata check: recv %" PRIu64
1530 metadata_viewer_stream
->stream
->metadata_received
,
1531 metadata_viewer_stream
->metadata_sent
);
1532 if (!metadata_viewer_stream
->stream
->metadata_received
||
1533 metadata_viewer_stream
->stream
->metadata_received
>
1534 metadata_viewer_stream
->metadata_sent
) {
1535 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1537 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1540 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1541 health_code_update();
1543 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1547 health_code_update();
1550 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1551 vstream
->index_sent_seqcount
,
1552 vstream
->stream
->stream_handle
);
1555 if (metadata_viewer_stream
) {
1556 viewer_stream_put(metadata_viewer_stream
);
1559 viewer_stream_put(vstream
);
1564 pthread_mutex_unlock(&rstream
->lock
);
1565 if (metadata_viewer_stream
) {
1566 viewer_stream_put(metadata_viewer_stream
);
1568 viewer_stream_put(vstream
);
1573 * Send the next index for a stream
1575 * Return 0 on success or else a negative value.
1578 int viewer_get_packet(struct relay_connection
*conn
)
1583 struct lttng_viewer_get_packet get_packet_info
;
1584 struct lttng_viewer_trace_packet reply_header
;
1585 struct relay_viewer_stream
*vstream
= NULL
;
1586 uint32_t reply_size
= sizeof(reply_header
);
1587 uint32_t packet_data_len
= 0;
1590 DBG2("Relay get data packet");
1592 health_code_update();
1594 ret
= recv_request(conn
->sock
, &get_packet_info
,
1595 sizeof(get_packet_info
));
1599 health_code_update();
1601 /* From this point on, the error label can be reached. */
1602 memset(&reply_header
, 0, sizeof(reply_header
));
1604 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1606 DBG("Client requested packet of unknown stream id %" PRIu64
,
1607 (uint64_t) be64toh(get_packet_info
.stream_id
));
1608 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1609 goto send_reply_nolock
;
1611 packet_data_len
= be32toh(get_packet_info
.len
);
1612 reply_size
+= packet_data_len
;
1615 reply
= zmalloc(reply_size
);
1617 PERROR("packet reply zmalloc");
1618 reply_size
= sizeof(reply_header
);
1622 pthread_mutex_lock(&vstream
->stream
->lock
);
1623 lseek_ret
= lseek(vstream
->stream_file
.fd
->fd
,
1624 be64toh(get_packet_info
.offset
), SEEK_SET
);
1625 if (lseek_ret
< 0) {
1626 PERROR("lseek fd %d to offset %" PRIu64
,
1627 vstream
->stream_file
.fd
->fd
,
1628 (uint64_t) be64toh(get_packet_info
.offset
));
1631 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
,
1632 reply
+ sizeof(reply_header
), packet_data_len
);
1633 if (read_len
< packet_data_len
) {
1634 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1635 vstream
->stream_file
.fd
->fd
,
1636 (uint64_t) be64toh(get_packet_info
.offset
));
1639 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1640 reply_header
.len
= htobe32(packet_data_len
);
1644 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1648 pthread_mutex_unlock(&vstream
->stream
->lock
);
1652 health_code_update();
1655 memcpy(reply
, &reply_header
, sizeof(reply_header
));
1656 ret
= send_response(conn
->sock
, reply
, reply_size
);
1658 /* No reply to send. */
1659 ret
= send_response(conn
->sock
, &reply_header
,
1663 health_code_update();
1665 PERROR("sendmsg of packet data failed");
1669 DBG("Sent %u bytes for stream %" PRIu64
, reply_size
,
1670 (uint64_t) be64toh(get_packet_info
.stream_id
));
1676 viewer_stream_put(vstream
);
1682 * Send the session's metadata
1684 * Return 0 on success else a negative value.
1687 int viewer_get_metadata(struct relay_connection
*conn
)
1693 struct lttng_viewer_get_metadata request
;
1694 struct lttng_viewer_metadata_packet reply
;
1695 struct relay_viewer_stream
*vstream
= NULL
;
1699 DBG("Relay get metadata");
1701 health_code_update();
1703 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1707 health_code_update();
1709 memset(&reply
, 0, sizeof(reply
));
1711 vstream
= viewer_stream_get_by_id(be64toh(request
.stream_id
));
1714 * The metadata stream can be closed by a CLOSE command
1715 * just before we attach. It can also be closed by
1716 * per-pid tracing during tracing. Therefore, it is
1717 * possible that we cannot find this viewer stream.
1718 * Reply back to the client with an error if we cannot
1721 DBG("Client requested metadata of unknown stream id %" PRIu64
,
1722 (uint64_t) be64toh(request
.stream_id
));
1723 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1726 pthread_mutex_lock(&vstream
->stream
->lock
);
1727 if (!vstream
->stream
->is_metadata
) {
1728 ERR("Invalid metadata stream");
1732 assert(vstream
->metadata_sent
<= vstream
->stream
->metadata_received
);
1734 len
= vstream
->stream
->metadata_received
- vstream
->metadata_sent
;
1737 * The live viewers expect to receive a NO_NEW_METADATA
1738 * status before a stream disappears, otherwise they abort the
1739 * entire live connection when receiving an error status.
1741 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1743 * The live viewer considers a closed 0 byte metadata stream as
1746 if (vstream
->metadata_sent
> 0) {
1747 vstream
->stream
->no_new_metadata_notified
= true;
1748 if (vstream
->stream
->closed
) {
1749 /* Release ownership for the viewer metadata stream. */
1750 viewer_stream_put(vstream
);
1756 /* first time, we open the metadata file */
1757 if (!vstream
->stream_file
.fd
) {
1759 char file_path
[LTTNG_PATH_MAX
];
1760 enum lttng_trace_chunk_status status
;
1761 struct relay_stream
*rstream
= vstream
->stream
;
1763 ret
= utils_stream_file_path(rstream
->path_name
,
1764 rstream
->channel_name
, rstream
->tracefile_size
,
1765 vstream
->current_tracefile_id
, NULL
, file_path
,
1771 status
= lttng_trace_chunk_open_file(
1772 vstream
->stream_file
.trace_chunk
,
1773 file_path
, O_RDONLY
, 0, &fd
);
1774 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1775 PERROR("Failed to open metadata file for viewer stream");
1778 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1779 if (!vstream
->stream_file
.fd
) {
1781 PERROR("Failed to close viewer metadata file");
1787 reply
.len
= htobe64(len
);
1788 data
= zmalloc(len
);
1790 PERROR("viewer metadata zmalloc");
1794 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
, data
, len
);
1795 if (read_len
< len
) {
1796 PERROR("Relay reading metadata file");
1799 vstream
->metadata_sent
+= read_len
;
1800 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1805 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1808 health_code_update();
1810 pthread_mutex_unlock(&vstream
->stream
->lock
);
1812 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1816 health_code_update();
1819 ret
= send_response(conn
->sock
, data
, len
);
1825 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1826 (uint64_t) be64toh(request
.stream_id
));
1828 DBG("Metadata sent");
1834 viewer_stream_put(vstream
);
1840 * Create a viewer session.
1842 * Return 0 on success or else a negative value.
1845 int viewer_create_session(struct relay_connection
*conn
)
1848 struct lttng_viewer_create_session_response resp
;
1850 DBG("Viewer create session received");
1852 memset(&resp
, 0, sizeof(resp
));
1853 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
1854 conn
->viewer_session
= viewer_session_create();
1855 if (!conn
->viewer_session
) {
1856 ERR("Allocation viewer session");
1857 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
1862 health_code_update();
1863 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
1867 health_code_update();
1875 * Detach a viewer session.
1877 * Return 0 on success or else a negative value.
1880 int viewer_detach_session(struct relay_connection
*conn
)
1883 struct lttng_viewer_detach_session_response response
;
1884 struct lttng_viewer_detach_session_request request
;
1885 struct relay_session
*session
= NULL
;
1886 uint64_t viewer_session_to_close
;
1888 DBG("Viewer detach session received");
1892 health_code_update();
1894 /* Receive the request from the connected client. */
1895 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1899 viewer_session_to_close
= be64toh(request
.session_id
);
1901 if (!conn
->viewer_session
) {
1902 DBG("Client trying to detach before creating a live viewer session");
1903 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1907 health_code_update();
1909 memset(&response
, 0, sizeof(response
));
1910 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
1912 session
= session_get_by_id(be64toh(request
.session_id
));
1914 DBG("Relay session %" PRIu64
" not found",
1915 (uint64_t) be64toh(request
.session_id
));
1916 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
1920 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
1922 DBG("Not attached to this session");
1923 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1924 goto send_reply_put
;
1927 viewer_session_close_one_session(conn
->viewer_session
, session
);
1928 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
1929 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
1932 session_put(session
);
1935 health_code_update();
1936 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1940 health_code_update();
1948 * live_relay_unknown_command: send -1 if received unknown command
1951 void live_relay_unknown_command(struct relay_connection
*conn
)
1953 struct lttcomm_relayd_generic_reply reply
;
1955 memset(&reply
, 0, sizeof(reply
));
1956 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1957 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
1961 * Process the commands received on the control socket
1964 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1965 struct relay_connection
*conn
)
1970 msg_value
= be32toh(recv_hdr
->cmd
);
1973 * Make sure we've done the version check before any command other then a
1974 * new client connection.
1976 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
1977 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
1982 switch (msg_value
) {
1983 case LTTNG_VIEWER_CONNECT
:
1984 ret
= viewer_connect(conn
);
1986 case LTTNG_VIEWER_LIST_SESSIONS
:
1987 ret
= viewer_list_sessions(conn
);
1989 case LTTNG_VIEWER_ATTACH_SESSION
:
1990 ret
= viewer_attach_session(conn
);
1992 case LTTNG_VIEWER_GET_NEXT_INDEX
:
1993 ret
= viewer_get_next_index(conn
);
1995 case LTTNG_VIEWER_GET_PACKET
:
1996 ret
= viewer_get_packet(conn
);
1998 case LTTNG_VIEWER_GET_METADATA
:
1999 ret
= viewer_get_metadata(conn
);
2001 case LTTNG_VIEWER_GET_NEW_STREAMS
:
2002 ret
= viewer_get_new_streams(conn
);
2004 case LTTNG_VIEWER_CREATE_SESSION
:
2005 ret
= viewer_create_session(conn
);
2007 case LTTNG_VIEWER_DETACH_SESSION
:
2008 ret
= viewer_detach_session(conn
);
2011 ERR("Received unknown viewer command (%u)",
2012 be32toh(recv_hdr
->cmd
));
2013 live_relay_unknown_command(conn
);
2023 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
2027 (void) lttng_poll_del(events
, pollfd
);
2029 ret
= close(pollfd
);
2031 ERR("Closing pollfd %d", pollfd
);
2036 * This thread does the actual work
2039 void *thread_worker(void *data
)
2043 struct lttng_poll_event events
;
2044 struct lttng_ht
*viewer_connections_ht
;
2045 struct lttng_ht_iter iter
;
2046 struct lttng_viewer_cmd recv_hdr
;
2047 struct relay_connection
*destroy_conn
;
2049 DBG("[thread] Live viewer relay worker started");
2051 rcu_register_thread();
2053 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
2055 if (testpoint(relayd_thread_live_worker
)) {
2056 goto error_testpoint
;
2059 /* table of connections indexed on socket */
2060 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2061 if (!viewer_connections_ht
) {
2062 goto viewer_connections_ht_error
;
2065 ret
= create_thread_poll_set(&events
, 2);
2067 goto error_poll_create
;
2070 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2079 health_code_update();
2081 /* Infinite blocking call, waiting for transmission */
2082 DBG3("Relayd live viewer worker thread polling...");
2083 health_poll_entry();
2084 ret
= lttng_poll_wait(&events
, -1);
2088 * Restart interrupted system call.
2090 if (errno
== EINTR
) {
2099 * Process control. The control connection is prioritised so we don't
2100 * starve it with high throughput tracing data on the data
2103 for (i
= 0; i
< nb_fd
; i
++) {
2104 /* Fetch once the poll data */
2105 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2106 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2108 health_code_update();
2110 /* Thread quit pipe has been closed. Killing thread. */
2111 ret
= check_thread_quit_pipe(pollfd
, revents
);
2117 /* Inspect the relay conn pipe for new connection. */
2118 if (pollfd
== live_conn_pipe
[0]) {
2119 if (revents
& LPOLLIN
) {
2120 struct relay_connection
*conn
;
2122 ret
= lttng_read(live_conn_pipe
[0],
2123 &conn
, sizeof(conn
));
2127 ret
= lttng_poll_add(&events
,
2129 LPOLLIN
| LPOLLRDHUP
);
2131 ERR("Failed to add new live connection file descriptor to poll set");
2134 connection_ht_add(viewer_connections_ht
, conn
);
2135 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2136 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2137 ERR("Relay live pipe error");
2140 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2144 /* Connection activity. */
2145 struct relay_connection
*conn
;
2147 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2152 if (revents
& LPOLLIN
) {
2153 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2154 sizeof(recv_hdr
), 0);
2156 /* Connection closed. */
2157 cleanup_connection_pollfd(&events
, pollfd
);
2158 /* Put "create" ownership reference. */
2159 connection_put(conn
);
2160 DBG("Viewer control conn closed with %d", pollfd
);
2162 ret
= process_control(&recv_hdr
, conn
);
2164 /* Clear the session on error. */
2165 cleanup_connection_pollfd(&events
, pollfd
);
2166 /* Put "create" ownership reference. */
2167 connection_put(conn
);
2168 DBG("Viewer connection closed with %d", pollfd
);
2171 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2172 cleanup_connection_pollfd(&events
, pollfd
);
2173 /* Put "create" ownership reference. */
2174 connection_put(conn
);
2176 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2177 connection_put(conn
);
2180 /* Put local "get_by_sock" reference. */
2181 connection_put(conn
);
2188 lttng_poll_clean(&events
);
2190 /* Cleanup remaining connection object. */
2192 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2195 health_code_update();
2196 connection_put(destroy_conn
);
2200 lttng_ht_destroy(viewer_connections_ht
);
2201 viewer_connections_ht_error
:
2202 /* Close relay conn pipes */
2203 utils_close_pipe(live_conn_pipe
);
2205 DBG("Viewer worker thread exited with error");
2207 DBG("Viewer worker thread cleanup complete");
2211 ERR("Health error occurred in %s", __func__
);
2213 health_unregister(health_relayd
);
2214 if (lttng_relay_stop_threads()) {
2215 ERR("Error stopping threads");
2217 rcu_unregister_thread();
2222 * Create the relay command pipe to wake thread_manage_apps.
2223 * Closed in cleanup().
2225 static int create_conn_pipe(void)
2227 return utils_create_pipe_cloexec(live_conn_pipe
);
2230 int relayd_live_join(void)
2232 int ret
, retval
= 0;
2235 ret
= pthread_join(live_listener_thread
, &status
);
2238 PERROR("pthread_join live listener");
2242 ret
= pthread_join(live_worker_thread
, &status
);
2245 PERROR("pthread_join live worker");
2249 ret
= pthread_join(live_dispatcher_thread
, &status
);
2252 PERROR("pthread_join live dispatcher");
2256 cleanup_relayd_live();
2264 int relayd_live_create(struct lttng_uri
*uri
)
2266 int ret
= 0, retval
= 0;
2272 goto exit_init_data
;
2276 /* Check if daemon is UID = 0 */
2277 is_root
= !getuid();
2280 if (live_uri
->port
< 1024) {
2281 ERR("Need to be root to use ports < 1024");
2283 goto exit_init_data
;
2287 /* Setup the thread apps communication pipe. */
2288 if (create_conn_pipe()) {
2290 goto exit_init_data
;
2293 /* Init relay command queue. */
2294 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2296 /* Set up max poll set size */
2297 if (lttng_poll_set_max_size()) {
2299 goto exit_init_data
;
2302 /* Setup the dispatcher thread */
2303 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2304 thread_dispatcher
, (void *) NULL
);
2307 PERROR("pthread_create viewer dispatcher");
2309 goto exit_dispatcher_thread
;
2312 /* Setup the worker thread */
2313 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2314 thread_worker
, NULL
);
2317 PERROR("pthread_create viewer worker");
2319 goto exit_worker_thread
;
2322 /* Setup the listener thread */
2323 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2324 thread_listener
, (void *) NULL
);
2327 PERROR("pthread_create viewer listener");
2329 goto exit_listener_thread
;
2333 * All OK, started all threads.
2338 * Join on the live_listener_thread should anything be added after
2339 * the live_listener thread's creation.
2342 exit_listener_thread
:
2344 ret
= pthread_join(live_worker_thread
, &status
);
2347 PERROR("pthread_join live worker");
2352 ret
= pthread_join(live_dispatcher_thread
, &status
);
2355 PERROR("pthread_join live dispatcher");
2358 exit_dispatcher_thread
:
2361 cleanup_relayd_live();