2 * Copyright (C) 2012 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
4 * 2013 - Jérémie Galarneau <jeremie.galarneau@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>
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/daemonize.h>
50 #include <common/futex.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/config/config.h>
59 #include "ctf-trace.h"
62 #include "lttng-relayd.h"
64 #include "health-relayd.h"
65 #include "testpoint.h"
66 #include "viewer-stream.h"
69 #include "connection.h"
71 /* command line options */
72 char *opt_output_path
;
73 static int opt_daemon
, opt_background
;
76 * We need to wait for listener and live listener threads, as well as
77 * health check thread, before being ready to signal readiness.
79 #define NR_LTTNG_RELAY_READY 3
80 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
81 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
82 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
84 static struct lttng_uri
*control_uri
;
85 static struct lttng_uri
*data_uri
;
86 static struct lttng_uri
*live_uri
;
90 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
91 static int tracing_group_name_override
;
93 const char * const config_section_name
= "relayd";
96 * Quit pipe for all threads. This permits a single cancellation point
97 * for all threads when receiving an event on the pipe.
99 int thread_quit_pipe
[2] = { -1, -1 };
102 * This pipe is used to inform the worker thread that a command is queued and
103 * ready to be processed.
105 static int relay_conn_pipe
[2] = { -1, -1 };
107 /* Shared between threads */
108 static int dispatch_thread_exit
;
110 static pthread_t listener_thread
;
111 static pthread_t dispatcher_thread
;
112 static pthread_t worker_thread
;
113 static pthread_t health_thread
;
115 static uint64_t last_relay_stream_id
;
118 * Relay command queue.
120 * The relay_thread_listener and relay_thread_dispatcher communicate with this
123 static struct relay_conn_queue relay_conn_queue
;
125 /* buffer allocated at startup, used to store the trace data */
126 static char *data_buffer
;
127 static unsigned int data_buffer_size
;
129 /* We need those values for the file/dir creation. */
130 static uid_t relayd_uid
;
131 static gid_t relayd_gid
;
133 /* Global relay stream hash table. */
134 struct lttng_ht
*relay_streams_ht
;
136 /* Global relay viewer stream hash table. */
137 struct lttng_ht
*viewer_streams_ht
;
139 /* Global hash table that stores relay index object. */
140 struct lttng_ht
*indexes_ht
;
142 /* Relayd health monitoring */
143 struct health_app
*health_relayd
;
145 static struct option long_options
[] = {
146 { "control-port", 1, 0, 'C', },
147 { "data-port", 1, 0, 'D', },
148 { "live-port", 1, 0, 'L', },
149 { "daemonize", 0, 0, 'd', },
150 { "background", 0, 0, 'b', },
151 { "group", 1, 0, 'g', },
152 { "help", 0, 0, 'h', },
153 { "output", 1, 0, 'o', },
154 { "verbose", 0, 0, 'v', },
155 { "config", 1, 0, 'f' },
159 static const char *config_ignore_options
[] = { "help", "config" };
162 * usage function on stderr
167 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
168 fprintf(stderr
, " -h, --help Display this usage.\n");
169 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
170 fprintf(stderr
, " -b, --background Start as a daemon, keeping console open.\n");
171 fprintf(stderr
, " -C, --control-port URL Control port listening.\n");
172 fprintf(stderr
, " -D, --data-port URL Data port listening.\n");
173 fprintf(stderr
, " -L, --live-port URL Live view port listening.\n");
174 fprintf(stderr
, " -o, --output PATH Output path for traces. Must use an absolute path.\n");
175 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
176 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
177 fprintf(stderr
, " -f --config Load daemon configuration file\n");
181 * Take an option from the getopt output and set it in the right variable to be
184 * Return 0 on success else a negative value.
187 int set_option(int opt
, const char *arg
, const char *optname
)
193 fprintf(stderr
, "option %s", optname
);
195 fprintf(stderr
, " with arg %s\n", arg
);
199 ret
= uri_parse(arg
, &control_uri
);
201 ERR("Invalid control URI specified");
204 if (control_uri
->port
== 0) {
205 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
209 ret
= uri_parse(arg
, &data_uri
);
211 ERR("Invalid data URI specified");
214 if (data_uri
->port
== 0) {
215 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
219 ret
= uri_parse(arg
, &live_uri
);
221 ERR("Invalid live URI specified");
224 if (live_uri
->port
== 0) {
225 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
235 tracing_group_name
= strdup(arg
);
236 if (tracing_group_name
== NULL
) {
241 tracing_group_name_override
= 1;
247 ret
= asprintf(&opt_output_path
, "%s", arg
);
250 PERROR("asprintf opt_output_path");
255 /* Verbose level can increase using multiple -v */
257 lttng_opt_verbose
= config_parse_value(arg
);
259 /* Only 3 level of verbosity (-vvv). */
260 if (lttng_opt_verbose
< 3) {
261 lttng_opt_verbose
+= 1;
266 /* Unknown option or other error.
267 * Error is printed by getopt, just return */
280 * config_entry_handler_cb used to handle options read from a config file.
281 * See config_entry_handler_cb comment in common/config/config.h for the
282 * return value conventions.
285 int config_entry_handler(const struct config_entry
*entry
, void *unused
)
289 if (!entry
|| !entry
->name
|| !entry
->value
) {
294 /* Check if the option is to be ignored */
295 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
296 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
301 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1; i
++) {
302 /* Ignore if entry name is not fully matched. */
303 if (strcmp(entry
->name
, long_options
[i
].name
)) {
308 * If the option takes no argument on the command line, we have to
309 * check if the value is "true". We support non-zero numeric values,
312 if (!long_options
[i
].has_arg
) {
313 ret
= config_parse_value(entry
->value
);
316 WARN("Invalid configuration value \"%s\" for option %s",
317 entry
->value
, entry
->name
);
319 /* False, skip boolean config option. */
324 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
328 WARN("Unrecognized option \"%s\" in daemon configuration file.",
336 int set_options(int argc
, char **argv
)
338 int c
, ret
= 0, option_index
= 0;
339 int orig_optopt
= optopt
, orig_optind
= optind
;
340 char *default_address
, *optstring
;
341 const char *config_path
= NULL
;
343 optstring
= utils_generate_optstring(long_options
,
344 sizeof(long_options
) / sizeof(struct option
));
350 /* Check for the --config option */
352 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
353 &option_index
)) != -1) {
357 } else if (c
!= 'f') {
361 config_path
= utils_expand_path(optarg
);
363 ERR("Failed to resolve path: %s", optarg
);
367 ret
= config_get_section_entries(config_path
, config_section_name
,
368 config_entry_handler
, NULL
);
371 ERR("Invalid configuration option at line %i", ret
);
377 /* Reset getopt's global state */
378 optopt
= orig_optopt
;
379 optind
= orig_optind
;
381 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
386 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
392 /* assign default values */
393 if (control_uri
== NULL
) {
394 ret
= asprintf(&default_address
,
395 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
396 DEFAULT_NETWORK_CONTROL_PORT
);
398 PERROR("asprintf default data address");
402 ret
= uri_parse(default_address
, &control_uri
);
403 free(default_address
);
405 ERR("Invalid control URI specified");
409 if (data_uri
== NULL
) {
410 ret
= asprintf(&default_address
,
411 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
412 DEFAULT_NETWORK_DATA_PORT
);
414 PERROR("asprintf default data address");
418 ret
= uri_parse(default_address
, &data_uri
);
419 free(default_address
);
421 ERR("Invalid data URI specified");
425 if (live_uri
== NULL
) {
426 ret
= asprintf(&default_address
,
427 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
428 DEFAULT_NETWORK_VIEWER_PORT
);
430 PERROR("asprintf default viewer control address");
434 ret
= uri_parse(default_address
, &live_uri
);
435 free(default_address
);
437 ERR("Invalid viewer control URI specified");
455 /* free the dynamically allocated opt_output_path */
456 free(opt_output_path
);
458 /* Close thread quit pipes */
459 utils_close_pipe(thread_quit_pipe
);
461 uri_free(control_uri
);
463 /* Live URI is freed in the live thread. */
465 if (tracing_group_name_override
) {
466 free((void *) tracing_group_name
);
471 * Write to writable pipe used to notify a thread.
474 int notify_thread_pipe(int wpipe
)
478 ret
= lttng_write(wpipe
, "!", 1);
480 PERROR("write poll pipe");
486 static void notify_health_quit_pipe(int *pipe
)
490 ret
= lttng_write(pipe
[1], "4", 1);
492 PERROR("write relay health quit");
497 * Stop all threads by closing the thread quit pipe.
500 void stop_threads(void)
504 /* Stopping all threads */
505 DBG("Terminating all threads");
506 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
508 ERR("write error on thread quit pipe");
511 notify_health_quit_pipe(health_quit_pipe
);
513 /* Dispatch thread */
514 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
515 futex_nto1_wake(&relay_conn_queue
.futex
);
519 * Signal handler for the daemon
521 * Simply stop all worker threads, leaving main() return gracefully after
522 * joining all threads and calling cleanup().
525 void sighandler(int sig
)
529 DBG("SIGPIPE caught");
532 DBG("SIGINT caught");
536 DBG("SIGTERM caught");
540 CMM_STORE_SHARED(recv_child_signal
, 1);
548 * Setup signal handler for :
549 * SIGINT, SIGTERM, SIGPIPE
552 int set_signal_handler(void)
558 if ((ret
= sigemptyset(&sigset
)) < 0) {
559 PERROR("sigemptyset");
563 sa
.sa_handler
= sighandler
;
566 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
571 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
576 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
581 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
586 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
591 void lttng_relay_notify_ready(void)
593 /* Notify the parent of the fork() process that we are ready. */
594 if (opt_daemon
|| opt_background
) {
595 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
596 kill(child_ppid
, SIGUSR1
);
602 * Init thread quit pipe.
604 * Return -1 on error or 0 if all pipes are created.
607 int init_thread_quit_pipe(void)
611 ret
= utils_create_pipe_cloexec(thread_quit_pipe
);
617 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
620 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
624 if (events
== NULL
|| size
== 0) {
629 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
635 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
647 * Check if the thread quit pipe was triggered.
649 * Return 1 if it was triggered else 0;
652 int check_thread_quit_pipe(int fd
, uint32_t events
)
654 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
662 * Create and init socket from uri.
665 struct lttcomm_sock
*relay_init_sock(struct lttng_uri
*uri
)
668 struct lttcomm_sock
*sock
= NULL
;
670 sock
= lttcomm_alloc_sock_from_uri(uri
);
672 ERR("Allocating socket");
676 ret
= lttcomm_create_sock(sock
);
680 DBG("Listening on sock %d", sock
->fd
);
682 ret
= sock
->ops
->bind(sock
);
687 ret
= sock
->ops
->listen(sock
, -1);
697 lttcomm_destroy_sock(sock
);
703 * Return nonzero if stream needs to be closed.
706 int close_stream_check(struct relay_stream
*stream
)
708 if (stream
->close_flag
&& stream
->prev_seq
== stream
->last_net_seq_num
) {
710 * We are about to close the stream so set the data pending flag to 1
711 * which will make the end data pending command skip the stream which
712 * is now closed and ready. Note that after proceeding to a file close,
713 * the written file is ready for reading.
715 stream
->data_pending_check_done
= 1;
721 static void try_close_stream(struct relay_session
*session
,
722 struct relay_stream
*stream
)
725 struct ctf_trace
*ctf_trace
;
730 if (!close_stream_check(stream
)) {
731 /* Can't close it, not ready for that. */
735 ctf_trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
,
739 pthread_mutex_lock(&session
->viewer_ready_lock
);
740 ctf_trace
->invalid_flag
= 1;
741 pthread_mutex_unlock(&session
->viewer_ready_lock
);
743 ret
= stream_close(session
, stream
);
744 if (ret
|| session
->snapshot
) {
745 /* Already close thus the ctf trace is being or has been destroyed. */
749 ctf_trace_try_destroy(session
, ctf_trace
);
756 * This thread manages the listening for new connections on the network
759 void *relay_thread_listener(void *data
)
761 int i
, ret
, pollfd
, err
= -1;
762 uint32_t revents
, nb_fd
;
763 struct lttng_poll_event events
;
764 struct lttcomm_sock
*control_sock
, *data_sock
;
766 DBG("[thread] Relay listener started");
768 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
770 health_code_update();
772 control_sock
= relay_init_sock(control_uri
);
774 goto error_sock_control
;
777 data_sock
= relay_init_sock(data_uri
);
779 goto error_sock_relay
;
783 * Pass 3 as size here for the thread quit pipe, control and data socket.
785 ret
= create_thread_poll_set(&events
, 3);
787 goto error_create_poll
;
790 /* Add the control socket */
791 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
796 /* Add the data socket */
797 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
802 lttng_relay_notify_ready();
804 if (testpoint(relayd_thread_listener
)) {
805 goto error_testpoint
;
809 health_code_update();
811 DBG("Listener accepting connections");
815 ret
= lttng_poll_wait(&events
, -1);
819 * Restart interrupted system call.
821 if (errno
== EINTR
) {
829 DBG("Relay new connection received");
830 for (i
= 0; i
< nb_fd
; i
++) {
831 health_code_update();
833 /* Fetch once the poll data */
834 revents
= LTTNG_POLL_GETEV(&events
, i
);
835 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
837 /* Thread quit pipe has been closed. Killing thread. */
838 ret
= check_thread_quit_pipe(pollfd
, revents
);
844 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
845 ERR("socket poll error");
847 } else if (revents
& LPOLLIN
) {
849 * Get allocated in this thread, enqueued to a global queue,
850 * dequeued and freed in the worker thread.
853 struct relay_connection
*new_conn
;
854 struct lttcomm_sock
*newsock
;
856 new_conn
= connection_create();
861 if (pollfd
== data_sock
->fd
) {
862 new_conn
->type
= RELAY_DATA
;
863 newsock
= data_sock
->ops
->accept(data_sock
);
864 DBG("Relay data connection accepted, socket %d",
867 assert(pollfd
== control_sock
->fd
);
868 new_conn
->type
= RELAY_CONTROL
;
869 newsock
= control_sock
->ops
->accept(control_sock
);
870 DBG("Relay control connection accepted, socket %d",
874 PERROR("accepting sock");
875 connection_free(new_conn
);
879 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
882 PERROR("setsockopt inet");
883 lttcomm_destroy_sock(newsock
);
884 connection_free(new_conn
);
887 new_conn
->sock
= newsock
;
889 /* Enqueue request for the dispatcher thread. */
890 cds_wfcq_enqueue(&relay_conn_queue
.head
, &relay_conn_queue
.tail
,
894 * Wake the dispatch queue futex. Implicit memory barrier with
895 * the exchange in cds_wfcq_enqueue.
897 futex_nto1_wake(&relay_conn_queue
.futex
);
906 lttng_poll_clean(&events
);
908 if (data_sock
->fd
>= 0) {
909 ret
= data_sock
->ops
->close(data_sock
);
914 lttcomm_destroy_sock(data_sock
);
916 if (control_sock
->fd
>= 0) {
917 ret
= control_sock
->ops
->close(control_sock
);
922 lttcomm_destroy_sock(control_sock
);
926 ERR("Health error occurred in %s", __func__
);
928 health_unregister(health_relayd
);
929 DBG("Relay listener thread cleanup complete");
935 * This thread manages the dispatching of the requests to worker threads
938 void *relay_thread_dispatcher(void *data
)
942 struct cds_wfcq_node
*node
;
943 struct relay_connection
*new_conn
= NULL
;
945 DBG("[thread] Relay dispatcher started");
947 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
949 if (testpoint(relayd_thread_dispatcher
)) {
950 goto error_testpoint
;
953 health_code_update();
955 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
956 health_code_update();
958 /* Atomically prepare the queue futex */
959 futex_nto1_prepare(&relay_conn_queue
.futex
);
962 health_code_update();
964 /* Dequeue commands */
965 node
= cds_wfcq_dequeue_blocking(&relay_conn_queue
.head
,
966 &relay_conn_queue
.tail
);
968 DBG("Woken up but nothing in the relay command queue");
969 /* Continue thread execution */
972 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
974 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
977 * Inform worker thread of the new request. This call is blocking
978 * so we can be assured that the data will be read at some point in
979 * time or wait to the end of the world :)
981 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
983 PERROR("write connection pipe");
984 connection_destroy(new_conn
);
987 } while (node
!= NULL
);
989 /* Futex wait on queue. Blocking call on futex() */
991 futex_nto1_wait(&relay_conn_queue
.futex
);
995 /* Normal exit, no error */
1002 ERR("Health error occurred in %s", __func__
);
1004 health_unregister(health_relayd
);
1005 DBG("Dispatch thread dying");
1010 static void try_close_streams(struct relay_session
*session
)
1012 struct ctf_trace
*ctf_trace
;
1013 struct lttng_ht_iter iter
;
1017 pthread_mutex_lock(&session
->viewer_ready_lock
);
1019 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
, &iter
.iter
, ctf_trace
,
1021 struct relay_stream
*stream
;
1023 /* Close streams. */
1024 cds_list_for_each_entry(stream
, &ctf_trace
->stream_list
, trace_list
) {
1025 stream_close(session
, stream
);
1028 ctf_trace
->invalid_flag
= 1;
1029 ctf_trace_try_destroy(session
, ctf_trace
);
1032 pthread_mutex_unlock(&session
->viewer_ready_lock
);
1036 * Try to destroy a session within a connection.
1038 static void destroy_session(struct relay_session
*session
,
1039 struct lttng_ht
*sessions_ht
)
1042 assert(sessions_ht
);
1044 /* Indicate that this session can be destroyed from now on. */
1045 session
->close_flag
= 1;
1047 try_close_streams(session
);
1050 * This will try to delete and destroy the session if no viewer is attached
1051 * to it meaning the refcount is down to zero.
1053 session_try_destroy(sessions_ht
, session
);
1057 * Copy index data from the control port to a given index object.
1059 static void copy_index_control_data(struct relay_index
*index
,
1060 struct lttcomm_relayd_index
*data
)
1066 * The index on disk is encoded in big endian, so we don't need to convert
1067 * the data received on the network. The data_offset value is NEVER
1068 * modified here and is updated by the data thread.
1070 index
->index_data
.packet_size
= data
->packet_size
;
1071 index
->index_data
.content_size
= data
->content_size
;
1072 index
->index_data
.timestamp_begin
= data
->timestamp_begin
;
1073 index
->index_data
.timestamp_end
= data
->timestamp_end
;
1074 index
->index_data
.events_discarded
= data
->events_discarded
;
1075 index
->index_data
.stream_id
= data
->stream_id
;
1079 * Handle the RELAYD_CREATE_SESSION command.
1081 * On success, send back the session id or else return a negative value.
1084 int relay_create_session(struct lttcomm_relayd_hdr
*recv_hdr
,
1085 struct relay_connection
*conn
)
1087 int ret
= 0, send_ret
;
1088 struct relay_session
*session
;
1089 struct lttcomm_relayd_status_session reply
;
1094 memset(&reply
, 0, sizeof(reply
));
1096 session
= session_create();
1101 session
->minor
= conn
->minor
;
1102 session
->major
= conn
->major
;
1103 conn
->session_id
= session
->id
;
1104 conn
->session
= session
;
1106 reply
.session_id
= htobe64(session
->id
);
1108 switch (conn
->minor
) {
1113 case 4: /* LTTng sessiond 2.4 */
1115 ret
= cmd_create_session_2_4(conn
, session
);
1118 lttng_ht_add_unique_u64(conn
->sessions_ht
, &session
->session_n
);
1119 DBG("Created session %" PRIu64
, session
->id
);
1123 reply
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1125 reply
.ret_code
= htobe32(LTTNG_OK
);
1128 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1130 ERR("Relayd sending session id");
1138 * When we have received all the streams and the metadata for a channel,
1139 * we make them visible to the viewer threads.
1142 void set_viewer_ready_flag(struct relay_connection
*conn
)
1144 struct relay_stream
*stream
, *tmp_stream
;
1146 pthread_mutex_lock(&conn
->session
->viewer_ready_lock
);
1147 cds_list_for_each_entry_safe(stream
, tmp_stream
, &conn
->recv_head
,
1149 stream
->viewer_ready
= 1;
1150 cds_list_del(&stream
->recv_list
);
1152 pthread_mutex_unlock(&conn
->session
->viewer_ready_lock
);
1157 * Add a recv handle node to the connection recv list with the given stream
1158 * handle. A new node is allocated thus must be freed when the node is deleted
1161 static void queue_stream(struct relay_stream
*stream
,
1162 struct relay_connection
*conn
)
1167 cds_list_add(&stream
->recv_list
, &conn
->recv_head
);
1171 * relay_add_stream: allocate a new stream for a session
1174 int relay_add_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1175 struct relay_connection
*conn
)
1178 struct relay_session
*session
= conn
->session
;
1179 struct relay_stream
*stream
= NULL
;
1180 struct lttcomm_relayd_status_stream reply
;
1181 struct ctf_trace
*trace
;
1183 if (!session
|| conn
->version_check_done
== 0) {
1184 ERR("Trying to add a stream before version check");
1186 goto end_no_session
;
1189 stream
= zmalloc(sizeof(struct relay_stream
));
1190 if (stream
== NULL
) {
1191 PERROR("relay stream zmalloc");
1193 goto end_no_session
;
1196 switch (conn
->minor
) {
1197 case 1: /* LTTng sessiond 2.1 */
1198 ret
= cmd_recv_stream_2_1(conn
, stream
);
1200 case 2: /* LTTng sessiond 2.2 */
1202 ret
= cmd_recv_stream_2_2(conn
, stream
);
1206 goto err_free_stream
;
1210 stream
->stream_handle
= ++last_relay_stream_id
;
1211 stream
->prev_seq
= -1ULL;
1212 stream
->session_id
= session
->id
;
1213 stream
->index_fd
= -1;
1214 stream
->read_index_fd
= -1;
1215 stream
->ctf_stream_id
= -1ULL;
1216 lttng_ht_node_init_u64(&stream
->node
, stream
->stream_handle
);
1217 pthread_mutex_init(&stream
->lock
, NULL
);
1219 ret
= utils_mkdir_recursive(stream
->path_name
, S_IRWXU
| S_IRWXG
);
1221 ERR("relay creating output directory");
1226 * No need to use run_as API here because whatever we receives, the relayd
1227 * uses its own credentials for the stream files.
1229 ret
= utils_create_stream_file(stream
->path_name
, stream
->channel_name
,
1230 stream
->tracefile_size
, 0, relayd_uid
, relayd_gid
, NULL
);
1232 ERR("Create output file");
1236 if (stream
->tracefile_size
) {
1237 DBG("Tracefile %s/%s_0 created", stream
->path_name
, stream
->channel_name
);
1239 DBG("Tracefile %s/%s created", stream
->path_name
, stream
->channel_name
);
1242 trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
, stream
->path_name
);
1244 trace
= ctf_trace_create(stream
->path_name
);
1249 ctf_trace_add(session
->ctf_traces_ht
, trace
);
1251 ctf_trace_get_ref(trace
);
1253 if (!strncmp(stream
->channel_name
, DEFAULT_METADATA_NAME
, NAME_MAX
)) {
1254 stream
->metadata_flag
= 1;
1255 /* Assign quick reference to the metadata stream in the trace. */
1256 trace
->metadata_stream
= stream
;
1260 * Add the stream in the recv list of the connection. Once the end stream
1261 * message is received, this list is emptied and streams are set with the
1262 * viewer ready flag.
1264 queue_stream(stream
, conn
);
1267 * Both in the ctf_trace object and the global stream ht since the data
1268 * side of the relayd does not have the concept of session.
1270 lttng_ht_add_unique_u64(relay_streams_ht
, &stream
->node
);
1271 cds_list_add_tail(&stream
->trace_list
, &trace
->stream_list
);
1273 session
->stream_count
++;
1275 DBG("Relay new stream added %s with ID %" PRIu64
, stream
->channel_name
,
1276 stream
->stream_handle
);
1279 memset(&reply
, 0, sizeof(reply
));
1280 reply
.handle
= htobe64(stream
->stream_handle
);
1281 /* send the session id to the client or a negative return code on error */
1283 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1284 /* stream was not properly added to the ht, so free it */
1287 reply
.ret_code
= htobe32(LTTNG_OK
);
1290 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1291 sizeof(struct lttcomm_relayd_status_stream
), 0);
1293 ERR("Relay sending stream id");
1302 free(stream
->path_name
);
1303 free(stream
->channel_name
);
1309 * relay_close_stream: close a specific stream
1312 int relay_close_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1313 struct relay_connection
*conn
)
1316 struct relay_session
*session
= conn
->session
;
1317 struct lttcomm_relayd_close_stream stream_info
;
1318 struct lttcomm_relayd_generic_reply reply
;
1319 struct relay_stream
*stream
;
1321 DBG("Close stream received");
1323 if (!session
|| conn
->version_check_done
== 0) {
1324 ERR("Trying to close a stream before version check");
1326 goto end_no_session
;
1329 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &stream_info
,
1330 sizeof(struct lttcomm_relayd_close_stream
), 0);
1331 if (ret
< sizeof(struct lttcomm_relayd_close_stream
)) {
1333 /* Orderly shutdown. Not necessary to print an error. */
1334 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1336 ERR("Relay didn't receive valid add_stream struct size : %d", ret
);
1339 goto end_no_session
;
1343 stream
= stream_find_by_id(relay_streams_ht
,
1344 be64toh(stream_info
.stream_id
));
1350 stream
->last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1351 stream
->close_flag
= 1;
1352 session
->stream_count
--;
1354 /* Check if we can close it or else the data will do it. */
1355 try_close_stream(session
, stream
);
1360 memset(&reply
, 0, sizeof(reply
));
1362 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1364 reply
.ret_code
= htobe32(LTTNG_OK
);
1366 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1367 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1369 ERR("Relay sending stream id");
1378 * relay_unknown_command: send -1 if received unknown command
1381 void relay_unknown_command(struct relay_connection
*conn
)
1383 struct lttcomm_relayd_generic_reply reply
;
1386 memset(&reply
, 0, sizeof(reply
));
1387 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1388 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1389 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1391 ERR("Relay sending unknown command");
1396 * relay_start: send an acknowledgment to the client to tell if we are
1397 * ready to receive data. We are ready if a session is established.
1400 int relay_start(struct lttcomm_relayd_hdr
*recv_hdr
,
1401 struct relay_connection
*conn
)
1403 int ret
= htobe32(LTTNG_OK
);
1404 struct lttcomm_relayd_generic_reply reply
;
1405 struct relay_session
*session
= conn
->session
;
1408 DBG("Trying to start the streaming without a session established");
1409 ret
= htobe32(LTTNG_ERR_UNK
);
1412 memset(&reply
, 0, sizeof(reply
));
1413 reply
.ret_code
= ret
;
1414 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1415 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1417 ERR("Relay sending start ack");
1424 * Append padding to the file pointed by the file descriptor fd.
1426 static int write_padding_to_file(int fd
, uint32_t size
)
1435 zeros
= zmalloc(size
);
1436 if (zeros
== NULL
) {
1437 PERROR("zmalloc zeros for padding");
1442 ret
= lttng_write(fd
, zeros
, size
);
1444 PERROR("write padding to file");
1454 * relay_recv_metadata: receive the metada for the session.
1457 int relay_recv_metadata(struct lttcomm_relayd_hdr
*recv_hdr
,
1458 struct relay_connection
*conn
)
1460 int ret
= htobe32(LTTNG_OK
);
1462 struct relay_session
*session
= conn
->session
;
1463 struct lttcomm_relayd_metadata_payload
*metadata_struct
;
1464 struct relay_stream
*metadata_stream
;
1465 uint64_t data_size
, payload_size
;
1466 struct ctf_trace
*ctf_trace
;
1469 ERR("Metadata sent before version check");
1474 data_size
= payload_size
= be64toh(recv_hdr
->data_size
);
1475 if (data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1476 ERR("Incorrect data size");
1480 payload_size
-= sizeof(struct lttcomm_relayd_metadata_payload
);
1482 if (data_buffer_size
< data_size
) {
1483 /* In case the realloc fails, we can free the memory */
1486 tmp_data_ptr
= realloc(data_buffer
, data_size
);
1487 if (!tmp_data_ptr
) {
1488 ERR("Allocating data buffer");
1493 data_buffer
= tmp_data_ptr
;
1494 data_buffer_size
= data_size
;
1496 memset(data_buffer
, 0, data_size
);
1497 DBG2("Relay receiving metadata, waiting for %" PRIu64
" bytes", data_size
);
1498 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
1499 if (ret
< 0 || ret
!= data_size
) {
1501 /* Orderly shutdown. Not necessary to print an error. */
1502 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1504 ERR("Relay didn't receive the whole metadata");
1509 metadata_struct
= (struct lttcomm_relayd_metadata_payload
*) data_buffer
;
1512 metadata_stream
= stream_find_by_id(relay_streams_ht
,
1513 be64toh(metadata_struct
->stream_id
));
1514 if (!metadata_stream
) {
1519 size_ret
= lttng_write(metadata_stream
->fd
, metadata_struct
->payload
,
1521 if (size_ret
< payload_size
) {
1522 ERR("Relay error writing metadata on file");
1527 ret
= write_padding_to_file(metadata_stream
->fd
,
1528 be32toh(metadata_struct
->padding_size
));
1533 ctf_trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
,
1534 metadata_stream
->path_name
);
1536 ctf_trace
->metadata_received
+=
1537 payload_size
+ be32toh(metadata_struct
->padding_size
);
1539 DBG2("Relay metadata written");
1548 * relay_send_version: send relayd version number
1551 int relay_send_version(struct lttcomm_relayd_hdr
*recv_hdr
,
1552 struct relay_connection
*conn
)
1555 struct lttcomm_relayd_version reply
, msg
;
1559 conn
->version_check_done
= 1;
1561 /* Get version from the other side. */
1562 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1563 if (ret
< 0 || ret
!= sizeof(msg
)) {
1565 /* Orderly shutdown. Not necessary to print an error. */
1566 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1568 ERR("Relay failed to receive the version values.");
1574 memset(&reply
, 0, sizeof(reply
));
1575 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
1576 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
1578 /* Major versions must be the same */
1579 if (reply
.major
!= be32toh(msg
.major
)) {
1580 DBG("Incompatible major versions (%u vs %u), deleting session",
1581 reply
.major
, be32toh(msg
.major
));
1582 destroy_session(conn
->session
, conn
->sessions_ht
);
1587 conn
->major
= reply
.major
;
1588 /* We adapt to the lowest compatible version */
1589 if (reply
.minor
<= be32toh(msg
.minor
)) {
1590 conn
->minor
= reply
.minor
;
1592 conn
->minor
= be32toh(msg
.minor
);
1595 reply
.major
= htobe32(reply
.major
);
1596 reply
.minor
= htobe32(reply
.minor
);
1597 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1598 sizeof(struct lttcomm_relayd_version
), 0);
1600 ERR("Relay sending version");
1603 DBG("Version check done using protocol %u.%u", conn
->major
,
1611 * Check for data pending for a given stream id from the session daemon.
1614 int relay_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1615 struct relay_connection
*conn
)
1617 struct relay_session
*session
= conn
->session
;
1618 struct lttcomm_relayd_data_pending msg
;
1619 struct lttcomm_relayd_generic_reply reply
;
1620 struct relay_stream
*stream
;
1622 uint64_t last_net_seq_num
, stream_id
;
1624 DBG("Data pending command received");
1626 if (!session
|| conn
->version_check_done
== 0) {
1627 ERR("Trying to check for data before version check");
1629 goto end_no_session
;
1632 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1633 if (ret
< sizeof(msg
)) {
1635 /* Orderly shutdown. Not necessary to print an error. */
1636 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1638 ERR("Relay didn't receive valid data_pending struct size : %d",
1642 goto end_no_session
;
1645 stream_id
= be64toh(msg
.stream_id
);
1646 last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
1649 stream
= stream_find_by_id(relay_streams_ht
, stream_id
);
1650 if (stream
== NULL
) {
1655 DBG("Data pending for stream id %" PRIu64
" prev_seq %" PRIu64
1656 " and last_seq %" PRIu64
, stream_id
, stream
->prev_seq
,
1659 /* Avoid wrapping issue */
1660 if (((int64_t) (stream
->prev_seq
- last_net_seq_num
)) >= 0) {
1661 /* Data has in fact been written and is NOT pending */
1664 /* Data still being streamed thus pending */
1668 /* Pending check is now done. */
1669 stream
->data_pending_check_done
= 1;
1674 memset(&reply
, 0, sizeof(reply
));
1675 reply
.ret_code
= htobe32(ret
);
1676 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1678 ERR("Relay data pending ret code failed");
1686 * Wait for the control socket to reach a quiescent state.
1688 * Note that for now, when receiving this command from the session daemon, this
1689 * means that every subsequent commands or data received on the control socket
1690 * has been handled. So, this is why we simply return OK here.
1693 int relay_quiescent_control(struct lttcomm_relayd_hdr
*recv_hdr
,
1694 struct relay_connection
*conn
)
1698 struct relay_stream
*stream
;
1699 struct lttng_ht_iter iter
;
1700 struct lttcomm_relayd_quiescent_control msg
;
1701 struct lttcomm_relayd_generic_reply reply
;
1703 DBG("Checking quiescent state on control socket");
1705 if (!conn
->session
|| conn
->version_check_done
== 0) {
1706 ERR("Trying to check for data before version check");
1708 goto end_no_session
;
1711 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1712 if (ret
< sizeof(msg
)) {
1714 /* Orderly shutdown. Not necessary to print an error. */
1715 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1717 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1721 goto end_no_session
;
1724 stream_id
= be64toh(msg
.stream_id
);
1727 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1729 if (stream
->stream_handle
== stream_id
) {
1730 stream
->data_pending_check_done
= 1;
1731 DBG("Relay quiescent control pending flag set to %" PRIu64
,
1738 memset(&reply
, 0, sizeof(reply
));
1739 reply
.ret_code
= htobe32(LTTNG_OK
);
1740 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1742 ERR("Relay data quiescent control ret code failed");
1750 * Initialize a data pending command. This means that a client is about to ask
1751 * for data pending for each stream he/she holds. Simply iterate over all
1752 * streams of a session and set the data_pending_check_done flag.
1754 * This command returns to the client a LTTNG_OK code.
1757 int relay_begin_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1758 struct relay_connection
*conn
)
1761 struct lttng_ht_iter iter
;
1762 struct lttcomm_relayd_begin_data_pending msg
;
1763 struct lttcomm_relayd_generic_reply reply
;
1764 struct relay_stream
*stream
;
1765 uint64_t session_id
;
1770 DBG("Init streams for data pending");
1772 if (!conn
->session
|| conn
->version_check_done
== 0) {
1773 ERR("Trying to check for data before version check");
1775 goto end_no_session
;
1778 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1779 if (ret
< sizeof(msg
)) {
1781 /* Orderly shutdown. Not necessary to print an error. */
1782 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1784 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1788 goto end_no_session
;
1791 session_id
= be64toh(msg
.session_id
);
1794 * Iterate over all streams to set the begin data pending flag. For now, the
1795 * streams are indexed by stream handle so we have to iterate over all
1796 * streams to find the one associated with the right session_id.
1799 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1801 if (stream
->session_id
== session_id
) {
1802 stream
->data_pending_check_done
= 0;
1803 DBG("Set begin data pending flag to stream %" PRIu64
,
1804 stream
->stream_handle
);
1809 memset(&reply
, 0, sizeof(reply
));
1810 /* All good, send back reply. */
1811 reply
.ret_code
= htobe32(LTTNG_OK
);
1813 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1815 ERR("Relay begin data pending send reply failed");
1823 * End data pending command. This will check, for a given session id, if each
1824 * stream associated with it has its data_pending_check_done flag set. If not,
1825 * this means that the client lost track of the stream but the data is still
1826 * being streamed on our side. In this case, we inform the client that data is
1829 * Return to the client if there is data in flight or not with a ret_code.
1832 int relay_end_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1833 struct relay_connection
*conn
)
1836 struct lttng_ht_iter iter
;
1837 struct lttcomm_relayd_end_data_pending msg
;
1838 struct lttcomm_relayd_generic_reply reply
;
1839 struct relay_stream
*stream
;
1840 uint64_t session_id
;
1841 uint32_t is_data_inflight
= 0;
1846 DBG("End data pending command");
1848 if (!conn
->session
|| conn
->version_check_done
== 0) {
1849 ERR("Trying to check for data before version check");
1851 goto end_no_session
;
1854 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1855 if (ret
< sizeof(msg
)) {
1857 /* Orderly shutdown. Not necessary to print an error. */
1858 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1860 ERR("Relay didn't receive valid end data_pending struct size: %d",
1864 goto end_no_session
;
1867 session_id
= be64toh(msg
.session_id
);
1869 /* Iterate over all streams to see if the begin data pending flag is set. */
1871 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1873 if (stream
->session_id
== session_id
&&
1874 !stream
->data_pending_check_done
&& !stream
->terminated_flag
) {
1875 is_data_inflight
= 1;
1876 DBG("Data is still in flight for stream %" PRIu64
,
1877 stream
->stream_handle
);
1883 memset(&reply
, 0, sizeof(reply
));
1884 /* All good, send back reply. */
1885 reply
.ret_code
= htobe32(is_data_inflight
);
1887 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1889 ERR("Relay end data pending send reply failed");
1897 * Receive an index for a specific stream.
1899 * Return 0 on success else a negative value.
1902 int relay_recv_index(struct lttcomm_relayd_hdr
*recv_hdr
,
1903 struct relay_connection
*conn
)
1905 int ret
, send_ret
, index_created
= 0;
1906 struct relay_session
*session
= conn
->session
;
1907 struct lttcomm_relayd_index index_info
;
1908 struct relay_index
*index
, *wr_index
= NULL
;
1909 struct lttcomm_relayd_generic_reply reply
;
1910 struct relay_stream
*stream
;
1911 uint64_t net_seq_num
;
1915 DBG("Relay receiving index");
1917 if (!session
|| conn
->version_check_done
== 0) {
1918 ERR("Trying to close a stream before version check");
1920 goto end_no_session
;
1923 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &index_info
,
1924 sizeof(index_info
), 0);
1925 if (ret
< sizeof(index_info
)) {
1927 /* Orderly shutdown. Not necessary to print an error. */
1928 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1930 ERR("Relay didn't receive valid index struct size : %d", ret
);
1933 goto end_no_session
;
1936 net_seq_num
= be64toh(index_info
.net_seq_num
);
1939 stream
= stream_find_by_id(relay_streams_ht
,
1940 be64toh(index_info
.relay_stream_id
));
1943 goto end_rcu_unlock
;
1946 /* Live beacon handling */
1947 if (index_info
.packet_size
== 0) {
1948 DBG("Received live beacon for stream %" PRIu64
, stream
->stream_handle
);
1951 * Only flag a stream inactive when it has already received data
1952 * and no indexes are in flight.
1954 if (stream
->total_index_received
> 0 && stream
->indexes_in_flight
== 0) {
1955 stream
->beacon_ts_end
= be64toh(index_info
.timestamp_end
);
1958 goto end_rcu_unlock
;
1960 stream
->beacon_ts_end
= -1ULL;
1963 index
= relay_index_find(stream
->stream_handle
, net_seq_num
);
1965 /* A successful creation will add the object to the HT. */
1966 index
= relay_index_create(stream
->stream_handle
, net_seq_num
);
1968 goto end_rcu_unlock
;
1971 stream
->indexes_in_flight
++;
1974 copy_index_control_data(index
, &index_info
);
1975 if (stream
->ctf_stream_id
== -1ULL) {
1976 stream
->ctf_stream_id
= be64toh(index_info
.stream_id
);
1979 if (index_created
) {
1981 * Try to add the relay index object to the hash table. If an object
1982 * already exist, destroy back the index created, set the data in this
1983 * object and write it on disk.
1985 relay_index_add(index
, &wr_index
);
1987 copy_index_control_data(wr_index
, &index_info
);
1991 /* The index already exists so write it on disk. */
1995 /* Do we have a writable ready index to write on disk. */
1997 ret
= relay_index_write(wr_index
->fd
, wr_index
);
1999 goto end_rcu_unlock
;
2001 stream
->total_index_received
++;
2002 stream
->indexes_in_flight
--;
2003 assert(stream
->indexes_in_flight
>= 0);
2009 memset(&reply
, 0, sizeof(reply
));
2011 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2013 reply
.ret_code
= htobe32(LTTNG_OK
);
2015 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2017 ERR("Relay sending close index id reply");
2026 * Receive the streams_sent message.
2028 * Return 0 on success else a negative value.
2031 int relay_streams_sent(struct lttcomm_relayd_hdr
*recv_hdr
,
2032 struct relay_connection
*conn
)
2035 struct lttcomm_relayd_generic_reply reply
;
2039 DBG("Relay receiving streams_sent");
2041 if (!conn
->session
|| conn
->version_check_done
== 0) {
2042 ERR("Trying to close a stream before version check");
2044 goto end_no_session
;
2048 * Flag every pending stream in the connection recv list that they are
2049 * ready to be used by the viewer.
2051 set_viewer_ready_flag(conn
);
2054 * Inform the viewer that there are new streams in the session.
2056 if (conn
->session
->viewer_refcount
) {
2057 uatomic_set(&conn
->session
->new_streams
, 1);
2060 memset(&reply
, 0, sizeof(reply
));
2061 reply
.ret_code
= htobe32(LTTNG_OK
);
2062 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2064 ERR("Relay sending sent_stream reply");
2076 * Process the commands received on the control socket
2079 int relay_process_control(struct lttcomm_relayd_hdr
*recv_hdr
,
2080 struct relay_connection
*conn
)
2084 switch (be32toh(recv_hdr
->cmd
)) {
2085 case RELAYD_CREATE_SESSION
:
2086 ret
= relay_create_session(recv_hdr
, conn
);
2088 case RELAYD_ADD_STREAM
:
2089 ret
= relay_add_stream(recv_hdr
, conn
);
2091 case RELAYD_START_DATA
:
2092 ret
= relay_start(recv_hdr
, conn
);
2094 case RELAYD_SEND_METADATA
:
2095 ret
= relay_recv_metadata(recv_hdr
, conn
);
2097 case RELAYD_VERSION
:
2098 ret
= relay_send_version(recv_hdr
, conn
);
2100 case RELAYD_CLOSE_STREAM
:
2101 ret
= relay_close_stream(recv_hdr
, conn
);
2103 case RELAYD_DATA_PENDING
:
2104 ret
= relay_data_pending(recv_hdr
, conn
);
2106 case RELAYD_QUIESCENT_CONTROL
:
2107 ret
= relay_quiescent_control(recv_hdr
, conn
);
2109 case RELAYD_BEGIN_DATA_PENDING
:
2110 ret
= relay_begin_data_pending(recv_hdr
, conn
);
2112 case RELAYD_END_DATA_PENDING
:
2113 ret
= relay_end_data_pending(recv_hdr
, conn
);
2115 case RELAYD_SEND_INDEX
:
2116 ret
= relay_recv_index(recv_hdr
, conn
);
2118 case RELAYD_STREAMS_SENT
:
2119 ret
= relay_streams_sent(recv_hdr
, conn
);
2121 case RELAYD_UPDATE_SYNC_INFO
:
2123 ERR("Received unknown command (%u)", be32toh(recv_hdr
->cmd
));
2124 relay_unknown_command(conn
);
2134 * Handle index for a data stream.
2136 * RCU read side lock MUST be acquired.
2138 * Return 0 on success else a negative value.
2140 static int handle_index_data(struct relay_stream
*stream
, uint64_t net_seq_num
,
2143 int ret
= 0, index_created
= 0;
2144 uint64_t stream_id
, data_offset
;
2145 struct relay_index
*index
, *wr_index
= NULL
;
2149 stream_id
= stream
->stream_handle
;
2150 /* Get data offset because we are about to update the index. */
2151 data_offset
= htobe64(stream
->tracefile_size_current
);
2154 * Lookup for an existing index for that stream id/sequence number. If on
2155 * exists, the control thread already received the data for it thus we need
2156 * to write it on disk.
2158 index
= relay_index_find(stream_id
, net_seq_num
);
2160 /* A successful creation will add the object to the HT. */
2161 index
= relay_index_create(stream_id
, net_seq_num
);
2167 stream
->indexes_in_flight
++;
2170 if (rotate_index
|| stream
->index_fd
< 0) {
2171 index
->to_close_fd
= stream
->index_fd
;
2172 ret
= index_create_file(stream
->path_name
, stream
->channel_name
,
2173 relayd_uid
, relayd_gid
, stream
->tracefile_size
,
2174 stream
->tracefile_count_current
);
2176 /* This will close the stream's index fd if one. */
2177 relay_index_free_safe(index
);
2180 stream
->index_fd
= ret
;
2182 index
->fd
= stream
->index_fd
;
2183 index
->index_data
.offset
= data_offset
;
2185 if (index_created
) {
2187 * Try to add the relay index object to the hash table. If an object
2188 * already exist, destroy back the index created and set the data.
2190 relay_index_add(index
, &wr_index
);
2192 /* Copy back data from the created index. */
2193 wr_index
->fd
= index
->fd
;
2194 wr_index
->to_close_fd
= index
->to_close_fd
;
2195 wr_index
->index_data
.offset
= data_offset
;
2199 /* The index already exists so write it on disk. */
2203 /* Do we have a writable ready index to write on disk. */
2205 ret
= relay_index_write(wr_index
->fd
, wr_index
);
2209 stream
->total_index_received
++;
2210 stream
->indexes_in_flight
--;
2211 assert(stream
->indexes_in_flight
>= 0);
2219 * relay_process_data: Process the data received on the data socket
2222 int relay_process_data(struct relay_connection
*conn
)
2224 int ret
= 0, rotate_index
= 0;
2226 struct relay_stream
*stream
;
2227 struct lttcomm_relayd_data_hdr data_hdr
;
2229 uint64_t net_seq_num
;
2231 struct relay_session
*session
;
2235 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &data_hdr
,
2236 sizeof(struct lttcomm_relayd_data_hdr
), 0);
2239 /* Orderly shutdown. Not necessary to print an error. */
2240 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2242 ERR("Unable to receive data header on sock %d", conn
->sock
->fd
);
2248 stream_id
= be64toh(data_hdr
.stream_id
);
2251 stream
= stream_find_by_id(relay_streams_ht
, stream_id
);
2254 goto end_rcu_unlock
;
2257 session
= session_find_by_id(conn
->sessions_ht
, stream
->session_id
);
2260 data_size
= be32toh(data_hdr
.data_size
);
2261 if (data_buffer_size
< data_size
) {
2264 tmp_data_ptr
= realloc(data_buffer
, data_size
);
2265 if (!tmp_data_ptr
) {
2266 ERR("Allocating data buffer");
2269 goto end_rcu_unlock
;
2271 data_buffer
= tmp_data_ptr
;
2272 data_buffer_size
= data_size
;
2274 memset(data_buffer
, 0, data_size
);
2276 net_seq_num
= be64toh(data_hdr
.net_seq_num
);
2278 DBG3("Receiving data of size %u for stream id %" PRIu64
" seqnum %" PRIu64
,
2279 data_size
, stream_id
, net_seq_num
);
2280 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
2283 /* Orderly shutdown. Not necessary to print an error. */
2284 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2287 goto end_rcu_unlock
;
2290 /* Check if a rotation is needed. */
2291 if (stream
->tracefile_size
> 0 &&
2292 (stream
->tracefile_size_current
+ data_size
) >
2293 stream
->tracefile_size
) {
2294 struct relay_viewer_stream
*vstream
;
2297 new_id
= (stream
->tracefile_count_current
+ 1) %
2298 stream
->tracefile_count
;
2300 * When we wrap-around back to 0, we start overwriting old
2303 if (!stream
->tracefile_overwrite
&& new_id
== 0) {
2304 stream
->tracefile_overwrite
= 1;
2306 pthread_mutex_lock(&stream
->viewer_stream_rotation_lock
);
2307 if (stream
->tracefile_overwrite
) {
2308 stream
->oldest_tracefile_id
=
2309 (stream
->oldest_tracefile_id
+ 1) %
2310 stream
->tracefile_count
;
2312 vstream
= viewer_stream_find_by_id(stream
->stream_handle
);
2315 * The viewer is reading a file about to be
2316 * overwritten. Close the FDs it is
2317 * currently using and let it handle the fault.
2319 if (vstream
->tracefile_count_current
== new_id
) {
2320 pthread_mutex_lock(&vstream
->overwrite_lock
);
2321 vstream
->abort_flag
= 1;
2322 pthread_mutex_unlock(&vstream
->overwrite_lock
);
2323 DBG("Streaming side setting abort_flag on stream %s_%lu\n",
2324 stream
->channel_name
, new_id
);
2325 } else if (vstream
->tracefile_count_current
==
2326 stream
->tracefile_count_current
) {
2328 * The reader and writer were in the
2329 * same trace file, inform the viewer
2330 * that no new index will ever be added
2333 vstream
->close_write_flag
= 1;
2336 ret
= utils_rotate_stream_file(stream
->path_name
, stream
->channel_name
,
2337 stream
->tracefile_size
, stream
->tracefile_count
,
2338 relayd_uid
, relayd_gid
, stream
->fd
,
2339 &(stream
->tracefile_count_current
), &stream
->fd
);
2340 stream
->total_index_received
= 0;
2341 pthread_mutex_unlock(&stream
->viewer_stream_rotation_lock
);
2343 ERR("Rotating stream output file");
2344 goto end_rcu_unlock
;
2346 /* Reset current size because we just perform a stream rotation. */
2347 stream
->tracefile_size_current
= 0;
2352 * Index are handled in protocol version 2.4 and above. Also, snapshot and
2353 * index are NOT supported.
2355 if (session
->minor
>= 4 && !session
->snapshot
) {
2356 ret
= handle_index_data(stream
, net_seq_num
, rotate_index
);
2358 goto end_rcu_unlock
;
2362 /* Write data to stream output fd. */
2363 size_ret
= lttng_write(stream
->fd
, data_buffer
, data_size
);
2364 if (size_ret
< data_size
) {
2365 ERR("Relay error writing data to file");
2367 goto end_rcu_unlock
;
2370 DBG2("Relay wrote %d bytes to tracefile for stream id %" PRIu64
,
2371 ret
, stream
->stream_handle
);
2373 ret
= write_padding_to_file(stream
->fd
, be32toh(data_hdr
.padding_size
));
2375 goto end_rcu_unlock
;
2377 stream
->tracefile_size_current
+= data_size
+ be32toh(data_hdr
.padding_size
);
2379 stream
->prev_seq
= net_seq_num
;
2381 try_close_stream(session
, stream
);
2390 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
2396 (void) lttng_poll_del(events
, pollfd
);
2398 ret
= close(pollfd
);
2400 ERR("Closing pollfd %d", pollfd
);
2404 static void destroy_connection(struct lttng_ht
*relay_connections_ht
,
2405 struct relay_connection
*conn
)
2407 assert(relay_connections_ht
);
2410 connection_delete(relay_connections_ht
, conn
);
2412 /* For the control socket, we try to destroy the session. */
2413 if (conn
->type
== RELAY_CONTROL
&& conn
->session
) {
2414 destroy_session(conn
->session
, conn
->sessions_ht
);
2417 connection_destroy(conn
);
2421 * This thread does the actual work
2424 void *relay_thread_worker(void *data
)
2426 int ret
, err
= -1, last_seen_data_fd
= -1;
2428 struct relay_connection
*conn
;
2429 struct lttng_poll_event events
;
2430 struct lttng_ht
*relay_connections_ht
;
2431 struct lttng_ht_iter iter
;
2432 struct lttcomm_relayd_hdr recv_hdr
;
2433 struct relay_local_data
*relay_ctx
= (struct relay_local_data
*) data
;
2434 struct lttng_ht
*sessions_ht
= relay_ctx
->sessions_ht
;
2435 struct relay_index
*index
;
2437 DBG("[thread] Relay worker started");
2439 rcu_register_thread();
2441 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
2443 if (testpoint(relayd_thread_worker
)) {
2444 goto error_testpoint
;
2447 health_code_update();
2449 /* table of connections indexed on socket */
2450 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2451 if (!relay_connections_ht
) {
2452 goto relay_connections_ht_error
;
2455 /* Tables of received indexes indexed by index handle and net_seq_num. */
2456 indexes_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_TWO_U64
);
2458 goto indexes_ht_error
;
2461 ret
= create_thread_poll_set(&events
, 2);
2463 goto error_poll_create
;
2466 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2473 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
2475 health_code_update();
2477 /* Infinite blocking call, waiting for transmission */
2478 DBG3("Relayd worker thread polling...");
2479 health_poll_entry();
2480 ret
= lttng_poll_wait(&events
, -1);
2484 * Restart interrupted system call.
2486 if (errno
== EINTR
) {
2495 * Process control. The control connection is prioritised so we don't
2496 * starve it with high throughout put tracing data on the data
2499 for (i
= 0; i
< nb_fd
; i
++) {
2500 /* Fetch once the poll data */
2501 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2502 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2504 health_code_update();
2506 /* Thread quit pipe has been closed. Killing thread. */
2507 ret
= check_thread_quit_pipe(pollfd
, revents
);
2513 /* Inspect the relay conn pipe for new connection */
2514 if (pollfd
== relay_conn_pipe
[0]) {
2515 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2516 ERR("Relay connection pipe error");
2518 } else if (revents
& LPOLLIN
) {
2519 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
2523 conn
->sessions_ht
= sessions_ht
;
2524 connection_init(conn
);
2525 lttng_poll_add(&events
, conn
->sock
->fd
,
2526 LPOLLIN
| LPOLLRDHUP
);
2528 lttng_ht_add_unique_ulong(relay_connections_ht
,
2531 DBG("Connection socket %d added", conn
->sock
->fd
);
2535 conn
= connection_find_by_sock(relay_connections_ht
, pollfd
);
2536 /* If not found, there is a synchronization issue. */
2539 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2540 cleanup_connection_pollfd(&events
, pollfd
);
2541 destroy_connection(relay_connections_ht
, conn
);
2542 if (last_seen_data_fd
== pollfd
) {
2543 last_seen_data_fd
= last_notdel_data_fd
;
2545 } else if (revents
& LPOLLIN
) {
2546 if (conn
->type
== RELAY_CONTROL
) {
2547 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2548 sizeof(recv_hdr
), 0);
2550 /* Connection closed */
2551 cleanup_connection_pollfd(&events
, pollfd
);
2552 destroy_connection(relay_connections_ht
, conn
);
2553 DBG("Control connection closed with %d", pollfd
);
2555 ret
= relay_process_control(&recv_hdr
, conn
);
2557 /* Clear the session on error. */
2558 cleanup_connection_pollfd(&events
, pollfd
);
2559 destroy_connection(relay_connections_ht
, conn
);
2560 DBG("Connection closed with %d", pollfd
);
2566 * Flag the last seen data fd not deleted. It will be
2567 * used as the last seen fd if any fd gets deleted in
2570 last_notdel_data_fd
= pollfd
;
2573 ERR("Unknown poll events %u for sock %d", revents
, pollfd
);
2580 * The last loop handled a control request, go back to poll to make
2581 * sure we prioritise the control socket.
2587 if (last_seen_data_fd
>= 0) {
2588 for (i
= 0; i
< nb_fd
; i
++) {
2589 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2591 health_code_update();
2593 if (last_seen_data_fd
== pollfd
) {
2600 /* Process data connection. */
2601 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
2602 /* Fetch the poll data. */
2603 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2604 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2606 health_code_update();
2608 /* Skip the command pipe. It's handled in the first loop. */
2609 if (pollfd
== relay_conn_pipe
[0]) {
2615 conn
= connection_find_by_sock(relay_connections_ht
, pollfd
);
2617 /* Skip it. Might be removed before. */
2622 if (revents
& LPOLLIN
) {
2623 if (conn
->type
!= RELAY_DATA
) {
2628 ret
= relay_process_data(conn
);
2629 /* Connection closed */
2631 cleanup_connection_pollfd(&events
, pollfd
);
2632 destroy_connection(relay_connections_ht
, conn
);
2633 DBG("Data connection closed with %d", pollfd
);
2635 * Every goto restart call sets the last seen fd where
2636 * here we don't really care since we gracefully
2637 * continue the loop after the connection is deleted.
2640 /* Keep last seen port. */
2641 last_seen_data_fd
= pollfd
;
2649 last_seen_data_fd
= -1;
2652 /* Normal exit, no error */
2657 lttng_poll_clean(&events
);
2659 /* Cleanup reamaining connection object. */
2661 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
, conn
,
2663 health_code_update();
2664 destroy_connection(relay_connections_ht
, conn
);
2669 cds_lfht_for_each_entry(indexes_ht
->ht
, &iter
.iter
, index
,
2671 health_code_update();
2672 relay_index_delete(index
);
2673 relay_index_free_safe(index
);
2676 lttng_ht_destroy(indexes_ht
);
2678 lttng_ht_destroy(relay_connections_ht
);
2679 relay_connections_ht_error
:
2680 /* Close relay conn pipes */
2681 utils_close_pipe(relay_conn_pipe
);
2683 DBG("Thread exited with error");
2685 DBG("Worker thread cleanup complete");
2690 ERR("Health error occurred in %s", __func__
);
2692 health_unregister(health_relayd
);
2693 rcu_unregister_thread();
2699 * Create the relay command pipe to wake thread_manage_apps.
2700 * Closed in cleanup().
2702 static int create_relay_conn_pipe(void)
2706 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
2714 int main(int argc
, char **argv
)
2718 struct relay_local_data
*relay_ctx
;
2720 /* Parse arguments */
2722 if ((ret
= set_options(argc
, argv
)) < 0) {
2726 if ((ret
= set_signal_handler()) < 0) {
2730 /* Try to create directory if -o, --output is specified. */
2731 if (opt_output_path
) {
2732 if (*opt_output_path
!= '/') {
2733 ERR("Please specify an absolute path for -o, --output PATH");
2737 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
);
2739 ERR("Unable to create %s", opt_output_path
);
2745 if (opt_daemon
|| opt_background
) {
2748 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
2755 * We are in the child. Make sure all other file
2756 * descriptors are closed, in case we are called with
2757 * more opened file descriptors than the standard ones.
2759 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
2764 /* Create thread quit pipe */
2765 if ((ret
= init_thread_quit_pipe()) < 0) {
2769 /* We need those values for the file/dir creation. */
2770 relayd_uid
= getuid();
2771 relayd_gid
= getgid();
2773 /* Check if daemon is UID = 0 */
2774 if (relayd_uid
== 0) {
2775 if (control_uri
->port
< 1024 || data_uri
->port
< 1024 || live_uri
->port
< 1024) {
2776 ERR("Need to be root to use ports < 1024");
2782 /* Setup the thread apps communication pipe. */
2783 if ((ret
= create_relay_conn_pipe()) < 0) {
2787 /* Init relay command queue. */
2788 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
2790 /* Set up max poll set size */
2791 lttng_poll_set_max_size();
2793 /* Initialize communication library */
2795 lttcomm_inet_init();
2797 relay_ctx
= zmalloc(sizeof(struct relay_local_data
));
2799 PERROR("relay_ctx");
2803 /* tables of sessions indexed by session ID */
2804 relay_ctx
->sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2805 if (!relay_ctx
->sessions_ht
) {
2806 goto exit_relay_ctx_sessions
;
2809 /* tables of streams indexed by stream ID */
2810 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2811 if (!relay_streams_ht
) {
2812 goto exit_relay_ctx_streams
;
2815 /* tables of streams indexed by stream ID */
2816 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2817 if (!viewer_streams_ht
) {
2818 goto exit_relay_ctx_viewer_streams
;
2821 /* Initialize thread health monitoring */
2822 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
2823 if (!health_relayd
) {
2824 PERROR("health_app_create error");
2825 goto exit_health_app_create
;
2828 ret
= utils_create_pipe(health_quit_pipe
);
2830 goto error_health_pipe
;
2833 /* Create thread to manage the client socket */
2834 ret
= pthread_create(&health_thread
, NULL
,
2835 thread_manage_health
, (void *) NULL
);
2837 PERROR("pthread_create health");
2841 /* Setup the dispatcher thread */
2842 ret
= pthread_create(&dispatcher_thread
, NULL
,
2843 relay_thread_dispatcher
, (void *) NULL
);
2845 PERROR("pthread_create dispatcher");
2846 goto exit_dispatcher
;
2849 /* Setup the worker thread */
2850 ret
= pthread_create(&worker_thread
, NULL
,
2851 relay_thread_worker
, (void *) relay_ctx
);
2853 PERROR("pthread_create worker");
2857 /* Setup the listener thread */
2858 ret
= pthread_create(&listener_thread
, NULL
,
2859 relay_thread_listener
, (void *) NULL
);
2861 PERROR("pthread_create listener");
2865 ret
= live_start_threads(live_uri
, relay_ctx
);
2867 ERR("Starting live viewer threads");
2872 ret
= pthread_join(listener_thread
, &status
);
2874 PERROR("pthread_join");
2875 goto error
; /* join error, exit without cleanup */
2879 ret
= pthread_join(worker_thread
, &status
);
2881 PERROR("pthread_join");
2882 goto error
; /* join error, exit without cleanup */
2886 ret
= pthread_join(dispatcher_thread
, &status
);
2888 PERROR("pthread_join");
2889 goto error
; /* join error, exit without cleanup */
2893 ret
= pthread_join(health_thread
, &status
);
2895 PERROR("pthread_join health thread");
2896 goto error
; /* join error, exit without cleanup */
2900 * Stop live threads only after joining other threads.
2902 live_stop_threads();
2905 utils_close_pipe(health_quit_pipe
);
2908 health_app_destroy(health_relayd
);
2910 exit_health_app_create
:
2911 lttng_ht_destroy(viewer_streams_ht
);
2913 exit_relay_ctx_viewer_streams
:
2914 lttng_ht_destroy(relay_streams_ht
);
2916 exit_relay_ctx_streams
:
2917 lttng_ht_destroy(relay_ctx
->sessions_ht
);
2919 exit_relay_ctx_sessions
: