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
);
1087 * Handle the RELAYD_CREATE_SESSION command.
1089 * On success, send back the session id or else return a negative value.
1091 static int relay_create_session(const struct lttcomm_relayd_hdr
*recv_hdr
,
1092 struct relay_connection
*conn
,
1093 const struct lttng_buffer_view
*payload
)
1097 struct relay_session
*session
;
1098 struct lttcomm_relayd_status_session reply
;
1099 char session_name
[LTTNG_NAME_MAX
];
1100 char hostname
[LTTNG_HOST_NAME_MAX
];
1101 uint32_t live_timer
= 0;
1102 bool snapshot
= false;
1104 memset(session_name
, 0, LTTNG_NAME_MAX
);
1105 memset(hostname
, 0, LTTNG_HOST_NAME_MAX
);
1107 memset(&reply
, 0, sizeof(reply
));
1109 if (conn
->minor
< 4) {
1110 /* From 2.1 to 2.3 */
1112 } else if (conn
->minor
>= 4 && conn
->minor
< 11) {
1113 /* From 2.4 to 2.10 */
1114 ret
= cmd_create_session_2_4(payload
, session_name
,
1115 hostname
, &live_timer
, &snapshot
);
1117 /* From 2.11 to ... */
1118 ret
= cmd_create_session_2_11(payload
, session_name
,
1119 hostname
, &live_timer
, &snapshot
);
1126 session
= session_create(session_name
, hostname
, live_timer
,
1127 snapshot
, conn
->major
, conn
->minor
);
1132 assert(!conn
->session
);
1133 conn
->session
= session
;
1134 DBG("Created session %" PRIu64
, session
->id
);
1136 reply
.session_id
= htobe64(session
->id
);
1140 reply
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1142 reply
.ret_code
= htobe32(LTTNG_OK
);
1145 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1146 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1147 ERR("Failed to send \"create session\" command reply (ret = %zd)",
1156 * When we have received all the streams and the metadata for a channel,
1157 * we make them visible to the viewer threads.
1159 static void publish_connection_local_streams(struct relay_connection
*conn
)
1161 struct relay_stream
*stream
;
1162 struct relay_session
*session
= conn
->session
;
1165 * We publish all streams belonging to a session atomically wrt
1168 pthread_mutex_lock(&session
->lock
);
1170 cds_list_for_each_entry_rcu(stream
, &session
->recv_list
,
1172 stream_publish(stream
);
1177 * Inform the viewer that there are new streams in the session.
1179 if (session
->viewer_attached
) {
1180 uatomic_set(&session
->new_streams
, 1);
1182 pthread_mutex_unlock(&session
->lock
);
1186 * relay_add_stream: allocate a new stream for a session
1188 static int relay_add_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1189 struct relay_connection
*conn
,
1190 const struct lttng_buffer_view
*payload
)
1194 struct relay_session
*session
= conn
->session
;
1195 struct relay_stream
*stream
= NULL
;
1196 struct lttcomm_relayd_status_stream reply
;
1197 struct ctf_trace
*trace
= NULL
;
1198 uint64_t stream_handle
= -1ULL;
1199 char *path_name
= NULL
, *channel_name
= NULL
;
1200 uint64_t tracefile_size
= 0, tracefile_count
= 0;
1202 if (!session
|| !conn
->version_check_done
) {
1203 ERR("Trying to add a stream before version check");
1205 goto end_no_session
;
1208 if (session
->minor
== 1) {
1210 ret
= cmd_recv_stream_2_1(payload
, &path_name
,
1212 } else if (session
->minor
> 1 && session
->minor
< 11) {
1213 /* From 2.2 to 2.10 */
1214 ret
= cmd_recv_stream_2_2(payload
, &path_name
,
1215 &channel_name
, &tracefile_size
, &tracefile_count
);
1217 /* From 2.11 to ... */
1218 ret
= cmd_recv_stream_2_11(payload
, &path_name
,
1219 &channel_name
, &tracefile_size
, &tracefile_count
);
1226 trace
= ctf_trace_get_by_path_or_create(session
, path_name
);
1230 /* This stream here has one reference on the trace. */
1232 pthread_mutex_lock(&last_relay_stream_id_lock
);
1233 stream_handle
= ++last_relay_stream_id
;
1234 pthread_mutex_unlock(&last_relay_stream_id_lock
);
1236 /* We pass ownership of path_name and channel_name. */
1237 stream
= stream_create(trace
, stream_handle
, path_name
,
1238 channel_name
, tracefile_size
, tracefile_count
);
1240 channel_name
= NULL
;
1243 * Streams are the owners of their trace. Reference to trace is
1244 * kept within stream_create().
1246 ctf_trace_put(trace
);
1249 memset(&reply
, 0, sizeof(reply
));
1250 reply
.handle
= htobe64(stream_handle
);
1252 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1254 reply
.ret_code
= htobe32(LTTNG_OK
);
1257 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1258 sizeof(struct lttcomm_relayd_status_stream
), 0);
1259 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1260 ERR("Failed to send \"add stream\" command reply (ret = %zd)",
1272 * relay_close_stream: close a specific stream
1274 static int relay_close_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1275 struct relay_connection
*conn
,
1276 const struct lttng_buffer_view
*payload
)
1280 struct relay_session
*session
= conn
->session
;
1281 struct lttcomm_relayd_close_stream stream_info
;
1282 struct lttcomm_relayd_generic_reply reply
;
1283 struct relay_stream
*stream
;
1285 DBG("Close stream received");
1287 if (!session
|| !conn
->version_check_done
) {
1288 ERR("Trying to close a stream before version check");
1290 goto end_no_session
;
1293 if (payload
->size
< sizeof(stream_info
)) {
1294 ERR("Unexpected payload size in \"relay_close_stream\": expected >= %zu bytes, got %zu bytes",
1295 sizeof(stream_info
), payload
->size
);
1297 goto end_no_session
;
1299 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1300 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1301 stream_info
.last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1303 stream
= stream_get_by_id(stream_info
.stream_id
);
1310 * Set last_net_seq_num before the close flag. Required by data
1313 pthread_mutex_lock(&stream
->lock
);
1314 stream
->last_net_seq_num
= stream_info
.last_net_seq_num
;
1315 pthread_mutex_unlock(&stream
->lock
);
1318 * This is one of the conditions which may trigger a stream close
1319 * with the others being:
1320 * 1) A close command is received for a stream
1321 * 2) The control connection owning the stream is closed
1322 * 3) We have received all of the stream's data _after_ a close
1325 try_stream_close(stream
);
1326 if (stream
->is_metadata
) {
1327 struct relay_viewer_stream
*vstream
;
1329 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
1331 if (vstream
->metadata_sent
== stream
->metadata_received
) {
1333 * Since all the metadata has been sent to the
1334 * viewer and that we have a request to close
1335 * its stream, we can safely teardown the
1336 * corresponding metadata viewer stream.
1338 viewer_stream_put(vstream
);
1340 /* Put local reference. */
1341 viewer_stream_put(vstream
);
1348 memset(&reply
, 0, sizeof(reply
));
1350 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1352 reply
.ret_code
= htobe32(LTTNG_OK
);
1354 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1355 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1356 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1357 ERR("Failed to send \"close stream\" command reply (ret = %zd)",
1367 * relay_reset_metadata: reset a metadata stream
1370 int relay_reset_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1371 struct relay_connection
*conn
,
1372 const struct lttng_buffer_view
*payload
)
1376 struct relay_session
*session
= conn
->session
;
1377 struct lttcomm_relayd_reset_metadata stream_info
;
1378 struct lttcomm_relayd_generic_reply reply
;
1379 struct relay_stream
*stream
;
1381 DBG("Reset metadata received");
1383 if (!session
|| !conn
->version_check_done
) {
1384 ERR("Trying to reset a metadata stream before version check");
1386 goto end_no_session
;
1389 if (payload
->size
< sizeof(stream_info
)) {
1390 ERR("Unexpected payload size in \"relay_reset_metadata\": expected >= %zu bytes, got %zu bytes",
1391 sizeof(stream_info
), payload
->size
);
1393 goto end_no_session
;
1395 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1396 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1397 stream_info
.version
= be64toh(stream_info
.version
);
1399 DBG("Update metadata to version %" PRIu64
, stream_info
.version
);
1401 /* Unsupported for live sessions for now. */
1402 if (session
->live_timer
!= 0) {
1407 stream
= stream_get_by_id(stream_info
.stream_id
);
1412 pthread_mutex_lock(&stream
->lock
);
1413 if (!stream
->is_metadata
) {
1418 ret
= utils_rotate_stream_file(stream
->path_name
, stream
->channel_name
,
1419 0, 0, -1, -1, stream
->stream_fd
->fd
, NULL
,
1420 &stream
->stream_fd
->fd
);
1422 ERR("Failed to rotate metadata file %s of channel %s",
1423 stream
->path_name
, stream
->channel_name
);
1428 pthread_mutex_unlock(&stream
->lock
);
1432 memset(&reply
, 0, sizeof(reply
));
1434 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1436 reply
.ret_code
= htobe32(LTTNG_OK
);
1438 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1439 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1440 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1441 ERR("Failed to send \"reset metadata\" command reply (ret = %zd)",
1451 * relay_unknown_command: send -1 if received unknown command
1453 static void relay_unknown_command(struct relay_connection
*conn
)
1455 struct lttcomm_relayd_generic_reply reply
;
1458 memset(&reply
, 0, sizeof(reply
));
1459 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1460 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1461 if (send_ret
< sizeof(reply
)) {
1462 ERR("Failed to send \"unknown command\" command reply (ret = %zd)", send_ret
);
1467 * relay_start: send an acknowledgment to the client to tell if we are
1468 * ready to receive data. We are ready if a session is established.
1470 static int relay_start(const struct lttcomm_relayd_hdr
*recv_hdr
,
1471 struct relay_connection
*conn
,
1472 const struct lttng_buffer_view
*payload
)
1476 struct lttcomm_relayd_generic_reply reply
;
1477 struct relay_session
*session
= conn
->session
;
1480 DBG("Trying to start the streaming without a session established");
1481 ret
= htobe32(LTTNG_ERR_UNK
);
1484 memset(&reply
, 0, sizeof(reply
));
1485 reply
.ret_code
= htobe32(LTTNG_OK
);
1486 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1488 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1489 ERR("Failed to send \"relay_start\" command reply (ret = %zd)",
1498 * Append padding to the file pointed by the file descriptor fd.
1500 static int write_padding_to_file(int fd
, uint32_t size
)
1509 zeros
= zmalloc(size
);
1510 if (zeros
== NULL
) {
1511 PERROR("zmalloc zeros for padding");
1516 ret
= lttng_write(fd
, zeros
, size
);
1518 PERROR("write padding to file");
1528 * Close the current index file if it is open, and create a new one.
1530 * Return 0 on success, -1 on error.
1533 int create_rotate_index_file(struct relay_stream
*stream
)
1536 uint32_t major
, minor
;
1538 /* Put ref on previous index_file. */
1539 if (stream
->index_file
) {
1540 lttng_index_file_put(stream
->index_file
);
1541 stream
->index_file
= NULL
;
1543 major
= stream
->trace
->session
->major
;
1544 minor
= stream
->trace
->session
->minor
;
1545 stream
->index_file
= lttng_index_file_create(stream
->path_name
,
1546 stream
->channel_name
,
1547 -1, -1, stream
->tracefile_size
,
1548 tracefile_array_get_file_index_head(stream
->tfa
),
1549 lttng_to_index_major(major
, minor
),
1550 lttng_to_index_minor(major
, minor
));
1551 if (!stream
->index_file
) {
1563 int do_rotate_stream(struct relay_stream
*stream
)
1567 /* Perform the stream rotation. */
1568 ret
= utils_rotate_stream_file(stream
->path_name
,
1569 stream
->channel_name
, stream
->tracefile_size
,
1570 stream
->tracefile_count
, -1,
1571 -1, stream
->stream_fd
->fd
,
1572 NULL
, &stream
->stream_fd
->fd
);
1574 ERR("Rotating stream output file");
1577 stream
->tracefile_size_current
= 0;
1579 /* Rotate also the index if the stream is not a metadata stream. */
1580 if (!stream
->is_metadata
) {
1581 ret
= create_rotate_index_file(stream
);
1583 ERR("Failed to rotate index file");
1588 stream
->rotate_at_seq_num
= -1ULL;
1589 stream
->pos_after_last_complete_data_index
= 0;
1596 * If too much data has been written in a tracefile before we received the
1597 * rotation command, we have to move the excess data to the new tracefile and
1598 * perform the rotation. This can happen because the control and data
1599 * connections are separate, the indexes as well as the commands arrive from
1600 * the control connection and we have no control over the order so we could be
1601 * in a situation where too much data has been received on the data connection
1602 * before the rotation command on the control connection arrives. We don't need
1603 * to update the index because its order is guaranteed with the rotation
1607 int rotate_truncate_stream(struct relay_stream
*stream
)
1611 uint64_t diff
, pos
= 0;
1612 char buf
[FILE_COPY_BUFFER_SIZE
];
1614 assert(!stream
->is_metadata
);
1616 assert(stream
->tracefile_size_current
>
1617 stream
->pos_after_last_complete_data_index
);
1618 diff
= stream
->tracefile_size_current
-
1619 stream
->pos_after_last_complete_data_index
;
1621 /* Create the new tracefile. */
1622 new_fd
= utils_create_stream_file(stream
->path_name
,
1623 stream
->channel_name
,
1624 stream
->tracefile_size
, stream
->tracefile_count
,
1625 /* uid */ -1, /* gid */ -1, /* suffix */ NULL
);
1627 ERR("Failed to create new stream file at path %s for channel %s",
1628 stream
->path_name
, stream
->channel_name
);
1634 * Rewind the current tracefile to the position at which the rotation
1635 * should have occured.
1637 lseek_ret
= lseek(stream
->stream_fd
->fd
,
1638 stream
->pos_after_last_complete_data_index
, SEEK_SET
);
1639 if (lseek_ret
< 0) {
1640 PERROR("seek truncate stream");
1645 /* Move data from the old file to the new file. */
1646 while (pos
< diff
) {
1647 uint64_t count
, bytes_left
;
1650 bytes_left
= diff
- pos
;
1651 count
= bytes_left
> sizeof(buf
) ? sizeof(buf
) : bytes_left
;
1652 assert(count
<= SIZE_MAX
);
1654 io_ret
= lttng_read(stream
->stream_fd
->fd
, buf
, count
);
1655 if (io_ret
< (ssize_t
) count
) {
1656 char error_string
[256];
1658 snprintf(error_string
, sizeof(error_string
),
1659 "Failed to read %" PRIu64
" bytes from fd %i in rotate_truncate_stream(), returned %zi",
1660 count
, stream
->stream_fd
->fd
, io_ret
);
1662 PERROR("%s", error_string
);
1664 ERR("%s", error_string
);
1670 io_ret
= lttng_write(new_fd
, buf
, count
);
1671 if (io_ret
< (ssize_t
) count
) {
1672 char error_string
[256];
1674 snprintf(error_string
, sizeof(error_string
),
1675 "Failed to write %" PRIu64
" bytes from fd %i in rotate_truncate_stream(), returned %zi",
1676 count
, new_fd
, io_ret
);
1678 PERROR("%s", error_string
);
1680 ERR("%s", error_string
);
1689 /* Truncate the file to get rid of the excess data. */
1690 ret
= ftruncate(stream
->stream_fd
->fd
,
1691 stream
->pos_after_last_complete_data_index
);
1693 PERROR("ftruncate");
1697 ret
= close(stream
->stream_fd
->fd
);
1699 PERROR("Closing tracefile");
1703 ret
= create_rotate_index_file(stream
);
1705 ERR("Rotate stream index file");
1710 * Update the offset and FD of all the eventual indexes created by the
1711 * data connection before the rotation command arrived.
1713 ret
= relay_index_switch_all_files(stream
);
1715 ERR("Failed to rotate index file");
1719 stream
->stream_fd
->fd
= new_fd
;
1720 stream
->tracefile_size_current
= diff
;
1721 stream
->pos_after_last_complete_data_index
= 0;
1722 stream
->rotate_at_seq_num
= -1ULL;
1731 * Check if a stream should perform a rotation (for session rotation).
1732 * Must be called with the stream lock held.
1734 * Return 0 on success, a negative value on error.
1737 int try_rotate_stream(struct relay_stream
*stream
)
1741 /* No rotation expected. */
1742 if (stream
->rotate_at_seq_num
== -1ULL) {
1746 if (stream
->prev_seq
< stream
->rotate_at_seq_num
||
1747 stream
->prev_seq
== -1ULL) {
1748 DBG("Stream %" PRIu64
" no yet ready for rotation",
1749 stream
->stream_handle
);
1751 } else if (stream
->prev_seq
> stream
->rotate_at_seq_num
) {
1752 DBG("Rotation after too much data has been written in tracefile "
1753 "for stream %" PRIu64
", need to truncate before "
1754 "rotating", stream
->stream_handle
);
1755 ret
= rotate_truncate_stream(stream
);
1757 ERR("Failed to truncate stream");
1761 /* stream->prev_seq == stream->rotate_at_seq_num */
1762 DBG("Stream %" PRIu64
" ready for rotation",
1763 stream
->stream_handle
);
1764 ret
= do_rotate_stream(stream
);
1772 * relay_recv_metadata: receive the metadata for the session.
1774 static int relay_recv_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1775 struct relay_connection
*conn
,
1776 const struct lttng_buffer_view
*payload
)
1780 struct relay_session
*session
= conn
->session
;
1781 struct lttcomm_relayd_metadata_payload metadata_payload_header
;
1782 struct relay_stream
*metadata_stream
;
1783 uint64_t metadata_payload_size
;
1786 ERR("Metadata sent before version check");
1791 if (recv_hdr
->data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1792 ERR("Incorrect data size");
1796 metadata_payload_size
= recv_hdr
->data_size
-
1797 sizeof(struct lttcomm_relayd_metadata_payload
);
1799 memcpy(&metadata_payload_header
, payload
->data
,
1800 sizeof(metadata_payload_header
));
1801 metadata_payload_header
.stream_id
= be64toh(
1802 metadata_payload_header
.stream_id
);
1803 metadata_payload_header
.padding_size
= be32toh(
1804 metadata_payload_header
.padding_size
);
1806 metadata_stream
= stream_get_by_id(metadata_payload_header
.stream_id
);
1807 if (!metadata_stream
) {
1812 pthread_mutex_lock(&metadata_stream
->lock
);
1814 size_ret
= lttng_write(metadata_stream
->stream_fd
->fd
,
1815 payload
->data
+ sizeof(metadata_payload_header
),
1816 metadata_payload_size
);
1817 if (size_ret
< metadata_payload_size
) {
1818 ERR("Relay error writing metadata on file");
1823 size_ret
= write_padding_to_file(metadata_stream
->stream_fd
->fd
,
1824 metadata_payload_header
.padding_size
);
1825 if (size_ret
< (int64_t) metadata_payload_header
.padding_size
) {
1830 metadata_stream
->metadata_received
+=
1831 metadata_payload_size
+ metadata_payload_header
.padding_size
;
1832 DBG2("Relay metadata written. Updated metadata_received %" PRIu64
,
1833 metadata_stream
->metadata_received
);
1835 ret
= try_rotate_stream(metadata_stream
);
1841 pthread_mutex_unlock(&metadata_stream
->lock
);
1842 stream_put(metadata_stream
);
1848 * relay_send_version: send relayd version number
1850 static int relay_send_version(const struct lttcomm_relayd_hdr
*recv_hdr
,
1851 struct relay_connection
*conn
,
1852 const struct lttng_buffer_view
*payload
)
1856 struct lttcomm_relayd_version reply
, msg
;
1857 bool compatible
= true;
1859 conn
->version_check_done
= true;
1861 /* Get version from the other side. */
1862 if (payload
->size
< sizeof(msg
)) {
1863 ERR("Unexpected payload size in \"relay_send_version\": expected >= %zu bytes, got %zu bytes",
1864 sizeof(msg
), payload
->size
);
1869 memcpy(&msg
, payload
->data
, sizeof(msg
));
1870 msg
.major
= be32toh(msg
.major
);
1871 msg
.minor
= be32toh(msg
.minor
);
1873 memset(&reply
, 0, sizeof(reply
));
1874 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
1875 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
1877 /* Major versions must be the same */
1878 if (reply
.major
!= msg
.major
) {
1879 DBG("Incompatible major versions (%u vs %u), deleting session",
1880 reply
.major
, msg
.major
);
1884 conn
->major
= reply
.major
;
1885 /* We adapt to the lowest compatible version */
1886 if (reply
.minor
<= msg
.minor
) {
1887 conn
->minor
= reply
.minor
;
1889 conn
->minor
= msg
.minor
;
1892 reply
.major
= htobe32(reply
.major
);
1893 reply
.minor
= htobe32(reply
.minor
);
1894 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1896 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1897 ERR("Failed to send \"send version\" command reply (ret = %zd)",
1910 DBG("Version check done using protocol %u.%u", conn
->major
,
1918 * Check for data pending for a given stream id from the session daemon.
1920 static int relay_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
1921 struct relay_connection
*conn
,
1922 const struct lttng_buffer_view
*payload
)
1924 struct relay_session
*session
= conn
->session
;
1925 struct lttcomm_relayd_data_pending msg
;
1926 struct lttcomm_relayd_generic_reply reply
;
1927 struct relay_stream
*stream
;
1931 DBG("Data pending command received");
1933 if (!session
|| !conn
->version_check_done
) {
1934 ERR("Trying to check for data before version check");
1936 goto end_no_session
;
1939 if (payload
->size
< sizeof(msg
)) {
1940 ERR("Unexpected payload size in \"relay_data_pending\": expected >= %zu bytes, got %zu bytes",
1941 sizeof(msg
), payload
->size
);
1943 goto end_no_session
;
1945 memcpy(&msg
, payload
->data
, sizeof(msg
));
1946 msg
.stream_id
= be64toh(msg
.stream_id
);
1947 msg
.last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
1949 stream
= stream_get_by_id(msg
.stream_id
);
1950 if (stream
== NULL
) {
1955 pthread_mutex_lock(&stream
->lock
);
1957 DBG("Data pending for stream id %" PRIu64
" prev_seq %" PRIu64
1958 " and last_seq %" PRIu64
, msg
.stream_id
,
1959 stream
->prev_seq
, msg
.last_net_seq_num
);
1961 /* Avoid wrapping issue */
1962 if (((int64_t) (stream
->prev_seq
- msg
.last_net_seq_num
)) >= 0) {
1963 /* Data has in fact been written and is NOT pending */
1966 /* Data still being streamed thus pending */
1970 stream
->data_pending_check_done
= true;
1971 pthread_mutex_unlock(&stream
->lock
);
1976 memset(&reply
, 0, sizeof(reply
));
1977 reply
.ret_code
= htobe32(ret
);
1978 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1979 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1980 ERR("Failed to send \"data pending\" command reply (ret = %zd)",
1990 * Wait for the control socket to reach a quiescent state.
1992 * Note that for now, when receiving this command from the session
1993 * daemon, this means that every subsequent commands or data received on
1994 * the control socket has been handled. So, this is why we simply return
1997 static int relay_quiescent_control(const struct lttcomm_relayd_hdr
*recv_hdr
,
1998 struct relay_connection
*conn
,
1999 const struct lttng_buffer_view
*payload
)
2003 struct relay_stream
*stream
;
2004 struct lttcomm_relayd_quiescent_control msg
;
2005 struct lttcomm_relayd_generic_reply reply
;
2007 DBG("Checking quiescent state on control socket");
2009 if (!conn
->session
|| !conn
->version_check_done
) {
2010 ERR("Trying to check for data before version check");
2012 goto end_no_session
;
2015 if (payload
->size
< sizeof(msg
)) {
2016 ERR("Unexpected payload size in \"relay_quiescent_control\": expected >= %zu bytes, got %zu bytes",
2017 sizeof(msg
), payload
->size
);
2019 goto end_no_session
;
2021 memcpy(&msg
, payload
->data
, sizeof(msg
));
2022 msg
.stream_id
= be64toh(msg
.stream_id
);
2024 stream
= stream_get_by_id(msg
.stream_id
);
2028 pthread_mutex_lock(&stream
->lock
);
2029 stream
->data_pending_check_done
= true;
2030 pthread_mutex_unlock(&stream
->lock
);
2032 DBG("Relay quiescent control pending flag set to %" PRIu64
, msg
.stream_id
);
2035 memset(&reply
, 0, sizeof(reply
));
2036 reply
.ret_code
= htobe32(LTTNG_OK
);
2037 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2038 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2039 ERR("Failed to send \"quiescent control\" command reply (ret = %zd)",
2051 * Initialize a data pending command. This means that a consumer is about
2052 * to ask for data pending for each stream it holds. Simply iterate over
2053 * all streams of a session and set the data_pending_check_done flag.
2055 * This command returns to the client a LTTNG_OK code.
2057 static int relay_begin_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2058 struct relay_connection
*conn
,
2059 const struct lttng_buffer_view
*payload
)
2063 struct lttng_ht_iter iter
;
2064 struct lttcomm_relayd_begin_data_pending msg
;
2065 struct lttcomm_relayd_generic_reply reply
;
2066 struct relay_stream
*stream
;
2071 DBG("Init streams for data pending");
2073 if (!conn
->session
|| !conn
->version_check_done
) {
2074 ERR("Trying to check for data before version check");
2076 goto end_no_session
;
2079 if (payload
->size
< sizeof(msg
)) {
2080 ERR("Unexpected payload size in \"relay_begin_data_pending\": expected >= %zu bytes, got %zu bytes",
2081 sizeof(msg
), payload
->size
);
2083 goto end_no_session
;
2085 memcpy(&msg
, payload
->data
, sizeof(msg
));
2086 msg
.session_id
= be64toh(msg
.session_id
);
2089 * Iterate over all streams to set the begin data pending flag.
2090 * For now, the streams are indexed by stream handle so we have
2091 * to iterate over all streams to find the one associated with
2092 * the right session_id.
2095 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2097 if (!stream_get(stream
)) {
2100 if (stream
->trace
->session
->id
== msg
.session_id
) {
2101 pthread_mutex_lock(&stream
->lock
);
2102 stream
->data_pending_check_done
= false;
2103 pthread_mutex_unlock(&stream
->lock
);
2104 DBG("Set begin data pending flag to stream %" PRIu64
,
2105 stream
->stream_handle
);
2111 memset(&reply
, 0, sizeof(reply
));
2112 /* All good, send back reply. */
2113 reply
.ret_code
= htobe32(LTTNG_OK
);
2115 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2116 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2117 ERR("Failed to send \"begin data pending\" command reply (ret = %zd)",
2129 * End data pending command. This will check, for a given session id, if
2130 * each stream associated with it has its data_pending_check_done flag
2131 * set. If not, this means that the client lost track of the stream but
2132 * the data is still being streamed on our side. In this case, we inform
2133 * the client that data is in flight.
2135 * Return to the client if there is data in flight or not with a ret_code.
2137 static int relay_end_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2138 struct relay_connection
*conn
,
2139 const struct lttng_buffer_view
*payload
)
2143 struct lttng_ht_iter iter
;
2144 struct lttcomm_relayd_end_data_pending msg
;
2145 struct lttcomm_relayd_generic_reply reply
;
2146 struct relay_stream
*stream
;
2147 uint32_t is_data_inflight
= 0;
2149 DBG("End data pending command");
2151 if (!conn
->session
|| !conn
->version_check_done
) {
2152 ERR("Trying to check for data before version check");
2154 goto end_no_session
;
2157 if (payload
->size
< sizeof(msg
)) {
2158 ERR("Unexpected payload size in \"relay_end_data_pending\": expected >= %zu bytes, got %zu bytes",
2159 sizeof(msg
), payload
->size
);
2161 goto end_no_session
;
2163 memcpy(&msg
, payload
->data
, sizeof(msg
));
2164 msg
.session_id
= be64toh(msg
.session_id
);
2167 * Iterate over all streams to see if the begin data pending
2171 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2173 if (!stream_get(stream
)) {
2176 if (stream
->trace
->session
->id
!= msg
.session_id
) {
2180 pthread_mutex_lock(&stream
->lock
);
2181 if (!stream
->data_pending_check_done
) {
2182 if (!stream
->closed
|| !(((int64_t) (stream
->prev_seq
- stream
->last_net_seq_num
)) >= 0)) {
2183 is_data_inflight
= 1;
2184 DBG("Data is still in flight for stream %" PRIu64
,
2185 stream
->stream_handle
);
2186 pthread_mutex_unlock(&stream
->lock
);
2191 pthread_mutex_unlock(&stream
->lock
);
2196 memset(&reply
, 0, sizeof(reply
));
2197 /* All good, send back reply. */
2198 reply
.ret_code
= htobe32(is_data_inflight
);
2200 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2201 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2202 ERR("Failed to send \"end data pending\" command reply (ret = %zd)",
2214 * Receive an index for a specific stream.
2216 * Return 0 on success else a negative value.
2218 static int relay_recv_index(const struct lttcomm_relayd_hdr
*recv_hdr
,
2219 struct relay_connection
*conn
,
2220 const struct lttng_buffer_view
*payload
)
2224 struct relay_session
*session
= conn
->session
;
2225 struct lttcomm_relayd_index index_info
;
2226 struct relay_index
*index
;
2227 struct lttcomm_relayd_generic_reply reply
;
2228 struct relay_stream
*stream
;
2233 DBG("Relay receiving index");
2235 if (!session
|| !conn
->version_check_done
) {
2236 ERR("Trying to close a stream before version check");
2238 goto end_no_session
;
2241 msg_len
= lttcomm_relayd_index_len(
2242 lttng_to_index_major(conn
->major
, conn
->minor
),
2243 lttng_to_index_minor(conn
->major
, conn
->minor
));
2244 if (payload
->size
< msg_len
) {
2245 ERR("Unexpected payload size in \"relay_recv_index\": expected >= %zu bytes, got %zu bytes",
2246 msg_len
, payload
->size
);
2248 goto end_no_session
;
2250 memcpy(&index_info
, payload
->data
, msg_len
);
2251 index_info
.relay_stream_id
= be64toh(index_info
.relay_stream_id
);
2252 index_info
.net_seq_num
= be64toh(index_info
.net_seq_num
);
2253 index_info
.packet_size
= be64toh(index_info
.packet_size
);
2254 index_info
.content_size
= be64toh(index_info
.content_size
);
2255 index_info
.timestamp_begin
= be64toh(index_info
.timestamp_begin
);
2256 index_info
.timestamp_end
= be64toh(index_info
.timestamp_end
);
2257 index_info
.events_discarded
= be64toh(index_info
.events_discarded
);
2258 index_info
.stream_id
= be64toh(index_info
.stream_id
);
2260 if (conn
->minor
>= 8) {
2261 index_info
.stream_instance_id
=
2262 be64toh(index_info
.stream_instance_id
);
2263 index_info
.packet_seq_num
= be64toh(index_info
.packet_seq_num
);
2266 stream
= stream_get_by_id(index_info
.relay_stream_id
);
2268 ERR("stream_get_by_id not found");
2272 pthread_mutex_lock(&stream
->lock
);
2274 /* Live beacon handling */
2275 if (index_info
.packet_size
== 0) {
2276 DBG("Received live beacon for stream %" PRIu64
,
2277 stream
->stream_handle
);
2280 * Only flag a stream inactive when it has already
2281 * received data and no indexes are in flight.
2283 if (stream
->index_received_seqcount
> 0
2284 && stream
->indexes_in_flight
== 0) {
2285 stream
->beacon_ts_end
= index_info
.timestamp_end
;
2288 goto end_stream_put
;
2290 stream
->beacon_ts_end
= -1ULL;
2293 if (stream
->ctf_stream_id
== -1ULL) {
2294 stream
->ctf_stream_id
= index_info
.stream_id
;
2296 index
= relay_index_get_by_id_or_create(stream
, index_info
.net_seq_num
);
2299 ERR("relay_index_get_by_id_or_create index NULL");
2300 goto end_stream_put
;
2302 if (set_index_control_data(index
, &index_info
, conn
)) {
2303 ERR("set_index_control_data error");
2304 relay_index_put(index
);
2306 goto end_stream_put
;
2308 ret
= relay_index_try_flush(index
);
2310 tracefile_array_commit_seq(stream
->tfa
);
2311 stream
->index_received_seqcount
++;
2312 stream
->pos_after_last_complete_data_index
+= index
->total_size
;
2313 } else if (ret
> 0) {
2317 ERR("relay_index_try_flush error %d", ret
);
2318 relay_index_put(index
);
2323 pthread_mutex_unlock(&stream
->lock
);
2328 memset(&reply
, 0, sizeof(reply
));
2330 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2332 reply
.ret_code
= htobe32(LTTNG_OK
);
2334 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2335 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2336 ERR("Failed to send \"recv index\" command reply (ret = %zd)", send_ret
);
2345 * Receive the streams_sent message.
2347 * Return 0 on success else a negative value.
2349 static int relay_streams_sent(const struct lttcomm_relayd_hdr
*recv_hdr
,
2350 struct relay_connection
*conn
,
2351 const struct lttng_buffer_view
*payload
)
2355 struct lttcomm_relayd_generic_reply reply
;
2359 DBG("Relay receiving streams_sent");
2361 if (!conn
->session
|| !conn
->version_check_done
) {
2362 ERR("Trying to close a stream before version check");
2364 goto end_no_session
;
2368 * Publish every pending stream in the connection recv list which are
2369 * now ready to be used by the viewer.
2371 publish_connection_local_streams(conn
);
2373 memset(&reply
, 0, sizeof(reply
));
2374 reply
.ret_code
= htobe32(LTTNG_OK
);
2375 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2376 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2377 ERR("Failed to send \"streams sent\" command reply (ret = %zd)",
2390 * relay_rotate_session_stream: rotate a stream to a new tracefile for the session
2391 * rotation feature (not the tracefile rotation feature).
2393 static int relay_rotate_session_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
2394 struct relay_connection
*conn
,
2395 const struct lttng_buffer_view
*payload
)
2399 struct relay_session
*session
= conn
->session
;
2400 struct lttcomm_relayd_rotate_stream stream_info
;
2401 struct lttcomm_relayd_generic_reply reply
;
2402 struct relay_stream
*stream
;
2405 struct lttng_buffer_view new_path_view
;
2407 DBG("Rotate stream received");
2409 if (!session
|| !conn
->version_check_done
) {
2410 ERR("Trying to rotate a stream before version check");
2415 if (session
->major
== 2 && session
->minor
< 11) {
2416 ERR("Unsupported feature before 2.11");
2421 header_len
= sizeof(struct lttcomm_relayd_rotate_stream
);
2423 if (payload
->size
< header_len
) {
2424 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected >= %zu bytes, got %zu bytes",
2425 header_len
, payload
->size
);
2430 memcpy(&stream_info
, payload
->data
, header_len
);
2432 /* Convert to host */
2433 stream_info
.pathname_length
= be32toh(stream_info
.pathname_length
);
2434 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
2435 stream_info
.new_chunk_id
= be64toh(stream_info
.new_chunk_id
);
2436 stream_info
.rotate_at_seq_num
= be64toh(stream_info
.rotate_at_seq_num
);
2438 path_len
= stream_info
.pathname_length
;
2439 if (payload
->size
< header_len
+ path_len
) {
2440 ERR("Unexpected payload size in \"relay_rotate_session_stream\" including path: expected >= %zu bytes, got %zu bytes",
2441 header_len
+ path_len
, payload
->size
);
2446 /* Ensure it fits in local filename length. */
2447 if (path_len
>= LTTNG_PATH_MAX
) {
2448 ret
= -ENAMETOOLONG
;
2449 ERR("Length of relay_rotate_session_stream command's path name (%zu bytes) exceeds the maximal allowed length of %i bytes",
2450 path_len
, LTTNG_PATH_MAX
);
2454 new_path_view
= lttng_buffer_view_from_view(payload
, header_len
,
2455 stream_info
.pathname_length
);
2457 stream
= stream_get_by_id(stream_info
.stream_id
);
2463 pthread_mutex_lock(&stream
->lock
);
2466 * Update the trace path (just the folder, the stream name does not
2469 free(stream
->path_name
);
2470 stream
->path_name
= create_output_path(new_path_view
.data
);
2471 if (!stream
->path_name
) {
2472 ERR("Failed to create a new output path");
2474 goto end_stream_unlock
;
2476 ret
= utils_mkdir_recursive(stream
->path_name
, S_IRWXU
| S_IRWXG
,
2479 ERR("relay creating output directory");
2481 goto end_stream_unlock
;
2484 stream
->chunk_id
= stream_info
.new_chunk_id
;
2486 if (stream
->is_metadata
) {
2488 * The metadata stream is sent only over the control connection
2489 * so we know we have all the data to perform the stream
2492 ret
= do_rotate_stream(stream
);
2494 stream
->rotate_at_seq_num
= stream_info
.rotate_at_seq_num
;
2495 ret
= try_rotate_stream(stream
);
2498 goto end_stream_unlock
;
2502 pthread_mutex_unlock(&stream
->lock
);
2505 memset(&reply
, 0, sizeof(reply
));
2507 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2509 reply
.ret_code
= htobe32(LTTNG_OK
);
2511 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2512 sizeof(struct lttcomm_relayd_generic_reply
), 0);
2513 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2514 ERR("Failed to send \"rotate session stream\" command reply (ret = %zd)",
2524 * relay_mkdir: Create a folder on the disk.
2526 static int relay_mkdir(const struct lttcomm_relayd_hdr
*recv_hdr
,
2527 struct relay_connection
*conn
,
2528 const struct lttng_buffer_view
*payload
)
2531 struct relay_session
*session
= conn
->session
;
2532 struct lttcomm_relayd_mkdir path_info_header
;
2533 struct lttcomm_relayd_generic_reply reply
;
2537 struct lttng_buffer_view path_view
;
2539 if (!session
|| !conn
->version_check_done
) {
2540 ERR("Trying to create a directory before version check");
2542 goto end_no_session
;
2545 if (session
->major
== 2 && session
->minor
< 11) {
2547 * This client is not supposed to use this command since
2548 * it predates its introduction.
2550 ERR("relay_mkdir command is unsupported before LTTng 2.11");
2552 goto end_no_session
;
2555 header_len
= sizeof(path_info_header
);
2556 if (payload
->size
< header_len
) {
2557 ERR("Unexpected payload size in \"relay_mkdir\": expected >= %zu bytes, got %zu bytes",
2558 header_len
, payload
->size
);
2560 goto end_no_session
;
2563 memcpy(&path_info_header
, payload
->data
, header_len
);
2565 path_info_header
.length
= be32toh(path_info_header
.length
);
2567 if (payload
->size
< header_len
+ path_info_header
.length
) {
2568 ERR("Unexpected payload size in \"relay_mkdir\" including path: expected >= %zu bytes, got %zu bytes",
2569 header_len
+ path_info_header
.length
, payload
->size
);
2571 goto end_no_session
;
2574 /* Ensure that it fits in local path length. */
2575 if (path_info_header
.length
>= LTTNG_PATH_MAX
) {
2576 ret
= -ENAMETOOLONG
;
2577 ERR("Path name argument of mkdir command (%" PRIu32
" bytes) exceeds the maximal length allowed (%d bytes)",
2578 path_info_header
.length
, LTTNG_PATH_MAX
);
2582 path_view
= lttng_buffer_view_from_view(payload
, header_len
,
2583 path_info_header
.length
);
2585 path
= create_output_path(path_view
.data
);
2587 ERR("Failed to create output path");
2592 ret
= utils_mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, -1, -1);
2594 ERR("relay creating output directory");
2601 memset(&reply
, 0, sizeof(reply
));
2603 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2605 reply
.ret_code
= htobe32(LTTNG_OK
);
2607 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2608 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2609 ERR("Failed to send \"mkdir\" command reply (ret = %zd)", send_ret
);
2618 static int validate_rotate_rename_path_length(const char *path_type
,
2619 uint32_t path_length
)
2623 if (path_length
> LTTNG_PATH_MAX
) {
2624 ret
= -ENAMETOOLONG
;
2625 ERR("rotate rename \"%s\" path name length (%" PRIu32
" bytes) exceeds the allowed size of %i bytes",
2626 path_type
, path_length
, LTTNG_PATH_MAX
);
2627 } else if (path_length
== 0) {
2629 ERR("rotate rename \"%s\" path name has an illegal length of 0", path_type
);
2635 * relay_rotate_rename: rename the trace folder after a rotation is
2636 * completed. We are not closing any fd here, just moving the folder, so it
2637 * works even if data is still in-flight.
2639 static int relay_rotate_rename(const struct lttcomm_relayd_hdr
*recv_hdr
,
2640 struct relay_connection
*conn
,
2641 const struct lttng_buffer_view
*payload
)
2645 struct relay_session
*session
= conn
->session
;
2646 struct lttcomm_relayd_generic_reply reply
;
2647 struct lttcomm_relayd_rotate_rename header
;
2649 size_t received_paths_size
;
2650 char *complete_old_path
= NULL
, *complete_new_path
= NULL
;
2651 struct lttng_buffer_view old_path_view
;
2652 struct lttng_buffer_view new_path_view
;
2654 if (!session
|| !conn
->version_check_done
) {
2655 ERR("Trying to rename a trace folder before version check");
2660 if (session
->major
== 2 && session
->minor
< 11) {
2661 ERR("relay_rotate_rename command is unsupported before LTTng 2.11");
2666 header_len
= sizeof(header
);
2667 if (payload
->size
< header_len
) {
2668 ERR("Unexpected payload size in \"relay_rotate_rename\": expected >= %zu bytes, got %zu bytes",
2669 header_len
, payload
->size
);
2674 memcpy(&header
, payload
->data
, header_len
);
2676 header
.old_path_length
= be32toh(header
.old_path_length
);
2677 header
.new_path_length
= be32toh(header
.new_path_length
);
2678 received_paths_size
= header
.old_path_length
+ header
.new_path_length
;
2680 if (payload
->size
< header_len
+ received_paths_size
) {
2681 ERR("Unexpected payload size in \"relay_rotate_rename\" including paths: expected >= %zu bytes, got %zu bytes",
2682 header_len
, payload
->size
);
2687 /* Ensure the paths don't exceed their allowed size. */
2688 ret
= validate_rotate_rename_path_length("old", header
.old_path_length
);
2692 ret
= validate_rotate_rename_path_length("new", header
.new_path_length
);
2697 old_path_view
= lttng_buffer_view_from_view(payload
, header_len
,
2698 header
.old_path_length
);
2699 new_path_view
= lttng_buffer_view_from_view(payload
,
2700 header_len
+ header
.old_path_length
,
2701 header
.new_path_length
);
2703 /* Validate that both paths received are NULL terminated. */
2704 if (old_path_view
.data
[old_path_view
.size
- 1] != '\0') {
2705 ERR("relay_rotate_rename command's \"old\" path is invalid (not NULL terminated)");
2709 if (new_path_view
.data
[new_path_view
.size
- 1] != '\0') {
2710 ERR("relay_rotate_rename command's \"new\" path is invalid (not NULL terminated)");
2715 complete_old_path
= create_output_path(old_path_view
.data
);
2716 if (!complete_old_path
) {
2717 ERR("Failed to build old output path in rotate_rename command");
2722 complete_new_path
= create_output_path(new_path_view
.data
);
2723 if (!complete_new_path
) {
2724 ERR("Failed to build new output path in rotate_rename command");
2729 ret
= utils_mkdir_recursive(complete_new_path
, S_IRWXU
| S_IRWXG
,
2732 ERR("Failed to mkdir() rotate_rename's \"new\" output directory at \"%s\"",
2738 * If a domain has not yet created its channel, the domain-specific
2739 * folder might not exist, but this is not an error.
2741 ret
= rename(complete_old_path
, complete_new_path
);
2742 if (ret
< 0 && errno
!= ENOENT
) {
2743 PERROR("Renaming chunk in rotate_rename command from \"%s\" to \"%s\"",
2744 complete_old_path
, complete_new_path
);
2750 memset(&reply
, 0, sizeof(reply
));
2752 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2754 reply
.ret_code
= htobe32(LTTNG_OK
);
2756 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2758 if (send_ret
< sizeof(reply
)) {
2759 ERR("Failed to send \"rotate rename\" command reply (ret = %zd)",
2765 free(complete_old_path
);
2766 free(complete_new_path
);
2771 * Check if all the streams in the session have completed the last rotation.
2772 * The chunk_id value is used to distinguish the cases where a stream was
2773 * closed on the consumerd before the rotation started but it still active on
2774 * the relayd, and the case where a stream appeared on the consumerd/relayd
2775 * after the last rotation started (in that case, it is already writing in the
2776 * new chunk folder).
2779 int relay_rotate_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2780 struct relay_connection
*conn
,
2781 const struct lttng_buffer_view
*payload
)
2783 struct relay_session
*session
= conn
->session
;
2784 struct lttcomm_relayd_rotate_pending msg
;
2785 struct lttcomm_relayd_rotate_pending_reply reply
;
2786 struct lttng_ht_iter iter
;
2787 struct relay_stream
*stream
;
2791 bool rotate_pending
= false;
2793 DBG("Rotate pending command received");
2795 if (!session
|| !conn
->version_check_done
) {
2796 ERR("Trying to check for data before version check");
2801 if (session
->major
== 2 && session
->minor
< 11) {
2802 ERR("Unsupported feature before 2.11");
2807 if (payload
->size
< sizeof(msg
)) {
2808 ERR("Unexpected payload size in \"relay_rotate_pending\": expected >= %zu bytes, got %zu bytes",
2809 sizeof(msg
), payload
->size
);
2814 memcpy(&msg
, payload
->data
, sizeof(msg
));
2816 chunk_id
= be64toh(msg
.chunk_id
);
2818 DBG("Evaluating rotate pending for chunk id %" PRIu64
, chunk_id
);
2821 * Iterate over all the streams in the session and check if they are
2822 * still waiting for data to perform their rotation.
2825 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2827 if (!stream_get(stream
)) {
2830 if (stream
->trace
->session
!= session
) {
2834 pthread_mutex_lock(&stream
->lock
);
2835 if (stream
->rotate_at_seq_num
!= -1ULL) {
2836 /* We have not yet performed the rotation. */
2837 rotate_pending
= true;
2838 DBG("Stream %" PRIu64
" is still rotating",
2839 stream
->stream_handle
);
2840 } else if (stream
->chunk_id
< chunk_id
) {
2842 * Stream closed on the consumer but still active on the
2845 rotate_pending
= true;
2846 DBG("Stream %" PRIu64
" did not exist on the consumer "
2847 "when the last rotation started, but is"
2848 "still waiting for data before getting"
2850 stream
->stream_handle
);
2852 pthread_mutex_unlock(&stream
->lock
);
2854 if (rotate_pending
) {
2861 memset(&reply
, 0, sizeof(reply
));
2862 reply
.generic
.ret_code
= htobe32((uint32_t) LTTNG_OK
);
2863 reply
.is_pending
= (uint8_t) !!rotate_pending
;
2864 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2866 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2867 ERR("Failed to send \"rotate pending\" command reply (ret = %zd)",
2876 #define DBG_CMD(cmd_name, conn) \
2877 DBG3("Processing \"%s\" command for socket %i", cmd_name, conn->sock->fd);
2879 static int relay_process_control_command(struct relay_connection
*conn
,
2880 const struct lttcomm_relayd_hdr
*header
,
2881 const struct lttng_buffer_view
*payload
)
2885 switch (header
->cmd
) {
2886 case RELAYD_CREATE_SESSION
:
2887 DBG_CMD("RELAYD_CREATE_SESSION", conn
);
2888 ret
= relay_create_session(header
, conn
, payload
);
2890 case RELAYD_ADD_STREAM
:
2891 DBG_CMD("RELAYD_ADD_STREAM", conn
);
2892 ret
= relay_add_stream(header
, conn
, payload
);
2894 case RELAYD_START_DATA
:
2895 DBG_CMD("RELAYD_START_DATA", conn
);
2896 ret
= relay_start(header
, conn
, payload
);
2898 case RELAYD_SEND_METADATA
:
2899 DBG_CMD("RELAYD_SEND_METADATA", conn
);
2900 ret
= relay_recv_metadata(header
, conn
, payload
);
2902 case RELAYD_VERSION
:
2903 DBG_CMD("RELAYD_VERSION", conn
);
2904 ret
= relay_send_version(header
, conn
, payload
);
2906 case RELAYD_CLOSE_STREAM
:
2907 DBG_CMD("RELAYD_CLOSE_STREAM", conn
);
2908 ret
= relay_close_stream(header
, conn
, payload
);
2910 case RELAYD_DATA_PENDING
:
2911 DBG_CMD("RELAYD_DATA_PENDING", conn
);
2912 ret
= relay_data_pending(header
, conn
, payload
);
2914 case RELAYD_QUIESCENT_CONTROL
:
2915 DBG_CMD("RELAYD_QUIESCENT_CONTROL", conn
);
2916 ret
= relay_quiescent_control(header
, conn
, payload
);
2918 case RELAYD_BEGIN_DATA_PENDING
:
2919 DBG_CMD("RELAYD_BEGIN_DATA_PENDING", conn
);
2920 ret
= relay_begin_data_pending(header
, conn
, payload
);
2922 case RELAYD_END_DATA_PENDING
:
2923 DBG_CMD("RELAYD_END_DATA_PENDING", conn
);
2924 ret
= relay_end_data_pending(header
, conn
, payload
);
2926 case RELAYD_SEND_INDEX
:
2927 DBG_CMD("RELAYD_SEND_INDEX", conn
);
2928 ret
= relay_recv_index(header
, conn
, payload
);
2930 case RELAYD_STREAMS_SENT
:
2931 DBG_CMD("RELAYD_STREAMS_SENT", conn
);
2932 ret
= relay_streams_sent(header
, conn
, payload
);
2934 case RELAYD_RESET_METADATA
:
2935 DBG_CMD("RELAYD_RESET_METADATA", conn
);
2936 ret
= relay_reset_metadata(header
, conn
, payload
);
2938 case RELAYD_ROTATE_STREAM
:
2939 DBG_CMD("RELAYD_ROTATE_STREAM", conn
);
2940 ret
= relay_rotate_session_stream(header
, conn
, payload
);
2942 case RELAYD_ROTATE_RENAME
:
2943 DBG_CMD("RELAYD_ROTATE_RENAME", conn
);
2944 ret
= relay_rotate_rename(header
, conn
, payload
);
2946 case RELAYD_ROTATE_PENDING
:
2947 DBG_CMD("RELAYD_ROTATE_PENDING", conn
);
2948 ret
= relay_rotate_pending(header
, conn
, payload
);
2951 DBG_CMD("RELAYD_MKDIR", conn
);
2952 ret
= relay_mkdir(header
, conn
, payload
);
2954 case RELAYD_UPDATE_SYNC_INFO
:
2956 ERR("Received unknown command (%u)", header
->cmd
);
2957 relay_unknown_command(conn
);
2966 static enum relay_connection_status
relay_process_control_receive_payload(
2967 struct relay_connection
*conn
)
2970 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
2971 struct lttng_dynamic_buffer
*reception_buffer
=
2972 &conn
->protocol
.ctrl
.reception_buffer
;
2973 struct ctrl_connection_state_receive_payload
*state
=
2974 &conn
->protocol
.ctrl
.state
.receive_payload
;
2975 struct lttng_buffer_view payload_view
;
2977 if (state
->left_to_receive
== 0) {
2978 /* Short-circuit for payload-less commands. */
2979 goto reception_complete
;
2982 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
2983 reception_buffer
->data
+ state
->received
,
2984 state
->left_to_receive
, MSG_DONTWAIT
);
2986 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2987 PERROR("Unable to receive command payload on sock %d",
2989 status
= RELAY_CONNECTION_STATUS_ERROR
;
2992 } else if (ret
== 0) {
2993 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
2994 status
= RELAY_CONNECTION_STATUS_CLOSED
;
2999 assert(ret
<= state
->left_to_receive
);
3001 state
->left_to_receive
-= ret
;
3002 state
->received
+= ret
;
3004 if (state
->left_to_receive
> 0) {
3006 * Can't transition to the protocol's next state, wait to
3007 * receive the rest of the header.
3009 DBG3("Partial reception of control connection protocol payload (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3010 state
->received
, state
->left_to_receive
,
3016 DBG("Done receiving control command payload: fd = %i, payload size = %" PRIu64
" bytes",
3017 conn
->sock
->fd
, state
->received
);
3019 * The payload required to process the command has been received.
3020 * A view to the reception buffer is forwarded to the various
3021 * commands and the state of the control is reset on success.
3023 * Commands are responsible for sending their reply to the peer.
3025 payload_view
= lttng_buffer_view_from_dynamic_buffer(reception_buffer
,
3027 ret
= relay_process_control_command(conn
,
3028 &state
->header
, &payload_view
);
3030 status
= RELAY_CONNECTION_STATUS_ERROR
;
3034 ret
= connection_reset_protocol_state(conn
);
3036 status
= RELAY_CONNECTION_STATUS_ERROR
;
3042 static enum relay_connection_status
relay_process_control_receive_header(
3043 struct relay_connection
*conn
)
3046 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3047 struct lttcomm_relayd_hdr header
;
3048 struct lttng_dynamic_buffer
*reception_buffer
=
3049 &conn
->protocol
.ctrl
.reception_buffer
;
3050 struct ctrl_connection_state_receive_header
*state
=
3051 &conn
->protocol
.ctrl
.state
.receive_header
;
3053 assert(state
->left_to_receive
!= 0);
3055 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3056 reception_buffer
->data
+ state
->received
,
3057 state
->left_to_receive
, MSG_DONTWAIT
);
3059 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3060 PERROR("Unable to receive control command header on sock %d",
3062 status
= RELAY_CONNECTION_STATUS_ERROR
;
3065 } else if (ret
== 0) {
3066 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3067 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3072 assert(ret
<= state
->left_to_receive
);
3074 state
->left_to_receive
-= ret
;
3075 state
->received
+= ret
;
3077 if (state
->left_to_receive
> 0) {
3079 * Can't transition to the protocol's next state, wait to
3080 * receive the rest of the header.
3082 DBG3("Partial reception of control connection protocol header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3083 state
->received
, state
->left_to_receive
,
3088 /* Transition to next state: receiving the command's payload. */
3089 conn
->protocol
.ctrl
.state_id
=
3090 CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3091 memcpy(&header
, reception_buffer
->data
, sizeof(header
));
3092 header
.circuit_id
= be64toh(header
.circuit_id
);
3093 header
.data_size
= be64toh(header
.data_size
);
3094 header
.cmd
= be32toh(header
.cmd
);
3095 header
.cmd_version
= be32toh(header
.cmd_version
);
3096 memcpy(&conn
->protocol
.ctrl
.state
.receive_payload
.header
,
3097 &header
, sizeof(header
));
3099 DBG("Done receiving control command header: fd = %i, cmd = %" PRIu32
", cmd_version = %" PRIu32
", payload size = %" PRIu64
" bytes",
3100 conn
->sock
->fd
, header
.cmd
, header
.cmd_version
,
3103 if (header
.data_size
> DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE
) {
3104 ERR("Command header indicates a payload (%" PRIu64
" bytes) that exceeds the maximal payload size allowed on a control connection.",
3106 status
= RELAY_CONNECTION_STATUS_ERROR
;
3110 conn
->protocol
.ctrl
.state
.receive_payload
.left_to_receive
=
3112 conn
->protocol
.ctrl
.state
.receive_payload
.received
= 0;
3113 ret
= lttng_dynamic_buffer_set_size(reception_buffer
,
3116 status
= RELAY_CONNECTION_STATUS_ERROR
;
3120 if (header
.data_size
== 0) {
3122 * Manually invoke the next state as the poll loop
3123 * will not wake-up to allow us to proceed further.
3125 status
= relay_process_control_receive_payload(conn
);
3132 * Process the commands received on the control socket
3134 static enum relay_connection_status
relay_process_control(
3135 struct relay_connection
*conn
)
3137 enum relay_connection_status status
;
3139 switch (conn
->protocol
.ctrl
.state_id
) {
3140 case CTRL_CONNECTION_STATE_RECEIVE_HEADER
:
3141 status
= relay_process_control_receive_header(conn
);
3143 case CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3144 status
= relay_process_control_receive_payload(conn
);
3147 ERR("Unknown control connection protocol state encountered.");
3155 * Handle index for a data stream.
3157 * Called with the stream lock held.
3159 * Return 0 on success else a negative value.
3161 static int handle_index_data(struct relay_stream
*stream
, uint64_t net_seq_num
,
3162 bool rotate_index
, bool *flushed
, uint64_t total_size
)
3165 uint64_t data_offset
;
3166 struct relay_index
*index
;
3168 /* Get data offset because we are about to update the index. */
3169 data_offset
= htobe64(stream
->tracefile_size_current
);
3171 DBG("handle_index_data: stream %" PRIu64
" net_seq_num %" PRIu64
" data offset %" PRIu64
,
3172 stream
->stream_handle
, net_seq_num
, stream
->tracefile_size_current
);
3175 * Lookup for an existing index for that stream id/sequence
3176 * number. If it exists, the control thread has already received the
3177 * data for it, thus we need to write it to disk.
3179 index
= relay_index_get_by_id_or_create(stream
, net_seq_num
);
3185 if (rotate_index
|| !stream
->index_file
) {
3186 ret
= create_rotate_index_file(stream
);
3188 ERR("Failed to rotate index");
3189 /* Put self-ref for this index due to error. */
3190 relay_index_put(index
);
3196 if (relay_index_set_file(index
, stream
->index_file
, data_offset
)) {
3198 /* Put self-ref for this index due to error. */
3199 relay_index_put(index
);
3204 ret
= relay_index_try_flush(index
);
3206 tracefile_array_commit_seq(stream
->tfa
);
3207 stream
->index_received_seqcount
++;
3209 } else if (ret
> 0) {
3210 index
->total_size
= total_size
;
3214 /* Put self-ref for this index due to error. */
3215 relay_index_put(index
);
3223 static enum relay_connection_status
relay_process_data_receive_header(
3224 struct relay_connection
*conn
)
3227 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3228 struct data_connection_state_receive_header
*state
=
3229 &conn
->protocol
.data
.state
.receive_header
;
3230 struct lttcomm_relayd_data_hdr header
;
3231 struct relay_stream
*stream
;
3233 assert(state
->left_to_receive
!= 0);
3235 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3236 state
->header_reception_buffer
+ state
->received
,
3237 state
->left_to_receive
, MSG_DONTWAIT
);
3239 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3240 PERROR("Unable to receive data header on sock %d", conn
->sock
->fd
);
3241 status
= RELAY_CONNECTION_STATUS_ERROR
;
3244 } else if (ret
== 0) {
3245 /* Orderly shutdown. Not necessary to print an error. */
3246 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3247 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3252 assert(ret
<= state
->left_to_receive
);
3254 state
->left_to_receive
-= ret
;
3255 state
->received
+= ret
;
3257 if (state
->left_to_receive
> 0) {
3259 * Can't transition to the protocol's next state, wait to
3260 * receive the rest of the header.
3262 DBG3("Partial reception of data connection header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3263 state
->received
, state
->left_to_receive
,
3268 /* Transition to next state: receiving the payload. */
3269 conn
->protocol
.data
.state_id
= DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3271 memcpy(&header
, state
->header_reception_buffer
, sizeof(header
));
3272 header
.circuit_id
= be64toh(header
.circuit_id
);
3273 header
.stream_id
= be64toh(header
.stream_id
);
3274 header
.data_size
= be32toh(header
.data_size
);
3275 header
.net_seq_num
= be64toh(header
.net_seq_num
);
3276 header
.padding_size
= be32toh(header
.padding_size
);
3277 memcpy(&conn
->protocol
.data
.state
.receive_payload
.header
, &header
, sizeof(header
));
3279 conn
->protocol
.data
.state
.receive_payload
.left_to_receive
=
3281 conn
->protocol
.data
.state
.receive_payload
.received
= 0;
3282 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= false;
3284 DBG("Received data connection header on fd %i: circuit_id = %" PRIu64
", stream_id = %" PRIu64
", data_size = %" PRIu32
", net_seq_num = %" PRIu64
", padding_size = %" PRIu32
,
3285 conn
->sock
->fd
, header
.circuit_id
,
3286 header
.stream_id
, header
.data_size
,
3287 header
.net_seq_num
, header
.padding_size
);
3289 stream
= stream_get_by_id(header
.stream_id
);
3291 DBG("relay_process_data_receive_payload: Cannot find stream %" PRIu64
,
3293 /* Protocol error. */
3294 status
= RELAY_CONNECTION_STATUS_ERROR
;
3298 pthread_mutex_lock(&stream
->lock
);
3300 /* Check if a rotation is needed. */
3301 if (stream
->tracefile_size
> 0 &&
3302 (stream
->tracefile_size_current
+ header
.data_size
) >
3303 stream
->tracefile_size
) {
3304 uint64_t old_id
, new_id
;
3306 old_id
= tracefile_array_get_file_index_head(stream
->tfa
);
3307 tracefile_array_file_rotate(stream
->tfa
);
3309 /* new_id is updated by utils_rotate_stream_file. */
3312 ret
= utils_rotate_stream_file(stream
->path_name
,
3313 stream
->channel_name
, stream
->tracefile_size
,
3314 stream
->tracefile_count
, -1,
3315 -1, stream
->stream_fd
->fd
,
3316 &new_id
, &stream
->stream_fd
->fd
);
3318 ERR("Failed to rotate stream output file");
3319 status
= RELAY_CONNECTION_STATUS_ERROR
;
3320 goto end_stream_unlock
;
3324 * Reset current size because we just performed a stream
3327 stream
->tracefile_size_current
= 0;
3328 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= true;
3332 pthread_mutex_unlock(&stream
->lock
);
3338 static enum relay_connection_status
relay_process_data_receive_payload(
3339 struct relay_connection
*conn
)
3342 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3343 struct relay_stream
*stream
;
3344 struct data_connection_state_receive_payload
*state
=
3345 &conn
->protocol
.data
.state
.receive_payload
;
3346 const size_t chunk_size
= RECV_DATA_BUFFER_SIZE
;
3347 char data_buffer
[chunk_size
];
3348 bool partial_recv
= false;
3349 bool new_stream
= false, close_requested
= false, index_flushed
= false;
3350 uint64_t left_to_receive
= state
->left_to_receive
;
3351 struct relay_session
*session
;
3353 DBG3("Receiving data for stream id %" PRIu64
" seqnum %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3354 state
->header
.stream_id
, state
->header
.net_seq_num
,
3355 state
->received
, left_to_receive
);
3357 stream
= stream_get_by_id(state
->header
.stream_id
);
3359 /* Protocol error. */
3360 ERR("relay_process_data_receive_payload: cannot find stream %" PRIu64
,
3361 state
->header
.stream_id
);
3362 status
= RELAY_CONNECTION_STATUS_ERROR
;
3366 pthread_mutex_lock(&stream
->lock
);
3367 session
= stream
->trace
->session
;
3368 if (!conn
->session
) {
3369 ret
= connection_set_session(conn
, session
);
3371 status
= RELAY_CONNECTION_STATUS_ERROR
;
3372 goto end_stream_unlock
;
3377 * The size of the "chunk" received on any iteration is bounded by:
3378 * - the data left to receive,
3379 * - the data immediately available on the socket,
3380 * - the on-stack data buffer
3382 while (left_to_receive
> 0 && !partial_recv
) {
3384 size_t recv_size
= min(left_to_receive
, chunk_size
);
3386 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
,
3387 recv_size
, MSG_DONTWAIT
);
3389 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3390 PERROR("Socket %d error", conn
->sock
->fd
);
3391 status
= RELAY_CONNECTION_STATUS_ERROR
;
3393 goto end_stream_unlock
;
3394 } else if (ret
== 0) {
3395 /* No more data ready to be consumed on socket. */
3396 DBG3("No more data ready for consumption on data socket of stream id %" PRIu64
,
3397 state
->header
.stream_id
);
3398 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3400 } else if (ret
< (int) recv_size
) {
3402 * All the data available on the socket has been
3405 partial_recv
= true;
3410 /* Write data to stream output fd. */
3411 write_ret
= lttng_write(stream
->stream_fd
->fd
, data_buffer
,
3413 if (write_ret
< (ssize_t
) recv_size
) {
3414 ERR("Relay error writing data to file");
3415 status
= RELAY_CONNECTION_STATUS_ERROR
;
3416 goto end_stream_unlock
;
3419 left_to_receive
-= recv_size
;
3420 state
->received
+= recv_size
;
3421 state
->left_to_receive
= left_to_receive
;
3423 DBG2("Relay wrote %zd bytes to tracefile for stream id %" PRIu64
,
3424 write_ret
, stream
->stream_handle
);
3427 if (state
->left_to_receive
> 0) {
3429 * Did not receive all the data expected, wait for more data to
3430 * become available on the socket.
3432 DBG3("Partial receive on data connection of stream id %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3433 state
->header
.stream_id
, state
->received
,
3434 state
->left_to_receive
);
3435 goto end_stream_unlock
;
3438 ret
= write_padding_to_file(stream
->stream_fd
->fd
,
3439 state
->header
.padding_size
);
3440 if ((int64_t) ret
< (int64_t) state
->header
.padding_size
) {
3441 ERR("write_padding_to_file: fail stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3442 stream
->stream_handle
,
3443 state
->header
.net_seq_num
, ret
);
3444 status
= RELAY_CONNECTION_STATUS_ERROR
;
3445 goto end_stream_unlock
;
3449 if (session
->minor
>= 4 && !session
->snapshot
) {
3450 ret
= handle_index_data(stream
, state
->header
.net_seq_num
,
3451 state
->rotate_index
, &index_flushed
, state
->header
.data_size
+ state
->header
.padding_size
);
3453 ERR("handle_index_data: fail stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3454 stream
->stream_handle
,
3455 state
->header
.net_seq_num
, ret
);
3456 status
= RELAY_CONNECTION_STATUS_ERROR
;
3457 goto end_stream_unlock
;
3461 stream
->tracefile_size_current
+= state
->header
.data_size
+
3462 state
->header
.padding_size
;
3464 if (stream
->prev_seq
== -1ULL) {
3467 if (index_flushed
) {
3468 stream
->pos_after_last_complete_data_index
=
3469 stream
->tracefile_size_current
;
3472 stream
->prev_seq
= state
->header
.net_seq_num
;
3475 * Resetting the protocol state (to RECEIVE_HEADER) will trash the
3476 * contents of *state which are aliased (union) to the same location as
3477 * the new state. Don't use it beyond this point.
3479 connection_reset_protocol_state(conn
);
3482 ret
= try_rotate_stream(stream
);
3484 status
= RELAY_CONNECTION_STATUS_ERROR
;
3485 goto end_stream_unlock
;
3489 close_requested
= stream
->close_requested
;
3490 pthread_mutex_unlock(&stream
->lock
);
3491 if (close_requested
&& left_to_receive
== 0) {
3492 try_stream_close(stream
);
3496 pthread_mutex_lock(&session
->lock
);
3497 uatomic_set(&session
->new_streams
, 1);
3498 pthread_mutex_unlock(&session
->lock
);
3507 * relay_process_data: Process the data received on the data socket
3509 static enum relay_connection_status
relay_process_data(
3510 struct relay_connection
*conn
)
3512 enum relay_connection_status status
;
3514 switch (conn
->protocol
.data
.state_id
) {
3515 case DATA_CONNECTION_STATE_RECEIVE_HEADER
:
3516 status
= relay_process_data_receive_header(conn
);
3518 case DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3519 status
= relay_process_data_receive_payload(conn
);
3522 ERR("Unexpected data connection communication state.");
3529 static void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
3533 (void) lttng_poll_del(events
, pollfd
);
3535 ret
= close(pollfd
);
3537 ERR("Closing pollfd %d", pollfd
);
3541 static void relay_thread_close_connection(struct lttng_poll_event
*events
,
3542 int pollfd
, struct relay_connection
*conn
)
3544 const char *type_str
;
3546 switch (conn
->type
) {
3551 type_str
= "Control";
3553 case RELAY_VIEWER_COMMAND
:
3554 type_str
= "Viewer Command";
3556 case RELAY_VIEWER_NOTIFICATION
:
3557 type_str
= "Viewer Notification";
3560 type_str
= "Unknown";
3562 cleanup_connection_pollfd(events
, pollfd
);
3563 connection_put(conn
);
3564 DBG("%s connection closed with %d", type_str
, pollfd
);
3568 * This thread does the actual work
3570 static void *relay_thread_worker(void *data
)
3572 int ret
, err
= -1, last_seen_data_fd
= -1;
3574 struct lttng_poll_event events
;
3575 struct lttng_ht
*relay_connections_ht
;
3576 struct lttng_ht_iter iter
;
3577 struct relay_connection
*destroy_conn
= NULL
;
3579 DBG("[thread] Relay worker started");
3581 rcu_register_thread();
3583 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
3585 if (testpoint(relayd_thread_worker
)) {
3586 goto error_testpoint
;
3589 health_code_update();
3591 /* table of connections indexed on socket */
3592 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3593 if (!relay_connections_ht
) {
3594 goto relay_connections_ht_error
;
3597 ret
= create_thread_poll_set(&events
, 2);
3599 goto error_poll_create
;
3602 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
3609 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
3611 health_code_update();
3613 /* Infinite blocking call, waiting for transmission */
3614 DBG3("Relayd worker thread polling...");
3615 health_poll_entry();
3616 ret
= lttng_poll_wait(&events
, -1);
3620 * Restart interrupted system call.
3622 if (errno
== EINTR
) {
3631 * Process control. The control connection is
3632 * prioritized so we don't starve it with high
3633 * throughput tracing data on the data connection.
3635 for (i
= 0; i
< nb_fd
; i
++) {
3636 /* Fetch once the poll data */
3637 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3638 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3640 health_code_update();
3644 * No activity for this FD (poll
3650 /* Thread quit pipe has been closed. Killing thread. */
3651 ret
= check_thread_quit_pipe(pollfd
, revents
);
3657 /* Inspect the relay conn pipe for new connection */
3658 if (pollfd
== relay_conn_pipe
[0]) {
3659 if (revents
& LPOLLIN
) {
3660 struct relay_connection
*conn
;
3662 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
3666 lttng_poll_add(&events
, conn
->sock
->fd
,
3667 LPOLLIN
| LPOLLRDHUP
);
3668 connection_ht_add(relay_connections_ht
, conn
);
3669 DBG("Connection socket %d added", conn
->sock
->fd
);
3670 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3671 ERR("Relay connection pipe error");
3674 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3678 struct relay_connection
*ctrl_conn
;
3680 ctrl_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3681 /* If not found, there is a synchronization issue. */
3684 if (ctrl_conn
->type
== RELAY_DATA
) {
3685 if (revents
& LPOLLIN
) {
3687 * Flag the last seen data fd not deleted. It will be
3688 * used as the last seen fd if any fd gets deleted in
3691 last_notdel_data_fd
= pollfd
;
3693 goto put_ctrl_connection
;
3695 assert(ctrl_conn
->type
== RELAY_CONTROL
);
3697 if (revents
& LPOLLIN
) {
3698 enum relay_connection_status status
;
3700 status
= relay_process_control(ctrl_conn
);
3701 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
3703 * On socket error flag the session as aborted to force
3704 * the cleanup of its stream otherwise it can leak
3705 * during the lifetime of the relayd.
3707 * This prevents situations in which streams can be
3708 * left opened because an index was received, the
3709 * control connection is closed, and the data
3710 * connection is closed (uncleanly) before the packet's
3713 * Since the control connection encountered an error,
3714 * it is okay to be conservative and close the
3715 * session right now as we can't rely on the protocol
3716 * being respected anymore.
3718 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
3719 session_abort(ctrl_conn
->session
);
3722 /* Clear the connection on error or close. */
3723 relay_thread_close_connection(&events
,
3728 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3729 relay_thread_close_connection(&events
,
3731 if (last_seen_data_fd
== pollfd
) {
3732 last_seen_data_fd
= last_notdel_data_fd
;
3735 ERR("Unexpected poll events %u for control sock %d",
3737 connection_put(ctrl_conn
);
3740 put_ctrl_connection
:
3741 connection_put(ctrl_conn
);
3746 * The last loop handled a control request, go back to poll to make
3747 * sure we prioritise the control socket.
3753 if (last_seen_data_fd
>= 0) {
3754 for (i
= 0; i
< nb_fd
; i
++) {
3755 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3757 health_code_update();
3759 if (last_seen_data_fd
== pollfd
) {
3766 /* Process data connection. */
3767 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
3768 /* Fetch the poll data. */
3769 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3770 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3771 struct relay_connection
*data_conn
;
3773 health_code_update();
3776 /* No activity for this FD (poll implementation). */
3780 /* Skip the command pipe. It's handled in the first loop. */
3781 if (pollfd
== relay_conn_pipe
[0]) {
3785 data_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3787 /* Skip it. Might be removed before. */
3790 if (data_conn
->type
== RELAY_CONTROL
) {
3791 goto put_data_connection
;
3793 assert(data_conn
->type
== RELAY_DATA
);
3795 if (revents
& LPOLLIN
) {
3796 enum relay_connection_status status
;
3798 status
= relay_process_data(data_conn
);
3799 /* Connection closed or error. */
3800 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
3802 * On socket error flag the session as aborted to force
3803 * the cleanup of its stream otherwise it can leak
3804 * during the lifetime of the relayd.
3806 * This prevents situations in which streams can be
3807 * left opened because an index was received, the
3808 * control connection is closed, and the data
3809 * connection is closed (uncleanly) before the packet's
3812 * Since the data connection encountered an error,
3813 * it is okay to be conservative and close the
3814 * session right now as we can't rely on the protocol
3815 * being respected anymore.
3817 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
3818 session_abort(data_conn
->session
);
3820 relay_thread_close_connection(&events
, pollfd
,
3823 * Every goto restart call sets the last seen fd where
3824 * here we don't really care since we gracefully
3825 * continue the loop after the connection is deleted.
3828 /* Keep last seen port. */
3829 last_seen_data_fd
= pollfd
;
3830 connection_put(data_conn
);
3833 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3834 relay_thread_close_connection(&events
, pollfd
,
3837 ERR("Unknown poll events %u for data sock %d",
3840 put_data_connection
:
3841 connection_put(data_conn
);
3843 last_seen_data_fd
= -1;
3846 /* Normal exit, no error */
3851 /* Cleanup remaining connection object. */
3853 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
,
3856 health_code_update();
3858 session_abort(destroy_conn
->session
);
3861 * No need to grab another ref, because we own
3864 relay_thread_close_connection(&events
, destroy_conn
->sock
->fd
,
3869 lttng_poll_clean(&events
);
3871 lttng_ht_destroy(relay_connections_ht
);
3872 relay_connections_ht_error
:
3873 /* Close relay conn pipes */
3874 utils_close_pipe(relay_conn_pipe
);
3876 DBG("Thread exited with error");
3878 DBG("Worker thread cleanup complete");
3882 ERR("Health error occurred in %s", __func__
);
3884 health_unregister(health_relayd
);
3885 rcu_unregister_thread();
3886 lttng_relay_stop_threads();
3891 * Create the relay command pipe to wake thread_manage_apps.
3892 * Closed in cleanup().
3894 static int create_relay_conn_pipe(void)
3898 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
3906 int main(int argc
, char **argv
)
3908 int ret
= 0, retval
= 0;
3911 /* Parse arguments */
3913 if (set_options(argc
, argv
)) {
3918 if (set_signal_handler()) {
3923 /* Try to create directory if -o, --output is specified. */
3924 if (opt_output_path
) {
3925 if (*opt_output_path
!= '/') {
3926 ERR("Please specify an absolute path for -o, --output PATH");
3931 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
,
3934 ERR("Unable to create %s", opt_output_path
);
3941 if (opt_daemon
|| opt_background
) {
3944 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
3952 * We are in the child. Make sure all other file
3953 * descriptors are closed, in case we are called with
3954 * more opened file descriptors than the standard ones.
3956 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
3961 /* Initialize thread health monitoring */
3962 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
3963 if (!health_relayd
) {
3964 PERROR("health_app_create error");
3966 goto exit_health_app_create
;
3969 /* Create thread quit pipe */
3970 if (init_thread_quit_pipe()) {
3972 goto exit_init_data
;
3975 /* Setup the thread apps communication pipe. */
3976 if (create_relay_conn_pipe()) {
3978 goto exit_init_data
;
3981 /* Init relay command queue. */
3982 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
3984 /* Initialize communication library */
3986 lttcomm_inet_init();
3988 /* tables of sessions indexed by session ID */
3989 sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3992 goto exit_init_data
;
3995 /* tables of streams indexed by stream ID */
3996 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3997 if (!relay_streams_ht
) {
3999 goto exit_init_data
;
4002 /* tables of streams indexed by stream ID */
4003 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4004 if (!viewer_streams_ht
) {
4006 goto exit_init_data
;
4009 ret
= utils_create_pipe(health_quit_pipe
);
4012 goto exit_health_quit_pipe
;
4015 /* Create thread to manage the client socket */
4016 ret
= pthread_create(&health_thread
, default_pthread_attr(),
4017 thread_manage_health
, (void *) NULL
);
4020 PERROR("pthread_create health");
4022 goto exit_health_thread
;
4025 /* Setup the dispatcher thread */
4026 ret
= pthread_create(&dispatcher_thread
, default_pthread_attr(),
4027 relay_thread_dispatcher
, (void *) NULL
);
4030 PERROR("pthread_create dispatcher");
4032 goto exit_dispatcher_thread
;
4035 /* Setup the worker thread */
4036 ret
= pthread_create(&worker_thread
, default_pthread_attr(),
4037 relay_thread_worker
, NULL
);
4040 PERROR("pthread_create worker");
4042 goto exit_worker_thread
;
4045 /* Setup the listener thread */
4046 ret
= pthread_create(&listener_thread
, default_pthread_attr(),
4047 relay_thread_listener
, (void *) NULL
);
4050 PERROR("pthread_create listener");
4052 goto exit_listener_thread
;
4055 ret
= relayd_live_create(live_uri
);
4057 ERR("Starting live viewer threads");
4063 * This is where we start awaiting program completion (e.g. through
4064 * signal that asks threads to teardown).
4067 ret
= relayd_live_join();
4073 ret
= pthread_join(listener_thread
, &status
);
4076 PERROR("pthread_join listener_thread");
4080 exit_listener_thread
:
4081 ret
= pthread_join(worker_thread
, &status
);
4084 PERROR("pthread_join worker_thread");
4089 ret
= pthread_join(dispatcher_thread
, &status
);
4092 PERROR("pthread_join dispatcher_thread");
4095 exit_dispatcher_thread
:
4097 ret
= pthread_join(health_thread
, &status
);
4100 PERROR("pthread_join health_thread");
4105 utils_close_pipe(health_quit_pipe
);
4106 exit_health_quit_pipe
:
4109 health_app_destroy(health_relayd
);
4110 exit_health_app_create
:
4113 * Wait for all pending call_rcu work to complete before tearing
4114 * down data structures. call_rcu worker may be trying to
4115 * perform lookups in those structures.
4120 /* Ensure all prior call_rcu are done. */