2 * Copyright (C) 2012 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
4 * 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License, version 2 only,
9 * as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
35 #include <sys/types.h>
38 #include <urcu/futex.h>
39 #include <urcu/uatomic.h>
40 #include <urcu/rculist.h>
45 #include <lttng/lttng.h>
46 #include <common/common.h>
47 #include <common/compat/poll.h>
48 #include <common/compat/socket.h>
49 #include <common/compat/endian.h>
50 #include <common/compat/getenv.h>
51 #include <common/defaults.h>
52 #include <common/daemonize.h>
53 #include <common/futex.h>
54 #include <common/sessiond-comm/sessiond-comm.h>
55 #include <common/sessiond-comm/inet.h>
56 #include <common/sessiond-comm/relayd.h>
57 #include <common/uri.h>
58 #include <common/utils.h>
59 #include <common/align.h>
60 #include <common/config/session-config.h>
61 #include <common/dynamic-buffer.h>
62 #include <common/buffer-view.h>
63 #include <common/string-utils/format.h>
66 #include "ctf-trace.h"
69 #include "lttng-relayd.h"
71 #include "health-relayd.h"
72 #include "testpoint.h"
73 #include "viewer-stream.h"
76 #include "connection.h"
77 #include "tracefile-array.h"
78 #include "tcp_keep_alive.h"
79 #include "sessiond-trace-chunks.h"
81 static const char *help_msg
=
82 #ifdef LTTNG_EMBED_HELP
83 #include <lttng-relayd.8.h>
89 enum relay_connection_status
{
90 RELAY_CONNECTION_STATUS_OK
,
91 /* An error occurred while processing an event on the connection. */
92 RELAY_CONNECTION_STATUS_ERROR
,
93 /* Connection closed/shutdown cleanly. */
94 RELAY_CONNECTION_STATUS_CLOSED
,
97 /* command line options */
98 char *opt_output_path
;
99 static int opt_daemon
, opt_background
;
102 * We need to wait for listener and live listener threads, as well as
103 * health check thread, before being ready to signal readiness.
105 #define NR_LTTNG_RELAY_READY 3
106 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
108 /* Size of receive buffer. */
109 #define RECV_DATA_BUFFER_SIZE 65536
111 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
112 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
114 static struct lttng_uri
*control_uri
;
115 static struct lttng_uri
*data_uri
;
116 static struct lttng_uri
*live_uri
;
118 const char *progname
;
120 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
121 static int tracing_group_name_override
;
123 const char * const config_section_name
= "relayd";
126 * Quit pipe for all threads. This permits a single cancellation point
127 * for all threads when receiving an event on the pipe.
129 int thread_quit_pipe
[2] = { -1, -1 };
132 * This pipe is used to inform the worker thread that a command is queued and
133 * ready to be processed.
135 static int relay_conn_pipe
[2] = { -1, -1 };
137 /* Shared between threads */
138 static int dispatch_thread_exit
;
140 static pthread_t listener_thread
;
141 static pthread_t dispatcher_thread
;
142 static pthread_t worker_thread
;
143 static pthread_t health_thread
;
146 * last_relay_stream_id_lock protects last_relay_stream_id increment
147 * atomicity on 32-bit architectures.
149 static pthread_mutex_t last_relay_stream_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
150 static uint64_t last_relay_stream_id
;
153 * Relay command queue.
155 * The relay_thread_listener and relay_thread_dispatcher communicate with this
158 static struct relay_conn_queue relay_conn_queue
;
160 /* Global relay stream hash table. */
161 struct lttng_ht
*relay_streams_ht
;
163 /* Global relay viewer stream hash table. */
164 struct lttng_ht
*viewer_streams_ht
;
166 /* Global relay sessions hash table. */
167 struct lttng_ht
*sessions_ht
;
169 /* Relayd health monitoring */
170 struct health_app
*health_relayd
;
172 struct sessiond_trace_chunk_registry
*sessiond_trace_chunk_registry
;
174 static struct option long_options
[] = {
175 { "control-port", 1, 0, 'C', },
176 { "data-port", 1, 0, 'D', },
177 { "live-port", 1, 0, 'L', },
178 { "daemonize", 0, 0, 'd', },
179 { "background", 0, 0, 'b', },
180 { "group", 1, 0, 'g', },
181 { "help", 0, 0, 'h', },
182 { "output", 1, 0, 'o', },
183 { "verbose", 0, 0, 'v', },
184 { "config", 1, 0, 'f' },
185 { "version", 0, 0, 'V' },
189 static const char *config_ignore_options
[] = { "help", "config", "version" };
192 * Take an option from the getopt output and set it in the right variable to be
195 * Return 0 on success else a negative value.
197 static int set_option(int opt
, const char *arg
, const char *optname
)
203 fprintf(stderr
, "option %s", optname
);
205 fprintf(stderr
, " with arg %s\n", arg
);
209 if (lttng_is_setuid_setgid()) {
210 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
211 "-C, --control-port");
213 ret
= uri_parse(arg
, &control_uri
);
215 ERR("Invalid control URI specified");
218 if (control_uri
->port
== 0) {
219 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
224 if (lttng_is_setuid_setgid()) {
225 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
228 ret
= uri_parse(arg
, &data_uri
);
230 ERR("Invalid data URI specified");
233 if (data_uri
->port
== 0) {
234 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
239 if (lttng_is_setuid_setgid()) {
240 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
243 ret
= uri_parse(arg
, &live_uri
);
245 ERR("Invalid live URI specified");
248 if (live_uri
->port
== 0) {
249 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
260 if (lttng_is_setuid_setgid()) {
261 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
264 tracing_group_name
= strdup(arg
);
265 if (tracing_group_name
== NULL
) {
270 tracing_group_name_override
= 1;
274 ret
= utils_show_help(8, "lttng-relayd", help_msg
);
276 ERR("Cannot show --help for `lttng-relayd`");
281 fprintf(stdout
, "%s\n", VERSION
);
284 if (lttng_is_setuid_setgid()) {
285 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
288 ret
= asprintf(&opt_output_path
, "%s", arg
);
291 PERROR("asprintf opt_output_path");
297 /* Verbose level can increase using multiple -v */
299 lttng_opt_verbose
= config_parse_value(arg
);
301 /* Only 3 level of verbosity (-vvv). */
302 if (lttng_opt_verbose
< 3) {
303 lttng_opt_verbose
+= 1;
308 /* Unknown option or other error.
309 * Error is printed by getopt, just return */
322 * config_entry_handler_cb used to handle options read from a config file.
323 * See config_entry_handler_cb comment in common/config/session-config.h for the
324 * return value conventions.
326 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
330 if (!entry
|| !entry
->name
|| !entry
->value
) {
335 /* Check if the option is to be ignored */
336 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
337 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
342 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1; i
++) {
343 /* Ignore if entry name is not fully matched. */
344 if (strcmp(entry
->name
, long_options
[i
].name
)) {
349 * If the option takes no argument on the command line,
350 * we have to check if the value is "true". We support
351 * non-zero numeric values, true, on and yes.
353 if (!long_options
[i
].has_arg
) {
354 ret
= config_parse_value(entry
->value
);
357 WARN("Invalid configuration value \"%s\" for option %s",
358 entry
->value
, entry
->name
);
360 /* False, skip boolean config option. */
365 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
369 WARN("Unrecognized option \"%s\" in daemon configuration file.",
376 static int set_options(int argc
, char **argv
)
378 int c
, ret
= 0, option_index
= 0, retval
= 0;
379 int orig_optopt
= optopt
, orig_optind
= optind
;
380 char *default_address
, *optstring
;
381 const char *config_path
= NULL
;
383 optstring
= utils_generate_optstring(long_options
,
384 sizeof(long_options
) / sizeof(struct option
));
390 /* Check for the --config option */
392 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
393 &option_index
)) != -1) {
397 } else if (c
!= 'f') {
401 if (lttng_is_setuid_setgid()) {
402 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
405 config_path
= utils_expand_path(optarg
);
407 ERR("Failed to resolve path: %s", optarg
);
412 ret
= config_get_section_entries(config_path
, config_section_name
,
413 config_entry_handler
, NULL
);
416 ERR("Invalid configuration option at line %i", ret
);
422 /* Reset getopt's global state */
423 optopt
= orig_optopt
;
424 optind
= orig_optind
;
426 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
431 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
438 /* assign default values */
439 if (control_uri
== NULL
) {
440 ret
= asprintf(&default_address
,
441 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
442 DEFAULT_NETWORK_CONTROL_PORT
);
444 PERROR("asprintf default data address");
449 ret
= uri_parse(default_address
, &control_uri
);
450 free(default_address
);
452 ERR("Invalid control URI specified");
457 if (data_uri
== NULL
) {
458 ret
= asprintf(&default_address
,
459 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
460 DEFAULT_NETWORK_DATA_PORT
);
462 PERROR("asprintf default data address");
467 ret
= uri_parse(default_address
, &data_uri
);
468 free(default_address
);
470 ERR("Invalid data URI specified");
475 if (live_uri
== NULL
) {
476 ret
= asprintf(&default_address
,
477 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
478 DEFAULT_NETWORK_VIEWER_PORT
);
480 PERROR("asprintf default viewer control address");
485 ret
= uri_parse(default_address
, &live_uri
);
486 free(default_address
);
488 ERR("Invalid viewer control URI specified");
499 static void print_global_objects(void)
501 rcu_register_thread();
503 print_viewer_streams();
504 print_relay_streams();
507 rcu_unregister_thread();
513 static void relayd_cleanup(void)
515 print_global_objects();
519 if (viewer_streams_ht
)
520 lttng_ht_destroy(viewer_streams_ht
);
521 if (relay_streams_ht
)
522 lttng_ht_destroy(relay_streams_ht
);
524 lttng_ht_destroy(sessions_ht
);
526 /* free the dynamically allocated opt_output_path */
527 free(opt_output_path
);
529 /* Close thread quit pipes */
530 utils_close_pipe(thread_quit_pipe
);
532 uri_free(control_uri
);
534 /* Live URI is freed in the live thread. */
536 if (tracing_group_name_override
) {
537 free((void *) tracing_group_name
);
542 * Write to writable pipe used to notify a thread.
544 static int notify_thread_pipe(int wpipe
)
548 ret
= lttng_write(wpipe
, "!", 1);
550 PERROR("write poll pipe");
558 static int notify_health_quit_pipe(int *pipe
)
562 ret
= lttng_write(pipe
[1], "4", 1);
564 PERROR("write relay health quit");
573 * Stop all relayd and relayd-live threads.
575 int lttng_relay_stop_threads(void)
579 /* Stopping all threads */
580 DBG("Terminating all threads");
581 if (notify_thread_pipe(thread_quit_pipe
[1])) {
582 ERR("write error on thread quit pipe");
586 if (notify_health_quit_pipe(health_quit_pipe
)) {
587 ERR("write error on health quit pipe");
590 /* Dispatch thread */
591 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
592 futex_nto1_wake(&relay_conn_queue
.futex
);
594 if (relayd_live_stop()) {
595 ERR("Error stopping live threads");
602 * Signal handler for the daemon
604 * Simply stop all worker threads, leaving main() return gracefully after
605 * joining all threads and calling cleanup().
607 static void sighandler(int sig
)
611 DBG("SIGINT caught");
612 if (lttng_relay_stop_threads()) {
613 ERR("Error stopping threads");
617 DBG("SIGTERM caught");
618 if (lttng_relay_stop_threads()) {
619 ERR("Error stopping threads");
623 CMM_STORE_SHARED(recv_child_signal
, 1);
631 * Setup signal handler for :
632 * SIGINT, SIGTERM, SIGPIPE
634 static int set_signal_handler(void)
640 if ((ret
= sigemptyset(&sigset
)) < 0) {
641 PERROR("sigemptyset");
648 sa
.sa_handler
= sighandler
;
649 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
654 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
659 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
664 sa
.sa_handler
= SIG_IGN
;
665 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
670 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
675 void lttng_relay_notify_ready(void)
677 /* Notify the parent of the fork() process that we are ready. */
678 if (opt_daemon
|| opt_background
) {
679 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
680 kill(child_ppid
, SIGUSR1
);
686 * Init thread quit pipe.
688 * Return -1 on error or 0 if all pipes are created.
690 static int init_thread_quit_pipe(void)
694 ret
= utils_create_pipe_cloexec(thread_quit_pipe
);
700 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
702 static int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
706 if (events
== NULL
|| size
== 0) {
711 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
717 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
729 * Check if the thread quit pipe was triggered.
731 * Return 1 if it was triggered else 0;
733 static int check_thread_quit_pipe(int fd
, uint32_t events
)
735 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
743 * Create and init socket from uri.
745 static struct lttcomm_sock
*relay_socket_create(struct lttng_uri
*uri
)
748 struct lttcomm_sock
*sock
= NULL
;
750 sock
= lttcomm_alloc_sock_from_uri(uri
);
752 ERR("Allocating socket");
756 ret
= lttcomm_create_sock(sock
);
760 DBG("Listening on sock %d", sock
->fd
);
762 ret
= sock
->ops
->bind(sock
);
764 PERROR("Failed to bind socket");
768 ret
= sock
->ops
->listen(sock
, -1);
778 lttcomm_destroy_sock(sock
);
784 * This thread manages the listening for new connections on the network
786 static void *relay_thread_listener(void *data
)
788 int i
, ret
, pollfd
, err
= -1;
789 uint32_t revents
, nb_fd
;
790 struct lttng_poll_event events
;
791 struct lttcomm_sock
*control_sock
, *data_sock
;
793 DBG("[thread] Relay listener started");
795 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
797 health_code_update();
799 control_sock
= relay_socket_create(control_uri
);
801 goto error_sock_control
;
804 data_sock
= relay_socket_create(data_uri
);
806 goto error_sock_relay
;
810 * Pass 3 as size here for the thread quit pipe, control and
813 ret
= create_thread_poll_set(&events
, 3);
815 goto error_create_poll
;
818 /* Add the control socket */
819 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
824 /* Add the data socket */
825 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
830 lttng_relay_notify_ready();
832 if (testpoint(relayd_thread_listener
)) {
833 goto error_testpoint
;
837 health_code_update();
839 DBG("Listener accepting connections");
843 ret
= lttng_poll_wait(&events
, -1);
847 * Restart interrupted system call.
849 if (errno
== EINTR
) {
857 DBG("Relay new connection received");
858 for (i
= 0; i
< nb_fd
; i
++) {
859 health_code_update();
861 /* Fetch once the poll data */
862 revents
= LTTNG_POLL_GETEV(&events
, i
);
863 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
865 /* Thread quit pipe has been closed. Killing thread. */
866 ret
= check_thread_quit_pipe(pollfd
, revents
);
872 if (revents
& LPOLLIN
) {
874 * A new connection is requested, therefore a
875 * sessiond/consumerd connection is allocated in
876 * this thread, enqueued to a global queue and
877 * dequeued (and freed) in the worker thread.
880 struct relay_connection
*new_conn
;
881 struct lttcomm_sock
*newsock
;
882 enum connection_type type
;
884 if (pollfd
== data_sock
->fd
) {
886 newsock
= data_sock
->ops
->accept(data_sock
);
887 DBG("Relay data connection accepted, socket %d",
890 assert(pollfd
== control_sock
->fd
);
891 type
= RELAY_CONTROL
;
892 newsock
= control_sock
->ops
->accept(control_sock
);
893 DBG("Relay control connection accepted, socket %d",
897 PERROR("accepting sock");
901 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
904 PERROR("setsockopt inet");
905 lttcomm_destroy_sock(newsock
);
909 ret
= socket_apply_keep_alive_config(newsock
->fd
);
911 ERR("Failed to apply TCP keep-alive configuration on socket (%i)",
913 lttcomm_destroy_sock(newsock
);
917 new_conn
= connection_create(newsock
, type
);
919 lttcomm_destroy_sock(newsock
);
923 /* Enqueue request for the dispatcher thread. */
924 cds_wfcq_enqueue(&relay_conn_queue
.head
, &relay_conn_queue
.tail
,
928 * Wake the dispatch queue futex.
929 * Implicit memory barrier with the
930 * exchange in cds_wfcq_enqueue.
932 futex_nto1_wake(&relay_conn_queue
.futex
);
933 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
934 ERR("socket poll error");
937 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
947 lttng_poll_clean(&events
);
949 if (data_sock
->fd
>= 0) {
950 ret
= data_sock
->ops
->close(data_sock
);
955 lttcomm_destroy_sock(data_sock
);
957 if (control_sock
->fd
>= 0) {
958 ret
= control_sock
->ops
->close(control_sock
);
963 lttcomm_destroy_sock(control_sock
);
967 ERR("Health error occurred in %s", __func__
);
969 health_unregister(health_relayd
);
970 DBG("Relay listener thread cleanup complete");
971 lttng_relay_stop_threads();
976 * This thread manages the dispatching of the requests to worker threads
978 static void *relay_thread_dispatcher(void *data
)
982 struct cds_wfcq_node
*node
;
983 struct relay_connection
*new_conn
= NULL
;
985 DBG("[thread] Relay dispatcher started");
987 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
989 if (testpoint(relayd_thread_dispatcher
)) {
990 goto error_testpoint
;
993 health_code_update();
996 health_code_update();
998 /* Atomically prepare the queue futex */
999 futex_nto1_prepare(&relay_conn_queue
.futex
);
1001 if (CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1006 health_code_update();
1008 /* Dequeue commands */
1009 node
= cds_wfcq_dequeue_blocking(&relay_conn_queue
.head
,
1010 &relay_conn_queue
.tail
);
1012 DBG("Woken up but nothing in the relay command queue");
1013 /* Continue thread execution */
1016 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
1018 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
1021 * Inform worker thread of the new request. This
1022 * call is blocking so we can be assured that
1023 * the data will be read at some point in time
1024 * or wait to the end of the world :)
1026 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
1028 PERROR("write connection pipe");
1029 connection_put(new_conn
);
1032 } while (node
!= NULL
);
1034 /* Futex wait on queue. Blocking call on futex() */
1035 health_poll_entry();
1036 futex_nto1_wait(&relay_conn_queue
.futex
);
1040 /* Normal exit, no error */
1047 ERR("Health error occurred in %s", __func__
);
1049 health_unregister(health_relayd
);
1050 DBG("Dispatch thread dying");
1051 lttng_relay_stop_threads();
1055 static bool session_streams_have_index(const struct relay_session
*session
)
1057 return session
->minor
>= 4 && !session
->snapshot
;
1061 * Handle the RELAYD_CREATE_SESSION command.
1063 * On success, send back the session id or else return a negative value.
1065 static int relay_create_session(const struct lttcomm_relayd_hdr
*recv_hdr
,
1066 struct relay_connection
*conn
,
1067 const struct lttng_buffer_view
*payload
)
1071 struct relay_session
*session
= NULL
;
1072 struct lttcomm_relayd_create_session_reply_2_11 reply
= {};
1073 char session_name
[LTTNG_NAME_MAX
] = {};
1074 char hostname
[LTTNG_HOST_NAME_MAX
] = {};
1075 uint32_t live_timer
= 0;
1076 bool snapshot
= false;
1077 bool session_name_contains_creation_timestamp
= false;
1078 /* Left nil for peers < 2.11. */
1079 char base_path
[LTTNG_PATH_MAX
] = {};
1080 lttng_uuid sessiond_uuid
= {};
1081 LTTNG_OPTIONAL(uint64_t) id_sessiond
= {};
1082 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1083 LTTNG_OPTIONAL(time_t) creation_time
= {};
1084 struct lttng_dynamic_buffer reply_payload
;
1086 lttng_dynamic_buffer_init(&reply_payload
);
1088 if (conn
->minor
< 4) {
1089 /* From 2.1 to 2.3 */
1091 } else if (conn
->minor
>= 4 && conn
->minor
< 11) {
1092 /* From 2.4 to 2.10 */
1093 ret
= cmd_create_session_2_4(payload
, session_name
,
1094 hostname
, &live_timer
, &snapshot
);
1096 bool has_current_chunk
;
1097 uint64_t current_chunk_id_value
;
1098 time_t creation_time_value
;
1099 uint64_t id_sessiond_value
;
1101 /* From 2.11 to ... */
1102 ret
= cmd_create_session_2_11(payload
, session_name
, hostname
,
1103 base_path
, &live_timer
, &snapshot
, &id_sessiond_value
,
1104 sessiond_uuid
, &has_current_chunk
,
1105 ¤t_chunk_id_value
, &creation_time_value
,
1106 &session_name_contains_creation_timestamp
);
1107 if (lttng_uuid_is_nil(sessiond_uuid
)) {
1108 /* The nil UUID is reserved for pre-2.11 clients. */
1109 ERR("Illegal nil UUID announced by peer in create session command");
1113 LTTNG_OPTIONAL_SET(&id_sessiond
, id_sessiond_value
);
1114 LTTNG_OPTIONAL_SET(&creation_time
, creation_time_value
);
1115 if (has_current_chunk
) {
1116 LTTNG_OPTIONAL_SET(¤t_chunk_id
,
1117 current_chunk_id_value
);
1125 session
= session_create(session_name
, hostname
, base_path
, live_timer
,
1126 snapshot
, sessiond_uuid
,
1127 id_sessiond
.is_set
? &id_sessiond
.value
: NULL
,
1128 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1129 creation_time
.is_set
? &creation_time
.value
: NULL
,
1130 conn
->major
, conn
->minor
,
1131 session_name_contains_creation_timestamp
);
1136 assert(!conn
->session
);
1137 conn
->session
= session
;
1138 DBG("Created session %" PRIu64
, session
->id
);
1140 reply
.generic
.session_id
= htobe64(session
->id
);
1144 reply
.generic
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1146 reply
.generic
.ret_code
= htobe32(LTTNG_OK
);
1149 if (conn
->minor
< 11) {
1150 /* From 2.1 to 2.10 */
1151 ret
= lttng_dynamic_buffer_append(&reply_payload
,
1152 &reply
.generic
, sizeof(reply
.generic
));
1154 ERR("Failed to append \"create session\" command reply header to payload buffer");
1159 const uint32_t output_path_length
=
1160 strlen(session
->output_path
) + 1;
1162 reply
.output_path_length
= htobe32(output_path_length
);
1163 ret
= lttng_dynamic_buffer_append(&reply_payload
, &reply
,
1166 ERR("Failed to append \"create session\" command reply header to payload buffer");
1170 ret
= lttng_dynamic_buffer_append(&reply_payload
,
1171 session
->output_path
, output_path_length
);
1173 ERR("Failed to append \"create session\" command reply path to payload buffer");
1178 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, reply_payload
.data
,
1179 reply_payload
.size
, 0);
1180 if (send_ret
< (ssize_t
) reply_payload
.size
) {
1181 ERR("Failed to send \"create session\" command reply of %zu bytes (ret = %zd)",
1182 reply_payload
.size
, send_ret
);
1186 if (ret
< 0 && session
) {
1187 session_put(session
);
1189 lttng_dynamic_buffer_reset(&reply_payload
);
1194 * When we have received all the streams and the metadata for a channel,
1195 * we make them visible to the viewer threads.
1197 static void publish_connection_local_streams(struct relay_connection
*conn
)
1199 struct relay_stream
*stream
;
1200 struct relay_session
*session
= conn
->session
;
1203 * We publish all streams belonging to a session atomically wrt
1206 pthread_mutex_lock(&session
->lock
);
1208 cds_list_for_each_entry_rcu(stream
, &session
->recv_list
,
1210 stream_publish(stream
);
1215 * Inform the viewer that there are new streams in the session.
1217 if (session
->viewer_attached
) {
1218 uatomic_set(&session
->new_streams
, 1);
1220 pthread_mutex_unlock(&session
->lock
);
1223 static int conform_channel_path(char *channel_path
)
1227 if (strstr("../", channel_path
)) {
1228 ERR("Refusing channel path as it walks up the path hierarchy: \"%s\"",
1234 if (*channel_path
== '/') {
1235 const size_t len
= strlen(channel_path
);
1238 * Channel paths from peers prior to 2.11 are expressed as an
1239 * absolute path that is, in reality, relative to the relay
1240 * daemon's output directory. Remove the leading slash so it
1241 * is correctly interpreted as a relative path later on.
1243 * len (and not len - 1) is used to copy the trailing NULL.
1245 bcopy(channel_path
+ 1, channel_path
, len
);
1252 * relay_add_stream: allocate a new stream for a session
1254 static int relay_add_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1255 struct relay_connection
*conn
,
1256 const struct lttng_buffer_view
*payload
)
1260 struct relay_session
*session
= conn
->session
;
1261 struct relay_stream
*stream
= NULL
;
1262 struct lttcomm_relayd_status_stream reply
;
1263 struct ctf_trace
*trace
= NULL
;
1264 uint64_t stream_handle
= -1ULL;
1265 char *path_name
= NULL
, *channel_name
= NULL
;
1266 uint64_t tracefile_size
= 0, tracefile_count
= 0;
1267 LTTNG_OPTIONAL(uint64_t) stream_chunk_id
= {};
1269 if (!session
|| !conn
->version_check_done
) {
1270 ERR("Trying to add a stream before version check");
1272 goto end_no_session
;
1275 if (session
->minor
== 1) {
1277 ret
= cmd_recv_stream_2_1(payload
, &path_name
,
1279 } else if (session
->minor
> 1 && session
->minor
< 11) {
1280 /* From 2.2 to 2.10 */
1281 ret
= cmd_recv_stream_2_2(payload
, &path_name
,
1282 &channel_name
, &tracefile_size
, &tracefile_count
);
1284 /* From 2.11 to ... */
1285 ret
= cmd_recv_stream_2_11(payload
, &path_name
,
1286 &channel_name
, &tracefile_size
, &tracefile_count
,
1287 &stream_chunk_id
.value
);
1288 stream_chunk_id
.is_set
= true;
1295 if (conform_channel_path(path_name
)) {
1299 trace
= ctf_trace_get_by_path_or_create(session
, path_name
);
1303 /* This stream here has one reference on the trace. */
1305 pthread_mutex_lock(&last_relay_stream_id_lock
);
1306 stream_handle
= ++last_relay_stream_id
;
1307 pthread_mutex_unlock(&last_relay_stream_id_lock
);
1309 /* We pass ownership of path_name and channel_name. */
1310 stream
= stream_create(trace
, stream_handle
, path_name
,
1311 channel_name
, tracefile_size
, tracefile_count
);
1313 channel_name
= NULL
;
1316 * Streams are the owners of their trace. Reference to trace is
1317 * kept within stream_create().
1319 ctf_trace_put(trace
);
1322 memset(&reply
, 0, sizeof(reply
));
1323 reply
.handle
= htobe64(stream_handle
);
1325 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1327 reply
.ret_code
= htobe32(LTTNG_OK
);
1330 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1331 sizeof(struct lttcomm_relayd_status_stream
), 0);
1332 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1333 ERR("Failed to send \"add stream\" command reply (ret = %zd)",
1345 * relay_close_stream: close a specific stream
1347 static int relay_close_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1348 struct relay_connection
*conn
,
1349 const struct lttng_buffer_view
*payload
)
1353 struct relay_session
*session
= conn
->session
;
1354 struct lttcomm_relayd_close_stream stream_info
;
1355 struct lttcomm_relayd_generic_reply reply
;
1356 struct relay_stream
*stream
;
1358 DBG("Close stream received");
1360 if (!session
|| !conn
->version_check_done
) {
1361 ERR("Trying to close a stream before version check");
1363 goto end_no_session
;
1366 if (payload
->size
< sizeof(stream_info
)) {
1367 ERR("Unexpected payload size in \"relay_close_stream\": expected >= %zu bytes, got %zu bytes",
1368 sizeof(stream_info
), payload
->size
);
1370 goto end_no_session
;
1372 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1373 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1374 stream_info
.last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1376 stream
= stream_get_by_id(stream_info
.stream_id
);
1383 * Set last_net_seq_num before the close flag. Required by data
1386 pthread_mutex_lock(&stream
->lock
);
1387 stream
->last_net_seq_num
= stream_info
.last_net_seq_num
;
1388 pthread_mutex_unlock(&stream
->lock
);
1391 * This is one of the conditions which may trigger a stream close
1392 * with the others being:
1393 * 1) A close command is received for a stream
1394 * 2) The control connection owning the stream is closed
1395 * 3) We have received all of the stream's data _after_ a close
1398 try_stream_close(stream
);
1399 if (stream
->is_metadata
) {
1400 struct relay_viewer_stream
*vstream
;
1402 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
1404 if (vstream
->metadata_sent
== stream
->metadata_received
) {
1406 * Since all the metadata has been sent to the
1407 * viewer and that we have a request to close
1408 * its stream, we can safely teardown the
1409 * corresponding metadata viewer stream.
1411 viewer_stream_put(vstream
);
1413 /* Put local reference. */
1414 viewer_stream_put(vstream
);
1421 memset(&reply
, 0, sizeof(reply
));
1423 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1425 reply
.ret_code
= htobe32(LTTNG_OK
);
1427 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1428 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1429 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1430 ERR("Failed to send \"close stream\" command reply (ret = %zd)",
1440 * relay_reset_metadata: reset a metadata stream
1443 int relay_reset_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1444 struct relay_connection
*conn
,
1445 const struct lttng_buffer_view
*payload
)
1449 struct relay_session
*session
= conn
->session
;
1450 struct lttcomm_relayd_reset_metadata stream_info
;
1451 struct lttcomm_relayd_generic_reply reply
;
1452 struct relay_stream
*stream
;
1454 DBG("Reset metadata received");
1456 if (!session
|| !conn
->version_check_done
) {
1457 ERR("Trying to reset a metadata stream before version check");
1459 goto end_no_session
;
1462 if (payload
->size
< sizeof(stream_info
)) {
1463 ERR("Unexpected payload size in \"relay_reset_metadata\": expected >= %zu bytes, got %zu bytes",
1464 sizeof(stream_info
), payload
->size
);
1466 goto end_no_session
;
1468 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1469 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1470 stream_info
.version
= be64toh(stream_info
.version
);
1472 DBG("Update metadata to version %" PRIu64
, stream_info
.version
);
1474 /* Unsupported for live sessions for now. */
1475 if (session
->live_timer
!= 0) {
1480 stream
= stream_get_by_id(stream_info
.stream_id
);
1485 pthread_mutex_lock(&stream
->lock
);
1486 if (!stream
->is_metadata
) {
1491 ret
= stream_reset_file(stream
);
1493 ERR("Failed to reset metadata stream %" PRIu64
1494 ": stream_path = %s, channel = %s",
1495 stream
->stream_handle
, stream
->path_name
,
1496 stream
->channel_name
);
1500 pthread_mutex_unlock(&stream
->lock
);
1504 memset(&reply
, 0, sizeof(reply
));
1506 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1508 reply
.ret_code
= htobe32(LTTNG_OK
);
1510 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1511 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1512 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1513 ERR("Failed to send \"reset metadata\" command reply (ret = %zd)",
1523 * relay_unknown_command: send -1 if received unknown command
1525 static void relay_unknown_command(struct relay_connection
*conn
)
1527 struct lttcomm_relayd_generic_reply reply
;
1530 memset(&reply
, 0, sizeof(reply
));
1531 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1532 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1533 if (send_ret
< sizeof(reply
)) {
1534 ERR("Failed to send \"unknown command\" command reply (ret = %zd)", send_ret
);
1539 * relay_start: send an acknowledgment to the client to tell if we are
1540 * ready to receive data. We are ready if a session is established.
1542 static int relay_start(const struct lttcomm_relayd_hdr
*recv_hdr
,
1543 struct relay_connection
*conn
,
1544 const struct lttng_buffer_view
*payload
)
1548 struct lttcomm_relayd_generic_reply reply
;
1549 struct relay_session
*session
= conn
->session
;
1552 DBG("Trying to start the streaming without a session established");
1553 ret
= htobe32(LTTNG_ERR_UNK
);
1556 memset(&reply
, 0, sizeof(reply
));
1557 reply
.ret_code
= htobe32(LTTNG_OK
);
1558 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1560 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1561 ERR("Failed to send \"relay_start\" command reply (ret = %zd)",
1570 * relay_recv_metadata: receive the metadata for the session.
1572 static int relay_recv_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1573 struct relay_connection
*conn
,
1574 const struct lttng_buffer_view
*payload
)
1577 struct relay_session
*session
= conn
->session
;
1578 struct lttcomm_relayd_metadata_payload metadata_payload_header
;
1579 struct relay_stream
*metadata_stream
;
1580 uint64_t metadata_payload_size
;
1581 struct lttng_buffer_view packet_view
;
1584 ERR("Metadata sent before version check");
1589 if (recv_hdr
->data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1590 ERR("Incorrect data size");
1594 metadata_payload_size
= recv_hdr
->data_size
-
1595 sizeof(struct lttcomm_relayd_metadata_payload
);
1597 memcpy(&metadata_payload_header
, payload
->data
,
1598 sizeof(metadata_payload_header
));
1599 metadata_payload_header
.stream_id
= be64toh(
1600 metadata_payload_header
.stream_id
);
1601 metadata_payload_header
.padding_size
= be32toh(
1602 metadata_payload_header
.padding_size
);
1604 metadata_stream
= stream_get_by_id(metadata_payload_header
.stream_id
);
1605 if (!metadata_stream
) {
1610 packet_view
= lttng_buffer_view_from_view(payload
,
1611 sizeof(metadata_payload_header
), metadata_payload_size
);
1612 if (!packet_view
.data
) {
1613 ERR("Invalid metadata packet length announced by header");
1618 pthread_mutex_lock(&metadata_stream
->lock
);
1619 ret
= stream_write(metadata_stream
, &packet_view
,
1620 metadata_payload_header
.padding_size
);
1621 pthread_mutex_unlock(&metadata_stream
->lock
);
1627 stream_put(metadata_stream
);
1633 * relay_send_version: send relayd version number
1635 static int relay_send_version(const struct lttcomm_relayd_hdr
*recv_hdr
,
1636 struct relay_connection
*conn
,
1637 const struct lttng_buffer_view
*payload
)
1641 struct lttcomm_relayd_version reply
, msg
;
1642 bool compatible
= true;
1644 conn
->version_check_done
= true;
1646 /* Get version from the other side. */
1647 if (payload
->size
< sizeof(msg
)) {
1648 ERR("Unexpected payload size in \"relay_send_version\": expected >= %zu bytes, got %zu bytes",
1649 sizeof(msg
), payload
->size
);
1654 memcpy(&msg
, payload
->data
, sizeof(msg
));
1655 msg
.major
= be32toh(msg
.major
);
1656 msg
.minor
= be32toh(msg
.minor
);
1658 memset(&reply
, 0, sizeof(reply
));
1659 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
1660 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
1662 /* Major versions must be the same */
1663 if (reply
.major
!= msg
.major
) {
1664 DBG("Incompatible major versions (%u vs %u), deleting session",
1665 reply
.major
, msg
.major
);
1669 conn
->major
= reply
.major
;
1670 /* We adapt to the lowest compatible version */
1671 if (reply
.minor
<= msg
.minor
) {
1672 conn
->minor
= reply
.minor
;
1674 conn
->minor
= msg
.minor
;
1677 reply
.major
= htobe32(reply
.major
);
1678 reply
.minor
= htobe32(reply
.minor
);
1679 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1681 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1682 ERR("Failed to send \"send version\" command reply (ret = %zd)",
1695 DBG("Version check done using protocol %u.%u", conn
->major
,
1703 * Check for data pending for a given stream id from the session daemon.
1705 static int relay_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
1706 struct relay_connection
*conn
,
1707 const struct lttng_buffer_view
*payload
)
1709 struct relay_session
*session
= conn
->session
;
1710 struct lttcomm_relayd_data_pending msg
;
1711 struct lttcomm_relayd_generic_reply reply
;
1712 struct relay_stream
*stream
;
1715 uint64_t stream_seq
;
1717 DBG("Data pending command received");
1719 if (!session
|| !conn
->version_check_done
) {
1720 ERR("Trying to check for data before version check");
1722 goto end_no_session
;
1725 if (payload
->size
< sizeof(msg
)) {
1726 ERR("Unexpected payload size in \"relay_data_pending\": expected >= %zu bytes, got %zu bytes",
1727 sizeof(msg
), payload
->size
);
1729 goto end_no_session
;
1731 memcpy(&msg
, payload
->data
, sizeof(msg
));
1732 msg
.stream_id
= be64toh(msg
.stream_id
);
1733 msg
.last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
1735 stream
= stream_get_by_id(msg
.stream_id
);
1736 if (stream
== NULL
) {
1741 pthread_mutex_lock(&stream
->lock
);
1743 if (session_streams_have_index(session
)) {
1745 * Ensure that both the index and stream data have been
1746 * flushed up to the requested point.
1748 stream_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
1750 stream_seq
= stream
->prev_data_seq
;
1752 DBG("Data pending for stream id %" PRIu64
": prev_data_seq %" PRIu64
1753 ", prev_index_seq %" PRIu64
1754 ", and last_seq %" PRIu64
, msg
.stream_id
,
1755 stream
->prev_data_seq
, stream
->prev_index_seq
,
1756 msg
.last_net_seq_num
);
1758 /* Avoid wrapping issue */
1759 if (((int64_t) (stream_seq
- msg
.last_net_seq_num
)) >= 0) {
1760 /* Data has in fact been written and is NOT pending */
1763 /* Data still being streamed thus pending */
1767 stream
->data_pending_check_done
= true;
1768 pthread_mutex_unlock(&stream
->lock
);
1773 memset(&reply
, 0, sizeof(reply
));
1774 reply
.ret_code
= htobe32(ret
);
1775 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1776 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1777 ERR("Failed to send \"data pending\" command reply (ret = %zd)",
1787 * Wait for the control socket to reach a quiescent state.
1789 * Note that for now, when receiving this command from the session
1790 * daemon, this means that every subsequent commands or data received on
1791 * the control socket has been handled. So, this is why we simply return
1794 static int relay_quiescent_control(const struct lttcomm_relayd_hdr
*recv_hdr
,
1795 struct relay_connection
*conn
,
1796 const struct lttng_buffer_view
*payload
)
1800 struct relay_stream
*stream
;
1801 struct lttcomm_relayd_quiescent_control msg
;
1802 struct lttcomm_relayd_generic_reply reply
;
1804 DBG("Checking quiescent state on control socket");
1806 if (!conn
->session
|| !conn
->version_check_done
) {
1807 ERR("Trying to check for data before version check");
1809 goto end_no_session
;
1812 if (payload
->size
< sizeof(msg
)) {
1813 ERR("Unexpected payload size in \"relay_quiescent_control\": expected >= %zu bytes, got %zu bytes",
1814 sizeof(msg
), payload
->size
);
1816 goto end_no_session
;
1818 memcpy(&msg
, payload
->data
, sizeof(msg
));
1819 msg
.stream_id
= be64toh(msg
.stream_id
);
1821 stream
= stream_get_by_id(msg
.stream_id
);
1825 pthread_mutex_lock(&stream
->lock
);
1826 stream
->data_pending_check_done
= true;
1827 pthread_mutex_unlock(&stream
->lock
);
1829 DBG("Relay quiescent control pending flag set to %" PRIu64
, msg
.stream_id
);
1832 memset(&reply
, 0, sizeof(reply
));
1833 reply
.ret_code
= htobe32(LTTNG_OK
);
1834 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1835 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1836 ERR("Failed to send \"quiescent control\" command reply (ret = %zd)",
1848 * Initialize a data pending command. This means that a consumer is about
1849 * to ask for data pending for each stream it holds. Simply iterate over
1850 * all streams of a session and set the data_pending_check_done flag.
1852 * This command returns to the client a LTTNG_OK code.
1854 static int relay_begin_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
1855 struct relay_connection
*conn
,
1856 const struct lttng_buffer_view
*payload
)
1860 struct lttng_ht_iter iter
;
1861 struct lttcomm_relayd_begin_data_pending msg
;
1862 struct lttcomm_relayd_generic_reply reply
;
1863 struct relay_stream
*stream
;
1868 DBG("Init streams for data pending");
1870 if (!conn
->session
|| !conn
->version_check_done
) {
1871 ERR("Trying to check for data before version check");
1873 goto end_no_session
;
1876 if (payload
->size
< sizeof(msg
)) {
1877 ERR("Unexpected payload size in \"relay_begin_data_pending\": expected >= %zu bytes, got %zu bytes",
1878 sizeof(msg
), payload
->size
);
1880 goto end_no_session
;
1882 memcpy(&msg
, payload
->data
, sizeof(msg
));
1883 msg
.session_id
= be64toh(msg
.session_id
);
1886 * Iterate over all streams to set the begin data pending flag.
1887 * For now, the streams are indexed by stream handle so we have
1888 * to iterate over all streams to find the one associated with
1889 * the right session_id.
1892 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1894 if (!stream_get(stream
)) {
1897 if (stream
->trace
->session
->id
== msg
.session_id
) {
1898 pthread_mutex_lock(&stream
->lock
);
1899 stream
->data_pending_check_done
= false;
1900 pthread_mutex_unlock(&stream
->lock
);
1901 DBG("Set begin data pending flag to stream %" PRIu64
,
1902 stream
->stream_handle
);
1908 memset(&reply
, 0, sizeof(reply
));
1909 /* All good, send back reply. */
1910 reply
.ret_code
= htobe32(LTTNG_OK
);
1912 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1913 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1914 ERR("Failed to send \"begin data pending\" command reply (ret = %zd)",
1926 * End data pending command. This will check, for a given session id, if
1927 * each stream associated with it has its data_pending_check_done flag
1928 * set. If not, this means that the client lost track of the stream but
1929 * the data is still being streamed on our side. In this case, we inform
1930 * the client that data is in flight.
1932 * Return to the client if there is data in flight or not with a ret_code.
1934 static int relay_end_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
1935 struct relay_connection
*conn
,
1936 const struct lttng_buffer_view
*payload
)
1940 struct lttng_ht_iter iter
;
1941 struct lttcomm_relayd_end_data_pending msg
;
1942 struct lttcomm_relayd_generic_reply reply
;
1943 struct relay_stream
*stream
;
1944 uint32_t is_data_inflight
= 0;
1946 DBG("End data pending command");
1948 if (!conn
->session
|| !conn
->version_check_done
) {
1949 ERR("Trying to check for data before version check");
1951 goto end_no_session
;
1954 if (payload
->size
< sizeof(msg
)) {
1955 ERR("Unexpected payload size in \"relay_end_data_pending\": expected >= %zu bytes, got %zu bytes",
1956 sizeof(msg
), payload
->size
);
1958 goto end_no_session
;
1960 memcpy(&msg
, payload
->data
, sizeof(msg
));
1961 msg
.session_id
= be64toh(msg
.session_id
);
1964 * Iterate over all streams to see if the begin data pending
1968 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1970 if (!stream_get(stream
)) {
1973 if (stream
->trace
->session
->id
!= msg
.session_id
) {
1977 pthread_mutex_lock(&stream
->lock
);
1978 if (!stream
->data_pending_check_done
) {
1979 uint64_t stream_seq
;
1981 if (session_streams_have_index(conn
->session
)) {
1983 * Ensure that both the index and stream data have been
1984 * flushed up to the requested point.
1986 stream_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
1988 stream_seq
= stream
->prev_data_seq
;
1990 if (!stream
->closed
|| !(((int64_t) (stream_seq
- stream
->last_net_seq_num
)) >= 0)) {
1991 is_data_inflight
= 1;
1992 DBG("Data is still in flight for stream %" PRIu64
,
1993 stream
->stream_handle
);
1994 pthread_mutex_unlock(&stream
->lock
);
1999 pthread_mutex_unlock(&stream
->lock
);
2004 memset(&reply
, 0, sizeof(reply
));
2005 /* All good, send back reply. */
2006 reply
.ret_code
= htobe32(is_data_inflight
);
2008 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2009 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2010 ERR("Failed to send \"end data pending\" command reply (ret = %zd)",
2022 * Receive an index for a specific stream.
2024 * Return 0 on success else a negative value.
2026 static int relay_recv_index(const struct lttcomm_relayd_hdr
*recv_hdr
,
2027 struct relay_connection
*conn
,
2028 const struct lttng_buffer_view
*payload
)
2032 struct relay_session
*session
= conn
->session
;
2033 struct lttcomm_relayd_index index_info
;
2034 struct lttcomm_relayd_generic_reply reply
;
2035 struct relay_stream
*stream
;
2040 DBG("Relay receiving index");
2042 if (!session
|| !conn
->version_check_done
) {
2043 ERR("Trying to close a stream before version check");
2045 goto end_no_session
;
2048 msg_len
= lttcomm_relayd_index_len(
2049 lttng_to_index_major(conn
->major
, conn
->minor
),
2050 lttng_to_index_minor(conn
->major
, conn
->minor
));
2051 if (payload
->size
< msg_len
) {
2052 ERR("Unexpected payload size in \"relay_recv_index\": expected >= %zu bytes, got %zu bytes",
2053 msg_len
, payload
->size
);
2055 goto end_no_session
;
2057 memcpy(&index_info
, payload
->data
, msg_len
);
2058 index_info
.relay_stream_id
= be64toh(index_info
.relay_stream_id
);
2059 index_info
.net_seq_num
= be64toh(index_info
.net_seq_num
);
2060 index_info
.packet_size
= be64toh(index_info
.packet_size
);
2061 index_info
.content_size
= be64toh(index_info
.content_size
);
2062 index_info
.timestamp_begin
= be64toh(index_info
.timestamp_begin
);
2063 index_info
.timestamp_end
= be64toh(index_info
.timestamp_end
);
2064 index_info
.events_discarded
= be64toh(index_info
.events_discarded
);
2065 index_info
.stream_id
= be64toh(index_info
.stream_id
);
2067 if (conn
->minor
>= 8) {
2068 index_info
.stream_instance_id
=
2069 be64toh(index_info
.stream_instance_id
);
2070 index_info
.packet_seq_num
= be64toh(index_info
.packet_seq_num
);
2073 stream
= stream_get_by_id(index_info
.relay_stream_id
);
2075 ERR("stream_get_by_id not found");
2080 pthread_mutex_lock(&stream
->lock
);
2081 ret
= stream_add_index(stream
, &index_info
);
2082 pthread_mutex_unlock(&stream
->lock
);
2084 goto end_stream_put
;
2090 memset(&reply
, 0, sizeof(reply
));
2092 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2094 reply
.ret_code
= htobe32(LTTNG_OK
);
2096 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2097 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2098 ERR("Failed to send \"recv index\" command reply (ret = %zd)", send_ret
);
2107 * Receive the streams_sent message.
2109 * Return 0 on success else a negative value.
2111 static int relay_streams_sent(const struct lttcomm_relayd_hdr
*recv_hdr
,
2112 struct relay_connection
*conn
,
2113 const struct lttng_buffer_view
*payload
)
2117 struct lttcomm_relayd_generic_reply reply
;
2121 DBG("Relay receiving streams_sent");
2123 if (!conn
->session
|| !conn
->version_check_done
) {
2124 ERR("Trying to close a stream before version check");
2126 goto end_no_session
;
2130 * Publish every pending stream in the connection recv list which are
2131 * now ready to be used by the viewer.
2133 publish_connection_local_streams(conn
);
2135 memset(&reply
, 0, sizeof(reply
));
2136 reply
.ret_code
= htobe32(LTTNG_OK
);
2137 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2138 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2139 ERR("Failed to send \"streams sent\" command reply (ret = %zd)",
2152 * relay_rotate_session_stream: rotate a stream to a new tracefile for the
2153 * session rotation feature (not the tracefile rotation feature).
2155 static int relay_rotate_session_streams(
2156 const struct lttcomm_relayd_hdr
*recv_hdr
,
2157 struct relay_connection
*conn
,
2158 const struct lttng_buffer_view
*payload
)
2163 enum lttng_error_code reply_code
= LTTNG_ERR_UNK
;
2164 struct relay_session
*session
= conn
->session
;
2165 struct lttcomm_relayd_rotate_streams rotate_streams
;
2166 struct lttcomm_relayd_generic_reply reply
= {};
2167 struct relay_stream
*stream
= NULL
;
2168 const size_t header_len
= sizeof(struct lttcomm_relayd_rotate_streams
);
2169 struct lttng_trace_chunk
*next_trace_chunk
= NULL
;
2170 struct lttng_buffer_view stream_positions
;
2171 char chunk_id_buf
[MAX_INT_DEC_LEN(uint64_t)];
2172 const char *chunk_id_str
= "none";
2174 if (!session
|| !conn
->version_check_done
) {
2175 ERR("Trying to rotate a stream before version check");
2180 if (session
->major
== 2 && session
->minor
< 11) {
2181 ERR("Unsupported feature before 2.11");
2186 if (payload
->size
< header_len
) {
2187 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected >= %zu bytes, got %zu bytes",
2188 header_len
, payload
->size
);
2193 memcpy(&rotate_streams
, payload
->data
, header_len
);
2195 /* Convert header to host endianness. */
2196 rotate_streams
= (typeof(rotate_streams
)) {
2197 .stream_count
= be32toh(rotate_streams
.stream_count
),
2198 .new_chunk_id
= (typeof(rotate_streams
.new_chunk_id
)) {
2199 .is_set
= !!rotate_streams
.new_chunk_id
.is_set
,
2200 .value
= be64toh(rotate_streams
.new_chunk_id
.value
),
2204 if (rotate_streams
.new_chunk_id
.is_set
) {
2206 * Retrieve the trace chunk the stream must transition to. As
2207 * per the protocol, this chunk should have been created
2208 * before this command is received.
2210 next_trace_chunk
= sessiond_trace_chunk_registry_get_chunk(
2211 sessiond_trace_chunk_registry
,
2212 session
->sessiond_uuid
, session
->id
,
2213 rotate_streams
.new_chunk_id
.value
);
2214 if (!next_trace_chunk
) {
2215 char uuid_str
[UUID_STR_LEN
];
2217 lttng_uuid_to_str(session
->sessiond_uuid
, uuid_str
);
2218 ERR("Unknown next trace chunk in ROTATE_STREAMS command: sessiond_uuid = {%s}, session_id = %" PRIu64
2219 ", trace_chunk_id = %" PRIu64
,
2220 uuid_str
, session
->id
,
2221 rotate_streams
.new_chunk_id
.value
);
2222 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2227 ret
= snprintf(chunk_id_buf
, sizeof(chunk_id_buf
), "%" PRIu64
,
2228 rotate_streams
.new_chunk_id
.value
);
2229 if (ret
< 0 || ret
>= sizeof(chunk_id_buf
)) {
2230 chunk_id_str
= "formatting error";
2232 chunk_id_str
= chunk_id_buf
;
2234 session
->has_rotated
= true;
2237 DBG("Rotate %" PRIu32
" streams of session \"%s\" to chunk \"%s\"",
2238 rotate_streams
.stream_count
, session
->session_name
,
2241 stream_positions
= lttng_buffer_view_from_view(payload
,
2242 sizeof(rotate_streams
), -1);
2243 if (!stream_positions
.data
||
2244 stream_positions
.size
<
2245 (rotate_streams
.stream_count
*
2246 sizeof(struct lttcomm_relayd_stream_rotation_position
))) {
2247 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2252 for (i
= 0; i
< rotate_streams
.stream_count
; i
++) {
2253 struct lttcomm_relayd_stream_rotation_position
*position_comm
=
2254 &((typeof(position_comm
)) stream_positions
.data
)[i
];
2255 const struct lttcomm_relayd_stream_rotation_position pos
= {
2256 .stream_id
= be64toh(position_comm
->stream_id
),
2257 .rotate_at_seq_num
= be64toh(
2258 position_comm
->rotate_at_seq_num
),
2261 stream
= stream_get_by_id(pos
.stream_id
);
2263 reply_code
= LTTNG_ERR_INVALID
;
2268 pthread_mutex_lock(&stream
->lock
);
2269 ret
= stream_set_pending_rotation(stream
, next_trace_chunk
,
2270 pos
.rotate_at_seq_num
);
2271 pthread_mutex_unlock(&stream
->lock
);
2273 reply_code
= LTTNG_ERR_FILE_CREATION_ERROR
;
2281 reply_code
= LTTNG_OK
;
2287 reply
.ret_code
= htobe32((uint32_t) reply_code
);
2288 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2289 sizeof(struct lttcomm_relayd_generic_reply
), 0);
2290 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2291 ERR("Failed to send \"rotate session stream\" command reply (ret = %zd)",
2298 lttng_trace_chunk_put(next_trace_chunk
);
2305 * relay_create_trace_chunk: create a new trace chunk
2307 static int relay_create_trace_chunk(const struct lttcomm_relayd_hdr
*recv_hdr
,
2308 struct relay_connection
*conn
,
2309 const struct lttng_buffer_view
*payload
)
2313 struct relay_session
*session
= conn
->session
;
2314 struct lttcomm_relayd_create_trace_chunk
*msg
;
2315 struct lttcomm_relayd_generic_reply reply
= {};
2316 struct lttng_buffer_view header_view
;
2317 struct lttng_buffer_view chunk_name_view
;
2318 struct lttng_trace_chunk
*chunk
= NULL
, *published_chunk
= NULL
;
2319 enum lttng_error_code reply_code
= LTTNG_OK
;
2320 enum lttng_trace_chunk_status chunk_status
;
2321 struct lttng_directory_handle session_output
;
2323 if (!session
|| !conn
->version_check_done
) {
2324 ERR("Trying to create a trace chunk before version check");
2329 if (session
->major
== 2 && session
->minor
< 11) {
2330 ERR("Chunk creation command is unsupported before 2.11");
2335 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
2336 if (!header_view
.data
) {
2337 ERR("Failed to receive payload of chunk creation command");
2342 /* Convert to host endianness. */
2343 msg
= (typeof(msg
)) header_view
.data
;
2344 msg
->chunk_id
= be64toh(msg
->chunk_id
);
2345 msg
->creation_timestamp
= be64toh(msg
->creation_timestamp
);
2346 msg
->override_name_length
= be32toh(msg
->override_name_length
);
2348 chunk
= lttng_trace_chunk_create(
2349 msg
->chunk_id
, msg
->creation_timestamp
);
2351 ERR("Failed to create trace chunk in trace chunk creation command");
2353 reply_code
= LTTNG_ERR_NOMEM
;
2357 if (msg
->override_name_length
) {
2360 chunk_name_view
= lttng_buffer_view_from_view(payload
,
2362 msg
->override_name_length
);
2363 name
= chunk_name_view
.data
;
2364 if (!name
|| name
[msg
->override_name_length
- 1]) {
2365 ERR("Failed to receive payload of chunk creation command");
2367 reply_code
= LTTNG_ERR_INVALID
;
2371 chunk_status
= lttng_trace_chunk_override_name(
2372 chunk
, chunk_name_view
.data
);
2373 switch (chunk_status
) {
2374 case LTTNG_TRACE_CHUNK_STATUS_OK
:
2376 case LTTNG_TRACE_CHUNK_STATUS_INVALID_ARGUMENT
:
2377 ERR("Failed to set the name of new trace chunk in trace chunk creation command (invalid name)");
2378 reply_code
= LTTNG_ERR_INVALID
;
2382 ERR("Failed to set the name of new trace chunk in trace chunk creation command (unknown error)");
2383 reply_code
= LTTNG_ERR_UNK
;
2389 chunk_status
= lttng_trace_chunk_set_credentials_current_user(chunk
);
2390 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2391 reply_code
= LTTNG_ERR_UNK
;
2396 ret
= session_init_output_directory_handle(
2397 conn
->session
, &session_output
);
2399 reply_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
2402 chunk_status
= lttng_trace_chunk_set_as_owner(chunk
, &session_output
);
2403 lttng_directory_handle_fini(&session_output
);
2404 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2405 reply_code
= LTTNG_ERR_UNK
;
2410 published_chunk
= sessiond_trace_chunk_registry_publish_chunk(
2411 sessiond_trace_chunk_registry
,
2412 conn
->session
->sessiond_uuid
,
2415 if (!published_chunk
) {
2416 char uuid_str
[UUID_STR_LEN
];
2418 lttng_uuid_to_str(conn
->session
->sessiond_uuid
, uuid_str
);
2419 ERR("Failed to publish chunk: sessiond_uuid = %s, session_id = %" PRIu64
", chunk_id = %" PRIu64
,
2424 reply_code
= LTTNG_ERR_NOMEM
;
2428 pthread_mutex_lock(&conn
->session
->lock
);
2429 if (conn
->session
->pending_closure_trace_chunk
) {
2431 * Invalid; this means a second create_trace_chunk command was
2432 * received before a close_trace_chunk.
2434 ERR("Invalid trace chunk close command received; a trace chunk is already waiting for a trace chunk close command");
2435 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2437 goto end_unlock_session
;
2439 conn
->session
->pending_closure_trace_chunk
=
2440 conn
->session
->current_trace_chunk
;
2441 conn
->session
->current_trace_chunk
= published_chunk
;
2442 published_chunk
= NULL
;
2444 pthread_mutex_unlock(&conn
->session
->lock
);
2446 reply
.ret_code
= htobe32((uint32_t) reply_code
);
2447 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
,
2449 sizeof(struct lttcomm_relayd_generic_reply
),
2451 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2452 ERR("Failed to send \"create trace chunk\" command reply (ret = %zd)",
2457 lttng_trace_chunk_put(chunk
);
2458 lttng_trace_chunk_put(published_chunk
);
2463 * relay_close_trace_chunk: close a trace chunk
2465 static int relay_close_trace_chunk(const struct lttcomm_relayd_hdr
*recv_hdr
,
2466 struct relay_connection
*conn
,
2467 const struct lttng_buffer_view
*payload
)
2471 struct relay_session
*session
= conn
->session
;
2472 struct lttcomm_relayd_close_trace_chunk
*msg
;
2473 struct lttcomm_relayd_close_trace_chunk_reply reply
= {};
2474 struct lttng_buffer_view header_view
;
2475 struct lttng_trace_chunk
*chunk
= NULL
;
2476 enum lttng_error_code reply_code
= LTTNG_OK
;
2477 enum lttng_trace_chunk_status chunk_status
;
2479 LTTNG_OPTIONAL(enum lttng_trace_chunk_command_type
) close_command
= {};
2480 time_t close_timestamp
;
2481 char closed_trace_chunk_path
[LTTNG_PATH_MAX
];
2482 size_t path_length
= 0;
2483 const char *chunk_name
= NULL
;
2484 struct lttng_dynamic_buffer reply_payload
;
2486 lttng_dynamic_buffer_init(&reply_payload
);
2488 if (!session
|| !conn
->version_check_done
) {
2489 ERR("Trying to close a trace chunk before version check");
2494 if (session
->major
== 2 && session
->minor
< 11) {
2495 ERR("Chunk close command is unsupported before 2.11");
2500 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
2501 if (!header_view
.data
) {
2502 ERR("Failed to receive payload of chunk close command");
2507 /* Convert to host endianness. */
2508 msg
= (typeof(msg
)) header_view
.data
;
2509 chunk_id
= be64toh(msg
->chunk_id
);
2510 close_timestamp
= (time_t) be64toh(msg
->close_timestamp
);
2511 close_command
= (typeof(close_command
)){
2512 .value
= be32toh(msg
->close_command
.value
),
2513 .is_set
= msg
->close_command
.is_set
,
2516 chunk
= sessiond_trace_chunk_registry_get_chunk(
2517 sessiond_trace_chunk_registry
,
2518 conn
->session
->sessiond_uuid
,
2522 char uuid_str
[UUID_STR_LEN
];
2524 lttng_uuid_to_str(conn
->session
->sessiond_uuid
, uuid_str
);
2525 ERR("Failed to find chunk to close: sessiond_uuid = %s, session_id = %" PRIu64
", chunk_id = %" PRIu64
,
2530 reply_code
= LTTNG_ERR_NOMEM
;
2534 pthread_mutex_lock(&session
->lock
);
2535 if (session
->pending_closure_trace_chunk
&&
2536 session
->pending_closure_trace_chunk
!= chunk
) {
2537 ERR("Trace chunk close command for session \"%s\" does not target the trace chunk pending closure",
2538 session
->session_name
);
2539 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2541 goto end_unlock_session
;
2544 chunk_status
= lttng_trace_chunk_set_close_timestamp(
2545 chunk
, close_timestamp
);
2546 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2547 ERR("Failed to set trace chunk close timestamp");
2549 reply_code
= LTTNG_ERR_UNK
;
2550 goto end_unlock_session
;
2553 if (close_command
.is_set
) {
2554 chunk_status
= lttng_trace_chunk_set_close_command(
2555 chunk
, close_command
.value
);
2556 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2558 reply_code
= LTTNG_ERR_INVALID
;
2559 goto end_unlock_session
;
2562 chunk_status
= lttng_trace_chunk_get_name(chunk
, &chunk_name
, NULL
);
2563 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2564 ERR("Failed to get chunk name");
2566 reply_code
= LTTNG_ERR_UNK
;
2567 goto end_unlock_session
;
2569 if (!session
->has_rotated
&& !session
->snapshot
) {
2570 ret
= lttng_strncpy(closed_trace_chunk_path
,
2571 session
->output_path
,
2572 sizeof(closed_trace_chunk_path
));
2574 ERR("Failed to send trace chunk path: path length of %zu bytes exceeds the maximal allowed length of %zu bytes",
2575 strlen(session
->output_path
),
2576 sizeof(closed_trace_chunk_path
));
2577 reply_code
= LTTNG_ERR_NOMEM
;
2579 goto end_unlock_session
;
2582 if (session
->snapshot
) {
2583 ret
= snprintf(closed_trace_chunk_path
,
2584 sizeof(closed_trace_chunk_path
),
2585 "%s/%s", session
->output_path
,
2588 ret
= snprintf(closed_trace_chunk_path
,
2589 sizeof(closed_trace_chunk_path
),
2590 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
2592 session
->output_path
, chunk_name
);
2594 if (ret
< 0 || ret
== sizeof(closed_trace_chunk_path
)) {
2595 ERR("Failed to format closed trace chunk resulting path");
2596 reply_code
= ret
< 0 ? LTTNG_ERR_UNK
: LTTNG_ERR_NOMEM
;
2598 goto end_unlock_session
;
2601 DBG("Reply chunk path on close: %s", closed_trace_chunk_path
);
2602 path_length
= strlen(closed_trace_chunk_path
) + 1;
2603 if (path_length
> UINT32_MAX
) {
2604 ERR("Closed trace chunk path exceeds the maximal length allowed by the protocol");
2606 reply_code
= LTTNG_ERR_INVALID_PROTOCOL
;
2607 goto end_unlock_session
;
2610 if (session
->current_trace_chunk
== chunk
) {
2612 * After a trace chunk close command, no new streams
2613 * referencing the chunk may be created. Hence, on the
2614 * event that no new trace chunk have been created for
2615 * the session, the reference to the current trace chunk
2616 * is released in order to allow it to be reclaimed when
2617 * the last stream releases its reference to it.
2619 lttng_trace_chunk_put(session
->current_trace_chunk
);
2620 session
->current_trace_chunk
= NULL
;
2622 lttng_trace_chunk_put(session
->pending_closure_trace_chunk
);
2623 session
->pending_closure_trace_chunk
= NULL
;
2625 pthread_mutex_unlock(&session
->lock
);
2628 reply
.generic
.ret_code
= htobe32((uint32_t) reply_code
);
2629 reply
.path_length
= htobe32((uint32_t) path_length
);
2630 ret
= lttng_dynamic_buffer_append(
2631 &reply_payload
, &reply
, sizeof(reply
));
2633 ERR("Failed to append \"close trace chunk\" command reply header to payload buffer");
2637 if (reply_code
== LTTNG_OK
) {
2638 ret
= lttng_dynamic_buffer_append(&reply_payload
,
2639 closed_trace_chunk_path
, path_length
);
2641 ERR("Failed to append \"close trace chunk\" command reply path to payload buffer");
2646 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
,
2650 if (send_ret
< reply_payload
.size
) {
2651 ERR("Failed to send \"close trace chunk\" command reply of %zu bytes (ret = %zd)",
2652 reply_payload
.size
, send_ret
);
2657 lttng_trace_chunk_put(chunk
);
2658 lttng_dynamic_buffer_reset(&reply_payload
);
2663 * relay_trace_chunk_exists: check if a trace chunk exists
2665 static int relay_trace_chunk_exists(const struct lttcomm_relayd_hdr
*recv_hdr
,
2666 struct relay_connection
*conn
,
2667 const struct lttng_buffer_view
*payload
)
2671 struct relay_session
*session
= conn
->session
;
2672 struct lttcomm_relayd_trace_chunk_exists
*msg
;
2673 struct lttcomm_relayd_trace_chunk_exists_reply reply
= {};
2674 struct lttng_buffer_view header_view
;
2675 struct lttng_trace_chunk
*chunk
= NULL
;
2678 if (!session
|| !conn
->version_check_done
) {
2679 ERR("Trying to close a trace chunk before version check");
2684 if (session
->major
== 2 && session
->minor
< 11) {
2685 ERR("Chunk close command is unsupported before 2.11");
2690 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
2691 if (!header_view
.data
) {
2692 ERR("Failed to receive payload of chunk close command");
2697 /* Convert to host endianness. */
2698 msg
= (typeof(msg
)) header_view
.data
;
2699 chunk_id
= be64toh(msg
->chunk_id
);
2701 chunk
= sessiond_trace_chunk_registry_get_chunk(
2702 sessiond_trace_chunk_registry
,
2703 conn
->session
->sessiond_uuid
,
2707 reply
= (typeof(reply
)) {
2708 .generic
.ret_code
= htobe32((uint32_t) LTTNG_OK
),
2709 .trace_chunk_exists
= !!chunk
,
2711 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
,
2712 &reply
, sizeof(reply
), 0);
2713 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2714 ERR("Failed to send \"create trace chunk\" command reply (ret = %zd)",
2719 lttng_trace_chunk_put(chunk
);
2723 #define DBG_CMD(cmd_name, conn) \
2724 DBG3("Processing \"%s\" command for socket %i", cmd_name, conn->sock->fd);
2726 static int relay_process_control_command(struct relay_connection
*conn
,
2727 const struct lttcomm_relayd_hdr
*header
,
2728 const struct lttng_buffer_view
*payload
)
2732 switch (header
->cmd
) {
2733 case RELAYD_CREATE_SESSION
:
2734 DBG_CMD("RELAYD_CREATE_SESSION", conn
);
2735 ret
= relay_create_session(header
, conn
, payload
);
2737 case RELAYD_ADD_STREAM
:
2738 DBG_CMD("RELAYD_ADD_STREAM", conn
);
2739 ret
= relay_add_stream(header
, conn
, payload
);
2741 case RELAYD_START_DATA
:
2742 DBG_CMD("RELAYD_START_DATA", conn
);
2743 ret
= relay_start(header
, conn
, payload
);
2745 case RELAYD_SEND_METADATA
:
2746 DBG_CMD("RELAYD_SEND_METADATA", conn
);
2747 ret
= relay_recv_metadata(header
, conn
, payload
);
2749 case RELAYD_VERSION
:
2750 DBG_CMD("RELAYD_VERSION", conn
);
2751 ret
= relay_send_version(header
, conn
, payload
);
2753 case RELAYD_CLOSE_STREAM
:
2754 DBG_CMD("RELAYD_CLOSE_STREAM", conn
);
2755 ret
= relay_close_stream(header
, conn
, payload
);
2757 case RELAYD_DATA_PENDING
:
2758 DBG_CMD("RELAYD_DATA_PENDING", conn
);
2759 ret
= relay_data_pending(header
, conn
, payload
);
2761 case RELAYD_QUIESCENT_CONTROL
:
2762 DBG_CMD("RELAYD_QUIESCENT_CONTROL", conn
);
2763 ret
= relay_quiescent_control(header
, conn
, payload
);
2765 case RELAYD_BEGIN_DATA_PENDING
:
2766 DBG_CMD("RELAYD_BEGIN_DATA_PENDING", conn
);
2767 ret
= relay_begin_data_pending(header
, conn
, payload
);
2769 case RELAYD_END_DATA_PENDING
:
2770 DBG_CMD("RELAYD_END_DATA_PENDING", conn
);
2771 ret
= relay_end_data_pending(header
, conn
, payload
);
2773 case RELAYD_SEND_INDEX
:
2774 DBG_CMD("RELAYD_SEND_INDEX", conn
);
2775 ret
= relay_recv_index(header
, conn
, payload
);
2777 case RELAYD_STREAMS_SENT
:
2778 DBG_CMD("RELAYD_STREAMS_SENT", conn
);
2779 ret
= relay_streams_sent(header
, conn
, payload
);
2781 case RELAYD_RESET_METADATA
:
2782 DBG_CMD("RELAYD_RESET_METADATA", conn
);
2783 ret
= relay_reset_metadata(header
, conn
, payload
);
2785 case RELAYD_ROTATE_STREAMS
:
2786 DBG_CMD("RELAYD_ROTATE_STREAMS", conn
);
2787 ret
= relay_rotate_session_streams(header
, conn
, payload
);
2789 case RELAYD_CREATE_TRACE_CHUNK
:
2790 DBG_CMD("RELAYD_CREATE_TRACE_CHUNK", conn
);
2791 ret
= relay_create_trace_chunk(header
, conn
, payload
);
2793 case RELAYD_CLOSE_TRACE_CHUNK
:
2794 DBG_CMD("RELAYD_CLOSE_TRACE_CHUNK", conn
);
2795 ret
= relay_close_trace_chunk(header
, conn
, payload
);
2797 case RELAYD_TRACE_CHUNK_EXISTS
:
2798 DBG_CMD("RELAYD_TRACE_CHUNK_EXISTS", conn
);
2799 ret
= relay_trace_chunk_exists(header
, conn
, payload
);
2801 case RELAYD_UPDATE_SYNC_INFO
:
2803 ERR("Received unknown command (%u)", header
->cmd
);
2804 relay_unknown_command(conn
);
2813 static enum relay_connection_status
relay_process_control_receive_payload(
2814 struct relay_connection
*conn
)
2817 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
2818 struct lttng_dynamic_buffer
*reception_buffer
=
2819 &conn
->protocol
.ctrl
.reception_buffer
;
2820 struct ctrl_connection_state_receive_payload
*state
=
2821 &conn
->protocol
.ctrl
.state
.receive_payload
;
2822 struct lttng_buffer_view payload_view
;
2824 if (state
->left_to_receive
== 0) {
2825 /* Short-circuit for payload-less commands. */
2826 goto reception_complete
;
2829 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
2830 reception_buffer
->data
+ state
->received
,
2831 state
->left_to_receive
, MSG_DONTWAIT
);
2833 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2834 PERROR("Unable to receive command payload on sock %d",
2836 status
= RELAY_CONNECTION_STATUS_ERROR
;
2839 } else if (ret
== 0) {
2840 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
2841 status
= RELAY_CONNECTION_STATUS_CLOSED
;
2846 assert(ret
<= state
->left_to_receive
);
2848 state
->left_to_receive
-= ret
;
2849 state
->received
+= ret
;
2851 if (state
->left_to_receive
> 0) {
2853 * Can't transition to the protocol's next state, wait to
2854 * receive the rest of the header.
2856 DBG3("Partial reception of control connection protocol payload (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
2857 state
->received
, state
->left_to_receive
,
2863 DBG("Done receiving control command payload: fd = %i, payload size = %" PRIu64
" bytes",
2864 conn
->sock
->fd
, state
->received
);
2866 * The payload required to process the command has been received.
2867 * A view to the reception buffer is forwarded to the various
2868 * commands and the state of the control is reset on success.
2870 * Commands are responsible for sending their reply to the peer.
2872 payload_view
= lttng_buffer_view_from_dynamic_buffer(reception_buffer
,
2874 ret
= relay_process_control_command(conn
,
2875 &state
->header
, &payload_view
);
2877 status
= RELAY_CONNECTION_STATUS_ERROR
;
2881 ret
= connection_reset_protocol_state(conn
);
2883 status
= RELAY_CONNECTION_STATUS_ERROR
;
2889 static enum relay_connection_status
relay_process_control_receive_header(
2890 struct relay_connection
*conn
)
2893 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
2894 struct lttcomm_relayd_hdr header
;
2895 struct lttng_dynamic_buffer
*reception_buffer
=
2896 &conn
->protocol
.ctrl
.reception_buffer
;
2897 struct ctrl_connection_state_receive_header
*state
=
2898 &conn
->protocol
.ctrl
.state
.receive_header
;
2900 assert(state
->left_to_receive
!= 0);
2902 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
2903 reception_buffer
->data
+ state
->received
,
2904 state
->left_to_receive
, MSG_DONTWAIT
);
2906 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2907 PERROR("Unable to receive control command header on sock %d",
2909 status
= RELAY_CONNECTION_STATUS_ERROR
;
2912 } else if (ret
== 0) {
2913 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
2914 status
= RELAY_CONNECTION_STATUS_CLOSED
;
2919 assert(ret
<= state
->left_to_receive
);
2921 state
->left_to_receive
-= ret
;
2922 state
->received
+= ret
;
2924 if (state
->left_to_receive
> 0) {
2926 * Can't transition to the protocol's next state, wait to
2927 * receive the rest of the header.
2929 DBG3("Partial reception of control connection protocol header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
2930 state
->received
, state
->left_to_receive
,
2935 /* Transition to next state: receiving the command's payload. */
2936 conn
->protocol
.ctrl
.state_id
=
2937 CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
;
2938 memcpy(&header
, reception_buffer
->data
, sizeof(header
));
2939 header
.circuit_id
= be64toh(header
.circuit_id
);
2940 header
.data_size
= be64toh(header
.data_size
);
2941 header
.cmd
= be32toh(header
.cmd
);
2942 header
.cmd_version
= be32toh(header
.cmd_version
);
2943 memcpy(&conn
->protocol
.ctrl
.state
.receive_payload
.header
,
2944 &header
, sizeof(header
));
2946 DBG("Done receiving control command header: fd = %i, cmd = %" PRIu32
", cmd_version = %" PRIu32
", payload size = %" PRIu64
" bytes",
2947 conn
->sock
->fd
, header
.cmd
, header
.cmd_version
,
2950 if (header
.data_size
> DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE
) {
2951 ERR("Command header indicates a payload (%" PRIu64
" bytes) that exceeds the maximal payload size allowed on a control connection.",
2953 status
= RELAY_CONNECTION_STATUS_ERROR
;
2957 conn
->protocol
.ctrl
.state
.receive_payload
.left_to_receive
=
2959 conn
->protocol
.ctrl
.state
.receive_payload
.received
= 0;
2960 ret
= lttng_dynamic_buffer_set_size(reception_buffer
,
2963 status
= RELAY_CONNECTION_STATUS_ERROR
;
2967 if (header
.data_size
== 0) {
2969 * Manually invoke the next state as the poll loop
2970 * will not wake-up to allow us to proceed further.
2972 status
= relay_process_control_receive_payload(conn
);
2979 * Process the commands received on the control socket
2981 static enum relay_connection_status
relay_process_control(
2982 struct relay_connection
*conn
)
2984 enum relay_connection_status status
;
2986 switch (conn
->protocol
.ctrl
.state_id
) {
2987 case CTRL_CONNECTION_STATE_RECEIVE_HEADER
:
2988 status
= relay_process_control_receive_header(conn
);
2990 case CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
:
2991 status
= relay_process_control_receive_payload(conn
);
2994 ERR("Unknown control connection protocol state encountered.");
3001 static enum relay_connection_status
relay_process_data_receive_header(
3002 struct relay_connection
*conn
)
3005 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3006 struct data_connection_state_receive_header
*state
=
3007 &conn
->protocol
.data
.state
.receive_header
;
3008 struct lttcomm_relayd_data_hdr header
;
3009 struct relay_stream
*stream
;
3011 assert(state
->left_to_receive
!= 0);
3013 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3014 state
->header_reception_buffer
+ state
->received
,
3015 state
->left_to_receive
, MSG_DONTWAIT
);
3017 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3018 PERROR("Unable to receive data header on sock %d", conn
->sock
->fd
);
3019 status
= RELAY_CONNECTION_STATUS_ERROR
;
3022 } else if (ret
== 0) {
3023 /* Orderly shutdown. Not necessary to print an error. */
3024 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3025 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3030 assert(ret
<= state
->left_to_receive
);
3032 state
->left_to_receive
-= ret
;
3033 state
->received
+= ret
;
3035 if (state
->left_to_receive
> 0) {
3037 * Can't transition to the protocol's next state, wait to
3038 * receive the rest of the header.
3040 DBG3("Partial reception of data connection header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3041 state
->received
, state
->left_to_receive
,
3046 /* Transition to next state: receiving the payload. */
3047 conn
->protocol
.data
.state_id
= DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3049 memcpy(&header
, state
->header_reception_buffer
, sizeof(header
));
3050 header
.circuit_id
= be64toh(header
.circuit_id
);
3051 header
.stream_id
= be64toh(header
.stream_id
);
3052 header
.data_size
= be32toh(header
.data_size
);
3053 header
.net_seq_num
= be64toh(header
.net_seq_num
);
3054 header
.padding_size
= be32toh(header
.padding_size
);
3055 memcpy(&conn
->protocol
.data
.state
.receive_payload
.header
, &header
, sizeof(header
));
3057 conn
->protocol
.data
.state
.receive_payload
.left_to_receive
=
3059 conn
->protocol
.data
.state
.receive_payload
.received
= 0;
3060 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= false;
3062 DBG("Received data connection header on fd %i: circuit_id = %" PRIu64
", stream_id = %" PRIu64
", data_size = %" PRIu32
", net_seq_num = %" PRIu64
", padding_size = %" PRIu32
,
3063 conn
->sock
->fd
, header
.circuit_id
,
3064 header
.stream_id
, header
.data_size
,
3065 header
.net_seq_num
, header
.padding_size
);
3067 stream
= stream_get_by_id(header
.stream_id
);
3069 DBG("relay_process_data_receive_payload: Cannot find stream %" PRIu64
,
3071 /* Protocol error. */
3072 status
= RELAY_CONNECTION_STATUS_ERROR
;
3076 pthread_mutex_lock(&stream
->lock
);
3077 /* Prepare stream for the reception of a new packet. */
3078 ret
= stream_init_packet(stream
, header
.data_size
,
3079 &conn
->protocol
.data
.state
.receive_payload
.rotate_index
);
3080 pthread_mutex_unlock(&stream
->lock
);
3082 ERR("Failed to rotate stream output file");
3083 status
= RELAY_CONNECTION_STATUS_ERROR
;
3084 goto end_stream_unlock
;
3093 static enum relay_connection_status
relay_process_data_receive_payload(
3094 struct relay_connection
*conn
)
3097 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3098 struct relay_stream
*stream
;
3099 struct data_connection_state_receive_payload
*state
=
3100 &conn
->protocol
.data
.state
.receive_payload
;
3101 const size_t chunk_size
= RECV_DATA_BUFFER_SIZE
;
3102 char data_buffer
[chunk_size
];
3103 bool partial_recv
= false;
3104 bool new_stream
= false, close_requested
= false, index_flushed
= false;
3105 uint64_t left_to_receive
= state
->left_to_receive
;
3106 struct relay_session
*session
;
3108 DBG3("Receiving data for stream id %" PRIu64
" seqnum %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3109 state
->header
.stream_id
, state
->header
.net_seq_num
,
3110 state
->received
, left_to_receive
);
3112 stream
= stream_get_by_id(state
->header
.stream_id
);
3114 /* Protocol error. */
3115 ERR("relay_process_data_receive_payload: cannot find stream %" PRIu64
,
3116 state
->header
.stream_id
);
3117 status
= RELAY_CONNECTION_STATUS_ERROR
;
3121 pthread_mutex_lock(&stream
->lock
);
3122 session
= stream
->trace
->session
;
3123 if (!conn
->session
) {
3124 ret
= connection_set_session(conn
, session
);
3126 status
= RELAY_CONNECTION_STATUS_ERROR
;
3127 goto end_stream_unlock
;
3132 * The size of the "chunk" received on any iteration is bounded by:
3133 * - the data left to receive,
3134 * - the data immediately available on the socket,
3135 * - the on-stack data buffer
3137 while (left_to_receive
> 0 && !partial_recv
) {
3138 size_t recv_size
= min(left_to_receive
, chunk_size
);
3139 struct lttng_buffer_view packet_chunk
;
3141 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
,
3142 recv_size
, MSG_DONTWAIT
);
3144 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3145 PERROR("Socket %d error", conn
->sock
->fd
);
3146 status
= RELAY_CONNECTION_STATUS_ERROR
;
3148 goto end_stream_unlock
;
3149 } else if (ret
== 0) {
3150 /* No more data ready to be consumed on socket. */
3151 DBG3("No more data ready for consumption on data socket of stream id %" PRIu64
,
3152 state
->header
.stream_id
);
3153 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3155 } else if (ret
< (int) recv_size
) {
3157 * All the data available on the socket has been
3160 partial_recv
= true;
3164 packet_chunk
= lttng_buffer_view_init(data_buffer
,
3166 assert(packet_chunk
.data
);
3168 ret
= stream_write(stream
, &packet_chunk
, 0);
3170 ERR("Relay error writing data to file");
3171 status
= RELAY_CONNECTION_STATUS_ERROR
;
3172 goto end_stream_unlock
;
3175 left_to_receive
-= recv_size
;
3176 state
->received
+= recv_size
;
3177 state
->left_to_receive
= left_to_receive
;
3180 if (state
->left_to_receive
> 0) {
3182 * Did not receive all the data expected, wait for more data to
3183 * become available on the socket.
3185 DBG3("Partial receive on data connection of stream id %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3186 state
->header
.stream_id
, state
->received
,
3187 state
->left_to_receive
);
3188 goto end_stream_unlock
;
3191 ret
= stream_write(stream
, NULL
, state
->header
.padding_size
);
3193 status
= RELAY_CONNECTION_STATUS_ERROR
;
3194 goto end_stream_unlock
;
3197 if (session_streams_have_index(session
)) {
3198 ret
= stream_update_index(stream
, state
->header
.net_seq_num
,
3199 state
->rotate_index
, &index_flushed
,
3200 state
->header
.data_size
+ state
->header
.padding_size
);
3202 ERR("Failed to update index: stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3203 stream
->stream_handle
,
3204 state
->header
.net_seq_num
, ret
);
3205 status
= RELAY_CONNECTION_STATUS_ERROR
;
3206 goto end_stream_unlock
;
3210 if (stream
->prev_data_seq
== -1ULL) {
3214 ret
= stream_complete_packet(stream
, state
->header
.data_size
+
3215 state
->header
.padding_size
, state
->header
.net_seq_num
,
3218 status
= RELAY_CONNECTION_STATUS_ERROR
;
3219 goto end_stream_unlock
;
3223 * Resetting the protocol state (to RECEIVE_HEADER) will trash the
3224 * contents of *state which are aliased (union) to the same location as
3225 * the new state. Don't use it beyond this point.
3227 connection_reset_protocol_state(conn
);
3231 close_requested
= stream
->close_requested
;
3232 pthread_mutex_unlock(&stream
->lock
);
3233 if (close_requested
&& left_to_receive
== 0) {
3234 try_stream_close(stream
);
3238 pthread_mutex_lock(&session
->lock
);
3239 uatomic_set(&session
->new_streams
, 1);
3240 pthread_mutex_unlock(&session
->lock
);
3249 * relay_process_data: Process the data received on the data socket
3251 static enum relay_connection_status
relay_process_data(
3252 struct relay_connection
*conn
)
3254 enum relay_connection_status status
;
3256 switch (conn
->protocol
.data
.state_id
) {
3257 case DATA_CONNECTION_STATE_RECEIVE_HEADER
:
3258 status
= relay_process_data_receive_header(conn
);
3260 case DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3261 status
= relay_process_data_receive_payload(conn
);
3264 ERR("Unexpected data connection communication state.");
3271 static void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
3275 (void) lttng_poll_del(events
, pollfd
);
3277 ret
= close(pollfd
);
3279 ERR("Closing pollfd %d", pollfd
);
3283 static void relay_thread_close_connection(struct lttng_poll_event
*events
,
3284 int pollfd
, struct relay_connection
*conn
)
3286 const char *type_str
;
3288 switch (conn
->type
) {
3293 type_str
= "Control";
3295 case RELAY_VIEWER_COMMAND
:
3296 type_str
= "Viewer Command";
3298 case RELAY_VIEWER_NOTIFICATION
:
3299 type_str
= "Viewer Notification";
3302 type_str
= "Unknown";
3304 cleanup_connection_pollfd(events
, pollfd
);
3305 connection_put(conn
);
3306 DBG("%s connection closed with %d", type_str
, pollfd
);
3310 * This thread does the actual work
3312 static void *relay_thread_worker(void *data
)
3314 int ret
, err
= -1, last_seen_data_fd
= -1;
3316 struct lttng_poll_event events
;
3317 struct lttng_ht
*relay_connections_ht
;
3318 struct lttng_ht_iter iter
;
3319 struct relay_connection
*destroy_conn
= NULL
;
3321 DBG("[thread] Relay worker started");
3323 rcu_register_thread();
3325 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
3327 if (testpoint(relayd_thread_worker
)) {
3328 goto error_testpoint
;
3331 health_code_update();
3333 /* table of connections indexed on socket */
3334 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3335 if (!relay_connections_ht
) {
3336 goto relay_connections_ht_error
;
3339 ret
= create_thread_poll_set(&events
, 2);
3341 goto error_poll_create
;
3344 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
3351 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
3353 health_code_update();
3355 /* Infinite blocking call, waiting for transmission */
3356 DBG3("Relayd worker thread polling...");
3357 health_poll_entry();
3358 ret
= lttng_poll_wait(&events
, -1);
3362 * Restart interrupted system call.
3364 if (errno
== EINTR
) {
3373 * Process control. The control connection is
3374 * prioritized so we don't starve it with high
3375 * throughput tracing data on the data connection.
3377 for (i
= 0; i
< nb_fd
; i
++) {
3378 /* Fetch once the poll data */
3379 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3380 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3382 health_code_update();
3384 /* Thread quit pipe has been closed. Killing thread. */
3385 ret
= check_thread_quit_pipe(pollfd
, revents
);
3391 /* Inspect the relay conn pipe for new connection */
3392 if (pollfd
== relay_conn_pipe
[0]) {
3393 if (revents
& LPOLLIN
) {
3394 struct relay_connection
*conn
;
3396 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
3400 lttng_poll_add(&events
, conn
->sock
->fd
,
3401 LPOLLIN
| LPOLLRDHUP
);
3402 connection_ht_add(relay_connections_ht
, conn
);
3403 DBG("Connection socket %d added", conn
->sock
->fd
);
3404 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3405 ERR("Relay connection pipe error");
3408 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3412 struct relay_connection
*ctrl_conn
;
3414 ctrl_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3415 /* If not found, there is a synchronization issue. */
3418 if (ctrl_conn
->type
== RELAY_DATA
) {
3419 if (revents
& LPOLLIN
) {
3421 * Flag the last seen data fd not deleted. It will be
3422 * used as the last seen fd if any fd gets deleted in
3425 last_notdel_data_fd
= pollfd
;
3427 goto put_ctrl_connection
;
3429 assert(ctrl_conn
->type
== RELAY_CONTROL
);
3431 if (revents
& LPOLLIN
) {
3432 enum relay_connection_status status
;
3434 status
= relay_process_control(ctrl_conn
);
3435 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
3437 * On socket error flag the session as aborted to force
3438 * the cleanup of its stream otherwise it can leak
3439 * during the lifetime of the relayd.
3441 * This prevents situations in which streams can be
3442 * left opened because an index was received, the
3443 * control connection is closed, and the data
3444 * connection is closed (uncleanly) before the packet's
3447 * Since the control connection encountered an error,
3448 * it is okay to be conservative and close the
3449 * session right now as we can't rely on the protocol
3450 * being respected anymore.
3452 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
3453 session_abort(ctrl_conn
->session
);
3456 /* Clear the connection on error or close. */
3457 relay_thread_close_connection(&events
,
3462 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3463 relay_thread_close_connection(&events
,
3465 if (last_seen_data_fd
== pollfd
) {
3466 last_seen_data_fd
= last_notdel_data_fd
;
3469 ERR("Unexpected poll events %u for control sock %d",
3471 connection_put(ctrl_conn
);
3474 put_ctrl_connection
:
3475 connection_put(ctrl_conn
);
3480 * The last loop handled a control request, go back to poll to make
3481 * sure we prioritise the control socket.
3487 if (last_seen_data_fd
>= 0) {
3488 for (i
= 0; i
< nb_fd
; i
++) {
3489 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3491 health_code_update();
3493 if (last_seen_data_fd
== pollfd
) {
3500 /* Process data connection. */
3501 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
3502 /* Fetch the poll data. */
3503 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3504 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3505 struct relay_connection
*data_conn
;
3507 health_code_update();
3510 /* No activity for this FD (poll implementation). */
3514 /* Skip the command pipe. It's handled in the first loop. */
3515 if (pollfd
== relay_conn_pipe
[0]) {
3519 data_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3521 /* Skip it. Might be removed before. */
3524 if (data_conn
->type
== RELAY_CONTROL
) {
3525 goto put_data_connection
;
3527 assert(data_conn
->type
== RELAY_DATA
);
3529 if (revents
& LPOLLIN
) {
3530 enum relay_connection_status status
;
3532 status
= relay_process_data(data_conn
);
3533 /* Connection closed or error. */
3534 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
3536 * On socket error flag the session as aborted to force
3537 * the cleanup of its stream otherwise it can leak
3538 * during the lifetime of the relayd.
3540 * This prevents situations in which streams can be
3541 * left opened because an index was received, the
3542 * control connection is closed, and the data
3543 * connection is closed (uncleanly) before the packet's
3546 * Since the data connection encountered an error,
3547 * it is okay to be conservative and close the
3548 * session right now as we can't rely on the protocol
3549 * being respected anymore.
3551 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
3552 session_abort(data_conn
->session
);
3554 relay_thread_close_connection(&events
, pollfd
,
3557 * Every goto restart call sets the last seen fd where
3558 * here we don't really care since we gracefully
3559 * continue the loop after the connection is deleted.
3562 /* Keep last seen port. */
3563 last_seen_data_fd
= pollfd
;
3564 connection_put(data_conn
);
3567 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3568 relay_thread_close_connection(&events
, pollfd
,
3571 ERR("Unknown poll events %u for data sock %d",
3574 put_data_connection
:
3575 connection_put(data_conn
);
3577 last_seen_data_fd
= -1;
3580 /* Normal exit, no error */
3585 /* Cleanup remaining connection object. */
3587 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
,
3590 health_code_update();
3592 session_abort(destroy_conn
->session
);
3595 * No need to grab another ref, because we own
3598 relay_thread_close_connection(&events
, destroy_conn
->sock
->fd
,
3603 lttng_poll_clean(&events
);
3605 lttng_ht_destroy(relay_connections_ht
);
3606 relay_connections_ht_error
:
3607 /* Close relay conn pipes */
3608 utils_close_pipe(relay_conn_pipe
);
3610 DBG("Thread exited with error");
3612 DBG("Worker thread cleanup complete");
3616 ERR("Health error occurred in %s", __func__
);
3618 health_unregister(health_relayd
);
3619 rcu_unregister_thread();
3620 lttng_relay_stop_threads();
3625 * Create the relay command pipe to wake thread_manage_apps.
3626 * Closed in cleanup().
3628 static int create_relay_conn_pipe(void)
3632 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
3640 int main(int argc
, char **argv
)
3642 int ret
= 0, retval
= 0;
3645 /* Parse arguments */
3647 if (set_options(argc
, argv
)) {
3652 if (set_signal_handler()) {
3657 /* Try to create directory if -o, --output is specified. */
3658 if (opt_output_path
) {
3659 if (*opt_output_path
!= '/') {
3660 ERR("Please specify an absolute path for -o, --output PATH");
3665 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
,
3668 ERR("Unable to create %s", opt_output_path
);
3675 if (opt_daemon
|| opt_background
) {
3678 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
3686 * We are in the child. Make sure all other file
3687 * descriptors are closed, in case we are called with
3688 * more opened file descriptors than the standard ones.
3690 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
3695 sessiond_trace_chunk_registry
= sessiond_trace_chunk_registry_create();
3696 if (!sessiond_trace_chunk_registry
) {
3697 ERR("Failed to initialize session daemon trace chunk registry");
3699 goto exit_sessiond_trace_chunk_registry
;
3702 /* Initialize thread health monitoring */
3703 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
3704 if (!health_relayd
) {
3705 PERROR("health_app_create error");
3707 goto exit_health_app_create
;
3710 /* Create thread quit pipe */
3711 if (init_thread_quit_pipe()) {
3713 goto exit_init_data
;
3716 /* Setup the thread apps communication pipe. */
3717 if (create_relay_conn_pipe()) {
3719 goto exit_init_data
;
3722 /* Init relay command queue. */
3723 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
3725 /* Initialize communication library */
3727 lttcomm_inet_init();
3729 /* tables of sessions indexed by session ID */
3730 sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3733 goto exit_init_data
;
3736 /* tables of streams indexed by stream ID */
3737 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3738 if (!relay_streams_ht
) {
3740 goto exit_init_data
;
3743 /* tables of streams indexed by stream ID */
3744 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3745 if (!viewer_streams_ht
) {
3747 goto exit_init_data
;
3750 ret
= utils_create_pipe(health_quit_pipe
);
3753 goto exit_health_quit_pipe
;
3756 /* Create thread to manage the client socket */
3757 ret
= pthread_create(&health_thread
, default_pthread_attr(),
3758 thread_manage_health
, (void *) NULL
);
3761 PERROR("pthread_create health");
3763 goto exit_health_thread
;
3766 /* Setup the dispatcher thread */
3767 ret
= pthread_create(&dispatcher_thread
, default_pthread_attr(),
3768 relay_thread_dispatcher
, (void *) NULL
);
3771 PERROR("pthread_create dispatcher");
3773 goto exit_dispatcher_thread
;
3776 /* Setup the worker thread */
3777 ret
= pthread_create(&worker_thread
, default_pthread_attr(),
3778 relay_thread_worker
, NULL
);
3781 PERROR("pthread_create worker");
3783 goto exit_worker_thread
;
3786 /* Setup the listener thread */
3787 ret
= pthread_create(&listener_thread
, default_pthread_attr(),
3788 relay_thread_listener
, (void *) NULL
);
3791 PERROR("pthread_create listener");
3793 goto exit_listener_thread
;
3796 ret
= relayd_live_create(live_uri
);
3798 ERR("Starting live viewer threads");
3804 * This is where we start awaiting program completion (e.g. through
3805 * signal that asks threads to teardown).
3808 ret
= relayd_live_join();
3814 ret
= pthread_join(listener_thread
, &status
);
3817 PERROR("pthread_join listener_thread");
3821 exit_listener_thread
:
3822 ret
= pthread_join(worker_thread
, &status
);
3825 PERROR("pthread_join worker_thread");
3830 ret
= pthread_join(dispatcher_thread
, &status
);
3833 PERROR("pthread_join dispatcher_thread");
3836 exit_dispatcher_thread
:
3838 ret
= pthread_join(health_thread
, &status
);
3841 PERROR("pthread_join health_thread");
3846 utils_close_pipe(health_quit_pipe
);
3847 exit_health_quit_pipe
:
3850 health_app_destroy(health_relayd
);
3851 sessiond_trace_chunk_registry_destroy(sessiond_trace_chunk_registry
);
3852 exit_health_app_create
:
3853 exit_sessiond_trace_chunk_registry
:
3856 * Wait for all pending call_rcu work to complete before tearing
3857 * down data structures. call_rcu worker may be trying to
3858 * perform lookups in those structures.
3863 /* Ensure all prior call_rcu are done. */