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 uint64_t session_id
, 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 * session must be locked to ensure that we see either none or all initial
276 * streams for a session, but no intermediate state..
278 * Return 0 on success or else a negative value.
280 static int make_viewer_streams(struct relay_session
*session
,
281 struct lttng_trace_chunk
*viewer_trace_chunk
,
282 enum lttng_viewer_seek seek_t
,
285 uint32_t *nb_created
,
289 struct lttng_ht_iter iter
;
290 struct ctf_trace
*ctf_trace
;
293 ASSERT_LOCKED(session
->lock
);
295 if (!viewer_trace_chunk
) {
296 ERR("Internal error: viewer session associated with session \"%s\" has a NULL trace chunk",
297 session
->session_name
);
302 if (session
->connection_closed
) {
307 * Create viewer streams for relay streams that are ready to be
308 * used for a the given session id only.
311 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
, &iter
.iter
, ctf_trace
,
313 bool trace_has_metadata_stream
= false;
314 struct relay_stream
*stream
;
316 health_code_update();
318 if (!ctf_trace_get(ctf_trace
)) {
323 * Iterate over all the streams of the trace to see if we have a
326 cds_list_for_each_entry_rcu(
327 stream
, &ctf_trace
->stream_list
, stream_node
)
329 if (stream
->is_metadata
) {
330 trace_has_metadata_stream
= true;
336 * If there is no metadata stream in this trace at the moment
337 * and we never sent one to the viewer, skip the trace. We
338 * accept that the viewer will not see this trace at all.
340 if (!trace_has_metadata_stream
&&
341 !ctf_trace
->metadata_stream_sent_to_viewer
) {
342 ctf_trace_put(ctf_trace
);
346 cds_list_for_each_entry_rcu(stream
, &ctf_trace
->stream_list
, stream_node
) {
347 struct relay_viewer_stream
*vstream
;
349 if (!stream_get(stream
)) {
353 * stream published is protected by the session lock.
355 if (!stream
->published
) {
358 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
361 * Save that we sent the metadata stream to the
362 * viewer. So that we know what trace the viewer
365 if (stream
->is_metadata
) {
366 ctf_trace
->metadata_stream_sent_to_viewer
=
369 vstream
= viewer_stream_create(stream
,
370 viewer_trace_chunk
, seek_t
);
373 ctf_trace_put(ctf_trace
);
379 /* Update number of created stream counter. */
383 * Ensure a self-reference is preserved even
384 * after we have put our local reference.
386 if (!viewer_stream_get(vstream
)) {
387 ERR("Unable to get self-reference on viewer stream, logic error.");
391 if (!vstream
->sent_flag
&& nb_unsent
) {
392 /* Update number of unsent stream counter. */
396 /* Update number of total stream counter. */
398 if (stream
->is_metadata
) {
399 if (!stream
->closed
||
400 stream
->metadata_received
> vstream
->metadata_sent
) {
404 if (!stream
->closed
||
405 !(((int64_t) (stream
->prev_data_seq
- stream
->last_net_seq_num
)) >= 0)) {
411 /* Put local reference. */
412 viewer_stream_put(vstream
);
416 ctf_trace_put(ctf_trace
);
427 int relayd_live_stop(void)
429 /* Stop dispatch thread */
430 CMM_STORE_SHARED(live_dispatch_thread_exit
, 1);
431 futex_nto1_wake(&viewer_conn_queue
.futex
);
436 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
439 int create_named_thread_poll_set(struct lttng_poll_event
*events
,
440 int size
, const char *name
)
444 if (events
== NULL
|| size
== 0) {
449 ret
= fd_tracker_util_poll_create(the_fd_tracker
,
450 name
, events
, 1, LTTNG_CLOEXEC
);
453 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
465 * Check if the thread quit pipe was triggered.
467 * Return 1 if it was triggered else 0;
470 int check_thread_quit_pipe(int fd
, uint32_t events
)
472 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
480 int create_sock(void *data
, int *out_fd
)
483 struct lttcomm_sock
*sock
= data
;
485 ret
= lttcomm_create_sock(sock
);
496 int close_sock(void *data
, int *in_fd
)
498 struct lttcomm_sock
*sock
= data
;
500 return sock
->ops
->close(sock
);
504 * Create and init socket from uri.
507 struct lttcomm_sock
*init_socket(struct lttng_uri
*uri
, const char *name
)
510 struct lttcomm_sock
*sock
= NULL
;
511 char uri_str
[LTTNG_PATH_MAX
];
512 char *formated_name
= NULL
;
514 sock
= lttcomm_alloc_sock_from_uri(uri
);
516 ERR("Allocating socket");
521 * Don't fail to create the socket if the name can't be built as it is
522 * only used for debugging purposes.
524 ret
= uri_to_str_url(uri
, uri_str
, sizeof(uri_str
));
525 uri_str
[sizeof(uri_str
) - 1] = '\0';
527 ret
= asprintf(&formated_name
, "%s socket @ %s", name
,
530 formated_name
= NULL
;
534 ret
= fd_tracker_open_unsuspendable_fd(the_fd_tracker
, &sock_fd
,
535 (const char **) (formated_name
? &formated_name
: NULL
),
536 1, create_sock
, sock
);
538 DBG("Listening on %s socket %d", name
, sock
->fd
);
540 ret
= sock
->ops
->bind(sock
);
542 PERROR("Failed to bind lttng-live socket");
546 ret
= sock
->ops
->listen(sock
, -1);
556 lttcomm_destroy_sock(sock
);
562 * This thread manages the listening for new connections on the network
565 void *thread_listener(void *data
)
567 int i
, ret
, pollfd
, err
= -1;
568 uint32_t revents
, nb_fd
;
569 struct lttng_poll_event events
;
570 struct lttcomm_sock
*live_control_sock
;
572 DBG("[thread] Relay live listener started");
574 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_LISTENER
);
576 health_code_update();
578 live_control_sock
= init_socket(live_uri
, "Live listener");
579 if (!live_control_sock
) {
580 goto error_sock_control
;
583 /* Pass 2 as size here for the thread quit pipe and control sockets. */
584 ret
= create_named_thread_poll_set(&events
, 2,
585 "Live listener thread epoll");
587 goto error_create_poll
;
590 /* Add the control socket */
591 ret
= lttng_poll_add(&events
, live_control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
596 lttng_relay_notify_ready();
598 if (testpoint(relayd_thread_live_listener
)) {
599 goto error_testpoint
;
603 health_code_update();
605 DBG("Listener accepting live viewers connections");
609 ret
= lttng_poll_wait(&events
, -1);
613 * Restart interrupted system call.
615 if (errno
== EINTR
) {
622 DBG("Relay new viewer connection received");
623 for (i
= 0; i
< nb_fd
; i
++) {
624 health_code_update();
626 /* Fetch once the poll data */
627 revents
= LTTNG_POLL_GETEV(&events
, i
);
628 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
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
= live_control_sock
->ops
->accept(live_control_sock
);
650 PERROR("accepting control sock");
653 DBG("Relay viewer connection accepted socket %d", newsock
->fd
);
655 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
658 PERROR("setsockopt inet");
659 lttcomm_destroy_sock(newsock
);
662 new_conn
= connection_create(newsock
, RELAY_CONNECTION_UNKNOWN
);
664 lttcomm_destroy_sock(newsock
);
667 /* Ownership assumed by the connection. */
670 /* Enqueue request for the dispatcher thread. */
671 cds_wfcq_enqueue(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
,
675 * Wake the dispatch queue futex.
676 * Implicit memory barrier with the
677 * exchange in cds_wfcq_enqueue.
679 futex_nto1_wake(&viewer_conn_queue
.futex
);
680 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
681 ERR("socket poll error");
684 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
694 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
696 if (live_control_sock
->fd
>= 0) {
697 int sock_fd
= live_control_sock
->fd
;
699 ret
= fd_tracker_close_unsuspendable_fd(the_fd_tracker
,
700 &sock_fd
, 1, close_sock
,
705 live_control_sock
->fd
= -1;
707 lttcomm_destroy_sock(live_control_sock
);
711 DBG("Live viewer listener thread exited with error");
713 health_unregister(health_relayd
);
714 DBG("Live viewer listener thread cleanup complete");
715 if (lttng_relay_stop_threads()) {
716 ERR("Error stopping threads");
722 * This thread manages the dispatching of the requests to worker threads
725 void *thread_dispatcher(void *data
)
729 struct cds_wfcq_node
*node
;
730 struct relay_connection
*conn
= NULL
;
732 DBG("[thread] Live viewer relay dispatcher started");
734 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER
);
736 if (testpoint(relayd_thread_live_dispatcher
)) {
737 goto error_testpoint
;
740 health_code_update();
743 health_code_update();
745 /* Atomically prepare the queue futex */
746 futex_nto1_prepare(&viewer_conn_queue
.futex
);
748 if (CMM_LOAD_SHARED(live_dispatch_thread_exit
)) {
753 health_code_update();
755 /* Dequeue commands */
756 node
= cds_wfcq_dequeue_blocking(&viewer_conn_queue
.head
,
757 &viewer_conn_queue
.tail
);
759 DBG("Woken up but nothing in the live-viewer "
760 "relay command queue");
761 /* Continue thread execution */
764 conn
= caa_container_of(node
, struct relay_connection
, qnode
);
765 DBG("Dispatching viewer request waiting on sock %d",
769 * Inform worker thread of the new request. This
770 * call is blocking so we can be assured that
771 * the data will be read at some point in time
772 * or wait to the end of the world :)
774 ret
= lttng_write(live_conn_pipe
[1], &conn
, sizeof(conn
));
776 PERROR("write conn pipe");
777 connection_put(conn
);
780 } while (node
!= NULL
);
782 /* Futex wait on queue. Blocking call on futex() */
784 futex_nto1_wait(&viewer_conn_queue
.futex
);
788 /* Normal exit, no error */
795 ERR("Health error occurred in %s", __func__
);
797 health_unregister(health_relayd
);
798 DBG("Live viewer dispatch thread dying");
799 if (lttng_relay_stop_threads()) {
800 ERR("Error stopping threads");
806 * Establish connection with the viewer and check the versions.
808 * Return 0 on success or else negative value.
811 int viewer_connect(struct relay_connection
*conn
)
814 struct lttng_viewer_connect reply
, msg
;
816 conn
->version_check_done
= 1;
818 health_code_update();
820 DBG("Viewer is establishing a connection to the relayd.");
822 ret
= recv_request(conn
->sock
, &msg
, sizeof(msg
));
827 health_code_update();
829 memset(&reply
, 0, sizeof(reply
));
830 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
831 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
833 /* Major versions must be the same */
834 if (reply
.major
!= be32toh(msg
.major
)) {
835 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
836 reply
.major
, be32toh(msg
.major
));
841 conn
->major
= reply
.major
;
842 /* We adapt to the lowest compatible version */
843 if (reply
.minor
<= be32toh(msg
.minor
)) {
844 conn
->minor
= reply
.minor
;
846 conn
->minor
= be32toh(msg
.minor
);
849 if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_COMMAND
) {
850 conn
->type
= RELAY_VIEWER_COMMAND
;
851 } else if (be32toh(msg
.type
) == LTTNG_VIEWER_CLIENT_NOTIFICATION
) {
852 conn
->type
= RELAY_VIEWER_NOTIFICATION
;
854 ERR("Unknown connection type : %u", be32toh(msg
.type
));
859 reply
.major
= htobe32(reply
.major
);
860 reply
.minor
= htobe32(reply
.minor
);
861 if (conn
->type
== RELAY_VIEWER_COMMAND
) {
863 * Increment outside of htobe64 macro, because the argument can
864 * be used more than once within the macro, and thus the
865 * operation may be undefined.
867 pthread_mutex_lock(&last_relay_viewer_session_id_lock
);
868 last_relay_viewer_session_id
++;
869 pthread_mutex_unlock(&last_relay_viewer_session_id_lock
);
870 reply
.viewer_session_id
= htobe64(last_relay_viewer_session_id
);
873 health_code_update();
875 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
880 health_code_update();
882 DBG("Version check done using protocol %u.%u", conn
->major
, conn
->minor
);
890 * Send the viewer the list of current sessions.
891 * We need to create a copy of the hash table content because otherwise
892 * we cannot assume the number of entries stays the same between getting
893 * the number of HT elements and iteration over the HT.
895 * Return 0 on success or else a negative value.
898 int viewer_list_sessions(struct relay_connection
*conn
)
901 struct lttng_viewer_list_sessions session_list
;
902 struct lttng_ht_iter iter
;
903 struct relay_session
*session
;
904 struct lttng_viewer_session
*send_session_buf
= NULL
;
905 uint32_t buf_count
= SESSION_BUF_DEFAULT_COUNT
;
908 DBG("List sessions received");
910 send_session_buf
= zmalloc(SESSION_BUF_DEFAULT_COUNT
* sizeof(*send_session_buf
));
911 if (!send_session_buf
) {
916 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
918 struct lttng_viewer_session
*send_session
;
920 health_code_update();
922 pthread_mutex_lock(&session
->lock
);
923 if (session
->connection_closed
) {
924 /* Skip closed session */
927 if (!session
->current_trace_chunk
) {
929 * Skip un-attachable session. It is either
930 * being destroyed or has not had a trace
931 * chunk created against it yet.
936 if (count
>= buf_count
) {
937 struct lttng_viewer_session
*newbuf
;
938 uint32_t new_buf_count
= buf_count
<< 1;
940 newbuf
= realloc(send_session_buf
,
941 new_buf_count
* sizeof(*send_session_buf
));
946 send_session_buf
= newbuf
;
947 buf_count
= new_buf_count
;
949 send_session
= &send_session_buf
[count
];
950 if (lttng_strncpy(send_session
->session_name
,
951 session
->session_name
,
952 sizeof(send_session
->session_name
))) {
956 if (lttng_strncpy(send_session
->hostname
, session
->hostname
,
957 sizeof(send_session
->hostname
))) {
961 send_session
->id
= htobe64(session
->id
);
962 send_session
->live_timer
= htobe32(session
->live_timer
);
963 if (session
->viewer_attached
) {
964 send_session
->clients
= htobe32(1);
966 send_session
->clients
= htobe32(0);
968 send_session
->streams
= htobe32(session
->stream_count
);
971 pthread_mutex_unlock(&session
->lock
);
974 pthread_mutex_unlock(&session
->lock
);
982 session_list
.sessions_count
= htobe32(count
);
984 health_code_update();
986 ret
= send_response(conn
->sock
, &session_list
, sizeof(session_list
));
991 health_code_update();
993 ret
= send_response(conn
->sock
, send_session_buf
,
994 count
* sizeof(*send_session_buf
));
998 health_code_update();
1002 free(send_session_buf
);
1007 * Send the viewer the list of current streams.
1010 int viewer_get_new_streams(struct relay_connection
*conn
)
1012 int ret
, send_streams
= 0;
1013 uint32_t nb_created
= 0, nb_unsent
= 0, nb_streams
= 0, nb_total
= 0;
1014 struct lttng_viewer_new_streams_request request
;
1015 struct lttng_viewer_new_streams_response response
;
1016 struct relay_session
*session
= NULL
;
1017 uint64_t session_id
;
1018 bool closed
= false;
1022 DBG("Get new streams received");
1024 health_code_update();
1026 /* Receive the request from the connected client. */
1027 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1031 session_id
= be64toh(request
.session_id
);
1033 health_code_update();
1035 memset(&response
, 0, sizeof(response
));
1037 session
= session_get_by_id(session_id
);
1039 DBG("Relay session %" PRIu64
" not found", session_id
);
1040 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
1044 if (!viewer_session_is_attached(conn
->viewer_session
, session
)) {
1045 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR
);
1049 pthread_mutex_lock(&session
->lock
);
1050 ret
= make_viewer_streams(session
,
1051 conn
->viewer_session
->current_trace_chunk
,
1052 LTTNG_VIEWER_SEEK_LAST
, &nb_total
, &nb_unsent
,
1053 &nb_created
, &closed
);
1055 goto error_unlock_session
;
1058 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_OK
);
1060 /* Only send back the newly created streams with the unsent ones. */
1061 nb_streams
= nb_created
+ nb_unsent
;
1062 response
.streams_count
= htobe32(nb_streams
);
1065 * If the session is closed, HUP when there are no more streams
1068 if (closed
&& nb_total
== 0) {
1070 response
.streams_count
= 0;
1071 response
.status
= htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP
);
1072 goto send_reply_unlock
;
1075 pthread_mutex_unlock(&session
->lock
);
1078 health_code_update();
1079 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1081 goto end_put_session
;
1083 health_code_update();
1086 * Unknown or empty session, just return gracefully, the viewer
1087 * knows what is happening.
1089 if (!send_streams
|| !nb_streams
) {
1091 goto end_put_session
;
1095 * Send stream and *DON'T* ignore the sent flag so every viewer
1096 * streams that were not sent from that point will be sent to
1099 ret
= send_viewer_streams(conn
->sock
, session_id
, 0);
1101 goto end_put_session
;
1106 session_put(session
);
1110 error_unlock_session
:
1111 pthread_mutex_unlock(&session
->lock
);
1112 session_put(session
);
1117 * Send the viewer the list of current sessions.
1120 int viewer_attach_session(struct relay_connection
*conn
)
1122 int send_streams
= 0;
1124 uint32_t nb_streams
= 0;
1125 enum lttng_viewer_seek seek_type
;
1126 struct lttng_viewer_attach_session_request request
;
1127 struct lttng_viewer_attach_session_response response
;
1128 struct relay_session
*session
= NULL
;
1129 enum lttng_viewer_attach_return_code viewer_attach_status
;
1130 bool closed
= false;
1131 uint64_t session_id
;
1135 health_code_update();
1137 /* Receive the request from the connected client. */
1138 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1143 session_id
= be64toh(request
.session_id
);
1144 health_code_update();
1146 memset(&response
, 0, sizeof(response
));
1148 if (!conn
->viewer_session
) {
1149 DBG("Client trying to attach before creating a live viewer session");
1150 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION
);
1154 session
= session_get_by_id(session_id
);
1156 DBG("Relay session %" PRIu64
" not found", session_id
);
1157 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1160 DBG("Attach session ID %" PRIu64
" received", session_id
);
1162 pthread_mutex_lock(&session
->lock
);
1163 if (!session
->current_trace_chunk
) {
1165 * Session is either being destroyed or it never had a trace
1166 * chunk created against it.
1168 DBG("Session requested by live client has no current trace chunk, returning unknown session");
1169 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1172 if (session
->live_timer
== 0) {
1173 DBG("Not live session");
1174 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE
);
1179 viewer_attach_status
= viewer_session_attach(conn
->viewer_session
,
1181 if (viewer_attach_status
!= LTTNG_VIEWER_ATTACH_OK
) {
1182 response
.status
= htobe32(viewer_attach_status
);
1186 switch (be32toh(request
.seek
)) {
1187 case LTTNG_VIEWER_SEEK_BEGINNING
:
1188 case LTTNG_VIEWER_SEEK_LAST
:
1189 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_OK
);
1190 seek_type
= be32toh(request
.seek
);
1193 ERR("Wrong seek parameter");
1194 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR
);
1199 ret
= make_viewer_streams(session
,
1200 conn
->viewer_session
->current_trace_chunk
, seek_type
,
1201 &nb_streams
, NULL
, NULL
, &closed
);
1203 goto end_put_session
;
1205 pthread_mutex_unlock(&session
->lock
);
1206 session_put(session
);
1209 response
.streams_count
= htobe32(nb_streams
);
1211 * If the session is closed when the viewer is attaching, it
1212 * means some of the streams may have been concurrently removed,
1213 * so we don't allow the viewer to attach, even if there are
1214 * streams available.
1218 response
.streams_count
= 0;
1219 response
.status
= htobe32(LTTNG_VIEWER_ATTACH_UNK
);
1224 health_code_update();
1225 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
1227 goto end_put_session
;
1229 health_code_update();
1232 * Unknown or empty session, just return gracefully, the viewer
1233 * knows what is happening.
1235 if (!send_streams
|| !nb_streams
) {
1237 goto end_put_session
;
1240 /* Send stream and ignore the sent flag. */
1241 ret
= send_viewer_streams(conn
->sock
, session_id
, 1);
1243 goto end_put_session
;
1248 pthread_mutex_unlock(&session
->lock
);
1249 session_put(session
);
1256 * Open the index file if needed for the given vstream.
1258 * If an index file is successfully opened, the vstream will set it as its
1259 * current index file.
1261 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
1263 * Called with rstream lock held.
1265 static int try_open_index(struct relay_viewer_stream
*vstream
,
1266 struct relay_stream
*rstream
)
1269 const uint32_t connection_major
= rstream
->trace
->session
->major
;
1270 const uint32_t connection_minor
= rstream
->trace
->session
->minor
;
1271 enum lttng_trace_chunk_status chunk_status
;
1273 if (vstream
->index_file
) {
1278 * First time, we open the index file and at least one index is ready.
1280 if (rstream
->index_received_seqcount
== 0) {
1284 chunk_status
= lttng_index_file_create_from_trace_chunk_read_only(
1285 vstream
->stream_file
.trace_chunk
, rstream
->path_name
,
1286 rstream
->channel_name
, rstream
->tracefile_size
,
1287 vstream
->current_tracefile_id
,
1288 lttng_to_index_major(connection_major
, connection_minor
),
1289 lttng_to_index_minor(connection_major
, connection_minor
),
1290 true, &vstream
->index_file
);
1291 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1292 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_NO_FILE
) {
1304 * Check the status of the index for the given stream. This function
1305 * updates the index structure if needed and can put (close) the vstream
1306 * in the HUP situation.
1308 * Return 0 means that we can proceed with the index. A value of 1 means
1309 * that the index has been updated and is ready to be sent to the
1310 * client. A negative value indicates an error that can't be handled.
1312 * Called with rstream lock held.
1314 static int check_index_status(struct relay_viewer_stream
*vstream
,
1315 struct relay_stream
*rstream
, struct ctf_trace
*trace
,
1316 struct lttng_viewer_index
*index
)
1320 DBG("Check index status: index_received_seqcount %" PRIu64
" "
1321 "index_sent_seqcount %" PRIu64
" "
1322 "for stream %" PRIu64
,
1323 rstream
->index_received_seqcount
,
1324 vstream
->index_sent_seqcount
,
1325 vstream
->stream
->stream_handle
);
1326 if ((trace
->session
->connection_closed
|| rstream
->closed
)
1327 && rstream
->index_received_seqcount
1328 == vstream
->index_sent_seqcount
) {
1330 * Last index sent and session connection or relay
1331 * stream are closed.
1333 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1335 } else if (rstream
->beacon_ts_end
!= -1ULL &&
1336 (rstream
->index_received_seqcount
== 0 ||
1337 (vstream
->index_sent_seqcount
!= 0 &&
1338 rstream
->index_received_seqcount
1339 <= vstream
->index_sent_seqcount
))) {
1341 * We've received a synchronization beacon and the last index
1342 * available has been sent, the index for now is inactive.
1344 * In this case, we have received a beacon which allows us to
1345 * inform the client of a time interval during which we can
1346 * guarantee that there are no events to read (and never will
1349 * The sent seqcount can grow higher than receive seqcount on
1350 * clear because the rotation performed by clear will push
1351 * the index_sent_seqcount ahead (see
1352 * viewer_stream_sync_tracefile_array_tail) and skip over
1353 * packet sequence numbers.
1355 index
->status
= htobe32(LTTNG_VIEWER_INDEX_INACTIVE
);
1356 index
->timestamp_end
= htobe64(rstream
->beacon_ts_end
);
1357 index
->stream_id
= htobe64(rstream
->ctf_stream_id
);
1358 DBG("Check index status: inactive with beacon, for stream %" PRIu64
,
1359 vstream
->stream
->stream_handle
);
1361 } else if (rstream
->index_received_seqcount
== 0 ||
1362 (vstream
->index_sent_seqcount
!= 0 &&
1363 rstream
->index_received_seqcount
1364 <= vstream
->index_sent_seqcount
)) {
1366 * This checks whether received <= sent seqcount. In
1367 * this case, we have not received a beacon. Therefore,
1368 * we can only ask the client to retry later.
1370 * The sent seqcount can grow higher than receive seqcount on
1371 * clear because the rotation performed by clear will push
1372 * the index_sent_seqcount ahead (see
1373 * viewer_stream_sync_tracefile_array_tail) and skip over
1374 * packet sequence numbers.
1376 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1377 DBG("Check index status: retry for stream %" PRIu64
,
1378 vstream
->stream
->stream_handle
);
1380 } else if (!tracefile_array_seq_in_file(rstream
->tfa
,
1381 vstream
->current_tracefile_id
,
1382 vstream
->index_sent_seqcount
)) {
1384 * The next index we want to send cannot be read either
1385 * because we need to perform a rotation, or due to
1386 * the producer having overwritten its trace file.
1388 DBG("Viewer stream %" PRIu64
" rotation",
1389 vstream
->stream
->stream_handle
);
1390 ret
= viewer_stream_rotate(vstream
);
1392 /* EOF across entire stream. */
1393 index
->status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1397 * If we have been pushed due to overwrite, it
1398 * necessarily means there is data that can be read in
1399 * the stream. If we rotated because we reached the end
1400 * of a tracefile, it means the following tracefile
1401 * needs to contain at least one index, else we would
1402 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1403 * viewer. The updated index_sent_seqcount needs to
1404 * point to a readable index entry now.
1406 * In the case where we "rotate" on a single file, we
1407 * can end up in a case where the requested index is
1408 * still unavailable.
1410 if (rstream
->tracefile_count
== 1 &&
1411 !tracefile_array_seq_in_file(
1413 vstream
->current_tracefile_id
,
1414 vstream
->index_sent_seqcount
)) {
1415 index
->status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1416 DBG("Check index status: retry: "
1417 "tracefile array sequence number %" PRIu64
1418 " not in file for stream %" PRIu64
,
1419 vstream
->index_sent_seqcount
,
1420 vstream
->stream
->stream_handle
);
1423 assert(tracefile_array_seq_in_file(rstream
->tfa
,
1424 vstream
->current_tracefile_id
,
1425 vstream
->index_sent_seqcount
));
1427 /* ret == 0 means successful so we continue. */
1432 viewer_stream_put(vstream
);
1438 * Send the next index for a stream.
1440 * Return 0 on success or else a negative value.
1443 int viewer_get_next_index(struct relay_connection
*conn
)
1446 struct lttng_viewer_get_next_index request_index
;
1447 struct lttng_viewer_index viewer_index
;
1448 struct ctf_packet_index packet_index
;
1449 struct relay_viewer_stream
*vstream
= NULL
;
1450 struct relay_stream
*rstream
= NULL
;
1451 struct ctf_trace
*ctf_trace
= NULL
;
1452 struct relay_viewer_stream
*metadata_viewer_stream
= NULL
;
1456 DBG("Viewer get next index");
1458 memset(&viewer_index
, 0, sizeof(viewer_index
));
1459 health_code_update();
1461 ret
= recv_request(conn
->sock
, &request_index
, sizeof(request_index
));
1465 health_code_update();
1467 vstream
= viewer_stream_get_by_id(be64toh(request_index
.stream_id
));
1469 DBG("Client requested index of unknown stream id %" PRIu64
,
1470 (uint64_t) be64toh(request_index
.stream_id
));
1471 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1475 /* Use back. ref. Protected by refcounts. */
1476 rstream
= vstream
->stream
;
1477 ctf_trace
= rstream
->trace
;
1479 /* metadata_viewer_stream may be NULL. */
1480 metadata_viewer_stream
=
1481 ctf_trace_get_viewer_metadata_stream(ctf_trace
);
1483 pthread_mutex_lock(&rstream
->lock
);
1486 * The viewer should not ask for index on metadata stream.
1488 if (rstream
->is_metadata
) {
1489 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1493 if (rstream
->ongoing_rotation
.is_set
) {
1494 /* Rotation is ongoing, try again later. */
1495 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1499 if (rstream
->trace
->session
->ongoing_rotation
) {
1500 /* Rotation is ongoing, try again later. */
1501 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1505 if (rstream
->trace_chunk
) {
1506 uint64_t rchunk_id
, vchunk_id
;
1509 * If the relay stream is not yet closed, ensure the viewer
1510 * chunk matches the relay chunk after clear.
1512 if (lttng_trace_chunk_get_id(rstream
->trace_chunk
,
1513 &rchunk_id
) != LTTNG_TRACE_CHUNK_STATUS_OK
) {
1514 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1517 if (lttng_trace_chunk_get_id(
1518 conn
->viewer_session
->current_trace_chunk
,
1519 &vchunk_id
) != LTTNG_TRACE_CHUNK_STATUS_OK
) {
1520 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1524 if (rchunk_id
!= vchunk_id
) {
1525 DBG("Relay and viewer chunk ids differ: "
1526 "rchunk_id %" PRIu64
" vchunk_id %" PRIu64
,
1527 rchunk_id
, vchunk_id
);
1529 lttng_trace_chunk_put(
1530 conn
->viewer_session
->current_trace_chunk
);
1531 conn
->viewer_session
->current_trace_chunk
= NULL
;
1532 ret
= viewer_session_set_trace_chunk_copy(
1533 conn
->viewer_session
,
1534 rstream
->trace_chunk
);
1536 viewer_index
.status
=
1537 htobe32(LTTNG_VIEWER_INDEX_ERR
);
1542 if (conn
->viewer_session
->current_trace_chunk
!=
1543 vstream
->stream_file
.trace_chunk
) {
1544 bool acquired_reference
;
1546 DBG("Viewer session and viewer stream chunk differ: "
1547 "vsession chunk %p vstream chunk %p",
1548 conn
->viewer_session
->current_trace_chunk
,
1549 vstream
->stream_file
.trace_chunk
);
1550 lttng_trace_chunk_put(vstream
->stream_file
.trace_chunk
);
1551 acquired_reference
= lttng_trace_chunk_get(conn
->viewer_session
->current_trace_chunk
);
1552 assert(acquired_reference
);
1553 vstream
->stream_file
.trace_chunk
=
1554 conn
->viewer_session
->current_trace_chunk
;
1555 viewer_stream_sync_tracefile_array_tail(vstream
);
1556 viewer_stream_close_files(vstream
);
1559 ret
= check_index_status(vstream
, rstream
, ctf_trace
, &viewer_index
);
1562 } else if (ret
== 1) {
1564 * We have no index to send and check_index_status has populated
1565 * viewer_index's status.
1569 /* At this point, ret is 0 thus we will be able to read the index. */
1572 /* Try to open an index if one is needed for that stream. */
1573 ret
= try_open_index(vstream
, rstream
);
1574 if (ret
== -ENOENT
) {
1575 if (rstream
->closed
) {
1576 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1579 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_RETRY
);
1584 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1589 * vstream->stream_fd may be NULL if it has been closed by
1590 * tracefile rotation, or if we are at the beginning of the
1591 * stream. We open the data stream file here to protect against
1592 * overwrite caused by tracefile rotation (in association with
1593 * unlink performed before overwrite).
1595 if (!vstream
->stream_file
.fd
) {
1597 char file_path
[LTTNG_PATH_MAX
];
1598 enum lttng_trace_chunk_status status
;
1600 ret
= utils_stream_file_path(rstream
->path_name
,
1601 rstream
->channel_name
, rstream
->tracefile_size
,
1602 vstream
->current_tracefile_id
, NULL
, file_path
,
1609 * It is possible the the file we are trying to open is
1610 * missing if the stream has been closed (application exits with
1611 * per-pid buffers) and a clear command has been performed.
1613 status
= lttng_trace_chunk_open_file(
1614 vstream
->stream_file
.trace_chunk
,
1615 file_path
, O_RDONLY
, 0, &fd
, true);
1616 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1617 if (status
== LTTNG_TRACE_CHUNK_STATUS_NO_FILE
&&
1619 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_HUP
);
1622 PERROR("Failed to open trace file for viewer stream");
1625 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1626 if (!vstream
->stream_file
.fd
) {
1628 PERROR("Failed to close viewer stream file");
1634 ret
= check_new_streams(conn
);
1636 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1638 } else if (ret
== 1) {
1639 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_STREAM
;
1642 ret
= lttng_index_file_read(vstream
->index_file
, &packet_index
);
1644 ERR("Relay error reading index file %d",
1645 vstream
->index_file
->fd
);
1646 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_ERR
);
1649 viewer_index
.status
= htobe32(LTTNG_VIEWER_INDEX_OK
);
1650 vstream
->index_sent_seqcount
++;
1654 * Indexes are stored in big endian, no need to switch before sending.
1656 DBG("Sending viewer index for stream %" PRIu64
" offset %" PRIu64
,
1657 rstream
->stream_handle
,
1658 (uint64_t) be64toh(packet_index
.offset
));
1659 viewer_index
.offset
= packet_index
.offset
;
1660 viewer_index
.packet_size
= packet_index
.packet_size
;
1661 viewer_index
.content_size
= packet_index
.content_size
;
1662 viewer_index
.timestamp_begin
= packet_index
.timestamp_begin
;
1663 viewer_index
.timestamp_end
= packet_index
.timestamp_end
;
1664 viewer_index
.events_discarded
= packet_index
.events_discarded
;
1665 viewer_index
.stream_id
= packet_index
.stream_id
;
1669 pthread_mutex_unlock(&rstream
->lock
);
1672 if (metadata_viewer_stream
) {
1673 pthread_mutex_lock(&metadata_viewer_stream
->stream
->lock
);
1674 DBG("get next index metadata check: recv %" PRIu64
1676 metadata_viewer_stream
->stream
->metadata_received
,
1677 metadata_viewer_stream
->metadata_sent
);
1678 if (!metadata_viewer_stream
->stream
->metadata_received
||
1679 metadata_viewer_stream
->stream
->metadata_received
>
1680 metadata_viewer_stream
->metadata_sent
) {
1681 viewer_index
.flags
|= LTTNG_VIEWER_FLAG_NEW_METADATA
;
1683 pthread_mutex_unlock(&metadata_viewer_stream
->stream
->lock
);
1686 viewer_index
.flags
= htobe32(viewer_index
.flags
);
1687 health_code_update();
1689 ret
= send_response(conn
->sock
, &viewer_index
, sizeof(viewer_index
));
1693 health_code_update();
1696 DBG("Index %" PRIu64
" for stream %" PRIu64
" sent",
1697 vstream
->index_sent_seqcount
,
1698 vstream
->stream
->stream_handle
);
1701 if (metadata_viewer_stream
) {
1702 viewer_stream_put(metadata_viewer_stream
);
1705 viewer_stream_put(vstream
);
1710 pthread_mutex_unlock(&rstream
->lock
);
1711 if (metadata_viewer_stream
) {
1712 viewer_stream_put(metadata_viewer_stream
);
1714 viewer_stream_put(vstream
);
1719 * Send the next index for a stream
1721 * Return 0 on success or else a negative value.
1724 int viewer_get_packet(struct relay_connection
*conn
)
1729 struct lttng_viewer_get_packet get_packet_info
;
1730 struct lttng_viewer_trace_packet reply_header
;
1731 struct relay_viewer_stream
*vstream
= NULL
;
1732 uint32_t reply_size
= sizeof(reply_header
);
1733 uint32_t packet_data_len
= 0;
1736 DBG2("Relay get data packet");
1738 health_code_update();
1740 ret
= recv_request(conn
->sock
, &get_packet_info
,
1741 sizeof(get_packet_info
));
1745 health_code_update();
1747 /* From this point on, the error label can be reached. */
1748 memset(&reply_header
, 0, sizeof(reply_header
));
1750 vstream
= viewer_stream_get_by_id(be64toh(get_packet_info
.stream_id
));
1752 DBG("Client requested packet of unknown stream id %" PRIu64
,
1753 (uint64_t) be64toh(get_packet_info
.stream_id
));
1754 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1755 goto send_reply_nolock
;
1757 packet_data_len
= be32toh(get_packet_info
.len
);
1758 reply_size
+= packet_data_len
;
1761 reply
= zmalloc(reply_size
);
1763 PERROR("packet reply zmalloc");
1764 reply_size
= sizeof(reply_header
);
1768 pthread_mutex_lock(&vstream
->stream
->lock
);
1769 lseek_ret
= lseek(vstream
->stream_file
.fd
->fd
,
1770 be64toh(get_packet_info
.offset
), SEEK_SET
);
1771 if (lseek_ret
< 0) {
1772 PERROR("lseek fd %d to offset %" PRIu64
,
1773 vstream
->stream_file
.fd
->fd
,
1774 (uint64_t) be64toh(get_packet_info
.offset
));
1777 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
,
1778 reply
+ sizeof(reply_header
), packet_data_len
);
1779 if (read_len
< packet_data_len
) {
1780 PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64
,
1781 vstream
->stream_file
.fd
->fd
,
1782 (uint64_t) be64toh(get_packet_info
.offset
));
1785 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_OK
);
1786 reply_header
.len
= htobe32(packet_data_len
);
1790 reply_header
.status
= htobe32(LTTNG_VIEWER_GET_PACKET_ERR
);
1794 pthread_mutex_unlock(&vstream
->stream
->lock
);
1798 health_code_update();
1801 memcpy(reply
, &reply_header
, sizeof(reply_header
));
1802 ret
= send_response(conn
->sock
, reply
, reply_size
);
1804 /* No reply to send. */
1805 ret
= send_response(conn
->sock
, &reply_header
,
1809 health_code_update();
1811 PERROR("sendmsg of packet data failed");
1815 DBG("Sent %u bytes for stream %" PRIu64
, reply_size
,
1816 (uint64_t) be64toh(get_packet_info
.stream_id
));
1822 viewer_stream_put(vstream
);
1828 * Send the session's metadata
1830 * Return 0 on success else a negative value.
1833 int viewer_get_metadata(struct relay_connection
*conn
)
1839 struct lttng_viewer_get_metadata request
;
1840 struct lttng_viewer_metadata_packet reply
;
1841 struct relay_viewer_stream
*vstream
= NULL
;
1845 DBG("Relay get metadata");
1847 health_code_update();
1849 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
1853 health_code_update();
1855 memset(&reply
, 0, sizeof(reply
));
1857 vstream
= viewer_stream_get_by_id(be64toh(request
.stream_id
));
1860 * The metadata stream can be closed by a CLOSE command
1861 * just before we attach. It can also be closed by
1862 * per-pid tracing during tracing. Therefore, it is
1863 * possible that we cannot find this viewer stream.
1864 * Reply back to the client with an error if we cannot
1867 DBG("Client requested metadata of unknown stream id %" PRIu64
,
1868 (uint64_t) be64toh(request
.stream_id
));
1869 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1872 pthread_mutex_lock(&vstream
->stream
->lock
);
1873 if (!vstream
->stream
->is_metadata
) {
1874 ERR("Invalid metadata stream");
1878 if (vstream
->metadata_sent
>= vstream
->stream
->metadata_received
) {
1880 * The live viewers expect to receive a NO_NEW_METADATA
1881 * status before a stream disappears, otherwise they abort the
1882 * entire live connection when receiving an error status.
1884 * Clear feature resets the metadata_sent to 0 until the
1885 * same metadata is received again.
1887 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1889 * The live viewer considers a closed 0 byte metadata stream as
1892 if (vstream
->metadata_sent
> 0) {
1893 vstream
->stream
->no_new_metadata_notified
= true;
1894 if (vstream
->stream
->closed
) {
1895 /* Release ownership for the viewer metadata stream. */
1896 viewer_stream_put(vstream
);
1902 len
= vstream
->stream
->metadata_received
- vstream
->metadata_sent
;
1904 /* first time, we open the metadata file */
1905 if (!vstream
->stream_file
.fd
) {
1907 char file_path
[LTTNG_PATH_MAX
];
1908 enum lttng_trace_chunk_status status
;
1909 struct relay_stream
*rstream
= vstream
->stream
;
1911 ret
= utils_stream_file_path(rstream
->path_name
,
1912 rstream
->channel_name
, rstream
->tracefile_size
,
1913 vstream
->current_tracefile_id
, NULL
, file_path
,
1920 * It is possible the the metadata file we are trying to open is
1921 * missing if the stream has been closed (application exits with
1922 * per-pid buffers) and a clear command has been performed.
1924 status
= lttng_trace_chunk_open_file(
1925 vstream
->stream_file
.trace_chunk
,
1926 file_path
, O_RDONLY
, 0, &fd
, true);
1927 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1928 if (status
== LTTNG_TRACE_CHUNK_STATUS_NO_FILE
) {
1929 reply
.status
= htobe32(LTTNG_VIEWER_NO_NEW_METADATA
);
1931 if (vstream
->stream
->closed
) {
1932 viewer_stream_put(vstream
);
1936 PERROR("Failed to open metadata file for viewer stream");
1939 vstream
->stream_file
.fd
= stream_fd_create(fd
);
1940 if (!vstream
->stream_file
.fd
) {
1942 PERROR("Failed to close viewer metadata file");
1948 reply
.len
= htobe64(len
);
1949 data
= zmalloc(len
);
1951 PERROR("viewer metadata zmalloc");
1955 read_len
= lttng_read(vstream
->stream_file
.fd
->fd
, data
, len
);
1956 if (read_len
< len
) {
1957 PERROR("Relay reading metadata file");
1960 vstream
->metadata_sent
+= read_len
;
1961 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_OK
);
1966 reply
.status
= htobe32(LTTNG_VIEWER_METADATA_ERR
);
1969 health_code_update();
1971 pthread_mutex_unlock(&vstream
->stream
->lock
);
1973 ret
= send_response(conn
->sock
, &reply
, sizeof(reply
));
1977 health_code_update();
1980 ret
= send_response(conn
->sock
, data
, len
);
1986 DBG("Sent %" PRIu64
" bytes of metadata for stream %" PRIu64
, len
,
1987 (uint64_t) be64toh(request
.stream_id
));
1989 DBG("Metadata sent");
1995 viewer_stream_put(vstream
);
2001 * Create a viewer session.
2003 * Return 0 on success or else a negative value.
2006 int viewer_create_session(struct relay_connection
*conn
)
2009 struct lttng_viewer_create_session_response resp
;
2011 DBG("Viewer create session received");
2013 memset(&resp
, 0, sizeof(resp
));
2014 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_OK
);
2015 conn
->viewer_session
= viewer_session_create();
2016 if (!conn
->viewer_session
) {
2017 ERR("Allocation viewer session");
2018 resp
.status
= htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR
);
2023 health_code_update();
2024 ret
= send_response(conn
->sock
, &resp
, sizeof(resp
));
2028 health_code_update();
2036 * Detach a viewer session.
2038 * Return 0 on success or else a negative value.
2041 int viewer_detach_session(struct relay_connection
*conn
)
2044 struct lttng_viewer_detach_session_response response
;
2045 struct lttng_viewer_detach_session_request request
;
2046 struct relay_session
*session
= NULL
;
2047 uint64_t viewer_session_to_close
;
2049 DBG("Viewer detach session received");
2053 health_code_update();
2055 /* Receive the request from the connected client. */
2056 ret
= recv_request(conn
->sock
, &request
, sizeof(request
));
2060 viewer_session_to_close
= be64toh(request
.session_id
);
2062 if (!conn
->viewer_session
) {
2063 DBG("Client trying to detach before creating a live viewer session");
2064 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
2068 health_code_update();
2070 memset(&response
, 0, sizeof(response
));
2071 DBG("Detaching from session ID %" PRIu64
, viewer_session_to_close
);
2073 session
= session_get_by_id(be64toh(request
.session_id
));
2075 DBG("Relay session %" PRIu64
" not found",
2076 (uint64_t) be64toh(request
.session_id
));
2077 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK
);
2081 ret
= viewer_session_is_attached(conn
->viewer_session
, session
);
2083 DBG("Not attached to this session");
2084 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR
);
2085 goto send_reply_put
;
2088 viewer_session_close_one_session(conn
->viewer_session
, session
);
2089 response
.status
= htobe32(LTTNG_VIEWER_DETACH_SESSION_OK
);
2090 DBG("Session %" PRIu64
" detached.", viewer_session_to_close
);
2093 session_put(session
);
2096 health_code_update();
2097 ret
= send_response(conn
->sock
, &response
, sizeof(response
));
2101 health_code_update();
2109 * live_relay_unknown_command: send -1 if received unknown command
2112 void live_relay_unknown_command(struct relay_connection
*conn
)
2114 struct lttcomm_relayd_generic_reply reply
;
2116 memset(&reply
, 0, sizeof(reply
));
2117 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2118 (void) send_response(conn
->sock
, &reply
, sizeof(reply
));
2122 * Process the commands received on the control socket
2125 int process_control(struct lttng_viewer_cmd
*recv_hdr
,
2126 struct relay_connection
*conn
)
2131 msg_value
= be32toh(recv_hdr
->cmd
);
2134 * Make sure we've done the version check before any command other then a
2135 * new client connection.
2137 if (msg_value
!= LTTNG_VIEWER_CONNECT
&& !conn
->version_check_done
) {
2138 ERR("Viewer conn value %" PRIu32
" before version check", msg_value
);
2143 switch (msg_value
) {
2144 case LTTNG_VIEWER_CONNECT
:
2145 ret
= viewer_connect(conn
);
2147 case LTTNG_VIEWER_LIST_SESSIONS
:
2148 ret
= viewer_list_sessions(conn
);
2150 case LTTNG_VIEWER_ATTACH_SESSION
:
2151 ret
= viewer_attach_session(conn
);
2153 case LTTNG_VIEWER_GET_NEXT_INDEX
:
2154 ret
= viewer_get_next_index(conn
);
2156 case LTTNG_VIEWER_GET_PACKET
:
2157 ret
= viewer_get_packet(conn
);
2159 case LTTNG_VIEWER_GET_METADATA
:
2160 ret
= viewer_get_metadata(conn
);
2162 case LTTNG_VIEWER_GET_NEW_STREAMS
:
2163 ret
= viewer_get_new_streams(conn
);
2165 case LTTNG_VIEWER_CREATE_SESSION
:
2166 ret
= viewer_create_session(conn
);
2168 case LTTNG_VIEWER_DETACH_SESSION
:
2169 ret
= viewer_detach_session(conn
);
2172 ERR("Received unknown viewer command (%u)",
2173 be32toh(recv_hdr
->cmd
));
2174 live_relay_unknown_command(conn
);
2184 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
2188 (void) lttng_poll_del(events
, pollfd
);
2190 ret
= close(pollfd
);
2192 ERR("Closing pollfd %d", pollfd
);
2197 * This thread does the actual work
2200 void *thread_worker(void *data
)
2204 struct lttng_poll_event events
;
2205 struct lttng_ht
*viewer_connections_ht
;
2206 struct lttng_ht_iter iter
;
2207 struct lttng_viewer_cmd recv_hdr
;
2208 struct relay_connection
*destroy_conn
;
2210 DBG("[thread] Live viewer relay worker started");
2212 rcu_register_thread();
2214 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LIVE_WORKER
);
2216 if (testpoint(relayd_thread_live_worker
)) {
2217 goto error_testpoint
;
2220 /* table of connections indexed on socket */
2221 viewer_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2222 if (!viewer_connections_ht
) {
2223 goto viewer_connections_ht_error
;
2226 ret
= create_named_thread_poll_set(&events
, 2,
2227 "Live viewer worker thread epoll");
2229 goto error_poll_create
;
2232 ret
= lttng_poll_add(&events
, live_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2241 health_code_update();
2243 /* Infinite blocking call, waiting for transmission */
2244 DBG3("Relayd live viewer worker thread polling...");
2245 health_poll_entry();
2246 ret
= lttng_poll_wait(&events
, -1);
2250 * Restart interrupted system call.
2252 if (errno
== EINTR
) {
2261 * Process control. The control connection is prioritised so we don't
2262 * starve it with high throughput tracing data on the data
2265 for (i
= 0; i
< nb_fd
; i
++) {
2266 /* Fetch once the poll data */
2267 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2268 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2270 health_code_update();
2272 /* Thread quit pipe has been closed. Killing thread. */
2273 ret
= check_thread_quit_pipe(pollfd
, revents
);
2279 /* Inspect the relay conn pipe for new connection. */
2280 if (pollfd
== live_conn_pipe
[0]) {
2281 if (revents
& LPOLLIN
) {
2282 struct relay_connection
*conn
;
2284 ret
= lttng_read(live_conn_pipe
[0],
2285 &conn
, sizeof(conn
));
2289 ret
= lttng_poll_add(&events
,
2291 LPOLLIN
| LPOLLRDHUP
);
2293 ERR("Failed to add new live connection file descriptor to poll set");
2296 connection_ht_add(viewer_connections_ht
, conn
);
2297 DBG("Connection socket %d added to poll", conn
->sock
->fd
);
2298 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2299 ERR("Relay live pipe error");
2302 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2306 /* Connection activity. */
2307 struct relay_connection
*conn
;
2309 conn
= connection_get_by_sock(viewer_connections_ht
, pollfd
);
2314 if (revents
& LPOLLIN
) {
2315 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2316 sizeof(recv_hdr
), 0);
2318 /* Connection closed. */
2319 cleanup_connection_pollfd(&events
, pollfd
);
2320 /* Put "create" ownership reference. */
2321 connection_put(conn
);
2322 DBG("Viewer control conn closed with %d", pollfd
);
2324 ret
= process_control(&recv_hdr
, conn
);
2326 /* Clear the session on error. */
2327 cleanup_connection_pollfd(&events
, pollfd
);
2328 /* Put "create" ownership reference. */
2329 connection_put(conn
);
2330 DBG("Viewer connection closed with %d", pollfd
);
2333 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2334 cleanup_connection_pollfd(&events
, pollfd
);
2335 /* Put "create" ownership reference. */
2336 connection_put(conn
);
2338 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2339 connection_put(conn
);
2342 /* Put local "get_by_sock" reference. */
2343 connection_put(conn
);
2350 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
2352 /* Cleanup remaining connection object. */
2354 cds_lfht_for_each_entry(viewer_connections_ht
->ht
, &iter
.iter
,
2357 health_code_update();
2358 connection_put(destroy_conn
);
2362 lttng_ht_destroy(viewer_connections_ht
);
2363 viewer_connections_ht_error
:
2364 /* Close relay conn pipes */
2365 (void) fd_tracker_util_pipe_close(the_fd_tracker
, live_conn_pipe
);
2367 DBG("Viewer worker thread exited with error");
2369 DBG("Viewer worker thread cleanup complete");
2373 ERR("Health error occurred in %s", __func__
);
2375 health_unregister(health_relayd
);
2376 if (lttng_relay_stop_threads()) {
2377 ERR("Error stopping threads");
2379 rcu_unregister_thread();
2384 * Create the relay command pipe to wake thread_manage_apps.
2385 * Closed in cleanup().
2387 static int create_conn_pipe(void)
2389 return fd_tracker_util_pipe_open_cloexec(the_fd_tracker
,
2390 "Live connection pipe", live_conn_pipe
);
2393 int relayd_live_join(void)
2395 int ret
, retval
= 0;
2398 ret
= pthread_join(live_listener_thread
, &status
);
2401 PERROR("pthread_join live listener");
2405 ret
= pthread_join(live_worker_thread
, &status
);
2408 PERROR("pthread_join live worker");
2412 ret
= pthread_join(live_dispatcher_thread
, &status
);
2415 PERROR("pthread_join live dispatcher");
2419 cleanup_relayd_live();
2427 int relayd_live_create(struct lttng_uri
*uri
)
2429 int ret
= 0, retval
= 0;
2435 goto exit_init_data
;
2439 /* Check if daemon is UID = 0 */
2440 is_root
= !getuid();
2443 if (live_uri
->port
< 1024) {
2444 ERR("Need to be root to use ports < 1024");
2446 goto exit_init_data
;
2450 /* Setup the thread apps communication pipe. */
2451 if (create_conn_pipe()) {
2453 goto exit_init_data
;
2456 /* Init relay command queue. */
2457 cds_wfcq_init(&viewer_conn_queue
.head
, &viewer_conn_queue
.tail
);
2459 /* Set up max poll set size */
2460 if (lttng_poll_set_max_size()) {
2462 goto exit_init_data
;
2465 /* Setup the dispatcher thread */
2466 ret
= pthread_create(&live_dispatcher_thread
, default_pthread_attr(),
2467 thread_dispatcher
, (void *) NULL
);
2470 PERROR("pthread_create viewer dispatcher");
2472 goto exit_dispatcher_thread
;
2475 /* Setup the worker thread */
2476 ret
= pthread_create(&live_worker_thread
, default_pthread_attr(),
2477 thread_worker
, NULL
);
2480 PERROR("pthread_create viewer worker");
2482 goto exit_worker_thread
;
2485 /* Setup the listener thread */
2486 ret
= pthread_create(&live_listener_thread
, default_pthread_attr(),
2487 thread_listener
, (void *) NULL
);
2490 PERROR("pthread_create viewer listener");
2492 goto exit_listener_thread
;
2496 * All OK, started all threads.
2501 * Join on the live_listener_thread should anything be added after
2502 * the live_listener thread's creation.
2505 exit_listener_thread
:
2507 ret
= pthread_join(live_worker_thread
, &status
);
2510 PERROR("pthread_join live worker");
2515 ret
= pthread_join(live_dispatcher_thread
, &status
);
2518 PERROR("pthread_join live dispatcher");
2521 exit_dispatcher_thread
:
2524 cleanup_relayd_live();