2 * Copyright (C) 2012 Julien Desfossez <jdesfossez@efficios.com>
3 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
4 * Copyright (C) 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Copyright (C) 2015 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * SPDX-License-Identifier: GPL-2.0-only
21 #include <sys/mount.h>
22 #include <sys/resource.h>
23 #include <sys/socket.h>
25 #include <sys/types.h>
27 #include <sys/resource.h>
29 #include <urcu/futex.h>
30 #include <urcu/uatomic.h>
31 #include <urcu/rculist.h>
37 #include <lttng/lttng.h>
38 #include <common/common.h>
39 #include <common/compat/poll.h>
40 #include <common/compat/socket.h>
41 #include <common/compat/endian.h>
42 #include <common/compat/getenv.h>
43 #include <common/defaults.h>
44 #include <common/daemonize.h>
45 #include <common/futex.h>
46 #include <common/sessiond-comm/sessiond-comm.h>
47 #include <common/sessiond-comm/inet.h>
48 #include <common/sessiond-comm/relayd.h>
49 #include <common/uri.h>
50 #include <common/utils.h>
51 #include <common/align.h>
52 #include <common/config/session-config.h>
53 #include <common/dynamic-buffer.h>
54 #include <common/buffer-view.h>
55 #include <common/string-utils/format.h>
56 #include <common/fd-tracker/fd-tracker.h>
57 #include <common/fd-tracker/utils.h>
59 #include "backward-compatibility-group-by.h"
61 #include "connection.h"
62 #include "ctf-trace.h"
63 #include "health-relayd.h"
66 #include "lttng-relayd.h"
68 #include "sessiond-trace-chunks.h"
70 #include "tcp_keep_alive.h"
71 #include "testpoint.h"
72 #include "tracefile-array.h"
75 #include "viewer-stream.h"
77 static const char *help_msg
=
78 #ifdef LTTNG_EMBED_HELP
79 #include <lttng-relayd.8.h>
85 enum relay_connection_status
{
86 RELAY_CONNECTION_STATUS_OK
,
87 /* An error occurred while processing an event on the connection. */
88 RELAY_CONNECTION_STATUS_ERROR
,
89 /* Connection closed/shutdown cleanly. */
90 RELAY_CONNECTION_STATUS_CLOSED
,
93 /* command line options */
94 char *opt_output_path
, *opt_working_directory
;
95 static int opt_daemon
, opt_background
, opt_print_version
, opt_allow_clear
= 1;
96 enum relay_group_output_by opt_group_output_by
= RELAYD_GROUP_OUTPUT_BY_UNKNOWN
;
99 * We need to wait for listener and live listener threads, as well as
100 * health check thread, before being ready to signal readiness.
102 #define NR_LTTNG_RELAY_READY 3
103 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
105 /* Size of receive buffer. */
106 #define RECV_DATA_BUFFER_SIZE 65536
108 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
109 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
111 static struct lttng_uri
*control_uri
;
112 static struct lttng_uri
*data_uri
;
113 static struct lttng_uri
*live_uri
;
115 const char *progname
;
117 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
118 static int tracing_group_name_override
;
120 const char * const config_section_name
= "relayd";
123 * Quit pipe for all threads. This permits a single cancellation point
124 * for all threads when receiving an event on the pipe.
126 int thread_quit_pipe
[2] = { -1, -1 };
129 * This pipe is used to inform the worker thread that a command is queued and
130 * ready to be processed.
132 static int relay_conn_pipe
[2] = { -1, -1 };
134 /* Shared between threads */
135 static int dispatch_thread_exit
;
137 static pthread_t listener_thread
;
138 static pthread_t dispatcher_thread
;
139 static pthread_t worker_thread
;
140 static pthread_t health_thread
;
143 * last_relay_stream_id_lock protects last_relay_stream_id increment
144 * atomicity on 32-bit architectures.
146 static pthread_mutex_t last_relay_stream_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
147 static uint64_t last_relay_stream_id
;
150 * Relay command queue.
152 * The relay_thread_listener and relay_thread_dispatcher communicate with this
155 static struct relay_conn_queue relay_conn_queue
;
157 /* Cap of file desriptors to be in simultaneous use by the relay daemon. */
158 static unsigned int lttng_opt_fd_pool_size
= -1;
160 /* Global relay stream hash table. */
161 struct lttng_ht
*relay_streams_ht
;
163 /* Global relay viewer stream hash table. */
164 struct lttng_ht
*viewer_streams_ht
;
166 /* Global relay sessions hash table. */
167 struct lttng_ht
*sessions_ht
;
169 /* Relayd health monitoring */
170 struct health_app
*health_relayd
;
172 struct sessiond_trace_chunk_registry
*sessiond_trace_chunk_registry
;
174 /* Global fd tracker. */
175 struct fd_tracker
*the_fd_tracker
;
177 static struct option long_options
[] = {
178 { "control-port", 1, 0, 'C', },
179 { "data-port", 1, 0, 'D', },
180 { "live-port", 1, 0, 'L', },
181 { "daemonize", 0, 0, 'd', },
182 { "background", 0, 0, 'b', },
183 { "group", 1, 0, 'g', },
184 { "fd-pool-size", 1, 0, '\0', },
185 { "help", 0, 0, 'h', },
186 { "output", 1, 0, 'o', },
187 { "verbose", 0, 0, 'v', },
188 { "config", 1, 0, 'f' },
189 { "version", 0, 0, 'V' },
190 { "working-directory", 1, 0, 'w', },
191 { "group-output-by-session", 0, 0, 's', },
192 { "group-output-by-host", 0, 0, 'p', },
193 { "disallow-clear", 0, 0, 'x' },
197 static const char *config_ignore_options
[] = { "help", "config", "version" };
199 static void print_version(void) {
200 fprintf(stdout
, "%s\n", VERSION
);
203 static void relayd_config_log(void)
205 DBG("LTTng-relayd " VERSION
" - " VERSION_NAME
"%s%s",
206 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
,
207 EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " EXTRA_VERSION_NAME
);
208 if (EXTRA_VERSION_DESCRIPTION
[0] != '\0') {
209 DBG("LTTng-relayd extra version description:\n\t" EXTRA_VERSION_DESCRIPTION
"\n");
211 if (EXTRA_VERSION_PATCHES
[0] != '\0') {
212 DBG("LTTng-relayd extra patches:\n\t" EXTRA_VERSION_PATCHES
"\n");
217 * Take an option from the getopt output and set it in the right variable to be
220 * Return 0 on success else a negative value.
222 static int set_option(int opt
, const char *arg
, const char *optname
)
228 if (!strcmp(optname
, "fd-pool-size")) {
232 v
= strtoul(arg
, NULL
, 0);
233 if (errno
!= 0 || !isdigit((unsigned char) arg
[0])) {
234 ERR("Wrong value in --fd-pool-size parameter: %s", arg
);
239 ERR("File descriptor cap overflow in --fd-pool-size parameter: %s", arg
);
243 lttng_opt_fd_pool_size
= (unsigned int) v
;
245 fprintf(stderr
, "unknown option %s", optname
);
247 fprintf(stderr
, " with arg %s\n", arg
);
252 if (lttng_is_setuid_setgid()) {
253 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
254 "-C, --control-port");
256 ret
= uri_parse(arg
, &control_uri
);
258 ERR("Invalid control URI specified");
261 if (control_uri
->port
== 0) {
262 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
267 if (lttng_is_setuid_setgid()) {
268 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
271 ret
= uri_parse(arg
, &data_uri
);
273 ERR("Invalid data URI specified");
276 if (data_uri
->port
== 0) {
277 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
282 if (lttng_is_setuid_setgid()) {
283 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
286 ret
= uri_parse(arg
, &live_uri
);
288 ERR("Invalid live URI specified");
291 if (live_uri
->port
== 0) {
292 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
303 if (lttng_is_setuid_setgid()) {
304 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
307 tracing_group_name
= strdup(arg
);
308 if (tracing_group_name
== NULL
) {
313 tracing_group_name_override
= 1;
317 ret
= utils_show_help(8, "lttng-relayd", help_msg
);
319 ERR("Cannot show --help for `lttng-relayd`");
324 opt_print_version
= 1;
327 if (lttng_is_setuid_setgid()) {
328 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
331 ret
= asprintf(&opt_output_path
, "%s", arg
);
334 PERROR("asprintf opt_output_path");
340 if (lttng_is_setuid_setgid()) {
341 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
342 "-w, --working-directory");
344 ret
= asprintf(&opt_working_directory
, "%s", arg
);
347 PERROR("asprintf opt_working_directory");
354 /* Verbose level can increase using multiple -v */
356 lttng_opt_verbose
= config_parse_value(arg
);
358 /* Only 3 level of verbosity (-vvv). */
359 if (lttng_opt_verbose
< 3) {
360 lttng_opt_verbose
+= 1;
365 if (opt_group_output_by
!= RELAYD_GROUP_OUTPUT_BY_UNKNOWN
) {
366 ERR("Cannot set --group-output-by-session, another --group-output-by argument is present");
369 opt_group_output_by
= RELAYD_GROUP_OUTPUT_BY_SESSION
;
372 if (opt_group_output_by
!= RELAYD_GROUP_OUTPUT_BY_UNKNOWN
) {
373 ERR("Cannot set --group-output-by-host, another --group-output-by argument is present");
376 opt_group_output_by
= RELAYD_GROUP_OUTPUT_BY_HOST
;
383 /* Unknown option or other error.
384 * Error is printed by getopt, just return */
397 * config_entry_handler_cb used to handle options read from a config file.
398 * See config_entry_handler_cb comment in common/config/session-config.h for the
399 * return value conventions.
401 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
405 if (!entry
|| !entry
->name
|| !entry
->value
) {
410 /* Check if the option is to be ignored */
411 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
412 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
417 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1; i
++) {
418 /* Ignore if entry name is not fully matched. */
419 if (strcmp(entry
->name
, long_options
[i
].name
)) {
424 * If the option takes no argument on the command line,
425 * we have to check if the value is "true". We support
426 * non-zero numeric values, true, on and yes.
428 if (!long_options
[i
].has_arg
) {
429 ret
= config_parse_value(entry
->value
);
432 WARN("Invalid configuration value \"%s\" for option %s",
433 entry
->value
, entry
->name
);
435 /* False, skip boolean config option. */
440 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
444 WARN("Unrecognized option \"%s\" in daemon configuration file.",
451 static int parse_env_options(void)
456 value
= lttng_secure_getenv(DEFAULT_LTTNG_RELAYD_WORKING_DIRECTORY_ENV
);
458 opt_working_directory
= strdup(value
);
459 if (!opt_working_directory
) {
460 ERR("Failed to allocate working directory string (\"%s\")",
468 static int set_fd_pool_size(void)
471 struct rlimit rlimit
;
473 ret
= getrlimit(RLIMIT_NOFILE
, &rlimit
);
475 PERROR("Failed to get file descriptor limit");
480 DBG("File descriptor count limits are %" PRIu64
" (soft) and %" PRIu64
" (hard)",
481 (uint64_t) rlimit
.rlim_cur
,
482 (uint64_t) rlimit
.rlim_max
);
483 if (lttng_opt_fd_pool_size
== -1) {
484 /* Use default value (soft limit - reserve). */
485 if (rlimit
.rlim_cur
< DEFAULT_RELAYD_MIN_FD_POOL_SIZE
) {
486 ERR("The process' file number limit is too low (%" PRIu64
"). The process' file number limit must be set to at least %i.",
487 (uint64_t) rlimit
.rlim_cur
, DEFAULT_RELAYD_MIN_FD_POOL_SIZE
);
491 lttng_opt_fd_pool_size
= rlimit
.rlim_cur
-
492 DEFAULT_RELAYD_FD_POOL_SIZE_RESERVE
;
496 if (lttng_opt_fd_pool_size
< DEFAULT_RELAYD_MIN_FD_POOL_SIZE
) {
497 ERR("File descriptor pool size must be set to at least %d",
498 DEFAULT_RELAYD_MIN_FD_POOL_SIZE
);
503 if (lttng_opt_fd_pool_size
> rlimit
.rlim_cur
) {
504 ERR("File descriptor pool size argument (%u) exceeds the process' soft limit (%" PRIu64
").",
505 lttng_opt_fd_pool_size
, (uint64_t) rlimit
.rlim_cur
);
510 DBG("File descriptor pool size argument (%u) adjusted to %u to accommodates transient fd uses",
511 lttng_opt_fd_pool_size
,
512 lttng_opt_fd_pool_size
- DEFAULT_RELAYD_FD_POOL_SIZE_RESERVE
);
513 lttng_opt_fd_pool_size
-= DEFAULT_RELAYD_FD_POOL_SIZE_RESERVE
;
518 static int set_options(int argc
, char **argv
)
520 int c
, ret
= 0, option_index
= 0, retval
= 0;
521 int orig_optopt
= optopt
, orig_optind
= optind
;
522 char *default_address
, *optstring
;
523 char *config_path
= NULL
;
525 optstring
= utils_generate_optstring(long_options
,
526 sizeof(long_options
) / sizeof(struct option
));
532 /* Check for the --config option */
534 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
535 &option_index
)) != -1) {
539 } else if (c
!= 'f') {
543 if (lttng_is_setuid_setgid()) {
544 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
548 config_path
= utils_expand_path(optarg
);
550 ERR("Failed to resolve path: %s", optarg
);
555 ret
= config_get_section_entries(config_path
, config_section_name
,
556 config_entry_handler
, NULL
);
559 ERR("Invalid configuration option at line %i", ret
);
565 /* Reset getopt's global state */
566 optopt
= orig_optopt
;
567 optind
= orig_optind
;
569 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
574 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
581 /* assign default values */
582 if (control_uri
== NULL
) {
583 ret
= asprintf(&default_address
,
584 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
585 DEFAULT_NETWORK_CONTROL_PORT
);
587 PERROR("asprintf default data address");
592 ret
= uri_parse(default_address
, &control_uri
);
593 free(default_address
);
595 ERR("Invalid control URI specified");
600 if (data_uri
== NULL
) {
601 ret
= asprintf(&default_address
,
602 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
603 DEFAULT_NETWORK_DATA_PORT
);
605 PERROR("asprintf default data address");
610 ret
= uri_parse(default_address
, &data_uri
);
611 free(default_address
);
613 ERR("Invalid data URI specified");
618 if (live_uri
== NULL
) {
619 ret
= asprintf(&default_address
,
620 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
621 DEFAULT_NETWORK_VIEWER_PORT
);
623 PERROR("asprintf default viewer control address");
628 ret
= uri_parse(default_address
, &live_uri
);
629 free(default_address
);
631 ERR("Invalid viewer control URI specified");
636 ret
= set_fd_pool_size();
642 if (opt_group_output_by
== RELAYD_GROUP_OUTPUT_BY_UNKNOWN
) {
643 opt_group_output_by
= RELAYD_GROUP_OUTPUT_BY_HOST
;
645 if (opt_allow_clear
) {
646 /* Check if env variable exists. */
647 const char *value
= lttng_secure_getenv(DEFAULT_LTTNG_RELAYD_DISALLOW_CLEAR_ENV
);
649 ret
= config_parse_value(value
);
651 ERR("Invalid value for %s specified", DEFAULT_LTTNG_RELAYD_DISALLOW_CLEAR_ENV
);
655 opt_allow_clear
= !ret
;
665 static void print_global_objects(void)
667 print_viewer_streams();
668 print_relay_streams();
672 static int noop_close(void *data
, int *fds
)
677 static void untrack_stdio(void)
679 int fds
[] = { fileno(stdout
), fileno(stderr
) };
682 * noop_close is used since we don't really want to close
683 * the stdio output fds; we merely want to stop tracking them.
685 (void) fd_tracker_close_unsuspendable_fd(the_fd_tracker
,
686 fds
, 2, noop_close
, NULL
);
692 static void relayd_cleanup(void)
694 print_global_objects();
698 if (viewer_streams_ht
)
699 lttng_ht_destroy(viewer_streams_ht
);
700 if (relay_streams_ht
)
701 lttng_ht_destroy(relay_streams_ht
);
703 lttng_ht_destroy(sessions_ht
);
705 free(opt_output_path
);
706 free(opt_working_directory
);
709 health_app_destroy(health_relayd
);
711 /* Close thread quit pipes */
712 if (health_quit_pipe
[0] != -1) {
713 (void) fd_tracker_util_pipe_close(
714 the_fd_tracker
, health_quit_pipe
);
716 if (thread_quit_pipe
[0] != -1) {
717 (void) fd_tracker_util_pipe_close(
718 the_fd_tracker
, thread_quit_pipe
);
720 if (sessiond_trace_chunk_registry
) {
721 sessiond_trace_chunk_registry_destroy(
722 sessiond_trace_chunk_registry
);
724 if (the_fd_tracker
) {
727 * fd_tracker_destroy() will log the contents of the fd-tracker
728 * if a leak is detected.
730 fd_tracker_destroy(the_fd_tracker
);
733 uri_free(control_uri
);
735 /* Live URI is freed in the live thread. */
737 if (tracing_group_name_override
) {
738 free((void *) tracing_group_name
);
743 * Write to writable pipe used to notify a thread.
745 static int notify_thread_pipe(int wpipe
)
749 ret
= lttng_write(wpipe
, "!", 1);
751 PERROR("write poll pipe");
759 static int notify_health_quit_pipe(int *pipe
)
763 ret
= lttng_write(pipe
[1], "4", 1);
765 PERROR("write relay health quit");
774 * Stop all relayd and relayd-live threads.
776 int lttng_relay_stop_threads(void)
780 /* Stopping all threads */
781 DBG("Terminating all threads");
782 if (notify_thread_pipe(thread_quit_pipe
[1])) {
783 ERR("write error on thread quit pipe");
787 if (notify_health_quit_pipe(health_quit_pipe
)) {
788 ERR("write error on health quit pipe");
791 /* Dispatch thread */
792 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
793 futex_nto1_wake(&relay_conn_queue
.futex
);
795 if (relayd_live_stop()) {
796 ERR("Error stopping live threads");
803 * Signal handler for the daemon
805 * Simply stop all worker threads, leaving main() return gracefully after
806 * joining all threads and calling cleanup().
808 static void sighandler(int sig
)
812 DBG("SIGINT caught");
813 if (lttng_relay_stop_threads()) {
814 ERR("Error stopping threads");
818 DBG("SIGTERM caught");
819 if (lttng_relay_stop_threads()) {
820 ERR("Error stopping threads");
824 CMM_STORE_SHARED(recv_child_signal
, 1);
832 * Setup signal handler for :
833 * SIGINT, SIGTERM, SIGPIPE
835 static int set_signal_handler(void)
841 if ((ret
= sigemptyset(&sigset
)) < 0) {
842 PERROR("sigemptyset");
849 sa
.sa_handler
= sighandler
;
850 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
855 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
860 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
865 sa
.sa_handler
= SIG_IGN
;
866 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
871 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
876 void lttng_relay_notify_ready(void)
878 /* Notify the parent of the fork() process that we are ready. */
879 if (opt_daemon
|| opt_background
) {
880 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
881 kill(child_ppid
, SIGUSR1
);
887 * Init thread quit pipe.
889 * Return -1 on error or 0 if all pipes are created.
891 static int init_thread_quit_pipe(void)
893 return fd_tracker_util_pipe_open_cloexec(
894 the_fd_tracker
, "Quit pipe", thread_quit_pipe
);
898 * Init health quit pipe.
900 * Return -1 on error or 0 if all pipes are created.
902 static int init_health_quit_pipe(void)
904 return fd_tracker_util_pipe_open_cloexec(the_fd_tracker
,
905 "Health quit pipe", health_quit_pipe
);
909 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
911 static int create_named_thread_poll_set(struct lttng_poll_event
*events
,
912 int size
, const char *name
)
916 if (events
== NULL
|| size
== 0) {
921 ret
= fd_tracker_util_poll_create(the_fd_tracker
,
922 name
, events
, 1, LTTNG_CLOEXEC
);
924 PERROR("Failed to create \"%s\" poll file descriptor", name
);
929 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
941 * Check if the thread quit pipe was triggered.
943 * Return 1 if it was triggered else 0;
945 static int check_thread_quit_pipe(int fd
, uint32_t events
)
947 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
954 static int create_sock(void *data
, int *out_fd
)
957 struct lttcomm_sock
*sock
= data
;
959 ret
= lttcomm_create_sock(sock
);
969 static int close_sock(void *data
, int *in_fd
)
971 struct lttcomm_sock
*sock
= data
;
973 return sock
->ops
->close(sock
);
976 static int accept_sock(void *data
, int *out_fd
)
979 /* Socks is an array of in_sock, out_sock. */
980 struct lttcomm_sock
**socks
= data
;
981 struct lttcomm_sock
*in_sock
= socks
[0];
983 socks
[1] = in_sock
->ops
->accept(in_sock
);
988 *out_fd
= socks
[1]->fd
;
994 * Create and init socket from uri.
996 static struct lttcomm_sock
*relay_socket_create(struct lttng_uri
*uri
,
1000 struct lttcomm_sock
*sock
= NULL
;
1001 char uri_str
[PATH_MAX
];
1002 char *formated_name
= NULL
;
1004 sock
= lttcomm_alloc_sock_from_uri(uri
);
1006 ERR("Allocating socket");
1011 * Don't fail to create the socket if the name can't be built as it is
1012 * only used for debugging purposes.
1014 ret
= uri_to_str_url(uri
, uri_str
, sizeof(uri_str
));
1015 uri_str
[sizeof(uri_str
) - 1] = '\0';
1017 ret
= asprintf(&formated_name
, "%s socket @ %s", name
,
1020 formated_name
= NULL
;
1024 ret
= fd_tracker_open_unsuspendable_fd(the_fd_tracker
, &sock_fd
,
1025 (const char **) (formated_name
? &formated_name
: NULL
),
1026 1, create_sock
, sock
);
1028 PERROR("Failed to open \"%s\" relay socket",
1029 formated_name
?: "Unknown");
1032 DBG("Listening on %s socket %d", name
, sock
->fd
);
1034 ret
= sock
->ops
->bind(sock
);
1036 PERROR("Failed to bind socket");
1040 ret
= sock
->ops
->listen(sock
, -1);
1046 free(formated_name
);
1051 lttcomm_destroy_sock(sock
);
1053 free(formated_name
);
1058 struct lttcomm_sock
*accept_relayd_sock(struct lttcomm_sock
*listening_sock
,
1062 struct lttcomm_sock
*socks
[2] = { listening_sock
, NULL
};
1063 struct lttcomm_sock
*new_sock
= NULL
;
1065 ret
= fd_tracker_open_unsuspendable_fd(
1066 the_fd_tracker
, &out_fd
,
1067 (const char **) &name
,
1068 1, accept_sock
, &socks
);
1072 new_sock
= socks
[1];
1073 DBG("%s accepted, socket %d", name
, new_sock
->fd
);
1079 * This thread manages the listening for new connections on the network
1081 static void *relay_thread_listener(void *data
)
1083 int i
, ret
, pollfd
, err
= -1;
1084 uint32_t revents
, nb_fd
;
1085 struct lttng_poll_event events
;
1086 struct lttcomm_sock
*control_sock
, *data_sock
;
1088 DBG("[thread] Relay listener started");
1090 rcu_register_thread();
1091 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
1093 health_code_update();
1095 control_sock
= relay_socket_create(control_uri
, "Control listener");
1096 if (!control_sock
) {
1097 goto error_sock_control
;
1100 data_sock
= relay_socket_create(data_uri
, "Data listener");
1102 goto error_sock_relay
;
1106 * Pass 3 as size here for the thread quit pipe, control and
1109 ret
= create_named_thread_poll_set(&events
, 3, "Listener thread epoll");
1111 goto error_create_poll
;
1114 /* Add the control socket */
1115 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
1117 goto error_poll_add
;
1120 /* Add the data socket */
1121 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
1123 goto error_poll_add
;
1126 lttng_relay_notify_ready();
1128 if (testpoint(relayd_thread_listener
)) {
1129 goto error_testpoint
;
1133 health_code_update();
1135 DBG("Listener accepting connections");
1138 health_poll_entry();
1139 ret
= lttng_poll_wait(&events
, -1);
1143 * Restart interrupted system call.
1145 if (errno
== EINTR
) {
1153 DBG("Relay new connection received");
1154 for (i
= 0; i
< nb_fd
; i
++) {
1155 health_code_update();
1157 /* Fetch once the poll data */
1158 revents
= LTTNG_POLL_GETEV(&events
, i
);
1159 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1161 /* Thread quit pipe has been closed. Killing thread. */
1162 ret
= check_thread_quit_pipe(pollfd
, revents
);
1168 if (revents
& LPOLLIN
) {
1170 * A new connection is requested, therefore a
1171 * sessiond/consumerd connection is allocated in
1172 * this thread, enqueued to a global queue and
1173 * dequeued (and freed) in the worker thread.
1176 struct relay_connection
*new_conn
;
1177 struct lttcomm_sock
*newsock
= NULL
;
1178 enum connection_type type
;
1180 if (pollfd
== data_sock
->fd
) {
1182 newsock
= accept_relayd_sock(data_sock
,
1183 "Data socket to relayd");
1185 assert(pollfd
== control_sock
->fd
);
1186 type
= RELAY_CONTROL
;
1187 newsock
= accept_relayd_sock(control_sock
,
1188 "Control socket to relayd");
1191 PERROR("accepting sock");
1195 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
1198 PERROR("setsockopt inet");
1199 lttcomm_destroy_sock(newsock
);
1203 ret
= socket_apply_keep_alive_config(newsock
->fd
);
1205 ERR("Failed to apply TCP keep-alive configuration on socket (%i)",
1207 lttcomm_destroy_sock(newsock
);
1211 new_conn
= connection_create(newsock
, type
);
1213 lttcomm_destroy_sock(newsock
);
1217 /* Enqueue request for the dispatcher thread. */
1218 cds_wfcq_enqueue(&relay_conn_queue
.head
, &relay_conn_queue
.tail
,
1222 * Wake the dispatch queue futex.
1223 * Implicit memory barrier with the
1224 * exchange in cds_wfcq_enqueue.
1226 futex_nto1_wake(&relay_conn_queue
.futex
);
1227 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1228 ERR("socket poll error");
1231 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1241 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
1243 if (data_sock
->fd
>= 0) {
1244 int data_sock_fd
= data_sock
->fd
;
1246 ret
= fd_tracker_close_unsuspendable_fd(the_fd_tracker
,
1247 &data_sock_fd
, 1, close_sock
,
1250 PERROR("Failed to close the data listener socket file descriptor");
1254 lttcomm_destroy_sock(data_sock
);
1256 if (control_sock
->fd
>= 0) {
1257 int control_sock_fd
= control_sock
->fd
;
1259 ret
= fd_tracker_close_unsuspendable_fd(the_fd_tracker
,
1260 &control_sock_fd
, 1, close_sock
,
1263 PERROR("Failed to close the control listener socket file descriptor");
1265 control_sock
->fd
= -1;
1267 lttcomm_destroy_sock(control_sock
);
1271 ERR("Health error occurred in %s", __func__
);
1273 health_unregister(health_relayd
);
1274 rcu_unregister_thread();
1275 DBG("Relay listener thread cleanup complete");
1276 lttng_relay_stop_threads();
1281 * This thread manages the dispatching of the requests to worker threads
1283 static void *relay_thread_dispatcher(void *data
)
1287 struct cds_wfcq_node
*node
;
1288 struct relay_connection
*new_conn
= NULL
;
1290 DBG("[thread] Relay dispatcher started");
1292 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
1294 if (testpoint(relayd_thread_dispatcher
)) {
1295 goto error_testpoint
;
1298 health_code_update();
1301 health_code_update();
1303 /* Atomically prepare the queue futex */
1304 futex_nto1_prepare(&relay_conn_queue
.futex
);
1306 if (CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1311 health_code_update();
1313 /* Dequeue commands */
1314 node
= cds_wfcq_dequeue_blocking(&relay_conn_queue
.head
,
1315 &relay_conn_queue
.tail
);
1317 DBG("Woken up but nothing in the relay command queue");
1318 /* Continue thread execution */
1321 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
1323 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
1326 * Inform worker thread of the new request. This
1327 * call is blocking so we can be assured that
1328 * the data will be read at some point in time
1329 * or wait to the end of the world :)
1331 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
1333 PERROR("write connection pipe");
1334 connection_put(new_conn
);
1337 } while (node
!= NULL
);
1339 /* Futex wait on queue. Blocking call on futex() */
1340 health_poll_entry();
1341 futex_nto1_wait(&relay_conn_queue
.futex
);
1345 /* Normal exit, no error */
1352 ERR("Health error occurred in %s", __func__
);
1354 health_unregister(health_relayd
);
1355 DBG("Dispatch thread dying");
1356 lttng_relay_stop_threads();
1360 static bool session_streams_have_index(const struct relay_session
*session
)
1362 return session
->minor
>= 4 && !session
->snapshot
;
1366 * Handle the RELAYD_CREATE_SESSION command.
1368 * On success, send back the session id or else return a negative value.
1370 static int relay_create_session(const struct lttcomm_relayd_hdr
*recv_hdr
,
1371 struct relay_connection
*conn
,
1372 const struct lttng_buffer_view
*payload
)
1376 struct relay_session
*session
= NULL
;
1377 struct lttcomm_relayd_create_session_reply_2_11 reply
= {};
1378 char session_name
[LTTNG_NAME_MAX
] = {};
1379 char hostname
[LTTNG_HOST_NAME_MAX
] = {};
1380 uint32_t live_timer
= 0;
1381 bool snapshot
= false;
1382 bool session_name_contains_creation_timestamp
= false;
1383 /* Left nil for peers < 2.11. */
1384 char base_path
[LTTNG_PATH_MAX
] = {};
1385 lttng_uuid sessiond_uuid
= {};
1386 LTTNG_OPTIONAL(uint64_t) id_sessiond
= {};
1387 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1388 LTTNG_OPTIONAL(time_t) creation_time
= {};
1389 struct lttng_dynamic_buffer reply_payload
;
1391 lttng_dynamic_buffer_init(&reply_payload
);
1393 if (conn
->minor
< 4) {
1394 /* From 2.1 to 2.3 */
1396 } else if (conn
->minor
>= 4 && conn
->minor
< 11) {
1397 /* From 2.4 to 2.10 */
1398 ret
= cmd_create_session_2_4(payload
, session_name
,
1399 hostname
, &live_timer
, &snapshot
);
1401 bool has_current_chunk
;
1402 uint64_t current_chunk_id_value
;
1403 time_t creation_time_value
;
1404 uint64_t id_sessiond_value
;
1406 /* From 2.11 to ... */
1407 ret
= cmd_create_session_2_11(payload
, session_name
, hostname
,
1408 base_path
, &live_timer
, &snapshot
, &id_sessiond_value
,
1409 sessiond_uuid
, &has_current_chunk
,
1410 ¤t_chunk_id_value
, &creation_time_value
,
1411 &session_name_contains_creation_timestamp
);
1412 if (lttng_uuid_is_nil(sessiond_uuid
)) {
1413 /* The nil UUID is reserved for pre-2.11 clients. */
1414 ERR("Illegal nil UUID announced by peer in create session command");
1418 LTTNG_OPTIONAL_SET(&id_sessiond
, id_sessiond_value
);
1419 LTTNG_OPTIONAL_SET(&creation_time
, creation_time_value
);
1420 if (has_current_chunk
) {
1421 LTTNG_OPTIONAL_SET(¤t_chunk_id
,
1422 current_chunk_id_value
);
1430 session
= session_create(session_name
, hostname
, base_path
, live_timer
,
1431 snapshot
, sessiond_uuid
,
1432 id_sessiond
.is_set
? &id_sessiond
.value
: NULL
,
1433 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1434 creation_time
.is_set
? &creation_time
.value
: NULL
,
1435 conn
->major
, conn
->minor
,
1436 session_name_contains_creation_timestamp
);
1441 assert(!conn
->session
);
1442 conn
->session
= session
;
1443 DBG("Created session %" PRIu64
, session
->id
);
1445 reply
.generic
.session_id
= htobe64(session
->id
);
1449 reply
.generic
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1451 reply
.generic
.ret_code
= htobe32(LTTNG_OK
);
1454 if (conn
->minor
< 11) {
1455 /* From 2.1 to 2.10 */
1456 ret
= lttng_dynamic_buffer_append(&reply_payload
,
1457 &reply
.generic
, sizeof(reply
.generic
));
1459 ERR("Failed to append \"create session\" command reply header to payload buffer");
1464 const uint32_t output_path_length
=
1465 session
? strlen(session
->output_path
) + 1 : 0;
1467 reply
.output_path_length
= htobe32(output_path_length
);
1468 ret
= lttng_dynamic_buffer_append(
1469 &reply_payload
, &reply
, sizeof(reply
));
1471 ERR("Failed to append \"create session\" command reply header to payload buffer");
1475 if (output_path_length
) {
1476 ret
= lttng_dynamic_buffer_append(&reply_payload
,
1477 session
->output_path
,
1478 output_path_length
);
1480 ERR("Failed to append \"create session\" command reply path to payload buffer");
1486 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, reply_payload
.data
,
1487 reply_payload
.size
, 0);
1488 if (send_ret
< (ssize_t
) reply_payload
.size
) {
1489 ERR("Failed to send \"create session\" command reply of %zu bytes (ret = %zd)",
1490 reply_payload
.size
, send_ret
);
1494 if (ret
< 0 && session
) {
1495 session_put(session
);
1497 lttng_dynamic_buffer_reset(&reply_payload
);
1502 * When we have received all the streams and the metadata for a channel,
1503 * we make them visible to the viewer threads.
1505 static void publish_connection_local_streams(struct relay_connection
*conn
)
1507 struct relay_stream
*stream
;
1508 struct relay_session
*session
= conn
->session
;
1511 * We publish all streams belonging to a session atomically wrt
1514 pthread_mutex_lock(&session
->lock
);
1516 cds_list_for_each_entry_rcu(stream
, &session
->recv_list
,
1518 stream_publish(stream
);
1523 * Inform the viewer that there are new streams in the session.
1525 if (session
->viewer_attached
) {
1526 uatomic_set(&session
->new_streams
, 1);
1528 pthread_mutex_unlock(&session
->lock
);
1531 static int conform_channel_path(char *channel_path
)
1535 if (strstr("../", channel_path
)) {
1536 ERR("Refusing channel path as it walks up the path hierarchy: \"%s\"",
1542 if (*channel_path
== '/') {
1543 const size_t len
= strlen(channel_path
);
1546 * Channel paths from peers prior to 2.11 are expressed as an
1547 * absolute path that is, in reality, relative to the relay
1548 * daemon's output directory. Remove the leading slash so it
1549 * is correctly interpreted as a relative path later on.
1551 * len (and not len - 1) is used to copy the trailing NULL.
1553 bcopy(channel_path
+ 1, channel_path
, len
);
1560 * relay_add_stream: allocate a new stream for a session
1562 static int relay_add_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1563 struct relay_connection
*conn
,
1564 const struct lttng_buffer_view
*payload
)
1568 struct relay_session
*session
= conn
->session
;
1569 struct relay_stream
*stream
= NULL
;
1570 struct lttcomm_relayd_status_stream reply
;
1571 struct ctf_trace
*trace
= NULL
;
1572 uint64_t stream_handle
= -1ULL;
1573 char *path_name
= NULL
, *channel_name
= NULL
;
1574 uint64_t tracefile_size
= 0, tracefile_count
= 0;
1575 LTTNG_OPTIONAL(uint64_t) stream_chunk_id
= {};
1577 if (!session
|| !conn
->version_check_done
) {
1578 ERR("Trying to add a stream before version check");
1580 goto end_no_session
;
1583 if (session
->minor
== 1) {
1585 ret
= cmd_recv_stream_2_1(payload
, &path_name
,
1587 } else if (session
->minor
> 1 && session
->minor
< 11) {
1588 /* From 2.2 to 2.10 */
1589 ret
= cmd_recv_stream_2_2(payload
, &path_name
,
1590 &channel_name
, &tracefile_size
, &tracefile_count
);
1592 /* From 2.11 to ... */
1593 ret
= cmd_recv_stream_2_11(payload
, &path_name
,
1594 &channel_name
, &tracefile_size
, &tracefile_count
,
1595 &stream_chunk_id
.value
);
1596 stream_chunk_id
.is_set
= true;
1603 if (conform_channel_path(path_name
)) {
1608 * Backward compatibility for --group-output-by-session.
1609 * Prior to lttng 2.11, the complete path is passed by the stream.
1610 * Starting at 2.11, lttng-relayd uses chunk. When dealing with producer
1611 * >=2.11 the chunk is responsible for the output path. When dealing
1612 * with producer < 2.11 the chunk output_path is the root output path
1613 * and the stream carries the complete path (path_name).
1614 * To support --group-output-by-session with older producer (<2.11), we
1615 * need to craft the path based on the stream path.
1617 if (opt_group_output_by
== RELAYD_GROUP_OUTPUT_BY_SESSION
) {
1618 if (conn
->minor
< 4) {
1620 * From 2.1 to 2.3, the session_name is not passed on
1621 * the RELAYD_CREATE_SESSION command. The session name
1622 * is necessary to detect the presence of a base_path
1623 * inside the stream path. Without it we cannot perform
1624 * a valid group-output-by-session transformation.
1626 WARN("Unable to perform a --group-by-session transformation for session %" PRIu64
1627 " for stream with path \"%s\" as it is produced by a peer using a protocol older than v2.4",
1628 session
->id
, path_name
);
1629 } else if (conn
->minor
>= 4 && conn
->minor
< 11) {
1630 char *group_by_session_path_name
;
1632 assert(session
->session_name
[0] != '\0');
1634 group_by_session_path_name
=
1635 backward_compat_group_by_session(
1637 session
->session_name
,
1638 session
->creation_time
.value
);
1639 if (!group_by_session_path_name
) {
1640 ERR("Failed to apply group by session to stream of session %" PRIu64
,
1645 DBG("Transformed session path from \"%s\" to \"%s\" to honor per-session name grouping",
1646 path_name
, group_by_session_path_name
);
1649 path_name
= group_by_session_path_name
;
1653 trace
= ctf_trace_get_by_path_or_create(session
, path_name
);
1658 /* This stream here has one reference on the trace. */
1659 pthread_mutex_lock(&last_relay_stream_id_lock
);
1660 stream_handle
= ++last_relay_stream_id
;
1661 pthread_mutex_unlock(&last_relay_stream_id_lock
);
1663 /* We pass ownership of path_name and channel_name. */
1664 stream
= stream_create(trace
, stream_handle
, path_name
,
1665 channel_name
, tracefile_size
, tracefile_count
);
1667 channel_name
= NULL
;
1670 * Streams are the owners of their trace. Reference to trace is
1671 * kept within stream_create().
1673 ctf_trace_put(trace
);
1676 memset(&reply
, 0, sizeof(reply
));
1677 reply
.handle
= htobe64(stream_handle
);
1679 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1681 reply
.ret_code
= htobe32(LTTNG_OK
);
1684 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1685 sizeof(struct lttcomm_relayd_status_stream
), 0);
1686 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1687 ERR("Failed to send \"add stream\" command reply (ret = %zd)",
1699 * relay_close_stream: close a specific stream
1701 static int relay_close_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1702 struct relay_connection
*conn
,
1703 const struct lttng_buffer_view
*payload
)
1707 struct relay_session
*session
= conn
->session
;
1708 struct lttcomm_relayd_close_stream stream_info
;
1709 struct lttcomm_relayd_generic_reply reply
;
1710 struct relay_stream
*stream
;
1712 DBG("Close stream received");
1714 if (!session
|| !conn
->version_check_done
) {
1715 ERR("Trying to close a stream before version check");
1717 goto end_no_session
;
1720 if (payload
->size
< sizeof(stream_info
)) {
1721 ERR("Unexpected payload size in \"relay_close_stream\": expected >= %zu bytes, got %zu bytes",
1722 sizeof(stream_info
), payload
->size
);
1724 goto end_no_session
;
1726 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1727 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1728 stream_info
.last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1730 stream
= stream_get_by_id(stream_info
.stream_id
);
1737 * Set last_net_seq_num before the close flag. Required by data
1740 pthread_mutex_lock(&stream
->lock
);
1741 stream
->last_net_seq_num
= stream_info
.last_net_seq_num
;
1742 pthread_mutex_unlock(&stream
->lock
);
1745 * This is one of the conditions which may trigger a stream close
1746 * with the others being:
1747 * 1) A close command is received for a stream
1748 * 2) The control connection owning the stream is closed
1749 * 3) We have received all of the stream's data _after_ a close
1752 try_stream_close(stream
);
1753 if (stream
->is_metadata
) {
1754 struct relay_viewer_stream
*vstream
;
1756 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
1758 if (stream
->no_new_metadata_notified
) {
1760 * Since all the metadata has been sent to the
1761 * viewer and that we have a request to close
1762 * its stream, we can safely teardown the
1763 * corresponding metadata viewer stream.
1765 viewer_stream_put(vstream
);
1767 /* Put local reference. */
1768 viewer_stream_put(vstream
);
1775 memset(&reply
, 0, sizeof(reply
));
1777 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1779 reply
.ret_code
= htobe32(LTTNG_OK
);
1781 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1782 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1783 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1784 ERR("Failed to send \"close stream\" command reply (ret = %zd)",
1794 * relay_reset_metadata: reset a metadata stream
1797 int relay_reset_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1798 struct relay_connection
*conn
,
1799 const struct lttng_buffer_view
*payload
)
1803 struct relay_session
*session
= conn
->session
;
1804 struct lttcomm_relayd_reset_metadata stream_info
;
1805 struct lttcomm_relayd_generic_reply reply
;
1806 struct relay_stream
*stream
;
1808 DBG("Reset metadata received");
1810 if (!session
|| !conn
->version_check_done
) {
1811 ERR("Trying to reset a metadata stream before version check");
1813 goto end_no_session
;
1816 if (payload
->size
< sizeof(stream_info
)) {
1817 ERR("Unexpected payload size in \"relay_reset_metadata\": expected >= %zu bytes, got %zu bytes",
1818 sizeof(stream_info
), payload
->size
);
1820 goto end_no_session
;
1822 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1823 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1824 stream_info
.version
= be64toh(stream_info
.version
);
1826 DBG("Update metadata to version %" PRIu64
, stream_info
.version
);
1828 /* Unsupported for live sessions for now. */
1829 if (session
->live_timer
!= 0) {
1834 stream
= stream_get_by_id(stream_info
.stream_id
);
1839 pthread_mutex_lock(&stream
->lock
);
1840 if (!stream
->is_metadata
) {
1845 ret
= stream_reset_file(stream
);
1847 ERR("Failed to reset metadata stream %" PRIu64
1848 ": stream_path = %s, channel = %s",
1849 stream
->stream_handle
, stream
->path_name
,
1850 stream
->channel_name
);
1854 pthread_mutex_unlock(&stream
->lock
);
1858 memset(&reply
, 0, sizeof(reply
));
1860 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1862 reply
.ret_code
= htobe32(LTTNG_OK
);
1864 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1865 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1866 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1867 ERR("Failed to send \"reset metadata\" command reply (ret = %zd)",
1877 * relay_unknown_command: send -1 if received unknown command
1879 static void relay_unknown_command(struct relay_connection
*conn
)
1881 struct lttcomm_relayd_generic_reply reply
;
1884 memset(&reply
, 0, sizeof(reply
));
1885 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1886 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1887 if (send_ret
< sizeof(reply
)) {
1888 ERR("Failed to send \"unknown command\" command reply (ret = %zd)", send_ret
);
1893 * relay_start: send an acknowledgment to the client to tell if we are
1894 * ready to receive data. We are ready if a session is established.
1896 static int relay_start(const struct lttcomm_relayd_hdr
*recv_hdr
,
1897 struct relay_connection
*conn
,
1898 const struct lttng_buffer_view
*payload
)
1902 struct lttcomm_relayd_generic_reply reply
;
1903 struct relay_session
*session
= conn
->session
;
1906 DBG("Trying to start the streaming without a session established");
1907 ret
= htobe32(LTTNG_ERR_UNK
);
1910 memset(&reply
, 0, sizeof(reply
));
1911 reply
.ret_code
= htobe32(LTTNG_OK
);
1912 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1914 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1915 ERR("Failed to send \"relay_start\" command reply (ret = %zd)",
1924 * relay_recv_metadata: receive the metadata for the session.
1926 static int relay_recv_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1927 struct relay_connection
*conn
,
1928 const struct lttng_buffer_view
*payload
)
1931 struct relay_session
*session
= conn
->session
;
1932 struct lttcomm_relayd_metadata_payload metadata_payload_header
;
1933 struct relay_stream
*metadata_stream
;
1934 uint64_t metadata_payload_size
;
1935 struct lttng_buffer_view packet_view
;
1938 ERR("Metadata sent before version check");
1943 if (recv_hdr
->data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1944 ERR("Incorrect data size");
1948 metadata_payload_size
= recv_hdr
->data_size
-
1949 sizeof(struct lttcomm_relayd_metadata_payload
);
1951 memcpy(&metadata_payload_header
, payload
->data
,
1952 sizeof(metadata_payload_header
));
1953 metadata_payload_header
.stream_id
= be64toh(
1954 metadata_payload_header
.stream_id
);
1955 metadata_payload_header
.padding_size
= be32toh(
1956 metadata_payload_header
.padding_size
);
1958 metadata_stream
= stream_get_by_id(metadata_payload_header
.stream_id
);
1959 if (!metadata_stream
) {
1964 packet_view
= lttng_buffer_view_from_view(payload
,
1965 sizeof(metadata_payload_header
), metadata_payload_size
);
1966 if (!lttng_buffer_view_is_valid(&packet_view
)) {
1967 ERR("Invalid metadata packet length announced by header");
1972 pthread_mutex_lock(&metadata_stream
->lock
);
1973 ret
= stream_write(metadata_stream
, &packet_view
,
1974 metadata_payload_header
.padding_size
);
1975 pthread_mutex_unlock(&metadata_stream
->lock
);
1981 stream_put(metadata_stream
);
1987 * relay_send_version: send relayd version number
1989 static int relay_send_version(const struct lttcomm_relayd_hdr
*recv_hdr
,
1990 struct relay_connection
*conn
,
1991 const struct lttng_buffer_view
*payload
)
1995 struct lttcomm_relayd_version reply
, msg
;
1996 bool compatible
= true;
1998 conn
->version_check_done
= true;
2000 /* Get version from the other side. */
2001 if (payload
->size
< sizeof(msg
)) {
2002 ERR("Unexpected payload size in \"relay_send_version\": expected >= %zu bytes, got %zu bytes",
2003 sizeof(msg
), payload
->size
);
2008 memcpy(&msg
, payload
->data
, sizeof(msg
));
2009 msg
.major
= be32toh(msg
.major
);
2010 msg
.minor
= be32toh(msg
.minor
);
2012 memset(&reply
, 0, sizeof(reply
));
2013 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
2014 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
2016 /* Major versions must be the same */
2017 if (reply
.major
!= msg
.major
) {
2018 DBG("Incompatible major versions (%u vs %u), deleting session",
2019 reply
.major
, msg
.major
);
2023 conn
->major
= reply
.major
;
2024 /* We adapt to the lowest compatible version */
2025 if (reply
.minor
<= msg
.minor
) {
2026 conn
->minor
= reply
.minor
;
2028 conn
->minor
= msg
.minor
;
2031 reply
.major
= htobe32(reply
.major
);
2032 reply
.minor
= htobe32(reply
.minor
);
2033 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2035 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2036 ERR("Failed to send \"send version\" command reply (ret = %zd)",
2049 DBG("Version check done using protocol %u.%u", conn
->major
,
2057 * Check for data pending for a given stream id from the session daemon.
2059 static int relay_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2060 struct relay_connection
*conn
,
2061 const struct lttng_buffer_view
*payload
)
2063 struct relay_session
*session
= conn
->session
;
2064 struct lttcomm_relayd_data_pending msg
;
2065 struct lttcomm_relayd_generic_reply reply
;
2066 struct relay_stream
*stream
;
2069 uint64_t stream_seq
;
2071 DBG("Data pending command received");
2073 if (!session
|| !conn
->version_check_done
) {
2074 ERR("Trying to check for data before version check");
2076 goto end_no_session
;
2079 if (payload
->size
< sizeof(msg
)) {
2080 ERR("Unexpected payload size in \"relay_data_pending\": expected >= %zu bytes, got %zu bytes",
2081 sizeof(msg
), payload
->size
);
2083 goto end_no_session
;
2085 memcpy(&msg
, payload
->data
, sizeof(msg
));
2086 msg
.stream_id
= be64toh(msg
.stream_id
);
2087 msg
.last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
2089 stream
= stream_get_by_id(msg
.stream_id
);
2090 if (stream
== NULL
) {
2095 pthread_mutex_lock(&stream
->lock
);
2097 if (session_streams_have_index(session
)) {
2099 * Ensure that both the index and stream data have been
2100 * flushed up to the requested point.
2102 stream_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
2104 stream_seq
= stream
->prev_data_seq
;
2106 DBG("Data pending for stream id %" PRIu64
": prev_data_seq %" PRIu64
2107 ", prev_index_seq %" PRIu64
2108 ", and last_seq %" PRIu64
, msg
.stream_id
,
2109 stream
->prev_data_seq
, stream
->prev_index_seq
,
2110 msg
.last_net_seq_num
);
2112 /* Avoid wrapping issue */
2113 if (((int64_t) (stream_seq
- msg
.last_net_seq_num
)) >= 0) {
2114 /* Data has in fact been written and is NOT pending */
2117 /* Data still being streamed thus pending */
2121 stream
->data_pending_check_done
= true;
2122 pthread_mutex_unlock(&stream
->lock
);
2127 memset(&reply
, 0, sizeof(reply
));
2128 reply
.ret_code
= htobe32(ret
);
2129 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2130 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2131 ERR("Failed to send \"data pending\" command reply (ret = %zd)",
2141 * Wait for the control socket to reach a quiescent state.
2143 * Note that for now, when receiving this command from the session
2144 * daemon, this means that every subsequent commands or data received on
2145 * the control socket has been handled. So, this is why we simply return
2148 static int relay_quiescent_control(const struct lttcomm_relayd_hdr
*recv_hdr
,
2149 struct relay_connection
*conn
,
2150 const struct lttng_buffer_view
*payload
)
2154 struct relay_stream
*stream
;
2155 struct lttcomm_relayd_quiescent_control msg
;
2156 struct lttcomm_relayd_generic_reply reply
;
2158 DBG("Checking quiescent state on control socket");
2160 if (!conn
->session
|| !conn
->version_check_done
) {
2161 ERR("Trying to check for data before version check");
2163 goto end_no_session
;
2166 if (payload
->size
< sizeof(msg
)) {
2167 ERR("Unexpected payload size in \"relay_quiescent_control\": expected >= %zu bytes, got %zu bytes",
2168 sizeof(msg
), payload
->size
);
2170 goto end_no_session
;
2172 memcpy(&msg
, payload
->data
, sizeof(msg
));
2173 msg
.stream_id
= be64toh(msg
.stream_id
);
2175 stream
= stream_get_by_id(msg
.stream_id
);
2179 pthread_mutex_lock(&stream
->lock
);
2180 stream
->data_pending_check_done
= true;
2181 pthread_mutex_unlock(&stream
->lock
);
2183 DBG("Relay quiescent control pending flag set to %" PRIu64
, msg
.stream_id
);
2186 memset(&reply
, 0, sizeof(reply
));
2187 reply
.ret_code
= htobe32(LTTNG_OK
);
2188 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2189 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2190 ERR("Failed to send \"quiescent control\" command reply (ret = %zd)",
2202 * Initialize a data pending command. This means that a consumer is about
2203 * to ask for data pending for each stream it holds. Simply iterate over
2204 * all streams of a session and set the data_pending_check_done flag.
2206 * This command returns to the client a LTTNG_OK code.
2208 static int relay_begin_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2209 struct relay_connection
*conn
,
2210 const struct lttng_buffer_view
*payload
)
2214 struct lttng_ht_iter iter
;
2215 struct lttcomm_relayd_begin_data_pending msg
;
2216 struct lttcomm_relayd_generic_reply reply
;
2217 struct relay_stream
*stream
;
2222 DBG("Init streams for data pending");
2224 if (!conn
->session
|| !conn
->version_check_done
) {
2225 ERR("Trying to check for data before version check");
2227 goto end_no_session
;
2230 if (payload
->size
< sizeof(msg
)) {
2231 ERR("Unexpected payload size in \"relay_begin_data_pending\": expected >= %zu bytes, got %zu bytes",
2232 sizeof(msg
), payload
->size
);
2234 goto end_no_session
;
2236 memcpy(&msg
, payload
->data
, sizeof(msg
));
2237 msg
.session_id
= be64toh(msg
.session_id
);
2240 * Iterate over all streams to set the begin data pending flag.
2241 * For now, the streams are indexed by stream handle so we have
2242 * to iterate over all streams to find the one associated with
2243 * the right session_id.
2246 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2248 if (!stream_get(stream
)) {
2251 if (stream
->trace
->session
->id
== msg
.session_id
) {
2252 pthread_mutex_lock(&stream
->lock
);
2253 stream
->data_pending_check_done
= false;
2254 pthread_mutex_unlock(&stream
->lock
);
2255 DBG("Set begin data pending flag to stream %" PRIu64
,
2256 stream
->stream_handle
);
2262 memset(&reply
, 0, sizeof(reply
));
2263 /* All good, send back reply. */
2264 reply
.ret_code
= htobe32(LTTNG_OK
);
2266 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2267 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2268 ERR("Failed to send \"begin data pending\" command reply (ret = %zd)",
2280 * End data pending command. This will check, for a given session id, if
2281 * each stream associated with it has its data_pending_check_done flag
2282 * set. If not, this means that the client lost track of the stream but
2283 * the data is still being streamed on our side. In this case, we inform
2284 * the client that data is in flight.
2286 * Return to the client if there is data in flight or not with a ret_code.
2288 static int relay_end_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2289 struct relay_connection
*conn
,
2290 const struct lttng_buffer_view
*payload
)
2294 struct lttng_ht_iter iter
;
2295 struct lttcomm_relayd_end_data_pending msg
;
2296 struct lttcomm_relayd_generic_reply reply
;
2297 struct relay_stream
*stream
;
2298 uint32_t is_data_inflight
= 0;
2300 DBG("End data pending command");
2302 if (!conn
->session
|| !conn
->version_check_done
) {
2303 ERR("Trying to check for data before version check");
2305 goto end_no_session
;
2308 if (payload
->size
< sizeof(msg
)) {
2309 ERR("Unexpected payload size in \"relay_end_data_pending\": expected >= %zu bytes, got %zu bytes",
2310 sizeof(msg
), payload
->size
);
2312 goto end_no_session
;
2314 memcpy(&msg
, payload
->data
, sizeof(msg
));
2315 msg
.session_id
= be64toh(msg
.session_id
);
2318 * Iterate over all streams to see if the begin data pending
2322 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2324 if (!stream_get(stream
)) {
2327 if (stream
->trace
->session
->id
!= msg
.session_id
) {
2331 pthread_mutex_lock(&stream
->lock
);
2332 if (!stream
->data_pending_check_done
) {
2333 uint64_t stream_seq
;
2335 if (session_streams_have_index(conn
->session
)) {
2337 * Ensure that both the index and stream data have been
2338 * flushed up to the requested point.
2340 stream_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
2342 stream_seq
= stream
->prev_data_seq
;
2344 if (!stream
->closed
|| !(((int64_t) (stream_seq
- stream
->last_net_seq_num
)) >= 0)) {
2345 is_data_inflight
= 1;
2346 DBG("Data is still in flight for stream %" PRIu64
,
2347 stream
->stream_handle
);
2348 pthread_mutex_unlock(&stream
->lock
);
2353 pthread_mutex_unlock(&stream
->lock
);
2358 memset(&reply
, 0, sizeof(reply
));
2359 /* All good, send back reply. */
2360 reply
.ret_code
= htobe32(is_data_inflight
);
2362 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2363 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2364 ERR("Failed to send \"end data pending\" command reply (ret = %zd)",
2376 * Receive an index for a specific stream.
2378 * Return 0 on success else a negative value.
2380 static int relay_recv_index(const struct lttcomm_relayd_hdr
*recv_hdr
,
2381 struct relay_connection
*conn
,
2382 const struct lttng_buffer_view
*payload
)
2386 struct relay_session
*session
= conn
->session
;
2387 struct lttcomm_relayd_index index_info
;
2388 struct lttcomm_relayd_generic_reply reply
;
2389 struct relay_stream
*stream
;
2394 DBG("Relay receiving index");
2396 if (!session
|| !conn
->version_check_done
) {
2397 ERR("Trying to close a stream before version check");
2399 goto end_no_session
;
2402 msg_len
= lttcomm_relayd_index_len(
2403 lttng_to_index_major(conn
->major
, conn
->minor
),
2404 lttng_to_index_minor(conn
->major
, conn
->minor
));
2405 if (payload
->size
< msg_len
) {
2406 ERR("Unexpected payload size in \"relay_recv_index\": expected >= %zu bytes, got %zu bytes",
2407 msg_len
, payload
->size
);
2409 goto end_no_session
;
2411 memcpy(&index_info
, payload
->data
, msg_len
);
2412 index_info
.relay_stream_id
= be64toh(index_info
.relay_stream_id
);
2413 index_info
.net_seq_num
= be64toh(index_info
.net_seq_num
);
2414 index_info
.packet_size
= be64toh(index_info
.packet_size
);
2415 index_info
.content_size
= be64toh(index_info
.content_size
);
2416 index_info
.timestamp_begin
= be64toh(index_info
.timestamp_begin
);
2417 index_info
.timestamp_end
= be64toh(index_info
.timestamp_end
);
2418 index_info
.events_discarded
= be64toh(index_info
.events_discarded
);
2419 index_info
.stream_id
= be64toh(index_info
.stream_id
);
2421 if (conn
->minor
>= 8) {
2422 index_info
.stream_instance_id
=
2423 be64toh(index_info
.stream_instance_id
);
2424 index_info
.packet_seq_num
= be64toh(index_info
.packet_seq_num
);
2426 index_info
.stream_instance_id
= -1ULL;
2427 index_info
.packet_seq_num
= -1ULL;
2430 stream
= stream_get_by_id(index_info
.relay_stream_id
);
2432 ERR("stream_get_by_id not found");
2437 pthread_mutex_lock(&stream
->lock
);
2438 ret
= stream_add_index(stream
, &index_info
);
2439 pthread_mutex_unlock(&stream
->lock
);
2441 goto end_stream_put
;
2447 memset(&reply
, 0, sizeof(reply
));
2449 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2451 reply
.ret_code
= htobe32(LTTNG_OK
);
2453 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2454 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2455 ERR("Failed to send \"recv index\" command reply (ret = %zd)", send_ret
);
2464 * Receive the streams_sent message.
2466 * Return 0 on success else a negative value.
2468 static int relay_streams_sent(const struct lttcomm_relayd_hdr
*recv_hdr
,
2469 struct relay_connection
*conn
,
2470 const struct lttng_buffer_view
*payload
)
2474 struct lttcomm_relayd_generic_reply reply
;
2478 DBG("Relay receiving streams_sent");
2480 if (!conn
->session
|| !conn
->version_check_done
) {
2481 ERR("Trying to close a stream before version check");
2483 goto end_no_session
;
2487 * Publish every pending stream in the connection recv list which are
2488 * now ready to be used by the viewer.
2490 publish_connection_local_streams(conn
);
2492 memset(&reply
, 0, sizeof(reply
));
2493 reply
.ret_code
= htobe32(LTTNG_OK
);
2494 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2495 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2496 ERR("Failed to send \"streams sent\" command reply (ret = %zd)",
2508 static ssize_t
relay_unpack_rotate_streams_header(
2509 const struct lttng_buffer_view
*payload
,
2510 struct lttcomm_relayd_rotate_streams
*_rotate_streams
)
2512 struct lttcomm_relayd_rotate_streams rotate_streams
;
2514 * Set to the smallest version (packed) of `lttcomm_relayd_rotate_streams`.
2515 * This is the smallest version of this structure, but it can be larger;
2516 * this variable is updated once the proper size of the structure is known.
2518 * See comment at the declaration of this structure for more information.
2520 ssize_t header_len
= sizeof(struct lttcomm_relayd_rotate_streams_packed
);
2521 size_t expected_payload_size_no_padding
,
2522 expected_payload_size_3_bytes_padding
,
2523 expected_payload_size_7_bytes_padding
;
2525 if (payload
->size
< header_len
) {
2526 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected >= %zu bytes, got %zu bytes",
2527 header_len
, payload
->size
);
2532 * Some versions incorrectly omitted the LTTNG_PACKED annotation on the
2533 * `new_chunk_id` optional field of struct lttcomm_relayd_rotate_streams.
2535 * We start by "unpacking" `stream_count` to figure out the padding length
2536 * emited by our peer.
2538 memcpy(&rotate_streams
.stream_count
, payload
->data
,
2539 sizeof(rotate_streams
.stream_count
));
2540 rotate_streams
= (typeof(rotate_streams
)) {
2541 .stream_count
= be32toh(rotate_streams
.stream_count
),
2545 * Payload size expected given the possible padding lengths in
2546 * `struct lttcomm_relayd_rotate_streams`.
2548 expected_payload_size_no_padding
= (rotate_streams
.stream_count
*
2549 sizeof(*rotate_streams
.rotation_positions
)) +
2550 sizeof(struct lttcomm_relayd_rotate_streams_packed
);
2551 expected_payload_size_3_bytes_padding
= (rotate_streams
.stream_count
*
2552 sizeof(*rotate_streams
.rotation_positions
)) +
2553 sizeof(struct lttcomm_relayd_rotate_streams_3_bytes_padding
);
2554 expected_payload_size_7_bytes_padding
= (rotate_streams
.stream_count
*
2555 sizeof(*rotate_streams
.rotation_positions
)) +
2556 sizeof(struct lttcomm_relayd_rotate_streams_7_bytes_padding
);
2558 if (payload
->size
== expected_payload_size_no_padding
) {
2559 struct lttcomm_relayd_rotate_streams_packed packed_rotate_streams
;
2562 * This handles cases where someone might build with
2563 * -fpack-struct or any other toolchain that wouldn't produce
2564 * padding to align `value`.
2566 DBG("Received `struct lttcomm_relayd_rotate_streams` with no padding");
2568 header_len
= sizeof(packed_rotate_streams
);
2569 memcpy(&packed_rotate_streams
, payload
->data
, header_len
);
2571 /* Unpack the packed structure to the natively-packed version. */
2572 *_rotate_streams
= (typeof(*_rotate_streams
)) {
2573 .stream_count
= be32toh(packed_rotate_streams
.stream_count
),
2574 .new_chunk_id
= (typeof(_rotate_streams
->new_chunk_id
)) {
2575 .is_set
= !!packed_rotate_streams
.new_chunk_id
.is_set
,
2576 .value
= be64toh(packed_rotate_streams
.new_chunk_id
.value
),
2579 } else if (payload
->size
== expected_payload_size_3_bytes_padding
) {
2580 struct lttcomm_relayd_rotate_streams_3_bytes_padding padded_rotate_streams
;
2582 DBG("Received `struct lttcomm_relayd_rotate_streams` with 3 bytes of padding (4-byte aligned peer)");
2584 header_len
= sizeof(padded_rotate_streams
);
2585 memcpy(&padded_rotate_streams
, payload
->data
, header_len
);
2587 /* Unpack the 3-byte padded structure to the natively-packed version. */
2588 *_rotate_streams
= (typeof(*_rotate_streams
)) {
2589 .stream_count
= be32toh(padded_rotate_streams
.stream_count
),
2590 .new_chunk_id
= (typeof(_rotate_streams
->new_chunk_id
)) {
2591 .is_set
= !!padded_rotate_streams
.new_chunk_id
.is_set
,
2592 .value
= be64toh(padded_rotate_streams
.new_chunk_id
.value
),
2595 } else if (payload
->size
== expected_payload_size_7_bytes_padding
) {
2596 struct lttcomm_relayd_rotate_streams_7_bytes_padding padded_rotate_streams
;
2598 DBG("Received `struct lttcomm_relayd_rotate_streams` with 7 bytes of padding (8-byte aligned peer)");
2600 header_len
= sizeof(padded_rotate_streams
);
2601 memcpy(&padded_rotate_streams
, payload
->data
, header_len
);
2603 /* Unpack the 7-byte padded structure to the natively-packed version. */
2604 *_rotate_streams
= (typeof(*_rotate_streams
)) {
2605 .stream_count
= be32toh(padded_rotate_streams
.stream_count
),
2606 .new_chunk_id
= (typeof(_rotate_streams
->new_chunk_id
)) {
2607 .is_set
= !!padded_rotate_streams
.new_chunk_id
.is_set
,
2608 .value
= be64toh(padded_rotate_streams
.new_chunk_id
.value
),
2612 header_len
= sizeof(padded_rotate_streams
);
2614 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected %zu, %zu or %zu bytes, got %zu bytes",
2615 expected_payload_size_no_padding
,
2616 expected_payload_size_3_bytes_padding
,
2617 expected_payload_size_7_bytes_padding
,
2628 * relay_rotate_session_stream: rotate a stream to a new tracefile for the
2629 * session rotation feature (not the tracefile rotation feature).
2631 static int relay_rotate_session_streams(
2632 const struct lttcomm_relayd_hdr
*recv_hdr
,
2633 struct relay_connection
*conn
,
2634 const struct lttng_buffer_view
*payload
)
2639 enum lttng_error_code reply_code
= LTTNG_ERR_UNK
;
2640 struct relay_session
*session
= conn
->session
;
2641 struct lttcomm_relayd_rotate_streams rotate_streams
;
2642 struct lttcomm_relayd_generic_reply reply
= {};
2643 struct relay_stream
*stream
= NULL
;
2644 struct lttng_trace_chunk
*next_trace_chunk
= NULL
;
2645 struct lttng_buffer_view stream_positions
;
2646 char chunk_id_buf
[MAX_INT_DEC_LEN(uint64_t)];
2647 const char *chunk_id_str
= "none";
2650 if (!session
|| !conn
->version_check_done
) {
2651 ERR("Trying to rotate a stream before version check");
2656 if (session
->major
== 2 && session
->minor
< 11) {
2657 ERR("Unsupported feature before 2.11");
2662 header_len
= relay_unpack_rotate_streams_header(payload
, &rotate_streams
);
2663 if (header_len
< 0) {
2668 if (rotate_streams
.new_chunk_id
.is_set
) {
2670 * Retrieve the trace chunk the stream must transition to. As
2671 * per the protocol, this chunk should have been created
2672 * before this command is received.
2674 next_trace_chunk
= sessiond_trace_chunk_registry_get_chunk(
2675 sessiond_trace_chunk_registry
,
2676 session
->sessiond_uuid
, session
->id
,
2677 rotate_streams
.new_chunk_id
.value
);
2678 if (!next_trace_chunk
) {
2679 char uuid_str
[LTTNG_UUID_STR_LEN
];
2681 lttng_uuid_to_str(session
->sessiond_uuid
, uuid_str
);
2682 ERR("Unknown next trace chunk in ROTATE_STREAMS command: sessiond_uuid = {%s}, session_id = %" PRIu64
2683 ", trace_chunk_id = %" PRIu64
,
2684 uuid_str
, session
->id
,
2685 rotate_streams
.new_chunk_id
.value
);
2686 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2691 ret
= snprintf(chunk_id_buf
, sizeof(chunk_id_buf
), "%" PRIu64
,
2692 rotate_streams
.new_chunk_id
.value
);
2693 if (ret
< 0 || ret
>= sizeof(chunk_id_buf
)) {
2694 chunk_id_str
= "formatting error";
2696 chunk_id_str
= chunk_id_buf
;
2700 DBG("Rotate %" PRIu32
" streams of session \"%s\" to chunk \"%s\"",
2701 rotate_streams
.stream_count
, session
->session_name
,
2704 stream_positions
= lttng_buffer_view_from_view(payload
,
2706 if (!stream_positions
.data
||
2707 stream_positions
.size
<
2708 (rotate_streams
.stream_count
*
2709 sizeof(struct lttcomm_relayd_stream_rotation_position
))) {
2710 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2715 for (i
= 0; i
< rotate_streams
.stream_count
; i
++) {
2716 struct lttcomm_relayd_stream_rotation_position
*position_comm
=
2717 &((typeof(position_comm
)) stream_positions
.data
)[i
];
2718 const struct lttcomm_relayd_stream_rotation_position pos
= {
2719 .stream_id
= be64toh(position_comm
->stream_id
),
2720 .rotate_at_seq_num
= be64toh(
2721 position_comm
->rotate_at_seq_num
),
2724 stream
= stream_get_by_id(pos
.stream_id
);
2726 reply_code
= LTTNG_ERR_INVALID
;
2731 pthread_mutex_lock(&stream
->lock
);
2732 ret
= stream_set_pending_rotation(stream
, next_trace_chunk
,
2733 pos
.rotate_at_seq_num
);
2734 pthread_mutex_unlock(&stream
->lock
);
2736 reply_code
= LTTNG_ERR_FILE_CREATION_ERROR
;
2744 reply_code
= LTTNG_OK
;
2751 reply
.ret_code
= htobe32((uint32_t) reply_code
);
2752 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2753 sizeof(struct lttcomm_relayd_generic_reply
), 0);
2754 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2755 ERR("Failed to send \"rotate session stream\" command reply (ret = %zd)",
2760 lttng_trace_chunk_put(next_trace_chunk
);
2765 * relay_create_trace_chunk: create a new trace chunk
2767 static int relay_create_trace_chunk(const struct lttcomm_relayd_hdr
*recv_hdr
,
2768 struct relay_connection
*conn
,
2769 const struct lttng_buffer_view
*payload
)
2773 struct relay_session
*session
= conn
->session
;
2774 struct lttcomm_relayd_create_trace_chunk
*msg
;
2775 struct lttcomm_relayd_generic_reply reply
= {};
2776 struct lttng_buffer_view header_view
;
2777 struct lttng_trace_chunk
*chunk
= NULL
, *published_chunk
= NULL
;
2778 enum lttng_error_code reply_code
= LTTNG_OK
;
2779 enum lttng_trace_chunk_status chunk_status
;
2780 const char *new_path
;
2782 if (!session
|| !conn
->version_check_done
) {
2783 ERR("Trying to create a trace chunk before version check");
2788 if (session
->major
== 2 && session
->minor
< 11) {
2789 ERR("Chunk creation command is unsupported before 2.11");
2794 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
2795 if (!lttng_buffer_view_is_valid(&header_view
)) {
2796 ERR("Failed to receive payload of chunk creation command");
2801 /* Convert to host endianness. */
2802 msg
= (typeof(msg
)) header_view
.data
;
2803 msg
->chunk_id
= be64toh(msg
->chunk_id
);
2804 msg
->creation_timestamp
= be64toh(msg
->creation_timestamp
);
2805 msg
->override_name_length
= be32toh(msg
->override_name_length
);
2807 if (session
->current_trace_chunk
&&
2808 !lttng_trace_chunk_get_name_overridden(session
->current_trace_chunk
)) {
2809 chunk_status
= lttng_trace_chunk_rename_path(session
->current_trace_chunk
,
2810 DEFAULT_CHUNK_TMP_OLD_DIRECTORY
);
2811 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2812 ERR("Failed to rename old chunk");
2814 reply_code
= LTTNG_ERR_UNK
;
2818 session
->ongoing_rotation
= true;
2819 if (!session
->current_trace_chunk
) {
2820 if (!session
->has_rotated
) {
2826 new_path
= DEFAULT_CHUNK_TMP_NEW_DIRECTORY
;
2828 chunk
= lttng_trace_chunk_create(
2829 msg
->chunk_id
, msg
->creation_timestamp
, new_path
);
2831 ERR("Failed to create trace chunk in trace chunk creation command");
2833 reply_code
= LTTNG_ERR_NOMEM
;
2836 lttng_trace_chunk_set_fd_tracker(chunk
, the_fd_tracker
);
2838 if (msg
->override_name_length
) {
2840 const struct lttng_buffer_view chunk_name_view
=
2841 lttng_buffer_view_from_view(payload
,
2843 msg
->override_name_length
);
2845 if (!lttng_buffer_view_is_valid(&chunk_name_view
)) {
2846 ERR("Invalid payload of chunk creation command (protocol error): buffer too short for expected name length");
2848 reply_code
= LTTNG_ERR_INVALID
;
2852 name
= chunk_name_view
.data
;
2853 if (name
[msg
->override_name_length
- 1]) {
2854 ERR("Invalid payload of chunk creation command (protocol error): name is not null-terminated");
2856 reply_code
= LTTNG_ERR_INVALID
;
2860 chunk_status
= lttng_trace_chunk_override_name(
2861 chunk
, chunk_name_view
.data
);
2862 switch (chunk_status
) {
2863 case LTTNG_TRACE_CHUNK_STATUS_OK
:
2865 case LTTNG_TRACE_CHUNK_STATUS_INVALID_ARGUMENT
:
2866 ERR("Failed to set the name of new trace chunk in trace chunk creation command (invalid name)");
2867 reply_code
= LTTNG_ERR_INVALID
;
2871 ERR("Failed to set the name of new trace chunk in trace chunk creation command (unknown error)");
2872 reply_code
= LTTNG_ERR_UNK
;
2878 chunk_status
= lttng_trace_chunk_set_credentials_current_user(chunk
);
2879 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2880 reply_code
= LTTNG_ERR_UNK
;
2885 assert(conn
->session
->output_directory
);
2886 chunk_status
= lttng_trace_chunk_set_as_owner(chunk
,
2887 conn
->session
->output_directory
);
2888 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2889 reply_code
= LTTNG_ERR_UNK
;
2894 published_chunk
= sessiond_trace_chunk_registry_publish_chunk(
2895 sessiond_trace_chunk_registry
,
2896 conn
->session
->sessiond_uuid
,
2899 if (!published_chunk
) {
2900 char uuid_str
[LTTNG_UUID_STR_LEN
];
2902 lttng_uuid_to_str(conn
->session
->sessiond_uuid
, uuid_str
);
2903 ERR("Failed to publish chunk: sessiond_uuid = %s, session_id = %" PRIu64
", chunk_id = %" PRIu64
,
2908 reply_code
= LTTNG_ERR_NOMEM
;
2912 pthread_mutex_lock(&conn
->session
->lock
);
2913 if (conn
->session
->pending_closure_trace_chunk
) {
2915 * Invalid; this means a second create_trace_chunk command was
2916 * received before a close_trace_chunk.
2918 ERR("Invalid trace chunk close command received; a trace chunk is already waiting for a trace chunk close command");
2919 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2921 goto end_unlock_session
;
2923 conn
->session
->pending_closure_trace_chunk
=
2924 conn
->session
->current_trace_chunk
;
2925 conn
->session
->current_trace_chunk
= published_chunk
;
2926 published_chunk
= NULL
;
2927 if (!conn
->session
->pending_closure_trace_chunk
) {
2928 session
->ongoing_rotation
= false;
2931 pthread_mutex_unlock(&conn
->session
->lock
);
2933 reply
.ret_code
= htobe32((uint32_t) reply_code
);
2934 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
,
2936 sizeof(struct lttcomm_relayd_generic_reply
),
2938 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2939 ERR("Failed to send \"create trace chunk\" command reply (ret = %zd)",
2944 lttng_trace_chunk_put(chunk
);
2945 lttng_trace_chunk_put(published_chunk
);
2950 * relay_close_trace_chunk: close a trace chunk
2952 static int relay_close_trace_chunk(const struct lttcomm_relayd_hdr
*recv_hdr
,
2953 struct relay_connection
*conn
,
2954 const struct lttng_buffer_view
*payload
)
2956 int ret
= 0, buf_ret
;
2958 struct relay_session
*session
= conn
->session
;
2959 struct lttcomm_relayd_close_trace_chunk
*msg
;
2960 struct lttcomm_relayd_close_trace_chunk_reply reply
= {};
2961 struct lttng_buffer_view header_view
;
2962 struct lttng_trace_chunk
*chunk
= NULL
;
2963 enum lttng_error_code reply_code
= LTTNG_OK
;
2964 enum lttng_trace_chunk_status chunk_status
;
2966 LTTNG_OPTIONAL(enum lttng_trace_chunk_command_type
) close_command
= {};
2967 time_t close_timestamp
;
2968 char closed_trace_chunk_path
[LTTNG_PATH_MAX
];
2969 size_t path_length
= 0;
2970 const char *chunk_name
= NULL
;
2971 struct lttng_dynamic_buffer reply_payload
;
2972 const char *new_path
;
2974 lttng_dynamic_buffer_init(&reply_payload
);
2976 if (!session
|| !conn
->version_check_done
) {
2977 ERR("Trying to close a trace chunk before version check");
2982 if (session
->major
== 2 && session
->minor
< 11) {
2983 ERR("Chunk close command is unsupported before 2.11");
2988 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
2989 if (!lttng_buffer_view_is_valid(&header_view
)) {
2990 ERR("Failed to receive payload of chunk close command");
2995 /* Convert to host endianness. */
2996 msg
= (typeof(msg
)) header_view
.data
;
2997 chunk_id
= be64toh(msg
->chunk_id
);
2998 close_timestamp
= (time_t) be64toh(msg
->close_timestamp
);
2999 close_command
= (typeof(close_command
)){
3000 .value
= be32toh(msg
->close_command
.value
),
3001 .is_set
= msg
->close_command
.is_set
,
3004 chunk
= sessiond_trace_chunk_registry_get_chunk(
3005 sessiond_trace_chunk_registry
,
3006 conn
->session
->sessiond_uuid
,
3010 char uuid_str
[LTTNG_UUID_STR_LEN
];
3012 lttng_uuid_to_str(conn
->session
->sessiond_uuid
, uuid_str
);
3013 ERR("Failed to find chunk to close: sessiond_uuid = %s, session_id = %" PRIu64
", chunk_id = %" PRIu64
,
3018 reply_code
= LTTNG_ERR_NOMEM
;
3022 pthread_mutex_lock(&session
->lock
);
3023 if (close_command
.is_set
&&
3024 close_command
.value
== LTTNG_TRACE_CHUNK_COMMAND_TYPE_DELETE
) {
3026 * Clear command. It is a protocol error to ask for a
3027 * clear on a relay which does not allow it. Querying
3028 * the configuration allows figuring out whether
3029 * clearing is allowed before doing the clear.
3031 if (!opt_allow_clear
) {
3033 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3034 goto end_unlock_session
;
3037 if (session
->pending_closure_trace_chunk
&&
3038 session
->pending_closure_trace_chunk
!= chunk
) {
3039 ERR("Trace chunk close command for session \"%s\" does not target the trace chunk pending closure",
3040 session
->session_name
);
3041 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3043 goto end_unlock_session
;
3046 if (session
->current_trace_chunk
&& session
->current_trace_chunk
!= chunk
&&
3047 !lttng_trace_chunk_get_name_overridden(session
->current_trace_chunk
)) {
3048 if (close_command
.is_set
&&
3049 close_command
.value
== LTTNG_TRACE_CHUNK_COMMAND_TYPE_DELETE
&&
3050 !session
->has_rotated
) {
3051 /* New chunk stays in session output directory. */
3054 /* Use chunk name for new chunk. */
3057 /* Rename new chunk path. */
3058 chunk_status
= lttng_trace_chunk_rename_path(session
->current_trace_chunk
,
3060 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3062 goto end_unlock_session
;
3064 session
->ongoing_rotation
= false;
3066 if ((!close_command
.is_set
||
3067 close_command
.value
== LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
) &&
3068 !lttng_trace_chunk_get_name_overridden(chunk
)) {
3069 const char *old_path
;
3071 if (!session
->has_rotated
) {
3076 /* We need to move back the .tmp_old_chunk to its rightful place. */
3077 chunk_status
= lttng_trace_chunk_rename_path(chunk
, old_path
);
3078 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3080 goto end_unlock_session
;
3083 chunk_status
= lttng_trace_chunk_set_close_timestamp(
3084 chunk
, close_timestamp
);
3085 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3086 ERR("Failed to set trace chunk close timestamp");
3088 reply_code
= LTTNG_ERR_UNK
;
3089 goto end_unlock_session
;
3092 if (close_command
.is_set
) {
3093 chunk_status
= lttng_trace_chunk_set_close_command(
3094 chunk
, close_command
.value
);
3095 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3097 reply_code
= LTTNG_ERR_INVALID
;
3098 goto end_unlock_session
;
3101 chunk_status
= lttng_trace_chunk_get_name(chunk
, &chunk_name
, NULL
);
3102 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3103 ERR("Failed to get chunk name");
3105 reply_code
= LTTNG_ERR_UNK
;
3106 goto end_unlock_session
;
3108 if (!session
->has_rotated
&& !session
->snapshot
) {
3109 ret
= lttng_strncpy(closed_trace_chunk_path
,
3110 session
->output_path
,
3111 sizeof(closed_trace_chunk_path
));
3113 ERR("Failed to send trace chunk path: path length of %zu bytes exceeds the maximal allowed length of %zu bytes",
3114 strlen(session
->output_path
),
3115 sizeof(closed_trace_chunk_path
));
3116 reply_code
= LTTNG_ERR_NOMEM
;
3118 goto end_unlock_session
;
3121 if (session
->snapshot
) {
3122 ret
= snprintf(closed_trace_chunk_path
,
3123 sizeof(closed_trace_chunk_path
),
3124 "%s/%s", session
->output_path
,
3127 ret
= snprintf(closed_trace_chunk_path
,
3128 sizeof(closed_trace_chunk_path
),
3129 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
3131 session
->output_path
, chunk_name
);
3133 if (ret
< 0 || ret
== sizeof(closed_trace_chunk_path
)) {
3134 ERR("Failed to format closed trace chunk resulting path");
3135 reply_code
= ret
< 0 ? LTTNG_ERR_UNK
: LTTNG_ERR_NOMEM
;
3137 goto end_unlock_session
;
3140 if (close_command
.is_set
&&
3141 close_command
.value
== LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
) {
3142 session
->has_rotated
= true;
3144 DBG("Reply chunk path on close: %s", closed_trace_chunk_path
);
3145 path_length
= strlen(closed_trace_chunk_path
) + 1;
3146 if (path_length
> UINT32_MAX
) {
3147 ERR("Closed trace chunk path exceeds the maximal length allowed by the protocol");
3149 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3150 goto end_unlock_session
;
3153 if (session
->current_trace_chunk
== chunk
) {
3155 * After a trace chunk close command, no new streams
3156 * referencing the chunk may be created. Hence, on the
3157 * event that no new trace chunk have been created for
3158 * the session, the reference to the current trace chunk
3159 * is released in order to allow it to be reclaimed when
3160 * the last stream releases its reference to it.
3162 lttng_trace_chunk_put(session
->current_trace_chunk
);
3163 session
->current_trace_chunk
= NULL
;
3165 lttng_trace_chunk_put(session
->pending_closure_trace_chunk
);
3166 session
->pending_closure_trace_chunk
= NULL
;
3168 pthread_mutex_unlock(&session
->lock
);
3171 reply
.generic
.ret_code
= htobe32((uint32_t) reply_code
);
3172 reply
.path_length
= htobe32((uint32_t) path_length
);
3173 buf_ret
= lttng_dynamic_buffer_append(
3174 &reply_payload
, &reply
, sizeof(reply
));
3176 ERR("Failed to append \"close trace chunk\" command reply header to payload buffer");
3180 if (reply_code
== LTTNG_OK
) {
3181 buf_ret
= lttng_dynamic_buffer_append(&reply_payload
,
3182 closed_trace_chunk_path
, path_length
);
3184 ERR("Failed to append \"close trace chunk\" command reply path to payload buffer");
3189 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
,
3193 if (send_ret
< reply_payload
.size
) {
3194 ERR("Failed to send \"close trace chunk\" command reply of %zu bytes (ret = %zd)",
3195 reply_payload
.size
, send_ret
);
3200 lttng_trace_chunk_put(chunk
);
3201 lttng_dynamic_buffer_reset(&reply_payload
);
3206 * relay_trace_chunk_exists: check if a trace chunk exists
3208 static int relay_trace_chunk_exists(const struct lttcomm_relayd_hdr
*recv_hdr
,
3209 struct relay_connection
*conn
,
3210 const struct lttng_buffer_view
*payload
)
3214 struct relay_session
*session
= conn
->session
;
3215 struct lttcomm_relayd_trace_chunk_exists
*msg
;
3216 struct lttcomm_relayd_trace_chunk_exists_reply reply
= {};
3217 struct lttng_buffer_view header_view
;
3221 if (!session
|| !conn
->version_check_done
) {
3222 ERR("Trying to check for the existance of a trace chunk before version check");
3227 if (session
->major
== 2 && session
->minor
< 11) {
3228 ERR("Chunk exists command is unsupported before 2.11");
3233 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
3234 if (!lttng_buffer_view_is_valid(&header_view
)) {
3235 ERR("Failed to receive payload of chunk exists command");
3240 /* Convert to host endianness. */
3241 msg
= (typeof(msg
)) header_view
.data
;
3242 chunk_id
= be64toh(msg
->chunk_id
);
3244 ret
= sessiond_trace_chunk_registry_chunk_exists(
3245 sessiond_trace_chunk_registry
,
3246 conn
->session
->sessiond_uuid
,
3248 chunk_id
, &chunk_exists
);
3250 * If ret is not 0, send the reply and report the error to the caller.
3251 * It is a protocol (or internal) error and the session/connection
3252 * should be torn down.
3254 reply
= (typeof(reply
)){
3255 .generic
.ret_code
= htobe32((uint32_t)
3256 (ret
== 0 ? LTTNG_OK
: LTTNG_ERR_INVALID_PROTOCOL
)),
3257 .trace_chunk_exists
= ret
== 0 ? chunk_exists
: 0,
3259 send_ret
= conn
->sock
->ops
->sendmsg(
3260 conn
->sock
, &reply
, sizeof(reply
), 0);
3261 if (send_ret
< (ssize_t
) sizeof(reply
)) {
3262 ERR("Failed to send \"create trace chunk\" command reply (ret = %zd)",
3271 * relay_get_configuration: query whether feature is available
3273 static int relay_get_configuration(const struct lttcomm_relayd_hdr
*recv_hdr
,
3274 struct relay_connection
*conn
,
3275 const struct lttng_buffer_view
*payload
)
3279 struct lttcomm_relayd_get_configuration
*msg
;
3280 struct lttcomm_relayd_get_configuration_reply reply
= {};
3281 struct lttng_buffer_view header_view
;
3282 uint64_t query_flags
= 0;
3283 uint64_t result_flags
= 0;
3285 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
3286 if (!lttng_buffer_view_is_valid(&header_view
)) {
3287 ERR("Failed to receive payload of chunk close command");
3292 /* Convert to host endianness. */
3293 msg
= (typeof(msg
)) header_view
.data
;
3294 query_flags
= be64toh(msg
->query_flags
);
3297 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
3300 if (opt_allow_clear
) {
3301 result_flags
|= LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
;
3305 reply
= (typeof(reply
)){
3306 .generic
.ret_code
= htobe32((uint32_t)
3307 (ret
== 0 ? LTTNG_OK
: LTTNG_ERR_INVALID_PROTOCOL
)),
3308 .relayd_configuration_flags
= htobe64(result_flags
),
3310 send_ret
= conn
->sock
->ops
->sendmsg(
3311 conn
->sock
, &reply
, sizeof(reply
), 0);
3312 if (send_ret
< (ssize_t
) sizeof(reply
)) {
3313 ERR("Failed to send \"get configuration\" command reply (ret = %zd)",
3321 #define DBG_CMD(cmd_name, conn) \
3322 DBG3("Processing \"%s\" command for socket %i", cmd_name, conn->sock->fd);
3324 static int relay_process_control_command(struct relay_connection
*conn
,
3325 const struct lttcomm_relayd_hdr
*header
,
3326 const struct lttng_buffer_view
*payload
)
3330 switch (header
->cmd
) {
3331 case RELAYD_CREATE_SESSION
:
3332 DBG_CMD("RELAYD_CREATE_SESSION", conn
);
3333 ret
= relay_create_session(header
, conn
, payload
);
3335 case RELAYD_ADD_STREAM
:
3336 DBG_CMD("RELAYD_ADD_STREAM", conn
);
3337 ret
= relay_add_stream(header
, conn
, payload
);
3339 case RELAYD_START_DATA
:
3340 DBG_CMD("RELAYD_START_DATA", conn
);
3341 ret
= relay_start(header
, conn
, payload
);
3343 case RELAYD_SEND_METADATA
:
3344 DBG_CMD("RELAYD_SEND_METADATA", conn
);
3345 ret
= relay_recv_metadata(header
, conn
, payload
);
3347 case RELAYD_VERSION
:
3348 DBG_CMD("RELAYD_VERSION", conn
);
3349 ret
= relay_send_version(header
, conn
, payload
);
3351 case RELAYD_CLOSE_STREAM
:
3352 DBG_CMD("RELAYD_CLOSE_STREAM", conn
);
3353 ret
= relay_close_stream(header
, conn
, payload
);
3355 case RELAYD_DATA_PENDING
:
3356 DBG_CMD("RELAYD_DATA_PENDING", conn
);
3357 ret
= relay_data_pending(header
, conn
, payload
);
3359 case RELAYD_QUIESCENT_CONTROL
:
3360 DBG_CMD("RELAYD_QUIESCENT_CONTROL", conn
);
3361 ret
= relay_quiescent_control(header
, conn
, payload
);
3363 case RELAYD_BEGIN_DATA_PENDING
:
3364 DBG_CMD("RELAYD_BEGIN_DATA_PENDING", conn
);
3365 ret
= relay_begin_data_pending(header
, conn
, payload
);
3367 case RELAYD_END_DATA_PENDING
:
3368 DBG_CMD("RELAYD_END_DATA_PENDING", conn
);
3369 ret
= relay_end_data_pending(header
, conn
, payload
);
3371 case RELAYD_SEND_INDEX
:
3372 DBG_CMD("RELAYD_SEND_INDEX", conn
);
3373 ret
= relay_recv_index(header
, conn
, payload
);
3375 case RELAYD_STREAMS_SENT
:
3376 DBG_CMD("RELAYD_STREAMS_SENT", conn
);
3377 ret
= relay_streams_sent(header
, conn
, payload
);
3379 case RELAYD_RESET_METADATA
:
3380 DBG_CMD("RELAYD_RESET_METADATA", conn
);
3381 ret
= relay_reset_metadata(header
, conn
, payload
);
3383 case RELAYD_ROTATE_STREAMS
:
3384 DBG_CMD("RELAYD_ROTATE_STREAMS", conn
);
3385 ret
= relay_rotate_session_streams(header
, conn
, payload
);
3387 case RELAYD_CREATE_TRACE_CHUNK
:
3388 DBG_CMD("RELAYD_CREATE_TRACE_CHUNK", conn
);
3389 ret
= relay_create_trace_chunk(header
, conn
, payload
);
3391 case RELAYD_CLOSE_TRACE_CHUNK
:
3392 DBG_CMD("RELAYD_CLOSE_TRACE_CHUNK", conn
);
3393 ret
= relay_close_trace_chunk(header
, conn
, payload
);
3395 case RELAYD_TRACE_CHUNK_EXISTS
:
3396 DBG_CMD("RELAYD_TRACE_CHUNK_EXISTS", conn
);
3397 ret
= relay_trace_chunk_exists(header
, conn
, payload
);
3399 case RELAYD_GET_CONFIGURATION
:
3400 DBG_CMD("RELAYD_GET_CONFIGURATION", conn
);
3401 ret
= relay_get_configuration(header
, conn
, payload
);
3403 case RELAYD_UPDATE_SYNC_INFO
:
3405 ERR("Received unknown command (%u)", header
->cmd
);
3406 relay_unknown_command(conn
);
3415 static enum relay_connection_status
relay_process_control_receive_payload(
3416 struct relay_connection
*conn
)
3419 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3420 struct lttng_dynamic_buffer
*reception_buffer
=
3421 &conn
->protocol
.ctrl
.reception_buffer
;
3422 struct ctrl_connection_state_receive_payload
*state
=
3423 &conn
->protocol
.ctrl
.state
.receive_payload
;
3424 struct lttng_buffer_view payload_view
;
3426 if (state
->left_to_receive
== 0) {
3427 /* Short-circuit for payload-less commands. */
3428 goto reception_complete
;
3431 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3432 reception_buffer
->data
+ state
->received
,
3433 state
->left_to_receive
, MSG_DONTWAIT
);
3435 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3436 PERROR("Unable to receive command payload on sock %d",
3438 status
= RELAY_CONNECTION_STATUS_ERROR
;
3441 } else if (ret
== 0) {
3442 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3443 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3448 assert(ret
<= state
->left_to_receive
);
3450 state
->left_to_receive
-= ret
;
3451 state
->received
+= ret
;
3453 if (state
->left_to_receive
> 0) {
3455 * Can't transition to the protocol's next state, wait to
3456 * receive the rest of the header.
3458 DBG3("Partial reception of control connection protocol payload (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3459 state
->received
, state
->left_to_receive
,
3465 DBG("Done receiving control command payload: fd = %i, payload size = %" PRIu64
" bytes",
3466 conn
->sock
->fd
, state
->received
);
3468 * The payload required to process the command has been received.
3469 * A view to the reception buffer is forwarded to the various
3470 * commands and the state of the control is reset on success.
3472 * Commands are responsible for sending their reply to the peer.
3474 payload_view
= lttng_buffer_view_from_dynamic_buffer(reception_buffer
,
3476 ret
= relay_process_control_command(conn
,
3477 &state
->header
, &payload_view
);
3479 status
= RELAY_CONNECTION_STATUS_ERROR
;
3483 ret
= connection_reset_protocol_state(conn
);
3485 status
= RELAY_CONNECTION_STATUS_ERROR
;
3491 static enum relay_connection_status
relay_process_control_receive_header(
3492 struct relay_connection
*conn
)
3495 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3496 struct lttcomm_relayd_hdr header
;
3497 struct lttng_dynamic_buffer
*reception_buffer
=
3498 &conn
->protocol
.ctrl
.reception_buffer
;
3499 struct ctrl_connection_state_receive_header
*state
=
3500 &conn
->protocol
.ctrl
.state
.receive_header
;
3502 assert(state
->left_to_receive
!= 0);
3504 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3505 reception_buffer
->data
+ state
->received
,
3506 state
->left_to_receive
, MSG_DONTWAIT
);
3508 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3509 PERROR("Unable to receive control command header on sock %d",
3511 status
= RELAY_CONNECTION_STATUS_ERROR
;
3514 } else if (ret
== 0) {
3515 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3516 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3521 assert(ret
<= state
->left_to_receive
);
3523 state
->left_to_receive
-= ret
;
3524 state
->received
+= ret
;
3526 if (state
->left_to_receive
> 0) {
3528 * Can't transition to the protocol's next state, wait to
3529 * receive the rest of the header.
3531 DBG3("Partial reception of control connection protocol header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3532 state
->received
, state
->left_to_receive
,
3537 /* Transition to next state: receiving the command's payload. */
3538 conn
->protocol
.ctrl
.state_id
=
3539 CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3540 memcpy(&header
, reception_buffer
->data
, sizeof(header
));
3541 header
.circuit_id
= be64toh(header
.circuit_id
);
3542 header
.data_size
= be64toh(header
.data_size
);
3543 header
.cmd
= be32toh(header
.cmd
);
3544 header
.cmd_version
= be32toh(header
.cmd_version
);
3545 memcpy(&conn
->protocol
.ctrl
.state
.receive_payload
.header
,
3546 &header
, sizeof(header
));
3548 DBG("Done receiving control command header: fd = %i, cmd = %" PRIu32
", cmd_version = %" PRIu32
", payload size = %" PRIu64
" bytes",
3549 conn
->sock
->fd
, header
.cmd
, header
.cmd_version
,
3552 if (header
.data_size
> DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE
) {
3553 ERR("Command header indicates a payload (%" PRIu64
" bytes) that exceeds the maximal payload size allowed on a control connection.",
3555 status
= RELAY_CONNECTION_STATUS_ERROR
;
3559 conn
->protocol
.ctrl
.state
.receive_payload
.left_to_receive
=
3561 conn
->protocol
.ctrl
.state
.receive_payload
.received
= 0;
3562 ret
= lttng_dynamic_buffer_set_size(reception_buffer
,
3565 status
= RELAY_CONNECTION_STATUS_ERROR
;
3569 if (header
.data_size
== 0) {
3571 * Manually invoke the next state as the poll loop
3572 * will not wake-up to allow us to proceed further.
3574 status
= relay_process_control_receive_payload(conn
);
3581 * Process the commands received on the control socket
3583 static enum relay_connection_status
relay_process_control(
3584 struct relay_connection
*conn
)
3586 enum relay_connection_status status
;
3588 switch (conn
->protocol
.ctrl
.state_id
) {
3589 case CTRL_CONNECTION_STATE_RECEIVE_HEADER
:
3590 status
= relay_process_control_receive_header(conn
);
3592 case CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3593 status
= relay_process_control_receive_payload(conn
);
3596 ERR("Unknown control connection protocol state encountered.");
3603 static enum relay_connection_status
relay_process_data_receive_header(
3604 struct relay_connection
*conn
)
3607 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3608 struct data_connection_state_receive_header
*state
=
3609 &conn
->protocol
.data
.state
.receive_header
;
3610 struct lttcomm_relayd_data_hdr header
;
3611 struct relay_stream
*stream
;
3613 assert(state
->left_to_receive
!= 0);
3615 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3616 state
->header_reception_buffer
+ state
->received
,
3617 state
->left_to_receive
, MSG_DONTWAIT
);
3619 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3620 PERROR("Unable to receive data header on sock %d", conn
->sock
->fd
);
3621 status
= RELAY_CONNECTION_STATUS_ERROR
;
3624 } else if (ret
== 0) {
3625 /* Orderly shutdown. Not necessary to print an error. */
3626 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3627 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3632 assert(ret
<= state
->left_to_receive
);
3634 state
->left_to_receive
-= ret
;
3635 state
->received
+= ret
;
3637 if (state
->left_to_receive
> 0) {
3639 * Can't transition to the protocol's next state, wait to
3640 * receive the rest of the header.
3642 DBG3("Partial reception of data connection header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3643 state
->received
, state
->left_to_receive
,
3648 /* Transition to next state: receiving the payload. */
3649 conn
->protocol
.data
.state_id
= DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3651 memcpy(&header
, state
->header_reception_buffer
, sizeof(header
));
3652 header
.circuit_id
= be64toh(header
.circuit_id
);
3653 header
.stream_id
= be64toh(header
.stream_id
);
3654 header
.data_size
= be32toh(header
.data_size
);
3655 header
.net_seq_num
= be64toh(header
.net_seq_num
);
3656 header
.padding_size
= be32toh(header
.padding_size
);
3657 memcpy(&conn
->protocol
.data
.state
.receive_payload
.header
, &header
, sizeof(header
));
3659 conn
->protocol
.data
.state
.receive_payload
.left_to_receive
=
3661 conn
->protocol
.data
.state
.receive_payload
.received
= 0;
3662 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= false;
3664 DBG("Received data connection header on fd %i: circuit_id = %" PRIu64
", stream_id = %" PRIu64
", data_size = %" PRIu32
", net_seq_num = %" PRIu64
", padding_size = %" PRIu32
,
3665 conn
->sock
->fd
, header
.circuit_id
,
3666 header
.stream_id
, header
.data_size
,
3667 header
.net_seq_num
, header
.padding_size
);
3669 stream
= stream_get_by_id(header
.stream_id
);
3671 DBG("relay_process_data_receive_payload: Cannot find stream %" PRIu64
,
3673 /* Protocol error. */
3674 status
= RELAY_CONNECTION_STATUS_ERROR
;
3678 pthread_mutex_lock(&stream
->lock
);
3679 /* Prepare stream for the reception of a new packet. */
3680 ret
= stream_init_packet(stream
, header
.data_size
,
3681 &conn
->protocol
.data
.state
.receive_payload
.rotate_index
);
3682 pthread_mutex_unlock(&stream
->lock
);
3684 ERR("Failed to rotate stream output file");
3685 status
= RELAY_CONNECTION_STATUS_ERROR
;
3686 goto end_stream_unlock
;
3695 static enum relay_connection_status
relay_process_data_receive_payload(
3696 struct relay_connection
*conn
)
3699 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3700 struct relay_stream
*stream
;
3701 struct data_connection_state_receive_payload
*state
=
3702 &conn
->protocol
.data
.state
.receive_payload
;
3703 const size_t chunk_size
= RECV_DATA_BUFFER_SIZE
;
3704 char data_buffer
[chunk_size
];
3705 bool partial_recv
= false;
3706 bool new_stream
= false, close_requested
= false, index_flushed
= false;
3707 uint64_t left_to_receive
= state
->left_to_receive
;
3708 struct relay_session
*session
;
3710 DBG3("Receiving data for stream id %" PRIu64
" seqnum %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3711 state
->header
.stream_id
, state
->header
.net_seq_num
,
3712 state
->received
, left_to_receive
);
3714 stream
= stream_get_by_id(state
->header
.stream_id
);
3716 /* Protocol error. */
3717 ERR("relay_process_data_receive_payload: cannot find stream %" PRIu64
,
3718 state
->header
.stream_id
);
3719 status
= RELAY_CONNECTION_STATUS_ERROR
;
3723 pthread_mutex_lock(&stream
->lock
);
3724 session
= stream
->trace
->session
;
3725 if (!conn
->session
) {
3726 ret
= connection_set_session(conn
, session
);
3728 status
= RELAY_CONNECTION_STATUS_ERROR
;
3729 goto end_stream_unlock
;
3734 * The size of the "chunk" received on any iteration is bounded by:
3735 * - the data left to receive,
3736 * - the data immediately available on the socket,
3737 * - the on-stack data buffer
3739 while (left_to_receive
> 0 && !partial_recv
) {
3740 size_t recv_size
= min(left_to_receive
, chunk_size
);
3741 struct lttng_buffer_view packet_chunk
;
3743 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
,
3744 recv_size
, MSG_DONTWAIT
);
3746 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3747 PERROR("Socket %d error", conn
->sock
->fd
);
3748 status
= RELAY_CONNECTION_STATUS_ERROR
;
3750 goto end_stream_unlock
;
3751 } else if (ret
== 0) {
3752 /* No more data ready to be consumed on socket. */
3753 DBG3("No more data ready for consumption on data socket of stream id %" PRIu64
,
3754 state
->header
.stream_id
);
3755 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3757 } else if (ret
< (int) recv_size
) {
3759 * All the data available on the socket has been
3762 partial_recv
= true;
3766 packet_chunk
= lttng_buffer_view_init(data_buffer
,
3768 assert(packet_chunk
.data
);
3770 ret
= stream_write(stream
, &packet_chunk
, 0);
3772 ERR("Relay error writing data to file");
3773 status
= RELAY_CONNECTION_STATUS_ERROR
;
3774 goto end_stream_unlock
;
3777 left_to_receive
-= recv_size
;
3778 state
->received
+= recv_size
;
3779 state
->left_to_receive
= left_to_receive
;
3782 if (state
->left_to_receive
> 0) {
3784 * Did not receive all the data expected, wait for more data to
3785 * become available on the socket.
3787 DBG3("Partial receive on data connection of stream id %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3788 state
->header
.stream_id
, state
->received
,
3789 state
->left_to_receive
);
3790 goto end_stream_unlock
;
3793 ret
= stream_write(stream
, NULL
, state
->header
.padding_size
);
3795 status
= RELAY_CONNECTION_STATUS_ERROR
;
3796 goto end_stream_unlock
;
3799 if (session_streams_have_index(session
)) {
3800 ret
= stream_update_index(stream
, state
->header
.net_seq_num
,
3801 state
->rotate_index
, &index_flushed
,
3802 state
->header
.data_size
+ state
->header
.padding_size
);
3804 ERR("Failed to update index: stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3805 stream
->stream_handle
,
3806 state
->header
.net_seq_num
, ret
);
3807 status
= RELAY_CONNECTION_STATUS_ERROR
;
3808 goto end_stream_unlock
;
3812 if (stream
->prev_data_seq
== -1ULL) {
3816 ret
= stream_complete_packet(stream
, state
->header
.data_size
+
3817 state
->header
.padding_size
, state
->header
.net_seq_num
,
3820 status
= RELAY_CONNECTION_STATUS_ERROR
;
3821 goto end_stream_unlock
;
3825 * Resetting the protocol state (to RECEIVE_HEADER) will trash the
3826 * contents of *state which are aliased (union) to the same location as
3827 * the new state. Don't use it beyond this point.
3829 connection_reset_protocol_state(conn
);
3833 close_requested
= stream
->close_requested
;
3834 pthread_mutex_unlock(&stream
->lock
);
3835 if (close_requested
&& left_to_receive
== 0) {
3836 try_stream_close(stream
);
3840 pthread_mutex_lock(&session
->lock
);
3841 uatomic_set(&session
->new_streams
, 1);
3842 pthread_mutex_unlock(&session
->lock
);
3851 * relay_process_data: Process the data received on the data socket
3853 static enum relay_connection_status
relay_process_data(
3854 struct relay_connection
*conn
)
3856 enum relay_connection_status status
;
3858 switch (conn
->protocol
.data
.state_id
) {
3859 case DATA_CONNECTION_STATE_RECEIVE_HEADER
:
3860 status
= relay_process_data_receive_header(conn
);
3862 case DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3863 status
= relay_process_data_receive_payload(conn
);
3866 ERR("Unexpected data connection communication state.");
3873 static void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
3877 (void) lttng_poll_del(events
, pollfd
);
3879 ret
= fd_tracker_close_unsuspendable_fd(the_fd_tracker
, &pollfd
, 1,
3880 fd_tracker_util_close_fd
, NULL
);
3882 ERR("Closing pollfd %d", pollfd
);
3886 static void relay_thread_close_connection(struct lttng_poll_event
*events
,
3887 int pollfd
, struct relay_connection
*conn
)
3889 const char *type_str
;
3891 switch (conn
->type
) {
3896 type_str
= "Control";
3898 case RELAY_VIEWER_COMMAND
:
3899 type_str
= "Viewer Command";
3901 case RELAY_VIEWER_NOTIFICATION
:
3902 type_str
= "Viewer Notification";
3905 type_str
= "Unknown";
3907 cleanup_connection_pollfd(events
, pollfd
);
3908 connection_put(conn
);
3909 DBG("%s connection closed with %d", type_str
, pollfd
);
3913 * This thread does the actual work
3915 static void *relay_thread_worker(void *data
)
3917 int ret
, err
= -1, last_seen_data_fd
= -1;
3919 struct lttng_poll_event events
;
3920 struct lttng_ht
*relay_connections_ht
;
3921 struct lttng_ht_iter iter
;
3922 struct relay_connection
*destroy_conn
= NULL
;
3924 DBG("[thread] Relay worker started");
3926 rcu_register_thread();
3928 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
3930 if (testpoint(relayd_thread_worker
)) {
3931 goto error_testpoint
;
3934 health_code_update();
3936 /* table of connections indexed on socket */
3937 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3938 if (!relay_connections_ht
) {
3939 goto relay_connections_ht_error
;
3942 ret
= create_named_thread_poll_set(&events
, 2, "Worker thread epoll");
3944 goto error_poll_create
;
3947 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
3954 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
3956 health_code_update();
3958 /* Infinite blocking call, waiting for transmission */
3959 DBG3("Relayd worker thread polling...");
3960 health_poll_entry();
3961 ret
= lttng_poll_wait(&events
, -1);
3965 * Restart interrupted system call.
3967 if (errno
== EINTR
) {
3976 * Process control. The control connection is
3977 * prioritized so we don't starve it with high
3978 * throughput tracing data on the data connection.
3980 for (i
= 0; i
< nb_fd
; i
++) {
3981 /* Fetch once the poll data */
3982 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3983 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3985 health_code_update();
3987 /* Thread quit pipe has been closed. Killing thread. */
3988 ret
= check_thread_quit_pipe(pollfd
, revents
);
3994 /* Inspect the relay conn pipe for new connection */
3995 if (pollfd
== relay_conn_pipe
[0]) {
3996 if (revents
& LPOLLIN
) {
3997 struct relay_connection
*conn
;
3999 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
4003 ret
= lttng_poll_add(&events
,
4005 LPOLLIN
| LPOLLRDHUP
);
4007 ERR("Failed to add new connection file descriptor to poll set");
4010 connection_ht_add(relay_connections_ht
, conn
);
4011 DBG("Connection socket %d added", conn
->sock
->fd
);
4012 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4013 ERR("Relay connection pipe error");
4016 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
4020 struct relay_connection
*ctrl_conn
;
4022 ctrl_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
4023 /* If not found, there is a synchronization issue. */
4026 if (ctrl_conn
->type
== RELAY_DATA
) {
4027 if (revents
& LPOLLIN
) {
4029 * Flag the last seen data fd not deleted. It will be
4030 * used as the last seen fd if any fd gets deleted in
4033 last_notdel_data_fd
= pollfd
;
4035 goto put_ctrl_connection
;
4037 assert(ctrl_conn
->type
== RELAY_CONTROL
);
4039 if (revents
& LPOLLIN
) {
4040 enum relay_connection_status status
;
4042 status
= relay_process_control(ctrl_conn
);
4043 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
4045 * On socket error flag the session as aborted to force
4046 * the cleanup of its stream otherwise it can leak
4047 * during the lifetime of the relayd.
4049 * This prevents situations in which streams can be
4050 * left opened because an index was received, the
4051 * control connection is closed, and the data
4052 * connection is closed (uncleanly) before the packet's
4055 * Since the control connection encountered an error,
4056 * it is okay to be conservative and close the
4057 * session right now as we can't rely on the protocol
4058 * being respected anymore.
4060 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
4061 session_abort(ctrl_conn
->session
);
4064 /* Clear the connection on error or close. */
4065 relay_thread_close_connection(&events
,
4070 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4071 relay_thread_close_connection(&events
,
4073 if (last_seen_data_fd
== pollfd
) {
4074 last_seen_data_fd
= last_notdel_data_fd
;
4077 ERR("Unexpected poll events %u for control sock %d",
4079 connection_put(ctrl_conn
);
4082 put_ctrl_connection
:
4083 connection_put(ctrl_conn
);
4088 * The last loop handled a control request, go back to poll to make
4089 * sure we prioritise the control socket.
4095 if (last_seen_data_fd
>= 0) {
4096 for (i
= 0; i
< nb_fd
; i
++) {
4097 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4099 health_code_update();
4101 if (last_seen_data_fd
== pollfd
) {
4108 /* Process data connection. */
4109 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
4110 /* Fetch the poll data. */
4111 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
4112 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4113 struct relay_connection
*data_conn
;
4115 health_code_update();
4118 /* No activity for this FD (poll implementation). */
4122 /* Skip the command pipe. It's handled in the first loop. */
4123 if (pollfd
== relay_conn_pipe
[0]) {
4127 data_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
4129 /* Skip it. Might be removed before. */
4132 if (data_conn
->type
== RELAY_CONTROL
) {
4133 goto put_data_connection
;
4135 assert(data_conn
->type
== RELAY_DATA
);
4137 if (revents
& LPOLLIN
) {
4138 enum relay_connection_status status
;
4140 status
= relay_process_data(data_conn
);
4141 /* Connection closed or error. */
4142 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
4144 * On socket error flag the session as aborted to force
4145 * the cleanup of its stream otherwise it can leak
4146 * during the lifetime of the relayd.
4148 * This prevents situations in which streams can be
4149 * left opened because an index was received, the
4150 * control connection is closed, and the data
4151 * connection is closed (uncleanly) before the packet's
4154 * Since the data connection encountered an error,
4155 * it is okay to be conservative and close the
4156 * session right now as we can't rely on the protocol
4157 * being respected anymore.
4159 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
4160 session_abort(data_conn
->session
);
4162 relay_thread_close_connection(&events
, pollfd
,
4165 * Every goto restart call sets the last seen fd where
4166 * here we don't really care since we gracefully
4167 * continue the loop after the connection is deleted.
4170 /* Keep last seen port. */
4171 last_seen_data_fd
= pollfd
;
4172 connection_put(data_conn
);
4175 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4176 relay_thread_close_connection(&events
, pollfd
,
4179 ERR("Unknown poll events %u for data sock %d",
4182 put_data_connection
:
4183 connection_put(data_conn
);
4185 last_seen_data_fd
= -1;
4188 /* Normal exit, no error */
4193 /* Cleanup remaining connection object. */
4195 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
,
4198 health_code_update();
4200 session_abort(destroy_conn
->session
);
4203 * No need to grab another ref, because we own
4206 relay_thread_close_connection(&events
, destroy_conn
->sock
->fd
,
4211 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
4213 lttng_ht_destroy(relay_connections_ht
);
4214 relay_connections_ht_error
:
4215 /* Close relay conn pipes */
4216 (void) fd_tracker_util_pipe_close(the_fd_tracker
,
4219 DBG("Thread exited with error");
4221 DBG("Worker thread cleanup complete");
4225 ERR("Health error occurred in %s", __func__
);
4227 health_unregister(health_relayd
);
4228 rcu_unregister_thread();
4229 lttng_relay_stop_threads();
4234 * Create the relay command pipe to wake thread_manage_apps.
4235 * Closed in cleanup().
4237 static int create_relay_conn_pipe(void)
4239 return fd_tracker_util_pipe_open_cloexec(the_fd_tracker
,
4240 "Relayd connection pipe", relay_conn_pipe
);
4243 static int stdio_open(void *data
, int *fds
)
4245 fds
[0] = fileno(stdout
);
4246 fds
[1] = fileno(stderr
);
4250 static int track_stdio(void)
4253 const char *names
[] = { "stdout", "stderr" };
4255 return fd_tracker_open_unsuspendable_fd(the_fd_tracker
, fds
,
4256 names
, 2, stdio_open
, NULL
);
4262 int main(int argc
, char **argv
)
4264 bool thread_is_rcu_registered
= false;
4265 int ret
= 0, retval
= 0;
4267 char *unlinked_file_directory_path
= NULL
, *output_path
= NULL
;
4269 /* Parse environment variables */
4270 ret
= parse_env_options();
4278 * Command line arguments overwrite environment.
4281 if (set_options(argc
, argv
)) {
4286 if (set_signal_handler()) {
4291 relayd_config_log();
4293 if (opt_print_version
) {
4299 ret
= fclose(stdin
);
4301 PERROR("Failed to close stdin");
4305 DBG("Clear command %s", opt_allow_clear
? "allowed" : "disallowed");
4307 /* Try to create directory if -o, --output is specified. */
4308 if (opt_output_path
) {
4309 if (*opt_output_path
!= '/') {
4310 ERR("Please specify an absolute path for -o, --output PATH");
4315 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
,
4318 ERR("Unable to create %s", opt_output_path
);
4325 if (opt_daemon
|| opt_background
) {
4326 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
4334 if (opt_working_directory
) {
4335 ret
= utils_change_working_directory(opt_working_directory
);
4337 /* All errors are already logged. */
4342 sessiond_trace_chunk_registry
= sessiond_trace_chunk_registry_create();
4343 if (!sessiond_trace_chunk_registry
) {
4344 ERR("Failed to initialize session daemon trace chunk registry");
4350 * The RCU thread registration (and use, through the fd-tracker's
4351 * creation) is done after the daemonization to allow us to not
4352 * deal with liburcu's fork() management as the call RCU needs to
4355 rcu_register_thread();
4356 thread_is_rcu_registered
= true;
4358 output_path
= create_output_path("");
4360 ERR("Failed to get output path");
4364 ret
= asprintf(&unlinked_file_directory_path
, "%s/%s", output_path
,
4365 DEFAULT_UNLINKED_FILES_DIRECTORY
);
4368 ERR("Failed to format unlinked file directory path");
4372 the_fd_tracker
= fd_tracker_create(
4373 unlinked_file_directory_path
, lttng_opt_fd_pool_size
);
4374 free(unlinked_file_directory_path
);
4375 if (!the_fd_tracker
) {
4380 ret
= track_stdio();
4386 /* Initialize thread health monitoring */
4387 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
4388 if (!health_relayd
) {
4389 PERROR("health_app_create error");
4394 /* Create thread quit pipe */
4395 if (init_thread_quit_pipe()) {
4400 /* Setup the thread apps communication pipe. */
4401 if (create_relay_conn_pipe()) {
4406 /* Init relay command queue. */
4407 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
4409 /* Initialize communication library */
4411 lttcomm_inet_init();
4413 /* tables of sessions indexed by session ID */
4414 sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4420 /* tables of streams indexed by stream ID */
4421 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4422 if (!relay_streams_ht
) {
4427 /* tables of streams indexed by stream ID */
4428 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4429 if (!viewer_streams_ht
) {
4434 ret
= init_health_quit_pipe();
4440 /* Create thread to manage the client socket */
4441 ret
= pthread_create(&health_thread
, default_pthread_attr(),
4442 thread_manage_health
, (void *) NULL
);
4445 PERROR("pthread_create health");
4450 /* Setup the dispatcher thread */
4451 ret
= pthread_create(&dispatcher_thread
, default_pthread_attr(),
4452 relay_thread_dispatcher
, (void *) NULL
);
4455 PERROR("pthread_create dispatcher");
4457 goto exit_dispatcher_thread
;
4460 /* Setup the worker thread */
4461 ret
= pthread_create(&worker_thread
, default_pthread_attr(),
4462 relay_thread_worker
, NULL
);
4465 PERROR("pthread_create worker");
4467 goto exit_worker_thread
;
4470 /* Setup the listener thread */
4471 ret
= pthread_create(&listener_thread
, default_pthread_attr(),
4472 relay_thread_listener
, (void *) NULL
);
4475 PERROR("pthread_create listener");
4477 goto exit_listener_thread
;
4480 ret
= relayd_live_create(live_uri
);
4482 ERR("Starting live viewer threads");
4488 * This is where we start awaiting program completion (e.g. through
4489 * signal that asks threads to teardown).
4492 ret
= relayd_live_join();
4498 ret
= pthread_join(listener_thread
, &status
);
4501 PERROR("pthread_join listener_thread");
4505 exit_listener_thread
:
4506 ret
= pthread_join(worker_thread
, &status
);
4509 PERROR("pthread_join worker_thread");
4514 ret
= pthread_join(dispatcher_thread
, &status
);
4517 PERROR("pthread_join dispatcher_thread");
4520 exit_dispatcher_thread
:
4522 ret
= pthread_join(health_thread
, &status
);
4525 PERROR("pthread_join health_thread");
4530 * Wait for all pending call_rcu work to complete before tearing
4531 * down data structures. call_rcu worker may be trying to
4532 * perform lookups in those structures.
4537 /* Ensure all prior call_rcu are done. */
4540 if (thread_is_rcu_registered
) {
4541 rcu_unregister_thread();