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>
56 #include <common/fd-tracker/utils.h>
60 #include "lttng-relayd.h"
62 #include "health-relayd.h"
63 #include "testpoint.h"
64 #include "viewer-stream.h"
67 #include "ctf-trace.h"
68 #include "connection.h"
69 #include "viewer-session.h"
71 #define SESSION_BUF_DEFAULT_COUNT 16
73 static struct lttng_uri
*live_uri
;
76 * This pipe is used to inform the worker thread that a command is queued and
77 * ready to be processed.
79 static int live_conn_pipe
[2] = { -1, -1 };
81 /* Shared between threads */
82 static int live_dispatch_thread_exit
;
84 static pthread_t live_listener_thread
;
85 static pthread_t live_dispatcher_thread
;
86 static pthread_t live_worker_thread
;
89 * Relay command queue.
91 * The live_thread_listener and live_thread_dispatcher communicate with this
94 static struct relay_conn_queue viewer_conn_queue
;
96 static uint64_t last_relay_viewer_session_id
;
97 static pthread_mutex_t last_relay_viewer_session_id_lock
=
98 PTHREAD_MUTEX_INITIALIZER
;
104 void cleanup_relayd_live(void)
112 * Receive a request buffer using a given socket, destination allocated buffer
115 * Return the size of the received message or else a negative value on error
116 * with errno being set by recvmsg() syscall.
119 ssize_t
recv_request(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
123 ret
= sock
->ops
->recvmsg(sock
, buf
, size
, 0);
124 if (ret
< 0 || ret
!= size
) {
126 /* Orderly shutdown. Not necessary to print an error. */
127 DBG("Socket %d did an orderly shutdown", sock
->fd
);
129 ERR("Relay failed to receive request.");
138 * Send a response buffer using a given socket, source allocated buffer of
141 * Return the size of the sent message or else a negative value on error with
142 * errno being set by sendmsg() syscall.
145 ssize_t
send_response(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
149 ret
= sock
->ops
->sendmsg(sock
, buf
, size
, 0);
151 ERR("Relayd failed to send response.");
158 * Atomically check if new streams got added in one of the sessions attached
159 * and reset the flag to 0.
161 * Returns 1 if new streams got added, 0 if nothing changed, a negative value
165 int check_new_streams(struct relay_connection
*conn
)
167 struct relay_session
*session
;
168 unsigned long current_val
;
171 if (!conn
->viewer_session
) {
175 cds_list_for_each_entry_rcu(session
,
176 &conn
->viewer_session
->session_list
,
177 viewer_session_node
) {
178 if (!session_get(session
)) {
181 current_val
= uatomic_cmpxchg(&session
->new_streams
, 1, 0);
183 session_put(session
);
194 * Send viewer streams to the given socket. The ignore_sent_flag indicates if
195 * this function should ignore the sent flag or not.
197 * Return 0 on success or else a negative value.
200 ssize_t
send_viewer_streams(struct lttcomm_sock
*sock
,
201 struct relay_session
*session
, unsigned int ignore_sent_flag
)
204 struct lttng_viewer_stream send_stream
;
205 struct lttng_ht_iter iter
;
206 struct relay_viewer_stream
*vstream
;
210 cds_lfht_for_each_entry(viewer_streams_ht
->ht
, &iter
.iter
, vstream
,
212 struct ctf_trace
*ctf_trace
;
214 health_code_update();
216 if (!viewer_stream_get(vstream
)) {
220 pthread_mutex_lock(&vstream
->stream
->lock
);
221 /* Ignore if not the same session. */
222 if (vstream
->stream
->trace
->session
->id
!= session
->id
||
223 (!ignore_sent_flag
&& vstream
->sent_flag
)) {
224 pthread_mutex_unlock(&vstream
->stream
->lock
);
225 viewer_stream_put(vstream
);
229 ctf_trace
= vstream
->stream
->trace
;
230 send_stream
.id
= htobe64(vstream
->stream
->stream_handle
);
231 send_stream
.ctf_trace_id
= htobe64(ctf_trace
->id
);
232 send_stream
.metadata_flag
= htobe32(
233 vstream
->stream
->is_metadata
);
234 if (lttng_strncpy(send_stream
.path_name
, vstream
->path_name
,
235 sizeof(send_stream
.path_name
))) {
236 pthread_mutex_unlock(&vstream
->stream
->lock
);
237 viewer_stream_put(vstream
);
238 ret
= -1; /* Error. */
241 if (lttng_strncpy(send_stream
.channel_name
,
242 vstream
->channel_name
,
243 sizeof(send_stream
.channel_name
))) {
244 pthread_mutex_unlock(&vstream
->stream
->lock
);
245 viewer_stream_put(vstream
);
246 ret
= -1; /* Error. */
250 DBG("Sending stream %" PRIu64
" to viewer",
251 vstream
->stream
->stream_handle
);
252 vstream
->sent_flag
= 1;
253 pthread_mutex_unlock(&vstream
->stream
->lock
);
255 ret
= send_response(sock
, &send_stream
, sizeof(send_stream
));
256 viewer_stream_put(vstream
);
270 * Create every viewer stream possible for the given session with the seek
271 * type. Three counters *can* be return which are in order the total amount of
272 * viewer stream of the session, the number of unsent stream and the number of
273 * stream created. Those counters can be NULL and thus will be ignored.
275 * Return 0 on success or else a negative value.
278 int make_viewer_streams(struct relay_session
*session
,
279 enum lttng_viewer_seek seek_t
, uint32_t *nb_total
, uint32_t *nb_unsent
,
280 uint32_t *nb_created
, bool *closed
)
283 struct lttng_ht_iter iter
;
284 struct ctf_trace
*ctf_trace
;
289 * Hold the session lock to ensure that we see either none or
290 * all initial streams for a session, but no intermediate state.
292 pthread_mutex_lock(&session
->lock
);
294 if (session
->connection_closed
) {
299 * Create viewer streams for relay streams that are ready to be
300 * used for a the given session id only.
303 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
, &iter
.iter
, ctf_trace
,
305 struct relay_stream
*stream
;
307 health_code_update();
309 if (!ctf_trace_get(ctf_trace
)) {
313 cds_list_for_each_entry_rcu(stream
, &ctf_trace
->stream_list
, stream_node
) {
314 struct relay_viewer_stream
*vstream
;
316 if (!stream_get(stream
)) {
320 * stream published is protected by the session lock.
322 if (!stream
->published
) {
325 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
327 vstream
= viewer_stream_create(stream
, seek_t
);
330 ctf_trace_put(ctf_trace
);
336 /* Update number of created stream counter. */
340 * Ensure a self-reference is preserved even
341 * after we have put our local reference.
343 if (!viewer_stream_get(vstream
)) {
344 ERR("Unable to get self-reference on viewer stream, logic error.");
348 if (!vstream
->sent_flag
&& nb_unsent
) {
349 /* Update number of unsent stream counter. */
353 /* Update number of total stream counter. */
355 if (stream
->is_metadata
) {
356 if (!stream
->closed
||
357 stream
->metadata_received
> vstream
->metadata_sent
) {
361 if (!stream
->closed
||
362 !(((int64_t) (stream
->prev_seq
- stream
->last_net_seq_num
)) >= 0)) {
368 /* Put local reference. */
369 viewer_stream_put(vstream
);
373 ctf_trace_put(ctf_trace
);
380 pthread_mutex_unlock(&session
->lock
);
384 int relayd_live_stop(void)
386 /* Stop dispatch thread */
387 CMM_STORE_SHARED(live_dispatch_thread_exit
, 1);
388 futex_nto1_wake(&viewer_conn_queue
.futex
);
393 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
396 int create_named_thread_poll_set(struct lttng_poll_event
*events
,
397 int size
, const char *name
)
401 if (events
== NULL
|| size
== 0) {
406 ret
= fd_tracker_util_poll_create(the_fd_tracker
,
407 name
, events
, 1, LTTNG_CLOEXEC
);
410 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
422 * Check if the thread quit pipe was triggered.
424 * Return 1 if it was triggered else 0;
427 int check_thread_quit_pipe(int fd
, uint32_t events
)
429 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
437 int create_sock(void *data
, int *out_fd
)
440 struct lttcomm_sock
*sock
= data
;
442 ret
= lttcomm_create_sock(sock
);
453 int close_sock(void *data
, int *in_fd
)
455 struct lttcomm_sock
*sock
= data
;
457 return sock
->ops
->close(sock
);
460 static int accept_sock(void *data
, int *out_fd
)
463 /* Socks is an array of in_sock, out_sock. */
464 struct lttcomm_sock
**socks
= data
;
465 struct lttcomm_sock
*in_sock
= socks
[0];
467 socks
[1] = in_sock
->ops
->accept(in_sock
);
472 *out_fd
= socks
[1]->fd
;
478 struct lttcomm_sock
*accept_live_sock(struct lttcomm_sock
*listening_sock
,
482 struct lttcomm_sock
*socks
[2] = { listening_sock
, NULL
};
483 struct lttcomm_sock
*new_sock
= NULL
;
485 ret
= fd_tracker_open_unsuspendable_fd(
486 the_fd_tracker
, &out_fd
,
487 (const char **) &name
,
488 1, accept_sock
, &socks
);
493 DBG("%s accepted, socket %d", name
, new_sock
->fd
);
499 * Create and init socket from uri.
502 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
, const char *name
)
505 struct lttcomm_sock
*sock
= NULL
;
506 char uri_str
[PATH_MAX
];
507 char *formated_name
= NULL
;
509 sock
= lttcomm_alloc_sock_from_uri(uri
);
511 ERR("Allocating socket");
516 * Don't fail to create the socket if the name can't be built as it is
517 * only used for debugging purposes.
519 ret
= uri_to_str_url(uri
, uri_str
, sizeof(uri_str
));
520 uri_str
[sizeof(uri_str
) - 1] = '\0';
522 ret
= asprintf(&formated_name
, "%s socket @ %s", name
,
525 formated_name
= NULL
;
529 ret
= fd_tracker_open_unsuspendable_fd(the_fd_tracker
, &sock_fd
,
530 (const char **) (formated_name
? &formated_name
: NULL
),
531 1, create_sock
, sock
);
533 DBG("Listening on %s socket %d", name
, sock
->fd
);
535 ret
= sock
->ops
->bind(sock
);
537 PERROR("Failed to bind lttng-live socket");
541 ret
= sock
->ops
->listen(sock
, -1);
551 lttcomm_destroy_sock(sock
);
557 * This thread manages the listening for new connections on the network
560 void *thread_listener(void *data
)
562 int i
, ret
, pollfd
, err
= -1;
563 uint32_t revents
, nb_fd
;
564 struct lttng_poll_event events
;
565 struct lttcomm_sock
*live_control_sock
;
567 DBG("[thread] Relay live listener started");
569 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
571 health_code_update();
573 live_control_sock
= init_socket(live_uri
, "Live listener");
574 if (!live_control_sock
) {
575 goto error_sock_control
;
578 /* Pass 2 as size here for the thread quit pipe and control sockets. */
579 ret
= create_named_thread_poll_set(&events
, 2,
580 "Live listener thread epoll");
582 goto error_create_poll
;
585 /* Add the control socket */
586 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
591 lttng_relay_notify_ready();
593 if (testpoint(relayd_thread_live_listener
)) {
594 goto error_testpoint
;
598 health_code_update();
600 DBG("Listener accepting live viewers connections");
604 ret
= lttng_poll_wait(&events
, -1);
608 * Restart interrupted system call.
610 if (errno
== EINTR
) {
617 DBG("Relay new viewer connection received");
618 for (i
= 0; i
< nb_fd
; i
++) {
619 health_code_update();
621 /* Fetch once the poll data */
622 revents
= LTTNG_POLL_GETEV(&events
, i
);
623 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
626 /* No activity for this FD (poll implementation). */
630 /* Thread quit pipe has been closed. Killing thread. */
631 ret
= check_thread_quit_pipe(pollfd
, revents
);
637 if (revents
& LPOLLIN
) {
639 * A new connection is requested, therefore a
640 * viewer connection is allocated in this
641 * thread, enqueued to a global queue and
642 * dequeued (and freed) in the worker thread.
645 struct relay_connection
*new_conn
;
646 struct lttcomm_sock
*newsock
;
648 newsock
= accept_live_sock(live_control_sock
,
649 "Live socket to client");
651 PERROR("accepting control sock");
654 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
656 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
659 PERROR("setsockopt inet");
660 lttcomm_destroy_sock(newsock
);
663 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
665 lttcomm_destroy_sock(newsock
);
668 /* Ownership assumed by the connection. */
671 /* Enqueue request for the dispatcher thread. */
672 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
676 * Wake the dispatch queue futex.
677 * Implicit memory barrier with the
678 * exchange in cds_wfcq_enqueue.
680 futex_nto1_wake(&viewer_conn_queue
.futex
);
681 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
682 ERR("socket poll error");
685 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
695 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
697 if (live_control_sock
->fd
>= 0) {
698 ret
= fd_tracker_close_unsuspendable_fd(the_fd_tracker
,
699 &live_control_sock
->fd
, 1, close_sock
,
705 lttcomm_destroy_sock(live_control_sock
);
709 DBG("Live viewer listener thread exited with error");
711 health_unregister(health_relayd
);
712 DBG("Live viewer listener thread cleanup complete");
713 if (lttng_relay_stop_threads()) {
714 ERR("Error stopping threads");
720 * This thread manages the dispatching of the requests to worker threads
723 void *thread_dispatcher(void *data
)
727 struct cds_wfcq_node
*node
;
728 struct relay_connection
*conn
= NULL
;
730 DBG("[thread] Live viewer relay dispatcher started");
732 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
734 if (testpoint(relayd_thread_live_dispatcher
)) {
735 goto error_testpoint
;
738 health_code_update();
741 health_code_update();
743 /* Atomically prepare the queue futex */
744 futex_nto1_prepare(&viewer_conn_queue
.futex
);
746 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
751 health_code_update();
753 /* Dequeue commands */
754 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
755 &viewer_conn_queue
.tail
);
757 DBG("Woken up but nothing in the live-viewer "
758 "relay command queue");
759 /* Continue thread execution */
762 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
763 DBG("Dispatching viewer request waiting on sock %d",
767 * Inform worker thread of the new request. This
768 * call is blocking so we can be assured that
769 * the data will be read at some point in time
770 * or wait to the end of the world :)
772 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
774 PERROR("write conn pipe");
775 connection_put(conn
);
778 } while (node
!= NULL
);
780 /* Futex wait on queue. Blocking call on futex() */
782 futex_nto1_wait(&viewer_conn_queue
.futex
);
786 /* Normal exit, no error */
793 ERR("Health error occurred in %s", __func__
);
795 health_unregister(health_relayd
);
796 DBG("Live viewer dispatch thread dying");
797 if (lttng_relay_stop_threads()) {
798 ERR("Error stopping threads");
804 * Establish connection with the viewer and check the versions.
806 * Return 0 on success or else negative value.
809 int viewer_connect(struct relay_connection
*conn
)
812 struct lttng_viewer_connect reply
, msg
;
814 conn
->version_check_done
= 1;
816 health_code_update();
818 DBG("Viewer is establishing a connection to the relayd.");
820 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
825 health_code_update();
827 memset(&reply
, 0, sizeof(reply
));
828 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
829 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
831 /* Major versions must be the same */
832 if (reply
.major
!= be32toh(msg
.major
)) {
833 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
834 reply
.major
, be32toh(msg
.major
));
839 conn
->major
= reply
.major
;
840 /* We adapt to the lowest compatible version */
841 if (reply
.minor
<= be32toh(msg
.minor
)) {
842 conn
->minor
= reply
.minor
;
844 conn
->minor
= be32toh(msg
.minor
);
847 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
848 conn
->type
= RELAY_VIEWER_COMMAND
;
849 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
850 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
852 ERR("Unknown connection type : %u", be32toh(msg
.type
));
857 reply
.major
= htobe32(reply
.major
);
858 reply
.minor
= htobe32(reply
.minor
);
859 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
861 * Increment outside of htobe64 macro, because the argument can
862 * be used more than once within the macro, and thus the
863 * operation may be undefined.
865 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
866 last_relay_viewer_session_id
++;
867 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
868 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
871 health_code_update();
873 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
878 health_code_update();
880 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
888 * Send the viewer the list of current sessions.
889 * We need to create a copy of the hash table content because otherwise
890 * we cannot assume the number of entries stays the same between getting
891 * the number of HT elements and iteration over the HT.
893 * Return 0 on success or else a negative value.
896 int viewer_list_sessions(struct relay_connection
*conn
)
899 struct lttng_viewer_list_sessions session_list
;
900 struct lttng_ht_iter iter
;
901 struct relay_session
*session
;
902 struct lttng_viewer_session
*send_session_buf
= NULL
;
903 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
906 DBG("List sessions received");
908 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
909 if (!send_session_buf
) {
914 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
916 struct lttng_viewer_session
*send_session
;
918 health_code_update();
920 if (count
>= buf_count
) {
921 struct lttng_viewer_session
*newbuf
;
922 uint32_t new_buf_count
= buf_count
<< 1;
924 newbuf
= realloc(send_session_buf
,
925 new_buf_count
* sizeof(*send_session_buf
));
930 send_session_buf
= newbuf
;
931 buf_count
= new_buf_count
;
933 send_session
= &send_session_buf
[count
];
934 if (lttng_strncpy(send_session
->session_name
,
935 session
->session_name
,
936 sizeof(send_session
->session_name
))) {
940 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
941 sizeof(send_session
->hostname
))) {
945 send_session
->id
= htobe64(session
->id
);
946 send_session
->live_timer
= htobe32(session
->live_timer
);
947 if (session
->viewer_attached
) {
948 send_session
->clients
= htobe32(1);
950 send_session
->clients
= htobe32(0);
952 send_session
->streams
= htobe32(session
->stream_count
);
960 session_list
.sessions_count
= htobe32(count
);
962 health_code_update();
964 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
969 health_code_update();
971 ret
= send_response(conn
->sock
, send_session_buf
,
972 count
* sizeof(*send_session_buf
));
976 health_code_update();
980 free(send_session_buf
);
985 * Send the viewer the list of current streams.
988 int viewer_get_new_streams(struct relay_connection
*conn
)
990 int ret
, send_streams
= 0;
991 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
992 struct lttng_viewer_new_streams_request request
;
993 struct lttng_viewer_new_streams_response response
;
994 struct relay_session
*session
;
1000 DBG("Get new streams received");
1002 health_code_update();
1004 /* Receive the request from the connected client. */
1005 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1009 session_id
= be64toh(request
.session_id
);
1011 health_code_update();
1013 memset(&response
, 0, sizeof(response
));
1015 session
= session_get_by_id(session_id
);
1017 DBG("Relay session %" PRIu64
" not found", session_id
);
1018 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
1022 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
1024 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
1029 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
1031 ret
= make_viewer_streams(session
, LTTNG_VIEWER_SEEK_LAST
, &nb_total
, &nb_unsent
,
1032 &nb_created
, &closed
);
1034 goto end_put_session
;
1036 /* Only send back the newly created streams with the unsent ones. */
1037 nb_streams
= nb_created
+ nb_unsent
;
1038 response
.streams_count
= htobe32(nb_streams
);
1041 * If the session is closed, HUP when there are no more streams
1044 if (closed
&& nb_total
== 0) {
1046 response
.streams_count
= 0;
1047 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
1052 health_code_update();
1053 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1055 goto end_put_session
;
1057 health_code_update();
1060 * Unknown or empty session, just return gracefully, the viewer
1061 * knows what is happening.
1063 if (!send_streams
|| !nb_streams
) {
1065 goto end_put_session
;
1069 * Send stream and *DON'T* ignore the sent flag so every viewer
1070 * streams that were not sent from that point will be sent to
1073 ret
= send_viewer_streams(conn
->sock
, session
, 0);
1075 goto end_put_session
;
1080 session_put(session
);
1087 * Send the viewer the list of current sessions.
1090 int viewer_attach_session(struct relay_connection
*conn
)
1092 int send_streams
= 0;
1094 uint32_t nb_streams
= 0;
1095 enum lttng_viewer_seek seek_type
;
1096 struct lttng_viewer_attach_session_request request
;
1097 struct lttng_viewer_attach_session_response response
;
1098 struct relay_session
*session
= NULL
;
1099 bool closed
= false;
1103 health_code_update();
1105 /* Receive the request from the connected client. */
1106 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1111 health_code_update();
1113 memset(&response
, 0, sizeof(response
));
1115 if (!conn
->viewer_session
) {
1116 DBG("Client trying to attach before creating a live viewer session");
1117 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1121 session
= session_get_by_id(be64toh(request
.session_id
));
1123 DBG("Relay session %" PRIu64
" not found",
1124 (uint64_t) be64toh(request
.session_id
));
1125 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1128 DBG("Attach session ID %" PRIu64
" received",
1129 (uint64_t) be64toh(request
.session_id
));
1131 if (session
->live_timer
== 0) {
1132 DBG("Not live session");
1133 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1138 ret
= viewer_session_attach(conn
->viewer_session
, session
);
1140 DBG("Already a viewer attached");
1141 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_ALREADY
);
1145 switch (be32toh(request
.seek
)) {
1146 case LTTNG_VIEWER_SEEK_BEGINNING
:
1147 case LTTNG_VIEWER_SEEK_LAST
:
1148 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1149 seek_type
= be32toh(request
.seek
);
1152 ERR("Wrong seek parameter");
1153 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1158 ret
= make_viewer_streams(session
, seek_type
, &nb_streams
, NULL
,
1161 goto end_put_session
;
1163 response
.streams_count
= htobe32(nb_streams
);
1166 * If the session is closed when the viewer is attaching, it
1167 * means some of the streams may have been concurrently removed,
1168 * so we don't allow the viewer to attach, even if there are
1169 * streams available.
1173 response
.streams_count
= 0;
1174 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
1179 health_code_update();
1180 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1182 goto end_put_session
;
1184 health_code_update();
1187 * Unknown or empty session, just return gracefully, the viewer
1188 * knows what is happening.
1190 if (!send_streams
|| !nb_streams
) {
1192 goto end_put_session
;
1195 /* Send stream and ignore the sent flag. */
1196 ret
= send_viewer_streams(conn
->sock
, session
, 1);
1198 goto end_put_session
;
1203 session_put(session
);
1210 * Open the index file if needed for the given vstream.
1212 * If an index file is successfully opened, the vstream will set it as its
1213 * current index file.
1215 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1217 * Called with rstream lock held.
1219 static int try_open_index(struct relay_viewer_stream
*vstream
,
1220 struct relay_stream
*rstream
)
1224 if (vstream
->index_file
) {
1229 * First time, we open the index file and at least one index is ready.
1231 if (rstream
->index_received_seqcount
== 0) {
1235 vstream
->index_file
= lttng_index_file_open(vstream
->path_name
,
1236 vstream
->channel_name
,
1237 vstream
->stream
->tracefile_count
,
1238 vstream
->current_tracefile_id
);
1239 if (!vstream
->index_file
) {
1248 * Check the status of the index for the given stream. This function
1249 * updates the index structure if needed and can put (close) the vstream
1250 * in the HUP situation.
1252 * Return 0 means that we can proceed with the index. A value of 1 means
1253 * that the index has been updated and is ready to be sent to the
1254 * client. A negative value indicates an error that can't be handled.
1256 * Called with rstream lock held.
1258 static int check_index_status(struct relay_viewer_stream
*vstream
,
1259 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1260 struct lttng_viewer_index
*index
)
1264 if ((trace
->session
->connection_closed
|| rstream
->closed
)
1265 && rstream
->index_received_seqcount
1266 == vstream
->index_sent_seqcount
) {
1268 * Last index sent and session connection or relay
1269 * stream are closed.
1271 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1273 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1274 rstream
->index_received_seqcount
1275 == vstream
->index_sent_seqcount
) {
1277 * We've received a synchronization beacon and the last index
1278 * available has been sent, the index for now is inactive.
1280 * In this case, we have received a beacon which allows us to
1281 * inform the client of a time interval during which we can
1282 * guarantee that there are no events to read (and never will
1285 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1286 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1287 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1289 } else if (rstream
->index_received_seqcount
1290 == vstream
->index_sent_seqcount
) {
1292 * This checks whether received == sent seqcount. In
1293 * this case, we have not received a beacon. Therefore,
1294 * we can only ask the client to retry later.
1296 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1298 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1299 vstream
->current_tracefile_id
,
1300 vstream
->index_sent_seqcount
)) {
1302 * The next index we want to send cannot be read either
1303 * because we need to perform a rotation, or due to
1304 * the producer having overwritten its trace file.
1306 DBG("Viewer stream %" PRIu64
" rotation",
1307 vstream
->stream
->stream_handle
);
1308 ret
= viewer_stream_rotate(vstream
);
1311 } else if (ret
== 1) {
1312 /* EOF across entire stream. */
1313 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1317 * If we have been pushed due to overwrite, it
1318 * necessarily means there is data that can be read in
1319 * the stream. If we rotated because we reached the end
1320 * of a tracefile, it means the following tracefile
1321 * needs to contain at least one index, else we would
1322 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1323 * viewer. The updated index_sent_seqcount needs to
1324 * point to a readable index entry now.
1326 * In the case where we "rotate" on a single file, we
1327 * can end up in a case where the requested index is
1328 * still unavailable.
1330 if (rstream
->tracefile_count
== 1 &&
1331 !tracefile_array_seq_in_file(
1333 vstream
->current_tracefile_id
,
1334 vstream
->index_sent_seqcount
)) {
1335 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1338 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1339 vstream
->current_tracefile_id
,
1340 vstream
->index_sent_seqcount
));
1342 /* ret == 0 means successful so we continue. */
1348 viewer_stream_put(vstream
);
1354 * Send the next index for a stream.
1356 * Return 0 on success or else a negative value.
1359 int viewer_get_next_index(struct relay_connection
*conn
)
1362 struct lttng_viewer_get_next_index request_index
;
1363 struct lttng_viewer_index viewer_index
;
1364 struct ctf_packet_index packet_index
;
1365 struct relay_viewer_stream
*vstream
= NULL
;
1366 struct relay_stream
*rstream
= NULL
;
1367 struct ctf_trace
*ctf_trace
= NULL
;
1368 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1372 DBG("Viewer get next index");
1374 memset(&viewer_index
, 0, sizeof(viewer_index
));
1375 health_code_update();
1377 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1381 health_code_update();
1383 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1385 DBG("Client requested index of unknown stream id %" PRIu64
,
1386 (uint64_t) be64toh(request_index
.stream_id
));
1387 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1391 /* Use back. ref. Protected by refcounts. */
1392 rstream
= vstream
->stream
;
1393 ctf_trace
= rstream
->trace
;
1395 /* metadata_viewer_stream may be NULL. */
1396 metadata_viewer_stream
=
1397 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1399 pthread_mutex_lock(&rstream
->lock
);
1402 * The viewer should not ask for index on metadata stream.
1404 if (rstream
->is_metadata
) {
1405 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1409 /* Try to open an index if one is needed for that stream. */
1410 ret
= try_open_index(vstream
, rstream
);
1412 if (ret
== -ENOENT
) {
1414 * The index is created only when the first data
1415 * packet arrives, it might not be ready at the
1416 * beginning of the session
1418 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1420 /* Unhandled error. */
1421 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1426 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1429 } else if (ret
== 1) {
1431 * We have no index to send and check_index_status has populated
1432 * viewer_index's status.
1436 /* At this point, ret is 0 thus we will be able to read the index. */
1440 * vstream->stream_fd may be NULL if it has been closed by
1441 * tracefile rotation, or if we are at the beginning of the
1442 * stream. We open the data stream file here to protect against
1443 * overwrite caused by tracefile rotation (in association with
1444 * unlink performed before overwrite).
1446 if (!vstream
->stream_fd
) {
1447 char fullpath
[PATH_MAX
];
1449 if (vstream
->stream
->tracefile_count
> 0) {
1450 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s_%" PRIu64
,
1452 vstream
->channel_name
,
1453 vstream
->current_tracefile_id
);
1455 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s",
1457 vstream
->channel_name
);
1463 vstream
->stream_fd
= stream_fd_open(fullpath
);
1464 if (!vstream
->stream_fd
) {
1472 ret
= check_new_streams(conn
);
1474 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1476 } else if (ret
== 1) {
1477 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1480 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1482 ERR("Relay error reading index file %d",
1483 vstream
->index_file
->fd
);
1484 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1487 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1488 vstream
->index_sent_seqcount
++;
1492 * Indexes are stored in big endian, no need to switch before sending.
1494 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1495 rstream
->stream_handle
,
1496 (uint64_t) be64toh(packet_index
.offset
));
1497 viewer_index
.offset
= packet_index
.offset
;
1498 viewer_index
.packet_size
= packet_index
.packet_size
;
1499 viewer_index
.content_size
= packet_index
.content_size
;
1500 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1501 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1502 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1503 viewer_index
.stream_id
= packet_index
.stream_id
;
1507 pthread_mutex_unlock(&rstream
->lock
);
1510 if (metadata_viewer_stream
) {
1511 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1512 DBG("get next index metadata check: recv %" PRIu64
1514 metadata_viewer_stream
->stream
->metadata_received
,
1515 metadata_viewer_stream
->metadata_sent
);
1516 if (!metadata_viewer_stream
->stream
->metadata_received
||
1517 metadata_viewer_stream
->stream
->metadata_received
>
1518 metadata_viewer_stream
->metadata_sent
) {
1519 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1521 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1524 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1525 health_code_update();
1527 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1531 health_code_update();
1534 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1535 vstream
->index_sent_seqcount
,
1536 vstream
->stream
->stream_handle
);
1539 if (metadata_viewer_stream
) {
1540 viewer_stream_put(metadata_viewer_stream
);
1543 viewer_stream_put(vstream
);
1548 pthread_mutex_unlock(&rstream
->lock
);
1549 if (metadata_viewer_stream
) {
1550 viewer_stream_put(metadata_viewer_stream
);
1552 viewer_stream_put(vstream
);
1557 * Send the next index for a stream
1559 * Return 0 on success or else a negative value.
1562 int viewer_get_packet(struct relay_connection
*conn
)
1567 struct lttng_viewer_get_packet get_packet_info
;
1568 struct lttng_viewer_trace_packet reply_header
;
1569 struct relay_viewer_stream
*vstream
= NULL
;
1570 uint32_t reply_size
= sizeof(reply_header
);
1571 uint32_t packet_data_len
= 0;
1574 DBG2("Relay get data packet");
1576 health_code_update();
1578 ret
= recv_request(conn
->sock
, &get_packet_info
,
1579 sizeof(get_packet_info
));
1583 health_code_update();
1585 /* From this point on, the error label can be reached. */
1586 memset(&reply_header
, 0, sizeof(reply_header
));
1588 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1590 DBG("Client requested packet of unknown stream id %" PRIu64
,
1591 (uint64_t) be64toh(get_packet_info
.stream_id
));
1592 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1593 goto send_reply_nolock
;
1595 packet_data_len
= be32toh(get_packet_info
.len
);
1596 reply_size
+= packet_data_len
;
1599 reply
= zmalloc(reply_size
);
1601 PERROR("packet reply zmalloc");
1602 reply_size
= sizeof(reply_header
);
1606 pthread_mutex_lock(&vstream
->stream
->lock
);
1607 stream_fd
= stream_fd_get_fd(vstream
->stream_fd
);
1608 if (stream_fd
< 0) {
1609 ERR("Failed to get viewer stream file descriptor");
1612 lseek_ret
= lseek(stream_fd
, be64toh(get_packet_info
.offset
), SEEK_SET
);
1613 if (lseek_ret
< 0) {
1614 PERROR("lseek fd %d to offset %" PRIu64
, stream_fd
,
1615 (uint64_t) be64toh(get_packet_info
.offset
));
1618 read_len
= lttng_read(stream_fd
,
1619 reply
+ sizeof(reply_header
),
1621 if (read_len
< packet_data_len
) {
1622 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1624 (uint64_t) be64toh(get_packet_info
.offset
));
1627 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1628 reply_header
.len
= htobe32(packet_data_len
);
1632 stream_fd_put_fd(vstream
->stream_fd
);
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
)
1679 int ret
= 0, stream_fd
= -1;
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_fd
) {
1732 char fullpath
[PATH_MAX
];
1734 ret
= snprintf(fullpath
, PATH_MAX
, "%s/%s", vstream
->path_name
,
1735 vstream
->channel_name
);
1739 vstream
->stream_fd
= stream_fd_open(fullpath
);
1740 if (!vstream
->stream_fd
) {
1741 PERROR("Failed to open viewer stream file at %s", fullpath
);
1746 reply
.len
= htobe64(len
);
1747 data
= zmalloc(len
);
1749 PERROR("viewer metadata zmalloc");
1753 stream_fd
= stream_fd_get_fd(vstream
->stream_fd
);
1754 if (stream_fd
< 0) {
1757 read_len
= lttng_read(stream_fd
, data
, len
);
1758 if (read_len
< len
) {
1759 PERROR("Relay reading metadata file");
1762 vstream
->metadata_sent
+= read_len
;
1763 if (vstream
->metadata_sent
== vstream
->stream
->metadata_received
1764 && vstream
->stream
->closed
) {
1765 /* Release ownership for the viewer metadata stream. */
1766 viewer_stream_put(vstream
);
1769 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1773 (void) stream_fd_put_fd(vstream
->stream_fd
);
1775 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1778 health_code_update();
1780 pthread_mutex_unlock(&vstream
->stream
->lock
);
1782 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1786 health_code_update();
1789 ret
= send_response(conn
->sock
, data
, len
);
1795 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1796 (uint64_t) be64toh(request
.stream_id
));
1798 DBG("Metadata sent");
1804 viewer_stream_put(vstream
);
1810 * Create a viewer session.
1812 * Return 0 on success or else a negative value.
1815 int viewer_create_session(struct relay_connection
*conn
)
1818 struct lttng_viewer_create_session_response resp
;
1820 DBG("Viewer create session received");
1822 memset(&resp
, 0, sizeof(resp
));
1823 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
1824 conn
->viewer_session
= viewer_session_create();
1825 if (!conn
->viewer_session
) {
1826 ERR("Allocation viewer session");
1827 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
1832 health_code_update();
1833 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
1837 health_code_update();
1845 * Detach a viewer session.
1847 * Return 0 on success or else a negative value.
1850 int viewer_detach_session(struct relay_connection
*conn
)
1853 struct lttng_viewer_detach_session_response response
;
1854 struct lttng_viewer_detach_session_request request
;
1855 struct relay_session
*session
= NULL
;
1856 uint64_t viewer_session_to_close
;
1858 DBG("Viewer detach session received");
1862 health_code_update();
1864 /* Receive the request from the connected client. */
1865 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1869 viewer_session_to_close
= be64toh(request
.session_id
);
1871 if (!conn
->viewer_session
) {
1872 DBG("Client trying to detach before creating a live viewer session");
1873 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1877 health_code_update();
1879 memset(&response
, 0, sizeof(response
));
1880 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
1882 session
= session_get_by_id(be64toh(request
.session_id
));
1884 DBG("Relay session %" PRIu64
" not found",
1885 (uint64_t) be64toh(request
.session_id
));
1886 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
1890 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
1892 DBG("Not attached to this session");
1893 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
1894 goto send_reply_put
;
1897 viewer_session_close_one_session(conn
->viewer_session
, session
);
1898 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
1899 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
1902 session_put(session
);
1905 health_code_update();
1906 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1910 health_code_update();
1918 * live_relay_unknown_command: send -1 if received unknown command
1921 void live_relay_unknown_command(struct relay_connection
*conn
)
1923 struct lttcomm_relayd_generic_reply reply
;
1925 memset(&reply
, 0, sizeof(reply
));
1926 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1927 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
1931 * Process the commands received on the control socket
1934 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
1935 struct relay_connection
*conn
)
1940 msg_value
= be32toh(recv_hdr
->cmd
);
1943 * Make sure we've done the version check before any command other then a
1944 * new client connection.
1946 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
1947 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
1952 switch (msg_value
) {
1953 case LTTNG_VIEWER_CONNECT
:
1954 ret
= viewer_connect(conn
);
1956 case LTTNG_VIEWER_LIST_SESSIONS
:
1957 ret
= viewer_list_sessions(conn
);
1959 case LTTNG_VIEWER_ATTACH_SESSION
:
1960 ret
= viewer_attach_session(conn
);
1962 case LTTNG_VIEWER_GET_NEXT_INDEX
:
1963 ret
= viewer_get_next_index(conn
);
1965 case LTTNG_VIEWER_GET_PACKET
:
1966 ret
= viewer_get_packet(conn
);
1968 case LTTNG_VIEWER_GET_METADATA
:
1969 ret
= viewer_get_metadata(conn
);
1971 case LTTNG_VIEWER_GET_NEW_STREAMS
:
1972 ret
= viewer_get_new_streams(conn
);
1974 case LTTNG_VIEWER_CREATE_SESSION
:
1975 ret
= viewer_create_session(conn
);
1977 case LTTNG_VIEWER_DETACH_SESSION
:
1978 ret
= viewer_detach_session(conn
);
1981 ERR("Received unknown viewer command (%u)",
1982 be32toh(recv_hdr
->cmd
));
1983 live_relay_unknown_command(conn
);
1993 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
1997 (void) lttng_poll_del(events
, pollfd
);
1999 ret
= fd_tracker_close_unsuspendable_fd(the_fd_tracker
, &pollfd
, 1,
2000 fd_tracker_util_close_fd
, NULL
);
2002 ERR("Closing pollfd %d", pollfd
);
2007 * This thread does the actual work
2010 void *thread_worker(void *data
)
2014 struct lttng_poll_event events
;
2015 struct lttng_ht
*viewer_connections_ht
;
2016 struct lttng_ht_iter iter
;
2017 struct lttng_viewer_cmd recv_hdr
;
2018 struct relay_connection
*destroy_conn
;
2020 DBG("[thread] Live viewer relay worker started");
2022 rcu_register_thread();
2024 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
2026 if (testpoint(relayd_thread_live_worker
)) {
2027 goto error_testpoint
;
2030 /* table of connections indexed on socket */
2031 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2032 if (!viewer_connections_ht
) {
2033 goto viewer_connections_ht_error
;
2036 ret
= create_named_thread_poll_set(&events
, 2,
2037 "Live viewer worker thread epoll");
2039 goto error_poll_create
;
2042 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2051 health_code_update();
2053 /* Infinite blocking call, waiting for transmission */
2054 DBG3("Relayd live viewer worker thread polling...");
2055 health_poll_entry();
2056 ret
= lttng_poll_wait(&events
, -1);
2060 * Restart interrupted system call.
2062 if (errno
== EINTR
) {
2071 * Process control. The control connection is prioritised so we don't
2072 * starve it with high throughput tracing data on the data
2075 for (i
= 0; i
< nb_fd
; i
++) {
2076 /* Fetch once the poll data */
2077 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2078 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2080 health_code_update();
2083 /* No activity for this FD (poll implementation). */
2087 /* Thread quit pipe has been closed. Killing thread. */
2088 ret
= check_thread_quit_pipe(pollfd
, revents
);
2094 /* Inspect the relay conn pipe for new connection. */
2095 if (pollfd
== live_conn_pipe
[0]) {
2096 if (revents
& LPOLLIN
) {
2097 struct relay_connection
*conn
;
2099 ret
= lttng_read(live_conn_pipe
[0],
2100 &conn
, sizeof(conn
));
2104 lttng_poll_add(&events
, conn
->sock
->fd
,
2105 LPOLLIN
| LPOLLRDHUP
);
2106 connection_ht_add(viewer_connections_ht
, conn
);
2107 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2108 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2109 ERR("Relay live pipe error");
2112 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2116 /* Connection activity. */
2117 struct relay_connection
*conn
;
2119 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2124 if (revents
& LPOLLIN
) {
2125 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2126 sizeof(recv_hdr
), 0);
2128 /* Connection closed. */
2129 cleanup_connection_pollfd(&events
, pollfd
);
2130 /* Put "create" ownership reference. */
2131 connection_put(conn
);
2132 DBG("Viewer control conn closed with %d", pollfd
);
2134 ret
= process_control(&recv_hdr
, conn
);
2136 /* Clear the session on error. */
2137 cleanup_connection_pollfd(&events
, pollfd
);
2138 /* Put "create" ownership reference. */
2139 connection_put(conn
);
2140 DBG("Viewer connection closed with %d", pollfd
);
2143 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2144 cleanup_connection_pollfd(&events
, pollfd
);
2145 /* Put "create" ownership reference. */
2146 connection_put(conn
);
2148 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2149 connection_put(conn
);
2152 /* Put local "get_by_sock" reference. */
2153 connection_put(conn
);
2160 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
2162 /* Cleanup remaining connection object. */
2164 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2167 health_code_update();
2168 connection_put(destroy_conn
);
2172 lttng_ht_destroy(viewer_connections_ht
);
2173 viewer_connections_ht_error
:
2174 /* Close relay conn pipes */
2175 (void) fd_tracker_util_pipe_close(the_fd_tracker
, live_conn_pipe
);
2177 DBG("Viewer worker thread exited with error");
2179 DBG("Viewer worker thread cleanup complete");
2183 ERR("Health error occurred in %s", __func__
);
2185 health_unregister(health_relayd
);
2186 if (lttng_relay_stop_threads()) {
2187 ERR("Error stopping threads");
2189 rcu_unregister_thread();
2194 * Create the relay command pipe to wake thread_manage_apps.
2195 * Closed in cleanup().
2197 static int create_conn_pipe(void)
2199 return fd_tracker_util_pipe_open_cloexec(the_fd_tracker
,
2200 "Live connection pipe", live_conn_pipe
);
2203 int relayd_live_join(void)
2205 int ret
, retval
= 0;
2208 ret
= pthread_join(live_listener_thread
, &status
);
2211 PERROR("pthread_join live listener");
2215 ret
= pthread_join(live_worker_thread
, &status
);
2218 PERROR("pthread_join live worker");
2222 ret
= pthread_join(live_dispatcher_thread
, &status
);
2225 PERROR("pthread_join live dispatcher");
2229 cleanup_relayd_live();
2237 int relayd_live_create(struct lttng_uri
*uri
)
2239 int ret
= 0, retval
= 0;
2245 goto exit_init_data
;
2249 /* Check if daemon is UID = 0 */
2250 is_root
= !getuid();
2253 if (live_uri
->port
< 1024) {
2254 ERR("Need to be root to use ports < 1024");
2256 goto exit_init_data
;
2260 /* Setup the thread apps communication pipe. */
2261 if (create_conn_pipe()) {
2263 goto exit_init_data
;
2266 /* Init relay command queue. */
2267 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2269 /* Set up max poll set size */
2270 if (lttng_poll_set_max_size()) {
2272 goto exit_init_data
;
2275 /* Setup the dispatcher thread */
2276 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2277 thread_dispatcher
, (void *) NULL
);
2280 PERROR("pthread_create viewer dispatcher");
2282 goto exit_dispatcher_thread
;
2285 /* Setup the worker thread */
2286 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2287 thread_worker
, NULL
);
2290 PERROR("pthread_create viewer worker");
2292 goto exit_worker_thread
;
2295 /* Setup the listener thread */
2296 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2297 thread_listener
, (void *) NULL
);
2300 PERROR("pthread_create viewer listener");
2302 goto exit_listener_thread
;
2306 * All OK, started all threads.
2311 * Join on the live_listener_thread should anything be added after
2312 * the live_listener thread's creation.
2315 exit_listener_thread
:
2317 ret
= pthread_join(live_worker_thread
, &status
);
2320 PERROR("pthread_join live worker");
2325 ret
= pthread_join(live_dispatcher_thread
, &status
);
2328 PERROR("pthread_join live dispatcher");
2331 exit_dispatcher_thread
:
2334 cleanup_relayd_live();