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>
38 #include <lttng/lttng.h>
39 #include <common/common.h>
40 #include <common/compat/poll.h>
41 #include <common/compat/socket.h>
42 #include <common/compat/endian.h>
43 #include <common/compat/getenv.h>
44 #include <common/defaults.h>
45 #include <common/daemonize.h>
46 #include <common/futex.h>
47 #include <common/sessiond-comm/sessiond-comm.h>
48 #include <common/sessiond-comm/inet.h>
49 #include <common/sessiond-comm/relayd.h>
50 #include <common/uri.h>
51 #include <common/utils.h>
52 #include <common/align.h>
53 #include <common/ini-config/ini-config.h>
54 #include <common/dynamic-buffer.h>
55 #include <common/buffer-view.h>
56 #include <common/string-utils/format.h>
57 #include <common/fd-tracker/fd-tracker.h>
58 #include <common/fd-tracker/utils.h>
60 #include "backward-compatibility-group-by.h"
62 #include "connection.h"
63 #include "ctf-trace.h"
64 #include "health-relayd.h"
67 #include "lttng-relayd.h"
69 #include "sessiond-trace-chunks.h"
71 #include "tcp_keep_alive.h"
72 #include "testpoint.h"
73 #include "tracefile-array.h"
76 #include "viewer-stream.h"
78 static const char *help_msg
=
79 #ifdef LTTNG_EMBED_HELP
80 #include <lttng-relayd.8.h>
86 enum relay_connection_status
{
87 RELAY_CONNECTION_STATUS_OK
,
88 /* An error occurred while processing an event on the connection. */
89 RELAY_CONNECTION_STATUS_ERROR
,
90 /* Connection closed/shutdown cleanly. */
91 RELAY_CONNECTION_STATUS_CLOSED
,
94 /* command line options */
95 char *opt_output_path
, *opt_working_directory
;
96 static int opt_daemon
, opt_background
, opt_print_version
, opt_allow_clear
= 1;
97 enum relay_group_output_by opt_group_output_by
= RELAYD_GROUP_OUTPUT_BY_UNKNOWN
;
99 /* Argument variables */
100 int lttng_opt_quiet
; /* not static in error.h */
101 int lttng_opt_verbose
; /* not static in error.h */
102 int lttng_opt_mi
; /* not static in error.h */
105 * We need to wait for listener and live listener threads, as well as
106 * health check thread, before being ready to signal readiness.
108 #define NR_LTTNG_RELAY_READY 3
109 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
111 /* Size of receive buffer. */
112 #define RECV_DATA_BUFFER_SIZE 65536
114 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
115 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
117 static struct lttng_uri
*control_uri
;
118 static struct lttng_uri
*data_uri
;
119 static struct lttng_uri
*live_uri
;
121 const char *progname
;
123 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
124 static int tracing_group_name_override
;
126 const char * const config_section_name
= "relayd";
129 * Quit pipe for all threads. This permits a single cancellation point
130 * for all threads when receiving an event on the pipe.
132 int thread_quit_pipe
[2] = { -1, -1 };
135 * This pipe is used to inform the worker thread that a command is queued and
136 * ready to be processed.
138 static int relay_conn_pipe
[2] = { -1, -1 };
140 /* Shared between threads */
141 static int dispatch_thread_exit
;
143 static pthread_t listener_thread
;
144 static pthread_t dispatcher_thread
;
145 static pthread_t worker_thread
;
146 static pthread_t health_thread
;
149 * last_relay_stream_id_lock protects last_relay_stream_id increment
150 * atomicity on 32-bit architectures.
152 static pthread_mutex_t last_relay_stream_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
153 static uint64_t last_relay_stream_id
;
156 * Relay command queue.
158 * The relay_thread_listener and relay_thread_dispatcher communicate with this
161 static struct relay_conn_queue relay_conn_queue
;
163 /* Cap of file desriptors to be in simultaneous use by the relay daemon. */
164 static unsigned int lttng_opt_fd_pool_size
= -1;
166 /* Global relay stream hash table. */
167 struct lttng_ht
*relay_streams_ht
;
169 /* Global relay viewer stream hash table. */
170 struct lttng_ht
*viewer_streams_ht
;
172 /* Global relay sessions hash table. */
173 struct lttng_ht
*sessions_ht
;
175 /* Relayd health monitoring */
176 struct health_app
*health_relayd
;
178 struct sessiond_trace_chunk_registry
*sessiond_trace_chunk_registry
;
180 /* Global fd tracker. */
181 struct fd_tracker
*the_fd_tracker
;
183 static struct option long_options
[] = {
184 { "control-port", 1, 0, 'C', },
185 { "data-port", 1, 0, 'D', },
186 { "live-port", 1, 0, 'L', },
187 { "daemonize", 0, 0, 'd', },
188 { "background", 0, 0, 'b', },
189 { "group", 1, 0, 'g', },
190 { "fd-pool-size", 1, 0, '\0', },
191 { "help", 0, 0, 'h', },
192 { "output", 1, 0, 'o', },
193 { "verbose", 0, 0, 'v', },
194 { "config", 1, 0, 'f' },
195 { "version", 0, 0, 'V' },
196 { "working-directory", 1, 0, 'w', },
197 { "group-output-by-session", 0, 0, 's', },
198 { "group-output-by-host", 0, 0, 'p', },
199 { "disallow-clear", 0, 0, 'x' },
203 static const char *config_ignore_options
[] = { "help", "config", "version" };
205 static void print_version(void) {
206 fprintf(stdout
, "%s\n", VERSION
);
209 static void relayd_config_log(void)
211 DBG("LTTng-relayd " VERSION
" - " VERSION_NAME
"%s%s",
212 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
,
213 EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " EXTRA_VERSION_NAME
);
214 if (EXTRA_VERSION_DESCRIPTION
[0] != '\0') {
215 DBG("LTTng-relayd extra version description:\n\t" EXTRA_VERSION_DESCRIPTION
"\n");
217 if (EXTRA_VERSION_PATCHES
[0] != '\0') {
218 DBG("LTTng-relayd extra patches:\n\t" EXTRA_VERSION_PATCHES
"\n");
223 * Take an option from the getopt output and set it in the right variable to be
226 * Return 0 on success else a negative value.
228 static int set_option(int opt
, const char *arg
, const char *optname
)
234 if (!strcmp(optname
, "fd-pool-size")) {
238 v
= strtoul(arg
, NULL
, 0);
239 if (errno
!= 0 || !isdigit((unsigned char) arg
[0])) {
240 ERR("Wrong value in --fd-pool-size parameter: %s", arg
);
245 ERR("File descriptor cap overflow in --fd-pool-size parameter: %s", arg
);
249 lttng_opt_fd_pool_size
= (unsigned int) v
;
251 fprintf(stderr
, "unknown option %s", optname
);
253 fprintf(stderr
, " with arg %s\n", arg
);
258 if (lttng_is_setuid_setgid()) {
259 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
260 "-C, --control-port");
262 ret
= uri_parse(arg
, &control_uri
);
264 ERR("Invalid control URI specified");
267 if (control_uri
->port
== 0) {
268 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
273 if (lttng_is_setuid_setgid()) {
274 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
277 ret
= uri_parse(arg
, &data_uri
);
279 ERR("Invalid data URI specified");
282 if (data_uri
->port
== 0) {
283 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
288 if (lttng_is_setuid_setgid()) {
289 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
292 ret
= uri_parse(arg
, &live_uri
);
294 ERR("Invalid live URI specified");
297 if (live_uri
->port
== 0) {
298 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
309 if (lttng_is_setuid_setgid()) {
310 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
313 tracing_group_name
= strdup(arg
);
314 if (tracing_group_name
== NULL
) {
319 tracing_group_name_override
= 1;
323 ret
= utils_show_help(8, "lttng-relayd", help_msg
);
325 ERR("Cannot show --help for `lttng-relayd`");
330 opt_print_version
= 1;
333 if (lttng_is_setuid_setgid()) {
334 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
337 ret
= asprintf(&opt_output_path
, "%s", arg
);
340 PERROR("asprintf opt_output_path");
346 if (lttng_is_setuid_setgid()) {
347 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
348 "-w, --working-directory");
350 ret
= asprintf(&opt_working_directory
, "%s", arg
);
353 PERROR("asprintf opt_working_directory");
360 /* Verbose level can increase using multiple -v */
362 lttng_opt_verbose
= config_parse_value(arg
);
364 /* Only 3 level of verbosity (-vvv). */
365 if (lttng_opt_verbose
< 3) {
366 lttng_opt_verbose
+= 1;
371 if (opt_group_output_by
!= RELAYD_GROUP_OUTPUT_BY_UNKNOWN
) {
372 ERR("Cannot set --group-output-by-session, another --group-output-by argument is present");
375 opt_group_output_by
= RELAYD_GROUP_OUTPUT_BY_SESSION
;
378 if (opt_group_output_by
!= RELAYD_GROUP_OUTPUT_BY_UNKNOWN
) {
379 ERR("Cannot set --group-output-by-host, another --group-output-by argument is present");
382 opt_group_output_by
= RELAYD_GROUP_OUTPUT_BY_HOST
;
389 /* Unknown option or other error.
390 * Error is printed by getopt, just return */
403 * config_entry_handler_cb used to handle options read from a config file.
404 * See config_entry_handler_cb comment in common/config/session-config.h for the
405 * return value conventions.
407 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
411 if (!entry
|| !entry
->name
|| !entry
->value
) {
416 /* Check if the option is to be ignored */
417 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
418 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
423 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1; i
++) {
424 /* Ignore if entry name is not fully matched. */
425 if (strcmp(entry
->name
, long_options
[i
].name
)) {
430 * If the option takes no argument on the command line,
431 * we have to check if the value is "true". We support
432 * non-zero numeric values, true, on and yes.
434 if (!long_options
[i
].has_arg
) {
435 ret
= config_parse_value(entry
->value
);
438 WARN("Invalid configuration value \"%s\" for option %s",
439 entry
->value
, entry
->name
);
441 /* False, skip boolean config option. */
446 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
450 WARN("Unrecognized option \"%s\" in daemon configuration file.",
457 static int parse_env_options(void)
462 value
= lttng_secure_getenv(DEFAULT_LTTNG_RELAYD_WORKING_DIRECTORY_ENV
);
464 opt_working_directory
= strdup(value
);
465 if (!opt_working_directory
) {
466 ERR("Failed to allocate working directory string (\"%s\")",
474 static int set_fd_pool_size(void)
477 struct rlimit rlimit
;
479 ret
= getrlimit(RLIMIT_NOFILE
, &rlimit
);
481 PERROR("Failed to get file descriptor limit");
486 DBG("File descriptor count limits are %" PRIu64
" (soft) and %" PRIu64
" (hard)",
487 (uint64_t) rlimit
.rlim_cur
,
488 (uint64_t) rlimit
.rlim_max
);
489 if (lttng_opt_fd_pool_size
== -1) {
490 /* Use default value (soft limit - reserve). */
491 if (rlimit
.rlim_cur
< DEFAULT_RELAYD_MIN_FD_POOL_SIZE
) {
492 ERR("The process' file number limit is too low (%" PRIu64
"). The process' file number limit must be set to at least %i.",
493 (uint64_t) rlimit
.rlim_cur
, DEFAULT_RELAYD_MIN_FD_POOL_SIZE
);
497 lttng_opt_fd_pool_size
= rlimit
.rlim_cur
-
498 DEFAULT_RELAYD_FD_POOL_SIZE_RESERVE
;
502 if (lttng_opt_fd_pool_size
< DEFAULT_RELAYD_MIN_FD_POOL_SIZE
) {
503 ERR("File descriptor pool size must be set to at least %d",
504 DEFAULT_RELAYD_MIN_FD_POOL_SIZE
);
509 if (lttng_opt_fd_pool_size
> rlimit
.rlim_cur
) {
510 ERR("File descriptor pool size argument (%u) exceeds the process' soft limit (%" PRIu64
").",
511 lttng_opt_fd_pool_size
, (uint64_t) rlimit
.rlim_cur
);
516 DBG("File descriptor pool size argument (%u) adjusted to %u to accommodates transient fd uses",
517 lttng_opt_fd_pool_size
,
518 lttng_opt_fd_pool_size
- DEFAULT_RELAYD_FD_POOL_SIZE_RESERVE
);
519 lttng_opt_fd_pool_size
-= DEFAULT_RELAYD_FD_POOL_SIZE_RESERVE
;
524 static int set_options(int argc
, char **argv
)
526 int c
, ret
= 0, option_index
= 0, retval
= 0;
527 int orig_optopt
= optopt
, orig_optind
= optind
;
528 char *default_address
, *optstring
;
529 char *config_path
= NULL
;
531 optstring
= utils_generate_optstring(long_options
,
532 sizeof(long_options
) / sizeof(struct option
));
538 /* Check for the --config option */
540 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
541 &option_index
)) != -1) {
545 } else if (c
!= 'f') {
549 if (lttng_is_setuid_setgid()) {
550 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
554 config_path
= utils_expand_path(optarg
);
556 ERR("Failed to resolve path: %s", optarg
);
561 ret
= config_get_section_entries(config_path
, config_section_name
,
562 config_entry_handler
, NULL
);
565 ERR("Invalid configuration option at line %i", ret
);
571 /* Reset getopt's global state */
572 optopt
= orig_optopt
;
573 optind
= orig_optind
;
575 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
580 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
587 /* assign default values */
588 if (control_uri
== NULL
) {
589 ret
= asprintf(&default_address
,
590 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
591 DEFAULT_NETWORK_CONTROL_PORT
);
593 PERROR("asprintf default data address");
598 ret
= uri_parse(default_address
, &control_uri
);
599 free(default_address
);
601 ERR("Invalid control URI specified");
606 if (data_uri
== NULL
) {
607 ret
= asprintf(&default_address
,
608 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
609 DEFAULT_NETWORK_DATA_PORT
);
611 PERROR("asprintf default data address");
616 ret
= uri_parse(default_address
, &data_uri
);
617 free(default_address
);
619 ERR("Invalid data URI specified");
624 if (live_uri
== NULL
) {
625 ret
= asprintf(&default_address
,
626 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
627 DEFAULT_NETWORK_VIEWER_PORT
);
629 PERROR("asprintf default viewer control address");
634 ret
= uri_parse(default_address
, &live_uri
);
635 free(default_address
);
637 ERR("Invalid viewer control URI specified");
642 ret
= set_fd_pool_size();
648 if (opt_group_output_by
== RELAYD_GROUP_OUTPUT_BY_UNKNOWN
) {
649 opt_group_output_by
= RELAYD_GROUP_OUTPUT_BY_HOST
;
651 if (opt_allow_clear
) {
652 /* Check if env variable exists. */
653 const char *value
= lttng_secure_getenv(DEFAULT_LTTNG_RELAYD_DISALLOW_CLEAR_ENV
);
655 ret
= config_parse_value(value
);
657 ERR("Invalid value for %s specified", DEFAULT_LTTNG_RELAYD_DISALLOW_CLEAR_ENV
);
661 opt_allow_clear
= !ret
;
671 static void print_global_objects(void)
673 print_viewer_streams();
674 print_relay_streams();
678 static int noop_close(void *data
, int *fds
)
683 static void untrack_stdio(void)
685 int fds
[] = { fileno(stdout
), fileno(stderr
) };
688 * noop_close is used since we don't really want to close
689 * the stdio output fds; we merely want to stop tracking them.
691 (void) fd_tracker_close_unsuspendable_fd(the_fd_tracker
,
692 fds
, 2, noop_close
, NULL
);
698 static void relayd_cleanup(void)
700 print_global_objects();
704 if (viewer_streams_ht
)
705 lttng_ht_destroy(viewer_streams_ht
);
706 if (relay_streams_ht
)
707 lttng_ht_destroy(relay_streams_ht
);
709 lttng_ht_destroy(sessions_ht
);
711 free(opt_output_path
);
712 free(opt_working_directory
);
715 health_app_destroy(health_relayd
);
717 /* Close thread quit pipes */
718 if (health_quit_pipe
[0] != -1) {
719 (void) fd_tracker_util_pipe_close(
720 the_fd_tracker
, health_quit_pipe
);
722 if (thread_quit_pipe
[0] != -1) {
723 (void) fd_tracker_util_pipe_close(
724 the_fd_tracker
, thread_quit_pipe
);
726 if (sessiond_trace_chunk_registry
) {
727 sessiond_trace_chunk_registry_destroy(
728 sessiond_trace_chunk_registry
);
730 if (the_fd_tracker
) {
733 * fd_tracker_destroy() will log the contents of the fd-tracker
734 * if a leak is detected.
736 fd_tracker_destroy(the_fd_tracker
);
739 uri_free(control_uri
);
741 /* Live URI is freed in the live thread. */
743 if (tracing_group_name_override
) {
744 free((void *) tracing_group_name
);
749 * Write to writable pipe used to notify a thread.
751 static int notify_thread_pipe(int wpipe
)
755 ret
= lttng_write(wpipe
, "!", 1);
757 PERROR("write poll pipe");
765 static int notify_health_quit_pipe(int *pipe
)
769 ret
= lttng_write(pipe
[1], "4", 1);
771 PERROR("write relay health quit");
780 * Stop all relayd and relayd-live threads.
782 int lttng_relay_stop_threads(void)
786 /* Stopping all threads */
787 DBG("Terminating all threads");
788 if (notify_thread_pipe(thread_quit_pipe
[1])) {
789 ERR("write error on thread quit pipe");
793 if (notify_health_quit_pipe(health_quit_pipe
)) {
794 ERR("write error on health quit pipe");
797 /* Dispatch thread */
798 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
799 futex_nto1_wake(&relay_conn_queue
.futex
);
801 if (relayd_live_stop()) {
802 ERR("Error stopping live threads");
809 * Signal handler for the daemon
811 * Simply stop all worker threads, leaving main() return gracefully after
812 * joining all threads and calling cleanup().
814 static void sighandler(int sig
)
818 DBG("SIGINT caught");
819 if (lttng_relay_stop_threads()) {
820 ERR("Error stopping threads");
824 DBG("SIGTERM caught");
825 if (lttng_relay_stop_threads()) {
826 ERR("Error stopping threads");
830 CMM_STORE_SHARED(recv_child_signal
, 1);
838 * Setup signal handler for :
839 * SIGINT, SIGTERM, SIGPIPE
841 static int set_signal_handler(void)
847 if ((ret
= sigemptyset(&sigset
)) < 0) {
848 PERROR("sigemptyset");
855 sa
.sa_handler
= sighandler
;
856 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
861 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
866 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
871 sa
.sa_handler
= SIG_IGN
;
872 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
877 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
882 void lttng_relay_notify_ready(void)
884 /* Notify the parent of the fork() process that we are ready. */
885 if (opt_daemon
|| opt_background
) {
886 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
887 kill(child_ppid
, SIGUSR1
);
893 * Init thread quit pipe.
895 * Return -1 on error or 0 if all pipes are created.
897 static int init_thread_quit_pipe(void)
899 return fd_tracker_util_pipe_open_cloexec(
900 the_fd_tracker
, "Quit pipe", thread_quit_pipe
);
904 * Init health quit pipe.
906 * Return -1 on error or 0 if all pipes are created.
908 static int init_health_quit_pipe(void)
910 return fd_tracker_util_pipe_open_cloexec(the_fd_tracker
,
911 "Health quit pipe", health_quit_pipe
);
915 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
917 static int create_named_thread_poll_set(struct lttng_poll_event
*events
,
918 int size
, const char *name
)
922 if (events
== NULL
|| size
== 0) {
927 ret
= fd_tracker_util_poll_create(the_fd_tracker
,
928 name
, events
, 1, LTTNG_CLOEXEC
);
930 PERROR("Failed to create \"%s\" poll file descriptor", name
);
935 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
947 * Check if the thread quit pipe was triggered.
949 * Return 1 if it was triggered else 0;
951 static int check_thread_quit_pipe(int fd
, uint32_t events
)
953 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
960 static int create_sock(void *data
, int *out_fd
)
963 struct lttcomm_sock
*sock
= (lttcomm_sock
*) data
;
965 ret
= lttcomm_create_sock(sock
);
975 static int close_sock(void *data
, int *in_fd
)
977 struct lttcomm_sock
*sock
= (lttcomm_sock
*) data
;
979 return sock
->ops
->close(sock
);
982 static int accept_sock(void *data
, int *out_fd
)
985 /* Socks is an array of in_sock, out_sock. */
986 struct lttcomm_sock
**socks
= (lttcomm_sock
**) data
;
987 struct lttcomm_sock
*in_sock
= socks
[0];
989 socks
[1] = in_sock
->ops
->accept(in_sock
);
994 *out_fd
= socks
[1]->fd
;
1000 * Create and init socket from uri.
1002 static struct lttcomm_sock
*relay_socket_create(struct lttng_uri
*uri
,
1006 struct lttcomm_sock
*sock
= NULL
;
1007 char uri_str
[PATH_MAX
];
1008 char *formated_name
= NULL
;
1010 sock
= lttcomm_alloc_sock_from_uri(uri
);
1012 ERR("Allocating socket");
1017 * Don't fail to create the socket if the name can't be built as it is
1018 * only used for debugging purposes.
1020 ret
= uri_to_str_url(uri
, uri_str
, sizeof(uri_str
));
1021 uri_str
[sizeof(uri_str
) - 1] = '\0';
1023 ret
= asprintf(&formated_name
, "%s socket @ %s", name
,
1026 formated_name
= NULL
;
1030 ret
= fd_tracker_open_unsuspendable_fd(the_fd_tracker
, &sock_fd
,
1031 (const char **) (formated_name
? &formated_name
: NULL
),
1032 1, create_sock
, sock
);
1034 PERROR("Failed to open \"%s\" relay socket",
1035 formated_name
?: "Unknown");
1038 DBG("Listening on %s socket %d", name
, sock
->fd
);
1040 ret
= sock
->ops
->bind(sock
);
1042 PERROR("Failed to bind socket");
1046 ret
= sock
->ops
->listen(sock
, -1);
1052 free(formated_name
);
1057 lttcomm_destroy_sock(sock
);
1059 free(formated_name
);
1064 struct lttcomm_sock
*accept_relayd_sock(struct lttcomm_sock
*listening_sock
,
1068 struct lttcomm_sock
*socks
[2] = { listening_sock
, NULL
};
1069 struct lttcomm_sock
*new_sock
= NULL
;
1071 ret
= fd_tracker_open_unsuspendable_fd(
1072 the_fd_tracker
, &out_fd
,
1073 (const char **) &name
,
1074 1, accept_sock
, &socks
);
1078 new_sock
= socks
[1];
1079 DBG("%s accepted, socket %d", name
, new_sock
->fd
);
1085 * This thread manages the listening for new connections on the network
1087 static void *relay_thread_listener(void *data
)
1089 int i
, ret
, pollfd
, err
= -1;
1090 uint32_t revents
, nb_fd
;
1091 struct lttng_poll_event events
;
1092 struct lttcomm_sock
*control_sock
, *data_sock
;
1094 DBG("[thread] Relay listener started");
1096 rcu_register_thread();
1097 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
1099 health_code_update();
1101 control_sock
= relay_socket_create(control_uri
, "Control listener");
1102 if (!control_sock
) {
1103 goto error_sock_control
;
1106 data_sock
= relay_socket_create(data_uri
, "Data listener");
1108 goto error_sock_relay
;
1112 * Pass 3 as size here for the thread quit pipe, control and
1115 ret
= create_named_thread_poll_set(&events
, 3, "Listener thread epoll");
1117 goto error_create_poll
;
1120 /* Add the control socket */
1121 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
1123 goto error_poll_add
;
1126 /* Add the data socket */
1127 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
1129 goto error_poll_add
;
1132 lttng_relay_notify_ready();
1134 if (testpoint(relayd_thread_listener
)) {
1135 goto error_testpoint
;
1139 health_code_update();
1141 DBG("Listener accepting connections");
1144 health_poll_entry();
1145 ret
= lttng_poll_wait(&events
, -1);
1149 * Restart interrupted system call.
1151 if (errno
== EINTR
) {
1159 DBG("Relay new connection received");
1160 for (i
= 0; i
< nb_fd
; i
++) {
1161 health_code_update();
1163 /* Fetch once the poll data */
1164 revents
= LTTNG_POLL_GETEV(&events
, i
);
1165 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1167 /* Thread quit pipe has been closed. Killing thread. */
1168 ret
= check_thread_quit_pipe(pollfd
, revents
);
1174 if (revents
& LPOLLIN
) {
1176 * A new connection is requested, therefore a
1177 * sessiond/consumerd connection is allocated in
1178 * this thread, enqueued to a global queue and
1179 * dequeued (and freed) in the worker thread.
1182 struct relay_connection
*new_conn
;
1183 struct lttcomm_sock
*newsock
= NULL
;
1184 enum connection_type type
;
1186 if (pollfd
== data_sock
->fd
) {
1188 newsock
= accept_relayd_sock(data_sock
,
1189 "Data socket to relayd");
1191 LTTNG_ASSERT(pollfd
== control_sock
->fd
);
1192 type
= RELAY_CONTROL
;
1193 newsock
= accept_relayd_sock(control_sock
,
1194 "Control socket to relayd");
1197 PERROR("accepting sock");
1201 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
1204 PERROR("setsockopt inet");
1205 lttcomm_destroy_sock(newsock
);
1209 ret
= socket_apply_keep_alive_config(newsock
->fd
);
1211 ERR("Failed to apply TCP keep-alive configuration on socket (%i)",
1213 lttcomm_destroy_sock(newsock
);
1217 new_conn
= connection_create(newsock
, type
);
1219 lttcomm_destroy_sock(newsock
);
1223 /* Enqueue request for the dispatcher thread. */
1224 cds_wfcq_head_ptr_t head
;
1225 head
.h
= &relay_conn_queue
.head
;
1226 cds_wfcq_enqueue(head
, &relay_conn_queue
.tail
,
1230 * Wake the dispatch queue futex.
1231 * Implicit memory barrier with the
1232 * exchange in cds_wfcq_enqueue.
1234 futex_nto1_wake(&relay_conn_queue
.futex
);
1235 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1236 ERR("socket poll error");
1239 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1249 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
1251 if (data_sock
->fd
>= 0) {
1252 int data_sock_fd
= data_sock
->fd
;
1254 ret
= fd_tracker_close_unsuspendable_fd(the_fd_tracker
,
1255 &data_sock_fd
, 1, close_sock
,
1258 PERROR("Failed to close the data listener socket file descriptor");
1262 lttcomm_destroy_sock(data_sock
);
1264 if (control_sock
->fd
>= 0) {
1265 int control_sock_fd
= control_sock
->fd
;
1267 ret
= fd_tracker_close_unsuspendable_fd(the_fd_tracker
,
1268 &control_sock_fd
, 1, close_sock
,
1271 PERROR("Failed to close the control listener socket file descriptor");
1273 control_sock
->fd
= -1;
1275 lttcomm_destroy_sock(control_sock
);
1279 ERR("Health error occurred in %s", __func__
);
1281 health_unregister(health_relayd
);
1282 rcu_unregister_thread();
1283 DBG("Relay listener thread cleanup complete");
1284 lttng_relay_stop_threads();
1289 * This thread manages the dispatching of the requests to worker threads
1291 static void *relay_thread_dispatcher(void *data
)
1295 struct cds_wfcq_node
*node
;
1296 struct relay_connection
*new_conn
= NULL
;
1298 DBG("[thread] Relay dispatcher started");
1300 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
1302 if (testpoint(relayd_thread_dispatcher
)) {
1303 goto error_testpoint
;
1306 health_code_update();
1309 health_code_update();
1311 /* Atomically prepare the queue futex */
1312 futex_nto1_prepare(&relay_conn_queue
.futex
);
1314 if (CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1319 health_code_update();
1321 /* Dequeue commands */
1322 node
= cds_wfcq_dequeue_blocking(&relay_conn_queue
.head
,
1323 &relay_conn_queue
.tail
);
1325 DBG("Woken up but nothing in the relay command queue");
1326 /* Continue thread execution */
1329 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
1331 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
1334 * Inform worker thread of the new request. This
1335 * call is blocking so we can be assured that
1336 * the data will be read at some point in time
1337 * or wait to the end of the world :)
1339 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
1341 PERROR("write connection pipe");
1342 connection_put(new_conn
);
1345 } while (node
!= NULL
);
1347 /* Futex wait on queue. Blocking call on futex() */
1348 health_poll_entry();
1349 futex_nto1_wait(&relay_conn_queue
.futex
);
1353 /* Normal exit, no error */
1360 ERR("Health error occurred in %s", __func__
);
1362 health_unregister(health_relayd
);
1363 DBG("Dispatch thread dying");
1364 lttng_relay_stop_threads();
1368 static bool session_streams_have_index(const struct relay_session
*session
)
1370 return session
->minor
>= 4 && !session
->snapshot
;
1374 * Handle the RELAYD_CREATE_SESSION command.
1376 * On success, send back the session id or else return a negative value.
1378 static int relay_create_session(const struct lttcomm_relayd_hdr
*recv_hdr
,
1379 struct relay_connection
*conn
,
1380 const struct lttng_buffer_view
*payload
)
1384 struct relay_session
*session
= NULL
;
1385 struct lttcomm_relayd_create_session_reply_2_11 reply
= {};
1386 char session_name
[LTTNG_NAME_MAX
] = {};
1387 char hostname
[LTTNG_HOST_NAME_MAX
] = {};
1388 uint32_t live_timer
= 0;
1389 bool snapshot
= false;
1390 bool session_name_contains_creation_timestamp
= false;
1391 /* Left nil for peers < 2.11. */
1392 char base_path
[LTTNG_PATH_MAX
] = {};
1393 lttng_uuid sessiond_uuid
= {};
1394 LTTNG_OPTIONAL(uint64_t) id_sessiond
= {};
1395 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1396 LTTNG_OPTIONAL(time_t) creation_time
= {};
1397 struct lttng_dynamic_buffer reply_payload
;
1399 lttng_dynamic_buffer_init(&reply_payload
);
1401 if (conn
->minor
< 4) {
1402 /* From 2.1 to 2.3 */
1404 } else if (conn
->minor
>= 4 && conn
->minor
< 11) {
1405 /* From 2.4 to 2.10 */
1406 ret
= cmd_create_session_2_4(payload
, session_name
,
1407 hostname
, &live_timer
, &snapshot
);
1409 bool has_current_chunk
;
1410 uint64_t current_chunk_id_value
;
1411 time_t creation_time_value
;
1412 uint64_t id_sessiond_value
;
1414 /* From 2.11 to ... */
1415 ret
= cmd_create_session_2_11(payload
, session_name
, hostname
,
1416 base_path
, &live_timer
, &snapshot
, &id_sessiond_value
,
1417 sessiond_uuid
, &has_current_chunk
,
1418 ¤t_chunk_id_value
, &creation_time_value
,
1419 &session_name_contains_creation_timestamp
);
1420 if (lttng_uuid_is_nil(sessiond_uuid
)) {
1421 /* The nil UUID is reserved for pre-2.11 clients. */
1422 ERR("Illegal nil UUID announced by peer in create session command");
1426 LTTNG_OPTIONAL_SET(&id_sessiond
, id_sessiond_value
);
1427 LTTNG_OPTIONAL_SET(&creation_time
, creation_time_value
);
1428 if (has_current_chunk
) {
1429 LTTNG_OPTIONAL_SET(¤t_chunk_id
,
1430 current_chunk_id_value
);
1438 session
= session_create(session_name
, hostname
, base_path
, live_timer
,
1439 snapshot
, sessiond_uuid
,
1440 id_sessiond
.is_set
? &id_sessiond
.value
: NULL
,
1441 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1442 creation_time
.is_set
? &creation_time
.value
: NULL
,
1443 conn
->major
, conn
->minor
,
1444 session_name_contains_creation_timestamp
);
1449 LTTNG_ASSERT(!conn
->session
);
1450 conn
->session
= session
;
1451 DBG("Created session %" PRIu64
, session
->id
);
1453 reply
.generic
.session_id
= htobe64(session
->id
);
1457 reply
.generic
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1459 reply
.generic
.ret_code
= htobe32(LTTNG_OK
);
1462 if (conn
->minor
< 11) {
1463 /* From 2.1 to 2.10 */
1464 ret
= lttng_dynamic_buffer_append(&reply_payload
,
1465 &reply
.generic
, sizeof(reply
.generic
));
1467 ERR("Failed to append \"create session\" command reply header to payload buffer");
1472 const uint32_t output_path_length
=
1473 session
? strlen(session
->output_path
) + 1 : 0;
1475 reply
.output_path_length
= htobe32(output_path_length
);
1476 ret
= lttng_dynamic_buffer_append(
1477 &reply_payload
, &reply
, sizeof(reply
));
1479 ERR("Failed to append \"create session\" command reply header to payload buffer");
1483 if (output_path_length
) {
1484 ret
= lttng_dynamic_buffer_append(&reply_payload
,
1485 session
->output_path
,
1486 output_path_length
);
1488 ERR("Failed to append \"create session\" command reply path to payload buffer");
1494 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, reply_payload
.data
,
1495 reply_payload
.size
, 0);
1496 if (send_ret
< (ssize_t
) reply_payload
.size
) {
1497 ERR("Failed to send \"create session\" command reply of %zu bytes (ret = %zd)",
1498 reply_payload
.size
, send_ret
);
1502 if (ret
< 0 && session
) {
1503 session_put(session
);
1505 lttng_dynamic_buffer_reset(&reply_payload
);
1510 * When we have received all the streams and the metadata for a channel,
1511 * we make them visible to the viewer threads.
1513 static void publish_connection_local_streams(struct relay_connection
*conn
)
1515 struct relay_stream
*stream
;
1516 struct relay_session
*session
= conn
->session
;
1519 * We publish all streams belonging to a session atomically wrt
1522 pthread_mutex_lock(&session
->lock
);
1524 cds_list_for_each_entry_rcu(stream
, &session
->recv_list
,
1526 stream_publish(stream
);
1531 * Inform the viewer that there are new streams in the session.
1533 if (session
->viewer_attached
) {
1534 uatomic_set(&session
->new_streams
, 1);
1536 pthread_mutex_unlock(&session
->lock
);
1539 static int conform_channel_path(char *channel_path
)
1543 if (strstr("../", channel_path
)) {
1544 ERR("Refusing channel path as it walks up the path hierarchy: \"%s\"",
1550 if (*channel_path
== '/') {
1551 const size_t len
= strlen(channel_path
);
1554 * Channel paths from peers prior to 2.11 are expressed as an
1555 * absolute path that is, in reality, relative to the relay
1556 * daemon's output directory. Remove the leading slash so it
1557 * is correctly interpreted as a relative path later on.
1559 * len (and not len - 1) is used to copy the trailing NULL.
1561 bcopy(channel_path
+ 1, channel_path
, len
);
1568 * relay_add_stream: allocate a new stream for a session
1570 static int relay_add_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1571 struct relay_connection
*conn
,
1572 const struct lttng_buffer_view
*payload
)
1576 struct relay_session
*session
= conn
->session
;
1577 struct relay_stream
*stream
= NULL
;
1578 struct lttcomm_relayd_status_stream reply
;
1579 struct ctf_trace
*trace
= NULL
;
1580 uint64_t stream_handle
= -1ULL;
1581 char *path_name
= NULL
, *channel_name
= NULL
;
1582 uint64_t tracefile_size
= 0, tracefile_count
= 0;
1583 LTTNG_OPTIONAL(uint64_t) stream_chunk_id
= {};
1585 if (!session
|| !conn
->version_check_done
) {
1586 ERR("Trying to add a stream before version check");
1588 goto end_no_session
;
1591 if (session
->minor
== 1) {
1593 ret
= cmd_recv_stream_2_1(payload
, &path_name
,
1595 } else if (session
->minor
> 1 && session
->minor
< 11) {
1596 /* From 2.2 to 2.10 */
1597 ret
= cmd_recv_stream_2_2(payload
, &path_name
,
1598 &channel_name
, &tracefile_size
, &tracefile_count
);
1600 /* From 2.11 to ... */
1601 ret
= cmd_recv_stream_2_11(payload
, &path_name
,
1602 &channel_name
, &tracefile_size
, &tracefile_count
,
1603 &stream_chunk_id
.value
);
1604 stream_chunk_id
.is_set
= true;
1611 if (conform_channel_path(path_name
)) {
1616 * Backward compatibility for --group-output-by-session.
1617 * Prior to lttng 2.11, the complete path is passed by the stream.
1618 * Starting at 2.11, lttng-relayd uses chunk. When dealing with producer
1619 * >=2.11 the chunk is responsible for the output path. When dealing
1620 * with producer < 2.11 the chunk output_path is the root output path
1621 * and the stream carries the complete path (path_name).
1622 * To support --group-output-by-session with older producer (<2.11), we
1623 * need to craft the path based on the stream path.
1625 if (opt_group_output_by
== RELAYD_GROUP_OUTPUT_BY_SESSION
) {
1626 if (conn
->minor
< 4) {
1628 * From 2.1 to 2.3, the session_name is not passed on
1629 * the RELAYD_CREATE_SESSION command. The session name
1630 * is necessary to detect the presence of a base_path
1631 * inside the stream path. Without it we cannot perform
1632 * a valid group-output-by-session transformation.
1634 WARN("Unable to perform a --group-by-session transformation for session %" PRIu64
1635 " for stream with path \"%s\" as it is produced by a peer using a protocol older than v2.4",
1636 session
->id
, path_name
);
1637 } else if (conn
->minor
>= 4 && conn
->minor
< 11) {
1638 char *group_by_session_path_name
;
1640 LTTNG_ASSERT(session
->session_name
[0] != '\0');
1642 group_by_session_path_name
=
1643 backward_compat_group_by_session(
1645 session
->session_name
,
1646 session
->creation_time
.value
);
1647 if (!group_by_session_path_name
) {
1648 ERR("Failed to apply group by session to stream of session %" PRIu64
,
1653 DBG("Transformed session path from \"%s\" to \"%s\" to honor per-session name grouping",
1654 path_name
, group_by_session_path_name
);
1657 path_name
= group_by_session_path_name
;
1661 trace
= ctf_trace_get_by_path_or_create(session
, path_name
);
1666 /* This stream here has one reference on the trace. */
1667 pthread_mutex_lock(&last_relay_stream_id_lock
);
1668 stream_handle
= ++last_relay_stream_id
;
1669 pthread_mutex_unlock(&last_relay_stream_id_lock
);
1671 /* We pass ownership of path_name and channel_name. */
1672 stream
= stream_create(trace
, stream_handle
, path_name
,
1673 channel_name
, tracefile_size
, tracefile_count
);
1675 channel_name
= NULL
;
1678 * Streams are the owners of their trace. Reference to trace is
1679 * kept within stream_create().
1681 ctf_trace_put(trace
);
1684 memset(&reply
, 0, sizeof(reply
));
1685 reply
.handle
= htobe64(stream_handle
);
1687 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1689 reply
.ret_code
= htobe32(LTTNG_OK
);
1692 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1693 sizeof(struct lttcomm_relayd_status_stream
), 0);
1694 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1695 ERR("Failed to send \"add stream\" command reply (ret = %zd)",
1707 * relay_close_stream: close a specific stream
1709 static int relay_close_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1710 struct relay_connection
*conn
,
1711 const struct lttng_buffer_view
*payload
)
1715 struct relay_session
*session
= conn
->session
;
1716 struct lttcomm_relayd_close_stream stream_info
;
1717 struct lttcomm_relayd_generic_reply reply
;
1718 struct relay_stream
*stream
;
1720 DBG("Close stream received");
1722 if (!session
|| !conn
->version_check_done
) {
1723 ERR("Trying to close a stream before version check");
1725 goto end_no_session
;
1728 if (payload
->size
< sizeof(stream_info
)) {
1729 ERR("Unexpected payload size in \"relay_close_stream\": expected >= %zu bytes, got %zu bytes",
1730 sizeof(stream_info
), payload
->size
);
1732 goto end_no_session
;
1734 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1735 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1736 stream_info
.last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1738 stream
= stream_get_by_id(stream_info
.stream_id
);
1745 * Set last_net_seq_num before the close flag. Required by data
1748 pthread_mutex_lock(&stream
->lock
);
1749 stream
->last_net_seq_num
= stream_info
.last_net_seq_num
;
1750 pthread_mutex_unlock(&stream
->lock
);
1753 * This is one of the conditions which may trigger a stream close
1754 * with the others being:
1755 * 1) A close command is received for a stream
1756 * 2) The control connection owning the stream is closed
1757 * 3) We have received all of the stream's data _after_ a close
1760 try_stream_close(stream
);
1765 memset(&reply
, 0, sizeof(reply
));
1767 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1769 reply
.ret_code
= htobe32(LTTNG_OK
);
1771 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1772 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1773 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1774 ERR("Failed to send \"close stream\" command reply (ret = %zd)",
1784 * relay_reset_metadata: reset a metadata stream
1787 int relay_reset_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1788 struct relay_connection
*conn
,
1789 const struct lttng_buffer_view
*payload
)
1793 struct relay_session
*session
= conn
->session
;
1794 struct lttcomm_relayd_reset_metadata stream_info
;
1795 struct lttcomm_relayd_generic_reply reply
;
1796 struct relay_stream
*stream
;
1798 DBG("Reset metadata received");
1800 if (!session
|| !conn
->version_check_done
) {
1801 ERR("Trying to reset a metadata stream before version check");
1803 goto end_no_session
;
1806 if (payload
->size
< sizeof(stream_info
)) {
1807 ERR("Unexpected payload size in \"relay_reset_metadata\": expected >= %zu bytes, got %zu bytes",
1808 sizeof(stream_info
), payload
->size
);
1810 goto end_no_session
;
1812 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1813 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1814 stream_info
.version
= be64toh(stream_info
.version
);
1816 DBG("Update metadata to version %" PRIu64
, stream_info
.version
);
1818 /* Unsupported for live sessions for now. */
1819 if (session
->live_timer
!= 0) {
1824 stream
= stream_get_by_id(stream_info
.stream_id
);
1829 pthread_mutex_lock(&stream
->lock
);
1830 if (!stream
->is_metadata
) {
1835 ret
= stream_reset_file(stream
);
1837 ERR("Failed to reset metadata stream %" PRIu64
1838 ": stream_path = %s, channel = %s",
1839 stream
->stream_handle
, stream
->path_name
,
1840 stream
->channel_name
);
1844 pthread_mutex_unlock(&stream
->lock
);
1848 memset(&reply
, 0, sizeof(reply
));
1850 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1852 reply
.ret_code
= htobe32(LTTNG_OK
);
1854 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1855 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1856 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1857 ERR("Failed to send \"reset metadata\" command reply (ret = %zd)",
1867 * relay_unknown_command: send -1 if received unknown command
1869 static void relay_unknown_command(struct relay_connection
*conn
)
1871 struct lttcomm_relayd_generic_reply reply
;
1874 memset(&reply
, 0, sizeof(reply
));
1875 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1876 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1877 if (send_ret
< sizeof(reply
)) {
1878 ERR("Failed to send \"unknown command\" command reply (ret = %zd)", send_ret
);
1883 * relay_start: send an acknowledgment to the client to tell if we are
1884 * ready to receive data. We are ready if a session is established.
1886 static int relay_start(const struct lttcomm_relayd_hdr
*recv_hdr
,
1887 struct relay_connection
*conn
,
1888 const struct lttng_buffer_view
*payload
)
1892 struct lttcomm_relayd_generic_reply reply
;
1893 struct relay_session
*session
= conn
->session
;
1896 DBG("Trying to start the streaming without a session established");
1897 ret
= htobe32(LTTNG_ERR_UNK
);
1900 memset(&reply
, 0, sizeof(reply
));
1901 reply
.ret_code
= htobe32(LTTNG_OK
);
1902 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1904 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1905 ERR("Failed to send \"relay_start\" command reply (ret = %zd)",
1914 * relay_recv_metadata: receive the metadata for the session.
1916 static int relay_recv_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1917 struct relay_connection
*conn
,
1918 const struct lttng_buffer_view
*payload
)
1921 struct relay_session
*session
= conn
->session
;
1922 struct lttcomm_relayd_metadata_payload metadata_payload_header
;
1923 struct relay_stream
*metadata_stream
;
1924 uint64_t metadata_payload_size
;
1925 struct lttng_buffer_view packet_view
;
1928 ERR("Metadata sent before version check");
1933 if (recv_hdr
->data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1934 ERR("Incorrect data size");
1938 metadata_payload_size
= recv_hdr
->data_size
-
1939 sizeof(struct lttcomm_relayd_metadata_payload
);
1941 memcpy(&metadata_payload_header
, payload
->data
,
1942 sizeof(metadata_payload_header
));
1943 metadata_payload_header
.stream_id
= be64toh(
1944 metadata_payload_header
.stream_id
);
1945 metadata_payload_header
.padding_size
= be32toh(
1946 metadata_payload_header
.padding_size
);
1948 metadata_stream
= stream_get_by_id(metadata_payload_header
.stream_id
);
1949 if (!metadata_stream
) {
1954 packet_view
= lttng_buffer_view_from_view(payload
,
1955 sizeof(metadata_payload_header
), metadata_payload_size
);
1956 if (!lttng_buffer_view_is_valid(&packet_view
)) {
1957 ERR("Invalid metadata packet length announced by header");
1962 pthread_mutex_lock(&metadata_stream
->lock
);
1963 ret
= stream_write(metadata_stream
, &packet_view
,
1964 metadata_payload_header
.padding_size
);
1965 pthread_mutex_unlock(&metadata_stream
->lock
);
1971 stream_put(metadata_stream
);
1977 * relay_send_version: send relayd version number
1979 static int relay_send_version(const struct lttcomm_relayd_hdr
*recv_hdr
,
1980 struct relay_connection
*conn
,
1981 const struct lttng_buffer_view
*payload
)
1985 struct lttcomm_relayd_version reply
, msg
;
1986 bool compatible
= true;
1988 conn
->version_check_done
= true;
1990 /* Get version from the other side. */
1991 if (payload
->size
< sizeof(msg
)) {
1992 ERR("Unexpected payload size in \"relay_send_version\": expected >= %zu bytes, got %zu bytes",
1993 sizeof(msg
), payload
->size
);
1998 memcpy(&msg
, payload
->data
, sizeof(msg
));
1999 msg
.major
= be32toh(msg
.major
);
2000 msg
.minor
= be32toh(msg
.minor
);
2002 memset(&reply
, 0, sizeof(reply
));
2003 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
2004 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
2006 /* Major versions must be the same */
2007 if (reply
.major
!= msg
.major
) {
2008 DBG("Incompatible major versions (%u vs %u), deleting session",
2009 reply
.major
, msg
.major
);
2013 conn
->major
= reply
.major
;
2014 /* We adapt to the lowest compatible version */
2015 if (reply
.minor
<= msg
.minor
) {
2016 conn
->minor
= reply
.minor
;
2018 conn
->minor
= msg
.minor
;
2021 reply
.major
= htobe32(reply
.major
);
2022 reply
.minor
= htobe32(reply
.minor
);
2023 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2025 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2026 ERR("Failed to send \"send version\" command reply (ret = %zd)",
2039 DBG("Version check done using protocol %u.%u", conn
->major
,
2047 * Check for data pending for a given stream id from the session daemon.
2049 static int relay_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2050 struct relay_connection
*conn
,
2051 const struct lttng_buffer_view
*payload
)
2053 struct relay_session
*session
= conn
->session
;
2054 struct lttcomm_relayd_data_pending msg
;
2055 struct lttcomm_relayd_generic_reply reply
;
2056 struct relay_stream
*stream
;
2059 uint64_t stream_seq
;
2061 DBG("Data pending command received");
2063 if (!session
|| !conn
->version_check_done
) {
2064 ERR("Trying to check for data before version check");
2066 goto end_no_session
;
2069 if (payload
->size
< sizeof(msg
)) {
2070 ERR("Unexpected payload size in \"relay_data_pending\": expected >= %zu bytes, got %zu bytes",
2071 sizeof(msg
), payload
->size
);
2073 goto end_no_session
;
2075 memcpy(&msg
, payload
->data
, sizeof(msg
));
2076 msg
.stream_id
= be64toh(msg
.stream_id
);
2077 msg
.last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
2079 stream
= stream_get_by_id(msg
.stream_id
);
2080 if (stream
== NULL
) {
2085 pthread_mutex_lock(&stream
->lock
);
2087 if (session_streams_have_index(session
)) {
2089 * Ensure that both the index and stream data have been
2090 * flushed up to the requested point.
2092 stream_seq
= std::min(stream
->prev_data_seq
, stream
->prev_index_seq
);
2094 stream_seq
= stream
->prev_data_seq
;
2096 DBG("Data pending for stream id %" PRIu64
": prev_data_seq %" PRIu64
2097 ", prev_index_seq %" PRIu64
2098 ", and last_seq %" PRIu64
, msg
.stream_id
,
2099 stream
->prev_data_seq
, stream
->prev_index_seq
,
2100 msg
.last_net_seq_num
);
2102 /* Avoid wrapping issue */
2103 if (((int64_t) (stream_seq
- msg
.last_net_seq_num
)) >= 0) {
2104 /* Data has in fact been written and is NOT pending */
2107 /* Data still being streamed thus pending */
2111 stream
->data_pending_check_done
= true;
2112 pthread_mutex_unlock(&stream
->lock
);
2117 memset(&reply
, 0, sizeof(reply
));
2118 reply
.ret_code
= htobe32(ret
);
2119 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2120 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2121 ERR("Failed to send \"data pending\" command reply (ret = %zd)",
2131 * Wait for the control socket to reach a quiescent state.
2133 * Note that for now, when receiving this command from the session
2134 * daemon, this means that every subsequent commands or data received on
2135 * the control socket has been handled. So, this is why we simply return
2138 static int relay_quiescent_control(const struct lttcomm_relayd_hdr
*recv_hdr
,
2139 struct relay_connection
*conn
,
2140 const struct lttng_buffer_view
*payload
)
2144 struct relay_stream
*stream
;
2145 struct lttcomm_relayd_quiescent_control msg
;
2146 struct lttcomm_relayd_generic_reply reply
;
2148 DBG("Checking quiescent state on control socket");
2150 if (!conn
->session
|| !conn
->version_check_done
) {
2151 ERR("Trying to check for data before version check");
2153 goto end_no_session
;
2156 if (payload
->size
< sizeof(msg
)) {
2157 ERR("Unexpected payload size in \"relay_quiescent_control\": expected >= %zu bytes, got %zu bytes",
2158 sizeof(msg
), payload
->size
);
2160 goto end_no_session
;
2162 memcpy(&msg
, payload
->data
, sizeof(msg
));
2163 msg
.stream_id
= be64toh(msg
.stream_id
);
2165 stream
= stream_get_by_id(msg
.stream_id
);
2169 pthread_mutex_lock(&stream
->lock
);
2170 stream
->data_pending_check_done
= true;
2171 pthread_mutex_unlock(&stream
->lock
);
2173 DBG("Relay quiescent control pending flag set to %" PRIu64
, msg
.stream_id
);
2176 memset(&reply
, 0, sizeof(reply
));
2177 reply
.ret_code
= htobe32(LTTNG_OK
);
2178 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2179 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2180 ERR("Failed to send \"quiescent control\" command reply (ret = %zd)",
2192 * Initialize a data pending command. This means that a consumer is about
2193 * to ask for data pending for each stream it holds. Simply iterate over
2194 * all streams of a session and set the data_pending_check_done flag.
2196 * This command returns to the client a LTTNG_OK code.
2198 static int relay_begin_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2199 struct relay_connection
*conn
,
2200 const struct lttng_buffer_view
*payload
)
2204 struct lttng_ht_iter iter
;
2205 struct lttcomm_relayd_begin_data_pending msg
;
2206 struct lttcomm_relayd_generic_reply reply
;
2207 struct relay_stream
*stream
;
2209 LTTNG_ASSERT(recv_hdr
);
2212 DBG("Init streams for data pending");
2214 if (!conn
->session
|| !conn
->version_check_done
) {
2215 ERR("Trying to check for data before version check");
2217 goto end_no_session
;
2220 if (payload
->size
< sizeof(msg
)) {
2221 ERR("Unexpected payload size in \"relay_begin_data_pending\": expected >= %zu bytes, got %zu bytes",
2222 sizeof(msg
), payload
->size
);
2224 goto end_no_session
;
2226 memcpy(&msg
, payload
->data
, sizeof(msg
));
2227 msg
.session_id
= be64toh(msg
.session_id
);
2230 * Iterate over all streams to set the begin data pending flag.
2231 * For now, the streams are indexed by stream handle so we have
2232 * to iterate over all streams to find the one associated with
2233 * the right session_id.
2236 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2238 if (!stream_get(stream
)) {
2241 if (stream
->trace
->session
->id
== msg
.session_id
) {
2242 pthread_mutex_lock(&stream
->lock
);
2243 stream
->data_pending_check_done
= false;
2244 pthread_mutex_unlock(&stream
->lock
);
2245 DBG("Set begin data pending flag to stream %" PRIu64
,
2246 stream
->stream_handle
);
2252 memset(&reply
, 0, sizeof(reply
));
2253 /* All good, send back reply. */
2254 reply
.ret_code
= htobe32(LTTNG_OK
);
2256 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2257 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2258 ERR("Failed to send \"begin data pending\" command reply (ret = %zd)",
2270 * End data pending command. This will check, for a given session id, if
2271 * each stream associated with it has its data_pending_check_done flag
2272 * set. If not, this means that the client lost track of the stream but
2273 * the data is still being streamed on our side. In this case, we inform
2274 * the client that data is in flight.
2276 * Return to the client if there is data in flight or not with a ret_code.
2278 static int relay_end_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2279 struct relay_connection
*conn
,
2280 const struct lttng_buffer_view
*payload
)
2284 struct lttng_ht_iter iter
;
2285 struct lttcomm_relayd_end_data_pending msg
;
2286 struct lttcomm_relayd_generic_reply reply
;
2287 struct relay_stream
*stream
;
2288 uint32_t is_data_inflight
= 0;
2290 DBG("End data pending command");
2292 if (!conn
->session
|| !conn
->version_check_done
) {
2293 ERR("Trying to check for data before version check");
2295 goto end_no_session
;
2298 if (payload
->size
< sizeof(msg
)) {
2299 ERR("Unexpected payload size in \"relay_end_data_pending\": expected >= %zu bytes, got %zu bytes",
2300 sizeof(msg
), payload
->size
);
2302 goto end_no_session
;
2304 memcpy(&msg
, payload
->data
, sizeof(msg
));
2305 msg
.session_id
= be64toh(msg
.session_id
);
2308 * Iterate over all streams to see if the begin data pending
2312 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2314 if (!stream_get(stream
)) {
2317 if (stream
->trace
->session
->id
!= msg
.session_id
) {
2321 pthread_mutex_lock(&stream
->lock
);
2322 if (!stream
->data_pending_check_done
) {
2323 uint64_t stream_seq
;
2325 if (session_streams_have_index(conn
->session
)) {
2327 * Ensure that both the index and stream data have been
2328 * flushed up to the requested point.
2330 stream_seq
= std::min(stream
->prev_data_seq
, stream
->prev_index_seq
);
2332 stream_seq
= stream
->prev_data_seq
;
2334 if (!stream
->closed
|| !(((int64_t) (stream_seq
- stream
->last_net_seq_num
)) >= 0)) {
2335 is_data_inflight
= 1;
2336 DBG("Data is still in flight for stream %" PRIu64
,
2337 stream
->stream_handle
);
2338 pthread_mutex_unlock(&stream
->lock
);
2343 pthread_mutex_unlock(&stream
->lock
);
2348 memset(&reply
, 0, sizeof(reply
));
2349 /* All good, send back reply. */
2350 reply
.ret_code
= htobe32(is_data_inflight
);
2352 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2353 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2354 ERR("Failed to send \"end data pending\" command reply (ret = %zd)",
2366 * Receive an index for a specific stream.
2368 * Return 0 on success else a negative value.
2370 static int relay_recv_index(const struct lttcomm_relayd_hdr
*recv_hdr
,
2371 struct relay_connection
*conn
,
2372 const struct lttng_buffer_view
*payload
)
2376 struct relay_session
*session
= conn
->session
;
2377 struct lttcomm_relayd_index index_info
;
2378 struct lttcomm_relayd_generic_reply reply
;
2379 struct relay_stream
*stream
;
2384 DBG("Relay receiving index");
2386 if (!session
|| !conn
->version_check_done
) {
2387 ERR("Trying to close a stream before version check");
2389 goto end_no_session
;
2392 msg_len
= lttcomm_relayd_index_len(
2393 lttng_to_index_major(conn
->major
, conn
->minor
),
2394 lttng_to_index_minor(conn
->major
, conn
->minor
));
2395 if (payload
->size
< msg_len
) {
2396 ERR("Unexpected payload size in \"relay_recv_index\": expected >= %zu bytes, got %zu bytes",
2397 msg_len
, payload
->size
);
2399 goto end_no_session
;
2401 memcpy(&index_info
, payload
->data
, msg_len
);
2402 index_info
.relay_stream_id
= be64toh(index_info
.relay_stream_id
);
2403 index_info
.net_seq_num
= be64toh(index_info
.net_seq_num
);
2404 index_info
.packet_size
= be64toh(index_info
.packet_size
);
2405 index_info
.content_size
= be64toh(index_info
.content_size
);
2406 index_info
.timestamp_begin
= be64toh(index_info
.timestamp_begin
);
2407 index_info
.timestamp_end
= be64toh(index_info
.timestamp_end
);
2408 index_info
.events_discarded
= be64toh(index_info
.events_discarded
);
2409 index_info
.stream_id
= be64toh(index_info
.stream_id
);
2411 if (conn
->minor
>= 8) {
2412 index_info
.stream_instance_id
=
2413 be64toh(index_info
.stream_instance_id
);
2414 index_info
.packet_seq_num
= be64toh(index_info
.packet_seq_num
);
2416 index_info
.stream_instance_id
= -1ULL;
2417 index_info
.packet_seq_num
= -1ULL;
2420 stream
= stream_get_by_id(index_info
.relay_stream_id
);
2422 ERR("stream_get_by_id not found");
2427 pthread_mutex_lock(&stream
->lock
);
2428 ret
= stream_add_index(stream
, &index_info
);
2429 pthread_mutex_unlock(&stream
->lock
);
2431 goto end_stream_put
;
2437 memset(&reply
, 0, sizeof(reply
));
2439 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2441 reply
.ret_code
= htobe32(LTTNG_OK
);
2443 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2444 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2445 ERR("Failed to send \"recv index\" command reply (ret = %zd)", send_ret
);
2454 * Receive the streams_sent message.
2456 * Return 0 on success else a negative value.
2458 static int relay_streams_sent(const struct lttcomm_relayd_hdr
*recv_hdr
,
2459 struct relay_connection
*conn
,
2460 const struct lttng_buffer_view
*payload
)
2464 struct lttcomm_relayd_generic_reply reply
;
2468 DBG("Relay receiving streams_sent");
2470 if (!conn
->session
|| !conn
->version_check_done
) {
2471 ERR("Trying to close a stream before version check");
2473 goto end_no_session
;
2477 * Publish every pending stream in the connection recv list which are
2478 * now ready to be used by the viewer.
2480 publish_connection_local_streams(conn
);
2482 memset(&reply
, 0, sizeof(reply
));
2483 reply
.ret_code
= htobe32(LTTNG_OK
);
2484 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2485 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2486 ERR("Failed to send \"streams sent\" command reply (ret = %zd)",
2498 static ssize_t
relay_unpack_rotate_streams_header(
2499 const struct lttng_buffer_view
*payload
,
2500 struct lttcomm_relayd_rotate_streams
*_rotate_streams
)
2502 struct lttcomm_relayd_rotate_streams rotate_streams
;
2504 * Set to the smallest version (packed) of `lttcomm_relayd_rotate_streams`.
2505 * This is the smallest version of this structure, but it can be larger;
2506 * this variable is updated once the proper size of the structure is known.
2508 * See comment at the declaration of this structure for more information.
2510 ssize_t header_len
= sizeof(struct lttcomm_relayd_rotate_streams_packed
);
2511 size_t expected_payload_size_no_padding
,
2512 expected_payload_size_3_bytes_padding
,
2513 expected_payload_size_7_bytes_padding
;
2515 if (payload
->size
< header_len
) {
2516 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected >= %zu bytes, got %zu bytes",
2517 header_len
, payload
->size
);
2522 * Some versions incorrectly omitted the LTTNG_PACKED annotation on the
2523 * `new_chunk_id` optional field of struct lttcomm_relayd_rotate_streams.
2525 * We start by "unpacking" `stream_count` to figure out the padding length
2526 * emited by our peer.
2528 memcpy(&rotate_streams
.stream_count
, payload
->data
,
2529 sizeof(rotate_streams
.stream_count
));
2530 rotate_streams
= (typeof(rotate_streams
)) {
2531 .stream_count
= be32toh(rotate_streams
.stream_count
),
2535 * Payload size expected given the possible padding lengths in
2536 * `struct lttcomm_relayd_rotate_streams`.
2538 expected_payload_size_no_padding
= (rotate_streams
.stream_count
*
2539 sizeof(*rotate_streams
.rotation_positions
)) +
2540 sizeof(lttcomm_relayd_rotate_streams_packed
);
2541 expected_payload_size_3_bytes_padding
= (rotate_streams
.stream_count
*
2542 sizeof(*rotate_streams
.rotation_positions
)) +
2543 sizeof(lttcomm_relayd_rotate_streams_3_bytes_padding
);
2544 expected_payload_size_7_bytes_padding
= (rotate_streams
.stream_count
*
2545 sizeof(*rotate_streams
.rotation_positions
)) +
2546 sizeof(lttcomm_relayd_rotate_streams_7_bytes_padding
);
2548 if (payload
->size
== expected_payload_size_no_padding
) {
2549 struct lttcomm_relayd_rotate_streams_packed packed_rotate_streams
;
2552 * This handles cases where someone might build with
2553 * -fpack-struct or any other toolchain that wouldn't produce
2554 * padding to align `value`.
2556 DBG("Received `struct lttcomm_relayd_rotate_streams` with no padding");
2558 header_len
= sizeof(packed_rotate_streams
);
2559 memcpy(&packed_rotate_streams
, payload
->data
, header_len
);
2561 /* Unpack the packed structure to the natively-packed version. */
2562 *_rotate_streams
= (typeof(*_rotate_streams
)) {
2563 .stream_count
= be32toh(packed_rotate_streams
.stream_count
),
2564 .new_chunk_id
= (typeof(_rotate_streams
->new_chunk_id
)) {
2565 .is_set
= !!packed_rotate_streams
.new_chunk_id
.is_set
,
2566 .value
= be64toh(packed_rotate_streams
.new_chunk_id
.value
),
2569 } else if (payload
->size
== expected_payload_size_3_bytes_padding
) {
2570 struct lttcomm_relayd_rotate_streams_3_bytes_padding padded_rotate_streams
;
2572 DBG("Received `struct lttcomm_relayd_rotate_streams` with 3 bytes of padding (4-byte aligned peer)");
2574 header_len
= sizeof(padded_rotate_streams
);
2575 memcpy(&padded_rotate_streams
, payload
->data
, header_len
);
2577 /* Unpack the 3-byte padded structure to the natively-packed version. */
2578 *_rotate_streams
= (typeof(*_rotate_streams
)) {
2579 .stream_count
= be32toh(padded_rotate_streams
.stream_count
),
2580 .new_chunk_id
= (typeof(_rotate_streams
->new_chunk_id
)) {
2581 .is_set
= !!padded_rotate_streams
.new_chunk_id
.is_set
,
2582 .value
= be64toh(padded_rotate_streams
.new_chunk_id
.value
),
2585 } else if (payload
->size
== expected_payload_size_7_bytes_padding
) {
2586 struct lttcomm_relayd_rotate_streams_7_bytes_padding padded_rotate_streams
;
2588 DBG("Received `struct lttcomm_relayd_rotate_streams` with 7 bytes of padding (8-byte aligned peer)");
2590 header_len
= sizeof(padded_rotate_streams
);
2591 memcpy(&padded_rotate_streams
, payload
->data
, header_len
);
2593 /* Unpack the 7-byte padded structure to the natively-packed version. */
2594 *_rotate_streams
= (typeof(*_rotate_streams
)) {
2595 .stream_count
= be32toh(padded_rotate_streams
.stream_count
),
2596 .new_chunk_id
= (typeof(_rotate_streams
->new_chunk_id
)) {
2597 .is_set
= !!padded_rotate_streams
.new_chunk_id
.is_set
,
2598 .value
= be64toh(padded_rotate_streams
.new_chunk_id
.value
),
2602 header_len
= sizeof(padded_rotate_streams
);
2604 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected %zu, %zu or %zu bytes, got %zu bytes",
2605 expected_payload_size_no_padding
,
2606 expected_payload_size_3_bytes_padding
,
2607 expected_payload_size_7_bytes_padding
,
2618 * relay_rotate_session_stream: rotate a stream to a new tracefile for the
2619 * session rotation feature (not the tracefile rotation feature).
2621 static int relay_rotate_session_streams(
2622 const struct lttcomm_relayd_hdr
*recv_hdr
,
2623 struct relay_connection
*conn
,
2624 const struct lttng_buffer_view
*payload
)
2629 enum lttng_error_code reply_code
= LTTNG_ERR_UNK
;
2630 struct relay_session
*session
= conn
->session
;
2631 struct lttcomm_relayd_rotate_streams rotate_streams
;
2632 struct lttcomm_relayd_generic_reply reply
= {};
2633 struct relay_stream
*stream
= NULL
;
2634 struct lttng_trace_chunk
*next_trace_chunk
= NULL
;
2635 struct lttng_buffer_view stream_positions
;
2636 char chunk_id_buf
[MAX_INT_DEC_LEN(uint64_t)];
2637 const char *chunk_id_str
= "none";
2640 if (!session
|| !conn
->version_check_done
) {
2641 ERR("Trying to rotate a stream before version check");
2646 if (session
->major
== 2 && session
->minor
< 11) {
2647 ERR("Unsupported feature before 2.11");
2652 header_len
= relay_unpack_rotate_streams_header(payload
, &rotate_streams
);
2653 if (header_len
< 0) {
2658 if (rotate_streams
.new_chunk_id
.is_set
) {
2660 * Retrieve the trace chunk the stream must transition to. As
2661 * per the protocol, this chunk should have been created
2662 * before this command is received.
2664 next_trace_chunk
= sessiond_trace_chunk_registry_get_chunk(
2665 sessiond_trace_chunk_registry
,
2666 session
->sessiond_uuid
,
2667 conn
->session
->id_sessiond
.is_set
?
2668 conn
->session
->id_sessiond
.value
:
2670 rotate_streams
.new_chunk_id
.value
);
2671 if (!next_trace_chunk
) {
2672 char uuid_str
[LTTNG_UUID_STR_LEN
];
2674 lttng_uuid_to_str(session
->sessiond_uuid
, uuid_str
);
2675 ERR("Unknown next trace chunk in ROTATE_STREAMS command: sessiond_uuid = {%s}, session_id = %" PRIu64
2676 ", trace_chunk_id = %" PRIu64
,
2677 uuid_str
, session
->id
,
2678 rotate_streams
.new_chunk_id
.value
);
2679 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2684 ret
= snprintf(chunk_id_buf
, sizeof(chunk_id_buf
), "%" PRIu64
,
2685 rotate_streams
.new_chunk_id
.value
);
2686 if (ret
< 0 || ret
>= sizeof(chunk_id_buf
)) {
2687 chunk_id_str
= "formatting error";
2689 chunk_id_str
= chunk_id_buf
;
2693 DBG("Rotate %" PRIu32
" streams of session \"%s\" to chunk \"%s\"",
2694 rotate_streams
.stream_count
, session
->session_name
,
2697 stream_positions
= lttng_buffer_view_from_view(payload
,
2699 if (!stream_positions
.data
||
2700 stream_positions
.size
<
2701 (rotate_streams
.stream_count
*
2702 sizeof(struct lttcomm_relayd_stream_rotation_position
))) {
2703 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2708 for (i
= 0; i
< rotate_streams
.stream_count
; i
++) {
2709 struct lttcomm_relayd_stream_rotation_position
*position_comm
=
2710 &((typeof(position_comm
)) stream_positions
.data
)[i
];
2711 const struct lttcomm_relayd_stream_rotation_position pos
= {
2712 .stream_id
= be64toh(position_comm
->stream_id
),
2713 .rotate_at_seq_num
= be64toh(
2714 position_comm
->rotate_at_seq_num
),
2717 stream
= stream_get_by_id(pos
.stream_id
);
2719 reply_code
= LTTNG_ERR_INVALID
;
2724 pthread_mutex_lock(&stream
->lock
);
2725 ret
= stream_set_pending_rotation(stream
, next_trace_chunk
,
2726 pos
.rotate_at_seq_num
);
2727 pthread_mutex_unlock(&stream
->lock
);
2729 reply_code
= LTTNG_ERR_FILE_CREATION_ERROR
;
2737 reply_code
= LTTNG_OK
;
2744 reply
.ret_code
= htobe32((uint32_t) reply_code
);
2745 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2746 sizeof(struct lttcomm_relayd_generic_reply
), 0);
2747 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2748 ERR("Failed to send \"rotate session stream\" command reply (ret = %zd)",
2753 lttng_trace_chunk_put(next_trace_chunk
);
2758 * relay_create_trace_chunk: create a new trace chunk
2760 static int relay_create_trace_chunk(const struct lttcomm_relayd_hdr
*recv_hdr
,
2761 struct relay_connection
*conn
,
2762 const struct lttng_buffer_view
*payload
)
2766 struct relay_session
*session
= conn
->session
;
2767 struct lttcomm_relayd_create_trace_chunk
*msg
;
2768 struct lttcomm_relayd_generic_reply reply
= {};
2769 struct lttng_buffer_view header_view
;
2770 struct lttng_trace_chunk
*chunk
= NULL
, *published_chunk
= NULL
;
2771 enum lttng_error_code reply_code
= LTTNG_OK
;
2772 enum lttng_trace_chunk_status chunk_status
;
2773 const char *new_path
;
2775 if (!session
|| !conn
->version_check_done
) {
2776 ERR("Trying to create a trace chunk before version check");
2781 if (session
->major
== 2 && session
->minor
< 11) {
2782 ERR("Chunk creation command is unsupported before 2.11");
2787 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
2788 if (!lttng_buffer_view_is_valid(&header_view
)) {
2789 ERR("Failed to receive payload of chunk creation command");
2794 /* Convert to host endianness. */
2795 msg
= (typeof(msg
)) header_view
.data
;
2796 msg
->chunk_id
= be64toh(msg
->chunk_id
);
2797 msg
->creation_timestamp
= be64toh(msg
->creation_timestamp
);
2798 msg
->override_name_length
= be32toh(msg
->override_name_length
);
2800 pthread_mutex_lock(&conn
->session
->lock
);
2801 session
->ongoing_rotation
= true;
2802 if (session
->current_trace_chunk
&&
2803 !lttng_trace_chunk_get_name_overridden(session
->current_trace_chunk
)) {
2804 chunk_status
= lttng_trace_chunk_rename_path(session
->current_trace_chunk
,
2805 DEFAULT_CHUNK_TMP_OLD_DIRECTORY
);
2806 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2807 ERR("Failed to rename old chunk");
2809 reply_code
= LTTNG_ERR_UNK
;
2813 if (!session
->current_trace_chunk
) {
2814 if (!session
->has_rotated
) {
2820 new_path
= DEFAULT_CHUNK_TMP_NEW_DIRECTORY
;
2822 chunk
= lttng_trace_chunk_create(
2823 msg
->chunk_id
, msg
->creation_timestamp
, new_path
);
2825 ERR("Failed to create trace chunk in trace chunk creation command");
2827 reply_code
= LTTNG_ERR_NOMEM
;
2830 lttng_trace_chunk_set_fd_tracker(chunk
, the_fd_tracker
);
2832 if (msg
->override_name_length
) {
2834 const struct lttng_buffer_view chunk_name_view
=
2835 lttng_buffer_view_from_view(payload
,
2837 msg
->override_name_length
);
2839 if (!lttng_buffer_view_is_valid(&chunk_name_view
)) {
2840 ERR("Invalid payload of chunk creation command (protocol error): buffer too short for expected name length");
2842 reply_code
= LTTNG_ERR_INVALID
;
2846 name
= chunk_name_view
.data
;
2847 if (name
[msg
->override_name_length
- 1]) {
2848 ERR("Invalid payload of chunk creation command (protocol error): name is not null-terminated");
2850 reply_code
= LTTNG_ERR_INVALID
;
2854 chunk_status
= lttng_trace_chunk_override_name(
2855 chunk
, chunk_name_view
.data
);
2856 switch (chunk_status
) {
2857 case LTTNG_TRACE_CHUNK_STATUS_OK
:
2859 case LTTNG_TRACE_CHUNK_STATUS_INVALID_ARGUMENT
:
2860 ERR("Failed to set the name of new trace chunk in trace chunk creation command (invalid name)");
2861 reply_code
= LTTNG_ERR_INVALID
;
2865 ERR("Failed to set the name of new trace chunk in trace chunk creation command (unknown error)");
2866 reply_code
= LTTNG_ERR_UNK
;
2872 chunk_status
= lttng_trace_chunk_set_credentials_current_user(chunk
);
2873 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2874 reply_code
= LTTNG_ERR_UNK
;
2879 LTTNG_ASSERT(conn
->session
->output_directory
);
2880 chunk_status
= lttng_trace_chunk_set_as_owner(chunk
,
2881 conn
->session
->output_directory
);
2882 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2883 reply_code
= LTTNG_ERR_UNK
;
2888 published_chunk
= sessiond_trace_chunk_registry_publish_chunk(
2889 sessiond_trace_chunk_registry
,
2890 conn
->session
->sessiond_uuid
,
2891 conn
->session
->id_sessiond
.is_set
?
2892 conn
->session
->id_sessiond
.value
:
2895 if (!published_chunk
) {
2896 char uuid_str
[LTTNG_UUID_STR_LEN
];
2898 lttng_uuid_to_str(conn
->session
->sessiond_uuid
, uuid_str
);
2899 ERR("Failed to publish chunk: sessiond_uuid = %s, session_id = %" PRIu64
", chunk_id = %" PRIu64
,
2904 reply_code
= LTTNG_ERR_NOMEM
;
2908 if (conn
->session
->pending_closure_trace_chunk
) {
2910 * Invalid; this means a second create_trace_chunk command was
2911 * received before a close_trace_chunk.
2913 ERR("Invalid trace chunk close command received; a trace chunk is already waiting for a trace chunk close command");
2914 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2918 conn
->session
->pending_closure_trace_chunk
=
2919 conn
->session
->current_trace_chunk
;
2920 conn
->session
->current_trace_chunk
= published_chunk
;
2921 published_chunk
= NULL
;
2922 if (!conn
->session
->pending_closure_trace_chunk
) {
2923 session
->ongoing_rotation
= false;
2926 pthread_mutex_unlock(&conn
->session
->lock
);
2927 reply
.ret_code
= htobe32((uint32_t) reply_code
);
2928 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
,
2930 sizeof(struct lttcomm_relayd_generic_reply
),
2932 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2933 ERR("Failed to send \"create trace chunk\" command reply (ret = %zd)",
2938 lttng_trace_chunk_put(chunk
);
2939 lttng_trace_chunk_put(published_chunk
);
2944 * relay_close_trace_chunk: close a trace chunk
2946 static int relay_close_trace_chunk(const struct lttcomm_relayd_hdr
*recv_hdr
,
2947 struct relay_connection
*conn
,
2948 const struct lttng_buffer_view
*payload
)
2950 int ret
= 0, buf_ret
;
2952 struct relay_session
*session
= conn
->session
;
2953 struct lttcomm_relayd_close_trace_chunk
*msg
;
2954 struct lttcomm_relayd_close_trace_chunk_reply reply
= {};
2955 struct lttng_buffer_view header_view
;
2956 struct lttng_trace_chunk
*chunk
= NULL
;
2957 enum lttng_error_code reply_code
= LTTNG_OK
;
2958 enum lttng_trace_chunk_status chunk_status
;
2960 LTTNG_OPTIONAL(enum lttng_trace_chunk_command_type
) close_command
= {};
2961 time_t close_timestamp
;
2962 char closed_trace_chunk_path
[LTTNG_PATH_MAX
];
2963 size_t path_length
= 0;
2964 const char *chunk_name
= NULL
;
2965 struct lttng_dynamic_buffer reply_payload
;
2966 const char *new_path
;
2968 lttng_dynamic_buffer_init(&reply_payload
);
2970 if (!session
|| !conn
->version_check_done
) {
2971 ERR("Trying to close a trace chunk before version check");
2976 if (session
->major
== 2 && session
->minor
< 11) {
2977 ERR("Chunk close command is unsupported before 2.11");
2982 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
2983 if (!lttng_buffer_view_is_valid(&header_view
)) {
2984 ERR("Failed to receive payload of chunk close command");
2989 /* Convert to host endianness. */
2990 msg
= (typeof(msg
)) header_view
.data
;
2991 chunk_id
= be64toh(msg
->chunk_id
);
2992 close_timestamp
= (time_t) be64toh(msg
->close_timestamp
);
2993 close_command
.value
= (lttng_trace_chunk_command_type
) be32toh(msg
->close_command
.value
);
2994 close_command
.is_set
= msg
->close_command
.is_set
;
2996 chunk
= sessiond_trace_chunk_registry_get_chunk(
2997 sessiond_trace_chunk_registry
,
2998 conn
->session
->sessiond_uuid
,
2999 conn
->session
->id_sessiond
.is_set
?
3000 conn
->session
->id_sessiond
.value
:
3004 char uuid_str
[LTTNG_UUID_STR_LEN
];
3006 lttng_uuid_to_str(conn
->session
->sessiond_uuid
, uuid_str
);
3007 ERR("Failed to find chunk to close: sessiond_uuid = %s, session_id = %" PRIu64
", chunk_id = %" PRIu64
,
3012 reply_code
= LTTNG_ERR_NOMEM
;
3016 pthread_mutex_lock(&session
->lock
);
3017 if (close_command
.is_set
&&
3018 close_command
.value
== LTTNG_TRACE_CHUNK_COMMAND_TYPE_DELETE
) {
3020 * Clear command. It is a protocol error to ask for a
3021 * clear on a relay which does not allow it. Querying
3022 * the configuration allows figuring out whether
3023 * clearing is allowed before doing the clear.
3025 if (!opt_allow_clear
) {
3027 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3028 goto end_unlock_session
;
3031 if (session
->pending_closure_trace_chunk
&&
3032 session
->pending_closure_trace_chunk
!= chunk
) {
3033 ERR("Trace chunk close command for session \"%s\" does not target the trace chunk pending closure",
3034 session
->session_name
);
3035 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3037 goto end_unlock_session
;
3040 if (session
->current_trace_chunk
&& session
->current_trace_chunk
!= chunk
&&
3041 !lttng_trace_chunk_get_name_overridden(session
->current_trace_chunk
)) {
3042 if (close_command
.is_set
&&
3043 close_command
.value
== LTTNG_TRACE_CHUNK_COMMAND_TYPE_DELETE
&&
3044 !session
->has_rotated
) {
3045 /* New chunk stays in session output directory. */
3048 /* Use chunk name for new chunk. */
3051 /* Rename new chunk path. */
3052 chunk_status
= lttng_trace_chunk_rename_path(session
->current_trace_chunk
,
3054 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3056 goto end_unlock_session
;
3058 session
->ongoing_rotation
= false;
3060 if ((!close_command
.is_set
||
3061 close_command
.value
== LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
) &&
3062 !lttng_trace_chunk_get_name_overridden(chunk
)) {
3063 const char *old_path
;
3065 if (!session
->has_rotated
) {
3070 /* We need to move back the .tmp_old_chunk to its rightful place. */
3071 chunk_status
= lttng_trace_chunk_rename_path(chunk
, old_path
);
3072 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3074 goto end_unlock_session
;
3077 chunk_status
= lttng_trace_chunk_set_close_timestamp(
3078 chunk
, close_timestamp
);
3079 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3080 ERR("Failed to set trace chunk close timestamp");
3082 reply_code
= LTTNG_ERR_UNK
;
3083 goto end_unlock_session
;
3086 if (close_command
.is_set
) {
3087 chunk_status
= lttng_trace_chunk_set_close_command(
3088 chunk
, close_command
.value
);
3089 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3091 reply_code
= LTTNG_ERR_INVALID
;
3092 goto end_unlock_session
;
3095 chunk_status
= lttng_trace_chunk_get_name(chunk
, &chunk_name
, NULL
);
3096 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3097 ERR("Failed to get chunk name");
3099 reply_code
= LTTNG_ERR_UNK
;
3100 goto end_unlock_session
;
3102 if (!session
->has_rotated
&& !session
->snapshot
) {
3103 ret
= lttng_strncpy(closed_trace_chunk_path
,
3104 session
->output_path
,
3105 sizeof(closed_trace_chunk_path
));
3107 ERR("Failed to send trace chunk path: path length of %zu bytes exceeds the maximal allowed length of %zu bytes",
3108 strlen(session
->output_path
),
3109 sizeof(closed_trace_chunk_path
));
3110 reply_code
= LTTNG_ERR_NOMEM
;
3112 goto end_unlock_session
;
3115 if (session
->snapshot
) {
3116 ret
= snprintf(closed_trace_chunk_path
,
3117 sizeof(closed_trace_chunk_path
),
3118 "%s/%s", session
->output_path
,
3121 ret
= snprintf(closed_trace_chunk_path
,
3122 sizeof(closed_trace_chunk_path
),
3123 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
3125 session
->output_path
, chunk_name
);
3127 if (ret
< 0 || ret
== sizeof(closed_trace_chunk_path
)) {
3128 ERR("Failed to format closed trace chunk resulting path");
3129 reply_code
= ret
< 0 ? LTTNG_ERR_UNK
: LTTNG_ERR_NOMEM
;
3131 goto end_unlock_session
;
3134 if (close_command
.is_set
&&
3135 close_command
.value
== LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
) {
3136 session
->has_rotated
= true;
3138 DBG("Reply chunk path on close: %s", closed_trace_chunk_path
);
3139 path_length
= strlen(closed_trace_chunk_path
) + 1;
3140 if (path_length
> UINT32_MAX
) {
3141 ERR("Closed trace chunk path exceeds the maximal length allowed by the protocol");
3143 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3144 goto end_unlock_session
;
3147 if (session
->current_trace_chunk
== chunk
) {
3149 * After a trace chunk close command, no new streams
3150 * referencing the chunk may be created. Hence, on the
3151 * event that no new trace chunk have been created for
3152 * the session, the reference to the current trace chunk
3153 * is released in order to allow it to be reclaimed when
3154 * the last stream releases its reference to it.
3156 lttng_trace_chunk_put(session
->current_trace_chunk
);
3157 session
->current_trace_chunk
= NULL
;
3159 lttng_trace_chunk_put(session
->pending_closure_trace_chunk
);
3160 session
->pending_closure_trace_chunk
= NULL
;
3162 pthread_mutex_unlock(&session
->lock
);
3165 reply
.generic
.ret_code
= htobe32((uint32_t) reply_code
);
3166 reply
.path_length
= htobe32((uint32_t) path_length
);
3167 buf_ret
= lttng_dynamic_buffer_append(
3168 &reply_payload
, &reply
, sizeof(reply
));
3170 ERR("Failed to append \"close trace chunk\" command reply header to payload buffer");
3174 if (reply_code
== LTTNG_OK
) {
3175 buf_ret
= lttng_dynamic_buffer_append(&reply_payload
,
3176 closed_trace_chunk_path
, path_length
);
3178 ERR("Failed to append \"close trace chunk\" command reply path to payload buffer");
3183 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
,
3187 if (send_ret
< reply_payload
.size
) {
3188 ERR("Failed to send \"close trace chunk\" command reply of %zu bytes (ret = %zd)",
3189 reply_payload
.size
, send_ret
);
3194 lttng_trace_chunk_put(chunk
);
3195 lttng_dynamic_buffer_reset(&reply_payload
);
3200 * relay_trace_chunk_exists: check if a trace chunk exists
3202 static int relay_trace_chunk_exists(const struct lttcomm_relayd_hdr
*recv_hdr
,
3203 struct relay_connection
*conn
,
3204 const struct lttng_buffer_view
*payload
)
3208 struct relay_session
*session
= conn
->session
;
3209 struct lttcomm_relayd_trace_chunk_exists
*msg
;
3210 struct lttcomm_relayd_trace_chunk_exists_reply reply
= {};
3211 struct lttng_buffer_view header_view
;
3215 if (!session
|| !conn
->version_check_done
) {
3216 ERR("Trying to check for the presence of a trace chunk before version check");
3221 if (session
->major
== 2 && session
->minor
< 11) {
3222 ERR("Chunk exists command is unsupported before 2.11");
3227 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
3228 if (!lttng_buffer_view_is_valid(&header_view
)) {
3229 ERR("Failed to receive payload of chunk exists command");
3234 /* Convert to host endianness. */
3235 msg
= (typeof(msg
)) header_view
.data
;
3236 chunk_id
= be64toh(msg
->chunk_id
);
3238 ret
= sessiond_trace_chunk_registry_chunk_exists(
3239 sessiond_trace_chunk_registry
,
3240 conn
->session
->sessiond_uuid
,
3242 chunk_id
, &chunk_exists
);
3244 * If ret is not 0, send the reply and report the error to the caller.
3245 * It is a protocol (or internal) error and the session/connection
3246 * should be torn down.
3248 reply
.generic
.ret_code
= htobe32((uint32_t) (ret
== 0 ? LTTNG_OK
: LTTNG_ERR_INVALID_PROTOCOL
));
3249 reply
.trace_chunk_exists
= ret
== 0 ? chunk_exists
: 0;
3251 send_ret
= conn
->sock
->ops
->sendmsg(
3252 conn
->sock
, &reply
, sizeof(reply
), 0);
3253 if (send_ret
< (ssize_t
) sizeof(reply
)) {
3254 ERR("Failed to send \"create trace chunk\" command reply (ret = %zd)",
3263 * relay_get_configuration: query whether feature is available
3265 static int relay_get_configuration(const struct lttcomm_relayd_hdr
*recv_hdr
,
3266 struct relay_connection
*conn
,
3267 const struct lttng_buffer_view
*payload
)
3271 struct lttcomm_relayd_get_configuration
*msg
;
3272 struct lttcomm_relayd_get_configuration_reply reply
= {};
3273 struct lttng_buffer_view header_view
;
3274 uint64_t query_flags
= 0;
3275 uint64_t result_flags
= 0;
3277 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
3278 if (!lttng_buffer_view_is_valid(&header_view
)) {
3279 ERR("Failed to receive payload of chunk close command");
3284 /* Convert to host endianness. */
3285 msg
= (typeof(msg
)) header_view
.data
;
3286 query_flags
= be64toh(msg
->query_flags
);
3289 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
3292 if (opt_allow_clear
) {
3293 result_flags
|= LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
;
3297 reply
.generic
.ret_code
= htobe32((uint32_t) (ret
== 0 ? LTTNG_OK
: LTTNG_ERR_INVALID_PROTOCOL
));
3298 reply
.relayd_configuration_flags
= htobe64(result_flags
);
3300 send_ret
= conn
->sock
->ops
->sendmsg(
3301 conn
->sock
, &reply
, sizeof(reply
), 0);
3302 if (send_ret
< (ssize_t
) sizeof(reply
)) {
3303 ERR("Failed to send \"get configuration\" command reply (ret = %zd)",
3311 static int relay_process_control_command(struct relay_connection
*conn
,
3312 const struct lttcomm_relayd_hdr
*header
,
3313 const struct lttng_buffer_view
*payload
)
3317 DBG3("Processing \"%s\" command for socket %i",
3318 lttcomm_relayd_command_str((lttcomm_relayd_command
) header
->cmd
),
3320 switch (header
->cmd
) {
3321 case RELAYD_CREATE_SESSION
:
3322 ret
= relay_create_session(header
, conn
, payload
);
3324 case RELAYD_ADD_STREAM
:
3325 ret
= relay_add_stream(header
, conn
, payload
);
3327 case RELAYD_START_DATA
:
3328 ret
= relay_start(header
, conn
, payload
);
3330 case RELAYD_SEND_METADATA
:
3331 ret
= relay_recv_metadata(header
, conn
, payload
);
3333 case RELAYD_VERSION
:
3334 ret
= relay_send_version(header
, conn
, payload
);
3336 case RELAYD_CLOSE_STREAM
:
3337 ret
= relay_close_stream(header
, conn
, payload
);
3339 case RELAYD_DATA_PENDING
:
3340 ret
= relay_data_pending(header
, conn
, payload
);
3342 case RELAYD_QUIESCENT_CONTROL
:
3343 ret
= relay_quiescent_control(header
, conn
, payload
);
3345 case RELAYD_BEGIN_DATA_PENDING
:
3346 ret
= relay_begin_data_pending(header
, conn
, payload
);
3348 case RELAYD_END_DATA_PENDING
:
3349 ret
= relay_end_data_pending(header
, conn
, payload
);
3351 case RELAYD_SEND_INDEX
:
3352 ret
= relay_recv_index(header
, conn
, payload
);
3354 case RELAYD_STREAMS_SENT
:
3355 ret
= relay_streams_sent(header
, conn
, payload
);
3357 case RELAYD_RESET_METADATA
:
3358 ret
= relay_reset_metadata(header
, conn
, payload
);
3360 case RELAYD_ROTATE_STREAMS
:
3361 ret
= relay_rotate_session_streams(header
, conn
, payload
);
3363 case RELAYD_CREATE_TRACE_CHUNK
:
3364 ret
= relay_create_trace_chunk(header
, conn
, payload
);
3366 case RELAYD_CLOSE_TRACE_CHUNK
:
3367 ret
= relay_close_trace_chunk(header
, conn
, payload
);
3369 case RELAYD_TRACE_CHUNK_EXISTS
:
3370 ret
= relay_trace_chunk_exists(header
, conn
, payload
);
3372 case RELAYD_GET_CONFIGURATION
:
3373 ret
= relay_get_configuration(header
, conn
, payload
);
3375 case RELAYD_UPDATE_SYNC_INFO
:
3377 ERR("Received unknown command (%u)", header
->cmd
);
3378 relay_unknown_command(conn
);
3387 static enum relay_connection_status
relay_process_control_receive_payload(
3388 struct relay_connection
*conn
)
3391 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3392 struct lttng_dynamic_buffer
*reception_buffer
=
3393 &conn
->protocol
.ctrl
.reception_buffer
;
3394 struct ctrl_connection_state_receive_payload
*state
=
3395 &conn
->protocol
.ctrl
.state
.receive_payload
;
3396 struct lttng_buffer_view payload_view
;
3398 if (state
->left_to_receive
== 0) {
3399 /* Short-circuit for payload-less commands. */
3400 goto reception_complete
;
3403 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3404 reception_buffer
->data
+ state
->received
,
3405 state
->left_to_receive
, MSG_DONTWAIT
);
3407 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3408 PERROR("Unable to receive command payload on sock %d",
3410 status
= RELAY_CONNECTION_STATUS_ERROR
;
3413 } else if (ret
== 0) {
3414 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3415 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3419 LTTNG_ASSERT(ret
> 0);
3420 LTTNG_ASSERT(ret
<= state
->left_to_receive
);
3422 state
->left_to_receive
-= ret
;
3423 state
->received
+= ret
;
3425 if (state
->left_to_receive
> 0) {
3427 * Can't transition to the protocol's next state, wait to
3428 * receive the rest of the header.
3430 DBG3("Partial reception of control connection protocol payload (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3431 state
->received
, state
->left_to_receive
,
3437 DBG("Done receiving control command payload: fd = %i, payload size = %" PRIu64
" bytes",
3438 conn
->sock
->fd
, state
->received
);
3440 * The payload required to process the command has been received.
3441 * A view to the reception buffer is forwarded to the various
3442 * commands and the state of the control is reset on success.
3444 * Commands are responsible for sending their reply to the peer.
3446 payload_view
= lttng_buffer_view_from_dynamic_buffer(reception_buffer
,
3448 ret
= relay_process_control_command(conn
,
3449 &state
->header
, &payload_view
);
3451 status
= RELAY_CONNECTION_STATUS_ERROR
;
3455 ret
= connection_reset_protocol_state(conn
);
3457 status
= RELAY_CONNECTION_STATUS_ERROR
;
3463 static enum relay_connection_status
relay_process_control_receive_header(
3464 struct relay_connection
*conn
)
3467 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3468 struct lttcomm_relayd_hdr header
;
3469 struct lttng_dynamic_buffer
*reception_buffer
=
3470 &conn
->protocol
.ctrl
.reception_buffer
;
3471 struct ctrl_connection_state_receive_header
*state
=
3472 &conn
->protocol
.ctrl
.state
.receive_header
;
3474 LTTNG_ASSERT(state
->left_to_receive
!= 0);
3476 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3477 reception_buffer
->data
+ state
->received
,
3478 state
->left_to_receive
, MSG_DONTWAIT
);
3480 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3481 PERROR("Unable to receive control command header on sock %d",
3483 status
= RELAY_CONNECTION_STATUS_ERROR
;
3486 } else if (ret
== 0) {
3487 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3488 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3492 LTTNG_ASSERT(ret
> 0);
3493 LTTNG_ASSERT(ret
<= state
->left_to_receive
);
3495 state
->left_to_receive
-= ret
;
3496 state
->received
+= ret
;
3498 if (state
->left_to_receive
> 0) {
3500 * Can't transition to the protocol's next state, wait to
3501 * receive the rest of the header.
3503 DBG3("Partial reception of control connection protocol header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3504 state
->received
, state
->left_to_receive
,
3509 /* Transition to next state: receiving the command's payload. */
3510 conn
->protocol
.ctrl
.state_id
=
3511 CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3512 memcpy(&header
, reception_buffer
->data
, sizeof(header
));
3513 header
.circuit_id
= be64toh(header
.circuit_id
);
3514 header
.data_size
= be64toh(header
.data_size
);
3515 header
.cmd
= be32toh(header
.cmd
);
3516 header
.cmd_version
= be32toh(header
.cmd_version
);
3517 memcpy(&conn
->protocol
.ctrl
.state
.receive_payload
.header
,
3518 &header
, sizeof(header
));
3520 DBG("Done receiving control command header: fd = %i, cmd = %s, cmd_version = %" PRIu32
", payload size = %" PRIu64
" bytes",
3521 conn
->sock
->fd
, lttcomm_relayd_command_str((enum lttcomm_relayd_command
) header
.cmd
),
3522 header
.cmd_version
, header
.data_size
);
3524 if (header
.data_size
> DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE
) {
3525 ERR("Command header indicates a payload (%" PRIu64
" bytes) that exceeds the maximal payload size allowed on a control connection.",
3527 status
= RELAY_CONNECTION_STATUS_ERROR
;
3531 conn
->protocol
.ctrl
.state
.receive_payload
.left_to_receive
=
3533 conn
->protocol
.ctrl
.state
.receive_payload
.received
= 0;
3534 ret
= lttng_dynamic_buffer_set_size(reception_buffer
,
3537 status
= RELAY_CONNECTION_STATUS_ERROR
;
3541 if (header
.data_size
== 0) {
3543 * Manually invoke the next state as the poll loop
3544 * will not wake-up to allow us to proceed further.
3546 status
= relay_process_control_receive_payload(conn
);
3553 * Process the commands received on the control socket
3555 static enum relay_connection_status
relay_process_control(
3556 struct relay_connection
*conn
)
3558 enum relay_connection_status status
;
3560 switch (conn
->protocol
.ctrl
.state_id
) {
3561 case CTRL_CONNECTION_STATE_RECEIVE_HEADER
:
3562 status
= relay_process_control_receive_header(conn
);
3564 case CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3565 status
= relay_process_control_receive_payload(conn
);
3568 ERR("Unknown control connection protocol state encountered.");
3575 static enum relay_connection_status
relay_process_data_receive_header(
3576 struct relay_connection
*conn
)
3579 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3580 struct data_connection_state_receive_header
*state
=
3581 &conn
->protocol
.data
.state
.receive_header
;
3582 struct lttcomm_relayd_data_hdr header
;
3583 struct relay_stream
*stream
;
3585 LTTNG_ASSERT(state
->left_to_receive
!= 0);
3587 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3588 state
->header_reception_buffer
+ state
->received
,
3589 state
->left_to_receive
, MSG_DONTWAIT
);
3591 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3592 PERROR("Unable to receive data header on sock %d", conn
->sock
->fd
);
3593 status
= RELAY_CONNECTION_STATUS_ERROR
;
3596 } else if (ret
== 0) {
3597 /* Orderly shutdown. Not necessary to print an error. */
3598 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3599 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3603 LTTNG_ASSERT(ret
> 0);
3604 LTTNG_ASSERT(ret
<= state
->left_to_receive
);
3606 state
->left_to_receive
-= ret
;
3607 state
->received
+= ret
;
3609 if (state
->left_to_receive
> 0) {
3611 * Can't transition to the protocol's next state, wait to
3612 * receive the rest of the header.
3614 DBG3("Partial reception of data connection header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3615 state
->received
, state
->left_to_receive
,
3620 /* Transition to next state: receiving the payload. */
3621 conn
->protocol
.data
.state_id
= DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3623 memcpy(&header
, state
->header_reception_buffer
, sizeof(header
));
3624 header
.circuit_id
= be64toh(header
.circuit_id
);
3625 header
.stream_id
= be64toh(header
.stream_id
);
3626 header
.data_size
= be32toh(header
.data_size
);
3627 header
.net_seq_num
= be64toh(header
.net_seq_num
);
3628 header
.padding_size
= be32toh(header
.padding_size
);
3629 memcpy(&conn
->protocol
.data
.state
.receive_payload
.header
, &header
, sizeof(header
));
3631 conn
->protocol
.data
.state
.receive_payload
.left_to_receive
=
3633 conn
->protocol
.data
.state
.receive_payload
.received
= 0;
3634 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= false;
3636 DBG("Received data connection header on fd %i: circuit_id = %" PRIu64
", stream_id = %" PRIu64
", data_size = %" PRIu32
", net_seq_num = %" PRIu64
", padding_size = %" PRIu32
,
3637 conn
->sock
->fd
, header
.circuit_id
,
3638 header
.stream_id
, header
.data_size
,
3639 header
.net_seq_num
, header
.padding_size
);
3641 stream
= stream_get_by_id(header
.stream_id
);
3643 DBG("relay_process_data_receive_payload: Cannot find stream %" PRIu64
,
3645 /* Protocol error. */
3646 status
= RELAY_CONNECTION_STATUS_ERROR
;
3650 pthread_mutex_lock(&stream
->lock
);
3651 /* Prepare stream for the reception of a new packet. */
3652 ret
= stream_init_packet(stream
, header
.data_size
,
3653 &conn
->protocol
.data
.state
.receive_payload
.rotate_index
);
3654 pthread_mutex_unlock(&stream
->lock
);
3656 ERR("Failed to rotate stream output file");
3657 status
= RELAY_CONNECTION_STATUS_ERROR
;
3658 goto end_stream_unlock
;
3667 static enum relay_connection_status
relay_process_data_receive_payload(
3668 struct relay_connection
*conn
)
3671 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3672 struct relay_stream
*stream
;
3673 struct data_connection_state_receive_payload
*state
=
3674 &conn
->protocol
.data
.state
.receive_payload
;
3675 const size_t chunk_size
= RECV_DATA_BUFFER_SIZE
;
3676 char data_buffer
[chunk_size
];
3677 bool partial_recv
= false;
3678 bool new_stream
= false, close_requested
= false, index_flushed
= false;
3679 uint64_t left_to_receive
= state
->left_to_receive
;
3680 struct relay_session
*session
;
3682 DBG3("Receiving data for stream id %" PRIu64
" seqnum %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3683 state
->header
.stream_id
, state
->header
.net_seq_num
,
3684 state
->received
, left_to_receive
);
3686 stream
= stream_get_by_id(state
->header
.stream_id
);
3688 /* Protocol error. */
3689 ERR("relay_process_data_receive_payload: cannot find stream %" PRIu64
,
3690 state
->header
.stream_id
);
3691 status
= RELAY_CONNECTION_STATUS_ERROR
;
3695 pthread_mutex_lock(&stream
->lock
);
3696 session
= stream
->trace
->session
;
3697 if (!conn
->session
) {
3698 ret
= connection_set_session(conn
, session
);
3700 status
= RELAY_CONNECTION_STATUS_ERROR
;
3701 goto end_stream_unlock
;
3706 * The size of the "chunk" received on any iteration is bounded by:
3707 * - the data left to receive,
3708 * - the data immediately available on the socket,
3709 * - the on-stack data buffer
3711 while (left_to_receive
> 0 && !partial_recv
) {
3712 size_t recv_size
= std::min
<uint64_t>(left_to_receive
, chunk_size
);
3713 struct lttng_buffer_view packet_chunk
;
3715 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
,
3716 recv_size
, MSG_DONTWAIT
);
3718 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3719 PERROR("Socket %d error", conn
->sock
->fd
);
3720 status
= RELAY_CONNECTION_STATUS_ERROR
;
3722 goto end_stream_unlock
;
3723 } else if (ret
== 0) {
3724 /* No more data ready to be consumed on socket. */
3725 DBG3("No more data ready for consumption on data socket of stream id %" PRIu64
,
3726 state
->header
.stream_id
);
3727 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3729 } else if (ret
< (int) recv_size
) {
3731 * All the data available on the socket has been
3734 partial_recv
= true;
3738 packet_chunk
= lttng_buffer_view_init(data_buffer
,
3740 LTTNG_ASSERT(packet_chunk
.data
);
3742 ret
= stream_write(stream
, &packet_chunk
, 0);
3744 ERR("Relay error writing data to file");
3745 status
= RELAY_CONNECTION_STATUS_ERROR
;
3746 goto end_stream_unlock
;
3749 left_to_receive
-= recv_size
;
3750 state
->received
+= recv_size
;
3751 state
->left_to_receive
= left_to_receive
;
3754 if (state
->left_to_receive
> 0) {
3756 * Did not receive all the data expected, wait for more data to
3757 * become available on the socket.
3759 DBG3("Partial receive on data connection of stream id %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3760 state
->header
.stream_id
, state
->received
,
3761 state
->left_to_receive
);
3762 goto end_stream_unlock
;
3765 ret
= stream_write(stream
, NULL
, state
->header
.padding_size
);
3767 status
= RELAY_CONNECTION_STATUS_ERROR
;
3768 goto end_stream_unlock
;
3771 if (session_streams_have_index(session
)) {
3772 ret
= stream_update_index(stream
, state
->header
.net_seq_num
,
3773 state
->rotate_index
, &index_flushed
,
3774 state
->header
.data_size
+ state
->header
.padding_size
);
3776 ERR("Failed to update index: stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3777 stream
->stream_handle
,
3778 state
->header
.net_seq_num
, ret
);
3779 status
= RELAY_CONNECTION_STATUS_ERROR
;
3780 goto end_stream_unlock
;
3784 if (stream
->prev_data_seq
== -1ULL) {
3788 ret
= stream_complete_packet(stream
, state
->header
.data_size
+
3789 state
->header
.padding_size
, state
->header
.net_seq_num
,
3792 status
= RELAY_CONNECTION_STATUS_ERROR
;
3793 goto end_stream_unlock
;
3797 * Resetting the protocol state (to RECEIVE_HEADER) will trash the
3798 * contents of *state which are aliased (union) to the same location as
3799 * the new state. Don't use it beyond this point.
3801 connection_reset_protocol_state(conn
);
3805 close_requested
= stream
->close_requested
;
3806 pthread_mutex_unlock(&stream
->lock
);
3807 if (close_requested
&& left_to_receive
== 0) {
3808 try_stream_close(stream
);
3812 pthread_mutex_lock(&session
->lock
);
3813 uatomic_set(&session
->new_streams
, 1);
3814 pthread_mutex_unlock(&session
->lock
);
3823 * relay_process_data: Process the data received on the data socket
3825 static enum relay_connection_status
relay_process_data(
3826 struct relay_connection
*conn
)
3828 enum relay_connection_status status
;
3830 switch (conn
->protocol
.data
.state_id
) {
3831 case DATA_CONNECTION_STATE_RECEIVE_HEADER
:
3832 status
= relay_process_data_receive_header(conn
);
3834 case DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3835 status
= relay_process_data_receive_payload(conn
);
3838 ERR("Unexpected data connection communication state.");
3845 static void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
3849 (void) lttng_poll_del(events
, pollfd
);
3851 ret
= fd_tracker_close_unsuspendable_fd(the_fd_tracker
, &pollfd
, 1,
3852 fd_tracker_util_close_fd
, NULL
);
3854 ERR("Closing pollfd %d", pollfd
);
3858 static void relay_thread_close_connection(struct lttng_poll_event
*events
,
3859 int pollfd
, struct relay_connection
*conn
)
3861 const char *type_str
;
3863 switch (conn
->type
) {
3868 type_str
= "Control";
3870 case RELAY_VIEWER_COMMAND
:
3871 type_str
= "Viewer Command";
3873 case RELAY_VIEWER_NOTIFICATION
:
3874 type_str
= "Viewer Notification";
3877 type_str
= "Unknown";
3879 cleanup_connection_pollfd(events
, pollfd
);
3880 connection_put(conn
);
3881 DBG("%s connection closed with %d", type_str
, pollfd
);
3885 * This thread does the actual work
3887 static void *relay_thread_worker(void *data
)
3889 int ret
, err
= -1, last_seen_data_fd
= -1;
3891 struct lttng_poll_event events
;
3892 struct lttng_ht
*relay_connections_ht
;
3893 struct lttng_ht_iter iter
;
3894 struct relay_connection
*destroy_conn
= NULL
;
3896 DBG("[thread] Relay worker started");
3898 rcu_register_thread();
3900 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
3902 if (testpoint(relayd_thread_worker
)) {
3903 goto error_testpoint
;
3906 health_code_update();
3908 /* table of connections indexed on socket */
3909 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3910 if (!relay_connections_ht
) {
3911 goto relay_connections_ht_error
;
3914 ret
= create_named_thread_poll_set(&events
, 2, "Worker thread epoll");
3916 goto error_poll_create
;
3919 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
3926 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
3928 health_code_update();
3930 /* Infinite blocking call, waiting for transmission */
3931 DBG3("Relayd worker thread polling...");
3932 health_poll_entry();
3933 ret
= lttng_poll_wait(&events
, -1);
3937 * Restart interrupted system call.
3939 if (errno
== EINTR
) {
3948 * Process control. The control connection is
3949 * prioritized so we don't starve it with high
3950 * throughput tracing data on the data connection.
3952 for (i
= 0; i
< nb_fd
; i
++) {
3953 /* Fetch once the poll data */
3954 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3955 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3957 health_code_update();
3959 /* Thread quit pipe has been closed. Killing thread. */
3960 ret
= check_thread_quit_pipe(pollfd
, revents
);
3966 /* Inspect the relay conn pipe for new connection */
3967 if (pollfd
== relay_conn_pipe
[0]) {
3968 if (revents
& LPOLLIN
) {
3969 struct relay_connection
*conn
;
3971 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
3975 ret
= lttng_poll_add(&events
,
3977 LPOLLIN
| LPOLLRDHUP
);
3979 ERR("Failed to add new connection file descriptor to poll set");
3982 connection_ht_add(relay_connections_ht
, conn
);
3983 DBG("Connection socket %d added", conn
->sock
->fd
);
3984 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3985 ERR("Relay connection pipe error");
3988 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3992 struct relay_connection
*ctrl_conn
;
3994 ctrl_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3995 /* If not found, there is a synchronization issue. */
3996 LTTNG_ASSERT(ctrl_conn
);
3998 if (ctrl_conn
->type
== RELAY_DATA
) {
3999 if (revents
& LPOLLIN
) {
4001 * Flag the last seen data fd not deleted. It will be
4002 * used as the last seen fd if any fd gets deleted in
4005 last_notdel_data_fd
= pollfd
;
4007 goto put_ctrl_connection
;
4009 LTTNG_ASSERT(ctrl_conn
->type
== RELAY_CONTROL
);
4011 if (revents
& LPOLLIN
) {
4012 enum relay_connection_status status
;
4014 status
= relay_process_control(ctrl_conn
);
4015 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
4017 * On socket error flag the session as aborted to force
4018 * the cleanup of its stream otherwise it can leak
4019 * during the lifetime of the relayd.
4021 * This prevents situations in which streams can be
4022 * left opened because an index was received, the
4023 * control connection is closed, and the data
4024 * connection is closed (uncleanly) before the packet's
4027 * Since the control connection encountered an error,
4028 * it is okay to be conservative and close the
4029 * session right now as we can't rely on the protocol
4030 * being respected anymore.
4032 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
4033 session_abort(ctrl_conn
->session
);
4036 /* Clear the connection on error or close. */
4037 relay_thread_close_connection(&events
,
4042 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4043 relay_thread_close_connection(&events
,
4045 if (last_seen_data_fd
== pollfd
) {
4046 last_seen_data_fd
= last_notdel_data_fd
;
4049 ERR("Unexpected poll events %u for control sock %d",
4051 connection_put(ctrl_conn
);
4054 put_ctrl_connection
:
4055 connection_put(ctrl_conn
);
4060 * The last loop handled a control request, go back to poll to make
4061 * sure we prioritise the control socket.
4067 if (last_seen_data_fd
>= 0) {
4068 for (i
= 0; i
< nb_fd
; i
++) {
4069 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4071 health_code_update();
4073 if (last_seen_data_fd
== pollfd
) {
4080 /* Process data connection. */
4081 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
4082 /* Fetch the poll data. */
4083 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
4084 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4085 struct relay_connection
*data_conn
;
4087 health_code_update();
4090 /* No activity for this FD (poll implementation). */
4094 /* Skip the command pipe. It's handled in the first loop. */
4095 if (pollfd
== relay_conn_pipe
[0]) {
4099 data_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
4101 /* Skip it. Might be removed before. */
4104 if (data_conn
->type
== RELAY_CONTROL
) {
4105 goto put_data_connection
;
4107 LTTNG_ASSERT(data_conn
->type
== RELAY_DATA
);
4109 if (revents
& LPOLLIN
) {
4110 enum relay_connection_status status
;
4112 status
= relay_process_data(data_conn
);
4113 /* Connection closed or error. */
4114 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
4116 * On socket error flag the session as aborted to force
4117 * the cleanup of its stream otherwise it can leak
4118 * during the lifetime of the relayd.
4120 * This prevents situations in which streams can be
4121 * left opened because an index was received, the
4122 * control connection is closed, and the data
4123 * connection is closed (uncleanly) before the packet's
4126 * Since the data connection encountered an error,
4127 * it is okay to be conservative and close the
4128 * session right now as we can't rely on the protocol
4129 * being respected anymore.
4131 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
4132 session_abort(data_conn
->session
);
4134 relay_thread_close_connection(&events
, pollfd
,
4137 * Every goto restart call sets the last seen fd where
4138 * here we don't really care since we gracefully
4139 * continue the loop after the connection is deleted.
4142 /* Keep last seen port. */
4143 last_seen_data_fd
= pollfd
;
4144 connection_put(data_conn
);
4147 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4148 relay_thread_close_connection(&events
, pollfd
,
4151 ERR("Unknown poll events %u for data sock %d",
4154 put_data_connection
:
4155 connection_put(data_conn
);
4157 last_seen_data_fd
= -1;
4160 /* Normal exit, no error */
4165 /* Cleanup remaining connection object. */
4167 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
,
4170 health_code_update();
4172 session_abort(destroy_conn
->session
);
4175 * No need to grab another ref, because we own
4178 relay_thread_close_connection(&events
, destroy_conn
->sock
->fd
,
4183 (void) fd_tracker_util_poll_clean(the_fd_tracker
, &events
);
4185 lttng_ht_destroy(relay_connections_ht
);
4186 relay_connections_ht_error
:
4187 /* Close relay conn pipes */
4188 (void) fd_tracker_util_pipe_close(the_fd_tracker
,
4191 DBG("Thread exited with error");
4193 DBG("Worker thread cleanup complete");
4197 ERR("Health error occurred in %s", __func__
);
4199 health_unregister(health_relayd
);
4200 rcu_unregister_thread();
4201 lttng_relay_stop_threads();
4206 * Create the relay command pipe to wake thread_manage_apps.
4207 * Closed in cleanup().
4209 static int create_relay_conn_pipe(void)
4211 return fd_tracker_util_pipe_open_cloexec(the_fd_tracker
,
4212 "Relayd connection pipe", relay_conn_pipe
);
4215 static int stdio_open(void *data
, int *fds
)
4217 fds
[0] = fileno(stdout
);
4218 fds
[1] = fileno(stderr
);
4222 static int track_stdio(void)
4225 const char *names
[] = { "stdout", "stderr" };
4227 return fd_tracker_open_unsuspendable_fd(the_fd_tracker
, fds
,
4228 names
, 2, stdio_open
, NULL
);
4234 int main(int argc
, char **argv
)
4236 bool thread_is_rcu_registered
= false;
4237 int ret
= 0, retval
= 0;
4239 char *unlinked_file_directory_path
= NULL
, *output_path
= NULL
;
4241 /* Parse environment variables */
4242 ret
= parse_env_options();
4250 * Command line arguments overwrite environment.
4253 if (set_options(argc
, argv
)) {
4258 if (set_signal_handler()) {
4263 relayd_config_log();
4265 if (opt_print_version
) {
4271 ret
= fclose(stdin
);
4273 PERROR("Failed to close stdin");
4277 DBG("Clear command %s", opt_allow_clear
? "allowed" : "disallowed");
4279 /* Try to create directory if -o, --output is specified. */
4280 if (opt_output_path
) {
4281 if (*opt_output_path
!= '/') {
4282 ERR("Please specify an absolute path for -o, --output PATH");
4287 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
,
4290 ERR("Unable to create %s", opt_output_path
);
4297 if (opt_daemon
|| opt_background
) {
4298 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
4306 if (opt_working_directory
) {
4307 ret
= utils_change_working_directory(opt_working_directory
);
4309 /* All errors are already logged. */
4314 sessiond_trace_chunk_registry
= sessiond_trace_chunk_registry_create();
4315 if (!sessiond_trace_chunk_registry
) {
4316 ERR("Failed to initialize session daemon trace chunk registry");
4322 * The RCU thread registration (and use, through the fd-tracker's
4323 * creation) is done after the daemonization to allow us to not
4324 * deal with liburcu's fork() management as the call RCU needs to
4327 rcu_register_thread();
4328 thread_is_rcu_registered
= true;
4330 output_path
= create_output_path("");
4332 ERR("Failed to get output path");
4336 ret
= asprintf(&unlinked_file_directory_path
, "%s/%s", output_path
,
4337 DEFAULT_UNLINKED_FILES_DIRECTORY
);
4340 ERR("Failed to format unlinked file directory path");
4344 the_fd_tracker
= fd_tracker_create(
4345 unlinked_file_directory_path
, lttng_opt_fd_pool_size
);
4346 free(unlinked_file_directory_path
);
4347 if (!the_fd_tracker
) {
4352 ret
= track_stdio();
4358 /* Initialize thread health monitoring */
4359 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
4360 if (!health_relayd
) {
4361 PERROR("health_app_create error");
4366 /* Create thread quit pipe */
4367 if (init_thread_quit_pipe()) {
4372 /* Setup the thread apps communication pipe. */
4373 if (create_relay_conn_pipe()) {
4378 /* Init relay command queue. */
4379 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
4381 /* Initialize communication library */
4383 lttcomm_inet_init();
4385 /* tables of sessions indexed by session ID */
4386 sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4392 /* tables of streams indexed by stream ID */
4393 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4394 if (!relay_streams_ht
) {
4399 /* tables of streams indexed by stream ID */
4400 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4401 if (!viewer_streams_ht
) {
4406 ret
= init_health_quit_pipe();
4412 /* Create thread to manage the client socket */
4413 ret
= pthread_create(&health_thread
, default_pthread_attr(),
4414 thread_manage_health
, (void *) NULL
);
4417 PERROR("pthread_create health");
4422 /* Setup the dispatcher thread */
4423 ret
= pthread_create(&dispatcher_thread
, default_pthread_attr(),
4424 relay_thread_dispatcher
, (void *) NULL
);
4427 PERROR("pthread_create dispatcher");
4429 goto exit_dispatcher_thread
;
4432 /* Setup the worker thread */
4433 ret
= pthread_create(&worker_thread
, default_pthread_attr(),
4434 relay_thread_worker
, NULL
);
4437 PERROR("pthread_create worker");
4439 goto exit_worker_thread
;
4442 /* Setup the listener thread */
4443 ret
= pthread_create(&listener_thread
, default_pthread_attr(),
4444 relay_thread_listener
, (void *) NULL
);
4447 PERROR("pthread_create listener");
4449 goto exit_listener_thread
;
4452 ret
= relayd_live_create(live_uri
);
4454 ERR("Starting live viewer threads");
4460 * This is where we start awaiting program completion (e.g. through
4461 * signal that asks threads to teardown).
4464 ret
= relayd_live_join();
4470 ret
= pthread_join(listener_thread
, &status
);
4473 PERROR("pthread_join listener_thread");
4477 exit_listener_thread
:
4478 ret
= pthread_join(worker_thread
, &status
);
4481 PERROR("pthread_join worker_thread");
4486 ret
= pthread_join(dispatcher_thread
, &status
);
4489 PERROR("pthread_join dispatcher_thread");
4492 exit_dispatcher_thread
:
4494 ret
= pthread_join(health_thread
, &status
);
4497 PERROR("pthread_join health_thread");
4502 * Wait for all pending call_rcu work to complete before tearing
4503 * down data structures. call_rcu worker may be trying to
4504 * perform lookups in those structures.
4509 /* Ensure all prior call_rcu are done. */
4512 if (thread_is_rcu_registered
) {
4513 rcu_unregister_thread();