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>
43 #include <lttng/lttng.h>
44 #include <common/common.h>
45 #include <common/compat/poll.h>
46 #include <common/compat/socket.h>
47 #include <common/compat/endian.h>
48 #include <common/compat/getenv.h>
49 #include <common/defaults.h>
50 #include <common/daemonize.h>
51 #include <common/futex.h>
52 #include <common/sessiond-comm/sessiond-comm.h>
53 #include <common/sessiond-comm/inet.h>
54 #include <common/sessiond-comm/relayd.h>
55 #include <common/uri.h>
56 #include <common/utils.h>
57 #include <common/align.h>
58 #include <common/config/session-config.h>
59 #include <common/dynamic-buffer.h>
60 #include <common/buffer-view.h>
61 #include <urcu/rculist.h>
64 #include "ctf-trace.h"
67 #include "lttng-relayd.h"
69 #include "health-relayd.h"
70 #include "testpoint.h"
71 #include "viewer-stream.h"
74 #include "connection.h"
75 #include "tracefile-array.h"
76 #include "tcp_keep_alive.h"
78 static const char *help_msg
=
79 #ifdef LTTNG_EMBED_HELP
80 #include <lttng-relayd.8.h>
86 enum relay_connection_status
{
87 RELAY_CONNECTION_STATUS_OK
,
88 /* An error occurred while processing an event on the connection. */
89 RELAY_CONNECTION_STATUS_ERROR
,
90 /* Connection closed/shutdown cleanly. */
91 RELAY_CONNECTION_STATUS_CLOSED
,
94 /* command line options */
95 char *opt_output_path
;
96 static int opt_daemon
, opt_background
;
99 * We need to wait for listener and live listener threads, as well as
100 * health check thread, before being ready to signal readiness.
102 #define NR_LTTNG_RELAY_READY 3
103 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
105 /* Size of receive buffer. */
106 #define RECV_DATA_BUFFER_SIZE 65536
107 #define FILE_COPY_BUFFER_SIZE 65536
109 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
110 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
112 static struct lttng_uri
*control_uri
;
113 static struct lttng_uri
*data_uri
;
114 static struct lttng_uri
*live_uri
;
116 const char *progname
;
118 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
119 static int tracing_group_name_override
;
121 const char * const config_section_name
= "relayd";
124 * Quit pipe for all threads. This permits a single cancellation point
125 * for all threads when receiving an event on the pipe.
127 int thread_quit_pipe
[2] = { -1, -1 };
130 * This pipe is used to inform the worker thread that a command is queued and
131 * ready to be processed.
133 static int relay_conn_pipe
[2] = { -1, -1 };
135 /* Shared between threads */
136 static int dispatch_thread_exit
;
138 static pthread_t listener_thread
;
139 static pthread_t dispatcher_thread
;
140 static pthread_t worker_thread
;
141 static pthread_t health_thread
;
144 * last_relay_stream_id_lock protects last_relay_stream_id increment
145 * atomicity on 32-bit architectures.
147 static pthread_mutex_t last_relay_stream_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
148 static uint64_t last_relay_stream_id
;
151 * Relay command queue.
153 * The relay_thread_listener and relay_thread_dispatcher communicate with this
156 static struct relay_conn_queue relay_conn_queue
;
158 /* Global relay stream hash table. */
159 struct lttng_ht
*relay_streams_ht
;
161 /* Global relay viewer stream hash table. */
162 struct lttng_ht
*viewer_streams_ht
;
164 /* Global relay sessions hash table. */
165 struct lttng_ht
*sessions_ht
;
167 /* Relayd health monitoring */
168 struct health_app
*health_relayd
;
170 static struct option long_options
[] = {
171 { "control-port", 1, 0, 'C', },
172 { "data-port", 1, 0, 'D', },
173 { "live-port", 1, 0, 'L', },
174 { "daemonize", 0, 0, 'd', },
175 { "background", 0, 0, 'b', },
176 { "group", 1, 0, 'g', },
177 { "help", 0, 0, 'h', },
178 { "output", 1, 0, 'o', },
179 { "verbose", 0, 0, 'v', },
180 { "config", 1, 0, 'f' },
181 { "version", 0, 0, 'V' },
185 static const char *config_ignore_options
[] = { "help", "config", "version" };
188 * Take an option from the getopt output and set it in the right variable to be
191 * Return 0 on success else a negative value.
193 static int set_option(int opt
, const char *arg
, const char *optname
)
199 fprintf(stderr
, "option %s", optname
);
201 fprintf(stderr
, " with arg %s\n", arg
);
205 if (lttng_is_setuid_setgid()) {
206 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
207 "-C, --control-port");
209 ret
= uri_parse(arg
, &control_uri
);
211 ERR("Invalid control URI specified");
214 if (control_uri
->port
== 0) {
215 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
220 if (lttng_is_setuid_setgid()) {
221 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
224 ret
= uri_parse(arg
, &data_uri
);
226 ERR("Invalid data URI specified");
229 if (data_uri
->port
== 0) {
230 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
235 if (lttng_is_setuid_setgid()) {
236 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
239 ret
= uri_parse(arg
, &live_uri
);
241 ERR("Invalid live URI specified");
244 if (live_uri
->port
== 0) {
245 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
256 if (lttng_is_setuid_setgid()) {
257 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
260 tracing_group_name
= strdup(arg
);
261 if (tracing_group_name
== NULL
) {
266 tracing_group_name_override
= 1;
270 ret
= utils_show_help(8, "lttng-relayd", help_msg
);
272 ERR("Cannot show --help for `lttng-relayd`");
277 fprintf(stdout
, "%s\n", VERSION
);
280 if (lttng_is_setuid_setgid()) {
281 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
284 ret
= asprintf(&opt_output_path
, "%s", arg
);
287 PERROR("asprintf opt_output_path");
293 /* Verbose level can increase using multiple -v */
295 lttng_opt_verbose
= config_parse_value(arg
);
297 /* Only 3 level of verbosity (-vvv). */
298 if (lttng_opt_verbose
< 3) {
299 lttng_opt_verbose
+= 1;
304 /* Unknown option or other error.
305 * Error is printed by getopt, just return */
318 * config_entry_handler_cb used to handle options read from a config file.
319 * See config_entry_handler_cb comment in common/config/session-config.h for the
320 * return value conventions.
322 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
326 if (!entry
|| !entry
->name
|| !entry
->value
) {
331 /* Check if the option is to be ignored */
332 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
333 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
338 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1; i
++) {
339 /* Ignore if entry name is not fully matched. */
340 if (strcmp(entry
->name
, long_options
[i
].name
)) {
345 * If the option takes no argument on the command line,
346 * we have to check if the value is "true". We support
347 * non-zero numeric values, true, on and yes.
349 if (!long_options
[i
].has_arg
) {
350 ret
= config_parse_value(entry
->value
);
353 WARN("Invalid configuration value \"%s\" for option %s",
354 entry
->value
, entry
->name
);
356 /* False, skip boolean config option. */
361 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
365 WARN("Unrecognized option \"%s\" in daemon configuration file.",
372 static int set_options(int argc
, char **argv
)
374 int c
, ret
= 0, option_index
= 0, retval
= 0;
375 int orig_optopt
= optopt
, orig_optind
= optind
;
376 char *default_address
, *optstring
;
377 const char *config_path
= NULL
;
379 optstring
= utils_generate_optstring(long_options
,
380 sizeof(long_options
) / sizeof(struct option
));
386 /* Check for the --config option */
388 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
389 &option_index
)) != -1) {
393 } else if (c
!= 'f') {
397 if (lttng_is_setuid_setgid()) {
398 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
401 config_path
= utils_expand_path(optarg
);
403 ERR("Failed to resolve path: %s", optarg
);
408 ret
= config_get_section_entries(config_path
, config_section_name
,
409 config_entry_handler
, NULL
);
412 ERR("Invalid configuration option at line %i", ret
);
418 /* Reset getopt's global state */
419 optopt
= orig_optopt
;
420 optind
= orig_optind
;
422 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
427 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
434 /* assign default values */
435 if (control_uri
== NULL
) {
436 ret
= asprintf(&default_address
,
437 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
438 DEFAULT_NETWORK_CONTROL_PORT
);
440 PERROR("asprintf default data address");
445 ret
= uri_parse(default_address
, &control_uri
);
446 free(default_address
);
448 ERR("Invalid control URI specified");
453 if (data_uri
== NULL
) {
454 ret
= asprintf(&default_address
,
455 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
456 DEFAULT_NETWORK_DATA_PORT
);
458 PERROR("asprintf default data address");
463 ret
= uri_parse(default_address
, &data_uri
);
464 free(default_address
);
466 ERR("Invalid data URI specified");
471 if (live_uri
== NULL
) {
472 ret
= asprintf(&default_address
,
473 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
474 DEFAULT_NETWORK_VIEWER_PORT
);
476 PERROR("asprintf default viewer control address");
481 ret
= uri_parse(default_address
, &live_uri
);
482 free(default_address
);
484 ERR("Invalid viewer control URI specified");
495 static void print_global_objects(void)
497 rcu_register_thread();
499 print_viewer_streams();
500 print_relay_streams();
503 rcu_unregister_thread();
509 static void relayd_cleanup(void)
511 print_global_objects();
515 if (viewer_streams_ht
)
516 lttng_ht_destroy(viewer_streams_ht
);
517 if (relay_streams_ht
)
518 lttng_ht_destroy(relay_streams_ht
);
520 lttng_ht_destroy(sessions_ht
);
522 /* free the dynamically allocated opt_output_path */
523 free(opt_output_path
);
525 /* Close thread quit pipes */
526 utils_close_pipe(thread_quit_pipe
);
528 uri_free(control_uri
);
530 /* Live URI is freed in the live thread. */
532 if (tracing_group_name_override
) {
533 free((void *) tracing_group_name
);
538 * Write to writable pipe used to notify a thread.
540 static int notify_thread_pipe(int wpipe
)
544 ret
= lttng_write(wpipe
, "!", 1);
546 PERROR("write poll pipe");
554 static int notify_health_quit_pipe(int *pipe
)
558 ret
= lttng_write(pipe
[1], "4", 1);
560 PERROR("write relay health quit");
569 * Stop all relayd and relayd-live threads.
571 int lttng_relay_stop_threads(void)
575 /* Stopping all threads */
576 DBG("Terminating all threads");
577 if (notify_thread_pipe(thread_quit_pipe
[1])) {
578 ERR("write error on thread quit pipe");
582 if (notify_health_quit_pipe(health_quit_pipe
)) {
583 ERR("write error on health quit pipe");
586 /* Dispatch thread */
587 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
588 futex_nto1_wake(&relay_conn_queue
.futex
);
590 if (relayd_live_stop()) {
591 ERR("Error stopping live threads");
598 * Signal handler for the daemon
600 * Simply stop all worker threads, leaving main() return gracefully after
601 * joining all threads and calling cleanup().
603 static void sighandler(int sig
)
607 DBG("SIGINT caught");
608 if (lttng_relay_stop_threads()) {
609 ERR("Error stopping threads");
613 DBG("SIGTERM caught");
614 if (lttng_relay_stop_threads()) {
615 ERR("Error stopping threads");
619 CMM_STORE_SHARED(recv_child_signal
, 1);
627 * Setup signal handler for :
628 * SIGINT, SIGTERM, SIGPIPE
630 static int set_signal_handler(void)
636 if ((ret
= sigemptyset(&sigset
)) < 0) {
637 PERROR("sigemptyset");
644 sa
.sa_handler
= sighandler
;
645 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
650 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
655 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
660 sa
.sa_handler
= SIG_IGN
;
661 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
666 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
671 void lttng_relay_notify_ready(void)
673 /* Notify the parent of the fork() process that we are ready. */
674 if (opt_daemon
|| opt_background
) {
675 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
676 kill(child_ppid
, SIGUSR1
);
682 * Init thread quit pipe.
684 * Return -1 on error or 0 if all pipes are created.
686 static int init_thread_quit_pipe(void)
690 ret
= utils_create_pipe_cloexec(thread_quit_pipe
);
696 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
698 static int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
702 if (events
== NULL
|| size
== 0) {
707 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
713 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
725 * Check if the thread quit pipe was triggered.
727 * Return 1 if it was triggered else 0;
729 static int check_thread_quit_pipe(int fd
, uint32_t events
)
731 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
739 * Create and init socket from uri.
741 static struct lttcomm_sock
*relay_socket_create(struct lttng_uri
*uri
)
744 struct lttcomm_sock
*sock
= NULL
;
746 sock
= lttcomm_alloc_sock_from_uri(uri
);
748 ERR("Allocating socket");
752 ret
= lttcomm_create_sock(sock
);
756 DBG("Listening on sock %d", sock
->fd
);
758 ret
= sock
->ops
->bind(sock
);
760 PERROR("Failed to bind socket");
764 ret
= sock
->ops
->listen(sock
, -1);
774 lttcomm_destroy_sock(sock
);
780 * This thread manages the listening for new connections on the network
782 static void *relay_thread_listener(void *data
)
784 int i
, ret
, pollfd
, err
= -1;
785 uint32_t revents
, nb_fd
;
786 struct lttng_poll_event events
;
787 struct lttcomm_sock
*control_sock
, *data_sock
;
789 DBG("[thread] Relay listener started");
791 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
793 health_code_update();
795 control_sock
= relay_socket_create(control_uri
);
797 goto error_sock_control
;
800 data_sock
= relay_socket_create(data_uri
);
802 goto error_sock_relay
;
806 * Pass 3 as size here for the thread quit pipe, control and
809 ret
= create_thread_poll_set(&events
, 3);
811 goto error_create_poll
;
814 /* Add the control socket */
815 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
820 /* Add the data socket */
821 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
826 lttng_relay_notify_ready();
828 if (testpoint(relayd_thread_listener
)) {
829 goto error_testpoint
;
833 health_code_update();
835 DBG("Listener accepting connections");
839 ret
= lttng_poll_wait(&events
, -1);
843 * Restart interrupted system call.
845 if (errno
== EINTR
) {
853 DBG("Relay new connection received");
854 for (i
= 0; i
< nb_fd
; i
++) {
855 health_code_update();
857 /* Fetch once the poll data */
858 revents
= LTTNG_POLL_GETEV(&events
, i
);
859 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
861 /* Thread quit pipe has been closed. Killing thread. */
862 ret
= check_thread_quit_pipe(pollfd
, revents
);
868 if (revents
& LPOLLIN
) {
870 * A new connection is requested, therefore a
871 * sessiond/consumerd connection is allocated in
872 * this thread, enqueued to a global queue and
873 * dequeued (and freed) in the worker thread.
876 struct relay_connection
*new_conn
;
877 struct lttcomm_sock
*newsock
;
878 enum connection_type type
;
880 if (pollfd
== data_sock
->fd
) {
882 newsock
= data_sock
->ops
->accept(data_sock
);
883 DBG("Relay data connection accepted, socket %d",
886 assert(pollfd
== control_sock
->fd
);
887 type
= RELAY_CONTROL
;
888 newsock
= control_sock
->ops
->accept(control_sock
);
889 DBG("Relay control connection accepted, socket %d",
893 PERROR("accepting sock");
897 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
900 PERROR("setsockopt inet");
901 lttcomm_destroy_sock(newsock
);
905 ret
= socket_apply_keep_alive_config(newsock
->fd
);
907 ERR("Failed to apply TCP keep-alive configuration on socket (%i)",
909 lttcomm_destroy_sock(newsock
);
913 new_conn
= connection_create(newsock
, type
);
915 lttcomm_destroy_sock(newsock
);
919 /* Enqueue request for the dispatcher thread. */
920 cds_wfcq_enqueue(&relay_conn_queue
.head
, &relay_conn_queue
.tail
,
924 * Wake the dispatch queue futex.
925 * Implicit memory barrier with the
926 * exchange in cds_wfcq_enqueue.
928 futex_nto1_wake(&relay_conn_queue
.futex
);
929 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
930 ERR("socket poll error");
933 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
943 lttng_poll_clean(&events
);
945 if (data_sock
->fd
>= 0) {
946 ret
= data_sock
->ops
->close(data_sock
);
951 lttcomm_destroy_sock(data_sock
);
953 if (control_sock
->fd
>= 0) {
954 ret
= control_sock
->ops
->close(control_sock
);
959 lttcomm_destroy_sock(control_sock
);
963 ERR("Health error occurred in %s", __func__
);
965 health_unregister(health_relayd
);
966 DBG("Relay listener thread cleanup complete");
967 lttng_relay_stop_threads();
972 * This thread manages the dispatching of the requests to worker threads
974 static void *relay_thread_dispatcher(void *data
)
978 struct cds_wfcq_node
*node
;
979 struct relay_connection
*new_conn
= NULL
;
981 DBG("[thread] Relay dispatcher started");
983 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
985 if (testpoint(relayd_thread_dispatcher
)) {
986 goto error_testpoint
;
989 health_code_update();
992 health_code_update();
994 /* Atomically prepare the queue futex */
995 futex_nto1_prepare(&relay_conn_queue
.futex
);
997 if (CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1002 health_code_update();
1004 /* Dequeue commands */
1005 node
= cds_wfcq_dequeue_blocking(&relay_conn_queue
.head
,
1006 &relay_conn_queue
.tail
);
1008 DBG("Woken up but nothing in the relay command queue");
1009 /* Continue thread execution */
1012 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
1014 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
1017 * Inform worker thread of the new request. This
1018 * call is blocking so we can be assured that
1019 * the data will be read at some point in time
1020 * or wait to the end of the world :)
1022 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
1024 PERROR("write connection pipe");
1025 connection_put(new_conn
);
1028 } while (node
!= NULL
);
1030 /* Futex wait on queue. Blocking call on futex() */
1031 health_poll_entry();
1032 futex_nto1_wait(&relay_conn_queue
.futex
);
1036 /* Normal exit, no error */
1043 ERR("Health error occurred in %s", __func__
);
1045 health_unregister(health_relayd
);
1046 DBG("Dispatch thread dying");
1047 lttng_relay_stop_threads();
1052 * Set index data from the control port to a given index object.
1054 static int set_index_control_data(struct relay_index
*index
,
1055 struct lttcomm_relayd_index
*data
,
1056 struct relay_connection
*conn
)
1058 struct ctf_packet_index index_data
;
1061 * The index on disk is encoded in big endian.
1063 index_data
.packet_size
= htobe64(data
->packet_size
);
1064 index_data
.content_size
= htobe64(data
->content_size
);
1065 index_data
.timestamp_begin
= htobe64(data
->timestamp_begin
);
1066 index_data
.timestamp_end
= htobe64(data
->timestamp_end
);
1067 index_data
.events_discarded
= htobe64(data
->events_discarded
);
1068 index_data
.stream_id
= htobe64(data
->stream_id
);
1070 if (conn
->minor
>= 8) {
1071 index
->index_data
.stream_instance_id
= htobe64(data
->stream_instance_id
);
1072 index
->index_data
.packet_seq_num
= htobe64(data
->packet_seq_num
);
1075 return relay_index_set_data(index
, &index_data
);
1078 static bool session_streams_have_index(const struct relay_session
*session
)
1080 return session
->minor
>= 4 && !session
->snapshot
;
1084 * Handle the RELAYD_CREATE_SESSION command.
1086 * On success, send back the session id or else return a negative value.
1088 static int relay_create_session(const struct lttcomm_relayd_hdr
*recv_hdr
,
1089 struct relay_connection
*conn
,
1090 const struct lttng_buffer_view
*payload
)
1094 struct relay_session
*session
= NULL
;
1095 struct lttcomm_relayd_status_session reply
;
1096 char session_name
[LTTNG_NAME_MAX
];
1097 char hostname
[LTTNG_HOST_NAME_MAX
];
1098 uint32_t live_timer
= 0;
1099 bool snapshot
= false;
1101 memset(session_name
, 0, LTTNG_NAME_MAX
);
1102 memset(hostname
, 0, LTTNG_HOST_NAME_MAX
);
1104 memset(&reply
, 0, sizeof(reply
));
1106 if (conn
->minor
< 4) {
1107 /* From 2.1 to 2.3 */
1109 } else if (conn
->minor
>= 4 && conn
->minor
< 11) {
1110 /* From 2.4 to 2.10 */
1111 ret
= cmd_create_session_2_4(payload
, session_name
,
1112 hostname
, &live_timer
, &snapshot
);
1114 /* From 2.11 to ... */
1115 ret
= cmd_create_session_2_11(payload
, session_name
,
1116 hostname
, &live_timer
, &snapshot
);
1123 session
= session_create(session_name
, hostname
, live_timer
,
1124 snapshot
, conn
->major
, conn
->minor
);
1129 assert(!conn
->session
);
1130 conn
->session
= session
;
1131 DBG("Created session %" PRIu64
, session
->id
);
1133 reply
.session_id
= htobe64(session
->id
);
1137 reply
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1139 reply
.ret_code
= htobe32(LTTNG_OK
);
1142 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1143 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1144 ERR("Failed to send \"create session\" command reply (ret = %zd)",
1148 if (ret
< 0 && session
) {
1149 session_put(session
);
1155 * When we have received all the streams and the metadata for a channel,
1156 * we make them visible to the viewer threads.
1158 static void publish_connection_local_streams(struct relay_connection
*conn
)
1160 struct relay_stream
*stream
;
1161 struct relay_session
*session
= conn
->session
;
1164 * We publish all streams belonging to a session atomically wrt
1167 pthread_mutex_lock(&session
->lock
);
1169 cds_list_for_each_entry_rcu(stream
, &session
->recv_list
,
1171 stream_publish(stream
);
1176 * Inform the viewer that there are new streams in the session.
1178 if (session
->viewer_attached
) {
1179 uatomic_set(&session
->new_streams
, 1);
1181 pthread_mutex_unlock(&session
->lock
);
1185 * relay_add_stream: allocate a new stream for a session
1187 static int relay_add_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1188 struct relay_connection
*conn
,
1189 const struct lttng_buffer_view
*payload
)
1193 struct relay_session
*session
= conn
->session
;
1194 struct relay_stream
*stream
= NULL
;
1195 struct lttcomm_relayd_status_stream reply
;
1196 struct ctf_trace
*trace
= NULL
;
1197 uint64_t stream_handle
= -1ULL;
1198 char *path_name
= NULL
, *channel_name
= NULL
;
1199 uint64_t tracefile_size
= 0, tracefile_count
= 0;
1200 struct relay_stream_chunk_id stream_chunk_id
= { 0 };
1202 if (!session
|| !conn
->version_check_done
) {
1203 ERR("Trying to add a stream before version check");
1205 goto end_no_session
;
1208 if (session
->minor
== 1) {
1210 ret
= cmd_recv_stream_2_1(payload
, &path_name
,
1212 } else if (session
->minor
> 1 && session
->minor
< 11) {
1213 /* From 2.2 to 2.10 */
1214 ret
= cmd_recv_stream_2_2(payload
, &path_name
,
1215 &channel_name
, &tracefile_size
, &tracefile_count
);
1217 /* From 2.11 to ... */
1218 ret
= cmd_recv_stream_2_11(payload
, &path_name
,
1219 &channel_name
, &tracefile_size
, &tracefile_count
,
1220 &stream_chunk_id
.value
);
1221 stream_chunk_id
.is_set
= true;
1228 trace
= ctf_trace_get_by_path_or_create(session
, path_name
);
1232 /* This stream here has one reference on the trace. */
1234 pthread_mutex_lock(&last_relay_stream_id_lock
);
1235 stream_handle
= ++last_relay_stream_id
;
1236 pthread_mutex_unlock(&last_relay_stream_id_lock
);
1238 /* We pass ownership of path_name and channel_name. */
1239 stream
= stream_create(trace
, stream_handle
, path_name
,
1240 channel_name
, tracefile_size
, tracefile_count
,
1243 channel_name
= NULL
;
1246 * Streams are the owners of their trace. Reference to trace is
1247 * kept within stream_create().
1249 ctf_trace_put(trace
);
1252 memset(&reply
, 0, sizeof(reply
));
1253 reply
.handle
= htobe64(stream_handle
);
1255 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1257 reply
.ret_code
= htobe32(LTTNG_OK
);
1260 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1261 sizeof(struct lttcomm_relayd_status_stream
), 0);
1262 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1263 ERR("Failed to send \"add stream\" command reply (ret = %zd)",
1275 * relay_close_stream: close a specific stream
1277 static int relay_close_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1278 struct relay_connection
*conn
,
1279 const struct lttng_buffer_view
*payload
)
1283 struct relay_session
*session
= conn
->session
;
1284 struct lttcomm_relayd_close_stream stream_info
;
1285 struct lttcomm_relayd_generic_reply reply
;
1286 struct relay_stream
*stream
;
1288 DBG("Close stream received");
1290 if (!session
|| !conn
->version_check_done
) {
1291 ERR("Trying to close a stream before version check");
1293 goto end_no_session
;
1296 if (payload
->size
< sizeof(stream_info
)) {
1297 ERR("Unexpected payload size in \"relay_close_stream\": expected >= %zu bytes, got %zu bytes",
1298 sizeof(stream_info
), payload
->size
);
1300 goto end_no_session
;
1302 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1303 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1304 stream_info
.last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1306 stream
= stream_get_by_id(stream_info
.stream_id
);
1313 * Set last_net_seq_num before the close flag. Required by data
1316 pthread_mutex_lock(&stream
->lock
);
1317 stream
->last_net_seq_num
= stream_info
.last_net_seq_num
;
1318 pthread_mutex_unlock(&stream
->lock
);
1321 * This is one of the conditions which may trigger a stream close
1322 * with the others being:
1323 * 1) A close command is received for a stream
1324 * 2) The control connection owning the stream is closed
1325 * 3) We have received all of the stream's data _after_ a close
1328 try_stream_close(stream
);
1329 if (stream
->is_metadata
) {
1330 struct relay_viewer_stream
*vstream
;
1332 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
1334 if (vstream
->metadata_sent
== stream
->metadata_received
) {
1336 * Since all the metadata has been sent to the
1337 * viewer and that we have a request to close
1338 * its stream, we can safely teardown the
1339 * corresponding metadata viewer stream.
1341 viewer_stream_put(vstream
);
1343 /* Put local reference. */
1344 viewer_stream_put(vstream
);
1351 memset(&reply
, 0, sizeof(reply
));
1353 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1355 reply
.ret_code
= htobe32(LTTNG_OK
);
1357 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1358 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1359 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1360 ERR("Failed to send \"close stream\" command reply (ret = %zd)",
1370 * relay_reset_metadata: reset a metadata stream
1373 int relay_reset_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1374 struct relay_connection
*conn
,
1375 const struct lttng_buffer_view
*payload
)
1379 struct relay_session
*session
= conn
->session
;
1380 struct lttcomm_relayd_reset_metadata stream_info
;
1381 struct lttcomm_relayd_generic_reply reply
;
1382 struct relay_stream
*stream
;
1384 DBG("Reset metadata received");
1386 if (!session
|| !conn
->version_check_done
) {
1387 ERR("Trying to reset a metadata stream before version check");
1389 goto end_no_session
;
1392 if (payload
->size
< sizeof(stream_info
)) {
1393 ERR("Unexpected payload size in \"relay_reset_metadata\": expected >= %zu bytes, got %zu bytes",
1394 sizeof(stream_info
), payload
->size
);
1396 goto end_no_session
;
1398 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1399 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1400 stream_info
.version
= be64toh(stream_info
.version
);
1402 DBG("Update metadata to version %" PRIu64
, stream_info
.version
);
1404 /* Unsupported for live sessions for now. */
1405 if (session
->live_timer
!= 0) {
1410 stream
= stream_get_by_id(stream_info
.stream_id
);
1415 pthread_mutex_lock(&stream
->lock
);
1416 if (!stream
->is_metadata
) {
1421 ret
= utils_rotate_stream_file(stream
->path_name
, stream
->channel_name
,
1422 0, 0, -1, -1, stream
->stream_fd
->fd
, NULL
,
1423 &stream
->stream_fd
->fd
);
1425 ERR("Failed to rotate metadata file %s of channel %s",
1426 stream
->path_name
, stream
->channel_name
);
1431 pthread_mutex_unlock(&stream
->lock
);
1435 memset(&reply
, 0, sizeof(reply
));
1437 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1439 reply
.ret_code
= htobe32(LTTNG_OK
);
1441 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1442 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1443 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1444 ERR("Failed to send \"reset metadata\" command reply (ret = %zd)",
1454 * relay_unknown_command: send -1 if received unknown command
1456 static void relay_unknown_command(struct relay_connection
*conn
)
1458 struct lttcomm_relayd_generic_reply reply
;
1461 memset(&reply
, 0, sizeof(reply
));
1462 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1463 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1464 if (send_ret
< sizeof(reply
)) {
1465 ERR("Failed to send \"unknown command\" command reply (ret = %zd)", send_ret
);
1470 * relay_start: send an acknowledgment to the client to tell if we are
1471 * ready to receive data. We are ready if a session is established.
1473 static int relay_start(const struct lttcomm_relayd_hdr
*recv_hdr
,
1474 struct relay_connection
*conn
,
1475 const struct lttng_buffer_view
*payload
)
1479 struct lttcomm_relayd_generic_reply reply
;
1480 struct relay_session
*session
= conn
->session
;
1483 DBG("Trying to start the streaming without a session established");
1484 ret
= htobe32(LTTNG_ERR_UNK
);
1487 memset(&reply
, 0, sizeof(reply
));
1488 reply
.ret_code
= htobe32(LTTNG_OK
);
1489 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1491 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1492 ERR("Failed to send \"relay_start\" command reply (ret = %zd)",
1501 * Append padding to the file pointed by the file descriptor fd.
1503 static int write_padding_to_file(int fd
, uint32_t size
)
1512 zeros
= zmalloc(size
);
1513 if (zeros
== NULL
) {
1514 PERROR("zmalloc zeros for padding");
1519 ret
= lttng_write(fd
, zeros
, size
);
1521 PERROR("write padding to file");
1531 * Close the current index file if it is open, and create a new one.
1533 * Return 0 on success, -1 on error.
1536 int create_rotate_index_file(struct relay_stream
*stream
,
1537 const char *stream_path
)
1540 uint32_t major
, minor
;
1542 /* Put ref on previous index_file. */
1543 if (stream
->index_file
) {
1544 lttng_index_file_put(stream
->index_file
);
1545 stream
->index_file
= NULL
;
1547 major
= stream
->trace
->session
->major
;
1548 minor
= stream
->trace
->session
->minor
;
1549 stream
->index_file
= lttng_index_file_create(stream_path
,
1550 stream
->channel_name
,
1551 -1, -1, stream
->tracefile_size
,
1552 tracefile_array_get_file_index_head(stream
->tfa
),
1553 lttng_to_index_major(major
, minor
),
1554 lttng_to_index_minor(major
, minor
));
1555 if (!stream
->index_file
) {
1567 int do_rotate_stream_data(struct relay_stream
*stream
)
1571 DBG("Rotating stream %" PRIu64
" data file",
1572 stream
->stream_handle
);
1573 /* Perform the stream rotation. */
1574 ret
= utils_rotate_stream_file(stream
->path_name
,
1575 stream
->channel_name
, stream
->tracefile_size
,
1576 stream
->tracefile_count
, -1,
1577 -1, stream
->stream_fd
->fd
,
1578 NULL
, &stream
->stream_fd
->fd
);
1580 ERR("Rotating stream output file");
1583 stream
->tracefile_size_current
= 0;
1584 stream
->pos_after_last_complete_data_index
= 0;
1585 stream
->data_rotated
= true;
1587 if (stream
->data_rotated
&& stream
->index_rotated
) {
1588 /* Rotation completed; reset its state. */
1589 DBG("Rotation completed for stream %" PRIu64
,
1590 stream
->stream_handle
);
1591 stream
->rotate_at_seq_num
= -1ULL;
1592 stream
->data_rotated
= false;
1593 stream
->index_rotated
= false;
1600 * If too much data has been written in a tracefile before we received the
1601 * rotation command, we have to move the excess data to the new tracefile and
1602 * perform the rotation. This can happen because the control and data
1603 * connections are separate, the indexes as well as the commands arrive from
1604 * the control connection and we have no control over the order so we could be
1605 * in a situation where too much data has been received on the data connection
1606 * before the rotation command on the control connection arrives.
1609 int rotate_truncate_stream(struct relay_stream
*stream
)
1613 uint64_t diff
, pos
= 0;
1614 char buf
[FILE_COPY_BUFFER_SIZE
];
1616 assert(!stream
->is_metadata
);
1618 assert(stream
->tracefile_size_current
>
1619 stream
->pos_after_last_complete_data_index
);
1620 diff
= stream
->tracefile_size_current
-
1621 stream
->pos_after_last_complete_data_index
;
1623 /* Create the new tracefile. */
1624 new_fd
= utils_create_stream_file(stream
->path_name
,
1625 stream
->channel_name
,
1626 stream
->tracefile_size
, stream
->tracefile_count
,
1627 /* uid */ -1, /* gid */ -1, /* suffix */ NULL
);
1629 ERR("Failed to create new stream file at path %s for channel %s",
1630 stream
->path_name
, stream
->channel_name
);
1636 * Rewind the current tracefile to the position at which the rotation
1637 * should have occurred.
1639 lseek_ret
= lseek(stream
->stream_fd
->fd
,
1640 stream
->pos_after_last_complete_data_index
, SEEK_SET
);
1641 if (lseek_ret
< 0) {
1642 PERROR("seek truncate stream");
1647 /* Move data from the old file to the new file. */
1648 while (pos
< diff
) {
1649 uint64_t count
, bytes_left
;
1652 bytes_left
= diff
- pos
;
1653 count
= bytes_left
> sizeof(buf
) ? sizeof(buf
) : bytes_left
;
1654 assert(count
<= SIZE_MAX
);
1656 io_ret
= lttng_read(stream
->stream_fd
->fd
, buf
, count
);
1657 if (io_ret
< (ssize_t
) count
) {
1658 char error_string
[256];
1660 snprintf(error_string
, sizeof(error_string
),
1661 "Failed to read %" PRIu64
" bytes from fd %i in rotate_truncate_stream(), returned %zi",
1662 count
, stream
->stream_fd
->fd
, io_ret
);
1664 PERROR("%s", error_string
);
1666 ERR("%s", error_string
);
1672 io_ret
= lttng_write(new_fd
, buf
, count
);
1673 if (io_ret
< (ssize_t
) count
) {
1674 char error_string
[256];
1676 snprintf(error_string
, sizeof(error_string
),
1677 "Failed to write %" PRIu64
" bytes from fd %i in rotate_truncate_stream(), returned %zi",
1678 count
, new_fd
, io_ret
);
1680 PERROR("%s", error_string
);
1682 ERR("%s", error_string
);
1691 /* Truncate the file to get rid of the excess data. */
1692 ret
= ftruncate(stream
->stream_fd
->fd
,
1693 stream
->pos_after_last_complete_data_index
);
1695 PERROR("ftruncate");
1699 ret
= close(stream
->stream_fd
->fd
);
1701 PERROR("Closing tracefile");
1706 * Update the offset and FD of all the eventual indexes created by the
1707 * data connection before the rotation command arrived.
1709 ret
= relay_index_switch_all_files(stream
);
1711 ERR("Failed to rotate index file");
1715 stream
->stream_fd
->fd
= new_fd
;
1716 stream
->tracefile_size_current
= diff
;
1717 stream
->pos_after_last_complete_data_index
= 0;
1718 stream
->rotate_at_seq_num
= -1ULL;
1727 * Check if a stream's index file should be rotated (for session rotation).
1728 * Must be called with the stream lock held.
1730 * Return 0 on success, a negative value on error.
1733 int try_rotate_stream_index(struct relay_stream
*stream
)
1737 if (stream
->rotate_at_seq_num
== -1ULL) {
1738 /* No rotation expected. */
1742 if (stream
->index_rotated
) {
1743 /* Rotation of the index has already occurred. */
1747 if (stream
->prev_index_seq
== -1ULL ||
1748 stream
->prev_index_seq
< stream
->rotate_at_seq_num
) {
1749 DBG("Stream %" PRIu64
" index not yet ready for rotation (rotate_at_seq_num = %" PRIu64
", prev_index_seq = %" PRIu64
")",
1750 stream
->stream_handle
,
1751 stream
->rotate_at_seq_num
,
1752 stream
->prev_index_seq
);
1754 } else if (stream
->prev_index_seq
!= stream
->rotate_at_seq_num
) {
1756 * Unexpected, protocol error/bug.
1757 * It could mean that we received a rotation position
1758 * that is in the past.
1760 ERR("Stream %" PRIu64
" index is in an inconsistent state (rotate_at_seq_num = %" PRIu64
", prev_data_seq = %" PRIu64
", prev_index_seq = %" PRIu64
")",
1761 stream
->stream_handle
,
1762 stream
->rotate_at_seq_num
,
1763 stream
->prev_data_seq
,
1764 stream
->prev_index_seq
);
1768 DBG("Rotating stream %" PRIu64
" index file",
1769 stream
->stream_handle
);
1770 ret
= create_rotate_index_file(stream
, stream
->path_name
);
1771 stream
->index_rotated
= true;
1773 if (stream
->data_rotated
&& stream
->index_rotated
) {
1774 /* Rotation completed; reset its state. */
1775 DBG("Rotation completed for stream %" PRIu64
,
1776 stream
->stream_handle
);
1777 stream
->rotate_at_seq_num
= -1ULL;
1778 stream
->data_rotated
= false;
1779 stream
->index_rotated
= false;
1788 * Check if a stream's data file (as opposed to index) should be rotated
1789 * (for session rotation).
1790 * Must be called with the stream lock held.
1792 * Return 0 on success, a negative value on error.
1795 int try_rotate_stream_data(struct relay_stream
*stream
)
1799 if (stream
->rotate_at_seq_num
== -1ULL) {
1800 /* No rotation expected. */
1804 if (stream
->data_rotated
) {
1805 /* Rotation of the data file has already occurred. */
1809 if (stream
->prev_data_seq
== -1ULL ||
1810 stream
->prev_data_seq
< stream
->rotate_at_seq_num
) {
1811 DBG("Stream %" PRIu64
" not yet ready for rotation (rotate_at_seq_num = %" PRIu64
", prev_data_seq = %" PRIu64
")",
1812 stream
->stream_handle
,
1813 stream
->rotate_at_seq_num
,
1814 stream
->prev_data_seq
);
1816 } else if (stream
->prev_data_seq
> stream
->rotate_at_seq_num
) {
1818 * prev_data_seq is checked here since indexes and rotation
1819 * commands are serialized with respect to each other.
1821 DBG("Rotation after too much data has been written in tracefile "
1822 "for stream %" PRIu64
", need to truncate before "
1823 "rotating", stream
->stream_handle
);
1824 ret
= rotate_truncate_stream(stream
);
1826 ERR("Failed to truncate stream");
1829 } else if (stream
->prev_data_seq
!= stream
->rotate_at_seq_num
) {
1831 * Unexpected, protocol error/bug.
1832 * It could mean that we received a rotation position
1833 * that is in the past.
1835 ERR("Stream %" PRIu64
" data is in an inconsistent state (rotate_at_seq_num = %" PRIu64
", prev_data_seq = %" PRIu64
")",
1836 stream
->stream_handle
,
1837 stream
->rotate_at_seq_num
,
1838 stream
->prev_data_seq
);
1842 ret
= do_rotate_stream_data(stream
);
1850 * relay_recv_metadata: receive the metadata for the session.
1852 static int relay_recv_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1853 struct relay_connection
*conn
,
1854 const struct lttng_buffer_view
*payload
)
1858 struct relay_session
*session
= conn
->session
;
1859 struct lttcomm_relayd_metadata_payload metadata_payload_header
;
1860 struct relay_stream
*metadata_stream
;
1861 uint64_t metadata_payload_size
;
1864 ERR("Metadata sent before version check");
1869 if (recv_hdr
->data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1870 ERR("Incorrect data size");
1874 metadata_payload_size
= recv_hdr
->data_size
-
1875 sizeof(struct lttcomm_relayd_metadata_payload
);
1877 memcpy(&metadata_payload_header
, payload
->data
,
1878 sizeof(metadata_payload_header
));
1879 metadata_payload_header
.stream_id
= be64toh(
1880 metadata_payload_header
.stream_id
);
1881 metadata_payload_header
.padding_size
= be32toh(
1882 metadata_payload_header
.padding_size
);
1884 metadata_stream
= stream_get_by_id(metadata_payload_header
.stream_id
);
1885 if (!metadata_stream
) {
1890 pthread_mutex_lock(&metadata_stream
->lock
);
1892 size_ret
= lttng_write(metadata_stream
->stream_fd
->fd
,
1893 payload
->data
+ sizeof(metadata_payload_header
),
1894 metadata_payload_size
);
1895 if (size_ret
< metadata_payload_size
) {
1896 ERR("Relay error writing metadata on file");
1901 size_ret
= write_padding_to_file(metadata_stream
->stream_fd
->fd
,
1902 metadata_payload_header
.padding_size
);
1903 if (size_ret
< (int64_t) metadata_payload_header
.padding_size
) {
1908 metadata_stream
->metadata_received
+=
1909 metadata_payload_size
+ metadata_payload_header
.padding_size
;
1910 DBG2("Relay metadata written. Updated metadata_received %" PRIu64
,
1911 metadata_stream
->metadata_received
);
1913 ret
= try_rotate_stream_data(metadata_stream
);
1919 pthread_mutex_unlock(&metadata_stream
->lock
);
1920 stream_put(metadata_stream
);
1926 * relay_send_version: send relayd version number
1928 static int relay_send_version(const struct lttcomm_relayd_hdr
*recv_hdr
,
1929 struct relay_connection
*conn
,
1930 const struct lttng_buffer_view
*payload
)
1934 struct lttcomm_relayd_version reply
, msg
;
1935 bool compatible
= true;
1937 conn
->version_check_done
= true;
1939 /* Get version from the other side. */
1940 if (payload
->size
< sizeof(msg
)) {
1941 ERR("Unexpected payload size in \"relay_send_version\": expected >= %zu bytes, got %zu bytes",
1942 sizeof(msg
), payload
->size
);
1947 memcpy(&msg
, payload
->data
, sizeof(msg
));
1948 msg
.major
= be32toh(msg
.major
);
1949 msg
.minor
= be32toh(msg
.minor
);
1951 memset(&reply
, 0, sizeof(reply
));
1952 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
1953 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
1955 /* Major versions must be the same */
1956 if (reply
.major
!= msg
.major
) {
1957 DBG("Incompatible major versions (%u vs %u), deleting session",
1958 reply
.major
, msg
.major
);
1962 conn
->major
= reply
.major
;
1963 /* We adapt to the lowest compatible version */
1964 if (reply
.minor
<= msg
.minor
) {
1965 conn
->minor
= reply
.minor
;
1967 conn
->minor
= msg
.minor
;
1970 reply
.major
= htobe32(reply
.major
);
1971 reply
.minor
= htobe32(reply
.minor
);
1972 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1974 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1975 ERR("Failed to send \"send version\" command reply (ret = %zd)",
1988 DBG("Version check done using protocol %u.%u", conn
->major
,
1996 * Check for data pending for a given stream id from the session daemon.
1998 static int relay_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
1999 struct relay_connection
*conn
,
2000 const struct lttng_buffer_view
*payload
)
2002 struct relay_session
*session
= conn
->session
;
2003 struct lttcomm_relayd_data_pending msg
;
2004 struct lttcomm_relayd_generic_reply reply
;
2005 struct relay_stream
*stream
;
2008 uint64_t stream_seq
;
2010 DBG("Data pending command received");
2012 if (!session
|| !conn
->version_check_done
) {
2013 ERR("Trying to check for data before version check");
2015 goto end_no_session
;
2018 if (payload
->size
< sizeof(msg
)) {
2019 ERR("Unexpected payload size in \"relay_data_pending\": expected >= %zu bytes, got %zu bytes",
2020 sizeof(msg
), payload
->size
);
2022 goto end_no_session
;
2024 memcpy(&msg
, payload
->data
, sizeof(msg
));
2025 msg
.stream_id
= be64toh(msg
.stream_id
);
2026 msg
.last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
2028 stream
= stream_get_by_id(msg
.stream_id
);
2029 if (stream
== NULL
) {
2034 pthread_mutex_lock(&stream
->lock
);
2036 if (session_streams_have_index(session
)) {
2038 * Ensure that both the index and stream data have been
2039 * flushed up to the requested point.
2041 stream_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
2043 stream_seq
= stream
->prev_data_seq
;
2045 DBG("Data pending for stream id %" PRIu64
": prev_data_seq %" PRIu64
2046 ", prev_index_seq %" PRIu64
2047 ", and last_seq %" PRIu64
, msg
.stream_id
,
2048 stream
->prev_data_seq
, stream
->prev_index_seq
,
2049 msg
.last_net_seq_num
);
2051 /* Avoid wrapping issue */
2052 if (((int64_t) (stream_seq
- msg
.last_net_seq_num
)) >= 0) {
2053 /* Data has in fact been written and is NOT pending */
2056 /* Data still being streamed thus pending */
2060 stream
->data_pending_check_done
= true;
2061 pthread_mutex_unlock(&stream
->lock
);
2066 memset(&reply
, 0, sizeof(reply
));
2067 reply
.ret_code
= htobe32(ret
);
2068 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2069 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2070 ERR("Failed to send \"data pending\" command reply (ret = %zd)",
2080 * Wait for the control socket to reach a quiescent state.
2082 * Note that for now, when receiving this command from the session
2083 * daemon, this means that every subsequent commands or data received on
2084 * the control socket has been handled. So, this is why we simply return
2087 static int relay_quiescent_control(const struct lttcomm_relayd_hdr
*recv_hdr
,
2088 struct relay_connection
*conn
,
2089 const struct lttng_buffer_view
*payload
)
2093 struct relay_stream
*stream
;
2094 struct lttcomm_relayd_quiescent_control msg
;
2095 struct lttcomm_relayd_generic_reply reply
;
2097 DBG("Checking quiescent state on control socket");
2099 if (!conn
->session
|| !conn
->version_check_done
) {
2100 ERR("Trying to check for data before version check");
2102 goto end_no_session
;
2105 if (payload
->size
< sizeof(msg
)) {
2106 ERR("Unexpected payload size in \"relay_quiescent_control\": expected >= %zu bytes, got %zu bytes",
2107 sizeof(msg
), payload
->size
);
2109 goto end_no_session
;
2111 memcpy(&msg
, payload
->data
, sizeof(msg
));
2112 msg
.stream_id
= be64toh(msg
.stream_id
);
2114 stream
= stream_get_by_id(msg
.stream_id
);
2118 pthread_mutex_lock(&stream
->lock
);
2119 stream
->data_pending_check_done
= true;
2120 pthread_mutex_unlock(&stream
->lock
);
2122 DBG("Relay quiescent control pending flag set to %" PRIu64
, msg
.stream_id
);
2125 memset(&reply
, 0, sizeof(reply
));
2126 reply
.ret_code
= htobe32(LTTNG_OK
);
2127 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2128 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2129 ERR("Failed to send \"quiescent control\" command reply (ret = %zd)",
2141 * Initialize a data pending command. This means that a consumer is about
2142 * to ask for data pending for each stream it holds. Simply iterate over
2143 * all streams of a session and set the data_pending_check_done flag.
2145 * This command returns to the client a LTTNG_OK code.
2147 static int relay_begin_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2148 struct relay_connection
*conn
,
2149 const struct lttng_buffer_view
*payload
)
2153 struct lttng_ht_iter iter
;
2154 struct lttcomm_relayd_begin_data_pending msg
;
2155 struct lttcomm_relayd_generic_reply reply
;
2156 struct relay_stream
*stream
;
2161 DBG("Init streams for data pending");
2163 if (!conn
->session
|| !conn
->version_check_done
) {
2164 ERR("Trying to check for data before version check");
2166 goto end_no_session
;
2169 if (payload
->size
< sizeof(msg
)) {
2170 ERR("Unexpected payload size in \"relay_begin_data_pending\": expected >= %zu bytes, got %zu bytes",
2171 sizeof(msg
), payload
->size
);
2173 goto end_no_session
;
2175 memcpy(&msg
, payload
->data
, sizeof(msg
));
2176 msg
.session_id
= be64toh(msg
.session_id
);
2179 * Iterate over all streams to set the begin data pending flag.
2180 * For now, the streams are indexed by stream handle so we have
2181 * to iterate over all streams to find the one associated with
2182 * the right session_id.
2185 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2187 if (!stream_get(stream
)) {
2190 if (stream
->trace
->session
->id
== msg
.session_id
) {
2191 pthread_mutex_lock(&stream
->lock
);
2192 stream
->data_pending_check_done
= false;
2193 pthread_mutex_unlock(&stream
->lock
);
2194 DBG("Set begin data pending flag to stream %" PRIu64
,
2195 stream
->stream_handle
);
2201 memset(&reply
, 0, sizeof(reply
));
2202 /* All good, send back reply. */
2203 reply
.ret_code
= htobe32(LTTNG_OK
);
2205 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2206 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2207 ERR("Failed to send \"begin data pending\" command reply (ret = %zd)",
2219 * End data pending command. This will check, for a given session id, if
2220 * each stream associated with it has its data_pending_check_done flag
2221 * set. If not, this means that the client lost track of the stream but
2222 * the data is still being streamed on our side. In this case, we inform
2223 * the client that data is in flight.
2225 * Return to the client if there is data in flight or not with a ret_code.
2227 static int relay_end_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2228 struct relay_connection
*conn
,
2229 const struct lttng_buffer_view
*payload
)
2233 struct lttng_ht_iter iter
;
2234 struct lttcomm_relayd_end_data_pending msg
;
2235 struct lttcomm_relayd_generic_reply reply
;
2236 struct relay_stream
*stream
;
2237 uint32_t is_data_inflight
= 0;
2239 DBG("End data pending command");
2241 if (!conn
->session
|| !conn
->version_check_done
) {
2242 ERR("Trying to check for data before version check");
2244 goto end_no_session
;
2247 if (payload
->size
< sizeof(msg
)) {
2248 ERR("Unexpected payload size in \"relay_end_data_pending\": expected >= %zu bytes, got %zu bytes",
2249 sizeof(msg
), payload
->size
);
2251 goto end_no_session
;
2253 memcpy(&msg
, payload
->data
, sizeof(msg
));
2254 msg
.session_id
= be64toh(msg
.session_id
);
2257 * Iterate over all streams to see if the begin data pending
2261 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2263 if (!stream_get(stream
)) {
2266 if (stream
->trace
->session
->id
!= msg
.session_id
) {
2270 pthread_mutex_lock(&stream
->lock
);
2271 if (!stream
->data_pending_check_done
) {
2272 uint64_t stream_seq
;
2274 if (session_streams_have_index(conn
->session
)) {
2276 * Ensure that both the index and stream data have been
2277 * flushed up to the requested point.
2279 stream_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
2281 stream_seq
= stream
->prev_data_seq
;
2283 if (!stream
->closed
|| !(((int64_t) (stream_seq
- stream
->last_net_seq_num
)) >= 0)) {
2284 is_data_inflight
= 1;
2285 DBG("Data is still in flight for stream %" PRIu64
,
2286 stream
->stream_handle
);
2287 pthread_mutex_unlock(&stream
->lock
);
2292 pthread_mutex_unlock(&stream
->lock
);
2297 memset(&reply
, 0, sizeof(reply
));
2298 /* All good, send back reply. */
2299 reply
.ret_code
= htobe32(is_data_inflight
);
2301 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2302 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2303 ERR("Failed to send \"end data pending\" command reply (ret = %zd)",
2315 * Receive an index for a specific stream.
2317 * Return 0 on success else a negative value.
2319 static int relay_recv_index(const struct lttcomm_relayd_hdr
*recv_hdr
,
2320 struct relay_connection
*conn
,
2321 const struct lttng_buffer_view
*payload
)
2325 struct relay_session
*session
= conn
->session
;
2326 struct lttcomm_relayd_index index_info
;
2327 struct relay_index
*index
;
2328 struct lttcomm_relayd_generic_reply reply
;
2329 struct relay_stream
*stream
;
2334 DBG("Relay receiving index");
2336 if (!session
|| !conn
->version_check_done
) {
2337 ERR("Trying to close a stream before version check");
2339 goto end_no_session
;
2342 msg_len
= lttcomm_relayd_index_len(
2343 lttng_to_index_major(conn
->major
, conn
->minor
),
2344 lttng_to_index_minor(conn
->major
, conn
->minor
));
2345 if (payload
->size
< msg_len
) {
2346 ERR("Unexpected payload size in \"relay_recv_index\": expected >= %zu bytes, got %zu bytes",
2347 msg_len
, payload
->size
);
2349 goto end_no_session
;
2351 memcpy(&index_info
, payload
->data
, msg_len
);
2352 index_info
.relay_stream_id
= be64toh(index_info
.relay_stream_id
);
2353 index_info
.net_seq_num
= be64toh(index_info
.net_seq_num
);
2354 index_info
.packet_size
= be64toh(index_info
.packet_size
);
2355 index_info
.content_size
= be64toh(index_info
.content_size
);
2356 index_info
.timestamp_begin
= be64toh(index_info
.timestamp_begin
);
2357 index_info
.timestamp_end
= be64toh(index_info
.timestamp_end
);
2358 index_info
.events_discarded
= be64toh(index_info
.events_discarded
);
2359 index_info
.stream_id
= be64toh(index_info
.stream_id
);
2361 if (conn
->minor
>= 8) {
2362 index_info
.stream_instance_id
=
2363 be64toh(index_info
.stream_instance_id
);
2364 index_info
.packet_seq_num
= be64toh(index_info
.packet_seq_num
);
2367 stream
= stream_get_by_id(index_info
.relay_stream_id
);
2369 ERR("stream_get_by_id not found");
2373 pthread_mutex_lock(&stream
->lock
);
2375 /* Live beacon handling */
2376 if (index_info
.packet_size
== 0) {
2377 DBG("Received live beacon for stream %" PRIu64
,
2378 stream
->stream_handle
);
2381 * Only flag a stream inactive when it has already
2382 * received data and no indexes are in flight.
2384 if (stream
->index_received_seqcount
> 0
2385 && stream
->indexes_in_flight
== 0) {
2386 stream
->beacon_ts_end
= index_info
.timestamp_end
;
2389 goto end_stream_put
;
2391 stream
->beacon_ts_end
= -1ULL;
2394 if (stream
->ctf_stream_id
== -1ULL) {
2395 stream
->ctf_stream_id
= index_info
.stream_id
;
2397 index
= relay_index_get_by_id_or_create(stream
, index_info
.net_seq_num
);
2400 ERR("relay_index_get_by_id_or_create index NULL");
2401 goto end_stream_put
;
2403 if (set_index_control_data(index
, &index_info
, conn
)) {
2404 ERR("set_index_control_data error");
2405 relay_index_put(index
);
2407 goto end_stream_put
;
2409 ret
= relay_index_try_flush(index
);
2411 tracefile_array_commit_seq(stream
->tfa
);
2412 stream
->index_received_seqcount
++;
2413 stream
->pos_after_last_complete_data_index
+= index
->total_size
;
2414 stream
->prev_index_seq
= index_info
.net_seq_num
;
2416 ret
= try_rotate_stream_index(stream
);
2418 goto end_stream_put
;
2420 } else if (ret
> 0) {
2427 * relay_index_try_flush is responsible for the self-reference
2428 * put of the index object on error.
2430 ERR("relay_index_try_flush error %d", ret
);
2435 pthread_mutex_unlock(&stream
->lock
);
2440 memset(&reply
, 0, sizeof(reply
));
2442 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2444 reply
.ret_code
= htobe32(LTTNG_OK
);
2446 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2447 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2448 ERR("Failed to send \"recv index\" command reply (ret = %zd)", send_ret
);
2457 * Receive the streams_sent message.
2459 * Return 0 on success else a negative value.
2461 static int relay_streams_sent(const struct lttcomm_relayd_hdr
*recv_hdr
,
2462 struct relay_connection
*conn
,
2463 const struct lttng_buffer_view
*payload
)
2467 struct lttcomm_relayd_generic_reply reply
;
2471 DBG("Relay receiving streams_sent");
2473 if (!conn
->session
|| !conn
->version_check_done
) {
2474 ERR("Trying to close a stream before version check");
2476 goto end_no_session
;
2480 * Publish every pending stream in the connection recv list which are
2481 * now ready to be used by the viewer.
2483 publish_connection_local_streams(conn
);
2485 memset(&reply
, 0, sizeof(reply
));
2486 reply
.ret_code
= htobe32(LTTNG_OK
);
2487 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2488 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2489 ERR("Failed to send \"streams sent\" command reply (ret = %zd)",
2502 * relay_rotate_session_stream: rotate a stream to a new tracefile for the session
2503 * rotation feature (not the tracefile rotation feature).
2505 static int relay_rotate_session_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
2506 struct relay_connection
*conn
,
2507 const struct lttng_buffer_view
*payload
)
2511 struct relay_session
*session
= conn
->session
;
2512 struct lttcomm_relayd_rotate_stream stream_info
;
2513 struct lttcomm_relayd_generic_reply reply
;
2514 struct relay_stream
*stream
;
2517 struct lttng_buffer_view new_path_view
;
2519 DBG("Rotate stream received");
2521 if (!session
|| !conn
->version_check_done
) {
2522 ERR("Trying to rotate a stream before version check");
2527 if (session
->major
== 2 && session
->minor
< 11) {
2528 ERR("Unsupported feature before 2.11");
2533 header_len
= sizeof(struct lttcomm_relayd_rotate_stream
);
2535 if (payload
->size
< header_len
) {
2536 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected >= %zu bytes, got %zu bytes",
2537 header_len
, payload
->size
);
2542 memcpy(&stream_info
, payload
->data
, header_len
);
2544 /* Convert to host */
2545 stream_info
.pathname_length
= be32toh(stream_info
.pathname_length
);
2546 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
2547 stream_info
.new_chunk_id
= be64toh(stream_info
.new_chunk_id
);
2548 stream_info
.rotate_at_seq_num
= be64toh(stream_info
.rotate_at_seq_num
);
2550 path_len
= stream_info
.pathname_length
;
2551 if (payload
->size
< header_len
+ path_len
) {
2552 ERR("Unexpected payload size in \"relay_rotate_session_stream\" including path: expected >= %zu bytes, got %zu bytes",
2553 header_len
+ path_len
, payload
->size
);
2558 /* Ensure it fits in local filename length. */
2559 if (path_len
>= LTTNG_PATH_MAX
) {
2560 ret
= -ENAMETOOLONG
;
2561 ERR("Length of relay_rotate_session_stream command's path name (%zu bytes) exceeds the maximal allowed length of %i bytes",
2562 path_len
, LTTNG_PATH_MAX
);
2566 new_path_view
= lttng_buffer_view_from_view(payload
, header_len
,
2567 stream_info
.pathname_length
);
2569 stream
= stream_get_by_id(stream_info
.stream_id
);
2575 pthread_mutex_lock(&stream
->lock
);
2578 * Update the trace path (just the folder, the stream name does not
2581 free(stream
->prev_path_name
);
2582 stream
->prev_path_name
= stream
->path_name
;
2583 stream
->path_name
= create_output_path(new_path_view
.data
);
2584 if (!stream
->path_name
) {
2585 ERR("Failed to create a new output path");
2587 goto end_stream_unlock
;
2589 ret
= utils_mkdir_recursive(stream
->path_name
, S_IRWXU
| S_IRWXG
,
2592 ERR("relay creating output directory");
2594 goto end_stream_unlock
;
2597 assert(stream
->current_chunk_id
.is_set
);
2598 stream
->current_chunk_id
.value
= stream_info
.new_chunk_id
;
2600 if (stream
->is_metadata
) {
2602 * Metadata streams have no index; consider its rotation
2605 stream
->index_rotated
= true;
2607 * The metadata stream is sent only over the control connection
2608 * so we know we have all the data to perform the stream
2611 ret
= do_rotate_stream_data(stream
);
2613 stream
->rotate_at_seq_num
= stream_info
.rotate_at_seq_num
;
2614 ret
= try_rotate_stream_data(stream
);
2616 goto end_stream_unlock
;
2619 ret
= try_rotate_stream_index(stream
);
2621 goto end_stream_unlock
;
2626 pthread_mutex_unlock(&stream
->lock
);
2629 memset(&reply
, 0, sizeof(reply
));
2631 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2633 reply
.ret_code
= htobe32(LTTNG_OK
);
2635 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2636 sizeof(struct lttcomm_relayd_generic_reply
), 0);
2637 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2638 ERR("Failed to send \"rotate session stream\" command reply (ret = %zd)",
2648 * relay_mkdir: Create a folder on the disk.
2650 static int relay_mkdir(const struct lttcomm_relayd_hdr
*recv_hdr
,
2651 struct relay_connection
*conn
,
2652 const struct lttng_buffer_view
*payload
)
2655 struct relay_session
*session
= conn
->session
;
2656 struct lttcomm_relayd_mkdir path_info_header
;
2657 struct lttcomm_relayd_generic_reply reply
;
2661 struct lttng_buffer_view path_view
;
2663 if (!session
|| !conn
->version_check_done
) {
2664 ERR("Trying to create a directory before version check");
2666 goto end_no_session
;
2669 if (session
->major
== 2 && session
->minor
< 11) {
2671 * This client is not supposed to use this command since
2672 * it predates its introduction.
2674 ERR("relay_mkdir command is unsupported before LTTng 2.11");
2676 goto end_no_session
;
2679 header_len
= sizeof(path_info_header
);
2680 if (payload
->size
< header_len
) {
2681 ERR("Unexpected payload size in \"relay_mkdir\": expected >= %zu bytes, got %zu bytes",
2682 header_len
, payload
->size
);
2684 goto end_no_session
;
2687 memcpy(&path_info_header
, payload
->data
, header_len
);
2689 path_info_header
.length
= be32toh(path_info_header
.length
);
2691 if (payload
->size
< header_len
+ path_info_header
.length
) {
2692 ERR("Unexpected payload size in \"relay_mkdir\" including path: expected >= %zu bytes, got %zu bytes",
2693 header_len
+ path_info_header
.length
, payload
->size
);
2695 goto end_no_session
;
2698 /* Ensure that it fits in local path length. */
2699 if (path_info_header
.length
>= LTTNG_PATH_MAX
) {
2700 ret
= -ENAMETOOLONG
;
2701 ERR("Path name argument of mkdir command (%" PRIu32
" bytes) exceeds the maximal length allowed (%d bytes)",
2702 path_info_header
.length
, LTTNG_PATH_MAX
);
2706 path_view
= lttng_buffer_view_from_view(payload
, header_len
,
2707 path_info_header
.length
);
2709 path
= create_output_path(path_view
.data
);
2711 ERR("Failed to create output path");
2716 DBG("MKDIR command has path \"%s\", changed to \"%s\"", path_view
.data
, path
);
2717 ret
= utils_mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, -1, -1);
2719 ERR("relay creating output directory");
2726 memset(&reply
, 0, sizeof(reply
));
2728 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2730 reply
.ret_code
= htobe32(LTTNG_OK
);
2732 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2733 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2734 ERR("Failed to send \"mkdir\" command reply (ret = %zd)", send_ret
);
2743 static int validate_rotate_rename_path_length(const char *path_type
,
2744 uint32_t path_length
)
2748 if (path_length
> LTTNG_PATH_MAX
) {
2749 ret
= -ENAMETOOLONG
;
2750 ERR("rotate rename \"%s\" path name length (%" PRIu32
" bytes) exceeds the allowed size of %i bytes",
2751 path_type
, path_length
, LTTNG_PATH_MAX
);
2752 } else if (path_length
== 0) {
2754 ERR("rotate rename \"%s\" path name has an illegal length of 0", path_type
);
2760 * relay_rotate_rename: rename the trace folder after a rotation is
2761 * completed. We are not closing any fd here, just moving the folder, so it
2762 * works even if data is still in-flight.
2764 static int relay_rotate_rename(const struct lttcomm_relayd_hdr
*recv_hdr
,
2765 struct relay_connection
*conn
,
2766 const struct lttng_buffer_view
*payload
)
2770 struct relay_session
*session
= conn
->session
;
2771 struct lttcomm_relayd_generic_reply reply
;
2772 struct lttcomm_relayd_rotate_rename header
;
2774 size_t received_paths_size
;
2775 char *complete_old_path
= NULL
, *complete_new_path
= NULL
;
2776 struct lttng_buffer_view old_path_view
;
2777 struct lttng_buffer_view new_path_view
;
2779 if (!session
|| !conn
->version_check_done
) {
2780 ERR("Trying to rename a trace folder before version check");
2785 if (session
->major
== 2 && session
->minor
< 11) {
2786 ERR("relay_rotate_rename command is unsupported before LTTng 2.11");
2791 header_len
= sizeof(header
);
2792 if (payload
->size
< header_len
) {
2793 ERR("Unexpected payload size in \"relay_rotate_rename\": expected >= %zu bytes, got %zu bytes",
2794 header_len
, payload
->size
);
2799 memcpy(&header
, payload
->data
, header_len
);
2801 header
.old_path_length
= be32toh(header
.old_path_length
);
2802 header
.new_path_length
= be32toh(header
.new_path_length
);
2803 received_paths_size
= header
.old_path_length
+ header
.new_path_length
;
2805 if (payload
->size
< header_len
+ received_paths_size
) {
2806 ERR("Unexpected payload size in \"relay_rotate_rename\" including paths: expected >= %zu bytes, got %zu bytes",
2807 header_len
, payload
->size
);
2812 /* Ensure the paths don't exceed their allowed size. */
2813 ret
= validate_rotate_rename_path_length("old", header
.old_path_length
);
2817 ret
= validate_rotate_rename_path_length("new", header
.new_path_length
);
2822 old_path_view
= lttng_buffer_view_from_view(payload
, header_len
,
2823 header
.old_path_length
);
2824 new_path_view
= lttng_buffer_view_from_view(payload
,
2825 header_len
+ header
.old_path_length
,
2826 header
.new_path_length
);
2828 /* Validate that both paths received are NULL terminated. */
2829 if (old_path_view
.data
[old_path_view
.size
- 1] != '\0') {
2830 ERR("relay_rotate_rename command's \"old\" path is invalid (not NULL terminated)");
2834 if (new_path_view
.data
[new_path_view
.size
- 1] != '\0') {
2835 ERR("relay_rotate_rename command's \"new\" path is invalid (not NULL terminated)");
2840 DBG("ROTATE_RENAME command has argument old path = \"%s\", new_path = \"%s\"",
2841 old_path_view
.data
, new_path_view
.data
);
2842 complete_old_path
= create_output_path(old_path_view
.data
);
2843 if (!complete_old_path
) {
2844 ERR("Failed to build old output path in rotate_rename command");
2849 complete_new_path
= create_output_path(new_path_view
.data
);
2850 if (!complete_new_path
) {
2851 ERR("Failed to build new output path in rotate_rename command");
2855 DBG("Expanded ROTATE_RENAME arguments to old path = \"%s\", new_path = \"%s\"",
2856 complete_old_path
, complete_new_path
);
2858 ret
= utils_mkdir_recursive(complete_new_path
, S_IRWXU
| S_IRWXG
,
2861 ERR("Failed to mkdir() rotate_rename's \"new\" output directory at \"%s\"",
2867 * If a domain has not yet created its channel, the domain-specific
2868 * folder might not exist, but this is not an error.
2870 ret
= rename(complete_old_path
, complete_new_path
);
2871 if (ret
< 0 && errno
!= ENOENT
) {
2872 PERROR("Renaming chunk in rotate_rename command from \"%s\" to \"%s\"",
2873 complete_old_path
, complete_new_path
);
2879 memset(&reply
, 0, sizeof(reply
));
2881 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2883 reply
.ret_code
= htobe32(LTTNG_OK
);
2885 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2887 if (send_ret
< sizeof(reply
)) {
2888 ERR("Failed to send \"rotate rename\" command reply (ret = %zd)",
2894 free(complete_old_path
);
2895 free(complete_new_path
);
2900 * Check if all the streams in the session have completed the last rotation.
2901 * The chunk_id value is used to distinguish the cases where a stream was
2902 * closed on the consumerd before the rotation started but it still active on
2903 * the relayd, and the case where a stream appeared on the consumerd/relayd
2904 * after the last rotation started (in that case, it is already writing in the
2905 * new chunk folder).
2908 int relay_rotate_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2909 struct relay_connection
*conn
,
2910 const struct lttng_buffer_view
*payload
)
2912 struct relay_session
*session
= conn
->session
;
2913 struct lttcomm_relayd_rotate_pending msg
;
2914 struct lttcomm_relayd_rotate_pending_reply reply
;
2915 struct lttng_ht_iter iter
;
2916 struct relay_stream
*stream
;
2920 bool rotate_pending
= false;
2922 DBG("Rotate pending command received");
2924 if (!session
|| !conn
->version_check_done
) {
2925 ERR("Trying to check for data before version check");
2930 if (session
->major
== 2 && session
->minor
< 11) {
2931 ERR("Unsupported feature before 2.11");
2936 if (payload
->size
< sizeof(msg
)) {
2937 ERR("Unexpected payload size in \"relay_rotate_pending\": expected >= %zu bytes, got %zu bytes",
2938 sizeof(msg
), payload
->size
);
2943 memcpy(&msg
, payload
->data
, sizeof(msg
));
2945 chunk_id
= be64toh(msg
.chunk_id
);
2947 DBG("Evaluating rotate pending for session \"%s\" and chunk id %" PRIu64
,
2948 session
->session_name
, chunk_id
);
2951 * Iterate over all the streams in the session and check if they are
2952 * still waiting for data to perform their rotation.
2955 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2957 if (!stream_get(stream
)) {
2960 if (stream
->trace
->session
!= session
) {
2964 pthread_mutex_lock(&stream
->lock
);
2965 if (stream
->rotate_at_seq_num
!= -1ULL) {
2966 /* We have not yet performed the rotation. */
2967 rotate_pending
= true;
2968 DBG("Stream %" PRIu64
" is still rotating",
2969 stream
->stream_handle
);
2970 } else if (stream
->current_chunk_id
.value
<= chunk_id
) {
2972 * Stream closed on the consumer but still active on the
2975 rotate_pending
= true;
2976 DBG("Stream %" PRIu64
" did not exist on the consumer "
2977 "when the last rotation started, but is"
2978 "still waiting for data before getting"
2980 stream
->stream_handle
);
2982 pthread_mutex_unlock(&stream
->lock
);
2984 if (rotate_pending
) {
2991 memset(&reply
, 0, sizeof(reply
));
2992 reply
.generic
.ret_code
= htobe32((uint32_t) LTTNG_OK
);
2993 reply
.is_pending
= (uint8_t) !!rotate_pending
;
2994 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2996 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2997 ERR("Failed to send \"rotate pending\" command reply (ret = %zd)",
3006 #define DBG_CMD(cmd_name, conn) \
3007 DBG3("Processing \"%s\" command for socket %i", cmd_name, conn->sock->fd);
3009 static int relay_process_control_command(struct relay_connection
*conn
,
3010 const struct lttcomm_relayd_hdr
*header
,
3011 const struct lttng_buffer_view
*payload
)
3015 switch (header
->cmd
) {
3016 case RELAYD_CREATE_SESSION
:
3017 DBG_CMD("RELAYD_CREATE_SESSION", conn
);
3018 ret
= relay_create_session(header
, conn
, payload
);
3020 case RELAYD_ADD_STREAM
:
3021 DBG_CMD("RELAYD_ADD_STREAM", conn
);
3022 ret
= relay_add_stream(header
, conn
, payload
);
3024 case RELAYD_START_DATA
:
3025 DBG_CMD("RELAYD_START_DATA", conn
);
3026 ret
= relay_start(header
, conn
, payload
);
3028 case RELAYD_SEND_METADATA
:
3029 DBG_CMD("RELAYD_SEND_METADATA", conn
);
3030 ret
= relay_recv_metadata(header
, conn
, payload
);
3032 case RELAYD_VERSION
:
3033 DBG_CMD("RELAYD_VERSION", conn
);
3034 ret
= relay_send_version(header
, conn
, payload
);
3036 case RELAYD_CLOSE_STREAM
:
3037 DBG_CMD("RELAYD_CLOSE_STREAM", conn
);
3038 ret
= relay_close_stream(header
, conn
, payload
);
3040 case RELAYD_DATA_PENDING
:
3041 DBG_CMD("RELAYD_DATA_PENDING", conn
);
3042 ret
= relay_data_pending(header
, conn
, payload
);
3044 case RELAYD_QUIESCENT_CONTROL
:
3045 DBG_CMD("RELAYD_QUIESCENT_CONTROL", conn
);
3046 ret
= relay_quiescent_control(header
, conn
, payload
);
3048 case RELAYD_BEGIN_DATA_PENDING
:
3049 DBG_CMD("RELAYD_BEGIN_DATA_PENDING", conn
);
3050 ret
= relay_begin_data_pending(header
, conn
, payload
);
3052 case RELAYD_END_DATA_PENDING
:
3053 DBG_CMD("RELAYD_END_DATA_PENDING", conn
);
3054 ret
= relay_end_data_pending(header
, conn
, payload
);
3056 case RELAYD_SEND_INDEX
:
3057 DBG_CMD("RELAYD_SEND_INDEX", conn
);
3058 ret
= relay_recv_index(header
, conn
, payload
);
3060 case RELAYD_STREAMS_SENT
:
3061 DBG_CMD("RELAYD_STREAMS_SENT", conn
);
3062 ret
= relay_streams_sent(header
, conn
, payload
);
3064 case RELAYD_RESET_METADATA
:
3065 DBG_CMD("RELAYD_RESET_METADATA", conn
);
3066 ret
= relay_reset_metadata(header
, conn
, payload
);
3068 case RELAYD_ROTATE_STREAM
:
3069 DBG_CMD("RELAYD_ROTATE_STREAM", conn
);
3070 ret
= relay_rotate_session_stream(header
, conn
, payload
);
3072 case RELAYD_ROTATE_RENAME
:
3073 DBG_CMD("RELAYD_ROTATE_RENAME", conn
);
3074 ret
= relay_rotate_rename(header
, conn
, payload
);
3076 case RELAYD_ROTATE_PENDING
:
3077 DBG_CMD("RELAYD_ROTATE_PENDING", conn
);
3078 ret
= relay_rotate_pending(header
, conn
, payload
);
3081 DBG_CMD("RELAYD_MKDIR", conn
);
3082 ret
= relay_mkdir(header
, conn
, payload
);
3084 case RELAYD_UPDATE_SYNC_INFO
:
3086 ERR("Received unknown command (%u)", header
->cmd
);
3087 relay_unknown_command(conn
);
3096 static enum relay_connection_status
relay_process_control_receive_payload(
3097 struct relay_connection
*conn
)
3100 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3101 struct lttng_dynamic_buffer
*reception_buffer
=
3102 &conn
->protocol
.ctrl
.reception_buffer
;
3103 struct ctrl_connection_state_receive_payload
*state
=
3104 &conn
->protocol
.ctrl
.state
.receive_payload
;
3105 struct lttng_buffer_view payload_view
;
3107 if (state
->left_to_receive
== 0) {
3108 /* Short-circuit for payload-less commands. */
3109 goto reception_complete
;
3112 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3113 reception_buffer
->data
+ state
->received
,
3114 state
->left_to_receive
, MSG_DONTWAIT
);
3116 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3117 PERROR("Unable to receive command payload on sock %d",
3119 status
= RELAY_CONNECTION_STATUS_ERROR
;
3122 } else if (ret
== 0) {
3123 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3124 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3129 assert(ret
<= state
->left_to_receive
);
3131 state
->left_to_receive
-= ret
;
3132 state
->received
+= ret
;
3134 if (state
->left_to_receive
> 0) {
3136 * Can't transition to the protocol's next state, wait to
3137 * receive the rest of the header.
3139 DBG3("Partial reception of control connection protocol payload (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3140 state
->received
, state
->left_to_receive
,
3146 DBG("Done receiving control command payload: fd = %i, payload size = %" PRIu64
" bytes",
3147 conn
->sock
->fd
, state
->received
);
3149 * The payload required to process the command has been received.
3150 * A view to the reception buffer is forwarded to the various
3151 * commands and the state of the control is reset on success.
3153 * Commands are responsible for sending their reply to the peer.
3155 payload_view
= lttng_buffer_view_from_dynamic_buffer(reception_buffer
,
3157 ret
= relay_process_control_command(conn
,
3158 &state
->header
, &payload_view
);
3160 status
= RELAY_CONNECTION_STATUS_ERROR
;
3164 ret
= connection_reset_protocol_state(conn
);
3166 status
= RELAY_CONNECTION_STATUS_ERROR
;
3172 static enum relay_connection_status
relay_process_control_receive_header(
3173 struct relay_connection
*conn
)
3176 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3177 struct lttcomm_relayd_hdr header
;
3178 struct lttng_dynamic_buffer
*reception_buffer
=
3179 &conn
->protocol
.ctrl
.reception_buffer
;
3180 struct ctrl_connection_state_receive_header
*state
=
3181 &conn
->protocol
.ctrl
.state
.receive_header
;
3183 assert(state
->left_to_receive
!= 0);
3185 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3186 reception_buffer
->data
+ state
->received
,
3187 state
->left_to_receive
, MSG_DONTWAIT
);
3189 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3190 PERROR("Unable to receive control command header on sock %d",
3192 status
= RELAY_CONNECTION_STATUS_ERROR
;
3195 } else if (ret
== 0) {
3196 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3197 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3202 assert(ret
<= state
->left_to_receive
);
3204 state
->left_to_receive
-= ret
;
3205 state
->received
+= ret
;
3207 if (state
->left_to_receive
> 0) {
3209 * Can't transition to the protocol's next state, wait to
3210 * receive the rest of the header.
3212 DBG3("Partial reception of control connection protocol header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3213 state
->received
, state
->left_to_receive
,
3218 /* Transition to next state: receiving the command's payload. */
3219 conn
->protocol
.ctrl
.state_id
=
3220 CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3221 memcpy(&header
, reception_buffer
->data
, sizeof(header
));
3222 header
.circuit_id
= be64toh(header
.circuit_id
);
3223 header
.data_size
= be64toh(header
.data_size
);
3224 header
.cmd
= be32toh(header
.cmd
);
3225 header
.cmd_version
= be32toh(header
.cmd_version
);
3226 memcpy(&conn
->protocol
.ctrl
.state
.receive_payload
.header
,
3227 &header
, sizeof(header
));
3229 DBG("Done receiving control command header: fd = %i, cmd = %" PRIu32
", cmd_version = %" PRIu32
", payload size = %" PRIu64
" bytes",
3230 conn
->sock
->fd
, header
.cmd
, header
.cmd_version
,
3233 if (header
.data_size
> DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE
) {
3234 ERR("Command header indicates a payload (%" PRIu64
" bytes) that exceeds the maximal payload size allowed on a control connection.",
3236 status
= RELAY_CONNECTION_STATUS_ERROR
;
3240 conn
->protocol
.ctrl
.state
.receive_payload
.left_to_receive
=
3242 conn
->protocol
.ctrl
.state
.receive_payload
.received
= 0;
3243 ret
= lttng_dynamic_buffer_set_size(reception_buffer
,
3246 status
= RELAY_CONNECTION_STATUS_ERROR
;
3250 if (header
.data_size
== 0) {
3252 * Manually invoke the next state as the poll loop
3253 * will not wake-up to allow us to proceed further.
3255 status
= relay_process_control_receive_payload(conn
);
3262 * Process the commands received on the control socket
3264 static enum relay_connection_status
relay_process_control(
3265 struct relay_connection
*conn
)
3267 enum relay_connection_status status
;
3269 switch (conn
->protocol
.ctrl
.state_id
) {
3270 case CTRL_CONNECTION_STATE_RECEIVE_HEADER
:
3271 status
= relay_process_control_receive_header(conn
);
3273 case CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3274 status
= relay_process_control_receive_payload(conn
);
3277 ERR("Unknown control connection protocol state encountered.");
3285 * Handle index for a data stream.
3287 * Called with the stream lock held.
3289 * Return 0 on success else a negative value.
3291 static int handle_index_data(struct relay_stream
*stream
, uint64_t net_seq_num
,
3292 bool rotate_index
, bool *flushed
, uint64_t total_size
)
3295 uint64_t data_offset
;
3296 struct relay_index
*index
;
3298 /* Get data offset because we are about to update the index. */
3299 data_offset
= htobe64(stream
->tracefile_size_current
);
3301 DBG("handle_index_data: stream %" PRIu64
" net_seq_num %" PRIu64
" data offset %" PRIu64
,
3302 stream
->stream_handle
, net_seq_num
, stream
->tracefile_size_current
);
3305 * Lookup for an existing index for that stream id/sequence
3306 * number. If it exists, the control thread has already received the
3307 * data for it, thus we need to write it to disk.
3309 index
= relay_index_get_by_id_or_create(stream
, net_seq_num
);
3315 if (rotate_index
|| !stream
->index_file
) {
3316 const char *stream_path
;
3319 * The data connection creates the stream's first index file.
3321 * This can happen _after_ a ROTATE_STREAM command. In
3322 * other words, the data of the first packet of this stream
3323 * can be received after a ROTATE_STREAM command.
3325 * The ROTATE_STREAM command changes the stream's path_name
3326 * to point to the "next" chunk. If a rotation is pending for
3327 * this stream, as indicated by "rotate_at_seq_num != -1ULL",
3328 * it means that we are still receiving data that belongs in the
3329 * stream's former path.
3331 * In this very specific case, we must ensure that the index
3332 * file is created in the streams's former path,
3335 * All other rotations beyond the first one are not affected
3336 * by this problem since the actual rotation operation creates
3337 * the new chunk's index file.
3339 stream_path
= stream
->rotate_at_seq_num
== -1ULL ?
3341 stream
->prev_path_name
;
3343 ret
= create_rotate_index_file(stream
, stream_path
);
3345 ERR("Failed to rotate index");
3346 /* Put self-ref for this index due to error. */
3347 relay_index_put(index
);
3353 if (relay_index_set_file(index
, stream
->index_file
, data_offset
)) {
3355 /* Put self-ref for this index due to error. */
3356 relay_index_put(index
);
3361 ret
= relay_index_try_flush(index
);
3363 tracefile_array_commit_seq(stream
->tfa
);
3364 stream
->index_received_seqcount
++;
3366 } else if (ret
> 0) {
3367 index
->total_size
= total_size
;
3374 * relay_index_try_flush is responsible for the self-reference
3375 * put of the index object on error.
3377 ERR("relay_index_try_flush error %d", ret
);
3384 static enum relay_connection_status
relay_process_data_receive_header(
3385 struct relay_connection
*conn
)
3388 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3389 struct data_connection_state_receive_header
*state
=
3390 &conn
->protocol
.data
.state
.receive_header
;
3391 struct lttcomm_relayd_data_hdr header
;
3392 struct relay_stream
*stream
;
3394 assert(state
->left_to_receive
!= 0);
3396 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3397 state
->header_reception_buffer
+ state
->received
,
3398 state
->left_to_receive
, MSG_DONTWAIT
);
3400 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3401 PERROR("Unable to receive data header on sock %d", conn
->sock
->fd
);
3402 status
= RELAY_CONNECTION_STATUS_ERROR
;
3405 } else if (ret
== 0) {
3406 /* Orderly shutdown. Not necessary to print an error. */
3407 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3408 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3413 assert(ret
<= state
->left_to_receive
);
3415 state
->left_to_receive
-= ret
;
3416 state
->received
+= ret
;
3418 if (state
->left_to_receive
> 0) {
3420 * Can't transition to the protocol's next state, wait to
3421 * receive the rest of the header.
3423 DBG3("Partial reception of data connection header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3424 state
->received
, state
->left_to_receive
,
3429 /* Transition to next state: receiving the payload. */
3430 conn
->protocol
.data
.state_id
= DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3432 memcpy(&header
, state
->header_reception_buffer
, sizeof(header
));
3433 header
.circuit_id
= be64toh(header
.circuit_id
);
3434 header
.stream_id
= be64toh(header
.stream_id
);
3435 header
.data_size
= be32toh(header
.data_size
);
3436 header
.net_seq_num
= be64toh(header
.net_seq_num
);
3437 header
.padding_size
= be32toh(header
.padding_size
);
3438 memcpy(&conn
->protocol
.data
.state
.receive_payload
.header
, &header
, sizeof(header
));
3440 conn
->protocol
.data
.state
.receive_payload
.left_to_receive
=
3442 conn
->protocol
.data
.state
.receive_payload
.received
= 0;
3443 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= false;
3445 DBG("Received data connection header on fd %i: circuit_id = %" PRIu64
", stream_id = %" PRIu64
", data_size = %" PRIu32
", net_seq_num = %" PRIu64
", padding_size = %" PRIu32
,
3446 conn
->sock
->fd
, header
.circuit_id
,
3447 header
.stream_id
, header
.data_size
,
3448 header
.net_seq_num
, header
.padding_size
);
3450 stream
= stream_get_by_id(header
.stream_id
);
3452 DBG("relay_process_data_receive_payload: Cannot find stream %" PRIu64
,
3454 /* Protocol error. */
3455 status
= RELAY_CONNECTION_STATUS_ERROR
;
3459 pthread_mutex_lock(&stream
->lock
);
3461 /* Check if a rotation is needed. */
3462 if (stream
->tracefile_size
> 0 &&
3463 (stream
->tracefile_size_current
+ header
.data_size
) >
3464 stream
->tracefile_size
) {
3465 uint64_t old_id
, new_id
;
3467 old_id
= tracefile_array_get_file_index_head(stream
->tfa
);
3468 tracefile_array_file_rotate(stream
->tfa
);
3470 /* new_id is updated by utils_rotate_stream_file. */
3473 ret
= utils_rotate_stream_file(stream
->path_name
,
3474 stream
->channel_name
, stream
->tracefile_size
,
3475 stream
->tracefile_count
, -1,
3476 -1, stream
->stream_fd
->fd
,
3477 &new_id
, &stream
->stream_fd
->fd
);
3479 ERR("Failed to rotate stream output file");
3480 status
= RELAY_CONNECTION_STATUS_ERROR
;
3481 goto end_stream_unlock
;
3485 * Reset current size because we just performed a stream
3488 stream
->tracefile_size_current
= 0;
3489 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= true;
3493 pthread_mutex_unlock(&stream
->lock
);
3499 static enum relay_connection_status
relay_process_data_receive_payload(
3500 struct relay_connection
*conn
)
3503 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3504 struct relay_stream
*stream
;
3505 struct data_connection_state_receive_payload
*state
=
3506 &conn
->protocol
.data
.state
.receive_payload
;
3507 const size_t chunk_size
= RECV_DATA_BUFFER_SIZE
;
3508 char data_buffer
[chunk_size
];
3509 bool partial_recv
= false;
3510 bool new_stream
= false, close_requested
= false, index_flushed
= false;
3511 uint64_t left_to_receive
= state
->left_to_receive
;
3512 struct relay_session
*session
;
3514 DBG3("Receiving data for stream id %" PRIu64
" seqnum %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3515 state
->header
.stream_id
, state
->header
.net_seq_num
,
3516 state
->received
, left_to_receive
);
3518 stream
= stream_get_by_id(state
->header
.stream_id
);
3520 /* Protocol error. */
3521 ERR("relay_process_data_receive_payload: cannot find stream %" PRIu64
,
3522 state
->header
.stream_id
);
3523 status
= RELAY_CONNECTION_STATUS_ERROR
;
3527 pthread_mutex_lock(&stream
->lock
);
3528 session
= stream
->trace
->session
;
3529 if (!conn
->session
) {
3530 ret
= connection_set_session(conn
, session
);
3532 status
= RELAY_CONNECTION_STATUS_ERROR
;
3533 goto end_stream_unlock
;
3538 * The size of the "chunk" received on any iteration is bounded by:
3539 * - the data left to receive,
3540 * - the data immediately available on the socket,
3541 * - the on-stack data buffer
3543 while (left_to_receive
> 0 && !partial_recv
) {
3545 size_t recv_size
= min(left_to_receive
, chunk_size
);
3547 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
,
3548 recv_size
, MSG_DONTWAIT
);
3550 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3551 PERROR("Socket %d error", conn
->sock
->fd
);
3552 status
= RELAY_CONNECTION_STATUS_ERROR
;
3554 goto end_stream_unlock
;
3555 } else if (ret
== 0) {
3556 /* No more data ready to be consumed on socket. */
3557 DBG3("No more data ready for consumption on data socket of stream id %" PRIu64
,
3558 state
->header
.stream_id
);
3559 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3561 } else if (ret
< (int) recv_size
) {
3563 * All the data available on the socket has been
3566 partial_recv
= true;
3571 /* Write data to stream output fd. */
3572 write_ret
= lttng_write(stream
->stream_fd
->fd
, data_buffer
,
3574 if (write_ret
< (ssize_t
) recv_size
) {
3575 ERR("Relay error writing data to file");
3576 status
= RELAY_CONNECTION_STATUS_ERROR
;
3577 goto end_stream_unlock
;
3580 left_to_receive
-= recv_size
;
3581 state
->received
+= recv_size
;
3582 state
->left_to_receive
= left_to_receive
;
3584 DBG2("Relay wrote %zd bytes to tracefile for stream id %" PRIu64
,
3585 write_ret
, stream
->stream_handle
);
3588 if (state
->left_to_receive
> 0) {
3590 * Did not receive all the data expected, wait for more data to
3591 * become available on the socket.
3593 DBG3("Partial receive on data connection of stream id %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3594 state
->header
.stream_id
, state
->received
,
3595 state
->left_to_receive
);
3596 goto end_stream_unlock
;
3599 ret
= write_padding_to_file(stream
->stream_fd
->fd
,
3600 state
->header
.padding_size
);
3601 if ((int64_t) ret
< (int64_t) state
->header
.padding_size
) {
3602 ERR("write_padding_to_file: fail stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3603 stream
->stream_handle
,
3604 state
->header
.net_seq_num
, ret
);
3605 status
= RELAY_CONNECTION_STATUS_ERROR
;
3606 goto end_stream_unlock
;
3610 if (session_streams_have_index(session
)) {
3611 ret
= handle_index_data(stream
, state
->header
.net_seq_num
,
3612 state
->rotate_index
, &index_flushed
, state
->header
.data_size
+ state
->header
.padding_size
);
3614 ERR("handle_index_data: fail stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3615 stream
->stream_handle
,
3616 state
->header
.net_seq_num
, ret
);
3617 status
= RELAY_CONNECTION_STATUS_ERROR
;
3618 goto end_stream_unlock
;
3622 stream
->tracefile_size_current
+= state
->header
.data_size
+
3623 state
->header
.padding_size
;
3625 if (stream
->prev_data_seq
== -1ULL) {
3628 if (index_flushed
) {
3629 stream
->pos_after_last_complete_data_index
=
3630 stream
->tracefile_size_current
;
3631 stream
->prev_index_seq
= state
->header
.net_seq_num
;
3632 ret
= try_rotate_stream_index(stream
);
3634 goto end_stream_unlock
;
3638 stream
->prev_data_seq
= state
->header
.net_seq_num
;
3641 * Resetting the protocol state (to RECEIVE_HEADER) will trash the
3642 * contents of *state which are aliased (union) to the same location as
3643 * the new state. Don't use it beyond this point.
3645 connection_reset_protocol_state(conn
);
3648 ret
= try_rotate_stream_data(stream
);
3650 status
= RELAY_CONNECTION_STATUS_ERROR
;
3651 goto end_stream_unlock
;
3655 close_requested
= stream
->close_requested
;
3656 pthread_mutex_unlock(&stream
->lock
);
3657 if (close_requested
&& left_to_receive
== 0) {
3658 try_stream_close(stream
);
3662 pthread_mutex_lock(&session
->lock
);
3663 uatomic_set(&session
->new_streams
, 1);
3664 pthread_mutex_unlock(&session
->lock
);
3673 * relay_process_data: Process the data received on the data socket
3675 static enum relay_connection_status
relay_process_data(
3676 struct relay_connection
*conn
)
3678 enum relay_connection_status status
;
3680 switch (conn
->protocol
.data
.state_id
) {
3681 case DATA_CONNECTION_STATE_RECEIVE_HEADER
:
3682 status
= relay_process_data_receive_header(conn
);
3684 case DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3685 status
= relay_process_data_receive_payload(conn
);
3688 ERR("Unexpected data connection communication state.");
3695 static void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
3699 (void) lttng_poll_del(events
, pollfd
);
3701 ret
= close(pollfd
);
3703 ERR("Closing pollfd %d", pollfd
);
3707 static void relay_thread_close_connection(struct lttng_poll_event
*events
,
3708 int pollfd
, struct relay_connection
*conn
)
3710 const char *type_str
;
3712 switch (conn
->type
) {
3717 type_str
= "Control";
3719 case RELAY_VIEWER_COMMAND
:
3720 type_str
= "Viewer Command";
3722 case RELAY_VIEWER_NOTIFICATION
:
3723 type_str
= "Viewer Notification";
3726 type_str
= "Unknown";
3728 cleanup_connection_pollfd(events
, pollfd
);
3729 connection_put(conn
);
3730 DBG("%s connection closed with %d", type_str
, pollfd
);
3734 * This thread does the actual work
3736 static void *relay_thread_worker(void *data
)
3738 int ret
, err
= -1, last_seen_data_fd
= -1;
3740 struct lttng_poll_event events
;
3741 struct lttng_ht
*relay_connections_ht
;
3742 struct lttng_ht_iter iter
;
3743 struct relay_connection
*destroy_conn
= NULL
;
3745 DBG("[thread] Relay worker started");
3747 rcu_register_thread();
3749 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
3751 if (testpoint(relayd_thread_worker
)) {
3752 goto error_testpoint
;
3755 health_code_update();
3757 /* table of connections indexed on socket */
3758 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3759 if (!relay_connections_ht
) {
3760 goto relay_connections_ht_error
;
3763 ret
= create_thread_poll_set(&events
, 2);
3765 goto error_poll_create
;
3768 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
3775 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
3777 health_code_update();
3779 /* Infinite blocking call, waiting for transmission */
3780 DBG3("Relayd worker thread polling...");
3781 health_poll_entry();
3782 ret
= lttng_poll_wait(&events
, -1);
3786 * Restart interrupted system call.
3788 if (errno
== EINTR
) {
3797 * Process control. The control connection is
3798 * prioritized so we don't starve it with high
3799 * throughput tracing data on the data connection.
3801 for (i
= 0; i
< nb_fd
; i
++) {
3802 /* Fetch once the poll data */
3803 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3804 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3806 health_code_update();
3808 /* Thread quit pipe has been closed. Killing thread. */
3809 ret
= check_thread_quit_pipe(pollfd
, revents
);
3815 /* Inspect the relay conn pipe for new connection */
3816 if (pollfd
== relay_conn_pipe
[0]) {
3817 if (revents
& LPOLLIN
) {
3818 struct relay_connection
*conn
;
3820 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
3824 lttng_poll_add(&events
, conn
->sock
->fd
,
3825 LPOLLIN
| LPOLLRDHUP
);
3826 connection_ht_add(relay_connections_ht
, conn
);
3827 DBG("Connection socket %d added", conn
->sock
->fd
);
3828 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3829 ERR("Relay connection pipe error");
3832 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3836 struct relay_connection
*ctrl_conn
;
3838 ctrl_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3839 /* If not found, there is a synchronization issue. */
3842 if (ctrl_conn
->type
== RELAY_DATA
) {
3843 if (revents
& LPOLLIN
) {
3845 * Flag the last seen data fd not deleted. It will be
3846 * used as the last seen fd if any fd gets deleted in
3849 last_notdel_data_fd
= pollfd
;
3851 goto put_ctrl_connection
;
3853 assert(ctrl_conn
->type
== RELAY_CONTROL
);
3855 if (revents
& LPOLLIN
) {
3856 enum relay_connection_status status
;
3858 status
= relay_process_control(ctrl_conn
);
3859 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
3861 * On socket error flag the session as aborted to force
3862 * the cleanup of its stream otherwise it can leak
3863 * during the lifetime of the relayd.
3865 * This prevents situations in which streams can be
3866 * left opened because an index was received, the
3867 * control connection is closed, and the data
3868 * connection is closed (uncleanly) before the packet's
3871 * Since the control connection encountered an error,
3872 * it is okay to be conservative and close the
3873 * session right now as we can't rely on the protocol
3874 * being respected anymore.
3876 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
3877 session_abort(ctrl_conn
->session
);
3880 /* Clear the connection on error or close. */
3881 relay_thread_close_connection(&events
,
3886 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3887 relay_thread_close_connection(&events
,
3889 if (last_seen_data_fd
== pollfd
) {
3890 last_seen_data_fd
= last_notdel_data_fd
;
3893 ERR("Unexpected poll events %u for control sock %d",
3895 connection_put(ctrl_conn
);
3898 put_ctrl_connection
:
3899 connection_put(ctrl_conn
);
3904 * The last loop handled a control request, go back to poll to make
3905 * sure we prioritise the control socket.
3911 if (last_seen_data_fd
>= 0) {
3912 for (i
= 0; i
< nb_fd
; i
++) {
3913 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3915 health_code_update();
3917 if (last_seen_data_fd
== pollfd
) {
3924 /* Process data connection. */
3925 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
3926 /* Fetch the poll data. */
3927 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3928 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3929 struct relay_connection
*data_conn
;
3931 health_code_update();
3934 /* No activity for this FD (poll implementation). */
3938 /* Skip the command pipe. It's handled in the first loop. */
3939 if (pollfd
== relay_conn_pipe
[0]) {
3943 data_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3945 /* Skip it. Might be removed before. */
3948 if (data_conn
->type
== RELAY_CONTROL
) {
3949 goto put_data_connection
;
3951 assert(data_conn
->type
== RELAY_DATA
);
3953 if (revents
& LPOLLIN
) {
3954 enum relay_connection_status status
;
3956 status
= relay_process_data(data_conn
);
3957 /* Connection closed or error. */
3958 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
3960 * On socket error flag the session as aborted to force
3961 * the cleanup of its stream otherwise it can leak
3962 * during the lifetime of the relayd.
3964 * This prevents situations in which streams can be
3965 * left opened because an index was received, the
3966 * control connection is closed, and the data
3967 * connection is closed (uncleanly) before the packet's
3970 * Since the data connection encountered an error,
3971 * it is okay to be conservative and close the
3972 * session right now as we can't rely on the protocol
3973 * being respected anymore.
3975 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
3976 session_abort(data_conn
->session
);
3978 relay_thread_close_connection(&events
, pollfd
,
3981 * Every goto restart call sets the last seen fd where
3982 * here we don't really care since we gracefully
3983 * continue the loop after the connection is deleted.
3986 /* Keep last seen port. */
3987 last_seen_data_fd
= pollfd
;
3988 connection_put(data_conn
);
3991 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3992 relay_thread_close_connection(&events
, pollfd
,
3995 ERR("Unknown poll events %u for data sock %d",
3998 put_data_connection
:
3999 connection_put(data_conn
);
4001 last_seen_data_fd
= -1;
4004 /* Normal exit, no error */
4009 /* Cleanup remaining connection object. */
4011 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
,
4014 health_code_update();
4016 session_abort(destroy_conn
->session
);
4019 * No need to grab another ref, because we own
4022 relay_thread_close_connection(&events
, destroy_conn
->sock
->fd
,
4027 lttng_poll_clean(&events
);
4029 lttng_ht_destroy(relay_connections_ht
);
4030 relay_connections_ht_error
:
4031 /* Close relay conn pipes */
4032 utils_close_pipe(relay_conn_pipe
);
4034 DBG("Thread exited with error");
4036 DBG("Worker thread cleanup complete");
4040 ERR("Health error occurred in %s", __func__
);
4042 health_unregister(health_relayd
);
4043 rcu_unregister_thread();
4044 lttng_relay_stop_threads();
4049 * Create the relay command pipe to wake thread_manage_apps.
4050 * Closed in cleanup().
4052 static int create_relay_conn_pipe(void)
4056 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
4064 int main(int argc
, char **argv
)
4066 int ret
= 0, retval
= 0;
4069 /* Parse arguments */
4071 if (set_options(argc
, argv
)) {
4076 if (set_signal_handler()) {
4081 /* Try to create directory if -o, --output is specified. */
4082 if (opt_output_path
) {
4083 if (*opt_output_path
!= '/') {
4084 ERR("Please specify an absolute path for -o, --output PATH");
4089 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
,
4092 ERR("Unable to create %s", opt_output_path
);
4099 if (opt_daemon
|| opt_background
) {
4102 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
4110 * We are in the child. Make sure all other file
4111 * descriptors are closed, in case we are called with
4112 * more opened file descriptors than the standard ones.
4114 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
4119 /* Initialize thread health monitoring */
4120 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
4121 if (!health_relayd
) {
4122 PERROR("health_app_create error");
4124 goto exit_health_app_create
;
4127 /* Create thread quit pipe */
4128 if (init_thread_quit_pipe()) {
4130 goto exit_init_data
;
4133 /* Setup the thread apps communication pipe. */
4134 if (create_relay_conn_pipe()) {
4136 goto exit_init_data
;
4139 /* Init relay command queue. */
4140 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
4142 /* Initialize communication library */
4144 lttcomm_inet_init();
4146 /* tables of sessions indexed by session ID */
4147 sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4150 goto exit_init_data
;
4153 /* tables of streams indexed by stream ID */
4154 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4155 if (!relay_streams_ht
) {
4157 goto exit_init_data
;
4160 /* tables of streams indexed by stream ID */
4161 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4162 if (!viewer_streams_ht
) {
4164 goto exit_init_data
;
4167 ret
= utils_create_pipe(health_quit_pipe
);
4170 goto exit_health_quit_pipe
;
4173 /* Create thread to manage the client socket */
4174 ret
= pthread_create(&health_thread
, default_pthread_attr(),
4175 thread_manage_health
, (void *) NULL
);
4178 PERROR("pthread_create health");
4180 goto exit_health_thread
;
4183 /* Setup the dispatcher thread */
4184 ret
= pthread_create(&dispatcher_thread
, default_pthread_attr(),
4185 relay_thread_dispatcher
, (void *) NULL
);
4188 PERROR("pthread_create dispatcher");
4190 goto exit_dispatcher_thread
;
4193 /* Setup the worker thread */
4194 ret
= pthread_create(&worker_thread
, default_pthread_attr(),
4195 relay_thread_worker
, NULL
);
4198 PERROR("pthread_create worker");
4200 goto exit_worker_thread
;
4203 /* Setup the listener thread */
4204 ret
= pthread_create(&listener_thread
, default_pthread_attr(),
4205 relay_thread_listener
, (void *) NULL
);
4208 PERROR("pthread_create listener");
4210 goto exit_listener_thread
;
4213 ret
= relayd_live_create(live_uri
);
4215 ERR("Starting live viewer threads");
4221 * This is where we start awaiting program completion (e.g. through
4222 * signal that asks threads to teardown).
4225 ret
= relayd_live_join();
4231 ret
= pthread_join(listener_thread
, &status
);
4234 PERROR("pthread_join listener_thread");
4238 exit_listener_thread
:
4239 ret
= pthread_join(worker_thread
, &status
);
4242 PERROR("pthread_join worker_thread");
4247 ret
= pthread_join(dispatcher_thread
, &status
);
4250 PERROR("pthread_join dispatcher_thread");
4253 exit_dispatcher_thread
:
4255 ret
= pthread_join(health_thread
, &status
);
4258 PERROR("pthread_join health_thread");
4263 utils_close_pipe(health_quit_pipe
);
4264 exit_health_quit_pipe
:
4267 health_app_destroy(health_relayd
);
4268 exit_health_app_create
:
4271 * Wait for all pending call_rcu work to complete before tearing
4272 * down data structures. call_rcu worker may be trying to
4273 * perform lookups in those structures.
4278 /* Ensure all prior call_rcu are done. */