2 * Copyright (C) 2012 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #include <sys/mount.h>
30 #include <sys/resource.h>
31 #include <sys/socket.h>
33 #include <sys/types.h>
36 #include <urcu/futex.h>
37 #include <urcu/uatomic.h>
42 #include <lttng/lttng.h>
43 #include <common/common.h>
44 #include <common/compat/poll.h>
45 #include <common/compat/socket.h>
46 #include <common/defaults.h>
47 #include <common/daemonize.h>
48 #include <common/futex.h>
49 #include <common/sessiond-comm/sessiond-comm.h>
50 #include <common/sessiond-comm/inet.h>
51 #include <common/sessiond-comm/relayd.h>
52 #include <common/uri.h>
53 #include <common/utils.h>
56 #include "ctf-trace.h"
59 #include "lttng-relayd.h"
61 #include "health-relayd.h"
62 #include "testpoint.h"
63 #include "viewer-stream.h"
66 #include "connection.h"
68 /* command line options */
69 char *opt_output_path
;
70 static int opt_daemon
, opt_background
;
73 * We need to wait for listener and live listener threads, as well as
74 * health check thread, before being ready to signal readiness.
76 #define NR_LTTNG_RELAY_READY 3
77 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
78 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
79 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
81 static struct lttng_uri
*control_uri
;
82 static struct lttng_uri
*data_uri
;
83 static struct lttng_uri
*live_uri
;
87 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
90 * Quit pipe for all threads. This permits a single cancellation point
91 * for all threads when receiving an event on the pipe.
93 int thread_quit_pipe
[2] = { -1, -1 };
96 * This pipe is used to inform the worker thread that a command is queued and
97 * ready to be processed.
99 static int relay_conn_pipe
[2] = { -1, -1 };
101 /* Shared between threads */
102 static int dispatch_thread_exit
;
104 static pthread_t listener_thread
;
105 static pthread_t dispatcher_thread
;
106 static pthread_t worker_thread
;
107 static pthread_t health_thread
;
109 static uint64_t last_relay_stream_id
;
112 * Relay command queue.
114 * The relay_thread_listener and relay_thread_dispatcher communicate with this
117 static struct relay_conn_queue relay_conn_queue
;
119 /* buffer allocated at startup, used to store the trace data */
120 static char *data_buffer
;
121 static unsigned int data_buffer_size
;
123 /* We need those values for the file/dir creation. */
124 static uid_t relayd_uid
;
125 static gid_t relayd_gid
;
127 /* Global relay stream hash table. */
128 struct lttng_ht
*relay_streams_ht
;
130 /* Global relay viewer stream hash table. */
131 struct lttng_ht
*viewer_streams_ht
;
133 /* Global hash table that stores relay index object. */
134 struct lttng_ht
*indexes_ht
;
136 /* Relayd health monitoring */
137 struct health_app
*health_relayd
;
140 * usage function on stderr
145 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
146 fprintf(stderr
, " -h, --help Display this usage.\n");
147 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
148 fprintf(stderr
, " -b, --background Start as a daemon, keeping console open.\n");
149 fprintf(stderr
, " -C, --control-port URL Control port listening.\n");
150 fprintf(stderr
, " -D, --data-port URL Data port listening.\n");
151 fprintf(stderr
, " -L, --live-port URL Live view port listening.\n");
152 fprintf(stderr
, " -o, --output PATH Output path for traces. Must use an absolute path.\n");
153 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
154 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
158 int parse_args(int argc
, char **argv
)
162 char *default_address
;
164 static struct option long_options
[] = {
165 { "control-port", 1, 0, 'C', },
166 { "data-port", 1, 0, 'D', },
167 { "daemonize", 0, 0, 'd', },
168 { "group", 1, 0, 'g', },
169 { "help", 0, 0, 'h', },
170 { "output", 1, 0, 'o', },
171 { "verbose", 0, 0, 'v', },
172 { "background", 0, 0, 'b' },
177 int option_index
= 0;
178 c
= getopt_long(argc
, argv
, "dhv" "C:D:L:o:g:b",
179 long_options
, &option_index
);
186 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
188 fprintf(stderr
, " with arg %s\n", optarg
);
192 ret
= uri_parse(optarg
, &control_uri
);
194 ERR("Invalid control URI specified");
197 if (control_uri
->port
== 0) {
198 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
202 ret
= uri_parse(optarg
, &data_uri
);
204 ERR("Invalid data URI specified");
207 if (data_uri
->port
== 0) {
208 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
212 ret
= uri_parse(optarg
, &live_uri
);
214 ERR("Invalid live URI specified");
217 if (live_uri
->port
== 0) {
218 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
228 tracing_group_name
= optarg
;
234 ret
= asprintf(&opt_output_path
, "%s", optarg
);
236 PERROR("asprintf opt_output_path");
241 /* Verbose level can increase using multiple -v */
242 lttng_opt_verbose
+= 1;
245 /* Unknown option or other error.
246 * Error is printed by getopt, just return */
252 /* assign default values */
253 if (control_uri
== NULL
) {
254 ret
= asprintf(&default_address
,
255 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
256 DEFAULT_NETWORK_CONTROL_PORT
);
258 PERROR("asprintf default data address");
262 ret
= uri_parse(default_address
, &control_uri
);
263 free(default_address
);
265 ERR("Invalid control URI specified");
269 if (data_uri
== NULL
) {
270 ret
= asprintf(&default_address
,
271 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
272 DEFAULT_NETWORK_DATA_PORT
);
274 PERROR("asprintf default data address");
278 ret
= uri_parse(default_address
, &data_uri
);
279 free(default_address
);
281 ERR("Invalid data URI specified");
285 if (live_uri
== NULL
) {
286 ret
= asprintf(&default_address
,
287 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
288 DEFAULT_NETWORK_VIEWER_PORT
);
290 PERROR("asprintf default viewer control address");
294 ret
= uri_parse(default_address
, &live_uri
);
295 free(default_address
);
297 ERR("Invalid viewer control URI specified");
314 /* free the dynamically allocated opt_output_path */
315 free(opt_output_path
);
317 /* Close thread quit pipes */
318 utils_close_pipe(thread_quit_pipe
);
320 uri_free(control_uri
);
322 /* Live URI is freed in the live thread. */
326 * Write to writable pipe used to notify a thread.
329 int notify_thread_pipe(int wpipe
)
333 ret
= lttng_write(wpipe
, "!", 1);
335 PERROR("write poll pipe");
341 static void notify_health_quit_pipe(int *pipe
)
345 ret
= lttng_write(pipe
[1], "4", 1);
347 PERROR("write relay health quit");
352 * Stop all threads by closing the thread quit pipe.
355 void stop_threads(void)
359 /* Stopping all threads */
360 DBG("Terminating all threads");
361 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
363 ERR("write error on thread quit pipe");
366 notify_health_quit_pipe(health_quit_pipe
);
368 /* Dispatch thread */
369 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
370 futex_nto1_wake(&relay_conn_queue
.futex
);
374 * Signal handler for the daemon
376 * Simply stop all worker threads, leaving main() return gracefully after
377 * joining all threads and calling cleanup().
380 void sighandler(int sig
)
384 DBG("SIGPIPE caught");
387 DBG("SIGINT caught");
391 DBG("SIGTERM caught");
395 CMM_STORE_SHARED(recv_child_signal
, 1);
403 * Setup signal handler for :
404 * SIGINT, SIGTERM, SIGPIPE
407 int set_signal_handler(void)
413 if ((ret
= sigemptyset(&sigset
)) < 0) {
414 PERROR("sigemptyset");
418 sa
.sa_handler
= sighandler
;
421 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
426 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
431 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
436 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
441 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
446 void lttng_relay_notify_ready(void)
448 /* Notify the parent of the fork() process that we are ready. */
449 if (opt_daemon
|| opt_background
) {
450 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
451 kill(child_ppid
, SIGUSR1
);
457 * Init thread quit pipe.
459 * Return -1 on error or 0 if all pipes are created.
462 int init_thread_quit_pipe(void)
466 ret
= utils_create_pipe_cloexec(thread_quit_pipe
);
472 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
475 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
479 if (events
== NULL
|| size
== 0) {
484 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
490 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
502 * Check if the thread quit pipe was triggered.
504 * Return 1 if it was triggered else 0;
507 int check_thread_quit_pipe(int fd
, uint32_t events
)
509 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
517 * Create and init socket from uri.
520 struct lttcomm_sock
*relay_init_sock(struct lttng_uri
*uri
)
523 struct lttcomm_sock
*sock
= NULL
;
525 sock
= lttcomm_alloc_sock_from_uri(uri
);
527 ERR("Allocating socket");
531 ret
= lttcomm_create_sock(sock
);
535 DBG("Listening on sock %d", sock
->fd
);
537 ret
= sock
->ops
->bind(sock
);
542 ret
= sock
->ops
->listen(sock
, -1);
552 lttcomm_destroy_sock(sock
);
558 * Return nonzero if stream needs to be closed.
561 int close_stream_check(struct relay_stream
*stream
)
563 if (stream
->close_flag
&& stream
->prev_seq
== stream
->last_net_seq_num
) {
565 * We are about to close the stream so set the data pending flag to 1
566 * which will make the end data pending command skip the stream which
567 * is now closed and ready. Note that after proceeding to a file close,
568 * the written file is ready for reading.
570 stream
->data_pending_check_done
= 1;
576 static void try_close_stream(struct relay_session
*session
,
577 struct relay_stream
*stream
)
580 struct ctf_trace
*ctf_trace
;
585 if (!close_stream_check(stream
)) {
586 /* Can't close it, not ready for that. */
590 ctf_trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
,
594 pthread_mutex_lock(&session
->viewer_ready_lock
);
595 ctf_trace
->invalid_flag
= 1;
596 pthread_mutex_unlock(&session
->viewer_ready_lock
);
598 ret
= stream_close(session
, stream
);
599 if (ret
|| session
->snapshot
) {
600 /* Already close thus the ctf trace is being or has been destroyed. */
604 ctf_trace_try_destroy(session
, ctf_trace
);
611 * This thread manages the listening for new connections on the network
614 void *relay_thread_listener(void *data
)
616 int i
, ret
, pollfd
, err
= -1;
617 uint32_t revents
, nb_fd
;
618 struct lttng_poll_event events
;
619 struct lttcomm_sock
*control_sock
, *data_sock
;
621 DBG("[thread] Relay listener started");
623 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
625 health_code_update();
627 control_sock
= relay_init_sock(control_uri
);
629 goto error_sock_control
;
632 data_sock
= relay_init_sock(data_uri
);
634 goto error_sock_relay
;
638 * Pass 3 as size here for the thread quit pipe, control and data socket.
640 ret
= create_thread_poll_set(&events
, 3);
642 goto error_create_poll
;
645 /* Add the control socket */
646 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
651 /* Add the data socket */
652 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
657 lttng_relay_notify_ready();
659 if (testpoint(relayd_thread_listener
)) {
660 goto error_testpoint
;
664 health_code_update();
666 DBG("Listener accepting connections");
670 ret
= lttng_poll_wait(&events
, -1);
674 * Restart interrupted system call.
676 if (errno
== EINTR
) {
684 DBG("Relay new connection received");
685 for (i
= 0; i
< nb_fd
; i
++) {
686 health_code_update();
688 /* Fetch once the poll data */
689 revents
= LTTNG_POLL_GETEV(&events
, i
);
690 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
692 /* Thread quit pipe has been closed. Killing thread. */
693 ret
= check_thread_quit_pipe(pollfd
, revents
);
699 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
700 ERR("socket poll error");
702 } else if (revents
& LPOLLIN
) {
704 * Get allocated in this thread, enqueued to a global queue,
705 * dequeued and freed in the worker thread.
708 struct relay_connection
*new_conn
;
709 struct lttcomm_sock
*newsock
;
711 new_conn
= connection_create();
716 if (pollfd
== data_sock
->fd
) {
717 new_conn
->type
= RELAY_DATA
;
718 newsock
= data_sock
->ops
->accept(data_sock
);
719 DBG("Relay data connection accepted, socket %d",
722 assert(pollfd
== control_sock
->fd
);
723 new_conn
->type
= RELAY_CONTROL
;
724 newsock
= control_sock
->ops
->accept(control_sock
);
725 DBG("Relay control connection accepted, socket %d",
729 PERROR("accepting sock");
730 connection_free(new_conn
);
734 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
737 PERROR("setsockopt inet");
738 lttcomm_destroy_sock(newsock
);
739 connection_free(new_conn
);
742 new_conn
->sock
= newsock
;
744 /* Enqueue request for the dispatcher thread. */
745 cds_wfq_enqueue(&relay_conn_queue
.queue
, &new_conn
->qnode
);
748 * Wake the dispatch queue futex. Implicit memory barrier with
749 * the exchange in cds_wfq_enqueue.
751 futex_nto1_wake(&relay_conn_queue
.futex
);
760 lttng_poll_clean(&events
);
762 if (data_sock
->fd
>= 0) {
763 ret
= data_sock
->ops
->close(data_sock
);
768 lttcomm_destroy_sock(data_sock
);
770 if (control_sock
->fd
>= 0) {
771 ret
= control_sock
->ops
->close(control_sock
);
776 lttcomm_destroy_sock(control_sock
);
780 ERR("Health error occurred in %s", __func__
);
782 health_unregister(health_relayd
);
783 DBG("Relay listener thread cleanup complete");
789 * This thread manages the dispatching of the requests to worker threads
792 void *relay_thread_dispatcher(void *data
)
796 struct cds_wfq_node
*node
;
797 struct relay_connection
*new_conn
= NULL
;
799 DBG("[thread] Relay dispatcher started");
801 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
803 if (testpoint(relayd_thread_dispatcher
)) {
804 goto error_testpoint
;
807 health_code_update();
809 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
810 health_code_update();
812 /* Atomically prepare the queue futex */
813 futex_nto1_prepare(&relay_conn_queue
.futex
);
816 health_code_update();
818 /* Dequeue commands */
819 node
= cds_wfq_dequeue_blocking(&relay_conn_queue
.queue
);
821 DBG("Woken up but nothing in the relay command queue");
822 /* Continue thread execution */
825 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
827 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
830 * Inform worker thread of the new request. This call is blocking
831 * so we can be assured that the data will be read at some point in
832 * time or wait to the end of the world :)
834 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
836 PERROR("write connection pipe");
837 connection_destroy(new_conn
);
840 } while (node
!= NULL
);
842 /* Futex wait on queue. Blocking call on futex() */
844 futex_nto1_wait(&relay_conn_queue
.futex
);
848 /* Normal exit, no error */
855 ERR("Health error occurred in %s", __func__
);
857 health_unregister(health_relayd
);
858 DBG("Dispatch thread dying");
863 static void try_close_streams(struct relay_session
*session
)
865 struct ctf_trace
*ctf_trace
;
866 struct lttng_ht_iter iter
;
870 pthread_mutex_lock(&session
->viewer_ready_lock
);
872 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
, &iter
.iter
, ctf_trace
,
874 struct relay_stream
*stream
;
877 cds_list_for_each_entry(stream
, &ctf_trace
->stream_list
, trace_list
) {
878 stream_close(session
, stream
);
881 ctf_trace
->invalid_flag
= 1;
882 ctf_trace_try_destroy(session
, ctf_trace
);
885 pthread_mutex_unlock(&session
->viewer_ready_lock
);
889 * Try to destroy a session within a connection.
891 static void destroy_session(struct relay_session
*session
,
892 struct lttng_ht
*sessions_ht
)
897 /* Indicate that this session can be destroyed from now on. */
898 session
->close_flag
= 1;
900 try_close_streams(session
);
903 * This will try to delete and destroy the session if no viewer is attached
904 * to it meaning the refcount is down to zero.
906 session_try_destroy(sessions_ht
, session
);
910 * Copy index data from the control port to a given index object.
912 static void copy_index_control_data(struct relay_index
*index
,
913 struct lttcomm_relayd_index
*data
)
919 * The index on disk is encoded in big endian, so we don't need to convert
920 * the data received on the network. The data_offset value is NEVER
921 * modified here and is updated by the data thread.
923 index
->index_data
.packet_size
= data
->packet_size
;
924 index
->index_data
.content_size
= data
->content_size
;
925 index
->index_data
.timestamp_begin
= data
->timestamp_begin
;
926 index
->index_data
.timestamp_end
= data
->timestamp_end
;
927 index
->index_data
.events_discarded
= data
->events_discarded
;
928 index
->index_data
.stream_id
= data
->stream_id
;
932 * Handle the RELAYD_CREATE_SESSION command.
934 * On success, send back the session id or else return a negative value.
937 int relay_create_session(struct lttcomm_relayd_hdr
*recv_hdr
,
938 struct relay_connection
*conn
)
940 int ret
= 0, send_ret
;
941 struct relay_session
*session
;
942 struct lttcomm_relayd_status_session reply
;
947 memset(&reply
, 0, sizeof(reply
));
949 session
= session_create();
954 session
->minor
= conn
->minor
;
955 session
->major
= conn
->major
;
956 conn
->session_id
= session
->id
;
957 conn
->session
= session
;
959 reply
.session_id
= htobe64(session
->id
);
961 switch (conn
->minor
) {
966 case 4: /* LTTng sessiond 2.4 */
968 ret
= cmd_create_session_2_4(conn
, session
);
971 lttng_ht_add_unique_u64(conn
->sessions_ht
, &session
->session_n
);
972 DBG("Created session %" PRIu64
, session
->id
);
976 reply
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
978 reply
.ret_code
= htobe32(LTTNG_OK
);
981 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
983 ERR("Relayd sending session id");
991 * When we have received all the streams and the metadata for a channel,
992 * we make them visible to the viewer threads.
995 void set_viewer_ready_flag(struct relay_connection
*conn
)
997 struct relay_stream
*stream
, *tmp_stream
;
999 pthread_mutex_lock(&conn
->session
->viewer_ready_lock
);
1000 cds_list_for_each_entry_safe(stream
, tmp_stream
, &conn
->recv_head
,
1002 stream
->viewer_ready
= 1;
1003 cds_list_del(&stream
->recv_list
);
1005 pthread_mutex_unlock(&conn
->session
->viewer_ready_lock
);
1010 * Add a recv handle node to the connection recv list with the given stream
1011 * handle. A new node is allocated thus must be freed when the node is deleted
1014 static void queue_stream(struct relay_stream
*stream
,
1015 struct relay_connection
*conn
)
1020 cds_list_add(&stream
->recv_list
, &conn
->recv_head
);
1024 * relay_add_stream: allocate a new stream for a session
1027 int relay_add_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1028 struct relay_connection
*conn
)
1031 struct relay_session
*session
= conn
->session
;
1032 struct relay_stream
*stream
= NULL
;
1033 struct lttcomm_relayd_status_stream reply
;
1034 struct ctf_trace
*trace
;
1036 if (!session
|| conn
->version_check_done
== 0) {
1037 ERR("Trying to add a stream before version check");
1039 goto end_no_session
;
1042 stream
= zmalloc(sizeof(struct relay_stream
));
1043 if (stream
== NULL
) {
1044 PERROR("relay stream zmalloc");
1046 goto end_no_session
;
1049 switch (conn
->minor
) {
1050 case 1: /* LTTng sessiond 2.1 */
1051 ret
= cmd_recv_stream_2_1(conn
, stream
);
1053 case 2: /* LTTng sessiond 2.2 */
1055 ret
= cmd_recv_stream_2_2(conn
, stream
);
1059 goto err_free_stream
;
1063 stream
->stream_handle
= ++last_relay_stream_id
;
1064 stream
->prev_seq
= -1ULL;
1065 stream
->session_id
= session
->id
;
1066 stream
->index_fd
= -1;
1067 stream
->read_index_fd
= -1;
1068 lttng_ht_node_init_u64(&stream
->node
, stream
->stream_handle
);
1069 pthread_mutex_init(&stream
->lock
, NULL
);
1071 ret
= utils_mkdir_recursive(stream
->path_name
, S_IRWXU
| S_IRWXG
);
1073 ERR("relay creating output directory");
1078 * No need to use run_as API here because whatever we receives, the relayd
1079 * uses its own credentials for the stream files.
1081 ret
= utils_create_stream_file(stream
->path_name
, stream
->channel_name
,
1082 stream
->tracefile_size
, 0, relayd_uid
, relayd_gid
, NULL
);
1084 ERR("Create output file");
1088 if (stream
->tracefile_size
) {
1089 DBG("Tracefile %s/%s_0 created", stream
->path_name
, stream
->channel_name
);
1091 DBG("Tracefile %s/%s created", stream
->path_name
, stream
->channel_name
);
1094 trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
, stream
->path_name
);
1096 trace
= ctf_trace_create(stream
->path_name
);
1101 ctf_trace_add(session
->ctf_traces_ht
, trace
);
1103 ctf_trace_get_ref(trace
);
1105 if (!strncmp(stream
->channel_name
, DEFAULT_METADATA_NAME
, NAME_MAX
)) {
1106 stream
->metadata_flag
= 1;
1107 /* Assign quick reference to the metadata stream in the trace. */
1108 trace
->metadata_stream
= stream
;
1112 * Add the stream in the recv list of the connection. Once the end stream
1113 * message is received, this list is emptied and streams are set with the
1114 * viewer ready flag.
1116 queue_stream(stream
, conn
);
1119 * Both in the ctf_trace object and the global stream ht since the data
1120 * side of the relayd does not have the concept of session.
1122 lttng_ht_add_unique_u64(relay_streams_ht
, &stream
->node
);
1123 cds_list_add_tail(&stream
->trace_list
, &trace
->stream_list
);
1125 session
->stream_count
++;
1127 DBG("Relay new stream added %s with ID %" PRIu64
, stream
->channel_name
,
1128 stream
->stream_handle
);
1131 memset(&reply
, 0, sizeof(reply
));
1132 reply
.handle
= htobe64(stream
->stream_handle
);
1133 /* send the session id to the client or a negative return code on error */
1135 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1136 /* stream was not properly added to the ht, so free it */
1139 reply
.ret_code
= htobe32(LTTNG_OK
);
1142 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1143 sizeof(struct lttcomm_relayd_status_stream
), 0);
1145 ERR("Relay sending stream id");
1154 free(stream
->path_name
);
1155 free(stream
->channel_name
);
1161 * relay_close_stream: close a specific stream
1164 int relay_close_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1165 struct relay_connection
*conn
)
1168 struct relay_session
*session
= conn
->session
;
1169 struct lttcomm_relayd_close_stream stream_info
;
1170 struct lttcomm_relayd_generic_reply reply
;
1171 struct relay_stream
*stream
;
1173 DBG("Close stream received");
1175 if (!session
|| conn
->version_check_done
== 0) {
1176 ERR("Trying to close a stream before version check");
1178 goto end_no_session
;
1181 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &stream_info
,
1182 sizeof(struct lttcomm_relayd_close_stream
), 0);
1183 if (ret
< sizeof(struct lttcomm_relayd_close_stream
)) {
1185 /* Orderly shutdown. Not necessary to print an error. */
1186 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1188 ERR("Relay didn't receive valid add_stream struct size : %d", ret
);
1191 goto end_no_session
;
1195 stream
= stream_find_by_id(relay_streams_ht
,
1196 be64toh(stream_info
.stream_id
));
1202 stream
->last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1203 stream
->close_flag
= 1;
1204 session
->stream_count
--;
1205 assert(session
->stream_count
>= 0);
1208 * Remove the stream from the connection recv list since we are about to
1209 * flag it invalid and thus might be freed. This has to be done here since
1210 * only the control thread can do actions on that list.
1212 * Note that this stream might NOT be in the list but we have to try to
1213 * remove it here else this can race with the stream destruction freeing
1214 * the object and the connection destroy doing a use after free when
1215 * deleting the remaining nodes in this list.
1217 cds_list_del(&stream
->recv_list
);
1219 /* Check if we can close it or else the data will do it. */
1220 try_close_stream(session
, stream
);
1225 memset(&reply
, 0, sizeof(reply
));
1227 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1229 reply
.ret_code
= htobe32(LTTNG_OK
);
1231 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1232 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1234 ERR("Relay sending stream id");
1243 * relay_unknown_command: send -1 if received unknown command
1246 void relay_unknown_command(struct relay_connection
*conn
)
1248 struct lttcomm_relayd_generic_reply reply
;
1251 memset(&reply
, 0, sizeof(reply
));
1252 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1253 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1254 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1256 ERR("Relay sending unknown command");
1261 * relay_start: send an acknowledgment to the client to tell if we are
1262 * ready to receive data. We are ready if a session is established.
1265 int relay_start(struct lttcomm_relayd_hdr
*recv_hdr
,
1266 struct relay_connection
*conn
)
1268 int ret
= htobe32(LTTNG_OK
);
1269 struct lttcomm_relayd_generic_reply reply
;
1270 struct relay_session
*session
= conn
->session
;
1273 DBG("Trying to start the streaming without a session established");
1274 ret
= htobe32(LTTNG_ERR_UNK
);
1277 memset(&reply
, 0, sizeof(reply
));
1278 reply
.ret_code
= ret
;
1279 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1280 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1282 ERR("Relay sending start ack");
1289 * Append padding to the file pointed by the file descriptor fd.
1291 static int write_padding_to_file(int fd
, uint32_t size
)
1300 zeros
= zmalloc(size
);
1301 if (zeros
== NULL
) {
1302 PERROR("zmalloc zeros for padding");
1307 ret
= lttng_write(fd
, zeros
, size
);
1309 PERROR("write padding to file");
1319 * relay_recv_metadata: receive the metada for the session.
1322 int relay_recv_metadata(struct lttcomm_relayd_hdr
*recv_hdr
,
1323 struct relay_connection
*conn
)
1325 int ret
= htobe32(LTTNG_OK
);
1327 struct relay_session
*session
= conn
->session
;
1328 struct lttcomm_relayd_metadata_payload
*metadata_struct
;
1329 struct relay_stream
*metadata_stream
;
1330 uint64_t data_size
, payload_size
;
1331 struct ctf_trace
*ctf_trace
;
1334 ERR("Metadata sent before version check");
1339 data_size
= payload_size
= be64toh(recv_hdr
->data_size
);
1340 if (data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1341 ERR("Incorrect data size");
1345 payload_size
-= sizeof(struct lttcomm_relayd_metadata_payload
);
1347 if (data_buffer_size
< data_size
) {
1348 /* In case the realloc fails, we can free the memory */
1351 tmp_data_ptr
= realloc(data_buffer
, data_size
);
1352 if (!tmp_data_ptr
) {
1353 ERR("Allocating data buffer");
1358 data_buffer
= tmp_data_ptr
;
1359 data_buffer_size
= data_size
;
1361 memset(data_buffer
, 0, data_size
);
1362 DBG2("Relay receiving metadata, waiting for %" PRIu64
" bytes", data_size
);
1363 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
1364 if (ret
< 0 || ret
!= data_size
) {
1366 /* Orderly shutdown. Not necessary to print an error. */
1367 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1369 ERR("Relay didn't receive the whole metadata");
1374 metadata_struct
= (struct lttcomm_relayd_metadata_payload
*) data_buffer
;
1377 metadata_stream
= stream_find_by_id(relay_streams_ht
,
1378 be64toh(metadata_struct
->stream_id
));
1379 if (!metadata_stream
) {
1384 size_ret
= lttng_write(metadata_stream
->fd
, metadata_struct
->payload
,
1386 if (size_ret
< payload_size
) {
1387 ERR("Relay error writing metadata on file");
1392 ret
= write_padding_to_file(metadata_stream
->fd
,
1393 be32toh(metadata_struct
->padding_size
));
1398 ctf_trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
,
1399 metadata_stream
->path_name
);
1401 ctf_trace
->metadata_received
+=
1402 payload_size
+ be32toh(metadata_struct
->padding_size
);
1404 DBG2("Relay metadata written");
1413 * relay_send_version: send relayd version number
1416 int relay_send_version(struct lttcomm_relayd_hdr
*recv_hdr
,
1417 struct relay_connection
*conn
)
1420 struct lttcomm_relayd_version reply
, msg
;
1424 conn
->version_check_done
= 1;
1426 /* Get version from the other side. */
1427 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1428 if (ret
< 0 || ret
!= sizeof(msg
)) {
1430 /* Orderly shutdown. Not necessary to print an error. */
1431 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1433 ERR("Relay failed to receive the version values.");
1439 memset(&reply
, 0, sizeof(reply
));
1440 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
1441 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
1443 /* Major versions must be the same */
1444 if (reply
.major
!= be32toh(msg
.major
)) {
1445 DBG("Incompatible major versions (%u vs %u), deleting session",
1446 reply
.major
, be32toh(msg
.major
));
1447 destroy_session(conn
->session
, conn
->sessions_ht
);
1452 conn
->major
= reply
.major
;
1453 /* We adapt to the lowest compatible version */
1454 if (reply
.minor
<= be32toh(msg
.minor
)) {
1455 conn
->minor
= reply
.minor
;
1457 conn
->minor
= be32toh(msg
.minor
);
1460 reply
.major
= htobe32(reply
.major
);
1461 reply
.minor
= htobe32(reply
.minor
);
1462 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1463 sizeof(struct lttcomm_relayd_version
), 0);
1465 ERR("Relay sending version");
1468 DBG("Version check done using protocol %u.%u", conn
->major
,
1476 * Check for data pending for a given stream id from the session daemon.
1479 int relay_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1480 struct relay_connection
*conn
)
1482 struct relay_session
*session
= conn
->session
;
1483 struct lttcomm_relayd_data_pending msg
;
1484 struct lttcomm_relayd_generic_reply reply
;
1485 struct relay_stream
*stream
;
1487 uint64_t last_net_seq_num
, stream_id
;
1489 DBG("Data pending command received");
1491 if (!session
|| conn
->version_check_done
== 0) {
1492 ERR("Trying to check for data before version check");
1494 goto end_no_session
;
1497 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1498 if (ret
< sizeof(msg
)) {
1500 /* Orderly shutdown. Not necessary to print an error. */
1501 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1503 ERR("Relay didn't receive valid data_pending struct size : %d",
1507 goto end_no_session
;
1510 stream_id
= be64toh(msg
.stream_id
);
1511 last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
1514 stream
= stream_find_by_id(relay_streams_ht
, stream_id
);
1515 if (stream
== NULL
) {
1520 DBG("Data pending for stream id %" PRIu64
" prev_seq %" PRIu64
1521 " and last_seq %" PRIu64
, stream_id
, stream
->prev_seq
,
1524 /* Avoid wrapping issue */
1525 if (((int64_t) (stream
->prev_seq
- last_net_seq_num
)) >= 0) {
1526 /* Data has in fact been written and is NOT pending */
1529 /* Data still being streamed thus pending */
1533 /* Pending check is now done. */
1534 stream
->data_pending_check_done
= 1;
1539 memset(&reply
, 0, sizeof(reply
));
1540 reply
.ret_code
= htobe32(ret
);
1541 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1543 ERR("Relay data pending ret code failed");
1551 * Wait for the control socket to reach a quiescent state.
1553 * Note that for now, when receiving this command from the session daemon, this
1554 * means that every subsequent commands or data received on the control socket
1555 * has been handled. So, this is why we simply return OK here.
1558 int relay_quiescent_control(struct lttcomm_relayd_hdr
*recv_hdr
,
1559 struct relay_connection
*conn
)
1563 struct relay_stream
*stream
;
1564 struct lttng_ht_iter iter
;
1565 struct lttcomm_relayd_quiescent_control msg
;
1566 struct lttcomm_relayd_generic_reply reply
;
1568 DBG("Checking quiescent state on control socket");
1570 if (!conn
->session
|| conn
->version_check_done
== 0) {
1571 ERR("Trying to check for data before version check");
1573 goto end_no_session
;
1576 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1577 if (ret
< sizeof(msg
)) {
1579 /* Orderly shutdown. Not necessary to print an error. */
1580 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1582 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1586 goto end_no_session
;
1589 stream_id
= be64toh(msg
.stream_id
);
1592 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1594 if (stream
->stream_handle
== stream_id
) {
1595 stream
->data_pending_check_done
= 1;
1596 DBG("Relay quiescent control pending flag set to %" PRIu64
,
1603 memset(&reply
, 0, sizeof(reply
));
1604 reply
.ret_code
= htobe32(LTTNG_OK
);
1605 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1607 ERR("Relay data quiescent control ret code failed");
1615 * Initialize a data pending command. This means that a client is about to ask
1616 * for data pending for each stream he/she holds. Simply iterate over all
1617 * streams of a session and set the data_pending_check_done flag.
1619 * This command returns to the client a LTTNG_OK code.
1622 int relay_begin_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1623 struct relay_connection
*conn
)
1626 struct lttng_ht_iter iter
;
1627 struct lttcomm_relayd_begin_data_pending msg
;
1628 struct lttcomm_relayd_generic_reply reply
;
1629 struct relay_stream
*stream
;
1630 uint64_t session_id
;
1635 DBG("Init streams for data pending");
1637 if (!conn
->session
|| conn
->version_check_done
== 0) {
1638 ERR("Trying to check for data before version check");
1640 goto end_no_session
;
1643 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1644 if (ret
< sizeof(msg
)) {
1646 /* Orderly shutdown. Not necessary to print an error. */
1647 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1649 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1653 goto end_no_session
;
1656 session_id
= be64toh(msg
.session_id
);
1659 * Iterate over all streams to set the begin data pending flag. For now, the
1660 * streams are indexed by stream handle so we have to iterate over all
1661 * streams to find the one associated with the right session_id.
1664 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1666 if (stream
->session_id
== session_id
) {
1667 stream
->data_pending_check_done
= 0;
1668 DBG("Set begin data pending flag to stream %" PRIu64
,
1669 stream
->stream_handle
);
1674 memset(&reply
, 0, sizeof(reply
));
1675 /* All good, send back reply. */
1676 reply
.ret_code
= htobe32(LTTNG_OK
);
1678 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1680 ERR("Relay begin data pending send reply failed");
1688 * End data pending command. This will check, for a given session id, if each
1689 * stream associated with it has its data_pending_check_done flag set. If not,
1690 * this means that the client lost track of the stream but the data is still
1691 * being streamed on our side. In this case, we inform the client that data is
1694 * Return to the client if there is data in flight or not with a ret_code.
1697 int relay_end_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1698 struct relay_connection
*conn
)
1701 struct lttng_ht_iter iter
;
1702 struct lttcomm_relayd_end_data_pending msg
;
1703 struct lttcomm_relayd_generic_reply reply
;
1704 struct relay_stream
*stream
;
1705 uint64_t session_id
;
1706 uint32_t is_data_inflight
= 0;
1711 DBG("End data pending command");
1713 if (!conn
->session
|| conn
->version_check_done
== 0) {
1714 ERR("Trying to check for data before version check");
1716 goto end_no_session
;
1719 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1720 if (ret
< sizeof(msg
)) {
1722 /* Orderly shutdown. Not necessary to print an error. */
1723 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1725 ERR("Relay didn't receive valid end data_pending struct size: %d",
1729 goto end_no_session
;
1732 session_id
= be64toh(msg
.session_id
);
1734 /* Iterate over all streams to see if the begin data pending flag is set. */
1736 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1738 if (stream
->session_id
== session_id
&&
1739 !stream
->data_pending_check_done
&& !stream
->terminated_flag
) {
1740 is_data_inflight
= 1;
1741 DBG("Data is still in flight for stream %" PRIu64
,
1742 stream
->stream_handle
);
1748 memset(&reply
, 0, sizeof(reply
));
1749 /* All good, send back reply. */
1750 reply
.ret_code
= htobe32(is_data_inflight
);
1752 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1754 ERR("Relay end data pending send reply failed");
1762 * Receive an index for a specific stream.
1764 * Return 0 on success else a negative value.
1767 int relay_recv_index(struct lttcomm_relayd_hdr
*recv_hdr
,
1768 struct relay_connection
*conn
)
1770 int ret
, send_ret
, index_created
= 0;
1771 struct relay_session
*session
= conn
->session
;
1772 struct lttcomm_relayd_index index_info
;
1773 struct relay_index
*index
, *wr_index
= NULL
;
1774 struct lttcomm_relayd_generic_reply reply
;
1775 struct relay_stream
*stream
;
1776 uint64_t net_seq_num
;
1780 DBG("Relay receiving index");
1782 if (!session
|| conn
->version_check_done
== 0) {
1783 ERR("Trying to close a stream before version check");
1785 goto end_no_session
;
1788 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &index_info
,
1789 sizeof(index_info
), 0);
1790 if (ret
< sizeof(index_info
)) {
1792 /* Orderly shutdown. Not necessary to print an error. */
1793 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1795 ERR("Relay didn't receive valid index struct size : %d", ret
);
1798 goto end_no_session
;
1801 net_seq_num
= be64toh(index_info
.net_seq_num
);
1804 stream
= stream_find_by_id(relay_streams_ht
,
1805 be64toh(index_info
.relay_stream_id
));
1808 goto end_rcu_unlock
;
1811 /* Live beacon handling */
1812 if (index_info
.packet_size
== 0) {
1813 DBG("Received live beacon for stream %" PRIu64
, stream
->stream_handle
);
1816 * Only flag a stream inactive when it has already received data.
1818 if (stream
->total_index_received
> 0) {
1819 stream
->beacon_ts_end
= be64toh(index_info
.timestamp_end
);
1822 goto end_rcu_unlock
;
1824 stream
->beacon_ts_end
= -1ULL;
1827 index
= relay_index_find(stream
->stream_handle
, net_seq_num
);
1829 /* A successful creation will add the object to the HT. */
1830 index
= relay_index_create(stream
->stream_handle
, net_seq_num
);
1832 goto end_rcu_unlock
;
1837 copy_index_control_data(index
, &index_info
);
1839 if (index_created
) {
1841 * Try to add the relay index object to the hash table. If an object
1842 * already exist, destroy back the index created, set the data in this
1843 * object and write it on disk.
1845 relay_index_add(index
, &wr_index
);
1847 copy_index_control_data(wr_index
, &index_info
);
1851 /* The index already exists so write it on disk. */
1855 /* Do we have a writable ready index to write on disk. */
1857 ret
= relay_index_write(wr_index
->fd
, wr_index
);
1859 goto end_rcu_unlock
;
1861 stream
->total_index_received
++;
1867 memset(&reply
, 0, sizeof(reply
));
1869 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1871 reply
.ret_code
= htobe32(LTTNG_OK
);
1873 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1875 ERR("Relay sending close index id reply");
1884 * Receive the streams_sent message.
1886 * Return 0 on success else a negative value.
1889 int relay_streams_sent(struct lttcomm_relayd_hdr
*recv_hdr
,
1890 struct relay_connection
*conn
)
1893 struct lttcomm_relayd_generic_reply reply
;
1897 DBG("Relay receiving streams_sent");
1899 if (!conn
->session
|| conn
->version_check_done
== 0) {
1900 ERR("Trying to close a stream before version check");
1902 goto end_no_session
;
1906 * Flag every pending stream in the connection recv list that they are
1907 * ready to be used by the viewer.
1909 set_viewer_ready_flag(conn
);
1912 * Inform the viewer that there are new streams in the session.
1914 if (conn
->session
->viewer_refcount
) {
1915 uatomic_set(&conn
->session
->new_streams
, 1);
1918 memset(&reply
, 0, sizeof(reply
));
1919 reply
.ret_code
= htobe32(LTTNG_OK
);
1920 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1922 ERR("Relay sending sent_stream reply");
1934 * Process the commands received on the control socket
1937 int relay_process_control(struct lttcomm_relayd_hdr
*recv_hdr
,
1938 struct relay_connection
*conn
)
1942 switch (be32toh(recv_hdr
->cmd
)) {
1943 case RELAYD_CREATE_SESSION
:
1944 ret
= relay_create_session(recv_hdr
, conn
);
1946 case RELAYD_ADD_STREAM
:
1947 ret
= relay_add_stream(recv_hdr
, conn
);
1949 case RELAYD_START_DATA
:
1950 ret
= relay_start(recv_hdr
, conn
);
1952 case RELAYD_SEND_METADATA
:
1953 ret
= relay_recv_metadata(recv_hdr
, conn
);
1955 case RELAYD_VERSION
:
1956 ret
= relay_send_version(recv_hdr
, conn
);
1958 case RELAYD_CLOSE_STREAM
:
1959 ret
= relay_close_stream(recv_hdr
, conn
);
1961 case RELAYD_DATA_PENDING
:
1962 ret
= relay_data_pending(recv_hdr
, conn
);
1964 case RELAYD_QUIESCENT_CONTROL
:
1965 ret
= relay_quiescent_control(recv_hdr
, conn
);
1967 case RELAYD_BEGIN_DATA_PENDING
:
1968 ret
= relay_begin_data_pending(recv_hdr
, conn
);
1970 case RELAYD_END_DATA_PENDING
:
1971 ret
= relay_end_data_pending(recv_hdr
, conn
);
1973 case RELAYD_SEND_INDEX
:
1974 ret
= relay_recv_index(recv_hdr
, conn
);
1976 case RELAYD_STREAMS_SENT
:
1977 ret
= relay_streams_sent(recv_hdr
, conn
);
1979 case RELAYD_UPDATE_SYNC_INFO
:
1981 ERR("Received unknown command (%u)", be32toh(recv_hdr
->cmd
));
1982 relay_unknown_command(conn
);
1992 * Handle index for a data stream.
1994 * RCU read side lock MUST be acquired.
1996 * Return 0 on success else a negative value.
1998 static int handle_index_data(struct relay_stream
*stream
, uint64_t net_seq_num
,
2001 int ret
= 0, index_created
= 0;
2002 uint64_t stream_id
, data_offset
;
2003 struct relay_index
*index
, *wr_index
= NULL
;
2007 stream_id
= stream
->stream_handle
;
2008 /* Get data offset because we are about to update the index. */
2009 data_offset
= htobe64(stream
->tracefile_size_current
);
2012 * Lookup for an existing index for that stream id/sequence number. If on
2013 * exists, the control thread already received the data for it thus we need
2014 * to write it on disk.
2016 index
= relay_index_find(stream_id
, net_seq_num
);
2018 /* A successful creation will add the object to the HT. */
2019 index
= relay_index_create(stream_id
, net_seq_num
);
2027 if (rotate_index
|| stream
->index_fd
< 0) {
2028 index
->to_close_fd
= stream
->index_fd
;
2029 ret
= index_create_file(stream
->path_name
, stream
->channel_name
,
2030 relayd_uid
, relayd_gid
, stream
->tracefile_size
,
2031 stream
->tracefile_count_current
);
2033 /* This will close the stream's index fd if one. */
2034 relay_index_free_safe(index
);
2037 stream
->index_fd
= ret
;
2039 index
->fd
= stream
->index_fd
;
2040 index
->index_data
.offset
= data_offset
;
2042 if (index_created
) {
2044 * Try to add the relay index object to the hash table. If an object
2045 * already exist, destroy back the index created and set the data.
2047 relay_index_add(index
, &wr_index
);
2049 /* Copy back data from the created index. */
2050 wr_index
->fd
= index
->fd
;
2051 wr_index
->to_close_fd
= index
->to_close_fd
;
2052 wr_index
->index_data
.offset
= data_offset
;
2056 /* The index already exists so write it on disk. */
2060 /* Do we have a writable ready index to write on disk. */
2062 ret
= relay_index_write(wr_index
->fd
, wr_index
);
2066 stream
->total_index_received
++;
2074 * relay_process_data: Process the data received on the data socket
2077 int relay_process_data(struct relay_connection
*conn
)
2079 int ret
= 0, rotate_index
= 0;
2081 struct relay_stream
*stream
;
2082 struct lttcomm_relayd_data_hdr data_hdr
;
2084 uint64_t net_seq_num
;
2086 struct relay_session
*session
;
2090 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &data_hdr
,
2091 sizeof(struct lttcomm_relayd_data_hdr
), 0);
2094 /* Orderly shutdown. Not necessary to print an error. */
2095 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2097 ERR("Unable to receive data header on sock %d", conn
->sock
->fd
);
2103 stream_id
= be64toh(data_hdr
.stream_id
);
2106 stream
= stream_find_by_id(relay_streams_ht
, stream_id
);
2109 goto end_rcu_unlock
;
2112 session
= session_find_by_id(conn
->sessions_ht
, stream
->session_id
);
2115 data_size
= be32toh(data_hdr
.data_size
);
2116 if (data_buffer_size
< data_size
) {
2119 tmp_data_ptr
= realloc(data_buffer
, data_size
);
2120 if (!tmp_data_ptr
) {
2121 ERR("Allocating data buffer");
2124 goto end_rcu_unlock
;
2126 data_buffer
= tmp_data_ptr
;
2127 data_buffer_size
= data_size
;
2129 memset(data_buffer
, 0, data_size
);
2131 net_seq_num
= be64toh(data_hdr
.net_seq_num
);
2133 DBG3("Receiving data of size %u for stream id %" PRIu64
" seqnum %" PRIu64
,
2134 data_size
, stream_id
, net_seq_num
);
2135 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
2138 /* Orderly shutdown. Not necessary to print an error. */
2139 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2142 goto end_rcu_unlock
;
2145 /* Check if a rotation is needed. */
2146 if (stream
->tracefile_size
> 0 &&
2147 (stream
->tracefile_size_current
+ data_size
) >
2148 stream
->tracefile_size
) {
2149 struct relay_viewer_stream
*vstream
;
2152 new_id
= (stream
->tracefile_count_current
+ 1) %
2153 stream
->tracefile_count
;
2155 * When we wrap-around back to 0, we start overwriting old
2158 if (!stream
->tracefile_overwrite
&& new_id
== 0) {
2159 stream
->tracefile_overwrite
= 1;
2161 pthread_mutex_lock(&stream
->viewer_stream_rotation_lock
);
2162 if (stream
->tracefile_overwrite
) {
2163 stream
->oldest_tracefile_id
=
2164 (stream
->oldest_tracefile_id
+ 1) %
2165 stream
->tracefile_count
;
2167 vstream
= viewer_stream_find_by_id(stream
->stream_handle
);
2170 * The viewer is reading a file about to be
2171 * overwritten. Close the FDs it is
2172 * currently using and let it handle the fault.
2174 if (vstream
->tracefile_count_current
== new_id
) {
2175 pthread_mutex_lock(&vstream
->overwrite_lock
);
2176 vstream
->abort_flag
= 1;
2177 pthread_mutex_unlock(&vstream
->overwrite_lock
);
2178 DBG("Streaming side setting abort_flag on stream %s_%lu\n",
2179 stream
->channel_name
, new_id
);
2180 } else if (vstream
->tracefile_count_current
==
2181 stream
->tracefile_count_current
) {
2183 * The reader and writer were in the
2184 * same trace file, inform the viewer
2185 * that no new index will ever be added
2188 vstream
->close_write_flag
= 1;
2191 ret
= utils_rotate_stream_file(stream
->path_name
, stream
->channel_name
,
2192 stream
->tracefile_size
, stream
->tracefile_count
,
2193 relayd_uid
, relayd_gid
, stream
->fd
,
2194 &(stream
->tracefile_count_current
), &stream
->fd
);
2195 stream
->total_index_received
= 0;
2196 pthread_mutex_unlock(&stream
->viewer_stream_rotation_lock
);
2198 ERR("Rotating stream output file");
2199 goto end_rcu_unlock
;
2201 /* Reset current size because we just perform a stream rotation. */
2202 stream
->tracefile_size_current
= 0;
2207 * Index are handled in protocol version 2.4 and above. Also, snapshot and
2208 * index are NOT supported.
2210 if (session
->minor
>= 4 && !session
->snapshot
) {
2211 ret
= handle_index_data(stream
, net_seq_num
, rotate_index
);
2213 goto end_rcu_unlock
;
2217 /* Write data to stream output fd. */
2218 size_ret
= lttng_write(stream
->fd
, data_buffer
, data_size
);
2219 if (size_ret
< data_size
) {
2220 ERR("Relay error writing data to file");
2222 goto end_rcu_unlock
;
2225 DBG2("Relay wrote %d bytes to tracefile for stream id %" PRIu64
,
2226 ret
, stream
->stream_handle
);
2228 ret
= write_padding_to_file(stream
->fd
, be32toh(data_hdr
.padding_size
));
2230 goto end_rcu_unlock
;
2232 stream
->tracefile_size_current
+= data_size
+ be32toh(data_hdr
.padding_size
);
2234 stream
->prev_seq
= net_seq_num
;
2236 try_close_stream(session
, stream
);
2245 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
2251 (void) lttng_poll_del(events
, pollfd
);
2253 ret
= close(pollfd
);
2255 ERR("Closing pollfd %d", pollfd
);
2259 static void destroy_connection(struct lttng_ht
*relay_connections_ht
,
2260 struct relay_connection
*conn
)
2262 assert(relay_connections_ht
);
2265 connection_delete(relay_connections_ht
, conn
);
2267 /* For the control socket, we try to destroy the session. */
2268 if (conn
->type
== RELAY_CONTROL
&& conn
->session
) {
2269 destroy_session(conn
->session
, conn
->sessions_ht
);
2272 connection_destroy(conn
);
2276 * This thread does the actual work
2279 void *relay_thread_worker(void *data
)
2281 int ret
, err
= -1, last_seen_data_fd
= -1;
2283 struct relay_connection
*conn
;
2284 struct lttng_poll_event events
;
2285 struct lttng_ht
*relay_connections_ht
;
2286 struct lttng_ht_iter iter
;
2287 struct lttcomm_relayd_hdr recv_hdr
;
2288 struct relay_local_data
*relay_ctx
= (struct relay_local_data
*) data
;
2289 struct lttng_ht
*sessions_ht
= relay_ctx
->sessions_ht
;
2291 DBG("[thread] Relay worker started");
2293 rcu_register_thread();
2295 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
2297 if (testpoint(relayd_thread_worker
)) {
2298 goto error_testpoint
;
2301 health_code_update();
2303 /* table of connections indexed on socket */
2304 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2305 if (!relay_connections_ht
) {
2306 goto relay_connections_ht_error
;
2309 /* Tables of received indexes indexed by index handle and net_seq_num. */
2310 indexes_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_TWO_U64
);
2312 goto indexes_ht_error
;
2315 ret
= create_thread_poll_set(&events
, 2);
2317 goto error_poll_create
;
2320 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2327 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
2329 health_code_update();
2331 /* Infinite blocking call, waiting for transmission */
2332 DBG3("Relayd worker thread polling...");
2333 health_poll_entry();
2334 ret
= lttng_poll_wait(&events
, -1);
2338 * Restart interrupted system call.
2340 if (errno
== EINTR
) {
2349 * Process control. The control connection is prioritised so we don't
2350 * starve it with high throughout put tracing data on the data
2353 for (i
= 0; i
< nb_fd
; i
++) {
2354 /* Fetch once the poll data */
2355 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2356 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2358 health_code_update();
2360 /* Thread quit pipe has been closed. Killing thread. */
2361 ret
= check_thread_quit_pipe(pollfd
, revents
);
2367 /* Inspect the relay conn pipe for new connection */
2368 if (pollfd
== relay_conn_pipe
[0]) {
2369 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2370 ERR("Relay connection pipe error");
2372 } else if (revents
& LPOLLIN
) {
2373 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
2377 conn
->sessions_ht
= sessions_ht
;
2378 connection_init(conn
);
2379 lttng_poll_add(&events
, conn
->sock
->fd
,
2380 LPOLLIN
| LPOLLRDHUP
);
2382 lttng_ht_add_unique_ulong(relay_connections_ht
,
2385 DBG("Connection socket %d added", conn
->sock
->fd
);
2389 conn
= connection_find_by_sock(relay_connections_ht
, pollfd
);
2390 /* If not found, there is a synchronization issue. */
2393 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2394 cleanup_connection_pollfd(&events
, pollfd
);
2395 destroy_connection(relay_connections_ht
, conn
);
2396 if (last_seen_data_fd
== pollfd
) {
2397 last_seen_data_fd
= last_notdel_data_fd
;
2399 } else if (revents
& LPOLLIN
) {
2400 if (conn
->type
== RELAY_CONTROL
) {
2401 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2402 sizeof(recv_hdr
), 0);
2404 /* Connection closed */
2405 cleanup_connection_pollfd(&events
, pollfd
);
2406 destroy_connection(relay_connections_ht
, conn
);
2407 DBG("Control connection closed with %d", pollfd
);
2409 ret
= relay_process_control(&recv_hdr
, conn
);
2411 /* Clear the session on error. */
2412 cleanup_connection_pollfd(&events
, pollfd
);
2413 destroy_connection(relay_connections_ht
, conn
);
2414 DBG("Connection closed with %d", pollfd
);
2420 * Flag the last seen data fd not deleted. It will be
2421 * used as the last seen fd if any fd gets deleted in
2424 last_notdel_data_fd
= pollfd
;
2427 ERR("Unknown poll events %u for sock %d", revents
, pollfd
);
2434 * The last loop handled a control request, go back to poll to make
2435 * sure we prioritise the control socket.
2441 if (last_seen_data_fd
>= 0) {
2442 for (i
= 0; i
< nb_fd
; i
++) {
2443 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2445 health_code_update();
2447 if (last_seen_data_fd
== pollfd
) {
2454 /* Process data connection. */
2455 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
2456 /* Fetch the poll data. */
2457 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2458 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2460 health_code_update();
2462 /* Skip the command pipe. It's handled in the first loop. */
2463 if (pollfd
== relay_conn_pipe
[0]) {
2469 conn
= connection_find_by_sock(relay_connections_ht
, pollfd
);
2471 /* Skip it. Might be removed before. */
2476 if (revents
& LPOLLIN
) {
2477 if (conn
->type
!= RELAY_DATA
) {
2481 ret
= relay_process_data(conn
);
2482 /* Connection closed */
2484 cleanup_connection_pollfd(&events
, pollfd
);
2485 destroy_connection(relay_connections_ht
, conn
);
2486 DBG("Data connection closed with %d", pollfd
);
2488 * Every goto restart call sets the last seen fd where
2489 * here we don't really care since we gracefully
2490 * continue the loop after the connection is deleted.
2493 /* Keep last seen port. */
2494 last_seen_data_fd
= pollfd
;
2502 last_seen_data_fd
= -1;
2505 /* Normal exit, no error */
2510 lttng_poll_clean(&events
);
2512 /* Cleanup reamaining connection object. */
2514 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
, conn
,
2516 health_code_update();
2517 destroy_connection(relay_connections_ht
, conn
);
2521 lttng_ht_destroy(indexes_ht
);
2523 lttng_ht_destroy(relay_connections_ht
);
2524 relay_connections_ht_error
:
2525 /* Close relay conn pipes */
2526 utils_close_pipe(relay_conn_pipe
);
2528 DBG("Thread exited with error");
2530 DBG("Worker thread cleanup complete");
2535 ERR("Health error occurred in %s", __func__
);
2537 health_unregister(health_relayd
);
2538 rcu_unregister_thread();
2544 * Create the relay command pipe to wake thread_manage_apps.
2545 * Closed in cleanup().
2547 static int create_relay_conn_pipe(void)
2551 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
2559 int main(int argc
, char **argv
)
2563 struct relay_local_data
*relay_ctx
;
2565 /* Parse arguments */
2567 if ((ret
= parse_args(argc
, argv
)) < 0) {
2571 if ((ret
= set_signal_handler()) < 0) {
2575 /* Try to create directory if -o, --output is specified. */
2576 if (opt_output_path
) {
2577 if (*opt_output_path
!= '/') {
2578 ERR("Please specify an absolute path for -o, --output PATH");
2582 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
);
2584 ERR("Unable to create %s", opt_output_path
);
2590 if (opt_daemon
|| opt_background
) {
2593 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
2600 * We are in the child. Make sure all other file
2601 * descriptors are closed, in case we are called with
2602 * more opened file descriptors than the standard ones.
2604 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
2609 /* Create thread quit pipe */
2610 if ((ret
= init_thread_quit_pipe()) < 0) {
2614 /* We need those values for the file/dir creation. */
2615 relayd_uid
= getuid();
2616 relayd_gid
= getgid();
2618 /* Check if daemon is UID = 0 */
2619 if (relayd_uid
== 0) {
2620 if (control_uri
->port
< 1024 || data_uri
->port
< 1024 ||
2621 live_uri
->port
< 1024) {
2622 ERR("Need to be root to use ports < 1024");
2628 /* Setup the thread apps communication pipe. */
2629 if ((ret
= create_relay_conn_pipe()) < 0) {
2633 /* Init relay command queue. */
2634 cds_wfq_init(&relay_conn_queue
.queue
);
2636 /* Set up max poll set size */
2637 lttng_poll_set_max_size();
2639 /* Initialize communication library */
2641 lttcomm_inet_init();
2643 relay_ctx
= zmalloc(sizeof(struct relay_local_data
));
2645 PERROR("relay_ctx");
2649 /* tables of sessions indexed by session ID */
2650 relay_ctx
->sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2651 if (!relay_ctx
->sessions_ht
) {
2652 goto exit_relay_ctx_sessions
;
2655 /* tables of streams indexed by stream ID */
2656 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2657 if (!relay_streams_ht
) {
2658 goto exit_relay_ctx_streams
;
2661 /* tables of streams indexed by stream ID */
2662 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2663 if (!viewer_streams_ht
) {
2664 goto exit_relay_ctx_viewer_streams
;
2667 /* Initialize thread health monitoring */
2668 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
2669 if (!health_relayd
) {
2670 PERROR("health_app_create error");
2671 goto exit_health_app_create
;
2674 ret
= utils_create_pipe(health_quit_pipe
);
2676 goto error_health_pipe
;
2679 /* Create thread to manage the client socket */
2680 ret
= pthread_create(&health_thread
, NULL
,
2681 thread_manage_health
, (void *) NULL
);
2683 PERROR("pthread_create health");
2687 /* Setup the dispatcher thread */
2688 ret
= pthread_create(&dispatcher_thread
, NULL
,
2689 relay_thread_dispatcher
, (void *) NULL
);
2691 PERROR("pthread_create dispatcher");
2692 goto exit_dispatcher
;
2695 /* Setup the worker thread */
2696 ret
= pthread_create(&worker_thread
, NULL
,
2697 relay_thread_worker
, (void *) relay_ctx
);
2699 PERROR("pthread_create worker");
2703 /* Setup the listener thread */
2704 ret
= pthread_create(&listener_thread
, NULL
,
2705 relay_thread_listener
, (void *) NULL
);
2707 PERROR("pthread_create listener");
2711 ret
= live_start_threads(live_uri
, relay_ctx
);
2713 ERR("Starting live viewer threads");
2718 ret
= pthread_join(listener_thread
, &status
);
2720 PERROR("pthread_join");
2721 goto error
; /* join error, exit without cleanup */
2725 ret
= pthread_join(worker_thread
, &status
);
2727 PERROR("pthread_join");
2728 goto error
; /* join error, exit without cleanup */
2732 ret
= pthread_join(dispatcher_thread
, &status
);
2734 PERROR("pthread_join");
2735 goto error
; /* join error, exit without cleanup */
2739 ret
= pthread_join(health_thread
, &status
);
2741 PERROR("pthread_join health thread");
2742 goto error
; /* join error, exit without cleanup */
2746 * Stop live threads only after joining other threads.
2748 live_stop_threads();
2751 utils_close_pipe(health_quit_pipe
);
2754 health_app_destroy(health_relayd
);
2756 exit_health_app_create
:
2757 lttng_ht_destroy(viewer_streams_ht
);
2759 exit_relay_ctx_viewer_streams
:
2760 lttng_ht_destroy(relay_streams_ht
);
2762 exit_relay_ctx_streams
:
2763 lttng_ht_destroy(relay_ctx
->sessions_ht
);
2765 exit_relay_ctx_sessions
: