2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #include <sys/mount.h>
30 #include <sys/resource.h>
31 #include <sys/socket.h>
33 #include <sys/types.h>
36 #include <urcu/futex.h>
37 #include <urcu/uatomic.h>
42 #include <lttng/lttng.h>
43 #include <common/common.h>
44 #include <common/compat/poll.h>
45 #include <common/compat/socket.h>
46 #include <common/defaults.h>
47 #include <common/futex.h>
48 #include <common/sessiond-comm/sessiond-comm.h>
49 #include <common/sessiond-comm/inet.h>
50 #include <common/sessiond-comm/relayd.h>
51 #include <common/uri.h>
52 #include <common/utils.h>
56 #include "lttng-relayd.h"
57 #include "lttng-viewer.h"
59 #include "health-relayd.h"
60 #include "testpoint.h"
62 static struct lttng_uri
*live_uri
;
65 * This pipe is used to inform the worker thread that a command is queued and
66 * ready to be processed.
68 static int live_relay_cmd_pipe
[2] = { -1, -1 };
70 /* Shared between threads */
71 static int live_dispatch_thread_exit
;
73 static pthread_t live_listener_thread
;
74 static pthread_t live_dispatcher_thread
;
75 static pthread_t live_worker_thread
;
78 * Relay command queue.
80 * The live_thread_listener and live_thread_dispatcher communicate with this
83 static struct relay_cmd_queue viewer_cmd_queue
;
85 static uint64_t last_relay_viewer_session_id
;
99 * Write to writable pipe used to notify a thread.
102 int notify_thread_pipe(int wpipe
)
106 ret
= lttng_write(wpipe
, "!", 1);
108 PERROR("write poll pipe");
115 * Stop all threads by closing the thread quit pipe.
118 void stop_threads(void)
122 /* Stopping all threads */
123 DBG("Terminating all live threads");
124 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
126 ERR("write error on thread quit pipe");
129 /* Dispatch thread */
130 CMM_STORE_SHARED(live_dispatch_thread_exit
, 1);
131 futex_nto1_wake(&viewer_cmd_queue
.futex
);
135 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
138 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
142 if (events
== NULL
|| size
== 0) {
147 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
153 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
165 * Check if the thread quit pipe was triggered.
167 * Return 1 if it was triggered else 0;
170 int check_thread_quit_pipe(int fd
, uint32_t events
)
172 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
180 * Create and init socket from uri.
183 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
)
186 struct lttcomm_sock
*sock
= NULL
;
188 sock
= lttcomm_alloc_sock_from_uri(uri
);
190 ERR("Allocating socket");
194 ret
= lttcomm_create_sock(sock
);
198 DBG("Listening on sock %d for live", sock
->fd
);
200 ret
= sock
->ops
->bind(sock
);
205 ret
= sock
->ops
->listen(sock
, -1);
215 lttcomm_destroy_sock(sock
);
221 * This thread manages the listening for new connections on the network
224 void *thread_listener(void *data
)
226 int i
, ret
, pollfd
, err
= -1;
228 uint32_t revents
, nb_fd
;
229 struct lttng_poll_event events
;
230 struct lttcomm_sock
*live_control_sock
;
232 DBG("[thread] Relay live listener started");
234 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
236 health_code_update();
238 live_control_sock
= init_socket(live_uri
);
239 if (!live_control_sock
) {
240 goto error_sock_control
;
243 /* Pass 2 as size here for the thread quit pipe and control sockets. */
244 ret
= create_thread_poll_set(&events
, 2);
246 goto error_create_poll
;
249 /* Add the control socket */
250 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
255 lttng_relay_notify_ready();
257 if (testpoint(relayd_thread_live_listener
)) {
258 goto error_testpoint
;
262 health_code_update();
264 DBG("Listener accepting live viewers connections");
268 ret
= lttng_poll_wait(&events
, -1);
272 * Restart interrupted system call.
274 if (errno
== EINTR
) {
281 DBG("Relay new viewer connection received");
282 for (i
= 0; i
< nb_fd
; i
++) {
283 health_code_update();
285 /* Fetch once the poll data */
286 revents
= LTTNG_POLL_GETEV(&events
, i
);
287 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
289 /* Thread quit pipe has been closed. Killing thread. */
290 ret
= check_thread_quit_pipe(pollfd
, revents
);
296 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
297 ERR("socket poll error");
299 } else if (revents
& LPOLLIN
) {
301 * Get allocated in this thread, enqueued to a global queue,
302 * dequeued and freed in the worker thread.
304 struct relay_command
*relay_cmd
;
305 struct lttcomm_sock
*newsock
;
307 relay_cmd
= zmalloc(sizeof(*relay_cmd
));
309 PERROR("relay command zmalloc");
313 assert(pollfd
== live_control_sock
->fd
);
314 newsock
= live_control_sock
->ops
->accept(live_control_sock
);
316 PERROR("accepting control sock");
320 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
321 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
324 PERROR("setsockopt inet");
325 lttcomm_destroy_sock(newsock
);
329 relay_cmd
->sock
= newsock
;
332 * Lock free enqueue the request.
334 cds_wfq_enqueue(&viewer_cmd_queue
.queue
, &relay_cmd
->node
);
337 * Wake the dispatch queue futex. Implicit memory
338 * barrier with the exchange in cds_wfq_enqueue.
340 futex_nto1_wake(&viewer_cmd_queue
.futex
);
349 lttng_poll_clean(&events
);
351 if (live_control_sock
->fd
>= 0) {
352 ret
= live_control_sock
->ops
->close(live_control_sock
);
357 lttcomm_destroy_sock(live_control_sock
);
361 DBG("Live viewer listener thread exited with error");
363 health_unregister(health_relayd
);
364 DBG("Live viewer listener thread cleanup complete");
370 * This thread manages the dispatching of the requests to worker threads
373 void *thread_dispatcher(void *data
)
377 struct cds_wfq_node
*node
;
378 struct relay_command
*relay_cmd
= NULL
;
380 DBG("[thread] Live viewer relay dispatcher started");
382 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
384 if (testpoint(relayd_thread_live_dispatcher
)) {
385 goto error_testpoint
;
388 health_code_update();
390 while (!CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
391 health_code_update();
393 /* Atomically prepare the queue futex */
394 futex_nto1_prepare(&viewer_cmd_queue
.futex
);
397 health_code_update();
399 /* Dequeue commands */
400 node
= cds_wfq_dequeue_blocking(&viewer_cmd_queue
.queue
);
402 DBG("Woken up but nothing in the live-viewer "
403 "relay command queue");
404 /* Continue thread execution */
408 relay_cmd
= caa_container_of(node
, struct relay_command
, node
);
409 DBG("Dispatching viewer request waiting on sock %d",
410 relay_cmd
->sock
->fd
);
413 * Inform worker thread of the new request. This call is blocking
414 * so we can be assured that the data will be read at some point in
415 * time or wait to the end of the world :)
417 ret
= lttng_write(live_relay_cmd_pipe
[1], relay_cmd
,
420 if (ret
< sizeof(struct relay_command
)) {
421 PERROR("write cmd pipe");
424 } while (node
!= NULL
);
426 /* Futex wait on queue. Blocking call on futex() */
428 futex_nto1_wait(&viewer_cmd_queue
.futex
);
432 /* Normal exit, no error */
439 ERR("Health error occurred in %s", __func__
);
441 health_unregister(health_relayd
);
442 DBG("Live viewer dispatch thread dying");
448 * Establish connection with the viewer and check the versions.
450 * Return 0 on success or else negative value.
453 int viewer_connect(struct relay_command
*cmd
)
456 struct lttng_viewer_connect reply
, msg
;
460 cmd
->version_check_done
= 1;
462 health_code_update();
464 /* Get version from the other side. */
465 ret
= cmd
->sock
->ops
->recvmsg(cmd
->sock
, &msg
, sizeof(msg
), 0);
466 if (ret
< 0 || ret
!= sizeof(msg
)) {
468 /* Orderly shutdown. Not necessary to print an error. */
469 DBG("Socket %d did an orderly shutdown", cmd
->sock
->fd
);
471 ERR("Relay failed to receive the version values.");
477 health_code_update();
479 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
480 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
482 /* Major versions must be the same */
483 if (reply
.major
!= be32toh(msg
.major
)) {
484 DBG("Incompatible major versions (%u vs %u)", reply
.major
,
490 cmd
->major
= reply
.major
;
491 /* We adapt to the lowest compatible version */
492 if (reply
.minor
<= be32toh(msg
.minor
)) {
493 cmd
->minor
= reply
.minor
;
495 cmd
->minor
= be32toh(msg
.minor
);
498 if (be32toh(msg
.type
) == VIEWER_CLIENT_COMMAND
) {
499 cmd
->type
= RELAY_VIEWER_COMMAND
;
500 } else if (be32toh(msg
.type
) == VIEWER_CLIENT_NOTIFICATION
) {
501 cmd
->type
= RELAY_VIEWER_NOTIFICATION
;
503 ERR("Unknown connection type : %u", be32toh(msg
.type
));
508 reply
.major
= htobe32(reply
.major
);
509 reply
.minor
= htobe32(reply
.minor
);
510 if (cmd
->type
== RELAY_VIEWER_COMMAND
) {
511 reply
.viewer_session_id
= htobe64(++last_relay_viewer_session_id
);
514 health_code_update();
516 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &reply
,
517 sizeof(struct lttng_viewer_connect
), 0);
519 ERR("Relay sending version");
522 health_code_update();
524 DBG("Version check done using protocol %u.%u", cmd
->major
, cmd
->minor
);
532 * Send the viewer the list of current sessions.
534 * Return 0 on success or else a negative value.
537 int viewer_list_sessions(struct relay_command
*cmd
,
538 struct lttng_ht
*sessions_ht
)
541 struct lttng_viewer_list_sessions session_list
;
543 long approx_before
, approx_after
;
544 struct lttng_ht_node_ulong
*node
;
545 struct lttng_ht_iter iter
;
546 struct lttng_viewer_session send_session
;
547 struct relay_session
*session
;
549 DBG("List sessions received");
551 if (cmd
->version_check_done
== 0) {
552 ERR("Trying to list sessions before version check");
558 cds_lfht_count_nodes(sessions_ht
->ht
, &approx_before
, &count
, &approx_after
);
559 session_list
.sessions_count
= htobe32(count
);
561 health_code_update();
563 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &session_list
,
564 sizeof(session_list
), 0);
566 ERR("Relay sending sessions list");
570 health_code_update();
572 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, node
, node
) {
573 health_code_update();
575 node
= lttng_ht_iter_get_node_ulong(&iter
);
579 session
= caa_container_of(node
, struct relay_session
, session_n
);
581 strncpy(send_session
.session_name
, session
->session_name
,
582 sizeof(send_session
.session_name
));
583 strncpy(send_session
.hostname
, session
->hostname
,
584 sizeof(send_session
.hostname
));
585 send_session
.id
= htobe64(session
->id
);
586 send_session
.live_timer
= htobe32(session
->live_timer
);
587 send_session
.clients
= htobe32(session
->viewer_attached
);
588 send_session
.streams
= htobe32(session
->stream_count
);
590 health_code_update();
592 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &send_session
,
593 sizeof(send_session
), 0);
595 ERR("Relay sending session info");
599 health_code_update();
614 * Open index file using a given viewer stream.
616 * Return 0 on success or else a negative value.
618 static int open_index(struct relay_viewer_stream
*stream
)
621 char fullpath
[PATH_MAX
];
622 struct ctf_packet_index_file_hdr hdr
;
624 if (stream
->tracefile_count
> 0) {
625 ret
= snprintf(fullpath
, sizeof(fullpath
), "%s/" DEFAULT_INDEX_DIR
"/%s_%"
626 PRIu64 DEFAULT_INDEX_FILE_SUFFIX
, stream
->path_name
,
627 stream
->channel_name
, stream
->tracefile_count_current
);
629 ret
= snprintf(fullpath
, sizeof(fullpath
), "%s/" DEFAULT_INDEX_DIR
"/%s"
630 DEFAULT_INDEX_FILE_SUFFIX
, stream
->path_name
,
631 stream
->channel_name
);
634 PERROR("snprintf index path");
638 DBG("Opening index file %s in read only", fullpath
);
639 ret
= open(fullpath
, O_RDONLY
);
641 if (errno
== ENOENT
) {
645 PERROR("opening index in read-only");
649 stream
->index_read_fd
= ret
;
650 DBG("Opening index file %s in read only, (fd: %d)", fullpath
, ret
);
652 ret
= lttng_read(stream
->index_read_fd
, &hdr
, sizeof(hdr
));
653 if (ret
< sizeof(hdr
)) {
654 PERROR("Reading index header");
657 if (be32toh(hdr
.magic
) != CTF_INDEX_MAGIC
) {
658 ERR("Invalid header magic");
662 if (be32toh(hdr
.index_major
) != CTF_INDEX_MAJOR
||
663 be32toh(hdr
.index_minor
) != CTF_INDEX_MINOR
) {
664 ERR("Invalid header version");
675 * Allocate and init a new viewer_stream.
677 * Copies the values from the stream passed in parameter and insert the new
678 * stream in the viewer_streams_ht.
680 * MUST be called with rcu_read_lock held.
682 * Returns 0 on success or a negative value on error.
685 int init_viewer_stream(struct relay_stream
*stream
, int seek_last
)
688 struct relay_viewer_stream
*viewer_stream
;
692 viewer_stream
= zmalloc(sizeof(*viewer_stream
));
693 if (!viewer_stream
) {
694 PERROR("relay viewer stream zmalloc");
698 viewer_stream
->session_id
= stream
->session
->id
;
699 viewer_stream
->stream_handle
= stream
->stream_handle
;
700 viewer_stream
->path_name
= strndup(stream
->path_name
,
701 LTTNG_VIEWER_PATH_MAX
);
702 viewer_stream
->channel_name
= strndup(stream
->channel_name
,
703 LTTNG_VIEWER_NAME_MAX
);
704 viewer_stream
->tracefile_count
= stream
->tracefile_count
;
705 viewer_stream
->metadata_flag
= stream
->metadata_flag
;
706 viewer_stream
->tracefile_count_last
= -1ULL;
708 viewer_stream
->tracefile_count_current
=
709 stream
->tracefile_count_current
;
711 viewer_stream
->tracefile_count_current
=
712 stream
->oldest_tracefile_id
;
715 viewer_stream
->ctf_trace
= stream
->ctf_trace
;
716 if (viewer_stream
->metadata_flag
) {
717 viewer_stream
->ctf_trace
->viewer_metadata_stream
=
720 uatomic_inc(&viewer_stream
->ctf_trace
->refcount
);
722 lttng_ht_node_init_u64(&viewer_stream
->stream_n
, stream
->stream_handle
);
723 lttng_ht_add_unique_u64(viewer_streams_ht
, &viewer_stream
->stream_n
);
725 viewer_stream
->index_read_fd
= -1;
726 viewer_stream
->read_fd
= -1;
729 * This is to avoid a race between the initialization of this object and
730 * the close of the given stream. If the stream is unable to find this
731 * viewer stream when closing, this copy will at least take the latest
733 * We also need that for the seek_last.
735 viewer_stream
->total_index_received
= stream
->total_index_received
;
738 * If we never received an index for the current stream, delay
739 * the opening of the index, otherwise open it right now.
741 if (viewer_stream
->tracefile_count_current
==
742 stream
->tracefile_count_current
&&
743 viewer_stream
->total_index_received
== 0) {
744 viewer_stream
->index_read_fd
= -1;
746 ret
= open_index(viewer_stream
);
752 if (seek_last
&& viewer_stream
->index_read_fd
> 0) {
753 ret
= lseek(viewer_stream
->index_read_fd
,
754 viewer_stream
->total_index_received
*
755 sizeof(struct ctf_packet_index
),
760 viewer_stream
->last_sent_index
=
761 viewer_stream
->total_index_received
;
771 * Rotate a stream to the next tracefile.
773 * Returns 0 on success, 1 on EOF, a negative value on error.
776 int rotate_viewer_stream(struct relay_viewer_stream
*viewer_stream
,
777 struct relay_stream
*stream
)
780 uint64_t tracefile_id
;
782 assert(viewer_stream
);
784 tracefile_id
= (viewer_stream
->tracefile_count_current
+ 1) %
785 viewer_stream
->tracefile_count
;
787 * Detect the last tracefile to open.
789 if (viewer_stream
->tracefile_count_last
!= -1ULL &&
790 viewer_stream
->tracefile_count_last
==
791 viewer_stream
->tracefile_count_current
) {
797 pthread_mutex_lock(&stream
->viewer_stream_rotation_lock
);
800 * The writer and the reader are not working in the same
801 * tracefile, we can read up to EOF, we don't care about the
802 * total_index_received.
804 if (!stream
|| (stream
->tracefile_count_current
!= tracefile_id
)) {
805 viewer_stream
->close_write_flag
= 1;
808 * We are opening a file that is still open in write, make
809 * sure we limit our reading to the number of indexes
812 viewer_stream
->close_write_flag
= 0;
814 viewer_stream
->total_index_received
=
815 stream
->total_index_received
;
818 viewer_stream
->tracefile_count_current
= tracefile_id
;
820 ret
= close(viewer_stream
->index_read_fd
);
822 PERROR("close index file %d",
823 viewer_stream
->index_read_fd
);
825 viewer_stream
->index_read_fd
= -1;
826 ret
= close(viewer_stream
->read_fd
);
828 PERROR("close tracefile %d",
829 viewer_stream
->read_fd
);
831 viewer_stream
->read_fd
= -1;
833 pthread_mutex_lock(&viewer_stream
->overwrite_lock
);
834 viewer_stream
->abort_flag
= 0;
835 pthread_mutex_unlock(&viewer_stream
->overwrite_lock
);
837 viewer_stream
->index_read_fd
= -1;
838 viewer_stream
->read_fd
= -1;
841 pthread_mutex_unlock(&stream
->viewer_stream_rotation_lock
);
843 ret
= open_index(viewer_stream
);
856 * Send the viewer the list of current sessions.
859 int viewer_get_new_streams(struct relay_command
*cmd
,
860 struct lttng_ht
*sessions_ht
)
862 int ret
, send_streams
= 0;
863 uint32_t nb_streams
= 0;
864 struct lttng_viewer_new_streams_request request
;
865 struct lttng_viewer_new_streams_response response
;
866 struct lttng_viewer_stream send_stream
;
867 struct relay_stream
*stream
;
868 struct relay_viewer_stream
*viewer_stream
;
869 struct lttng_ht_node_ulong
*node
;
870 struct lttng_ht_iter iter
;
871 struct relay_session
*session
;
876 DBG("Get new streams received");
878 if (cmd
->version_check_done
== 0) {
879 ERR("Trying to get streams before version check");
884 health_code_update();
886 ret
= cmd
->sock
->ops
->recvmsg(cmd
->sock
, &request
, sizeof(request
), 0);
887 if (ret
< 0 || ret
!= sizeof(request
)) {
889 /* Orderly shutdown. Not necessary to print an error. */
890 DBG("Socket %d did an orderly shutdown", cmd
->sock
->fd
);
892 ERR("Relay failed to receive the command parameters.");
898 health_code_update();
901 lttng_ht_lookup(sessions_ht
,
902 (void *)((unsigned long) be64toh(request
.session_id
)), &iter
);
903 node
= lttng_ht_iter_get_node_ulong(&iter
);
905 DBG("Relay session %" PRIu64
" not found",
906 be64toh(request
.session_id
));
907 response
.status
= htobe32(VIEWER_NEW_STREAMS_ERR
);
911 session
= caa_container_of(node
, struct relay_session
, session_n
);
912 if (cmd
->session_id
== session
->id
) {
913 /* We confirmed the viewer is asking for the same session. */
915 response
.status
= htobe32(VIEWER_NEW_STREAMS_OK
);
918 response
.status
= htobe32(VIEWER_NEW_STREAMS_ERR
);
923 * Fill the viewer_streams_ht to count the number of streams ready to be
924 * sent and avoid concurrency issues on the relay_streams_ht and don't rely
925 * on a total session stream count.
927 pthread_mutex_lock(&session
->viewer_ready_lock
);
928 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
930 struct relay_viewer_stream
*vstream
;
932 health_code_update();
935 * Don't send stream if no ctf_trace, wrong session or if the stream is
936 * not ready for the viewer.
938 if (stream
->session
!= cmd
->session
||
939 !stream
->ctf_trace
|| !stream
->viewer_ready
) {
943 vstream
= live_find_viewer_stream_by_id(stream
->stream_handle
);
945 ret
= init_viewer_stream(stream
, 0);
947 pthread_mutex_unlock(&session
->viewer_ready_lock
);
951 } else if (!vstream
->sent_flag
) {
955 pthread_mutex_unlock(&session
->viewer_ready_lock
);
957 response
.streams_count
= htobe32(nb_streams
);
960 health_code_update();
961 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &response
, sizeof(response
), 0);
963 ERR("Relay sending viewer attach response");
966 health_code_update();
969 * Unknown or empty session, just return gracefully, the viewer knows what
972 if (!send_streams
|| !nb_streams
) {
977 /* We should only be there if we have a session to attach to. */
978 cds_lfht_for_each_entry(viewer_streams_ht
->ht
, &iter
.iter
, viewer_stream
,
980 health_code_update();
982 /* Don't send back if session does not match or already sent. */
983 if (viewer_stream
->session_id
!= cmd
->session
->id
||
984 viewer_stream
->sent_flag
) {
988 send_stream
.id
= htobe64(viewer_stream
->stream_handle
);
989 send_stream
.ctf_trace_id
= htobe64(viewer_stream
->ctf_trace
->id
);
990 send_stream
.metadata_flag
= htobe32(viewer_stream
->metadata_flag
);
991 strncpy(send_stream
.path_name
, viewer_stream
->path_name
,
992 sizeof(send_stream
.path_name
));
993 strncpy(send_stream
.channel_name
, viewer_stream
->channel_name
,
994 sizeof(send_stream
.channel_name
));
996 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &send_stream
,
997 sizeof(send_stream
), 0);
999 ERR("Relay sending stream %" PRIu64
, viewer_stream
->stream_handle
);
1002 DBG("Sent stream %" PRIu64
" to viewer", viewer_stream
->stream_handle
);
1003 viewer_stream
->sent_flag
= 1;
1016 * Send the viewer the list of current sessions.
1019 int viewer_attach_session(struct relay_command
*cmd
,
1020 struct lttng_ht
*sessions_ht
)
1022 int ret
, send_streams
= 0;
1023 uint32_t nb_streams
= 0;
1024 struct lttng_viewer_attach_session_request request
;
1025 struct lttng_viewer_attach_session_response response
;
1026 struct lttng_viewer_stream send_stream
;
1027 struct relay_stream
*stream
;
1028 struct relay_viewer_stream
*viewer_stream
;
1029 struct lttng_ht_node_ulong
*node
;
1030 struct lttng_ht_node_u64
*node64
;
1031 struct lttng_ht_iter iter
;
1032 struct relay_session
*session
;
1036 assert(sessions_ht
);
1038 DBG("Attach session received");
1040 if (cmd
->version_check_done
== 0) {
1041 ERR("Trying to attach session before version check");
1043 goto end_no_session
;
1046 health_code_update();
1048 ret
= cmd
->sock
->ops
->recvmsg(cmd
->sock
, &request
, sizeof(request
), 0);
1049 if (ret
< 0 || ret
!= sizeof(request
)) {
1051 /* Orderly shutdown. Not necessary to print an error. */
1052 DBG("Socket %d did an orderly shutdown", cmd
->sock
->fd
);
1054 ERR("Relay failed to receive the attach parameters.");
1060 health_code_update();
1063 lttng_ht_lookup(sessions_ht
,
1064 (void *)((unsigned long) be64toh(request
.session_id
)), &iter
);
1065 node
= lttng_ht_iter_get_node_ulong(&iter
);
1067 DBG("Relay session %" PRIu64
" not found",
1068 be64toh(request
.session_id
));
1069 response
.status
= htobe32(VIEWER_ATTACH_UNK
);
1073 session
= caa_container_of(node
, struct relay_session
, session_n
);
1074 if (cmd
->session_id
== session
->id
) {
1075 /* Same viewer already attached, just send the stream list. */
1077 response
.status
= htobe32(VIEWER_ATTACH_OK
);
1078 } else if (session
->viewer_attached
!= 0) {
1079 DBG("Already a viewer attached");
1080 response
.status
= htobe32(VIEWER_ATTACH_ALREADY
);
1082 } else if (session
->live_timer
== 0) {
1083 DBG("Not live session");
1084 response
.status
= htobe32(VIEWER_ATTACH_NOT_LIVE
);
1087 session
->viewer_attached
++;
1089 response
.status
= htobe32(VIEWER_ATTACH_OK
);
1090 cmd
->session_id
= session
->id
;
1091 cmd
->session
= session
;
1094 switch (be32toh(request
.seek
)) {
1095 case VIEWER_SEEK_BEGINNING
:
1096 /* Default behaviour. */
1098 case VIEWER_SEEK_LAST
:
1102 ERR("Wrong seek parameter");
1103 response
.status
= htobe32(VIEWER_ATTACH_SEEK_ERR
);
1109 /* We should only be there if we have a session to attach to. */
1113 * Fill the viewer_streams_ht to count the number of streams
1114 * ready to be sent and avoid concurrency issues on the
1115 * relay_streams_ht and don't rely on a total session stream count.
1117 pthread_mutex_lock(&session
->viewer_ready_lock
);
1118 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, node
, node
) {
1119 struct relay_viewer_stream
*vstream
;
1121 health_code_update();
1123 node
= lttng_ht_iter_get_node_ulong(&iter
);
1127 stream
= caa_container_of(node
, struct relay_stream
, stream_n
);
1128 if (stream
->session
!= cmd
->session
) {
1133 * Don't send streams with no ctf_trace, they are not
1136 if (!stream
->ctf_trace
|| !stream
->viewer_ready
) {
1140 vstream
= live_find_viewer_stream_by_id(stream
->stream_handle
);
1142 ret
= init_viewer_stream(stream
, seek_last
);
1144 pthread_mutex_unlock(&session
->viewer_ready_lock
);
1150 pthread_mutex_unlock(&session
->viewer_ready_lock
);
1152 response
.streams_count
= htobe32(nb_streams
);
1156 health_code_update();
1157 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &response
, sizeof(response
), 0);
1159 ERR("Relay sending viewer attach response");
1162 health_code_update();
1165 * Unknown or empty session, just return gracefully, the viewer knows what
1168 if (!send_streams
|| !nb_streams
) {
1173 /* We should only be there if we have a session to attach to. */
1175 cds_lfht_for_each_entry(viewer_streams_ht
->ht
, &iter
.iter
, node
, node
) {
1176 health_code_update();
1178 node64
= lttng_ht_iter_get_node_u64(&iter
);
1182 viewer_stream
= caa_container_of(node64
, struct relay_viewer_stream
,
1184 if (viewer_stream
->session_id
!= cmd
->session
->id
) {
1188 send_stream
.id
= htobe64(viewer_stream
->stream_handle
);
1189 send_stream
.ctf_trace_id
= htobe64(viewer_stream
->ctf_trace
->id
);
1190 send_stream
.metadata_flag
= htobe32(viewer_stream
->metadata_flag
);
1191 strncpy(send_stream
.path_name
, viewer_stream
->path_name
,
1192 sizeof(send_stream
.path_name
));
1193 strncpy(send_stream
.channel_name
, viewer_stream
->channel_name
,
1194 sizeof(send_stream
.channel_name
));
1196 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &send_stream
,
1197 sizeof(send_stream
), 0);
1199 ERR("Relay sending stream %" PRIu64
, viewer_stream
->stream_handle
);
1202 DBG("Sent stream %" PRIu64
" to viewer", viewer_stream
->stream_handle
);
1203 viewer_stream
->sent_flag
= 1;
1215 * Get viewer stream from stream id.
1217 * RCU read side lock MUST be acquired.
1219 struct relay_viewer_stream
*live_find_viewer_stream_by_id(uint64_t stream_id
)
1221 struct lttng_ht_node_u64
*node
;
1222 struct lttng_ht_iter iter
;
1223 struct relay_viewer_stream
*stream
= NULL
;
1225 lttng_ht_lookup(viewer_streams_ht
, &stream_id
, &iter
);
1226 node
= lttng_ht_iter_get_node_u64(&iter
);
1228 DBG("Relay viewer stream %" PRIu64
" not found", stream_id
);
1231 stream
= caa_container_of(node
, struct relay_viewer_stream
, stream_n
);
1238 void deferred_free_viewer_stream(struct rcu_head
*head
)
1240 struct relay_viewer_stream
*stream
=
1241 caa_container_of(head
, struct relay_viewer_stream
, rcu_node
);
1243 free(stream
->path_name
);
1244 free(stream
->channel_name
);
1249 void delete_viewer_stream(struct relay_viewer_stream
*vstream
)
1252 struct lttng_ht_iter iter
;
1254 iter
.iter
.node
= &vstream
->stream_n
.node
;
1255 delret
= lttng_ht_del(viewer_streams_ht
, &iter
);
1260 void destroy_viewer_stream(struct relay_viewer_stream
*vstream
)
1262 unsigned long ret_ref
;
1266 ret_ref
= uatomic_add_return(&vstream
->ctf_trace
->refcount
, -1);
1267 assert(ret_ref
>= 0);
1269 if (vstream
->read_fd
>= 0) {
1270 ret
= close(vstream
->read_fd
);
1272 PERROR("close read_fd");
1275 if (vstream
->index_read_fd
>= 0) {
1276 ret
= close(vstream
->index_read_fd
);
1278 PERROR("close index_read_fd");
1283 * If the only stream left in the HT is the metadata stream,
1284 * we need to remove it because we won't detect a EOF for this
1287 if (ret_ref
== 1 && vstream
->ctf_trace
->viewer_metadata_stream
) {
1288 delete_viewer_stream(vstream
->ctf_trace
->viewer_metadata_stream
);
1289 destroy_viewer_stream(vstream
->ctf_trace
->viewer_metadata_stream
);
1290 vstream
->ctf_trace
->metadata_stream
= NULL
;
1291 DBG("Freeing ctf_trace %" PRIu64
, vstream
->ctf_trace
->id
);
1293 * The streaming-side is already closed and we can't receive a new
1294 * stream concurrently at this point (since the session is being
1295 * destroyed), so when we detect the refcount equals 0, we are the
1296 * only owners of the ctf_trace and we can free it ourself.
1298 free(vstream
->ctf_trace
);
1301 call_rcu(&vstream
->rcu_node
, deferred_free_viewer_stream
);
1305 * Atomically check if new streams got added in the session since the last
1306 * check and reset the flag to 0.
1308 * Returns 1 if new streams got added, 0 if nothing changed, a negative value
1312 int check_new_streams(uint64_t session_id
, struct lttng_ht
*sessions_ht
)
1314 struct lttng_ht_node_ulong
*node
;
1315 struct lttng_ht_iter iter
;
1316 struct relay_session
*session
;
1317 unsigned long current_val
;
1320 lttng_ht_lookup(sessions_ht
,
1321 (void *)((unsigned long) session_id
), &iter
);
1322 node
= lttng_ht_iter_get_node_ulong(&iter
);
1324 DBG("Relay session %" PRIu64
" not found", session_id
);
1329 session
= caa_container_of(node
, struct relay_session
, session_n
);
1331 current_val
= uatomic_cmpxchg(&session
->new_streams
, 1, 0);
1339 * Send the next index for a stream.
1341 * Return 0 on success or else a negative value.
1344 int viewer_get_next_index(struct relay_command
*cmd
,
1345 struct lttng_ht
*sessions_ht
)
1348 struct lttng_viewer_get_next_index request_index
;
1349 struct lttng_viewer_index viewer_index
;
1350 struct ctf_packet_index packet_index
;
1351 struct relay_viewer_stream
*vstream
;
1352 struct relay_stream
*rstream
;
1355 assert(sessions_ht
);
1357 DBG("Viewer get next index");
1359 if (cmd
->version_check_done
== 0) {
1360 ERR("Trying to request index before version check");
1362 goto end_no_session
;
1365 health_code_update();
1366 ret
= cmd
->sock
->ops
->recvmsg(cmd
->sock
, &request_index
,
1367 sizeof(request_index
), 0);
1368 if (ret
< 0 || ret
!= sizeof(request_index
)) {
1370 ERR("Relay didn't receive the whole packet");
1373 health_code_update();
1376 vstream
= live_find_viewer_stream_by_id(be64toh(request_index
.stream_id
));
1382 memset(&viewer_index
, 0, sizeof(viewer_index
));
1385 * The viewer should not ask for index on metadata stream.
1387 if (vstream
->metadata_flag
) {
1388 viewer_index
.status
= htobe32(VIEWER_INDEX_HUP
);
1392 /* First time, we open the index file */
1393 if (vstream
->index_read_fd
< 0) {
1394 ret
= open_index(vstream
);
1395 if (ret
== -ENOENT
) {
1397 * The index is created only when the first data packet arrives, it
1398 * might not be ready at the beginning of the session
1400 viewer_index
.status
= htobe32(VIEWER_INDEX_RETRY
);
1402 } else if (ret
< 0) {
1403 viewer_index
.status
= htobe32(VIEWER_INDEX_ERR
);
1408 rstream
= relay_stream_find_by_id(vstream
->stream_handle
);
1410 if (vstream
->abort_flag
) {
1411 /* Rotate on abort (overwrite). */
1412 DBG("Viewer rotate because of overwrite");
1413 ret
= rotate_viewer_stream(vstream
, rstream
);
1416 } else if (ret
== 1) {
1417 viewer_index
.status
= htobe32(VIEWER_INDEX_HUP
);
1418 delete_viewer_stream(vstream
);
1419 destroy_viewer_stream(vstream
);
1423 pthread_mutex_lock(&rstream
->viewer_stream_rotation_lock
);
1424 if (rstream
->tracefile_count_current
== vstream
->tracefile_count_current
) {
1425 if (rstream
->beacon_ts_end
!= -1ULL &&
1426 vstream
->last_sent_index
== rstream
->total_index_received
) {
1427 viewer_index
.status
= htobe32(VIEWER_INDEX_INACTIVE
);
1428 viewer_index
.timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1429 pthread_mutex_unlock(&rstream
->viewer_stream_rotation_lock
);
1432 * Reader and writer are working in the same tracefile, so we care
1433 * about the number of index received and sent. Otherwise, we read
1436 } else if (rstream
->total_index_received
<= vstream
->last_sent_index
1437 && !vstream
->close_write_flag
) {
1438 pthread_mutex_unlock(&rstream
->viewer_stream_rotation_lock
);
1439 /* No new index to send, retry later. */
1440 viewer_index
.status
= htobe32(VIEWER_INDEX_RETRY
);
1444 pthread_mutex_unlock(&rstream
->viewer_stream_rotation_lock
);
1445 } else if (!rstream
&& vstream
->close_write_flag
&&
1446 vstream
->total_index_received
== vstream
->last_sent_index
) {
1447 /* Last index sent and current tracefile closed in write */
1448 viewer_index
.status
= htobe32(VIEWER_INDEX_HUP
);
1449 delete_viewer_stream(vstream
);
1450 destroy_viewer_stream(vstream
);
1453 vstream
->close_write_flag
= 1;
1456 if (!vstream
->ctf_trace
->metadata_received
||
1457 vstream
->ctf_trace
->metadata_received
>
1458 vstream
->ctf_trace
->metadata_sent
) {
1459 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1462 ret
= check_new_streams(vstream
->session_id
, sessions_ht
);
1465 } else if (ret
== 1) {
1466 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1469 pthread_mutex_lock(&vstream
->overwrite_lock
);
1470 if (vstream
->abort_flag
) {
1472 * The file is being overwritten by the writer, we cannot
1475 viewer_index
.status
= htobe32(VIEWER_INDEX_RETRY
);
1476 pthread_mutex_unlock(&vstream
->overwrite_lock
);
1477 ret
= rotate_viewer_stream(vstream
, rstream
);
1480 } else if (ret
== 1) {
1481 viewer_index
.status
= htobe32(VIEWER_INDEX_HUP
);
1482 delete_viewer_stream(vstream
);
1483 destroy_viewer_stream(vstream
);
1488 ret
= lttng_read(vstream
->index_read_fd
, &packet_index
,
1489 sizeof(packet_index
));
1490 pthread_mutex_unlock(&vstream
->overwrite_lock
);
1491 if (ret
< sizeof(packet_index
)) {
1493 * The tracefile is closed in write, so we read up to EOF.
1495 if (vstream
->close_write_flag
== 1) {
1496 viewer_index
.status
= htobe32(VIEWER_INDEX_RETRY
);
1497 /* Rotate on normal EOF */
1498 ret
= rotate_viewer_stream(vstream
, rstream
);
1501 } else if (ret
== 1) {
1502 viewer_index
.status
= htobe32(VIEWER_INDEX_HUP
);
1503 delete_viewer_stream(vstream
);
1504 destroy_viewer_stream(vstream
);
1508 PERROR("Relay reading index file %d",
1509 vstream
->index_read_fd
);
1510 viewer_index
.status
= htobe32(VIEWER_INDEX_ERR
);
1514 viewer_index
.status
= htobe32(VIEWER_INDEX_OK
);
1515 vstream
->last_sent_index
++;
1519 * Indexes are stored in big endian, no need to switch before sending.
1521 viewer_index
.offset
= packet_index
.offset
;
1522 viewer_index
.packet_size
= packet_index
.packet_size
;
1523 viewer_index
.content_size
= packet_index
.content_size
;
1524 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1525 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1526 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1527 viewer_index
.stream_id
= packet_index
.stream_id
;
1530 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1531 health_code_update();
1532 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &viewer_index
,
1533 sizeof(viewer_index
), 0);
1535 ERR("Relay index to viewer");
1538 health_code_update();
1540 DBG("Index %" PRIu64
"for stream %" PRIu64
"sent",
1541 vstream
->last_sent_index
, vstream
->stream_handle
);
1552 * Send the next index for a stream
1554 * Return 0 on success or else a negative value.
1557 int viewer_get_packet(struct relay_command
*cmd
,
1558 struct lttng_ht
*sessions_ht
)
1560 int ret
, send_data
= 0;
1564 struct lttng_viewer_get_packet get_packet_info
;
1565 struct lttng_viewer_trace_packet reply
;
1566 struct relay_viewer_stream
*stream
;
1570 DBG2("Relay get data packet");
1572 if (cmd
->version_check_done
== 0) {
1573 ERR("Trying to get packet before version check");
1578 health_code_update();
1579 ret
= cmd
->sock
->ops
->recvmsg(cmd
->sock
, &get_packet_info
,
1580 sizeof(get_packet_info
), 0);
1581 if (ret
< 0 || ret
!= sizeof(get_packet_info
)) {
1583 ERR("Relay didn't receive the whole packet");
1586 health_code_update();
1588 /* From this point on, the error label can be reached. */
1589 memset(&reply
, 0, sizeof(reply
));
1592 stream
= live_find_viewer_stream_by_id(be64toh(get_packet_info
.stream_id
));
1596 assert(stream
->ctf_trace
);
1599 * First time we read this stream, we need open the tracefile, we should
1600 * only arrive here if an index has already been sent to the viewer, so the
1601 * tracefile must exist, if it does not it is a fatal error.
1603 if (stream
->read_fd
< 0) {
1604 char fullpath
[PATH_MAX
];
1606 if (stream
->tracefile_count
> 0) {
1607 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s_%" PRIu64
, stream
->path_name
,
1608 stream
->channel_name
,
1609 stream
->tracefile_count_current
);
1611 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s", stream
->path_name
,
1612 stream
->channel_name
);
1617 ret
= open(fullpath
, O_RDONLY
);
1619 PERROR("Relay opening trace file");
1622 stream
->read_fd
= ret
;
1625 if (!stream
->ctf_trace
->metadata_received
||
1626 stream
->ctf_trace
->metadata_received
>
1627 stream
->ctf_trace
->metadata_sent
) {
1628 reply
.status
= htobe32(VIEWER_GET_PACKET_ERR
);
1629 reply
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1633 ret
= check_new_streams(stream
->session_id
, sessions_ht
);
1636 } else if (ret
== 1) {
1637 reply
.status
= htobe32(VIEWER_GET_PACKET_ERR
);
1638 reply
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1642 len
= be32toh(get_packet_info
.len
);
1643 data
= zmalloc(len
);
1645 PERROR("relay data zmalloc");
1649 ret
= lseek(stream
->read_fd
, be64toh(get_packet_info
.offset
), SEEK_SET
);
1652 * If the read fd was closed by the streaming side, the
1653 * abort_flag will be set to 1, otherwise it is an error.
1655 if (stream
->abort_flag
== 0) {
1659 reply
.status
= htobe32(VIEWER_GET_PACKET_EOF
);
1662 read_len
= lttng_read(stream
->read_fd
, data
, len
);
1663 if (read_len
< len
) {
1665 * If the read fd was closed by the streaming side, the
1666 * abort_flag will be set to 1, otherwise it is an error.
1668 if (stream
->abort_flag
== 0) {
1669 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1671 be64toh(get_packet_info
.offset
));
1674 reply
.status
= htobe32(VIEWER_GET_PACKET_EOF
);
1678 reply
.status
= htobe32(VIEWER_GET_PACKET_OK
);
1679 reply
.len
= htobe32(len
);
1684 reply
.status
= htobe32(VIEWER_GET_PACKET_ERR
);
1687 reply
.flags
= htobe32(reply
.flags
);
1689 health_code_update();
1690 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &reply
, sizeof(reply
), 0);
1692 ERR("Relay data header to viewer");
1695 health_code_update();
1698 health_code_update();
1699 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, data
, len
, 0);
1701 ERR("Relay send data to viewer");
1704 health_code_update();
1707 DBG("Sent %u bytes for stream %" PRIu64
, len
,
1708 be64toh(get_packet_info
.stream_id
));
1719 * Send the session's metadata
1721 * Return 0 on success else a negative value.
1724 int viewer_get_metadata(struct relay_command
*cmd
)
1730 struct lttng_viewer_get_metadata request
;
1731 struct lttng_viewer_metadata_packet reply
;
1732 struct relay_viewer_stream
*stream
;
1736 DBG("Relay get metadata");
1738 if (cmd
->version_check_done
== 0) {
1739 ERR("Trying to get metadata before version check");
1744 health_code_update();
1745 ret
= cmd
->sock
->ops
->recvmsg(cmd
->sock
, &request
,
1746 sizeof(request
), 0);
1747 if (ret
< 0 || ret
!= sizeof(request
)) {
1749 ERR("Relay didn't receive the whole packet");
1752 health_code_update();
1755 stream
= live_find_viewer_stream_by_id(be64toh(request
.stream_id
));
1756 if (!stream
|| !stream
->metadata_flag
) {
1757 ERR("Invalid metadata stream");
1760 assert(stream
->ctf_trace
);
1761 assert(stream
->ctf_trace
->metadata_sent
<=
1762 stream
->ctf_trace
->metadata_received
);
1764 len
= stream
->ctf_trace
->metadata_received
-
1765 stream
->ctf_trace
->metadata_sent
;
1767 reply
.status
= htobe32(VIEWER_NO_NEW_METADATA
);
1771 /* first time, we open the metadata file */
1772 if (stream
->read_fd
< 0) {
1773 char fullpath
[PATH_MAX
];
1775 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s", stream
->path_name
,
1776 stream
->channel_name
);
1780 ret
= open(fullpath
, O_RDONLY
);
1782 PERROR("Relay opening metadata file");
1785 stream
->read_fd
= ret
;
1788 reply
.len
= htobe64(len
);
1789 data
= zmalloc(len
);
1791 PERROR("viewer metadata zmalloc");
1795 read_len
= lttng_read(stream
->read_fd
, data
, len
);
1796 if (read_len
< len
) {
1797 PERROR("Relay reading metadata file");
1800 stream
->ctf_trace
->metadata_sent
+= read_len
;
1801 reply
.status
= htobe32(VIEWER_METADATA_OK
);
1805 reply
.status
= htobe32(VIEWER_METADATA_ERR
);
1808 health_code_update();
1809 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &reply
, sizeof(reply
), 0);
1811 ERR("Relay data header to viewer");
1814 health_code_update();
1817 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, data
, len
, 0);
1819 ERR("Relay send data to viewer");
1824 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1825 be64toh(request
.stream_id
));
1827 DBG("Metadata sent");
1837 * live_relay_unknown_command: send -1 if received unknown command
1840 void live_relay_unknown_command(struct relay_command
*cmd
)
1842 struct lttcomm_relayd_generic_reply reply
;
1845 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1846 ret
= cmd
->sock
->ops
->sendmsg(cmd
->sock
, &reply
,
1847 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1849 ERR("Relay sending unknown command");
1854 * Process the commands received on the control socket
1857 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1858 struct relay_command
*cmd
, struct lttng_ht
*sessions_ht
)
1862 switch (be32toh(recv_hdr
->cmd
)) {
1863 case VIEWER_CONNECT
:
1864 ret
= viewer_connect(cmd
);
1866 case VIEWER_LIST_SESSIONS
:
1867 ret
= viewer_list_sessions(cmd
, sessions_ht
);
1869 case VIEWER_ATTACH_SESSION
:
1870 ret
= viewer_attach_session(cmd
, sessions_ht
);
1872 case VIEWER_GET_NEXT_INDEX
:
1873 ret
= viewer_get_next_index(cmd
, sessions_ht
);
1875 case VIEWER_GET_PACKET
:
1876 ret
= viewer_get_packet(cmd
, sessions_ht
);
1878 case VIEWER_GET_METADATA
:
1879 ret
= viewer_get_metadata(cmd
);
1881 case VIEWER_GET_NEW_STREAMS
:
1882 ret
= viewer_get_new_streams(cmd
, sessions_ht
);
1885 ERR("Received unknown viewer command (%u)", be32toh(recv_hdr
->cmd
));
1886 live_relay_unknown_command(cmd
);
1896 void cleanup_poll_connection(struct lttng_poll_event
*events
, int pollfd
)
1902 lttng_poll_del(events
, pollfd
);
1904 ret
= close(pollfd
);
1906 ERR("Closing pollfd %d", pollfd
);
1911 * Create and add connection to the given hash table.
1913 * Return poll add value or else -1 on error.
1916 int add_connection(int fd
, struct lttng_poll_event
*events
,
1917 struct lttng_ht
*relay_connections_ht
)
1920 struct relay_command
*relay_connection
;
1923 assert(relay_connections_ht
);
1925 relay_connection
= zmalloc(sizeof(struct relay_command
));
1926 if (relay_connection
== NULL
) {
1927 PERROR("Relay command zmalloc");
1931 ret
= lttng_read(fd
, relay_connection
, sizeof(*relay_connection
));
1932 if (ret
< sizeof(*relay_connection
)) {
1933 PERROR("read relay cmd pipe");
1937 lttng_ht_node_init_ulong(&relay_connection
->sock_n
,
1938 (unsigned long) relay_connection
->sock
->fd
);
1940 lttng_ht_add_unique_ulong(relay_connections_ht
,
1941 &relay_connection
->sock_n
);
1944 return lttng_poll_add(events
, relay_connection
->sock
->fd
,
1945 LPOLLIN
| LPOLLRDHUP
);
1948 free(relay_connection
);
1954 void deferred_free_connection(struct rcu_head
*head
)
1956 struct relay_command
*relay_connection
=
1957 caa_container_of(head
, struct relay_command
, rcu_node
);
1959 if (relay_connection
->session
&&
1960 relay_connection
->session
->viewer_attached
> 0) {
1961 relay_connection
->session
->viewer_attached
--;
1963 lttcomm_destroy_sock(relay_connection
->sock
);
1964 free(relay_connection
);
1968 * Delete all streams for a specific session ID.
1971 void viewer_del_streams(uint64_t session_id
)
1973 struct relay_viewer_stream
*stream
;
1974 struct lttng_ht_iter iter
;
1977 cds_lfht_for_each_entry(viewer_streams_ht
->ht
, &iter
.iter
, stream
,
1979 health_code_update();
1981 if (stream
->session_id
!= session_id
) {
1985 delete_viewer_stream(stream
);
1986 assert(stream
->ctf_trace
);
1988 if (stream
->metadata_flag
) {
1990 * The metadata viewer stream is destroyed once the refcount on the
1991 * ctf trace goes to 0 in the destroy stream function thus there is
1992 * no explicit call to that function here.
1994 stream
->ctf_trace
->metadata_sent
= 0;
1995 stream
->ctf_trace
->viewer_metadata_stream
= NULL
;
1997 destroy_viewer_stream(stream
);
2004 * Delete and free a connection.
2006 * RCU read side lock MUST be acquired.
2009 void del_connection(struct lttng_ht
*relay_connections_ht
,
2010 struct lttng_ht_iter
*iter
, struct relay_command
*relay_connection
)
2014 assert(relay_connections_ht
);
2016 assert(relay_connection
);
2018 DBG("Cleaning connection of session ID %" PRIu64
,
2019 relay_connection
->session_id
);
2021 ret
= lttng_ht_del(relay_connections_ht
, iter
);
2024 viewer_del_streams(relay_connection
->session_id
);
2026 call_rcu(&relay_connection
->rcu_node
, deferred_free_connection
);
2030 * This thread does the actual work
2033 void *thread_worker(void *data
)
2037 struct relay_command
*relay_connection
;
2038 struct lttng_poll_event events
;
2039 struct lttng_ht
*relay_connections_ht
;
2040 struct lttng_ht_node_ulong
*node
;
2041 struct lttng_ht_iter iter
;
2042 struct lttng_viewer_cmd recv_hdr
;
2043 struct relay_local_data
*relay_ctx
= (struct relay_local_data
*) data
;
2044 struct lttng_ht
*sessions_ht
= relay_ctx
->sessions_ht
;
2046 DBG("[thread] Live viewer relay worker started");
2048 rcu_register_thread();
2050 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
2052 if (testpoint(relayd_thread_live_worker
)) {
2053 goto error_testpoint
;
2056 /* table of connections indexed on socket */
2057 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2058 if (!relay_connections_ht
) {
2059 goto relay_connections_ht_error
;
2062 ret
= create_thread_poll_set(&events
, 2);
2064 goto error_poll_create
;
2067 ret
= lttng_poll_add(&events
, live_relay_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2076 health_code_update();
2078 /* Infinite blocking call, waiting for transmission */
2079 DBG3("Relayd live viewer worker thread polling...");
2080 health_poll_entry();
2081 ret
= lttng_poll_wait(&events
, -1);
2085 * Restart interrupted system call.
2087 if (errno
== EINTR
) {
2096 * Process control. The control connection is prioritised so we don't
2097 * starve it with high throughput tracing data on the data
2100 for (i
= 0; i
< nb_fd
; i
++) {
2101 /* Fetch once the poll data */
2102 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2103 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2105 health_code_update();
2107 /* Thread quit pipe has been closed. Killing thread. */
2108 ret
= check_thread_quit_pipe(pollfd
, revents
);
2114 /* Inspect the relay cmd pipe for new connection */
2115 if (pollfd
== live_relay_cmd_pipe
[0]) {
2116 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2117 ERR("Relay live pipe error");
2119 } else if (revents
& LPOLLIN
) {
2120 DBG("Relay live viewer command received");
2121 ret
= add_connection(live_relay_cmd_pipe
[0],
2122 &events
, relay_connections_ht
);
2127 } else if (revents
) {
2129 lttng_ht_lookup(relay_connections_ht
,
2130 (void *)((unsigned long) pollfd
), &iter
);
2131 node
= lttng_ht_iter_get_node_ulong(&iter
);
2133 DBG2("Relay viewer sock %d not found", pollfd
);
2137 relay_connection
= caa_container_of(node
, struct relay_command
,
2140 if (revents
& (LPOLLERR
)) {
2141 cleanup_poll_connection(&events
, pollfd
);
2142 del_connection(relay_connections_ht
, &iter
,
2144 } else if (revents
& (LPOLLHUP
| LPOLLRDHUP
)) {
2145 DBG("Viewer socket %d hung up", pollfd
);
2146 cleanup_poll_connection(&events
, pollfd
);
2147 del_connection(relay_connections_ht
, &iter
,
2149 } else if (revents
& LPOLLIN
) {
2150 ret
= relay_connection
->sock
->ops
->recvmsg(
2151 relay_connection
->sock
, &recv_hdr
,
2152 sizeof(struct lttng_viewer_cmd
),
2154 /* connection closed */
2156 cleanup_poll_connection(&events
, pollfd
);
2157 del_connection(relay_connections_ht
, &iter
,
2159 DBG("Viewer control connection closed with %d",
2162 if (relay_connection
->session
) {
2163 DBG2("Relay viewer worker receiving data for "
2164 "session: %" PRIu64
,
2165 relay_connection
->session
->id
);
2167 ret
= process_control(&recv_hdr
, relay_connection
,
2170 /* Clear the session on error. */
2171 cleanup_poll_connection(&events
, pollfd
);
2172 del_connection(relay_connections_ht
, &iter
,
2174 DBG("Viewer connection closed with %d", pollfd
);
2185 lttng_poll_clean(&events
);
2187 /* empty the hash table and free the memory */
2189 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
, node
, node
) {
2190 health_code_update();
2192 node
= lttng_ht_iter_get_node_ulong(&iter
);
2197 relay_connection
= caa_container_of(node
, struct relay_command
,
2199 del_connection(relay_connections_ht
, &iter
, relay_connection
);
2203 lttng_ht_destroy(relay_connections_ht
);
2204 relay_connections_ht_error
:
2205 /* Close relay cmd pipes */
2206 utils_close_pipe(live_relay_cmd_pipe
);
2208 DBG("Viewer worker thread exited with error");
2210 DBG("Viewer worker thread cleanup complete");
2214 ERR("Health error occurred in %s", __func__
);
2216 health_unregister(health_relayd
);
2218 rcu_unregister_thread();
2223 * Create the relay command pipe to wake thread_manage_apps.
2224 * Closed in cleanup().
2226 static int create_relay_cmd_pipe(void)
2230 ret
= utils_create_pipe_cloexec(live_relay_cmd_pipe
);
2235 void live_stop_threads(void)
2242 ret
= pthread_join(live_listener_thread
, &status
);
2244 PERROR("pthread_join live listener");
2245 goto error
; /* join error, exit without cleanup */
2248 ret
= pthread_join(live_worker_thread
, &status
);
2250 PERROR("pthread_join live worker");
2251 goto error
; /* join error, exit without cleanup */
2254 ret
= pthread_join(live_dispatcher_thread
, &status
);
2256 PERROR("pthread_join live dispatcher");
2257 goto error
; /* join error, exit without cleanup */
2269 int live_start_threads(struct lttng_uri
*uri
,
2270 struct relay_local_data
*relay_ctx
)
2279 /* Check if daemon is UID = 0 */
2280 is_root
= !getuid();
2283 if (live_uri
->port
< 1024) {
2284 ERR("Need to be root to use ports < 1024");
2290 /* Setup the thread apps communication pipe. */
2291 if ((ret
= create_relay_cmd_pipe()) < 0) {
2295 /* Init relay command queue. */
2296 cds_wfq_init(&viewer_cmd_queue
.queue
);
2298 /* Set up max poll set size */
2299 lttng_poll_set_max_size();
2301 /* Setup the dispatcher thread */
2302 ret
= pthread_create(&live_dispatcher_thread
, NULL
,
2303 thread_dispatcher
, (void *) NULL
);
2305 PERROR("pthread_create viewer dispatcher");
2306 goto exit_dispatcher
;
2309 /* Setup the worker thread */
2310 ret
= pthread_create(&live_worker_thread
, NULL
,
2311 thread_worker
, relay_ctx
);
2313 PERROR("pthread_create viewer worker");
2317 /* Setup the listener thread */
2318 ret
= pthread_create(&live_listener_thread
, NULL
,
2319 thread_listener
, (void *) NULL
);
2321 PERROR("pthread_create viewer listener");
2329 ret
= pthread_join(live_listener_thread
, &status
);
2331 PERROR("pthread_join live listener");
2332 goto error
; /* join error, exit without cleanup */
2336 ret
= pthread_join(live_worker_thread
, &status
);
2338 PERROR("pthread_join live worker");
2339 goto error
; /* join error, exit without cleanup */
2343 ret
= pthread_join(live_dispatcher_thread
, &status
);
2345 PERROR("pthread_join live dispatcher");
2346 goto error
; /* join error, exit without cleanup */