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 occured 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
);
863 * No activity for this FD (poll
869 /* Thread quit pipe has been closed. Killing thread. */
870 ret
= check_thread_quit_pipe(pollfd
, revents
);
876 if (revents
& LPOLLIN
) {
878 * A new connection is requested, therefore a
879 * sessiond/consumerd connection is allocated in
880 * this thread, enqueued to a global queue and
881 * dequeued (and freed) in the worker thread.
884 struct relay_connection
*new_conn
;
885 struct lttcomm_sock
*newsock
;
886 enum connection_type type
;
888 if (pollfd
== data_sock
->fd
) {
890 newsock
= data_sock
->ops
->accept(data_sock
);
891 DBG("Relay data connection accepted, socket %d",
894 assert(pollfd
== control_sock
->fd
);
895 type
= RELAY_CONTROL
;
896 newsock
= control_sock
->ops
->accept(control_sock
);
897 DBG("Relay control connection accepted, socket %d",
901 PERROR("accepting sock");
905 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
908 PERROR("setsockopt inet");
909 lttcomm_destroy_sock(newsock
);
913 ret
= socket_apply_keep_alive_config(newsock
->fd
);
915 ERR("Failed to apply TCP keep-alive configuration on socket (%i)",
917 lttcomm_destroy_sock(newsock
);
921 new_conn
= connection_create(newsock
, type
);
923 lttcomm_destroy_sock(newsock
);
927 /* Enqueue request for the dispatcher thread. */
928 cds_wfcq_enqueue(&relay_conn_queue
.head
, &relay_conn_queue
.tail
,
932 * Wake the dispatch queue futex.
933 * Implicit memory barrier with the
934 * exchange in cds_wfcq_enqueue.
936 futex_nto1_wake(&relay_conn_queue
.futex
);
937 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
938 ERR("socket poll error");
941 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
951 lttng_poll_clean(&events
);
953 if (data_sock
->fd
>= 0) {
954 ret
= data_sock
->ops
->close(data_sock
);
959 lttcomm_destroy_sock(data_sock
);
961 if (control_sock
->fd
>= 0) {
962 ret
= control_sock
->ops
->close(control_sock
);
967 lttcomm_destroy_sock(control_sock
);
971 ERR("Health error occurred in %s", __func__
);
973 health_unregister(health_relayd
);
974 DBG("Relay listener thread cleanup complete");
975 lttng_relay_stop_threads();
980 * This thread manages the dispatching of the requests to worker threads
982 static void *relay_thread_dispatcher(void *data
)
986 struct cds_wfcq_node
*node
;
987 struct relay_connection
*new_conn
= NULL
;
989 DBG("[thread] Relay dispatcher started");
991 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
993 if (testpoint(relayd_thread_dispatcher
)) {
994 goto error_testpoint
;
997 health_code_update();
1000 health_code_update();
1002 /* Atomically prepare the queue futex */
1003 futex_nto1_prepare(&relay_conn_queue
.futex
);
1005 if (CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1010 health_code_update();
1012 /* Dequeue commands */
1013 node
= cds_wfcq_dequeue_blocking(&relay_conn_queue
.head
,
1014 &relay_conn_queue
.tail
);
1016 DBG("Woken up but nothing in the relay command queue");
1017 /* Continue thread execution */
1020 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
1022 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
1025 * Inform worker thread of the new request. This
1026 * call is blocking so we can be assured that
1027 * the data will be read at some point in time
1028 * or wait to the end of the world :)
1030 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
1032 PERROR("write connection pipe");
1033 connection_put(new_conn
);
1036 } while (node
!= NULL
);
1038 /* Futex wait on queue. Blocking call on futex() */
1039 health_poll_entry();
1040 futex_nto1_wait(&relay_conn_queue
.futex
);
1044 /* Normal exit, no error */
1051 ERR("Health error occurred in %s", __func__
);
1053 health_unregister(health_relayd
);
1054 DBG("Dispatch thread dying");
1055 lttng_relay_stop_threads();
1060 * Set index data from the control port to a given index object.
1062 static int set_index_control_data(struct relay_index
*index
,
1063 struct lttcomm_relayd_index
*data
,
1064 struct relay_connection
*conn
)
1066 struct ctf_packet_index index_data
;
1069 * The index on disk is encoded in big endian.
1071 index_data
.packet_size
= htobe64(data
->packet_size
);
1072 index_data
.content_size
= htobe64(data
->content_size
);
1073 index_data
.timestamp_begin
= htobe64(data
->timestamp_begin
);
1074 index_data
.timestamp_end
= htobe64(data
->timestamp_end
);
1075 index_data
.events_discarded
= htobe64(data
->events_discarded
);
1076 index_data
.stream_id
= htobe64(data
->stream_id
);
1078 if (conn
->minor
>= 8) {
1079 index
->index_data
.stream_instance_id
= htobe64(data
->stream_instance_id
);
1080 index
->index_data
.packet_seq_num
= htobe64(data
->packet_seq_num
);
1083 return relay_index_set_data(index
, &index_data
);
1086 static bool session_streams_have_index(const struct relay_session
*session
)
1088 return session
->minor
>= 4 && !session
->snapshot
;
1092 * Handle the RELAYD_CREATE_SESSION command.
1094 * On success, send back the session id or else return a negative value.
1096 static int relay_create_session(const struct lttcomm_relayd_hdr
*recv_hdr
,
1097 struct relay_connection
*conn
,
1098 const struct lttng_buffer_view
*payload
)
1102 struct relay_session
*session
;
1103 struct lttcomm_relayd_status_session reply
;
1104 char session_name
[LTTNG_NAME_MAX
];
1105 char hostname
[LTTNG_HOST_NAME_MAX
];
1106 uint32_t live_timer
= 0;
1107 bool snapshot
= false;
1109 memset(session_name
, 0, LTTNG_NAME_MAX
);
1110 memset(hostname
, 0, LTTNG_HOST_NAME_MAX
);
1112 memset(&reply
, 0, sizeof(reply
));
1114 if (conn
->minor
< 4) {
1115 /* From 2.1 to 2.3 */
1117 } else if (conn
->minor
>= 4 && conn
->minor
< 11) {
1118 /* From 2.4 to 2.10 */
1119 ret
= cmd_create_session_2_4(payload
, session_name
,
1120 hostname
, &live_timer
, &snapshot
);
1122 /* From 2.11 to ... */
1123 ret
= cmd_create_session_2_11(payload
, session_name
,
1124 hostname
, &live_timer
, &snapshot
);
1131 session
= session_create(session_name
, hostname
, live_timer
,
1132 snapshot
, conn
->major
, conn
->minor
);
1137 assert(!conn
->session
);
1138 conn
->session
= session
;
1139 DBG("Created session %" PRIu64
, session
->id
);
1141 reply
.session_id
= htobe64(session
->id
);
1145 reply
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1147 reply
.ret_code
= htobe32(LTTNG_OK
);
1150 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1151 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1152 ERR("Failed to send \"create session\" command reply (ret = %zd)",
1161 * When we have received all the streams and the metadata for a channel,
1162 * we make them visible to the viewer threads.
1164 static void publish_connection_local_streams(struct relay_connection
*conn
)
1166 struct relay_stream
*stream
;
1167 struct relay_session
*session
= conn
->session
;
1170 * We publish all streams belonging to a session atomically wrt
1173 pthread_mutex_lock(&session
->lock
);
1175 cds_list_for_each_entry_rcu(stream
, &session
->recv_list
,
1177 stream_publish(stream
);
1182 * Inform the viewer that there are new streams in the session.
1184 if (session
->viewer_attached
) {
1185 uatomic_set(&session
->new_streams
, 1);
1187 pthread_mutex_unlock(&session
->lock
);
1191 * relay_add_stream: allocate a new stream for a session
1193 static int relay_add_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1194 struct relay_connection
*conn
,
1195 const struct lttng_buffer_view
*payload
)
1199 struct relay_session
*session
= conn
->session
;
1200 struct relay_stream
*stream
= NULL
;
1201 struct lttcomm_relayd_status_stream reply
;
1202 struct ctf_trace
*trace
= NULL
;
1203 uint64_t stream_handle
= -1ULL;
1204 char *path_name
= NULL
, *channel_name
= NULL
;
1205 uint64_t tracefile_size
= 0, tracefile_count
= 0;
1206 struct relay_stream_chunk_id stream_chunk_id
= { 0 };
1208 if (!session
|| !conn
->version_check_done
) {
1209 ERR("Trying to add a stream before version check");
1211 goto end_no_session
;
1214 if (session
->minor
== 1) {
1216 ret
= cmd_recv_stream_2_1(payload
, &path_name
,
1218 } else if (session
->minor
> 1 && session
->minor
< 11) {
1219 /* From 2.2 to 2.10 */
1220 ret
= cmd_recv_stream_2_2(payload
, &path_name
,
1221 &channel_name
, &tracefile_size
, &tracefile_count
);
1223 /* From 2.11 to ... */
1224 ret
= cmd_recv_stream_2_11(payload
, &path_name
,
1225 &channel_name
, &tracefile_size
, &tracefile_count
,
1226 &stream_chunk_id
.value
);
1227 stream_chunk_id
.is_set
= true;
1234 trace
= ctf_trace_get_by_path_or_create(session
, path_name
);
1238 /* This stream here has one reference on the trace. */
1240 pthread_mutex_lock(&last_relay_stream_id_lock
);
1241 stream_handle
= ++last_relay_stream_id
;
1242 pthread_mutex_unlock(&last_relay_stream_id_lock
);
1244 /* We pass ownership of path_name and channel_name. */
1245 stream
= stream_create(trace
, stream_handle
, path_name
,
1246 channel_name
, tracefile_size
, tracefile_count
,
1249 channel_name
= NULL
;
1252 * Streams are the owners of their trace. Reference to trace is
1253 * kept within stream_create().
1255 ctf_trace_put(trace
);
1258 memset(&reply
, 0, sizeof(reply
));
1259 reply
.handle
= htobe64(stream_handle
);
1261 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1263 reply
.ret_code
= htobe32(LTTNG_OK
);
1266 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1267 sizeof(struct lttcomm_relayd_status_stream
), 0);
1268 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1269 ERR("Failed to send \"add stream\" command reply (ret = %zd)",
1281 * relay_close_stream: close a specific stream
1283 static int relay_close_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1284 struct relay_connection
*conn
,
1285 const struct lttng_buffer_view
*payload
)
1289 struct relay_session
*session
= conn
->session
;
1290 struct lttcomm_relayd_close_stream stream_info
;
1291 struct lttcomm_relayd_generic_reply reply
;
1292 struct relay_stream
*stream
;
1294 DBG("Close stream received");
1296 if (!session
|| !conn
->version_check_done
) {
1297 ERR("Trying to close a stream before version check");
1299 goto end_no_session
;
1302 if (payload
->size
< sizeof(stream_info
)) {
1303 ERR("Unexpected payload size in \"relay_close_stream\": expected >= %zu bytes, got %zu bytes",
1304 sizeof(stream_info
), payload
->size
);
1306 goto end_no_session
;
1308 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1309 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1310 stream_info
.last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1312 stream
= stream_get_by_id(stream_info
.stream_id
);
1319 * Set last_net_seq_num before the close flag. Required by data
1322 pthread_mutex_lock(&stream
->lock
);
1323 stream
->last_net_seq_num
= stream_info
.last_net_seq_num
;
1324 pthread_mutex_unlock(&stream
->lock
);
1327 * This is one of the conditions which may trigger a stream close
1328 * with the others being:
1329 * 1) A close command is received for a stream
1330 * 2) The control connection owning the stream is closed
1331 * 3) We have received all of the stream's data _after_ a close
1334 try_stream_close(stream
);
1335 if (stream
->is_metadata
) {
1336 struct relay_viewer_stream
*vstream
;
1338 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
1340 if (vstream
->metadata_sent
== stream
->metadata_received
) {
1342 * Since all the metadata has been sent to the
1343 * viewer and that we have a request to close
1344 * its stream, we can safely teardown the
1345 * corresponding metadata viewer stream.
1347 viewer_stream_put(vstream
);
1349 /* Put local reference. */
1350 viewer_stream_put(vstream
);
1357 memset(&reply
, 0, sizeof(reply
));
1359 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1361 reply
.ret_code
= htobe32(LTTNG_OK
);
1363 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1364 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1365 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1366 ERR("Failed to send \"close stream\" command reply (ret = %zd)",
1376 * relay_reset_metadata: reset a metadata stream
1379 int relay_reset_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1380 struct relay_connection
*conn
,
1381 const struct lttng_buffer_view
*payload
)
1385 struct relay_session
*session
= conn
->session
;
1386 struct lttcomm_relayd_reset_metadata stream_info
;
1387 struct lttcomm_relayd_generic_reply reply
;
1388 struct relay_stream
*stream
;
1390 DBG("Reset metadata received");
1392 if (!session
|| !conn
->version_check_done
) {
1393 ERR("Trying to reset a metadata stream before version check");
1395 goto end_no_session
;
1398 if (payload
->size
< sizeof(stream_info
)) {
1399 ERR("Unexpected payload size in \"relay_reset_metadata\": expected >= %zu bytes, got %zu bytes",
1400 sizeof(stream_info
), payload
->size
);
1402 goto end_no_session
;
1404 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1405 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1406 stream_info
.version
= be64toh(stream_info
.version
);
1408 DBG("Update metadata to version %" PRIu64
, stream_info
.version
);
1410 /* Unsupported for live sessions for now. */
1411 if (session
->live_timer
!= 0) {
1416 stream
= stream_get_by_id(stream_info
.stream_id
);
1421 pthread_mutex_lock(&stream
->lock
);
1422 if (!stream
->is_metadata
) {
1427 ret
= utils_rotate_stream_file(stream
->path_name
, stream
->channel_name
,
1428 0, 0, -1, -1, stream
->stream_fd
->fd
, NULL
,
1429 &stream
->stream_fd
->fd
);
1431 ERR("Failed to rotate metadata file %s of channel %s",
1432 stream
->path_name
, stream
->channel_name
);
1437 pthread_mutex_unlock(&stream
->lock
);
1441 memset(&reply
, 0, sizeof(reply
));
1443 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1445 reply
.ret_code
= htobe32(LTTNG_OK
);
1447 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1448 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1449 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1450 ERR("Failed to send \"reset metadata\" command reply (ret = %zd)",
1460 * relay_unknown_command: send -1 if received unknown command
1462 static void relay_unknown_command(struct relay_connection
*conn
)
1464 struct lttcomm_relayd_generic_reply reply
;
1467 memset(&reply
, 0, sizeof(reply
));
1468 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1469 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1470 if (send_ret
< sizeof(reply
)) {
1471 ERR("Failed to send \"unknown command\" command reply (ret = %zd)", send_ret
);
1476 * relay_start: send an acknowledgment to the client to tell if we are
1477 * ready to receive data. We are ready if a session is established.
1479 static int relay_start(const struct lttcomm_relayd_hdr
*recv_hdr
,
1480 struct relay_connection
*conn
,
1481 const struct lttng_buffer_view
*payload
)
1485 struct lttcomm_relayd_generic_reply reply
;
1486 struct relay_session
*session
= conn
->session
;
1489 DBG("Trying to start the streaming without a session established");
1490 ret
= htobe32(LTTNG_ERR_UNK
);
1493 memset(&reply
, 0, sizeof(reply
));
1494 reply
.ret_code
= htobe32(LTTNG_OK
);
1495 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1497 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1498 ERR("Failed to send \"relay_start\" command reply (ret = %zd)",
1507 * Append padding to the file pointed by the file descriptor fd.
1509 static int write_padding_to_file(int fd
, uint32_t size
)
1518 zeros
= zmalloc(size
);
1519 if (zeros
== NULL
) {
1520 PERROR("zmalloc zeros for padding");
1525 ret
= lttng_write(fd
, zeros
, size
);
1527 PERROR("write padding to file");
1537 * Close the current index file if it is open, and create a new one.
1539 * Return 0 on success, -1 on error.
1542 int create_rotate_index_file(struct relay_stream
*stream
,
1543 const char *stream_path
)
1546 uint32_t major
, minor
;
1548 /* Put ref on previous index_file. */
1549 if (stream
->index_file
) {
1550 lttng_index_file_put(stream
->index_file
);
1551 stream
->index_file
= NULL
;
1553 major
= stream
->trace
->session
->major
;
1554 minor
= stream
->trace
->session
->minor
;
1555 stream
->index_file
= lttng_index_file_create(stream_path
,
1556 stream
->channel_name
,
1557 -1, -1, stream
->tracefile_size
,
1558 tracefile_array_get_file_index_head(stream
->tfa
),
1559 lttng_to_index_major(major
, minor
),
1560 lttng_to_index_minor(major
, minor
));
1561 if (!stream
->index_file
) {
1573 int do_rotate_stream(struct relay_stream
*stream
)
1577 /* Perform the stream rotation. */
1578 ret
= utils_rotate_stream_file(stream
->path_name
,
1579 stream
->channel_name
, stream
->tracefile_size
,
1580 stream
->tracefile_count
, -1,
1581 -1, stream
->stream_fd
->fd
,
1582 NULL
, &stream
->stream_fd
->fd
);
1584 ERR("Rotating stream output file");
1587 stream
->tracefile_size_current
= 0;
1589 /* Rotate also the index if the stream is not a metadata stream. */
1590 if (!stream
->is_metadata
) {
1591 ret
= create_rotate_index_file(stream
, stream
->path_name
);
1593 ERR("Failed to rotate index file");
1598 stream
->rotate_at_seq_num
= -1ULL;
1599 stream
->pos_after_last_complete_data_index
= 0;
1606 * If too much data has been written in a tracefile before we received the
1607 * rotation command, we have to move the excess data to the new tracefile and
1608 * perform the rotation. This can happen because the control and data
1609 * connections are separate, the indexes as well as the commands arrive from
1610 * the control connection and we have no control over the order so we could be
1611 * in a situation where too much data has been received on the data connection
1612 * before the rotation command on the control connection arrives. We don't need
1613 * to update the index because its order is guaranteed with the rotation
1617 int rotate_truncate_stream(struct relay_stream
*stream
)
1621 uint64_t diff
, pos
= 0;
1622 char buf
[FILE_COPY_BUFFER_SIZE
];
1624 assert(!stream
->is_metadata
);
1626 assert(stream
->tracefile_size_current
>
1627 stream
->pos_after_last_complete_data_index
);
1628 diff
= stream
->tracefile_size_current
-
1629 stream
->pos_after_last_complete_data_index
;
1631 /* Create the new tracefile. */
1632 new_fd
= utils_create_stream_file(stream
->path_name
,
1633 stream
->channel_name
,
1634 stream
->tracefile_size
, stream
->tracefile_count
,
1635 /* uid */ -1, /* gid */ -1, /* suffix */ NULL
);
1637 ERR("Failed to create new stream file at path %s for channel %s",
1638 stream
->path_name
, stream
->channel_name
);
1644 * Rewind the current tracefile to the position at which the rotation
1645 * should have occured.
1647 lseek_ret
= lseek(stream
->stream_fd
->fd
,
1648 stream
->pos_after_last_complete_data_index
, SEEK_SET
);
1649 if (lseek_ret
< 0) {
1650 PERROR("seek truncate stream");
1655 /* Move data from the old file to the new file. */
1656 while (pos
< diff
) {
1657 uint64_t count
, bytes_left
;
1660 bytes_left
= diff
- pos
;
1661 count
= bytes_left
> sizeof(buf
) ? sizeof(buf
) : bytes_left
;
1662 assert(count
<= SIZE_MAX
);
1664 io_ret
= lttng_read(stream
->stream_fd
->fd
, buf
, count
);
1665 if (io_ret
< (ssize_t
) count
) {
1666 char error_string
[256];
1668 snprintf(error_string
, sizeof(error_string
),
1669 "Failed to read %" PRIu64
" bytes from fd %i in rotate_truncate_stream(), returned %zi",
1670 count
, stream
->stream_fd
->fd
, io_ret
);
1672 PERROR("%s", error_string
);
1674 ERR("%s", error_string
);
1680 io_ret
= lttng_write(new_fd
, buf
, count
);
1681 if (io_ret
< (ssize_t
) count
) {
1682 char error_string
[256];
1684 snprintf(error_string
, sizeof(error_string
),
1685 "Failed to write %" PRIu64
" bytes from fd %i in rotate_truncate_stream(), returned %zi",
1686 count
, new_fd
, io_ret
);
1688 PERROR("%s", error_string
);
1690 ERR("%s", error_string
);
1699 /* Truncate the file to get rid of the excess data. */
1700 ret
= ftruncate(stream
->stream_fd
->fd
,
1701 stream
->pos_after_last_complete_data_index
);
1703 PERROR("ftruncate");
1707 ret
= close(stream
->stream_fd
->fd
);
1709 PERROR("Closing tracefile");
1713 ret
= create_rotate_index_file(stream
, stream
->path_name
);
1715 ERR("Rotate stream index file");
1720 * Update the offset and FD of all the eventual indexes created by the
1721 * data connection before the rotation command arrived.
1723 ret
= relay_index_switch_all_files(stream
);
1725 ERR("Failed to rotate index file");
1729 stream
->stream_fd
->fd
= new_fd
;
1730 stream
->tracefile_size_current
= diff
;
1731 stream
->pos_after_last_complete_data_index
= 0;
1732 stream
->rotate_at_seq_num
= -1ULL;
1741 * Check if a stream should perform a rotation (for session rotation).
1742 * Must be called with the stream lock held.
1744 * Return 0 on success, a negative value on error.
1747 int try_rotate_stream(struct relay_stream
*stream
)
1752 /* No rotation expected. */
1753 if (stream
->rotate_at_seq_num
== -1ULL) {
1757 trace_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
1758 if (stream
->prev_data_seq
== -1ULL || stream
->prev_index_seq
== -1ULL ||
1759 trace_seq
< stream
->rotate_at_seq_num
) {
1760 DBG("Stream %" PRIu64
" not yet ready for rotation (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
);
1766 } else if (stream
->prev_data_seq
> stream
->rotate_at_seq_num
) {
1768 * prev_data_seq is checked here since indexes and rotation
1769 * commands are serialized with respect to each other.
1771 DBG("Rotation after too much data has been written in tracefile "
1772 "for stream %" PRIu64
", need to truncate before "
1773 "rotating", stream
->stream_handle
);
1774 ret
= rotate_truncate_stream(stream
);
1776 ERR("Failed to truncate stream");
1780 if (trace_seq
!= stream
->rotate_at_seq_num
) {
1782 * Unexpected, protocol error/bug.
1783 * It could mean that we received a rotation position
1784 * that is in the past.
1786 ERR("Stream %" PRIu64
" is in an inconsistent state (rotate_at_seq_num = %" PRIu64
", prev_data_seq = %" PRIu64
", prev_index_seq = %" PRIu64
")",
1787 stream
->stream_handle
,
1788 stream
->rotate_at_seq_num
,
1789 stream
->prev_data_seq
,
1790 stream
->prev_index_seq
);
1794 DBG("Stream %" PRIu64
" ready for rotation",
1795 stream
->stream_handle
);
1796 ret
= do_rotate_stream(stream
);
1804 * relay_recv_metadata: receive the metadata for the session.
1806 static int relay_recv_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1807 struct relay_connection
*conn
,
1808 const struct lttng_buffer_view
*payload
)
1812 struct relay_session
*session
= conn
->session
;
1813 struct lttcomm_relayd_metadata_payload metadata_payload_header
;
1814 struct relay_stream
*metadata_stream
;
1815 uint64_t metadata_payload_size
;
1818 ERR("Metadata sent before version check");
1823 if (recv_hdr
->data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1824 ERR("Incorrect data size");
1828 metadata_payload_size
= recv_hdr
->data_size
-
1829 sizeof(struct lttcomm_relayd_metadata_payload
);
1831 memcpy(&metadata_payload_header
, payload
->data
,
1832 sizeof(metadata_payload_header
));
1833 metadata_payload_header
.stream_id
= be64toh(
1834 metadata_payload_header
.stream_id
);
1835 metadata_payload_header
.padding_size
= be32toh(
1836 metadata_payload_header
.padding_size
);
1838 metadata_stream
= stream_get_by_id(metadata_payload_header
.stream_id
);
1839 if (!metadata_stream
) {
1844 pthread_mutex_lock(&metadata_stream
->lock
);
1846 size_ret
= lttng_write(metadata_stream
->stream_fd
->fd
,
1847 payload
->data
+ sizeof(metadata_payload_header
),
1848 metadata_payload_size
);
1849 if (size_ret
< metadata_payload_size
) {
1850 ERR("Relay error writing metadata on file");
1855 size_ret
= write_padding_to_file(metadata_stream
->stream_fd
->fd
,
1856 metadata_payload_header
.padding_size
);
1857 if (size_ret
< (int64_t) metadata_payload_header
.padding_size
) {
1862 metadata_stream
->metadata_received
+=
1863 metadata_payload_size
+ metadata_payload_header
.padding_size
;
1864 DBG2("Relay metadata written. Updated metadata_received %" PRIu64
,
1865 metadata_stream
->metadata_received
);
1867 ret
= try_rotate_stream(metadata_stream
);
1873 pthread_mutex_unlock(&metadata_stream
->lock
);
1874 stream_put(metadata_stream
);
1880 * relay_send_version: send relayd version number
1882 static int relay_send_version(const struct lttcomm_relayd_hdr
*recv_hdr
,
1883 struct relay_connection
*conn
,
1884 const struct lttng_buffer_view
*payload
)
1888 struct lttcomm_relayd_version reply
, msg
;
1889 bool compatible
= true;
1891 conn
->version_check_done
= true;
1893 /* Get version from the other side. */
1894 if (payload
->size
< sizeof(msg
)) {
1895 ERR("Unexpected payload size in \"relay_send_version\": expected >= %zu bytes, got %zu bytes",
1896 sizeof(msg
), payload
->size
);
1901 memcpy(&msg
, payload
->data
, sizeof(msg
));
1902 msg
.major
= be32toh(msg
.major
);
1903 msg
.minor
= be32toh(msg
.minor
);
1905 memset(&reply
, 0, sizeof(reply
));
1906 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
1907 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
1909 /* Major versions must be the same */
1910 if (reply
.major
!= msg
.major
) {
1911 DBG("Incompatible major versions (%u vs %u), deleting session",
1912 reply
.major
, msg
.major
);
1916 conn
->major
= reply
.major
;
1917 /* We adapt to the lowest compatible version */
1918 if (reply
.minor
<= msg
.minor
) {
1919 conn
->minor
= reply
.minor
;
1921 conn
->minor
= msg
.minor
;
1924 reply
.major
= htobe32(reply
.major
);
1925 reply
.minor
= htobe32(reply
.minor
);
1926 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1928 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1929 ERR("Failed to send \"send version\" command reply (ret = %zd)",
1942 DBG("Version check done using protocol %u.%u", conn
->major
,
1950 * Check for data pending for a given stream id from the session daemon.
1952 static int relay_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
1953 struct relay_connection
*conn
,
1954 const struct lttng_buffer_view
*payload
)
1956 struct relay_session
*session
= conn
->session
;
1957 struct lttcomm_relayd_data_pending msg
;
1958 struct lttcomm_relayd_generic_reply reply
;
1959 struct relay_stream
*stream
;
1962 uint64_t stream_seq
;
1964 DBG("Data pending command received");
1966 if (!session
|| !conn
->version_check_done
) {
1967 ERR("Trying to check for data before version check");
1969 goto end_no_session
;
1972 if (payload
->size
< sizeof(msg
)) {
1973 ERR("Unexpected payload size in \"relay_data_pending\": expected >= %zu bytes, got %zu bytes",
1974 sizeof(msg
), payload
->size
);
1976 goto end_no_session
;
1978 memcpy(&msg
, payload
->data
, sizeof(msg
));
1979 msg
.stream_id
= be64toh(msg
.stream_id
);
1980 msg
.last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
1982 stream
= stream_get_by_id(msg
.stream_id
);
1983 if (stream
== NULL
) {
1988 pthread_mutex_lock(&stream
->lock
);
1990 if (session_streams_have_index(session
)) {
1992 * Ensure that both the index and stream data have been
1993 * flushed up to the requested point.
1995 stream_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
1997 stream_seq
= stream
->prev_data_seq
;
1999 DBG("Data pending for stream id %" PRIu64
": prev_data_seq %" PRIu64
2000 ", prev_index_seq %" PRIu64
2001 ", and last_seq %" PRIu64
, msg
.stream_id
,
2002 stream
->prev_data_seq
, stream
->prev_index_seq
,
2003 msg
.last_net_seq_num
);
2005 /* Avoid wrapping issue */
2006 if (((int64_t) (stream_seq
- msg
.last_net_seq_num
)) >= 0) {
2007 /* Data has in fact been written and is NOT pending */
2010 /* Data still being streamed thus pending */
2014 stream
->data_pending_check_done
= true;
2015 pthread_mutex_unlock(&stream
->lock
);
2020 memset(&reply
, 0, sizeof(reply
));
2021 reply
.ret_code
= htobe32(ret
);
2022 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2023 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2024 ERR("Failed to send \"data pending\" command reply (ret = %zd)",
2034 * Wait for the control socket to reach a quiescent state.
2036 * Note that for now, when receiving this command from the session
2037 * daemon, this means that every subsequent commands or data received on
2038 * the control socket has been handled. So, this is why we simply return
2041 static int relay_quiescent_control(const struct lttcomm_relayd_hdr
*recv_hdr
,
2042 struct relay_connection
*conn
,
2043 const struct lttng_buffer_view
*payload
)
2047 struct relay_stream
*stream
;
2048 struct lttcomm_relayd_quiescent_control msg
;
2049 struct lttcomm_relayd_generic_reply reply
;
2051 DBG("Checking quiescent state on control socket");
2053 if (!conn
->session
|| !conn
->version_check_done
) {
2054 ERR("Trying to check for data before version check");
2056 goto end_no_session
;
2059 if (payload
->size
< sizeof(msg
)) {
2060 ERR("Unexpected payload size in \"relay_quiescent_control\": expected >= %zu bytes, got %zu bytes",
2061 sizeof(msg
), payload
->size
);
2063 goto end_no_session
;
2065 memcpy(&msg
, payload
->data
, sizeof(msg
));
2066 msg
.stream_id
= be64toh(msg
.stream_id
);
2068 stream
= stream_get_by_id(msg
.stream_id
);
2072 pthread_mutex_lock(&stream
->lock
);
2073 stream
->data_pending_check_done
= true;
2074 pthread_mutex_unlock(&stream
->lock
);
2076 DBG("Relay quiescent control pending flag set to %" PRIu64
, msg
.stream_id
);
2079 memset(&reply
, 0, sizeof(reply
));
2080 reply
.ret_code
= htobe32(LTTNG_OK
);
2081 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2082 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2083 ERR("Failed to send \"quiescent control\" command reply (ret = %zd)",
2095 * Initialize a data pending command. This means that a consumer is about
2096 * to ask for data pending for each stream it holds. Simply iterate over
2097 * all streams of a session and set the data_pending_check_done flag.
2099 * This command returns to the client a LTTNG_OK code.
2101 static int relay_begin_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2102 struct relay_connection
*conn
,
2103 const struct lttng_buffer_view
*payload
)
2107 struct lttng_ht_iter iter
;
2108 struct lttcomm_relayd_begin_data_pending msg
;
2109 struct lttcomm_relayd_generic_reply reply
;
2110 struct relay_stream
*stream
;
2115 DBG("Init streams for data pending");
2117 if (!conn
->session
|| !conn
->version_check_done
) {
2118 ERR("Trying to check for data before version check");
2120 goto end_no_session
;
2123 if (payload
->size
< sizeof(msg
)) {
2124 ERR("Unexpected payload size in \"relay_begin_data_pending\": expected >= %zu bytes, got %zu bytes",
2125 sizeof(msg
), payload
->size
);
2127 goto end_no_session
;
2129 memcpy(&msg
, payload
->data
, sizeof(msg
));
2130 msg
.session_id
= be64toh(msg
.session_id
);
2133 * Iterate over all streams to set the begin data pending flag.
2134 * For now, the streams are indexed by stream handle so we have
2135 * to iterate over all streams to find the one associated with
2136 * the right session_id.
2139 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2141 if (!stream_get(stream
)) {
2144 if (stream
->trace
->session
->id
== msg
.session_id
) {
2145 pthread_mutex_lock(&stream
->lock
);
2146 stream
->data_pending_check_done
= false;
2147 pthread_mutex_unlock(&stream
->lock
);
2148 DBG("Set begin data pending flag to stream %" PRIu64
,
2149 stream
->stream_handle
);
2155 memset(&reply
, 0, sizeof(reply
));
2156 /* All good, send back reply. */
2157 reply
.ret_code
= htobe32(LTTNG_OK
);
2159 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2160 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2161 ERR("Failed to send \"begin data pending\" command reply (ret = %zd)",
2173 * End data pending command. This will check, for a given session id, if
2174 * each stream associated with it has its data_pending_check_done flag
2175 * set. If not, this means that the client lost track of the stream but
2176 * the data is still being streamed on our side. In this case, we inform
2177 * the client that data is in flight.
2179 * Return to the client if there is data in flight or not with a ret_code.
2181 static int relay_end_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2182 struct relay_connection
*conn
,
2183 const struct lttng_buffer_view
*payload
)
2187 struct lttng_ht_iter iter
;
2188 struct lttcomm_relayd_end_data_pending msg
;
2189 struct lttcomm_relayd_generic_reply reply
;
2190 struct relay_stream
*stream
;
2191 uint32_t is_data_inflight
= 0;
2193 DBG("End data pending command");
2195 if (!conn
->session
|| !conn
->version_check_done
) {
2196 ERR("Trying to check for data before version check");
2198 goto end_no_session
;
2201 if (payload
->size
< sizeof(msg
)) {
2202 ERR("Unexpected payload size in \"relay_end_data_pending\": expected >= %zu bytes, got %zu bytes",
2203 sizeof(msg
), payload
->size
);
2205 goto end_no_session
;
2207 memcpy(&msg
, payload
->data
, sizeof(msg
));
2208 msg
.session_id
= be64toh(msg
.session_id
);
2211 * Iterate over all streams to see if the begin data pending
2215 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2217 if (!stream_get(stream
)) {
2220 if (stream
->trace
->session
->id
!= msg
.session_id
) {
2224 pthread_mutex_lock(&stream
->lock
);
2225 if (!stream
->data_pending_check_done
) {
2226 uint64_t stream_seq
;
2228 if (session_streams_have_index(conn
->session
)) {
2230 * Ensure that both the index and stream data have been
2231 * flushed up to the requested point.
2233 stream_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
2235 stream_seq
= stream
->prev_data_seq
;
2237 if (!stream
->closed
|| !(((int64_t) (stream_seq
- stream
->last_net_seq_num
)) >= 0)) {
2238 is_data_inflight
= 1;
2239 DBG("Data is still in flight for stream %" PRIu64
,
2240 stream
->stream_handle
);
2241 pthread_mutex_unlock(&stream
->lock
);
2246 pthread_mutex_unlock(&stream
->lock
);
2251 memset(&reply
, 0, sizeof(reply
));
2252 /* All good, send back reply. */
2253 reply
.ret_code
= htobe32(is_data_inflight
);
2255 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2256 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2257 ERR("Failed to send \"end data pending\" command reply (ret = %zd)",
2269 * Receive an index for a specific stream.
2271 * Return 0 on success else a negative value.
2273 static int relay_recv_index(const struct lttcomm_relayd_hdr
*recv_hdr
,
2274 struct relay_connection
*conn
,
2275 const struct lttng_buffer_view
*payload
)
2279 struct relay_session
*session
= conn
->session
;
2280 struct lttcomm_relayd_index index_info
;
2281 struct relay_index
*index
;
2282 struct lttcomm_relayd_generic_reply reply
;
2283 struct relay_stream
*stream
;
2288 DBG("Relay receiving index");
2290 if (!session
|| !conn
->version_check_done
) {
2291 ERR("Trying to close a stream before version check");
2293 goto end_no_session
;
2296 msg_len
= lttcomm_relayd_index_len(
2297 lttng_to_index_major(conn
->major
, conn
->minor
),
2298 lttng_to_index_minor(conn
->major
, conn
->minor
));
2299 if (payload
->size
< msg_len
) {
2300 ERR("Unexpected payload size in \"relay_recv_index\": expected >= %zu bytes, got %zu bytes",
2301 msg_len
, payload
->size
);
2303 goto end_no_session
;
2305 memcpy(&index_info
, payload
->data
, msg_len
);
2306 index_info
.relay_stream_id
= be64toh(index_info
.relay_stream_id
);
2307 index_info
.net_seq_num
= be64toh(index_info
.net_seq_num
);
2308 index_info
.packet_size
= be64toh(index_info
.packet_size
);
2309 index_info
.content_size
= be64toh(index_info
.content_size
);
2310 index_info
.timestamp_begin
= be64toh(index_info
.timestamp_begin
);
2311 index_info
.timestamp_end
= be64toh(index_info
.timestamp_end
);
2312 index_info
.events_discarded
= be64toh(index_info
.events_discarded
);
2313 index_info
.stream_id
= be64toh(index_info
.stream_id
);
2315 if (conn
->minor
>= 8) {
2316 index_info
.stream_instance_id
=
2317 be64toh(index_info
.stream_instance_id
);
2318 index_info
.packet_seq_num
= be64toh(index_info
.packet_seq_num
);
2321 stream
= stream_get_by_id(index_info
.relay_stream_id
);
2323 ERR("stream_get_by_id not found");
2327 pthread_mutex_lock(&stream
->lock
);
2329 /* Live beacon handling */
2330 if (index_info
.packet_size
== 0) {
2331 DBG("Received live beacon for stream %" PRIu64
,
2332 stream
->stream_handle
);
2335 * Only flag a stream inactive when it has already
2336 * received data and no indexes are in flight.
2338 if (stream
->index_received_seqcount
> 0
2339 && stream
->indexes_in_flight
== 0) {
2340 stream
->beacon_ts_end
= index_info
.timestamp_end
;
2343 goto end_stream_put
;
2345 stream
->beacon_ts_end
= -1ULL;
2348 if (stream
->ctf_stream_id
== -1ULL) {
2349 stream
->ctf_stream_id
= index_info
.stream_id
;
2351 index
= relay_index_get_by_id_or_create(stream
, index_info
.net_seq_num
);
2354 ERR("relay_index_get_by_id_or_create index NULL");
2355 goto end_stream_put
;
2357 if (set_index_control_data(index
, &index_info
, conn
)) {
2358 ERR("set_index_control_data error");
2359 relay_index_put(index
);
2361 goto end_stream_put
;
2363 ret
= relay_index_try_flush(index
);
2365 tracefile_array_commit_seq(stream
->tfa
);
2366 stream
->index_received_seqcount
++;
2367 stream
->pos_after_last_complete_data_index
+= index
->total_size
;
2368 stream
->prev_index_seq
= index_info
.net_seq_num
;
2369 } else if (ret
> 0) {
2376 * relay_index_try_flush is responsible for the self-reference
2377 * put of the index object on error.
2379 ERR("relay_index_try_flush error %d", ret
);
2384 pthread_mutex_unlock(&stream
->lock
);
2389 memset(&reply
, 0, sizeof(reply
));
2391 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2393 reply
.ret_code
= htobe32(LTTNG_OK
);
2395 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2396 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2397 ERR("Failed to send \"recv index\" command reply (ret = %zd)", send_ret
);
2406 * Receive the streams_sent message.
2408 * Return 0 on success else a negative value.
2410 static int relay_streams_sent(const struct lttcomm_relayd_hdr
*recv_hdr
,
2411 struct relay_connection
*conn
,
2412 const struct lttng_buffer_view
*payload
)
2416 struct lttcomm_relayd_generic_reply reply
;
2420 DBG("Relay receiving streams_sent");
2422 if (!conn
->session
|| !conn
->version_check_done
) {
2423 ERR("Trying to close a stream before version check");
2425 goto end_no_session
;
2429 * Publish every pending stream in the connection recv list which are
2430 * now ready to be used by the viewer.
2432 publish_connection_local_streams(conn
);
2434 memset(&reply
, 0, sizeof(reply
));
2435 reply
.ret_code
= htobe32(LTTNG_OK
);
2436 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2437 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2438 ERR("Failed to send \"streams sent\" command reply (ret = %zd)",
2451 * relay_rotate_session_stream: rotate a stream to a new tracefile for the session
2452 * rotation feature (not the tracefile rotation feature).
2454 static int relay_rotate_session_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
2455 struct relay_connection
*conn
,
2456 const struct lttng_buffer_view
*payload
)
2460 struct relay_session
*session
= conn
->session
;
2461 struct lttcomm_relayd_rotate_stream stream_info
;
2462 struct lttcomm_relayd_generic_reply reply
;
2463 struct relay_stream
*stream
;
2466 struct lttng_buffer_view new_path_view
;
2468 DBG("Rotate stream received");
2470 if (!session
|| !conn
->version_check_done
) {
2471 ERR("Trying to rotate a stream before version check");
2476 if (session
->major
== 2 && session
->minor
< 11) {
2477 ERR("Unsupported feature before 2.11");
2482 header_len
= sizeof(struct lttcomm_relayd_rotate_stream
);
2484 if (payload
->size
< header_len
) {
2485 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected >= %zu bytes, got %zu bytes",
2486 header_len
, payload
->size
);
2491 memcpy(&stream_info
, payload
->data
, header_len
);
2493 /* Convert to host */
2494 stream_info
.pathname_length
= be32toh(stream_info
.pathname_length
);
2495 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
2496 stream_info
.new_chunk_id
= be64toh(stream_info
.new_chunk_id
);
2497 stream_info
.rotate_at_seq_num
= be64toh(stream_info
.rotate_at_seq_num
);
2499 path_len
= stream_info
.pathname_length
;
2500 if (payload
->size
< header_len
+ path_len
) {
2501 ERR("Unexpected payload size in \"relay_rotate_session_stream\" including path: expected >= %zu bytes, got %zu bytes",
2502 header_len
+ path_len
, payload
->size
);
2507 /* Ensure it fits in local filename length. */
2508 if (path_len
>= LTTNG_PATH_MAX
) {
2509 ret
= -ENAMETOOLONG
;
2510 ERR("Length of relay_rotate_session_stream command's path name (%zu bytes) exceeds the maximal allowed length of %i bytes",
2511 path_len
, LTTNG_PATH_MAX
);
2515 new_path_view
= lttng_buffer_view_from_view(payload
, header_len
,
2516 stream_info
.pathname_length
);
2518 stream
= stream_get_by_id(stream_info
.stream_id
);
2524 pthread_mutex_lock(&stream
->lock
);
2527 * Update the trace path (just the folder, the stream name does not
2530 free(stream
->prev_path_name
);
2531 stream
->prev_path_name
= stream
->path_name
;
2532 stream
->path_name
= create_output_path(new_path_view
.data
);
2533 if (!stream
->path_name
) {
2534 ERR("Failed to create a new output path");
2536 goto end_stream_unlock
;
2538 ret
= utils_mkdir_recursive(stream
->path_name
, S_IRWXU
| S_IRWXG
,
2541 ERR("relay creating output directory");
2543 goto end_stream_unlock
;
2546 assert(stream
->current_chunk_id
.is_set
);
2547 stream
->current_chunk_id
.value
= stream_info
.new_chunk_id
;
2549 if (stream
->is_metadata
) {
2551 * The metadata stream is sent only over the control connection
2552 * so we know we have all the data to perform the stream
2555 ret
= do_rotate_stream(stream
);
2557 stream
->rotate_at_seq_num
= stream_info
.rotate_at_seq_num
;
2558 ret
= try_rotate_stream(stream
);
2561 goto end_stream_unlock
;
2565 pthread_mutex_unlock(&stream
->lock
);
2568 memset(&reply
, 0, sizeof(reply
));
2570 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2572 reply
.ret_code
= htobe32(LTTNG_OK
);
2574 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2575 sizeof(struct lttcomm_relayd_generic_reply
), 0);
2576 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2577 ERR("Failed to send \"rotate session stream\" command reply (ret = %zd)",
2587 * relay_mkdir: Create a folder on the disk.
2589 static int relay_mkdir(const struct lttcomm_relayd_hdr
*recv_hdr
,
2590 struct relay_connection
*conn
,
2591 const struct lttng_buffer_view
*payload
)
2594 struct relay_session
*session
= conn
->session
;
2595 struct lttcomm_relayd_mkdir path_info_header
;
2596 struct lttcomm_relayd_generic_reply reply
;
2600 struct lttng_buffer_view path_view
;
2602 if (!session
|| !conn
->version_check_done
) {
2603 ERR("Trying to create a directory before version check");
2605 goto end_no_session
;
2608 if (session
->major
== 2 && session
->minor
< 11) {
2610 * This client is not supposed to use this command since
2611 * it predates its introduction.
2613 ERR("relay_mkdir command is unsupported before LTTng 2.11");
2615 goto end_no_session
;
2618 header_len
= sizeof(path_info_header
);
2619 if (payload
->size
< header_len
) {
2620 ERR("Unexpected payload size in \"relay_mkdir\": expected >= %zu bytes, got %zu bytes",
2621 header_len
, payload
->size
);
2623 goto end_no_session
;
2626 memcpy(&path_info_header
, payload
->data
, header_len
);
2628 path_info_header
.length
= be32toh(path_info_header
.length
);
2630 if (payload
->size
< header_len
+ path_info_header
.length
) {
2631 ERR("Unexpected payload size in \"relay_mkdir\" including path: expected >= %zu bytes, got %zu bytes",
2632 header_len
+ path_info_header
.length
, payload
->size
);
2634 goto end_no_session
;
2637 /* Ensure that it fits in local path length. */
2638 if (path_info_header
.length
>= LTTNG_PATH_MAX
) {
2639 ret
= -ENAMETOOLONG
;
2640 ERR("Path name argument of mkdir command (%" PRIu32
" bytes) exceeds the maximal length allowed (%d bytes)",
2641 path_info_header
.length
, LTTNG_PATH_MAX
);
2645 path_view
= lttng_buffer_view_from_view(payload
, header_len
,
2646 path_info_header
.length
);
2648 path
= create_output_path(path_view
.data
);
2650 ERR("Failed to create output path");
2655 DBG("MKDIR command has path \"%s\", changed to \"%s\"", path_view
.data
, path
);
2656 ret
= utils_mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, -1, -1);
2658 ERR("relay creating output directory");
2665 memset(&reply
, 0, sizeof(reply
));
2667 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2669 reply
.ret_code
= htobe32(LTTNG_OK
);
2671 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2672 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2673 ERR("Failed to send \"mkdir\" command reply (ret = %zd)", send_ret
);
2682 static int validate_rotate_rename_path_length(const char *path_type
,
2683 uint32_t path_length
)
2687 if (path_length
> LTTNG_PATH_MAX
) {
2688 ret
= -ENAMETOOLONG
;
2689 ERR("rotate rename \"%s\" path name length (%" PRIu32
" bytes) exceeds the allowed size of %i bytes",
2690 path_type
, path_length
, LTTNG_PATH_MAX
);
2691 } else if (path_length
== 0) {
2693 ERR("rotate rename \"%s\" path name has an illegal length of 0", path_type
);
2699 * relay_rotate_rename: rename the trace folder after a rotation is
2700 * completed. We are not closing any fd here, just moving the folder, so it
2701 * works even if data is still in-flight.
2703 static int relay_rotate_rename(const struct lttcomm_relayd_hdr
*recv_hdr
,
2704 struct relay_connection
*conn
,
2705 const struct lttng_buffer_view
*payload
)
2709 struct relay_session
*session
= conn
->session
;
2710 struct lttcomm_relayd_generic_reply reply
;
2711 struct lttcomm_relayd_rotate_rename header
;
2713 size_t received_paths_size
;
2714 char *complete_old_path
= NULL
, *complete_new_path
= NULL
;
2715 struct lttng_buffer_view old_path_view
;
2716 struct lttng_buffer_view new_path_view
;
2718 if (!session
|| !conn
->version_check_done
) {
2719 ERR("Trying to rename a trace folder before version check");
2724 if (session
->major
== 2 && session
->minor
< 11) {
2725 ERR("relay_rotate_rename command is unsupported before LTTng 2.11");
2730 header_len
= sizeof(header
);
2731 if (payload
->size
< header_len
) {
2732 ERR("Unexpected payload size in \"relay_rotate_rename\": expected >= %zu bytes, got %zu bytes",
2733 header_len
, payload
->size
);
2738 memcpy(&header
, payload
->data
, header_len
);
2740 header
.old_path_length
= be32toh(header
.old_path_length
);
2741 header
.new_path_length
= be32toh(header
.new_path_length
);
2742 received_paths_size
= header
.old_path_length
+ header
.new_path_length
;
2744 if (payload
->size
< header_len
+ received_paths_size
) {
2745 ERR("Unexpected payload size in \"relay_rotate_rename\" including paths: expected >= %zu bytes, got %zu bytes",
2746 header_len
, payload
->size
);
2751 /* Ensure the paths don't exceed their allowed size. */
2752 ret
= validate_rotate_rename_path_length("old", header
.old_path_length
);
2756 ret
= validate_rotate_rename_path_length("new", header
.new_path_length
);
2761 old_path_view
= lttng_buffer_view_from_view(payload
, header_len
,
2762 header
.old_path_length
);
2763 new_path_view
= lttng_buffer_view_from_view(payload
,
2764 header_len
+ header
.old_path_length
,
2765 header
.new_path_length
);
2767 /* Validate that both paths received are NULL terminated. */
2768 if (old_path_view
.data
[old_path_view
.size
- 1] != '\0') {
2769 ERR("relay_rotate_rename command's \"old\" path is invalid (not NULL terminated)");
2773 if (new_path_view
.data
[new_path_view
.size
- 1] != '\0') {
2774 ERR("relay_rotate_rename command's \"new\" path is invalid (not NULL terminated)");
2779 DBG("ROTATE_RENAME command has argument old path = \"%s\", new_path = \"%s\"",
2780 old_path_view
.data
, new_path_view
.data
);
2781 complete_old_path
= create_output_path(old_path_view
.data
);
2782 if (!complete_old_path
) {
2783 ERR("Failed to build old output path in rotate_rename command");
2788 complete_new_path
= create_output_path(new_path_view
.data
);
2789 if (!complete_new_path
) {
2790 ERR("Failed to build new output path in rotate_rename command");
2794 DBG("Expanded ROTATE_RENAME arguments to old path = \"%s\", new_path = \"%s\"",
2795 complete_old_path
, complete_new_path
);
2797 ret
= utils_mkdir_recursive(complete_new_path
, S_IRWXU
| S_IRWXG
,
2800 ERR("Failed to mkdir() rotate_rename's \"new\" output directory at \"%s\"",
2806 * If a domain has not yet created its channel, the domain-specific
2807 * folder might not exist, but this is not an error.
2809 ret
= rename(complete_old_path
, complete_new_path
);
2810 if (ret
< 0 && errno
!= ENOENT
) {
2811 PERROR("Renaming chunk in rotate_rename command from \"%s\" to \"%s\"",
2812 complete_old_path
, complete_new_path
);
2818 memset(&reply
, 0, sizeof(reply
));
2820 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2822 reply
.ret_code
= htobe32(LTTNG_OK
);
2824 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2826 if (send_ret
< sizeof(reply
)) {
2827 ERR("Failed to send \"rotate rename\" command reply (ret = %zd)",
2833 free(complete_old_path
);
2834 free(complete_new_path
);
2839 * Check if all the streams in the session have completed the last rotation.
2840 * The chunk_id value is used to distinguish the cases where a stream was
2841 * closed on the consumerd before the rotation started but it still active on
2842 * the relayd, and the case where a stream appeared on the consumerd/relayd
2843 * after the last rotation started (in that case, it is already writing in the
2844 * new chunk folder).
2847 int relay_rotate_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2848 struct relay_connection
*conn
,
2849 const struct lttng_buffer_view
*payload
)
2851 struct relay_session
*session
= conn
->session
;
2852 struct lttcomm_relayd_rotate_pending msg
;
2853 struct lttcomm_relayd_rotate_pending_reply reply
;
2854 struct lttng_ht_iter iter
;
2855 struct relay_stream
*stream
;
2859 bool rotate_pending
= false;
2861 DBG("Rotate pending command received");
2863 if (!session
|| !conn
->version_check_done
) {
2864 ERR("Trying to check for data before version check");
2869 if (session
->major
== 2 && session
->minor
< 11) {
2870 ERR("Unsupported feature before 2.11");
2875 if (payload
->size
< sizeof(msg
)) {
2876 ERR("Unexpected payload size in \"relay_rotate_pending\": expected >= %zu bytes, got %zu bytes",
2877 sizeof(msg
), payload
->size
);
2882 memcpy(&msg
, payload
->data
, sizeof(msg
));
2884 chunk_id
= be64toh(msg
.chunk_id
);
2886 DBG("Evaluating rotate pending for session \"%s\" and chunk id %" PRIu64
,
2887 session
->session_name
, chunk_id
);
2890 * Iterate over all the streams in the session and check if they are
2891 * still waiting for data to perform their rotation.
2894 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2896 if (!stream_get(stream
)) {
2899 if (stream
->trace
->session
!= session
) {
2903 pthread_mutex_lock(&stream
->lock
);
2904 if (stream
->rotate_at_seq_num
!= -1ULL) {
2905 /* We have not yet performed the rotation. */
2906 rotate_pending
= true;
2907 DBG("Stream %" PRIu64
" is still rotating",
2908 stream
->stream_handle
);
2909 } else if (stream
->current_chunk_id
.value
< chunk_id
) {
2911 * Stream closed on the consumer but still active on the
2914 rotate_pending
= true;
2915 DBG("Stream %" PRIu64
" did not exist on the consumer "
2916 "when the last rotation started, but is"
2917 "still waiting for data before getting"
2919 stream
->stream_handle
);
2921 pthread_mutex_unlock(&stream
->lock
);
2923 if (rotate_pending
) {
2930 memset(&reply
, 0, sizeof(reply
));
2931 reply
.generic
.ret_code
= htobe32((uint32_t) LTTNG_OK
);
2932 reply
.is_pending
= (uint8_t) !!rotate_pending
;
2933 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2935 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2936 ERR("Failed to send \"rotate pending\" command reply (ret = %zd)",
2945 #define DBG_CMD(cmd_name, conn) \
2946 DBG3("Processing \"%s\" command for socket %i", cmd_name, conn->sock->fd);
2948 static int relay_process_control_command(struct relay_connection
*conn
,
2949 const struct lttcomm_relayd_hdr
*header
,
2950 const struct lttng_buffer_view
*payload
)
2954 switch (header
->cmd
) {
2955 case RELAYD_CREATE_SESSION
:
2956 DBG_CMD("RELAYD_CREATE_SESSION", conn
);
2957 ret
= relay_create_session(header
, conn
, payload
);
2959 case RELAYD_ADD_STREAM
:
2960 DBG_CMD("RELAYD_ADD_STREAM", conn
);
2961 ret
= relay_add_stream(header
, conn
, payload
);
2963 case RELAYD_START_DATA
:
2964 DBG_CMD("RELAYD_START_DATA", conn
);
2965 ret
= relay_start(header
, conn
, payload
);
2967 case RELAYD_SEND_METADATA
:
2968 DBG_CMD("RELAYD_SEND_METADATA", conn
);
2969 ret
= relay_recv_metadata(header
, conn
, payload
);
2971 case RELAYD_VERSION
:
2972 DBG_CMD("RELAYD_VERSION", conn
);
2973 ret
= relay_send_version(header
, conn
, payload
);
2975 case RELAYD_CLOSE_STREAM
:
2976 DBG_CMD("RELAYD_CLOSE_STREAM", conn
);
2977 ret
= relay_close_stream(header
, conn
, payload
);
2979 case RELAYD_DATA_PENDING
:
2980 DBG_CMD("RELAYD_DATA_PENDING", conn
);
2981 ret
= relay_data_pending(header
, conn
, payload
);
2983 case RELAYD_QUIESCENT_CONTROL
:
2984 DBG_CMD("RELAYD_QUIESCENT_CONTROL", conn
);
2985 ret
= relay_quiescent_control(header
, conn
, payload
);
2987 case RELAYD_BEGIN_DATA_PENDING
:
2988 DBG_CMD("RELAYD_BEGIN_DATA_PENDING", conn
);
2989 ret
= relay_begin_data_pending(header
, conn
, payload
);
2991 case RELAYD_END_DATA_PENDING
:
2992 DBG_CMD("RELAYD_END_DATA_PENDING", conn
);
2993 ret
= relay_end_data_pending(header
, conn
, payload
);
2995 case RELAYD_SEND_INDEX
:
2996 DBG_CMD("RELAYD_SEND_INDEX", conn
);
2997 ret
= relay_recv_index(header
, conn
, payload
);
2999 case RELAYD_STREAMS_SENT
:
3000 DBG_CMD("RELAYD_STREAMS_SENT", conn
);
3001 ret
= relay_streams_sent(header
, conn
, payload
);
3003 case RELAYD_RESET_METADATA
:
3004 DBG_CMD("RELAYD_RESET_METADATA", conn
);
3005 ret
= relay_reset_metadata(header
, conn
, payload
);
3007 case RELAYD_ROTATE_STREAM
:
3008 DBG_CMD("RELAYD_ROTATE_STREAM", conn
);
3009 ret
= relay_rotate_session_stream(header
, conn
, payload
);
3011 case RELAYD_ROTATE_RENAME
:
3012 DBG_CMD("RELAYD_ROTATE_RENAME", conn
);
3013 ret
= relay_rotate_rename(header
, conn
, payload
);
3015 case RELAYD_ROTATE_PENDING
:
3016 DBG_CMD("RELAYD_ROTATE_PENDING", conn
);
3017 ret
= relay_rotate_pending(header
, conn
, payload
);
3020 DBG_CMD("RELAYD_MKDIR", conn
);
3021 ret
= relay_mkdir(header
, conn
, payload
);
3023 case RELAYD_UPDATE_SYNC_INFO
:
3025 ERR("Received unknown command (%u)", header
->cmd
);
3026 relay_unknown_command(conn
);
3035 static enum relay_connection_status
relay_process_control_receive_payload(
3036 struct relay_connection
*conn
)
3039 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3040 struct lttng_dynamic_buffer
*reception_buffer
=
3041 &conn
->protocol
.ctrl
.reception_buffer
;
3042 struct ctrl_connection_state_receive_payload
*state
=
3043 &conn
->protocol
.ctrl
.state
.receive_payload
;
3044 struct lttng_buffer_view payload_view
;
3046 if (state
->left_to_receive
== 0) {
3047 /* Short-circuit for payload-less commands. */
3048 goto reception_complete
;
3051 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3052 reception_buffer
->data
+ state
->received
,
3053 state
->left_to_receive
, MSG_DONTWAIT
);
3055 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3056 PERROR("Unable to receive command payload on sock %d",
3058 status
= RELAY_CONNECTION_STATUS_ERROR
;
3061 } else if (ret
== 0) {
3062 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3063 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3068 assert(ret
<= state
->left_to_receive
);
3070 state
->left_to_receive
-= ret
;
3071 state
->received
+= ret
;
3073 if (state
->left_to_receive
> 0) {
3075 * Can't transition to the protocol's next state, wait to
3076 * receive the rest of the header.
3078 DBG3("Partial reception of control connection protocol payload (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3079 state
->received
, state
->left_to_receive
,
3085 DBG("Done receiving control command payload: fd = %i, payload size = %" PRIu64
" bytes",
3086 conn
->sock
->fd
, state
->received
);
3088 * The payload required to process the command has been received.
3089 * A view to the reception buffer is forwarded to the various
3090 * commands and the state of the control is reset on success.
3092 * Commands are responsible for sending their reply to the peer.
3094 payload_view
= lttng_buffer_view_from_dynamic_buffer(reception_buffer
,
3096 ret
= relay_process_control_command(conn
,
3097 &state
->header
, &payload_view
);
3099 status
= RELAY_CONNECTION_STATUS_ERROR
;
3103 ret
= connection_reset_protocol_state(conn
);
3105 status
= RELAY_CONNECTION_STATUS_ERROR
;
3111 static enum relay_connection_status
relay_process_control_receive_header(
3112 struct relay_connection
*conn
)
3115 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3116 struct lttcomm_relayd_hdr header
;
3117 struct lttng_dynamic_buffer
*reception_buffer
=
3118 &conn
->protocol
.ctrl
.reception_buffer
;
3119 struct ctrl_connection_state_receive_header
*state
=
3120 &conn
->protocol
.ctrl
.state
.receive_header
;
3122 assert(state
->left_to_receive
!= 0);
3124 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3125 reception_buffer
->data
+ state
->received
,
3126 state
->left_to_receive
, MSG_DONTWAIT
);
3128 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3129 PERROR("Unable to receive control command header on sock %d",
3131 status
= RELAY_CONNECTION_STATUS_ERROR
;
3134 } else if (ret
== 0) {
3135 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3136 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3141 assert(ret
<= state
->left_to_receive
);
3143 state
->left_to_receive
-= ret
;
3144 state
->received
+= ret
;
3146 if (state
->left_to_receive
> 0) {
3148 * Can't transition to the protocol's next state, wait to
3149 * receive the rest of the header.
3151 DBG3("Partial reception of control connection protocol header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3152 state
->received
, state
->left_to_receive
,
3157 /* Transition to next state: receiving the command's payload. */
3158 conn
->protocol
.ctrl
.state_id
=
3159 CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3160 memcpy(&header
, reception_buffer
->data
, sizeof(header
));
3161 header
.circuit_id
= be64toh(header
.circuit_id
);
3162 header
.data_size
= be64toh(header
.data_size
);
3163 header
.cmd
= be32toh(header
.cmd
);
3164 header
.cmd_version
= be32toh(header
.cmd_version
);
3165 memcpy(&conn
->protocol
.ctrl
.state
.receive_payload
.header
,
3166 &header
, sizeof(header
));
3168 DBG("Done receiving control command header: fd = %i, cmd = %" PRIu32
", cmd_version = %" PRIu32
", payload size = %" PRIu64
" bytes",
3169 conn
->sock
->fd
, header
.cmd
, header
.cmd_version
,
3172 if (header
.data_size
> DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE
) {
3173 ERR("Command header indicates a payload (%" PRIu64
" bytes) that exceeds the maximal payload size allowed on a control connection.",
3175 status
= RELAY_CONNECTION_STATUS_ERROR
;
3179 conn
->protocol
.ctrl
.state
.receive_payload
.left_to_receive
=
3181 conn
->protocol
.ctrl
.state
.receive_payload
.received
= 0;
3182 ret
= lttng_dynamic_buffer_set_size(reception_buffer
,
3185 status
= RELAY_CONNECTION_STATUS_ERROR
;
3189 if (header
.data_size
== 0) {
3191 * Manually invoke the next state as the poll loop
3192 * will not wake-up to allow us to proceed further.
3194 status
= relay_process_control_receive_payload(conn
);
3201 * Process the commands received on the control socket
3203 static enum relay_connection_status
relay_process_control(
3204 struct relay_connection
*conn
)
3206 enum relay_connection_status status
;
3208 switch (conn
->protocol
.ctrl
.state_id
) {
3209 case CTRL_CONNECTION_STATE_RECEIVE_HEADER
:
3210 status
= relay_process_control_receive_header(conn
);
3212 case CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3213 status
= relay_process_control_receive_payload(conn
);
3216 ERR("Unknown control connection protocol state encountered.");
3224 * Handle index for a data stream.
3226 * Called with the stream lock held.
3228 * Return 0 on success else a negative value.
3230 static int handle_index_data(struct relay_stream
*stream
, uint64_t net_seq_num
,
3231 bool rotate_index
, bool *flushed
, uint64_t total_size
)
3234 uint64_t data_offset
;
3235 struct relay_index
*index
;
3237 /* Get data offset because we are about to update the index. */
3238 data_offset
= htobe64(stream
->tracefile_size_current
);
3240 DBG("handle_index_data: stream %" PRIu64
" net_seq_num %" PRIu64
" data offset %" PRIu64
,
3241 stream
->stream_handle
, net_seq_num
, stream
->tracefile_size_current
);
3244 * Lookup for an existing index for that stream id/sequence
3245 * number. If it exists, the control thread has already received the
3246 * data for it, thus we need to write it to disk.
3248 index
= relay_index_get_by_id_or_create(stream
, net_seq_num
);
3254 if (rotate_index
|| !stream
->index_file
) {
3255 const char *stream_path
;
3258 * The data connection creates the stream's first index file.
3260 * This can happen _after_ a ROTATE_STREAM command. In
3261 * other words, the data of the first packet of this stream
3262 * can be received after a ROTATE_STREAM command.
3264 * The ROTATE_STREAM command changes the stream's path_name
3265 * to point to the "next" chunk. If a rotation is pending for
3266 * this stream, as indicated by "rotate_at_seq_num != -1ULL",
3267 * it means that we are still receiving data that belongs in the
3268 * stream's former path.
3270 * In this very specific case, we must ensure that the index
3271 * file is created in the streams's former path,
3274 * All other rotations beyond the first one are not affected
3275 * by this problem since the actual rotation operation creates
3276 * the new chunk's index file.
3278 stream_path
= stream
->rotate_at_seq_num
== -1ULL ?
3280 stream
->prev_path_name
;
3282 ret
= create_rotate_index_file(stream
, stream_path
);
3284 ERR("Failed to rotate index");
3285 /* Put self-ref for this index due to error. */
3286 relay_index_put(index
);
3292 if (relay_index_set_file(index
, stream
->index_file
, data_offset
)) {
3294 /* Put self-ref for this index due to error. */
3295 relay_index_put(index
);
3300 ret
= relay_index_try_flush(index
);
3302 tracefile_array_commit_seq(stream
->tfa
);
3303 stream
->index_received_seqcount
++;
3305 } else if (ret
> 0) {
3306 index
->total_size
= total_size
;
3313 * relay_index_try_flush is responsible for the self-reference
3314 * put of the index object on error.
3316 ERR("relay_index_try_flush error %d", ret
);
3323 static enum relay_connection_status
relay_process_data_receive_header(
3324 struct relay_connection
*conn
)
3327 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3328 struct data_connection_state_receive_header
*state
=
3329 &conn
->protocol
.data
.state
.receive_header
;
3330 struct lttcomm_relayd_data_hdr header
;
3331 struct relay_stream
*stream
;
3333 assert(state
->left_to_receive
!= 0);
3335 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3336 state
->header_reception_buffer
+ state
->received
,
3337 state
->left_to_receive
, MSG_DONTWAIT
);
3339 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3340 PERROR("Unable to receive data header on sock %d", conn
->sock
->fd
);
3341 status
= RELAY_CONNECTION_STATUS_ERROR
;
3344 } else if (ret
== 0) {
3345 /* Orderly shutdown. Not necessary to print an error. */
3346 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3347 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3352 assert(ret
<= state
->left_to_receive
);
3354 state
->left_to_receive
-= ret
;
3355 state
->received
+= ret
;
3357 if (state
->left_to_receive
> 0) {
3359 * Can't transition to the protocol's next state, wait to
3360 * receive the rest of the header.
3362 DBG3("Partial reception of data connection header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3363 state
->received
, state
->left_to_receive
,
3368 /* Transition to next state: receiving the payload. */
3369 conn
->protocol
.data
.state_id
= DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3371 memcpy(&header
, state
->header_reception_buffer
, sizeof(header
));
3372 header
.circuit_id
= be64toh(header
.circuit_id
);
3373 header
.stream_id
= be64toh(header
.stream_id
);
3374 header
.data_size
= be32toh(header
.data_size
);
3375 header
.net_seq_num
= be64toh(header
.net_seq_num
);
3376 header
.padding_size
= be32toh(header
.padding_size
);
3377 memcpy(&conn
->protocol
.data
.state
.receive_payload
.header
, &header
, sizeof(header
));
3379 conn
->protocol
.data
.state
.receive_payload
.left_to_receive
=
3381 conn
->protocol
.data
.state
.receive_payload
.received
= 0;
3382 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= false;
3384 DBG("Received data connection header on fd %i: circuit_id = %" PRIu64
", stream_id = %" PRIu64
", data_size = %" PRIu32
", net_seq_num = %" PRIu64
", padding_size = %" PRIu32
,
3385 conn
->sock
->fd
, header
.circuit_id
,
3386 header
.stream_id
, header
.data_size
,
3387 header
.net_seq_num
, header
.padding_size
);
3389 stream
= stream_get_by_id(header
.stream_id
);
3391 DBG("relay_process_data_receive_payload: Cannot find stream %" PRIu64
,
3393 /* Protocol error. */
3394 status
= RELAY_CONNECTION_STATUS_ERROR
;
3398 pthread_mutex_lock(&stream
->lock
);
3400 /* Check if a rotation is needed. */
3401 if (stream
->tracefile_size
> 0 &&
3402 (stream
->tracefile_size_current
+ header
.data_size
) >
3403 stream
->tracefile_size
) {
3404 uint64_t old_id
, new_id
;
3406 old_id
= tracefile_array_get_file_index_head(stream
->tfa
);
3407 tracefile_array_file_rotate(stream
->tfa
);
3409 /* new_id is updated by utils_rotate_stream_file. */
3412 ret
= utils_rotate_stream_file(stream
->path_name
,
3413 stream
->channel_name
, stream
->tracefile_size
,
3414 stream
->tracefile_count
, -1,
3415 -1, stream
->stream_fd
->fd
,
3416 &new_id
, &stream
->stream_fd
->fd
);
3418 ERR("Failed to rotate stream output file");
3419 status
= RELAY_CONNECTION_STATUS_ERROR
;
3420 goto end_stream_unlock
;
3424 * Reset current size because we just performed a stream
3427 stream
->tracefile_size_current
= 0;
3428 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= true;
3432 pthread_mutex_unlock(&stream
->lock
);
3438 static enum relay_connection_status
relay_process_data_receive_payload(
3439 struct relay_connection
*conn
)
3442 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3443 struct relay_stream
*stream
;
3444 struct data_connection_state_receive_payload
*state
=
3445 &conn
->protocol
.data
.state
.receive_payload
;
3446 const size_t chunk_size
= RECV_DATA_BUFFER_SIZE
;
3447 char data_buffer
[chunk_size
];
3448 bool partial_recv
= false;
3449 bool new_stream
= false, close_requested
= false, index_flushed
= false;
3450 uint64_t left_to_receive
= state
->left_to_receive
;
3451 struct relay_session
*session
;
3453 DBG3("Receiving data for stream id %" PRIu64
" seqnum %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3454 state
->header
.stream_id
, state
->header
.net_seq_num
,
3455 state
->received
, left_to_receive
);
3457 stream
= stream_get_by_id(state
->header
.stream_id
);
3459 /* Protocol error. */
3460 ERR("relay_process_data_receive_payload: cannot find stream %" PRIu64
,
3461 state
->header
.stream_id
);
3462 status
= RELAY_CONNECTION_STATUS_ERROR
;
3466 pthread_mutex_lock(&stream
->lock
);
3467 session
= stream
->trace
->session
;
3468 if (!conn
->session
) {
3469 ret
= connection_set_session(conn
, session
);
3471 status
= RELAY_CONNECTION_STATUS_ERROR
;
3472 goto end_stream_unlock
;
3477 * The size of the "chunk" received on any iteration is bounded by:
3478 * - the data left to receive,
3479 * - the data immediately available on the socket,
3480 * - the on-stack data buffer
3482 while (left_to_receive
> 0 && !partial_recv
) {
3484 size_t recv_size
= min(left_to_receive
, chunk_size
);
3486 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
,
3487 recv_size
, MSG_DONTWAIT
);
3489 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3490 PERROR("Socket %d error", conn
->sock
->fd
);
3491 status
= RELAY_CONNECTION_STATUS_ERROR
;
3493 goto end_stream_unlock
;
3494 } else if (ret
== 0) {
3495 /* No more data ready to be consumed on socket. */
3496 DBG3("No more data ready for consumption on data socket of stream id %" PRIu64
,
3497 state
->header
.stream_id
);
3498 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3500 } else if (ret
< (int) recv_size
) {
3502 * All the data available on the socket has been
3505 partial_recv
= true;
3510 /* Write data to stream output fd. */
3511 write_ret
= lttng_write(stream
->stream_fd
->fd
, data_buffer
,
3513 if (write_ret
< (ssize_t
) recv_size
) {
3514 ERR("Relay error writing data to file");
3515 status
= RELAY_CONNECTION_STATUS_ERROR
;
3516 goto end_stream_unlock
;
3519 left_to_receive
-= recv_size
;
3520 state
->received
+= recv_size
;
3521 state
->left_to_receive
= left_to_receive
;
3523 DBG2("Relay wrote %zd bytes to tracefile for stream id %" PRIu64
,
3524 write_ret
, stream
->stream_handle
);
3527 if (state
->left_to_receive
> 0) {
3529 * Did not receive all the data expected, wait for more data to
3530 * become available on the socket.
3532 DBG3("Partial receive on data connection of stream id %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3533 state
->header
.stream_id
, state
->received
,
3534 state
->left_to_receive
);
3535 goto end_stream_unlock
;
3538 ret
= write_padding_to_file(stream
->stream_fd
->fd
,
3539 state
->header
.padding_size
);
3540 if ((int64_t) ret
< (int64_t) state
->header
.padding_size
) {
3541 ERR("write_padding_to_file: fail stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3542 stream
->stream_handle
,
3543 state
->header
.net_seq_num
, ret
);
3544 status
= RELAY_CONNECTION_STATUS_ERROR
;
3545 goto end_stream_unlock
;
3549 if (session_streams_have_index(session
)) {
3550 ret
= handle_index_data(stream
, state
->header
.net_seq_num
,
3551 state
->rotate_index
, &index_flushed
, state
->header
.data_size
+ state
->header
.padding_size
);
3553 ERR("handle_index_data: fail stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3554 stream
->stream_handle
,
3555 state
->header
.net_seq_num
, ret
);
3556 status
= RELAY_CONNECTION_STATUS_ERROR
;
3557 goto end_stream_unlock
;
3561 stream
->tracefile_size_current
+= state
->header
.data_size
+
3562 state
->header
.padding_size
;
3564 if (stream
->prev_data_seq
== -1ULL) {
3567 if (index_flushed
) {
3568 stream
->pos_after_last_complete_data_index
=
3569 stream
->tracefile_size_current
;
3570 stream
->prev_index_seq
= state
->header
.net_seq_num
;
3573 stream
->prev_data_seq
= state
->header
.net_seq_num
;
3576 * Resetting the protocol state (to RECEIVE_HEADER) will trash the
3577 * contents of *state which are aliased (union) to the same location as
3578 * the new state. Don't use it beyond this point.
3580 connection_reset_protocol_state(conn
);
3583 ret
= try_rotate_stream(stream
);
3585 status
= RELAY_CONNECTION_STATUS_ERROR
;
3586 goto end_stream_unlock
;
3590 close_requested
= stream
->close_requested
;
3591 pthread_mutex_unlock(&stream
->lock
);
3592 if (close_requested
&& left_to_receive
== 0) {
3593 try_stream_close(stream
);
3597 pthread_mutex_lock(&session
->lock
);
3598 uatomic_set(&session
->new_streams
, 1);
3599 pthread_mutex_unlock(&session
->lock
);
3608 * relay_process_data: Process the data received on the data socket
3610 static enum relay_connection_status
relay_process_data(
3611 struct relay_connection
*conn
)
3613 enum relay_connection_status status
;
3615 switch (conn
->protocol
.data
.state_id
) {
3616 case DATA_CONNECTION_STATE_RECEIVE_HEADER
:
3617 status
= relay_process_data_receive_header(conn
);
3619 case DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3620 status
= relay_process_data_receive_payload(conn
);
3623 ERR("Unexpected data connection communication state.");
3630 static void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
3634 (void) lttng_poll_del(events
, pollfd
);
3636 ret
= close(pollfd
);
3638 ERR("Closing pollfd %d", pollfd
);
3642 static void relay_thread_close_connection(struct lttng_poll_event
*events
,
3643 int pollfd
, struct relay_connection
*conn
)
3645 const char *type_str
;
3647 switch (conn
->type
) {
3652 type_str
= "Control";
3654 case RELAY_VIEWER_COMMAND
:
3655 type_str
= "Viewer Command";
3657 case RELAY_VIEWER_NOTIFICATION
:
3658 type_str
= "Viewer Notification";
3661 type_str
= "Unknown";
3663 cleanup_connection_pollfd(events
, pollfd
);
3664 connection_put(conn
);
3665 DBG("%s connection closed with %d", type_str
, pollfd
);
3669 * This thread does the actual work
3671 static void *relay_thread_worker(void *data
)
3673 int ret
, err
= -1, last_seen_data_fd
= -1;
3675 struct lttng_poll_event events
;
3676 struct lttng_ht
*relay_connections_ht
;
3677 struct lttng_ht_iter iter
;
3678 struct relay_connection
*destroy_conn
= NULL
;
3680 DBG("[thread] Relay worker started");
3682 rcu_register_thread();
3684 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
3686 if (testpoint(relayd_thread_worker
)) {
3687 goto error_testpoint
;
3690 health_code_update();
3692 /* table of connections indexed on socket */
3693 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3694 if (!relay_connections_ht
) {
3695 goto relay_connections_ht_error
;
3698 ret
= create_thread_poll_set(&events
, 2);
3700 goto error_poll_create
;
3703 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
3710 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
3712 health_code_update();
3714 /* Infinite blocking call, waiting for transmission */
3715 DBG3("Relayd worker thread polling...");
3716 health_poll_entry();
3717 ret
= lttng_poll_wait(&events
, -1);
3721 * Restart interrupted system call.
3723 if (errno
== EINTR
) {
3732 * Process control. The control connection is
3733 * prioritized so we don't starve it with high
3734 * throughput tracing data on the data connection.
3736 for (i
= 0; i
< nb_fd
; i
++) {
3737 /* Fetch once the poll data */
3738 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3739 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3741 health_code_update();
3745 * No activity for this FD (poll
3751 /* Thread quit pipe has been closed. Killing thread. */
3752 ret
= check_thread_quit_pipe(pollfd
, revents
);
3758 /* Inspect the relay conn pipe for new connection */
3759 if (pollfd
== relay_conn_pipe
[0]) {
3760 if (revents
& LPOLLIN
) {
3761 struct relay_connection
*conn
;
3763 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
3767 lttng_poll_add(&events
, conn
->sock
->fd
,
3768 LPOLLIN
| LPOLLRDHUP
);
3769 connection_ht_add(relay_connections_ht
, conn
);
3770 DBG("Connection socket %d added", conn
->sock
->fd
);
3771 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3772 ERR("Relay connection pipe error");
3775 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3779 struct relay_connection
*ctrl_conn
;
3781 ctrl_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3782 /* If not found, there is a synchronization issue. */
3785 if (ctrl_conn
->type
== RELAY_DATA
) {
3786 if (revents
& LPOLLIN
) {
3788 * Flag the last seen data fd not deleted. It will be
3789 * used as the last seen fd if any fd gets deleted in
3792 last_notdel_data_fd
= pollfd
;
3794 goto put_ctrl_connection
;
3796 assert(ctrl_conn
->type
== RELAY_CONTROL
);
3798 if (revents
& LPOLLIN
) {
3799 enum relay_connection_status status
;
3801 status
= relay_process_control(ctrl_conn
);
3802 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
3804 * On socket error flag the session as aborted to force
3805 * the cleanup of its stream otherwise it can leak
3806 * during the lifetime of the relayd.
3808 * This prevents situations in which streams can be
3809 * left opened because an index was received, the
3810 * control connection is closed, and the data
3811 * connection is closed (uncleanly) before the packet's
3814 * Since the control connection encountered an error,
3815 * it is okay to be conservative and close the
3816 * session right now as we can't rely on the protocol
3817 * being respected anymore.
3819 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
3820 session_abort(ctrl_conn
->session
);
3823 /* Clear the connection on error or close. */
3824 relay_thread_close_connection(&events
,
3829 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3830 relay_thread_close_connection(&events
,
3832 if (last_seen_data_fd
== pollfd
) {
3833 last_seen_data_fd
= last_notdel_data_fd
;
3836 ERR("Unexpected poll events %u for control sock %d",
3838 connection_put(ctrl_conn
);
3841 put_ctrl_connection
:
3842 connection_put(ctrl_conn
);
3847 * The last loop handled a control request, go back to poll to make
3848 * sure we prioritise the control socket.
3854 if (last_seen_data_fd
>= 0) {
3855 for (i
= 0; i
< nb_fd
; i
++) {
3856 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3858 health_code_update();
3860 if (last_seen_data_fd
== pollfd
) {
3867 /* Process data connection. */
3868 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
3869 /* Fetch the poll data. */
3870 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3871 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3872 struct relay_connection
*data_conn
;
3874 health_code_update();
3877 /* No activity for this FD (poll implementation). */
3881 /* Skip the command pipe. It's handled in the first loop. */
3882 if (pollfd
== relay_conn_pipe
[0]) {
3886 data_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3888 /* Skip it. Might be removed before. */
3891 if (data_conn
->type
== RELAY_CONTROL
) {
3892 goto put_data_connection
;
3894 assert(data_conn
->type
== RELAY_DATA
);
3896 if (revents
& LPOLLIN
) {
3897 enum relay_connection_status status
;
3899 status
= relay_process_data(data_conn
);
3900 /* Connection closed or error. */
3901 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
3903 * On socket error flag the session as aborted to force
3904 * the cleanup of its stream otherwise it can leak
3905 * during the lifetime of the relayd.
3907 * This prevents situations in which streams can be
3908 * left opened because an index was received, the
3909 * control connection is closed, and the data
3910 * connection is closed (uncleanly) before the packet's
3913 * Since the data connection encountered an error,
3914 * it is okay to be conservative and close the
3915 * session right now as we can't rely on the protocol
3916 * being respected anymore.
3918 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
3919 session_abort(data_conn
->session
);
3921 relay_thread_close_connection(&events
, pollfd
,
3924 * Every goto restart call sets the last seen fd where
3925 * here we don't really care since we gracefully
3926 * continue the loop after the connection is deleted.
3929 /* Keep last seen port. */
3930 last_seen_data_fd
= pollfd
;
3931 connection_put(data_conn
);
3934 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3935 relay_thread_close_connection(&events
, pollfd
,
3938 ERR("Unknown poll events %u for data sock %d",
3941 put_data_connection
:
3942 connection_put(data_conn
);
3944 last_seen_data_fd
= -1;
3947 /* Normal exit, no error */
3952 /* Cleanup remaining connection object. */
3954 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
,
3957 health_code_update();
3959 session_abort(destroy_conn
->session
);
3962 * No need to grab another ref, because we own
3965 relay_thread_close_connection(&events
, destroy_conn
->sock
->fd
,
3970 lttng_poll_clean(&events
);
3972 lttng_ht_destroy(relay_connections_ht
);
3973 relay_connections_ht_error
:
3974 /* Close relay conn pipes */
3975 utils_close_pipe(relay_conn_pipe
);
3977 DBG("Thread exited with error");
3979 DBG("Worker thread cleanup complete");
3983 ERR("Health error occurred in %s", __func__
);
3985 health_unregister(health_relayd
);
3986 rcu_unregister_thread();
3987 lttng_relay_stop_threads();
3992 * Create the relay command pipe to wake thread_manage_apps.
3993 * Closed in cleanup().
3995 static int create_relay_conn_pipe(void)
3999 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
4007 int main(int argc
, char **argv
)
4009 int ret
= 0, retval
= 0;
4012 /* Parse arguments */
4014 if (set_options(argc
, argv
)) {
4019 if (set_signal_handler()) {
4024 /* Try to create directory if -o, --output is specified. */
4025 if (opt_output_path
) {
4026 if (*opt_output_path
!= '/') {
4027 ERR("Please specify an absolute path for -o, --output PATH");
4032 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
,
4035 ERR("Unable to create %s", opt_output_path
);
4042 if (opt_daemon
|| opt_background
) {
4045 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
4053 * We are in the child. Make sure all other file
4054 * descriptors are closed, in case we are called with
4055 * more opened file descriptors than the standard ones.
4057 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
4062 /* Initialize thread health monitoring */
4063 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
4064 if (!health_relayd
) {
4065 PERROR("health_app_create error");
4067 goto exit_health_app_create
;
4070 /* Create thread quit pipe */
4071 if (init_thread_quit_pipe()) {
4073 goto exit_init_data
;
4076 /* Setup the thread apps communication pipe. */
4077 if (create_relay_conn_pipe()) {
4079 goto exit_init_data
;
4082 /* Init relay command queue. */
4083 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
4085 /* Initialize communication library */
4087 lttcomm_inet_init();
4089 /* tables of sessions indexed by session ID */
4090 sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4093 goto exit_init_data
;
4096 /* tables of streams indexed by stream ID */
4097 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4098 if (!relay_streams_ht
) {
4100 goto exit_init_data
;
4103 /* tables of streams indexed by stream ID */
4104 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4105 if (!viewer_streams_ht
) {
4107 goto exit_init_data
;
4110 ret
= utils_create_pipe(health_quit_pipe
);
4113 goto exit_health_quit_pipe
;
4116 /* Create thread to manage the client socket */
4117 ret
= pthread_create(&health_thread
, default_pthread_attr(),
4118 thread_manage_health
, (void *) NULL
);
4121 PERROR("pthread_create health");
4123 goto exit_health_thread
;
4126 /* Setup the dispatcher thread */
4127 ret
= pthread_create(&dispatcher_thread
, default_pthread_attr(),
4128 relay_thread_dispatcher
, (void *) NULL
);
4131 PERROR("pthread_create dispatcher");
4133 goto exit_dispatcher_thread
;
4136 /* Setup the worker thread */
4137 ret
= pthread_create(&worker_thread
, default_pthread_attr(),
4138 relay_thread_worker
, NULL
);
4141 PERROR("pthread_create worker");
4143 goto exit_worker_thread
;
4146 /* Setup the listener thread */
4147 ret
= pthread_create(&listener_thread
, default_pthread_attr(),
4148 relay_thread_listener
, (void *) NULL
);
4151 PERROR("pthread_create listener");
4153 goto exit_listener_thread
;
4156 ret
= relayd_live_create(live_uri
);
4158 ERR("Starting live viewer threads");
4164 * This is where we start awaiting program completion (e.g. through
4165 * signal that asks threads to teardown).
4168 ret
= relayd_live_join();
4174 ret
= pthread_join(listener_thread
, &status
);
4177 PERROR("pthread_join listener_thread");
4181 exit_listener_thread
:
4182 ret
= pthread_join(worker_thread
, &status
);
4185 PERROR("pthread_join worker_thread");
4190 ret
= pthread_join(dispatcher_thread
, &status
);
4193 PERROR("pthread_join dispatcher_thread");
4196 exit_dispatcher_thread
:
4198 ret
= pthread_join(health_thread
, &status
);
4201 PERROR("pthread_join health_thread");
4206 utils_close_pipe(health_quit_pipe
);
4207 exit_health_quit_pipe
:
4210 health_app_destroy(health_relayd
);
4211 exit_health_app_create
:
4214 * Wait for all pending call_rcu work to complete before tearing
4215 * down data structures. call_rcu worker may be trying to
4216 * perform lookups in those structures.
4221 /* Ensure all prior call_rcu are done. */