2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
4 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 #include <sys/mount.h>
31 #include <sys/resource.h>
32 #include <sys/socket.h>
34 #include <sys/types.h>
37 #include <urcu/futex.h>
38 #include <urcu/uatomic.h>
39 #include <urcu/rculist.h>
43 #include <lttng/lttng.h>
44 #include <common/common.h>
45 #include <common/compat/poll.h>
46 #include <common/compat/socket.h>
47 #include <common/compat/endian.h>
48 #include <common/defaults.h>
49 #include <common/futex.h>
50 #include <common/index/index.h>
51 #include <common/sessiond-comm/sessiond-comm.h>
52 #include <common/sessiond-comm/inet.h>
53 #include <common/sessiond-comm/relayd.h>
54 #include <common/uri.h>
55 #include <common/utils.h>
59 #include "lttng-relayd.h"
61 #include "health-relayd.h"
62 #include "testpoint.h"
63 #include "viewer-stream.h"
66 #include "ctf-trace.h"
67 #include "connection.h"
68 #include "viewer-session.h"
70 #define SESSION_BUF_DEFAULT_COUNT 16
72 static struct lttng_uri
*live_uri
;
75 * This pipe is used to inform the worker thread that a command is queued and
76 * ready to be processed.
78 static int live_conn_pipe
[2] = { -1, -1 };
80 /* Shared between threads */
81 static int live_dispatch_thread_exit
;
83 static pthread_t live_listener_thread
;
84 static pthread_t live_dispatcher_thread
;
85 static pthread_t live_worker_thread
;
88 * Relay command queue.
90 * The live_thread_listener and live_thread_dispatcher communicate with this
93 static struct relay_conn_queue viewer_conn_queue
;
95 static uint64_t last_relay_viewer_session_id
;
96 static pthread_mutex_t last_relay_viewer_session_id_lock
=
97 PTHREAD_MUTEX_INITIALIZER
;
103 void cleanup_relayd_live(void)
111 * Receive a request buffer using a given socket, destination allocated buffer
114 * Return the size of the received message or else a negative value on error
115 * with errno being set by recvmsg() syscall.
118 ssize_t
recv_request(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
122 ret
= sock
->ops
->recvmsg(sock
, buf
, size
, 0);
123 if (ret
< 0 || ret
!= size
) {
125 /* Orderly shutdown. Not necessary to print an error. */
126 DBG("Socket %d did an orderly shutdown", sock
->fd
);
128 ERR("Relay failed to receive request.");
137 * Send a response buffer using a given socket, source allocated buffer of
140 * Return the size of the sent message or else a negative value on error with
141 * errno being set by sendmsg() syscall.
144 ssize_t
send_response(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
148 ret
= sock
->ops
->sendmsg(sock
, buf
, size
, 0);
150 ERR("Relayd failed to send response.");
157 * Atomically check if new streams got added in one of the sessions attached
158 * and reset the flag to 0.
160 * Returns 1 if new streams got added, 0 if nothing changed, a negative value
164 int check_new_streams(struct relay_connection
*conn
)
166 struct relay_session
*session
;
167 unsigned long current_val
;
170 if (!conn
->viewer_session
) {
174 cds_list_for_each_entry_rcu(session
,
175 &conn
->viewer_session
->session_list
,
176 viewer_session_node
) {
177 if (!session_get(session
)) {
180 current_val
= uatomic_cmpxchg(&session
->new_streams
, 1, 0);
182 session_put(session
);
193 * Send viewer streams to the given socket. The ignore_sent_flag indicates if
194 * this function should ignore the sent flag or not.
196 * Return 0 on success or else a negative value.
199 ssize_t
send_viewer_streams(struct lttcomm_sock
*sock
,
200 uint64_t session_id
, unsigned int ignore_sent_flag
)
203 struct lttng_viewer_stream send_stream
;
204 struct lttng_ht_iter iter
;
205 struct relay_viewer_stream
*vstream
;
209 cds_lfht_for_each_entry(viewer_streams_ht
->ht
, &iter
.iter
, vstream
,
211 struct ctf_trace
*ctf_trace
;
213 health_code_update();
215 if (!viewer_stream_get(vstream
)) {
219 pthread_mutex_lock(&vstream
->stream
->lock
);
220 /* Ignore if not the same session. */
221 if (vstream
->stream
->trace
->session
->id
!= session_id
||
222 (!ignore_sent_flag
&& vstream
->sent_flag
)) {
223 pthread_mutex_unlock(&vstream
->stream
->lock
);
224 viewer_stream_put(vstream
);
228 ctf_trace
= vstream
->stream
->trace
;
229 send_stream
.id
= htobe64(vstream
->stream
->stream_handle
);
230 send_stream
.ctf_trace_id
= htobe64(ctf_trace
->id
);
231 send_stream
.metadata_flag
= htobe32(
232 vstream
->stream
->is_metadata
);
233 if (lttng_strncpy(send_stream
.path_name
, vstream
->path_name
,
234 sizeof(send_stream
.path_name
))) {
235 pthread_mutex_unlock(&vstream
->stream
->lock
);
236 viewer_stream_put(vstream
);
237 ret
= -1; /* Error. */
240 if (lttng_strncpy(send_stream
.channel_name
,
241 vstream
->channel_name
,
242 sizeof(send_stream
.channel_name
))) {
243 pthread_mutex_unlock(&vstream
->stream
->lock
);
244 viewer_stream_put(vstream
);
245 ret
= -1; /* Error. */
249 DBG("Sending stream %" PRIu64
" to viewer",
250 vstream
->stream
->stream_handle
);
251 vstream
->sent_flag
= 1;
252 pthread_mutex_unlock(&vstream
->stream
->lock
);
254 ret
= send_response(sock
, &send_stream
, sizeof(send_stream
));
255 viewer_stream_put(vstream
);
269 * Create every viewer stream possible for the given session with the seek
270 * type. Three counters *can* be return which are in order the total amount of
271 * viewer stream of the session, the number of unsent stream and the number of
272 * stream created. Those counters can be NULL and thus will be ignored.
274 * session must be locked to ensure that we see either none or all initial
275 * streams for a session, but no intermediate state..
277 * Return 0 on success or else a negative value.
279 static int make_viewer_streams(struct relay_session
*session
,
280 struct lttng_trace_chunk
*viewer_trace_chunk
,
281 enum lttng_viewer_seek seek_t
,
284 uint32_t *nb_created
,
288 struct lttng_ht_iter iter
;
289 struct ctf_trace
*ctf_trace
;
292 ASSERT_LOCKED(session
->lock
);
294 if (!viewer_trace_chunk
) {
295 ERR("Internal error: viewer session associated with session \"%s\" has a NULL trace chunk",
296 session
->session_name
);
301 if (session
->connection_closed
) {
306 * Create viewer streams for relay streams that are ready to be
307 * used for a the given session id only.
310 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
, &iter
.iter
, ctf_trace
,
312 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
) {
344 cds_list_for_each_entry_rcu(stream
, &ctf_trace
->stream_list
, stream_node
) {
345 struct relay_viewer_stream
*vstream
;
347 if (!stream_get(stream
)) {
351 * stream published is protected by the session lock.
353 if (!stream
->published
) {
356 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
359 * Save that we sent the metadata stream to the
360 * viewer. So that we know what trace the viewer
363 if (stream
->is_metadata
) {
364 ctf_trace
->metadata_stream_sent_to_viewer
=
367 vstream
= viewer_stream_create(stream
,
368 viewer_trace_chunk
, seek_t
);
371 ctf_trace_put(ctf_trace
);
377 /* Update number of created stream counter. */
381 * Ensure a self-reference is preserved even
382 * after we have put our local reference.
384 if (!viewer_stream_get(vstream
)) {
385 ERR("Unable to get self-reference on viewer stream, logic error.");
389 if (!vstream
->sent_flag
&& nb_unsent
) {
390 /* Update number of unsent stream counter. */
394 /* Update number of total stream counter. */
396 if (stream
->is_metadata
) {
397 if (!stream
->closed
||
398 stream
->metadata_received
> vstream
->metadata_sent
) {
402 if (!stream
->closed
||
403 !(((int64_t) (stream
->prev_data_seq
- stream
->last_net_seq_num
)) >= 0)) {
409 /* Put local reference. */
410 viewer_stream_put(vstream
);
414 ctf_trace_put(ctf_trace
);
425 int relayd_live_stop(void)
427 /* Stop dispatch thread */
428 CMM_STORE_SHARED(live_dispatch_thread_exit
, 1);
429 futex_nto1_wake(&viewer_conn_queue
.futex
);
434 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
437 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
441 if (events
== NULL
|| size
== 0) {
446 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
452 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
464 * Check if the thread quit pipe was triggered.
466 * Return 1 if it was triggered else 0;
469 int check_thread_quit_pipe(int fd
, uint32_t events
)
471 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
479 * Create and init socket from uri.
482 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
)
485 struct lttcomm_sock
*sock
= NULL
;
487 sock
= lttcomm_alloc_sock_from_uri(uri
);
489 ERR("Allocating socket");
493 ret
= lttcomm_create_sock(sock
);
497 DBG("Listening on sock %d for lttng-live", sock
->fd
);
499 ret
= sock
->ops
->bind(sock
);
501 PERROR("Failed to bind lttng-live socket");
505 ret
= sock
->ops
->listen(sock
, -1);
515 lttcomm_destroy_sock(sock
);
521 * This thread manages the listening for new connections on the network
524 void *thread_listener(void *data
)
526 int i
, ret
, pollfd
, err
= -1;
527 uint32_t revents
, nb_fd
;
528 struct lttng_poll_event events
;
529 struct lttcomm_sock
*live_control_sock
;
531 DBG("[thread] Relay live listener started");
533 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
535 health_code_update();
537 live_control_sock
= init_socket(live_uri
);
538 if (!live_control_sock
) {
539 goto error_sock_control
;
542 /* Pass 2 as size here for the thread quit pipe and control sockets. */
543 ret
= create_thread_poll_set(&events
, 2);
545 goto error_create_poll
;
548 /* Add the control socket */
549 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
554 lttng_relay_notify_ready();
556 if (testpoint(relayd_thread_live_listener
)) {
557 goto error_testpoint
;
561 health_code_update();
563 DBG("Listener accepting live viewers connections");
567 ret
= lttng_poll_wait(&events
, -1);
571 * Restart interrupted system call.
573 if (errno
== EINTR
) {
580 DBG("Relay new viewer connection received");
581 for (i
= 0; i
< nb_fd
; i
++) {
582 health_code_update();
584 /* Fetch once the poll data */
585 revents
= LTTNG_POLL_GETEV(&events
, i
);
586 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
588 /* Thread quit pipe has been closed. Killing thread. */
589 ret
= check_thread_quit_pipe(pollfd
, revents
);
595 if (revents
& LPOLLIN
) {
597 * A new connection is requested, therefore a
598 * viewer connection is allocated in this
599 * thread, enqueued to a global queue and
600 * dequeued (and freed) in the worker thread.
603 struct relay_connection
*new_conn
;
604 struct lttcomm_sock
*newsock
;
606 newsock
= live_control_sock
->ops
->accept(live_control_sock
);
608 PERROR("accepting control sock");
611 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
613 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
616 PERROR("setsockopt inet");
617 lttcomm_destroy_sock(newsock
);
620 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
622 lttcomm_destroy_sock(newsock
);
625 /* Ownership assumed by the connection. */
628 /* Enqueue request for the dispatcher thread. */
629 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
633 * Wake the dispatch queue futex.
634 * Implicit memory barrier with the
635 * exchange in cds_wfcq_enqueue.
637 futex_nto1_wake(&viewer_conn_queue
.futex
);
638 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
639 ERR("socket poll error");
642 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
652 lttng_poll_clean(&events
);
654 if (live_control_sock
->fd
>= 0) {
655 ret
= live_control_sock
->ops
->close(live_control_sock
);
660 lttcomm_destroy_sock(live_control_sock
);
664 DBG("Live viewer listener thread exited with error");
666 health_unregister(health_relayd
);
667 DBG("Live viewer listener thread cleanup complete");
668 if (lttng_relay_stop_threads()) {
669 ERR("Error stopping threads");
675 * This thread manages the dispatching of the requests to worker threads
678 void *thread_dispatcher(void *data
)
682 struct cds_wfcq_node
*node
;
683 struct relay_connection
*conn
= NULL
;
685 DBG("[thread] Live viewer relay dispatcher started");
687 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
689 if (testpoint(relayd_thread_live_dispatcher
)) {
690 goto error_testpoint
;
693 health_code_update();
696 health_code_update();
698 /* Atomically prepare the queue futex */
699 futex_nto1_prepare(&viewer_conn_queue
.futex
);
701 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
706 health_code_update();
708 /* Dequeue commands */
709 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
710 &viewer_conn_queue
.tail
);
712 DBG("Woken up but nothing in the live-viewer "
713 "relay command queue");
714 /* Continue thread execution */
717 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
718 DBG("Dispatching viewer request waiting on sock %d",
722 * Inform worker thread of the new request. This
723 * call is blocking so we can be assured that
724 * the data will be read at some point in time
725 * or wait to the end of the world :)
727 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
729 PERROR("write conn pipe");
730 connection_put(conn
);
733 } while (node
!= NULL
);
735 /* Futex wait on queue. Blocking call on futex() */
737 futex_nto1_wait(&viewer_conn_queue
.futex
);
741 /* Normal exit, no error */
748 ERR("Health error occurred in %s", __func__
);
750 health_unregister(health_relayd
);
751 DBG("Live viewer dispatch thread dying");
752 if (lttng_relay_stop_threads()) {
753 ERR("Error stopping threads");
759 * Establish connection with the viewer and check the versions.
761 * Return 0 on success or else negative value.
764 int viewer_connect(struct relay_connection
*conn
)
767 struct lttng_viewer_connect reply
, msg
;
769 conn
->version_check_done
= 1;
771 health_code_update();
773 DBG("Viewer is establishing a connection to the relayd.");
775 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
780 health_code_update();
782 memset(&reply
, 0, sizeof(reply
));
783 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
784 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
786 /* Major versions must be the same */
787 if (reply
.major
!= be32toh(msg
.major
)) {
788 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
789 reply
.major
, be32toh(msg
.major
));
794 conn
->major
= reply
.major
;
795 /* We adapt to the lowest compatible version */
796 if (reply
.minor
<= be32toh(msg
.minor
)) {
797 conn
->minor
= reply
.minor
;
799 conn
->minor
= be32toh(msg
.minor
);
802 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
803 conn
->type
= RELAY_VIEWER_COMMAND
;
804 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
805 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
807 ERR("Unknown connection type : %u", be32toh(msg
.type
));
812 reply
.major
= htobe32(reply
.major
);
813 reply
.minor
= htobe32(reply
.minor
);
814 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
816 * Increment outside of htobe64 macro, because the argument can
817 * be used more than once within the macro, and thus the
818 * operation may be undefined.
820 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
821 last_relay_viewer_session_id
++;
822 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
823 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
826 health_code_update();
828 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
833 health_code_update();
835 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
843 * Send the viewer the list of current sessions.
844 * We need to create a copy of the hash table content because otherwise
845 * we cannot assume the number of entries stays the same between getting
846 * the number of HT elements and iteration over the HT.
848 * Return 0 on success or else a negative value.
851 int viewer_list_sessions(struct relay_connection
*conn
)
854 struct lttng_viewer_list_sessions session_list
;
855 struct lttng_ht_iter iter
;
856 struct relay_session
*session
;
857 struct lttng_viewer_session
*send_session_buf
= NULL
;
858 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
861 DBG("List sessions received");
863 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
864 if (!send_session_buf
) {
869 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
871 struct lttng_viewer_session
*send_session
;
873 health_code_update();
875 pthread_mutex_lock(&session
->lock
);
876 if (session
->connection_closed
) {
877 /* Skip closed session */
880 if (!session
->current_trace_chunk
) {
882 * Skip un-attachable session. It is either
883 * being destroyed or has not had a trace
884 * chunk created against it yet.
889 if (count
>= buf_count
) {
890 struct lttng_viewer_session
*newbuf
;
891 uint32_t new_buf_count
= buf_count
<< 1;
893 newbuf
= realloc(send_session_buf
,
894 new_buf_count
* sizeof(*send_session_buf
));
899 send_session_buf
= newbuf
;
900 buf_count
= new_buf_count
;
902 send_session
= &send_session_buf
[count
];
903 if (lttng_strncpy(send_session
->session_name
,
904 session
->session_name
,
905 sizeof(send_session
->session_name
))) {
909 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
910 sizeof(send_session
->hostname
))) {
914 send_session
->id
= htobe64(session
->id
);
915 send_session
->live_timer
= htobe32(session
->live_timer
);
916 if (session
->viewer_attached
) {
917 send_session
->clients
= htobe32(1);
919 send_session
->clients
= htobe32(0);
921 send_session
->streams
= htobe32(session
->stream_count
);
924 pthread_mutex_unlock(&session
->lock
);
927 pthread_mutex_unlock(&session
->lock
);
935 session_list
.sessions_count
= htobe32(count
);
937 health_code_update();
939 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
944 health_code_update();
946 ret
= send_response(conn
->sock
, send_session_buf
,
947 count
* sizeof(*send_session_buf
));
951 health_code_update();
955 free(send_session_buf
);
960 * Send the viewer the list of current streams.
963 int viewer_get_new_streams(struct relay_connection
*conn
)
965 int ret
, send_streams
= 0;
966 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
967 struct lttng_viewer_new_streams_request request
;
968 struct lttng_viewer_new_streams_response response
;
969 struct relay_session
*session
= NULL
;
975 DBG("Get new streams received");
977 health_code_update();
979 /* Receive the request from the connected client. */
980 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
984 session_id
= be64toh(request
.session_id
);
986 health_code_update();
988 memset(&response
, 0, sizeof(response
));
990 session
= session_get_by_id(session_id
);
992 DBG("Relay session %" PRIu64
" not found", session_id
);
993 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
997 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
998 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
1002 pthread_mutex_lock(&session
->lock
);
1003 ret
= make_viewer_streams(session
,
1004 conn
->viewer_session
->current_trace_chunk
,
1005 LTTNG_VIEWER_SEEK_LAST
, &nb_total
, &nb_unsent
,
1006 &nb_created
, &closed
);
1008 goto error_unlock_session
;
1011 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
1013 /* Only send back the newly created streams with the unsent ones. */
1014 nb_streams
= nb_created
+ nb_unsent
;
1015 response
.streams_count
= htobe32(nb_streams
);
1018 * If the session is closed, HUP when there are no more streams
1021 if (closed
&& nb_total
== 0) {
1023 response
.streams_count
= 0;
1024 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
1025 goto send_reply_unlock
;
1028 pthread_mutex_unlock(&session
->lock
);
1031 health_code_update();
1032 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1034 goto end_put_session
;
1036 health_code_update();
1039 * Unknown or empty session, just return gracefully, the viewer
1040 * knows what is happening.
1042 if (!send_streams
|| !nb_streams
) {
1044 goto end_put_session
;
1048 * Send stream and *DON'T* ignore the sent flag so every viewer
1049 * streams that were not sent from that point will be sent to
1052 ret
= send_viewer_streams(conn
->sock
, session_id
, 0);
1054 goto end_put_session
;
1059 session_put(session
);
1063 error_unlock_session
:
1064 pthread_mutex_unlock(&session
->lock
);
1065 session_put(session
);
1070 * Send the viewer the list of current sessions.
1073 int viewer_attach_session(struct relay_connection
*conn
)
1075 int send_streams
= 0;
1077 uint32_t nb_streams
= 0;
1078 enum lttng_viewer_seek seek_type
;
1079 struct lttng_viewer_attach_session_request request
;
1080 struct lttng_viewer_attach_session_response response
;
1081 struct relay_session
*session
= NULL
;
1082 enum lttng_viewer_attach_return_code viewer_attach_status
;
1083 bool closed
= false;
1084 uint64_t session_id
;
1088 health_code_update();
1090 /* Receive the request from the connected client. */
1091 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1096 session_id
= be64toh(request
.session_id
);
1097 health_code_update();
1099 memset(&response
, 0, sizeof(response
));
1101 if (!conn
->viewer_session
) {
1102 DBG("Client trying to attach before creating a live viewer session");
1103 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1107 session
= session_get_by_id(session_id
);
1109 DBG("Relay session %" PRIu64
" not found", session_id
);
1110 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1113 DBG("Attach session ID %" PRIu64
" received", session_id
);
1115 pthread_mutex_lock(&session
->lock
);
1116 if (!session
->current_trace_chunk
) {
1118 * Session is either being destroyed or it never had a trace
1119 * chunk created against it.
1121 DBG("Session requested by live client has no current trace chunk, returning unknown session");
1122 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1125 if (session
->live_timer
== 0) {
1126 DBG("Not live session");
1127 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1132 viewer_attach_status
= viewer_session_attach(conn
->viewer_session
,
1134 if (viewer_attach_status
!= LTTNG_VIEWER_ATTACH_OK
) {
1135 response
.status
= htobe32(viewer_attach_status
);
1139 switch (be32toh(request
.seek
)) {
1140 case LTTNG_VIEWER_SEEK_BEGINNING
:
1141 case LTTNG_VIEWER_SEEK_LAST
:
1142 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1143 seek_type
= be32toh(request
.seek
);
1146 ERR("Wrong seek parameter");
1147 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1152 ret
= make_viewer_streams(session
,
1153 conn
->viewer_session
->current_trace_chunk
, seek_type
,
1154 &nb_streams
, NULL
, NULL
, &closed
);
1156 goto end_put_session
;
1158 pthread_mutex_unlock(&session
->lock
);
1159 session_put(session
);
1162 response
.streams_count
= htobe32(nb_streams
);
1164 * If the session is closed when the viewer is attaching, it
1165 * means some of the streams may have been concurrently removed,
1166 * so we don't allow the viewer to attach, even if there are
1167 * streams available.
1171 response
.streams_count
= 0;
1172 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1177 health_code_update();
1178 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1180 goto end_put_session
;
1182 health_code_update();
1185 * Unknown or empty session, just return gracefully, the viewer
1186 * knows what is happening.
1188 if (!send_streams
|| !nb_streams
) {
1190 goto end_put_session
;
1193 /* Send stream and ignore the sent flag. */
1194 ret
= send_viewer_streams(conn
->sock
, session_id
, 1);
1196 goto end_put_session
;
1201 pthread_mutex_unlock(&session
->lock
);
1202 session_put(session
);
1209 * Open the index file if needed for the given vstream.
1211 * If an index file is successfully opened, the vstream will set it as its
1212 * current index file.
1214 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1216 * Called with rstream lock held.
1218 static int try_open_index(struct relay_viewer_stream
*vstream
,
1219 struct relay_stream
*rstream
)
1222 const uint32_t connection_major
= rstream
->trace
->session
->major
;
1223 const uint32_t connection_minor
= rstream
->trace
->session
->minor
;
1225 if (vstream
->index_file
) {
1230 * First time, we open the index file and at least one index is ready.
1232 if (rstream
->index_received_seqcount
== 0) {
1236 vstream
->index_file
= lttng_index_file_create_from_trace_chunk_read_only(
1237 vstream
->stream_file
.trace_chunk
, rstream
->path_name
,
1238 rstream
->channel_name
, rstream
->tracefile_size
,
1239 vstream
->current_tracefile_id
,
1240 lttng_to_index_major(connection_major
, connection_minor
),
1241 lttng_to_index_minor(connection_major
, connection_minor
));
1242 if (!vstream
->index_file
) {
1251 * Check the status of the index for the given stream. This function
1252 * updates the index structure if needed and can put (close) the vstream
1253 * in the HUP situation.
1255 * Return 0 means that we can proceed with the index. A value of 1 means
1256 * that the index has been updated and is ready to be sent to the
1257 * client. A negative value indicates an error that can't be handled.
1259 * Called with rstream lock held.
1261 static int check_index_status(struct relay_viewer_stream
*vstream
,
1262 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1263 struct lttng_viewer_index
*index
)
1267 if ((trace
->session
->connection_closed
|| rstream
->closed
)
1268 && rstream
->index_received_seqcount
1269 == vstream
->index_sent_seqcount
) {
1271 * Last index sent and session connection or relay
1272 * stream are closed.
1274 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1276 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1277 rstream
->index_received_seqcount
1278 == vstream
->index_sent_seqcount
) {
1280 * We've received a synchronization beacon and the last index
1281 * available has been sent, the index for now is inactive.
1283 * In this case, we have received a beacon which allows us to
1284 * inform the client of a time interval during which we can
1285 * guarantee that there are no events to read (and never will
1288 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1289 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1290 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1292 } else if (rstream
->index_received_seqcount
1293 == vstream
->index_sent_seqcount
) {
1295 * This checks whether received == sent seqcount. In
1296 * this case, we have not received a beacon. Therefore,
1297 * we can only ask the client to retry later.
1299 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1301 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1302 vstream
->current_tracefile_id
,
1303 vstream
->index_sent_seqcount
)) {
1305 * The next index we want to send cannot be read either
1306 * because we need to perform a rotation, or due to
1307 * the producer having overwritten its trace file.
1309 DBG("Viewer stream %" PRIu64
" rotation",
1310 vstream
->stream
->stream_handle
);
1311 ret
= viewer_stream_rotate(vstream
);
1314 } else if (ret
== 1) {
1315 /* EOF across entire stream. */
1316 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1320 * If we have been pushed due to overwrite, it
1321 * necessarily means there is data that can be read in
1322 * the stream. If we rotated because we reached the end
1323 * of a tracefile, it means the following tracefile
1324 * needs to contain at least one index, else we would
1325 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1326 * viewer. The updated index_sent_seqcount needs to
1327 * point to a readable index entry now.
1329 * In the case where we "rotate" on a single file, we
1330 * can end up in a case where the requested index is
1331 * still unavailable.
1333 if (rstream
->tracefile_count
== 1 &&
1334 !tracefile_array_seq_in_file(
1336 vstream
->current_tracefile_id
,
1337 vstream
->index_sent_seqcount
)) {
1338 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1341 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1342 vstream
->current_tracefile_id
,
1343 vstream
->index_sent_seqcount
));
1345 /* ret == 0 means successful so we continue. */
1351 viewer_stream_put(vstream
);
1357 * Send the next index for a stream.
1359 * Return 0 on success or else a negative value.
1362 int viewer_get_next_index(struct relay_connection
*conn
)
1365 struct lttng_viewer_get_next_index request_index
;
1366 struct lttng_viewer_index viewer_index
;
1367 struct ctf_packet_index packet_index
;
1368 struct relay_viewer_stream
*vstream
= NULL
;
1369 struct relay_stream
*rstream
= NULL
;
1370 struct ctf_trace
*ctf_trace
= NULL
;
1371 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1375 DBG("Viewer get next index");
1377 memset(&viewer_index
, 0, sizeof(viewer_index
));
1378 health_code_update();
1380 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1384 health_code_update();
1386 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1388 DBG("Client requested index of unknown stream id %" PRIu64
,
1389 (uint64_t) be64toh(request_index
.stream_id
));
1390 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1394 /* Use back. ref. Protected by refcounts. */
1395 rstream
= vstream
->stream
;
1396 ctf_trace
= rstream
->trace
;
1398 /* metadata_viewer_stream may be NULL. */
1399 metadata_viewer_stream
=
1400 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1402 pthread_mutex_lock(&rstream
->lock
);
1405 * The viewer should not ask for index on metadata stream.
1407 if (rstream
->is_metadata
) {
1408 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1412 /* Try to open an index if one is needed for that stream. */
1413 ret
= try_open_index(vstream
, rstream
);
1415 if (ret
== -ENOENT
) {
1417 * The index is created only when the first data
1418 * packet arrives, it might not be ready at the
1419 * beginning of the session
1421 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1423 /* Unhandled error. */
1424 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1429 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1432 } else if (ret
== 1) {
1434 * We have no index to send and check_index_status has populated
1435 * viewer_index's status.
1439 /* At this point, ret is 0 thus we will be able to read the index. */
1443 * vstream->stream_fd may be NULL if it has been closed by
1444 * tracefile rotation, or if we are at the beginning of the
1445 * stream. We open the data stream file here to protect against
1446 * overwrite caused by tracefile rotation (in association with
1447 * unlink performed before overwrite).
1449 if (!vstream
->stream_file
.fd
) {
1451 char file_path
[LTTNG_PATH_MAX
];
1452 enum lttng_trace_chunk_status status
;
1454 ret
= utils_stream_file_path(rstream
->path_name
,
1455 rstream
->channel_name
, rstream
->tracefile_size
,
1456 vstream
->current_tracefile_id
, NULL
, file_path
,
1462 status
= lttng_trace_chunk_open_file(
1463 vstream
->stream_file
.trace_chunk
,
1464 file_path
, O_RDONLY
, 0, &fd
);
1465 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1466 PERROR("Failed to open trace file for viewer stream");
1469 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1470 if (!vstream
->stream_file
.fd
) {
1472 PERROR("Failed to close viewer stream file");
1478 ret
= check_new_streams(conn
);
1480 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1482 } else if (ret
== 1) {
1483 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1486 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1488 ERR("Relay error reading index file %d",
1489 vstream
->index_file
->fd
);
1490 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1493 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1494 vstream
->index_sent_seqcount
++;
1498 * Indexes are stored in big endian, no need to switch before sending.
1500 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1501 rstream
->stream_handle
,
1502 (uint64_t) be64toh(packet_index
.offset
));
1503 viewer_index
.offset
= packet_index
.offset
;
1504 viewer_index
.packet_size
= packet_index
.packet_size
;
1505 viewer_index
.content_size
= packet_index
.content_size
;
1506 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1507 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1508 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1509 viewer_index
.stream_id
= packet_index
.stream_id
;
1513 pthread_mutex_unlock(&rstream
->lock
);
1516 if (metadata_viewer_stream
) {
1517 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1518 DBG("get next index metadata check: recv %" PRIu64
1520 metadata_viewer_stream
->stream
->metadata_received
,
1521 metadata_viewer_stream
->metadata_sent
);
1522 if (!metadata_viewer_stream
->stream
->metadata_received
||
1523 metadata_viewer_stream
->stream
->metadata_received
>
1524 metadata_viewer_stream
->metadata_sent
) {
1525 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1527 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1530 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1531 health_code_update();
1533 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1537 health_code_update();
1540 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1541 vstream
->index_sent_seqcount
,
1542 vstream
->stream
->stream_handle
);
1545 if (metadata_viewer_stream
) {
1546 viewer_stream_put(metadata_viewer_stream
);
1549 viewer_stream_put(vstream
);
1554 pthread_mutex_unlock(&rstream
->lock
);
1555 if (metadata_viewer_stream
) {
1556 viewer_stream_put(metadata_viewer_stream
);
1558 viewer_stream_put(vstream
);
1563 * Send the next index for a stream
1565 * Return 0 on success or else a negative value.
1568 int viewer_get_packet(struct relay_connection
*conn
)
1573 struct lttng_viewer_get_packet get_packet_info
;
1574 struct lttng_viewer_trace_packet reply_header
;
1575 struct relay_viewer_stream
*vstream
= NULL
;
1576 uint32_t reply_size
= sizeof(reply_header
);
1577 uint32_t packet_data_len
= 0;
1580 DBG2("Relay get data packet");
1582 health_code_update();
1584 ret
= recv_request(conn
->sock
, &get_packet_info
,
1585 sizeof(get_packet_info
));
1589 health_code_update();
1591 /* From this point on, the error label can be reached. */
1592 memset(&reply_header
, 0, sizeof(reply_header
));
1594 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1596 DBG("Client requested packet of unknown stream id %" PRIu64
,
1597 (uint64_t) be64toh(get_packet_info
.stream_id
));
1598 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1599 goto send_reply_nolock
;
1601 packet_data_len
= be32toh(get_packet_info
.len
);
1602 reply_size
+= packet_data_len
;
1605 reply
= zmalloc(reply_size
);
1607 PERROR("packet reply zmalloc");
1608 reply_size
= sizeof(reply_header
);
1612 pthread_mutex_lock(&vstream
->stream
->lock
);
1613 lseek_ret
= lseek(vstream
->stream_file
.fd
->fd
,
1614 be64toh(get_packet_info
.offset
), SEEK_SET
);
1615 if (lseek_ret
< 0) {
1616 PERROR("lseek fd %d to offset %" PRIu64
,
1617 vstream
->stream_file
.fd
->fd
,
1618 (uint64_t) be64toh(get_packet_info
.offset
));
1621 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
,
1622 reply
+ sizeof(reply_header
), packet_data_len
);
1623 if (read_len
< packet_data_len
) {
1624 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1625 vstream
->stream_file
.fd
->fd
,
1626 (uint64_t) be64toh(get_packet_info
.offset
));
1629 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1630 reply_header
.len
= htobe32(packet_data_len
);
1634 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1638 pthread_mutex_unlock(&vstream
->stream
->lock
);
1642 health_code_update();
1645 memcpy(reply
, &reply_header
, sizeof(reply_header
));
1646 ret
= send_response(conn
->sock
, reply
, reply_size
);
1648 /* No reply to send. */
1649 ret
= send_response(conn
->sock
, &reply_header
,
1653 health_code_update();
1655 PERROR("sendmsg of packet data failed");
1659 DBG("Sent %u bytes for stream %" PRIu64
, reply_size
,
1660 (uint64_t) be64toh(get_packet_info
.stream_id
));
1666 viewer_stream_put(vstream
);
1672 * Send the session's metadata
1674 * Return 0 on success else a negative value.
1677 int viewer_get_metadata(struct relay_connection
*conn
)
1683 struct lttng_viewer_get_metadata request
;
1684 struct lttng_viewer_metadata_packet reply
;
1685 struct relay_viewer_stream
*vstream
= NULL
;
1689 DBG("Relay get metadata");
1691 health_code_update();
1693 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1697 health_code_update();
1699 memset(&reply
, 0, sizeof(reply
));
1701 vstream
= viewer_stream_get_by_id(be64toh(request
.stream_id
));
1704 * The metadata stream can be closed by a CLOSE command
1705 * just before we attach. It can also be closed by
1706 * per-pid tracing during tracing. Therefore, it is
1707 * possible that we cannot find this viewer stream.
1708 * Reply back to the client with an error if we cannot
1711 DBG("Client requested metadata of unknown stream id %" PRIu64
,
1712 (uint64_t) be64toh(request
.stream_id
));
1713 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1716 pthread_mutex_lock(&vstream
->stream
->lock
);
1717 if (!vstream
->stream
->is_metadata
) {
1718 ERR("Invalid metadata stream");
1722 assert(vstream
->metadata_sent
<= vstream
->stream
->metadata_received
);
1724 len
= vstream
->stream
->metadata_received
- vstream
->metadata_sent
;
1726 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1730 /* first time, we open the metadata file */
1731 if (!vstream
->stream_file
.fd
) {
1733 char file_path
[LTTNG_PATH_MAX
];
1734 enum lttng_trace_chunk_status status
;
1735 struct relay_stream
*rstream
= vstream
->stream
;
1737 ret
= utils_stream_file_path(rstream
->path_name
,
1738 rstream
->channel_name
, rstream
->tracefile_size
,
1739 vstream
->current_tracefile_id
, NULL
, file_path
,
1745 status
= lttng_trace_chunk_open_file(
1746 vstream
->stream_file
.trace_chunk
,
1747 file_path
, O_RDONLY
, 0, &fd
);
1748 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1749 PERROR("Failed to open metadata file for viewer stream");
1752 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1753 if (!vstream
->stream_file
.fd
) {
1755 PERROR("Failed to close viewer metadata file");
1761 reply
.len
= htobe64(len
);
1762 data
= zmalloc(len
);
1764 PERROR("viewer metadata zmalloc");
1768 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
, data
, len
);
1769 if (read_len
< len
) {
1770 PERROR("Relay reading metadata file");
1773 vstream
->metadata_sent
+= read_len
;
1774 if (vstream
->metadata_sent
== vstream
->stream
->metadata_received
1775 && vstream
->stream
->closed
) {
1776 /* Release ownership for the viewer metadata stream. */
1777 viewer_stream_put(vstream
);
1780 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1785 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1788 health_code_update();
1790 pthread_mutex_unlock(&vstream
->stream
->lock
);
1792 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1796 health_code_update();
1799 ret
= send_response(conn
->sock
, data
, len
);
1805 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1806 (uint64_t) be64toh(request
.stream_id
));
1808 DBG("Metadata sent");
1814 viewer_stream_put(vstream
);
1820 * Create a viewer session.
1822 * Return 0 on success or else a negative value.
1825 int viewer_create_session(struct relay_connection
*conn
)
1828 struct lttng_viewer_create_session_response resp
;
1830 DBG("Viewer create session received");
1832 memset(&resp
, 0, sizeof(resp
));
1833 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
1834 conn
->viewer_session
= viewer_session_create();
1835 if (!conn
->viewer_session
) {
1836 ERR("Allocation viewer session");
1837 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
1842 health_code_update();
1843 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
1847 health_code_update();
1855 * Detach a viewer session.
1857 * Return 0 on success or else a negative value.
1860 int viewer_detach_session(struct relay_connection
*conn
)
1863 struct lttng_viewer_detach_session_response response
;
1864 struct lttng_viewer_detach_session_request request
;
1865 struct relay_session
*session
= NULL
;
1866 uint64_t viewer_session_to_close
;
1868 DBG("Viewer detach session received");
1872 health_code_update();
1874 /* Receive the request from the connected client. */
1875 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1879 viewer_session_to_close
= be64toh(request
.session_id
);
1881 if (!conn
->viewer_session
) {
1882 DBG("Client trying to detach before creating a live viewer session");
1883 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1887 health_code_update();
1889 memset(&response
, 0, sizeof(response
));
1890 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
1892 session
= session_get_by_id(be64toh(request
.session_id
));
1894 DBG("Relay session %" PRIu64
" not found",
1895 (uint64_t) be64toh(request
.session_id
));
1896 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
1900 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
1902 DBG("Not attached to this session");
1903 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1904 goto send_reply_put
;
1907 viewer_session_close_one_session(conn
->viewer_session
, session
);
1908 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
1909 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
1912 session_put(session
);
1915 health_code_update();
1916 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1920 health_code_update();
1928 * live_relay_unknown_command: send -1 if received unknown command
1931 void live_relay_unknown_command(struct relay_connection
*conn
)
1933 struct lttcomm_relayd_generic_reply reply
;
1935 memset(&reply
, 0, sizeof(reply
));
1936 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1937 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
1941 * Process the commands received on the control socket
1944 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1945 struct relay_connection
*conn
)
1950 msg_value
= be32toh(recv_hdr
->cmd
);
1953 * Make sure we've done the version check before any command other then a
1954 * new client connection.
1956 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
1957 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
1962 switch (msg_value
) {
1963 case LTTNG_VIEWER_CONNECT
:
1964 ret
= viewer_connect(conn
);
1966 case LTTNG_VIEWER_LIST_SESSIONS
:
1967 ret
= viewer_list_sessions(conn
);
1969 case LTTNG_VIEWER_ATTACH_SESSION
:
1970 ret
= viewer_attach_session(conn
);
1972 case LTTNG_VIEWER_GET_NEXT_INDEX
:
1973 ret
= viewer_get_next_index(conn
);
1975 case LTTNG_VIEWER_GET_PACKET
:
1976 ret
= viewer_get_packet(conn
);
1978 case LTTNG_VIEWER_GET_METADATA
:
1979 ret
= viewer_get_metadata(conn
);
1981 case LTTNG_VIEWER_GET_NEW_STREAMS
:
1982 ret
= viewer_get_new_streams(conn
);
1984 case LTTNG_VIEWER_CREATE_SESSION
:
1985 ret
= viewer_create_session(conn
);
1987 case LTTNG_VIEWER_DETACH_SESSION
:
1988 ret
= viewer_detach_session(conn
);
1991 ERR("Received unknown viewer command (%u)",
1992 be32toh(recv_hdr
->cmd
));
1993 live_relay_unknown_command(conn
);
2003 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
2007 (void) lttng_poll_del(events
, pollfd
);
2009 ret
= close(pollfd
);
2011 ERR("Closing pollfd %d", pollfd
);
2016 * This thread does the actual work
2019 void *thread_worker(void *data
)
2023 struct lttng_poll_event events
;
2024 struct lttng_ht
*viewer_connections_ht
;
2025 struct lttng_ht_iter iter
;
2026 struct lttng_viewer_cmd recv_hdr
;
2027 struct relay_connection
*destroy_conn
;
2029 DBG("[thread] Live viewer relay worker started");
2031 rcu_register_thread();
2033 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
2035 if (testpoint(relayd_thread_live_worker
)) {
2036 goto error_testpoint
;
2039 /* table of connections indexed on socket */
2040 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2041 if (!viewer_connections_ht
) {
2042 goto viewer_connections_ht_error
;
2045 ret
= create_thread_poll_set(&events
, 2);
2047 goto error_poll_create
;
2050 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2059 health_code_update();
2061 /* Infinite blocking call, waiting for transmission */
2062 DBG3("Relayd live viewer worker thread polling...");
2063 health_poll_entry();
2064 ret
= lttng_poll_wait(&events
, -1);
2068 * Restart interrupted system call.
2070 if (errno
== EINTR
) {
2079 * Process control. The control connection is prioritised so we don't
2080 * starve it with high throughput tracing data on the data
2083 for (i
= 0; i
< nb_fd
; i
++) {
2084 /* Fetch once the poll data */
2085 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2086 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2088 health_code_update();
2090 /* Thread quit pipe has been closed. Killing thread. */
2091 ret
= check_thread_quit_pipe(pollfd
, revents
);
2097 /* Inspect the relay conn pipe for new connection. */
2098 if (pollfd
== live_conn_pipe
[0]) {
2099 if (revents
& LPOLLIN
) {
2100 struct relay_connection
*conn
;
2102 ret
= lttng_read(live_conn_pipe
[0],
2103 &conn
, sizeof(conn
));
2107 ret
= lttng_poll_add(&events
,
2109 LPOLLIN
| LPOLLRDHUP
);
2111 ERR("Failed to add new live connection file descriptor to poll set");
2114 connection_ht_add(viewer_connections_ht
, conn
);
2115 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2116 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2117 ERR("Relay live pipe error");
2120 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2124 /* Connection activity. */
2125 struct relay_connection
*conn
;
2127 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2132 if (revents
& LPOLLIN
) {
2133 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2134 sizeof(recv_hdr
), 0);
2136 /* Connection closed. */
2137 cleanup_connection_pollfd(&events
, pollfd
);
2138 /* Put "create" ownership reference. */
2139 connection_put(conn
);
2140 DBG("Viewer control conn closed with %d", pollfd
);
2142 ret
= process_control(&recv_hdr
, conn
);
2144 /* Clear the session on error. */
2145 cleanup_connection_pollfd(&events
, pollfd
);
2146 /* Put "create" ownership reference. */
2147 connection_put(conn
);
2148 DBG("Viewer connection closed with %d", pollfd
);
2151 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2152 cleanup_connection_pollfd(&events
, pollfd
);
2153 /* Put "create" ownership reference. */
2154 connection_put(conn
);
2156 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2157 connection_put(conn
);
2160 /* Put local "get_by_sock" reference. */
2161 connection_put(conn
);
2168 lttng_poll_clean(&events
);
2170 /* Cleanup remaining connection object. */
2172 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2175 health_code_update();
2176 connection_put(destroy_conn
);
2180 lttng_ht_destroy(viewer_connections_ht
);
2181 viewer_connections_ht_error
:
2182 /* Close relay conn pipes */
2183 utils_close_pipe(live_conn_pipe
);
2185 DBG("Viewer worker thread exited with error");
2187 DBG("Viewer worker thread cleanup complete");
2191 ERR("Health error occurred in %s", __func__
);
2193 health_unregister(health_relayd
);
2194 if (lttng_relay_stop_threads()) {
2195 ERR("Error stopping threads");
2197 rcu_unregister_thread();
2202 * Create the relay command pipe to wake thread_manage_apps.
2203 * Closed in cleanup().
2205 static int create_conn_pipe(void)
2207 return utils_create_pipe_cloexec(live_conn_pipe
);
2210 int relayd_live_join(void)
2212 int ret
, retval
= 0;
2215 ret
= pthread_join(live_listener_thread
, &status
);
2218 PERROR("pthread_join live listener");
2222 ret
= pthread_join(live_worker_thread
, &status
);
2225 PERROR("pthread_join live worker");
2229 ret
= pthread_join(live_dispatcher_thread
, &status
);
2232 PERROR("pthread_join live dispatcher");
2236 cleanup_relayd_live();
2244 int relayd_live_create(struct lttng_uri
*uri
)
2246 int ret
= 0, retval
= 0;
2252 goto exit_init_data
;
2256 /* Check if daemon is UID = 0 */
2257 is_root
= !getuid();
2260 if (live_uri
->port
< 1024) {
2261 ERR("Need to be root to use ports < 1024");
2263 goto exit_init_data
;
2267 /* Setup the thread apps communication pipe. */
2268 if (create_conn_pipe()) {
2270 goto exit_init_data
;
2273 /* Init relay command queue. */
2274 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2276 /* Set up max poll set size */
2277 if (lttng_poll_set_max_size()) {
2279 goto exit_init_data
;
2282 /* Setup the dispatcher thread */
2283 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2284 thread_dispatcher
, (void *) NULL
);
2287 PERROR("pthread_create viewer dispatcher");
2289 goto exit_dispatcher_thread
;
2292 /* Setup the worker thread */
2293 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2294 thread_worker
, NULL
);
2297 PERROR("pthread_create viewer worker");
2299 goto exit_worker_thread
;
2302 /* Setup the listener thread */
2303 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2304 thread_listener
, (void *) NULL
);
2307 PERROR("pthread_create viewer listener");
2309 goto exit_listener_thread
;
2313 * All OK, started all threads.
2318 * Join on the live_listener_thread should anything be added after
2319 * the live_listener thread's creation.
2322 exit_listener_thread
:
2324 ret
= pthread_join(live_worker_thread
, &status
);
2327 PERROR("pthread_join live worker");
2332 ret
= pthread_join(live_dispatcher_thread
, &status
);
2335 PERROR("pthread_join live dispatcher");
2338 exit_dispatcher_thread
:
2341 cleanup_relayd_live();