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 <urcu/rculist.h>
62 #include "ctf-trace.h"
65 #include "lttng-relayd.h"
67 #include "health-relayd.h"
68 #include "testpoint.h"
69 #include "viewer-stream.h"
72 #include "connection.h"
73 #include "tracefile-array.h"
74 #include "tcp_keep_alive.h"
76 static const char *help_msg
=
77 #ifdef LTTNG_EMBED_HELP
78 #include <lttng-relayd.8.h>
84 /* command line options */
85 char *opt_output_path
;
86 static int opt_daemon
, opt_background
;
89 * We need to wait for listener and live listener threads, as well as
90 * health check thread, before being ready to signal readiness.
92 #define NR_LTTNG_RELAY_READY 3
93 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
95 /* Size of receive buffer. */
96 #define RECV_DATA_BUFFER_SIZE 65536
97 #define FILE_COPY_BUFFER_SIZE 65536
99 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
100 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
102 static struct lttng_uri
*control_uri
;
103 static struct lttng_uri
*data_uri
;
104 static struct lttng_uri
*live_uri
;
106 const char *progname
;
108 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
109 static int tracing_group_name_override
;
111 const char * const config_section_name
= "relayd";
114 * Quit pipe for all threads. This permits a single cancellation point
115 * for all threads when receiving an event on the pipe.
117 int thread_quit_pipe
[2] = { -1, -1 };
120 * This pipe is used to inform the worker thread that a command is queued and
121 * ready to be processed.
123 static int relay_conn_pipe
[2] = { -1, -1 };
125 /* Shared between threads */
126 static int dispatch_thread_exit
;
128 static pthread_t listener_thread
;
129 static pthread_t dispatcher_thread
;
130 static pthread_t worker_thread
;
131 static pthread_t health_thread
;
134 * last_relay_stream_id_lock protects last_relay_stream_id increment
135 * atomicity on 32-bit architectures.
137 static pthread_mutex_t last_relay_stream_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
138 static uint64_t last_relay_stream_id
;
141 * Relay command queue.
143 * The relay_thread_listener and relay_thread_dispatcher communicate with this
146 static struct relay_conn_queue relay_conn_queue
;
148 /* buffer allocated at startup, used to store the trace data */
149 static char *data_buffer
;
150 static unsigned int data_buffer_size
;
152 /* Global relay stream hash table. */
153 struct lttng_ht
*relay_streams_ht
;
155 /* Global relay viewer stream hash table. */
156 struct lttng_ht
*viewer_streams_ht
;
158 /* Global relay sessions hash table. */
159 struct lttng_ht
*sessions_ht
;
161 /* Relayd health monitoring */
162 struct health_app
*health_relayd
;
164 static struct option long_options
[] = {
165 { "control-port", 1, 0, 'C', },
166 { "data-port", 1, 0, 'D', },
167 { "live-port", 1, 0, 'L', },
168 { "daemonize", 0, 0, 'd', },
169 { "background", 0, 0, 'b', },
170 { "group", 1, 0, 'g', },
171 { "help", 0, 0, 'h', },
172 { "output", 1, 0, 'o', },
173 { "verbose", 0, 0, 'v', },
174 { "config", 1, 0, 'f' },
175 { "version", 0, 0, 'V' },
179 static const char *config_ignore_options
[] = { "help", "config", "version" };
182 * Take an option from the getopt output and set it in the right variable to be
185 * Return 0 on success else a negative value.
187 static int set_option(int opt
, const char *arg
, const char *optname
)
193 fprintf(stderr
, "option %s", optname
);
195 fprintf(stderr
, " with arg %s\n", arg
);
199 if (lttng_is_setuid_setgid()) {
200 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
201 "-C, --control-port");
203 ret
= uri_parse(arg
, &control_uri
);
205 ERR("Invalid control URI specified");
208 if (control_uri
->port
== 0) {
209 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
214 if (lttng_is_setuid_setgid()) {
215 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
218 ret
= uri_parse(arg
, &data_uri
);
220 ERR("Invalid data URI specified");
223 if (data_uri
->port
== 0) {
224 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
229 if (lttng_is_setuid_setgid()) {
230 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
233 ret
= uri_parse(arg
, &live_uri
);
235 ERR("Invalid live URI specified");
238 if (live_uri
->port
== 0) {
239 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
250 if (lttng_is_setuid_setgid()) {
251 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
254 tracing_group_name
= strdup(arg
);
255 if (tracing_group_name
== NULL
) {
260 tracing_group_name_override
= 1;
264 ret
= utils_show_help(8, "lttng-relayd", help_msg
);
266 ERR("Cannot show --help for `lttng-relayd`");
271 fprintf(stdout
, "%s\n", VERSION
);
274 if (lttng_is_setuid_setgid()) {
275 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
278 ret
= asprintf(&opt_output_path
, "%s", arg
);
281 PERROR("asprintf opt_output_path");
287 /* Verbose level can increase using multiple -v */
289 lttng_opt_verbose
= config_parse_value(arg
);
291 /* Only 3 level of verbosity (-vvv). */
292 if (lttng_opt_verbose
< 3) {
293 lttng_opt_verbose
+= 1;
298 /* Unknown option or other error.
299 * Error is printed by getopt, just return */
312 * config_entry_handler_cb used to handle options read from a config file.
313 * See config_entry_handler_cb comment in common/config/session-config.h for the
314 * return value conventions.
316 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
320 if (!entry
|| !entry
->name
|| !entry
->value
) {
325 /* Check if the option is to be ignored */
326 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
327 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
332 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1; i
++) {
333 /* Ignore if entry name is not fully matched. */
334 if (strcmp(entry
->name
, long_options
[i
].name
)) {
339 * If the option takes no argument on the command line,
340 * we have to check if the value is "true". We support
341 * non-zero numeric values, true, on and yes.
343 if (!long_options
[i
].has_arg
) {
344 ret
= config_parse_value(entry
->value
);
347 WARN("Invalid configuration value \"%s\" for option %s",
348 entry
->value
, entry
->name
);
350 /* False, skip boolean config option. */
355 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
359 WARN("Unrecognized option \"%s\" in daemon configuration file.",
366 static int set_options(int argc
, char **argv
)
368 int c
, ret
= 0, option_index
= 0, retval
= 0;
369 int orig_optopt
= optopt
, orig_optind
= optind
;
370 char *default_address
, *optstring
;
371 const char *config_path
= NULL
;
373 optstring
= utils_generate_optstring(long_options
,
374 sizeof(long_options
) / sizeof(struct option
));
380 /* Check for the --config option */
382 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
383 &option_index
)) != -1) {
387 } else if (c
!= 'f') {
391 if (lttng_is_setuid_setgid()) {
392 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
395 config_path
= utils_expand_path(optarg
);
397 ERR("Failed to resolve path: %s", optarg
);
402 ret
= config_get_section_entries(config_path
, config_section_name
,
403 config_entry_handler
, NULL
);
406 ERR("Invalid configuration option at line %i", ret
);
412 /* Reset getopt's global state */
413 optopt
= orig_optopt
;
414 optind
= orig_optind
;
416 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
421 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
428 /* assign default values */
429 if (control_uri
== NULL
) {
430 ret
= asprintf(&default_address
,
431 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
432 DEFAULT_NETWORK_CONTROL_PORT
);
434 PERROR("asprintf default data address");
439 ret
= uri_parse(default_address
, &control_uri
);
440 free(default_address
);
442 ERR("Invalid control URI specified");
447 if (data_uri
== NULL
) {
448 ret
= asprintf(&default_address
,
449 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
450 DEFAULT_NETWORK_DATA_PORT
);
452 PERROR("asprintf default data address");
457 ret
= uri_parse(default_address
, &data_uri
);
458 free(default_address
);
460 ERR("Invalid data URI specified");
465 if (live_uri
== NULL
) {
466 ret
= asprintf(&default_address
,
467 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
468 DEFAULT_NETWORK_VIEWER_PORT
);
470 PERROR("asprintf default viewer control address");
475 ret
= uri_parse(default_address
, &live_uri
);
476 free(default_address
);
478 ERR("Invalid viewer control URI specified");
489 static void print_global_objects(void)
491 rcu_register_thread();
493 print_viewer_streams();
494 print_relay_streams();
497 rcu_unregister_thread();
503 static void relayd_cleanup(void)
505 print_global_objects();
509 if (viewer_streams_ht
)
510 lttng_ht_destroy(viewer_streams_ht
);
511 if (relay_streams_ht
)
512 lttng_ht_destroy(relay_streams_ht
);
514 lttng_ht_destroy(sessions_ht
);
516 /* free the dynamically allocated opt_output_path */
517 free(opt_output_path
);
519 /* Close thread quit pipes */
520 utils_close_pipe(thread_quit_pipe
);
522 uri_free(control_uri
);
524 /* Live URI is freed in the live thread. */
526 if (tracing_group_name_override
) {
527 free((void *) tracing_group_name
);
532 * Write to writable pipe used to notify a thread.
534 static int notify_thread_pipe(int wpipe
)
538 ret
= lttng_write(wpipe
, "!", 1);
540 PERROR("write poll pipe");
548 static int notify_health_quit_pipe(int *pipe
)
552 ret
= lttng_write(pipe
[1], "4", 1);
554 PERROR("write relay health quit");
563 * Stop all relayd and relayd-live threads.
565 int lttng_relay_stop_threads(void)
569 /* Stopping all threads */
570 DBG("Terminating all threads");
571 if (notify_thread_pipe(thread_quit_pipe
[1])) {
572 ERR("write error on thread quit pipe");
576 if (notify_health_quit_pipe(health_quit_pipe
)) {
577 ERR("write error on health quit pipe");
580 /* Dispatch thread */
581 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
582 futex_nto1_wake(&relay_conn_queue
.futex
);
584 if (relayd_live_stop()) {
585 ERR("Error stopping live threads");
592 * Signal handler for the daemon
594 * Simply stop all worker threads, leaving main() return gracefully after
595 * joining all threads and calling cleanup().
597 static void sighandler(int sig
)
601 DBG("SIGINT caught");
602 if (lttng_relay_stop_threads()) {
603 ERR("Error stopping threads");
607 DBG("SIGTERM caught");
608 if (lttng_relay_stop_threads()) {
609 ERR("Error stopping threads");
613 CMM_STORE_SHARED(recv_child_signal
, 1);
621 * Setup signal handler for :
622 * SIGINT, SIGTERM, SIGPIPE
624 static int set_signal_handler(void)
630 if ((ret
= sigemptyset(&sigset
)) < 0) {
631 PERROR("sigemptyset");
638 sa
.sa_handler
= sighandler
;
639 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
644 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
649 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
654 sa
.sa_handler
= SIG_IGN
;
655 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
660 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
665 void lttng_relay_notify_ready(void)
667 /* Notify the parent of the fork() process that we are ready. */
668 if (opt_daemon
|| opt_background
) {
669 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
670 kill(child_ppid
, SIGUSR1
);
676 * Init thread quit pipe.
678 * Return -1 on error or 0 if all pipes are created.
680 static int init_thread_quit_pipe(void)
684 ret
= utils_create_pipe_cloexec(thread_quit_pipe
);
690 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
692 static int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
696 if (events
== NULL
|| size
== 0) {
701 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
707 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
719 * Check if the thread quit pipe was triggered.
721 * Return 1 if it was triggered else 0;
723 static int check_thread_quit_pipe(int fd
, uint32_t events
)
725 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
733 * Create and init socket from uri.
735 static struct lttcomm_sock
*relay_socket_create(struct lttng_uri
*uri
)
738 struct lttcomm_sock
*sock
= NULL
;
740 sock
= lttcomm_alloc_sock_from_uri(uri
);
742 ERR("Allocating socket");
746 ret
= lttcomm_create_sock(sock
);
750 DBG("Listening on sock %d", sock
->fd
);
752 ret
= sock
->ops
->bind(sock
);
757 ret
= sock
->ops
->listen(sock
, -1);
767 lttcomm_destroy_sock(sock
);
773 * This thread manages the listening for new connections on the network
775 static void *relay_thread_listener(void *data
)
777 int i
, ret
, pollfd
, err
= -1;
778 uint32_t revents
, nb_fd
;
779 struct lttng_poll_event events
;
780 struct lttcomm_sock
*control_sock
, *data_sock
;
782 DBG("[thread] Relay listener started");
784 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
786 health_code_update();
788 control_sock
= relay_socket_create(control_uri
);
790 goto error_sock_control
;
793 data_sock
= relay_socket_create(data_uri
);
795 goto error_sock_relay
;
799 * Pass 3 as size here for the thread quit pipe, control and
802 ret
= create_thread_poll_set(&events
, 3);
804 goto error_create_poll
;
807 /* Add the control socket */
808 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
813 /* Add the data socket */
814 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
819 lttng_relay_notify_ready();
821 if (testpoint(relayd_thread_listener
)) {
822 goto error_testpoint
;
826 health_code_update();
828 DBG("Listener accepting connections");
832 ret
= lttng_poll_wait(&events
, -1);
836 * Restart interrupted system call.
838 if (errno
== EINTR
) {
846 DBG("Relay new connection received");
847 for (i
= 0; i
< nb_fd
; i
++) {
848 health_code_update();
850 /* Fetch once the poll data */
851 revents
= LTTNG_POLL_GETEV(&events
, i
);
852 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
856 * No activity for this FD (poll
862 /* Thread quit pipe has been closed. Killing thread. */
863 ret
= check_thread_quit_pipe(pollfd
, revents
);
869 if (revents
& LPOLLIN
) {
871 * A new connection is requested, therefore a
872 * sessiond/consumerd connection is allocated in
873 * this thread, enqueued to a global queue and
874 * dequeued (and freed) in the worker thread.
877 struct relay_connection
*new_conn
;
878 struct lttcomm_sock
*newsock
;
879 enum connection_type type
;
881 if (pollfd
== data_sock
->fd
) {
883 newsock
= data_sock
->ops
->accept(data_sock
);
884 DBG("Relay data connection accepted, socket %d",
887 assert(pollfd
== control_sock
->fd
);
888 type
= RELAY_CONTROL
;
889 newsock
= control_sock
->ops
->accept(control_sock
);
890 DBG("Relay control connection accepted, socket %d",
894 PERROR("accepting sock");
898 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
901 PERROR("setsockopt inet");
902 lttcomm_destroy_sock(newsock
);
906 ret
= socket_apply_keep_alive_config(newsock
->fd
);
908 ERR("Failed to apply TCP keep-alive configuration on socket (%i)",
910 lttcomm_destroy_sock(newsock
);
914 new_conn
= connection_create(newsock
, type
);
916 lttcomm_destroy_sock(newsock
);
920 /* Enqueue request for the dispatcher thread. */
921 cds_wfcq_enqueue(&relay_conn_queue
.head
, &relay_conn_queue
.tail
,
925 * Wake the dispatch queue futex.
926 * Implicit memory barrier with the
927 * exchange in cds_wfcq_enqueue.
929 futex_nto1_wake(&relay_conn_queue
.futex
);
930 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
931 ERR("socket poll error");
934 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
944 lttng_poll_clean(&events
);
946 if (data_sock
->fd
>= 0) {
947 ret
= data_sock
->ops
->close(data_sock
);
952 lttcomm_destroy_sock(data_sock
);
954 if (control_sock
->fd
>= 0) {
955 ret
= control_sock
->ops
->close(control_sock
);
960 lttcomm_destroy_sock(control_sock
);
964 ERR("Health error occurred in %s", __func__
);
966 health_unregister(health_relayd
);
967 DBG("Relay listener thread cleanup complete");
968 lttng_relay_stop_threads();
973 * This thread manages the dispatching of the requests to worker threads
975 static void *relay_thread_dispatcher(void *data
)
979 struct cds_wfcq_node
*node
;
980 struct relay_connection
*new_conn
= NULL
;
982 DBG("[thread] Relay dispatcher started");
984 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
986 if (testpoint(relayd_thread_dispatcher
)) {
987 goto error_testpoint
;
990 health_code_update();
993 health_code_update();
995 /* Atomically prepare the queue futex */
996 futex_nto1_prepare(&relay_conn_queue
.futex
);
998 if (CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1003 health_code_update();
1005 /* Dequeue commands */
1006 node
= cds_wfcq_dequeue_blocking(&relay_conn_queue
.head
,
1007 &relay_conn_queue
.tail
);
1009 DBG("Woken up but nothing in the relay command queue");
1010 /* Continue thread execution */
1013 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
1015 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
1018 * Inform worker thread of the new request. This
1019 * call is blocking so we can be assured that
1020 * the data will be read at some point in time
1021 * or wait to the end of the world :)
1023 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
1025 PERROR("write connection pipe");
1026 connection_put(new_conn
);
1029 } while (node
!= NULL
);
1031 /* Futex wait on queue. Blocking call on futex() */
1032 health_poll_entry();
1033 futex_nto1_wait(&relay_conn_queue
.futex
);
1037 /* Normal exit, no error */
1044 ERR("Health error occurred in %s", __func__
);
1046 health_unregister(health_relayd
);
1047 DBG("Dispatch thread dying");
1048 lttng_relay_stop_threads();
1053 * Set index data from the control port to a given index object.
1055 static int set_index_control_data(struct relay_index
*index
,
1056 struct lttcomm_relayd_index
*data
,
1057 struct relay_connection
*conn
)
1059 struct ctf_packet_index index_data
;
1062 * The index on disk is encoded in big endian, so we don't need
1063 * to convert the data received on the network. The data_offset
1064 * value is NEVER modified here and is updated by the data
1067 index_data
.packet_size
= data
->packet_size
;
1068 index_data
.content_size
= data
->content_size
;
1069 index_data
.timestamp_begin
= data
->timestamp_begin
;
1070 index_data
.timestamp_end
= data
->timestamp_end
;
1071 index_data
.events_discarded
= data
->events_discarded
;
1072 index_data
.stream_id
= data
->stream_id
;
1074 if (conn
->minor
>= 8) {
1075 index
->index_data
.stream_instance_id
= data
->stream_instance_id
;
1076 index
->index_data
.packet_seq_num
= data
->packet_seq_num
;
1079 return relay_index_set_data(index
, &index_data
);
1083 * Handle the RELAYD_CREATE_SESSION command.
1085 * On success, send back the session id or else return a negative value.
1087 static int relay_create_session(struct lttcomm_relayd_hdr
*recv_hdr
,
1088 struct relay_connection
*conn
)
1090 int ret
= 0, send_ret
;
1091 struct relay_session
*session
;
1092 struct lttcomm_relayd_status_session reply
;
1093 char session_name
[LTTNG_NAME_MAX
];
1094 char hostname
[LTTNG_HOST_NAME_MAX
];
1095 uint32_t live_timer
= 0;
1096 bool snapshot
= false;
1098 memset(session_name
, 0, LTTNG_NAME_MAX
);
1099 memset(hostname
, 0, LTTNG_HOST_NAME_MAX
);
1101 memset(&reply
, 0, sizeof(reply
));
1103 switch (conn
->minor
) {
1108 case 4: /* LTTng sessiond 2.4 */
1110 ret
= cmd_create_session_2_4(conn
, session_name
,
1111 hostname
, &live_timer
, &snapshot
);
1117 session
= session_create(session_name
, hostname
, live_timer
,
1118 snapshot
, conn
->major
, conn
->minor
);
1123 assert(!conn
->session
);
1124 conn
->session
= session
;
1125 DBG("Created session %" PRIu64
, session
->id
);
1127 reply
.session_id
= htobe64(session
->id
);
1131 reply
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1133 reply
.ret_code
= htobe32(LTTNG_OK
);
1136 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1138 ERR("Relayd sending session id");
1146 * When we have received all the streams and the metadata for a channel,
1147 * we make them visible to the viewer threads.
1149 static void publish_connection_local_streams(struct relay_connection
*conn
)
1151 struct relay_stream
*stream
;
1152 struct relay_session
*session
= conn
->session
;
1155 * We publish all streams belonging to a session atomically wrt
1158 pthread_mutex_lock(&session
->lock
);
1160 cds_list_for_each_entry_rcu(stream
, &session
->recv_list
,
1162 stream_publish(stream
);
1167 * Inform the viewer that there are new streams in the session.
1169 if (session
->viewer_attached
) {
1170 uatomic_set(&session
->new_streams
, 1);
1172 pthread_mutex_unlock(&session
->lock
);
1176 * relay_add_stream: allocate a new stream for a session
1178 static int relay_add_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1179 struct relay_connection
*conn
)
1183 struct relay_session
*session
= conn
->session
;
1184 struct relay_stream
*stream
= NULL
;
1185 struct lttcomm_relayd_status_stream reply
;
1186 struct ctf_trace
*trace
= NULL
;
1187 uint64_t stream_handle
= -1ULL;
1188 char *path_name
= NULL
, *channel_name
= NULL
;
1189 uint64_t tracefile_size
= 0, tracefile_count
= 0;
1191 if (!session
|| conn
->version_check_done
== 0) {
1192 ERR("Trying to add a stream before version check");
1194 goto end_no_session
;
1197 switch (session
->minor
) {
1198 case 1: /* LTTng sessiond 2.1. Allocates path_name and channel_name. */
1199 ret
= cmd_recv_stream_2_1(conn
, &path_name
,
1202 case 2: /* LTTng sessiond 2.2. Allocates path_name and channel_name. */
1204 ret
= cmd_recv_stream_2_2(conn
, &path_name
,
1205 &channel_name
, &tracefile_size
, &tracefile_count
);
1212 trace
= ctf_trace_get_by_path_or_create(session
, path_name
);
1216 /* This stream here has one reference on the trace. */
1218 pthread_mutex_lock(&last_relay_stream_id_lock
);
1219 stream_handle
= ++last_relay_stream_id
;
1220 pthread_mutex_unlock(&last_relay_stream_id_lock
);
1222 /* We pass ownership of path_name and channel_name. */
1223 stream
= stream_create(trace
, stream_handle
, path_name
,
1224 channel_name
, tracefile_size
, tracefile_count
);
1226 channel_name
= NULL
;
1229 * Streams are the owners of their trace. Reference to trace is
1230 * kept within stream_create().
1232 ctf_trace_put(trace
);
1235 memset(&reply
, 0, sizeof(reply
));
1236 reply
.handle
= htobe64(stream_handle
);
1238 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1240 reply
.ret_code
= htobe32(LTTNG_OK
);
1243 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1244 sizeof(struct lttcomm_relayd_status_stream
), 0);
1246 ERR("Relay sending stream id");
1247 ret
= (int) send_ret
;
1257 * relay_close_stream: close a specific stream
1259 static int relay_close_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1260 struct relay_connection
*conn
)
1263 struct relay_session
*session
= conn
->session
;
1264 struct lttcomm_relayd_close_stream stream_info
;
1265 struct lttcomm_relayd_generic_reply reply
;
1266 struct relay_stream
*stream
;
1268 DBG("Close stream received");
1270 if (!session
|| conn
->version_check_done
== 0) {
1271 ERR("Trying to close a stream before version check");
1273 goto end_no_session
;
1276 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &stream_info
,
1277 sizeof(struct lttcomm_relayd_close_stream
), 0);
1278 if (ret
< sizeof(struct lttcomm_relayd_close_stream
)) {
1280 /* Orderly shutdown. Not necessary to print an error. */
1281 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1283 ERR("Relay didn't receive valid add_stream struct size : %d", ret
);
1286 goto end_no_session
;
1289 stream
= stream_get_by_id(be64toh(stream_info
.stream_id
));
1296 * Set last_net_seq_num before the close flag. Required by data
1299 pthread_mutex_lock(&stream
->lock
);
1300 stream
->last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1301 pthread_mutex_unlock(&stream
->lock
);
1304 * This is one of the conditions which may trigger a stream close
1305 * with the others being:
1306 * 1) A close command is received for a stream
1307 * 2) The control connection owning the stream is closed
1308 * 3) We have received all of the stream's data _after_ a close
1311 try_stream_close(stream
);
1312 if (stream
->is_metadata
) {
1313 struct relay_viewer_stream
*vstream
;
1315 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
1317 if (vstream
->metadata_sent
== stream
->metadata_received
) {
1319 * Since all the metadata has been sent to the
1320 * viewer and that we have a request to close
1321 * its stream, we can safely teardown the
1322 * corresponding metadata viewer stream.
1324 viewer_stream_put(vstream
);
1326 /* Put local reference. */
1327 viewer_stream_put(vstream
);
1333 memset(&reply
, 0, sizeof(reply
));
1335 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1337 reply
.ret_code
= htobe32(LTTNG_OK
);
1339 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1340 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1342 ERR("Relay sending stream id");
1351 * relay_reset_metadata: reset a metadata stream
1354 int relay_reset_metadata(struct lttcomm_relayd_hdr
*recv_hdr
,
1355 struct relay_connection
*conn
)
1358 struct relay_session
*session
= conn
->session
;
1359 struct lttcomm_relayd_reset_metadata stream_info
;
1360 struct lttcomm_relayd_generic_reply reply
;
1361 struct relay_stream
*stream
;
1363 DBG("Reset metadata received");
1365 if (!session
|| conn
->version_check_done
== 0) {
1366 ERR("Trying to reset a metadata stream before version check");
1368 goto end_no_session
;
1371 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &stream_info
,
1372 sizeof(struct lttcomm_relayd_reset_metadata
), 0);
1373 if (ret
< sizeof(struct lttcomm_relayd_reset_metadata
)) {
1375 /* Orderly shutdown. Not necessary to print an error. */
1376 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1378 ERR("Relay didn't receive valid reset_metadata struct "
1382 goto end_no_session
;
1384 DBG("Update metadata to version %" PRIu64
, be64toh(stream_info
.version
));
1386 /* Unsupported for live sessions for now. */
1387 if (session
->live_timer
!= 0) {
1392 stream
= stream_get_by_id(be64toh(stream_info
.stream_id
));
1397 pthread_mutex_lock(&stream
->lock
);
1398 if (!stream
->is_metadata
) {
1403 ret
= utils_rotate_stream_file(stream
->path_name
, stream
->channel_name
,
1404 0, 0, -1, -1, stream
->stream_fd
->fd
, NULL
,
1405 &stream
->stream_fd
->fd
);
1407 ERR("Failed to rotate metadata file %s of channel %s",
1408 stream
->path_name
, stream
->channel_name
);
1413 pthread_mutex_unlock(&stream
->lock
);
1417 memset(&reply
, 0, sizeof(reply
));
1419 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1421 reply
.ret_code
= htobe32(LTTNG_OK
);
1423 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1424 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1426 ERR("Relay sending reset metadata reply");
1435 * relay_unknown_command: send -1 if received unknown command
1437 static void relay_unknown_command(struct relay_connection
*conn
)
1439 struct lttcomm_relayd_generic_reply reply
;
1442 memset(&reply
, 0, sizeof(reply
));
1443 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1444 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1445 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1447 ERR("Relay sending unknown command");
1452 * relay_start: send an acknowledgment to the client to tell if we are
1453 * ready to receive data. We are ready if a session is established.
1455 static int relay_start(struct lttcomm_relayd_hdr
*recv_hdr
,
1456 struct relay_connection
*conn
)
1458 int ret
= htobe32(LTTNG_OK
);
1459 struct lttcomm_relayd_generic_reply reply
;
1460 struct relay_session
*session
= conn
->session
;
1463 DBG("Trying to start the streaming without a session established");
1464 ret
= htobe32(LTTNG_ERR_UNK
);
1467 memset(&reply
, 0, sizeof(reply
));
1468 reply
.ret_code
= ret
;
1469 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1470 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1472 ERR("Relay sending start ack");
1479 * Append padding to the file pointed by the file descriptor fd.
1481 static int write_padding_to_file(int fd
, uint32_t size
)
1490 zeros
= zmalloc(size
);
1491 if (zeros
== NULL
) {
1492 PERROR("zmalloc zeros for padding");
1497 ret
= lttng_write(fd
, zeros
, size
);
1499 PERROR("write padding to file");
1509 * Close the current index file if it is open, and create a new one.
1511 * Return 0 on success, -1 on error.
1514 int create_rotate_index_file(struct relay_stream
*stream
)
1517 uint32_t major
, minor
;
1519 /* Put ref on previous index_file. */
1520 if (stream
->index_file
) {
1521 lttng_index_file_put(stream
->index_file
);
1522 stream
->index_file
= NULL
;
1524 major
= stream
->trace
->session
->major
;
1525 minor
= stream
->trace
->session
->minor
;
1526 stream
->index_file
= lttng_index_file_create(stream
->path_name
,
1527 stream
->channel_name
,
1528 -1, -1, stream
->tracefile_size
,
1529 tracefile_array_get_file_index_head(stream
->tfa
),
1530 lttng_to_index_major(major
, minor
),
1531 lttng_to_index_minor(major
, minor
));
1532 if (!stream
->index_file
) {
1544 int do_rotate_stream(struct relay_stream
*stream
)
1548 /* Perform the stream rotation. */
1549 ret
= utils_rotate_stream_file(stream
->path_name
,
1550 stream
->channel_name
, stream
->tracefile_size
,
1551 stream
->tracefile_count
, -1,
1552 -1, stream
->stream_fd
->fd
,
1553 NULL
, &stream
->stream_fd
->fd
);
1555 ERR("Rotating stream output file");
1558 stream
->tracefile_size_current
= 0;
1560 /* Rotate also the index if the stream is not a metadata stream. */
1561 if (!stream
->is_metadata
) {
1562 ret
= create_rotate_index_file(stream
);
1564 ERR("Failed to rotate index file");
1569 stream
->rotate_at_seq_num
= -1ULL;
1570 stream
->pos_after_last_complete_data_index
= 0;
1577 * If too much data has been written in a tracefile before we received the
1578 * rotation command, we have to move the excess data to the new tracefile and
1579 * perform the rotation. This can happen because the control and data
1580 * connections are separate, the indexes as well as the commands arrive from
1581 * the control connection and we have no control over the order so we could be
1582 * in a situation where too much data has been received on the data connection
1583 * before the rotation command on the control connection arrives. We don't need
1584 * to update the index because its order is guaranteed with the rotation
1588 int rotate_truncate_stream(struct relay_stream
*stream
)
1592 uint64_t diff
, pos
= 0;
1593 char buf
[FILE_COPY_BUFFER_SIZE
];
1595 assert(!stream
->is_metadata
);
1597 assert(stream
->tracefile_size_current
>
1598 stream
->pos_after_last_complete_data_index
);
1599 diff
= stream
->tracefile_size_current
-
1600 stream
->pos_after_last_complete_data_index
;
1602 /* Create the new tracefile. */
1603 new_fd
= utils_create_stream_file(stream
->path_name
,
1604 stream
->channel_name
,
1605 stream
->tracefile_size
, stream
->tracefile_count
,
1606 /* uid */ -1, /* gid */ -1, /* suffix */ NULL
);
1608 ERR("Failed to create new stream file at path %s for channel %s",
1609 stream
->path_name
, stream
->channel_name
);
1615 * Rewind the current tracefile to the position at which the rotation
1616 * should have occured.
1618 lseek_ret
= lseek(stream
->stream_fd
->fd
,
1619 stream
->pos_after_last_complete_data_index
, SEEK_SET
);
1620 if (lseek_ret
< 0) {
1621 PERROR("seek truncate stream");
1626 /* Move data from the old file to the new file. */
1627 while (pos
< diff
) {
1628 uint64_t count
, bytes_left
;
1631 bytes_left
= diff
- pos
;
1632 count
= bytes_left
> sizeof(buf
) ? sizeof(buf
) : bytes_left
;
1633 assert(count
<= SIZE_MAX
);
1635 io_ret
= lttng_read(stream
->stream_fd
->fd
, buf
, count
);
1636 if (io_ret
< (ssize_t
) count
) {
1637 char error_string
[256];
1639 snprintf(error_string
, sizeof(error_string
),
1640 "Failed to read %" PRIu64
" bytes from fd %i in rotate_truncate_stream(), returned %zi",
1641 count
, stream
->stream_fd
->fd
, io_ret
);
1643 PERROR("%s", error_string
);
1645 ERR("%s", error_string
);
1651 io_ret
= lttng_write(new_fd
, buf
, count
);
1652 if (io_ret
< (ssize_t
) count
) {
1653 char error_string
[256];
1655 snprintf(error_string
, sizeof(error_string
),
1656 "Failed to write %" PRIu64
" bytes from fd %i in rotate_truncate_stream(), returned %zi",
1657 count
, new_fd
, io_ret
);
1659 PERROR("%s", error_string
);
1661 ERR("%s", error_string
);
1670 /* Truncate the file to get rid of the excess data. */
1671 ret
= ftruncate(stream
->stream_fd
->fd
,
1672 stream
->pos_after_last_complete_data_index
);
1674 PERROR("ftruncate");
1678 ret
= close(stream
->stream_fd
->fd
);
1680 PERROR("Closing tracefile");
1684 ret
= create_rotate_index_file(stream
);
1686 ERR("Rotate stream index file");
1691 * Update the offset and FD of all the eventual indexes created by the
1692 * data connection before the rotation command arrived.
1694 ret
= relay_index_switch_all_files(stream
);
1696 ERR("Failed to rotate index file");
1700 stream
->stream_fd
->fd
= new_fd
;
1701 stream
->tracefile_size_current
= diff
;
1702 stream
->pos_after_last_complete_data_index
= 0;
1703 stream
->rotate_at_seq_num
= -1ULL;
1712 * Check if a stream should perform a rotation (for session rotation).
1713 * Must be called with the stream lock held.
1715 * Return 0 on success, a negative value on error.
1718 int try_rotate_stream(struct relay_stream
*stream
)
1722 /* No rotation expected. */
1723 if (stream
->rotate_at_seq_num
== -1ULL) {
1727 if (stream
->prev_seq
< stream
->rotate_at_seq_num
||
1728 stream
->prev_seq
== -1ULL) {
1729 DBG("Stream %" PRIu64
" no yet ready for rotation",
1730 stream
->stream_handle
);
1732 } else if (stream
->prev_seq
> stream
->rotate_at_seq_num
) {
1733 DBG("Rotation after too much data has been written in tracefile "
1734 "for stream %" PRIu64
", need to truncate before "
1735 "rotating", stream
->stream_handle
);
1736 ret
= rotate_truncate_stream(stream
);
1738 ERR("Failed to truncate stream");
1742 /* stream->prev_seq == stream->rotate_at_seq_num */
1743 DBG("Stream %" PRIu64
" ready for rotation",
1744 stream
->stream_handle
);
1745 ret
= do_rotate_stream(stream
);
1753 * relay_recv_metadata: receive the metadata for the session.
1755 static int relay_recv_metadata(struct lttcomm_relayd_hdr
*recv_hdr
,
1756 struct relay_connection
*conn
)
1760 struct relay_session
*session
= conn
->session
;
1761 struct lttcomm_relayd_metadata_payload
*metadata_struct
;
1762 struct relay_stream
*metadata_stream
;
1763 uint64_t data_size
, payload_size
;
1766 ERR("Metadata sent before version check");
1771 data_size
= payload_size
= be64toh(recv_hdr
->data_size
);
1772 if (data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1773 ERR("Incorrect data size");
1777 payload_size
-= sizeof(struct lttcomm_relayd_metadata_payload
);
1779 if (data_buffer_size
< data_size
) {
1780 /* In case the realloc fails, we can free the memory */
1783 tmp_data_ptr
= realloc(data_buffer
, data_size
);
1784 if (!tmp_data_ptr
) {
1785 ERR("Allocating data buffer");
1790 data_buffer
= tmp_data_ptr
;
1791 data_buffer_size
= data_size
;
1793 memset(data_buffer
, 0, data_size
);
1794 DBG2("Relay receiving metadata, waiting for %" PRIu64
" bytes", data_size
);
1795 size_ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
1796 if (size_ret
< 0 || size_ret
!= data_size
) {
1797 if (size_ret
== 0) {
1798 /* Orderly shutdown. Not necessary to print an error. */
1799 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1801 ERR("Relay didn't receive the whole metadata");
1806 metadata_struct
= (struct lttcomm_relayd_metadata_payload
*) data_buffer
;
1808 metadata_stream
= stream_get_by_id(be64toh(metadata_struct
->stream_id
));
1809 if (!metadata_stream
) {
1814 pthread_mutex_lock(&metadata_stream
->lock
);
1816 size_ret
= lttng_write(metadata_stream
->stream_fd
->fd
, metadata_struct
->payload
,
1818 if (size_ret
< payload_size
) {
1819 ERR("Relay error writing metadata on file");
1824 size_ret
= write_padding_to_file(metadata_stream
->stream_fd
->fd
,
1825 be32toh(metadata_struct
->padding_size
));
1830 metadata_stream
->metadata_received
+=
1831 payload_size
+ be32toh(metadata_struct
->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(struct lttcomm_relayd_hdr
*recv_hdr
,
1851 struct relay_connection
*conn
)
1854 struct lttcomm_relayd_version reply
, msg
;
1855 bool compatible
= true;
1857 conn
->version_check_done
= 1;
1859 /* Get version from the other side. */
1860 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1861 if (ret
< 0 || ret
!= sizeof(msg
)) {
1863 /* Orderly shutdown. Not necessary to print an error. */
1864 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1866 ERR("Relay failed to receive the version values.");
1872 memset(&reply
, 0, sizeof(reply
));
1873 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
1874 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
1876 /* Major versions must be the same */
1877 if (reply
.major
!= be32toh(msg
.major
)) {
1878 DBG("Incompatible major versions (%u vs %u), deleting session",
1879 reply
.major
, be32toh(msg
.major
));
1883 conn
->major
= reply
.major
;
1884 /* We adapt to the lowest compatible version */
1885 if (reply
.minor
<= be32toh(msg
.minor
)) {
1886 conn
->minor
= reply
.minor
;
1888 conn
->minor
= be32toh(msg
.minor
);
1891 reply
.major
= htobe32(reply
.major
);
1892 reply
.minor
= htobe32(reply
.minor
);
1893 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1894 sizeof(struct lttcomm_relayd_version
), 0);
1896 ERR("Relay sending version");
1904 DBG("Version check done using protocol %u.%u", conn
->major
,
1912 * Check for data pending for a given stream id from the session daemon.
1914 static int relay_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1915 struct relay_connection
*conn
)
1917 struct relay_session
*session
= conn
->session
;
1918 struct lttcomm_relayd_data_pending msg
;
1919 struct lttcomm_relayd_generic_reply reply
;
1920 struct relay_stream
*stream
;
1922 uint64_t last_net_seq_num
, stream_id
;
1924 DBG("Data pending command received");
1926 if (!session
|| conn
->version_check_done
== 0) {
1927 ERR("Trying to check for data before version check");
1929 goto end_no_session
;
1932 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1933 if (ret
< sizeof(msg
)) {
1935 /* Orderly shutdown. Not necessary to print an error. */
1936 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1938 ERR("Relay didn't receive valid data_pending struct size : %d",
1942 goto end_no_session
;
1945 stream_id
= be64toh(msg
.stream_id
);
1946 last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
1948 stream
= stream_get_by_id(stream_id
);
1949 if (stream
== NULL
) {
1954 pthread_mutex_lock(&stream
->lock
);
1956 DBG("Data pending for stream id %" PRIu64
" prev_seq %" PRIu64
1957 " and last_seq %" PRIu64
, stream_id
, stream
->prev_seq
,
1960 /* Avoid wrapping issue */
1961 if (((int64_t) (stream
->prev_seq
- last_net_seq_num
)) >= 0) {
1962 /* Data has in fact been written and is NOT pending */
1965 /* Data still being streamed thus pending */
1969 stream
->data_pending_check_done
= true;
1970 pthread_mutex_unlock(&stream
->lock
);
1975 memset(&reply
, 0, sizeof(reply
));
1976 reply
.ret_code
= htobe32(ret
);
1977 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1979 ERR("Relay data pending ret code failed");
1987 * Wait for the control socket to reach a quiescent state.
1989 * Note that for now, when receiving this command from the session
1990 * daemon, this means that every subsequent commands or data received on
1991 * the control socket has been handled. So, this is why we simply return
1994 static int relay_quiescent_control(struct lttcomm_relayd_hdr
*recv_hdr
,
1995 struct relay_connection
*conn
)
1999 struct relay_stream
*stream
;
2000 struct lttcomm_relayd_quiescent_control msg
;
2001 struct lttcomm_relayd_generic_reply reply
;
2003 DBG("Checking quiescent state on control socket");
2005 if (!conn
->session
|| conn
->version_check_done
== 0) {
2006 ERR("Trying to check for data before version check");
2008 goto end_no_session
;
2011 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
2012 if (ret
< sizeof(msg
)) {
2014 /* Orderly shutdown. Not necessary to print an error. */
2015 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2017 ERR("Relay didn't receive valid begin data_pending struct size: %d",
2021 goto end_no_session
;
2024 stream_id
= be64toh(msg
.stream_id
);
2025 stream
= stream_get_by_id(stream_id
);
2029 pthread_mutex_lock(&stream
->lock
);
2030 stream
->data_pending_check_done
= true;
2031 pthread_mutex_unlock(&stream
->lock
);
2032 DBG("Relay quiescent control pending flag set to %" PRIu64
, stream_id
);
2035 memset(&reply
, 0, sizeof(reply
));
2036 reply
.ret_code
= htobe32(LTTNG_OK
);
2037 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2039 ERR("Relay data quiescent control ret code failed");
2047 * Initialize a data pending command. This means that a consumer is about
2048 * to ask for data pending for each stream it holds. Simply iterate over
2049 * all streams of a session and set the data_pending_check_done flag.
2051 * This command returns to the client a LTTNG_OK code.
2053 static int relay_begin_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
2054 struct relay_connection
*conn
)
2057 struct lttng_ht_iter iter
;
2058 struct lttcomm_relayd_begin_data_pending msg
;
2059 struct lttcomm_relayd_generic_reply reply
;
2060 struct relay_stream
*stream
;
2061 uint64_t session_id
;
2066 DBG("Init streams for data pending");
2068 if (!conn
->session
|| conn
->version_check_done
== 0) {
2069 ERR("Trying to check for data before version check");
2071 goto end_no_session
;
2074 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
2075 if (ret
< sizeof(msg
)) {
2077 /* Orderly shutdown. Not necessary to print an error. */
2078 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2080 ERR("Relay didn't receive valid begin data_pending struct size: %d",
2084 goto end_no_session
;
2087 session_id
= be64toh(msg
.session_id
);
2090 * Iterate over all streams to set the begin data pending flag.
2091 * For now, the streams are indexed by stream handle so we have
2092 * to iterate over all streams to find the one associated with
2093 * the right session_id.
2096 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2098 if (!stream_get(stream
)) {
2101 if (stream
->trace
->session
->id
== session_id
) {
2102 pthread_mutex_lock(&stream
->lock
);
2103 stream
->data_pending_check_done
= false;
2104 pthread_mutex_unlock(&stream
->lock
);
2105 DBG("Set begin data pending flag to stream %" PRIu64
,
2106 stream
->stream_handle
);
2112 memset(&reply
, 0, sizeof(reply
));
2113 /* All good, send back reply. */
2114 reply
.ret_code
= htobe32(LTTNG_OK
);
2116 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2118 ERR("Relay begin data pending send reply failed");
2126 * End data pending command. This will check, for a given session id, if
2127 * each stream associated with it has its data_pending_check_done flag
2128 * set. If not, this means that the client lost track of the stream but
2129 * the data is still being streamed on our side. In this case, we inform
2130 * the client that data is in flight.
2132 * Return to the client if there is data in flight or not with a ret_code.
2134 static int relay_end_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
2135 struct relay_connection
*conn
)
2138 struct lttng_ht_iter iter
;
2139 struct lttcomm_relayd_end_data_pending msg
;
2140 struct lttcomm_relayd_generic_reply reply
;
2141 struct relay_stream
*stream
;
2142 uint64_t session_id
;
2143 uint32_t is_data_inflight
= 0;
2145 DBG("End data pending command");
2147 if (!conn
->session
|| conn
->version_check_done
== 0) {
2148 ERR("Trying to check for data before version check");
2150 goto end_no_session
;
2153 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
2154 if (ret
< sizeof(msg
)) {
2156 /* Orderly shutdown. Not necessary to print an error. */
2157 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2159 ERR("Relay didn't receive valid end data_pending struct size: %d",
2163 goto end_no_session
;
2166 session_id
= be64toh(msg
.session_id
);
2169 * Iterate over all streams to see if the begin data pending
2173 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2175 if (!stream_get(stream
)) {
2178 if (stream
->trace
->session
->id
!= session_id
) {
2182 pthread_mutex_lock(&stream
->lock
);
2183 if (!stream
->data_pending_check_done
) {
2184 if (!stream
->closed
|| !(((int64_t) (stream
->prev_seq
- stream
->last_net_seq_num
)) >= 0)) {
2185 is_data_inflight
= 1;
2186 DBG("Data is still in flight for stream %" PRIu64
,
2187 stream
->stream_handle
);
2188 pthread_mutex_unlock(&stream
->lock
);
2193 pthread_mutex_unlock(&stream
->lock
);
2198 memset(&reply
, 0, sizeof(reply
));
2199 /* All good, send back reply. */
2200 reply
.ret_code
= htobe32(is_data_inflight
);
2202 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2204 ERR("Relay end data pending send reply failed");
2212 * Receive an index for a specific stream.
2214 * Return 0 on success else a negative value.
2216 static int relay_recv_index(struct lttcomm_relayd_hdr
*recv_hdr
,
2217 struct relay_connection
*conn
)
2220 struct relay_session
*session
= conn
->session
;
2221 struct lttcomm_relayd_index index_info
;
2222 struct relay_index
*index
;
2223 struct lttcomm_relayd_generic_reply reply
;
2224 struct relay_stream
*stream
;
2225 uint64_t net_seq_num
;
2230 DBG("Relay receiving index");
2232 if (!session
|| conn
->version_check_done
== 0) {
2233 ERR("Trying to close a stream before version check");
2235 goto end_no_session
;
2238 msg_len
= lttcomm_relayd_index_len(
2239 lttng_to_index_major(conn
->major
, conn
->minor
),
2240 lttng_to_index_minor(conn
->major
, conn
->minor
));
2241 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &index_info
,
2243 if (ret
< msg_len
) {
2245 /* Orderly shutdown. Not necessary to print an error. */
2246 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2248 ERR("Relay didn't receive valid index struct size : %d", ret
);
2251 goto end_no_session
;
2254 net_seq_num
= be64toh(index_info
.net_seq_num
);
2256 stream
= stream_get_by_id(be64toh(index_info
.relay_stream_id
));
2258 ERR("stream_get_by_id not found");
2262 pthread_mutex_lock(&stream
->lock
);
2264 /* Live beacon handling */
2265 if (index_info
.packet_size
== 0) {
2266 DBG("Received live beacon for stream %" PRIu64
,
2267 stream
->stream_handle
);
2270 * Only flag a stream inactive when it has already
2271 * received data and no indexes are in flight.
2273 if (stream
->index_received_seqcount
> 0
2274 && stream
->indexes_in_flight
== 0) {
2275 stream
->beacon_ts_end
=
2276 be64toh(index_info
.timestamp_end
);
2279 goto end_stream_put
;
2281 stream
->beacon_ts_end
= -1ULL;
2284 if (stream
->ctf_stream_id
== -1ULL) {
2285 stream
->ctf_stream_id
= be64toh(index_info
.stream_id
);
2287 index
= relay_index_get_by_id_or_create(stream
, net_seq_num
);
2290 ERR("relay_index_get_by_id_or_create index NULL");
2291 goto end_stream_put
;
2293 if (set_index_control_data(index
, &index_info
, conn
)) {
2294 ERR("set_index_control_data error");
2295 relay_index_put(index
);
2297 goto end_stream_put
;
2299 ret
= relay_index_try_flush(index
);
2301 tracefile_array_commit_seq(stream
->tfa
);
2302 stream
->index_received_seqcount
++;
2303 stream
->pos_after_last_complete_data_index
+= index
->total_size
;
2304 } else if (ret
> 0) {
2308 ERR("relay_index_try_flush error %d", ret
);
2309 relay_index_put(index
);
2314 pthread_mutex_unlock(&stream
->lock
);
2319 memset(&reply
, 0, sizeof(reply
));
2321 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2323 reply
.ret_code
= htobe32(LTTNG_OK
);
2325 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2327 ERR("Relay sending close index id reply");
2336 * Receive the streams_sent message.
2338 * Return 0 on success else a negative value.
2340 static int relay_streams_sent(struct lttcomm_relayd_hdr
*recv_hdr
,
2341 struct relay_connection
*conn
)
2344 struct lttcomm_relayd_generic_reply reply
;
2348 DBG("Relay receiving streams_sent");
2350 if (!conn
->session
|| conn
->version_check_done
== 0) {
2351 ERR("Trying to close a stream before version check");
2353 goto end_no_session
;
2357 * Publish every pending stream in the connection recv list which are
2358 * now ready to be used by the viewer.
2360 publish_connection_local_streams(conn
);
2362 memset(&reply
, 0, sizeof(reply
));
2363 reply
.ret_code
= htobe32(LTTNG_OK
);
2364 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2366 ERR("Relay sending sent_stream reply");
2378 * relay_rotate_stream: rotate a stream to a new tracefile for the session
2379 * rotation feature (not the tracefile rotation feature).
2381 static int relay_rotate_session_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
2382 struct relay_connection
*conn
)
2385 struct relay_session
*session
= conn
->session
;
2386 struct lttcomm_relayd_rotate_stream stream_info
;
2387 struct lttcomm_relayd_generic_reply reply
;
2388 struct relay_stream
*stream
;
2390 char *new_pathname
= NULL
;
2392 DBG("Rotate stream received");
2394 if (!session
|| !conn
->version_check_done
) {
2395 ERR("Trying to rotate a stream before version check");
2400 if (session
->major
== 2 && session
->minor
< 11) {
2401 ERR("Unsupported feature before 2.11");
2406 memset(&stream_info
, 0, sizeof(struct lttcomm_relayd_rotate_stream
));
2409 * Receive the struct up to the new_pathname member since we don't know
2412 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &stream_info
,
2413 sizeof(struct lttcomm_relayd_rotate_stream
), 0);
2414 if (ret
< sizeof(struct lttcomm_relayd_rotate_stream
)) {
2416 /* Orderly shutdown. Not necessary to print an error. */
2417 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2419 ERR("Relay didn't receive valid rotate_stream struct size : %d", ret
);
2425 stream
= stream_get_by_id(be64toh(stream_info
.stream_id
));
2431 len
= be32toh(stream_info
.pathname_length
);
2432 /* Ensure it fits in local filename length. */
2433 if (len
>= LTTNG_PATH_MAX
) {
2434 ret
= -ENAMETOOLONG
;
2435 ERR("Length of relay_rotate_session_stream command's path name (%zu bytes) exceeds the maximal allowed length of %i bytes",
2436 len
, LTTNG_PATH_MAX
);
2440 new_pathname
= zmalloc(len
);
2441 if (!new_pathname
) {
2442 PERROR("Failed to allocation new path name of relay_rotate_session_stream command");
2447 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, new_pathname
, len
, 0);
2450 /* Orderly shutdown. Not necessary to print an error. */
2451 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2453 ERR("Relay didn't receive valid rotate_stream struct size : %d", ret
);
2459 pthread_mutex_lock(&stream
->lock
);
2462 * Update the trace path (just the folder, the stream name does not
2465 free(stream
->path_name
);
2466 stream
->path_name
= create_output_path(new_pathname
);
2467 if (!stream
->path_name
) {
2468 ERR("Failed to create a new output path");
2469 goto end_stream_unlock
;
2471 ret
= utils_mkdir_recursive(stream
->path_name
, S_IRWXU
| S_IRWXG
,
2474 ERR("relay creating output directory");
2475 goto end_stream_unlock
;
2477 stream
->chunk_id
= be64toh(stream_info
.new_chunk_id
);
2479 if (stream
->is_metadata
) {
2481 * The metadata stream is sent only over the control connection
2482 * so we know we have all the data to perform the stream
2485 ret
= do_rotate_stream(stream
);
2487 stream
->rotate_at_seq_num
= be64toh(stream_info
.rotate_at_seq_num
);
2488 ret
= try_rotate_stream(stream
);
2491 goto end_stream_unlock
;
2495 pthread_mutex_unlock(&stream
->lock
);
2498 memset(&reply
, 0, sizeof(reply
));
2500 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2502 reply
.ret_code
= htobe32(LTTNG_OK
);
2504 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2505 sizeof(struct lttcomm_relayd_generic_reply
), 0);
2507 ERR("Failed to send reply of rotate session stream command");
2517 * relay_mkdir: Create a folder on the disk.
2519 static int relay_mkdir(struct lttcomm_relayd_hdr
*recv_hdr
,
2520 struct relay_connection
*conn
)
2523 ssize_t network_ret
;
2524 struct relay_session
*session
= conn
->session
;
2525 struct lttcomm_relayd_mkdir path_info_header
;
2526 struct lttcomm_relayd_mkdir
*path_info
= NULL
;
2527 struct lttcomm_relayd_generic_reply reply
;
2530 if (!session
|| !conn
->version_check_done
) {
2531 ERR("Trying to create a directory before version check");
2533 goto end_no_session
;
2536 if (session
->major
== 2 && session
->minor
< 11) {
2538 * This client is not supposed to use this command since
2539 * it predates its introduction.
2541 ERR("relay_mkdir command is unsupported before LTTng 2.11");
2543 goto end_no_session
;
2546 network_ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &path_info_header
,
2547 sizeof(path_info_header
), 0);
2548 if (network_ret
< (ssize_t
) sizeof(path_info_header
)) {
2549 if (network_ret
== 0) {
2550 /* Orderly shutdown. Not necessary to print an error. */
2551 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2553 ERR("Reception of mkdir command argument length failed with ret = %zi, expected %zu",
2554 network_ret
, sizeof(path_info_header
));
2557 goto end_no_session
;
2560 path_info_header
.length
= be32toh(path_info_header
.length
);
2562 /* Ensure that it fits in local path length. */
2563 if (path_info_header
.length
>= LTTNG_PATH_MAX
) {
2564 ret
= -ENAMETOOLONG
;
2565 ERR("Path name argument of mkdir command (%" PRIu32
" bytes) exceeds the maximal length allowed (%d bytes)",
2566 path_info_header
.length
, LTTNG_PATH_MAX
);
2570 path_info
= zmalloc(sizeof(path_info_header
) + path_info_header
.length
);
2572 PERROR("zmalloc of mkdir command path");
2577 network_ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, path_info
->path
,
2578 path_info_header
.length
, 0);
2579 if (network_ret
< (ssize_t
) path_info_header
.length
) {
2580 if (network_ret
== 0) {
2581 /* Orderly shutdown. Not necessary to print an error. */
2582 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2584 ERR("Reception of mkdir path argument failed with ret = %zi, expected %" PRIu32
,
2585 network_ret
, path_info_header
.length
);
2588 goto end_no_session
;
2591 path
= create_output_path(path_info
->path
);
2593 ERR("Failed to create output path");
2598 ret
= utils_mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, -1, -1);
2600 ERR("relay creating output directory");
2607 memset(&reply
, 0, sizeof(reply
));
2609 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2611 reply
.ret_code
= htobe32(LTTNG_OK
);
2613 network_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2614 sizeof(struct lttcomm_relayd_generic_reply
), 0);
2615 if (network_ret
< (ssize_t
) sizeof(struct lttcomm_relayd_generic_reply
)) {
2616 ERR("Failed to send mkdir command status code with ret = %zi, expected %zu",
2618 sizeof(struct lttcomm_relayd_generic_reply
));
2628 static int validate_rotate_rename_path_length(const char *path_type
,
2629 uint32_t path_length
)
2633 if (path_length
> LTTNG_PATH_MAX
) {
2634 ret
= -ENAMETOOLONG
;
2635 ERR("rotate rename \"%s\" path name length (%" PRIu32
" bytes) exceeds the allowed size of %i bytes",
2636 path_type
, path_length
, LTTNG_PATH_MAX
);
2637 } else if (path_length
== 0) {
2639 ERR("rotate rename \"%s\" path name has an illegal length of 0", path_type
);
2645 * relay_rotate_rename: rename the trace folder after a rotation is
2646 * completed. We are not closing any fd here, just moving the folder, so it
2647 * works even if data is still in-flight.
2649 static int relay_rotate_rename(struct lttcomm_relayd_hdr
*recv_hdr
,
2650 struct relay_connection
*conn
)
2653 ssize_t network_ret
;
2654 struct relay_session
*session
= conn
->session
;
2655 struct lttcomm_relayd_generic_reply reply
;
2656 struct lttcomm_relayd_rotate_rename header
;
2657 char *received_paths
= NULL
;
2658 size_t received_paths_size
;
2659 const char *received_old_path
, *received_new_path
;
2660 char *complete_old_path
= NULL
, *complete_new_path
= NULL
;
2662 if (!session
|| !conn
->version_check_done
) {
2663 ERR("Trying to rename a trace folder before version check");
2668 if (session
->major
== 2 && session
->minor
< 11) {
2669 ERR("relay_rotate_rename command is unsupported before LTTng 2.11");
2674 network_ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &header
,
2676 if (network_ret
< (ssize_t
) sizeof(header
)) {
2677 if (network_ret
== 0) {
2678 /* Orderly shutdown. Not necessary to print an error. */
2679 DBG("Socket %d did an orderly shutdown",
2682 ERR("Relay didn't receive a valid rotate_rename command header: expected %zu bytes, recvmsg() returned %zi",
2683 sizeof(header
), network_ret
);
2689 header
.old_path_length
= be32toh(header
.old_path_length
);
2690 header
.new_path_length
= be32toh(header
.new_path_length
);
2691 received_paths_size
= header
.old_path_length
+ header
.new_path_length
;
2693 /* Ensure the paths don't exceed their allowed size. */
2694 ret
= validate_rotate_rename_path_length("old", header
.old_path_length
);
2698 ret
= validate_rotate_rename_path_length("new", header
.new_path_length
);
2703 received_paths
= zmalloc(received_paths_size
);
2704 if (!received_paths
) {
2705 PERROR("Could not allocate rotate commands paths reception buffer");
2710 network_ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, received_paths
,
2711 received_paths_size
, 0);
2712 if (network_ret
< (ssize_t
) received_paths_size
) {
2713 if (network_ret
== 0) {
2714 /* Orderly shutdown. Not necessary to print an error. */
2715 DBG("Socket %d did an orderly shutdown",
2718 ERR("Relay failed to received rename command paths (%zu bytes): recvmsg() returned %zi",
2719 received_paths_size
, network_ret
);
2725 /* Validate that both paths received are NULL terminated. */
2726 if (received_paths
[header
.old_path_length
- 1] != '\0') {
2727 ERR("relay_rotate_rename command's \"old\" path is invalid (not NULL terminated)");
2731 if (received_paths
[received_paths_size
- 1] != '\0') {
2732 ERR("relay_rotate_rename command's \"new\" path is invalid (not NULL terminated)");
2737 received_old_path
= received_paths
;
2738 received_new_path
= received_paths
+ header
.old_path_length
;
2740 complete_old_path
= create_output_path(received_old_path
);
2741 if (!complete_old_path
) {
2742 ERR("Failed to build old output path in rotate_rename command");
2747 complete_new_path
= create_output_path(received_new_path
);
2748 if (!complete_new_path
) {
2749 ERR("Failed to build new output path in rotate_rename command");
2754 ret
= utils_mkdir_recursive(complete_new_path
, S_IRWXU
| S_IRWXG
,
2757 ERR("Failed to mkdir() rotate_rename's \"new\" output directory at \"%s\"",
2763 * If a domain has not yet created its channel, the domain-specific
2764 * folder might not exist, but this is not an error.
2766 ret
= rename(complete_old_path
, complete_new_path
);
2767 if (ret
< 0 && errno
!= ENOENT
) {
2768 PERROR("Renaming chunk in rotate_rename command from \"%s\" to \"%s\"",
2769 complete_old_path
, complete_new_path
);
2775 memset(&reply
, 0, sizeof(reply
));
2777 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2779 reply
.ret_code
= htobe32(LTTNG_OK
);
2781 network_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2782 sizeof(struct lttcomm_relayd_generic_reply
), 0);
2783 if (network_ret
< sizeof(struct lttcomm_relayd_generic_reply
)) {
2784 ERR("Relay sending stream id");
2789 free(received_paths
);
2790 free(complete_old_path
);
2791 free(complete_new_path
);
2796 * Check if all the streams in the session have completed the last rotation.
2797 * The chunk_id value is used to distinguish the cases where a stream was
2798 * closed on the consumerd before the rotation started but it still active on
2799 * the relayd, and the case where a stream appeared on the consumerd/relayd
2800 * after the last rotation started (in that case, it is already writing in the
2801 * new chunk folder).
2804 int relay_rotate_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
2805 struct relay_connection
*conn
)
2807 struct relay_session
*session
= conn
->session
;
2808 struct lttcomm_relayd_rotate_pending msg
;
2809 struct lttcomm_relayd_rotate_pending_reply reply
;
2810 struct lttng_ht_iter iter
;
2811 struct relay_stream
*stream
;
2813 ssize_t network_ret
;
2815 bool rotate_pending
= false;
2817 DBG("Rotate pending command received");
2819 if (!session
|| !conn
->version_check_done
) {
2820 ERR("Trying to check for data before version check");
2825 if (session
->major
== 2 && session
->minor
< 11) {
2826 ERR("Unsupported feature before 2.11");
2831 network_ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
2832 if (network_ret
< (ssize_t
) sizeof(msg
)) {
2833 if (network_ret
== 0) {
2834 /* Orderly shutdown. Not necessary to print an error. */
2835 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2837 ERR("Relay didn't receive valid rotate_pending struct size : %zi",
2844 chunk_id
= be64toh(msg
.chunk_id
);
2845 DBG("Evaluating rotate pending for chunk id %" PRIu64
, chunk_id
);
2848 * Iterate over all the streams in the session and check if they are
2849 * still waiting for data to perform their rotation.
2852 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2854 if (!stream_get(stream
)) {
2857 if (stream
->trace
->session
!= session
) {
2861 pthread_mutex_lock(&stream
->lock
);
2862 if (stream
->rotate_at_seq_num
!= -1ULL) {
2863 /* We have not yet performed the rotation. */
2864 rotate_pending
= true;
2865 DBG("Stream %" PRIu64
" is still rotating",
2866 stream
->stream_handle
);
2867 } else if (stream
->chunk_id
< chunk_id
) {
2869 * Stream closed on the consumer but still active on the
2872 rotate_pending
= true;
2873 DBG("Stream %" PRIu64
" did not exist on the consumer "
2874 "when the last rotation started, but is"
2875 "still waiting for data before getting"
2877 stream
->stream_handle
);
2879 pthread_mutex_unlock(&stream
->lock
);
2881 if (rotate_pending
) {
2888 memset(&reply
, 0, sizeof(reply
));
2889 reply
.generic
.ret_code
= htobe32((uint32_t) LTTNG_OK
);
2890 reply
.is_pending
= (uint8_t) !!rotate_pending
;
2891 network_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2893 if (network_ret
< (ssize_t
) sizeof(reply
)) {
2894 ERR("Relay rotate pending ret code failed");
2903 * Process the commands received on the control socket
2905 static int relay_process_control(struct lttcomm_relayd_hdr
*recv_hdr
,
2906 struct relay_connection
*conn
)
2910 switch (be32toh(recv_hdr
->cmd
)) {
2911 case RELAYD_CREATE_SESSION
:
2912 ret
= relay_create_session(recv_hdr
, conn
);
2914 case RELAYD_ADD_STREAM
:
2915 ret
= relay_add_stream(recv_hdr
, conn
);
2917 case RELAYD_START_DATA
:
2918 ret
= relay_start(recv_hdr
, conn
);
2920 case RELAYD_SEND_METADATA
:
2921 ret
= relay_recv_metadata(recv_hdr
, conn
);
2923 case RELAYD_VERSION
:
2924 ret
= relay_send_version(recv_hdr
, conn
);
2926 case RELAYD_CLOSE_STREAM
:
2927 ret
= relay_close_stream(recv_hdr
, conn
);
2929 case RELAYD_DATA_PENDING
:
2930 ret
= relay_data_pending(recv_hdr
, conn
);
2932 case RELAYD_QUIESCENT_CONTROL
:
2933 ret
= relay_quiescent_control(recv_hdr
, conn
);
2935 case RELAYD_BEGIN_DATA_PENDING
:
2936 ret
= relay_begin_data_pending(recv_hdr
, conn
);
2938 case RELAYD_END_DATA_PENDING
:
2939 ret
= relay_end_data_pending(recv_hdr
, conn
);
2941 case RELAYD_SEND_INDEX
:
2942 ret
= relay_recv_index(recv_hdr
, conn
);
2944 case RELAYD_STREAMS_SENT
:
2945 ret
= relay_streams_sent(recv_hdr
, conn
);
2947 case RELAYD_RESET_METADATA
:
2948 ret
= relay_reset_metadata(recv_hdr
, conn
);
2950 case RELAYD_ROTATE_STREAM
:
2951 ret
= relay_rotate_session_stream(recv_hdr
, conn
);
2953 case RELAYD_ROTATE_RENAME
:
2954 ret
= relay_rotate_rename(recv_hdr
, conn
);
2956 case RELAYD_ROTATE_PENDING
:
2957 ret
= relay_rotate_pending(recv_hdr
, conn
);
2960 ret
= relay_mkdir(recv_hdr
, conn
);
2962 case RELAYD_UPDATE_SYNC_INFO
:
2964 ERR("Received unknown command (%u)", be32toh(recv_hdr
->cmd
));
2965 relay_unknown_command(conn
);
2975 * Handle index for a data stream.
2977 * Called with the stream lock held.
2979 * Return 0 on success else a negative value.
2981 static int handle_index_data(struct relay_stream
*stream
, uint64_t net_seq_num
,
2982 int rotate_index
, bool *flushed
, uint64_t total_size
)
2985 uint64_t data_offset
;
2986 struct relay_index
*index
;
2988 /* Get data offset because we are about to update the index. */
2989 data_offset
= htobe64(stream
->tracefile_size_current
);
2991 DBG("handle_index_data: stream %" PRIu64
" net_seq_num %" PRIu64
" data offset %" PRIu64
,
2992 stream
->stream_handle
, net_seq_num
, stream
->tracefile_size_current
);
2995 * Lookup for an existing index for that stream id/sequence
2996 * number. If it exists, the control thread has already received the
2997 * data for it, thus we need to write it to disk.
2999 index
= relay_index_get_by_id_or_create(stream
, net_seq_num
);
3005 if (rotate_index
|| !stream
->index_file
) {
3006 ret
= create_rotate_index_file(stream
);
3008 ERR("Failed to rotate index");
3009 /* Put self-ref for this index due to error. */
3010 relay_index_put(index
);
3016 if (relay_index_set_file(index
, stream
->index_file
, data_offset
)) {
3018 /* Put self-ref for this index due to error. */
3019 relay_index_put(index
);
3024 ret
= relay_index_try_flush(index
);
3026 tracefile_array_commit_seq(stream
->tfa
);
3027 stream
->index_received_seqcount
++;
3029 } else if (ret
> 0) {
3030 index
->total_size
= total_size
;
3034 /* Put self-ref for this index due to error. */
3035 relay_index_put(index
);
3044 * relay_process_data: Process the data received on the data socket
3046 static int relay_process_data(struct relay_connection
*conn
)
3048 int ret
= 0, rotate_index
= 0;
3050 struct relay_stream
*stream
;
3051 struct lttcomm_relayd_data_hdr data_hdr
;
3053 uint64_t net_seq_num
;
3055 struct relay_session
*session
;
3056 bool new_stream
= false, close_requested
= false;
3057 size_t chunk_size
= RECV_DATA_BUFFER_SIZE
;
3058 size_t recv_off
= 0;
3059 char data_buffer
[chunk_size
];
3060 bool index_flushed
= false;
3062 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &data_hdr
,
3063 sizeof(struct lttcomm_relayd_data_hdr
), 0);
3066 /* Orderly shutdown. Not necessary to print an error. */
3067 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
3069 ERR("Unable to receive data header on sock %d", conn
->sock
->fd
);
3075 stream_id
= be64toh(data_hdr
.stream_id
);
3076 stream
= stream_get_by_id(stream_id
);
3078 ERR("relay_process_data: Cannot find stream %" PRIu64
, stream_id
);
3082 session
= stream
->trace
->session
;
3083 data_size
= be32toh(data_hdr
.data_size
);
3085 net_seq_num
= be64toh(data_hdr
.net_seq_num
);
3087 DBG3("Receiving data of size %u for stream id %" PRIu64
" seqnum %" PRIu64
,
3088 data_size
, stream_id
, net_seq_num
);
3090 pthread_mutex_lock(&stream
->lock
);
3092 /* Check if a rotation is needed. */
3093 if (stream
->tracefile_size
> 0 &&
3094 (stream
->tracefile_size_current
+ data_size
) >
3095 stream
->tracefile_size
) {
3096 uint64_t old_id
, new_id
;
3098 old_id
= tracefile_array_get_file_index_head(stream
->tfa
);
3099 tracefile_array_file_rotate(stream
->tfa
);
3101 /* new_id is updated by utils_rotate_stream_file. */
3104 ret
= utils_rotate_stream_file(stream
->path_name
,
3105 stream
->channel_name
, stream
->tracefile_size
,
3106 stream
->tracefile_count
, -1,
3107 -1, stream
->stream_fd
->fd
,
3108 &new_id
, &stream
->stream_fd
->fd
);
3110 ERR("Rotating stream output file");
3111 goto end_stream_unlock
;
3114 * Reset current size because we just performed a stream
3117 stream
->tracefile_size_current
= 0;
3122 * Index are handled in protocol version 2.4 and above. Also,
3123 * snapshot and index are NOT supported.
3125 if (session
->minor
>= 4 && !session
->snapshot
) {
3126 ret
= handle_index_data(stream
, net_seq_num
, rotate_index
,
3128 data_size
+ be32toh(data_hdr
.padding_size
));
3130 ERR("handle_index_data: fail stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3131 stream
->stream_handle
, net_seq_num
, ret
);
3132 goto end_stream_unlock
;
3136 for (recv_off
= 0; recv_off
< data_size
; recv_off
+= chunk_size
) {
3137 size_t recv_size
= min(data_size
- recv_off
, chunk_size
);
3139 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, recv_size
, 0);
3142 /* Orderly shutdown. Not necessary to print an error. */
3143 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
3145 ERR("Socket %d error %d", conn
->sock
->fd
, ret
);
3148 goto end_stream_unlock
;
3151 /* Write data to stream output fd. */
3152 size_ret
= lttng_write(stream
->stream_fd
->fd
, data_buffer
,
3154 if (size_ret
< recv_size
) {
3155 ERR("Relay error writing data to file");
3157 goto end_stream_unlock
;
3160 DBG2("Relay wrote %zd bytes to tracefile for stream id %" PRIu64
,
3161 size_ret
, stream
->stream_handle
);
3164 ret
= write_padding_to_file(stream
->stream_fd
->fd
,
3165 be32toh(data_hdr
.padding_size
));
3167 ERR("write_padding_to_file: fail stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3168 stream
->stream_handle
, net_seq_num
, ret
);
3169 goto end_stream_unlock
;
3171 stream
->tracefile_size_current
+=
3172 data_size
+ be32toh(data_hdr
.padding_size
);
3173 if (stream
->prev_seq
== -1ULL) {
3176 if (index_flushed
) {
3177 stream
->pos_after_last_complete_data_index
=
3178 stream
->tracefile_size_current
;
3181 stream
->prev_seq
= net_seq_num
;
3183 ret
= try_rotate_stream(stream
);
3185 goto end_stream_unlock
;
3189 close_requested
= stream
->close_requested
;
3190 pthread_mutex_unlock(&stream
->lock
);
3191 if (close_requested
) {
3192 try_stream_close(stream
);
3196 pthread_mutex_lock(&session
->lock
);
3197 uatomic_set(&session
->new_streams
, 1);
3198 pthread_mutex_unlock(&session
->lock
);
3205 static void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
3209 (void) lttng_poll_del(events
, pollfd
);
3211 ret
= close(pollfd
);
3213 ERR("Closing pollfd %d", pollfd
);
3217 static void relay_thread_close_connection(struct lttng_poll_event
*events
,
3218 int pollfd
, struct relay_connection
*conn
)
3220 const char *type_str
;
3222 switch (conn
->type
) {
3227 type_str
= "Control";
3229 case RELAY_VIEWER_COMMAND
:
3230 type_str
= "Viewer Command";
3232 case RELAY_VIEWER_NOTIFICATION
:
3233 type_str
= "Viewer Notification";
3236 type_str
= "Unknown";
3238 cleanup_connection_pollfd(events
, pollfd
);
3239 connection_put(conn
);
3240 DBG("%s connection closed with %d", type_str
, pollfd
);
3244 * This thread does the actual work
3246 static void *relay_thread_worker(void *data
)
3248 int ret
, err
= -1, last_seen_data_fd
= -1;
3250 struct lttng_poll_event events
;
3251 struct lttng_ht
*relay_connections_ht
;
3252 struct lttng_ht_iter iter
;
3253 struct lttcomm_relayd_hdr recv_hdr
;
3254 struct relay_connection
*destroy_conn
= NULL
;
3256 DBG("[thread] Relay worker started");
3258 rcu_register_thread();
3260 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
3262 if (testpoint(relayd_thread_worker
)) {
3263 goto error_testpoint
;
3266 health_code_update();
3268 /* table of connections indexed on socket */
3269 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3270 if (!relay_connections_ht
) {
3271 goto relay_connections_ht_error
;
3274 ret
= create_thread_poll_set(&events
, 2);
3276 goto error_poll_create
;
3279 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
3286 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
3288 health_code_update();
3290 /* Infinite blocking call, waiting for transmission */
3291 DBG3("Relayd worker thread polling...");
3292 health_poll_entry();
3293 ret
= lttng_poll_wait(&events
, -1);
3297 * Restart interrupted system call.
3299 if (errno
== EINTR
) {
3308 * Process control. The control connection is
3309 * prioritized so we don't starve it with high
3310 * throughput tracing data on the data connection.
3312 for (i
= 0; i
< nb_fd
; i
++) {
3313 /* Fetch once the poll data */
3314 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3315 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3317 health_code_update();
3321 * No activity for this FD (poll
3327 /* Thread quit pipe has been closed. Killing thread. */
3328 ret
= check_thread_quit_pipe(pollfd
, revents
);
3334 /* Inspect the relay conn pipe for new connection */
3335 if (pollfd
== relay_conn_pipe
[0]) {
3336 if (revents
& LPOLLIN
) {
3337 struct relay_connection
*conn
;
3339 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
3343 lttng_poll_add(&events
, conn
->sock
->fd
,
3344 LPOLLIN
| LPOLLRDHUP
);
3345 connection_ht_add(relay_connections_ht
, conn
);
3346 DBG("Connection socket %d added", conn
->sock
->fd
);
3347 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3348 ERR("Relay connection pipe error");
3351 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3355 struct relay_connection
*ctrl_conn
;
3357 ctrl_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3358 /* If not found, there is a synchronization issue. */
3361 if (ctrl_conn
->type
== RELAY_DATA
) {
3362 if (revents
& LPOLLIN
) {
3364 * Flag the last seen data fd not deleted. It will be
3365 * used as the last seen fd if any fd gets deleted in
3368 last_notdel_data_fd
= pollfd
;
3370 goto put_ctrl_connection
;
3372 assert(ctrl_conn
->type
== RELAY_CONTROL
);
3374 if (revents
& LPOLLIN
) {
3375 ret
= ctrl_conn
->sock
->ops
->recvmsg(ctrl_conn
->sock
,
3376 &recv_hdr
, sizeof(recv_hdr
), 0);
3378 /* Connection closed */
3379 relay_thread_close_connection(&events
, pollfd
,
3382 ret
= relay_process_control(&recv_hdr
, ctrl_conn
);
3384 /* Clear the session on error. */
3385 relay_thread_close_connection(&events
,
3390 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3391 relay_thread_close_connection(&events
,
3393 if (last_seen_data_fd
== pollfd
) {
3394 last_seen_data_fd
= last_notdel_data_fd
;
3397 ERR("Unexpected poll events %u for control sock %d",
3399 connection_put(ctrl_conn
);
3402 put_ctrl_connection
:
3403 connection_put(ctrl_conn
);
3408 * The last loop handled a control request, go back to poll to make
3409 * sure we prioritise the control socket.
3415 if (last_seen_data_fd
>= 0) {
3416 for (i
= 0; i
< nb_fd
; i
++) {
3417 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3419 health_code_update();
3421 if (last_seen_data_fd
== pollfd
) {
3428 /* Process data connection. */
3429 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
3430 /* Fetch the poll data. */
3431 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3432 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3433 struct relay_connection
*data_conn
;
3435 health_code_update();
3438 /* No activity for this FD (poll implementation). */
3442 /* Skip the command pipe. It's handled in the first loop. */
3443 if (pollfd
== relay_conn_pipe
[0]) {
3447 data_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3449 /* Skip it. Might be removed before. */
3452 if (data_conn
->type
== RELAY_CONTROL
) {
3453 goto put_data_connection
;
3455 assert(data_conn
->type
== RELAY_DATA
);
3457 if (revents
& LPOLLIN
) {
3458 ret
= relay_process_data(data_conn
);
3459 /* Connection closed */
3461 relay_thread_close_connection(&events
, pollfd
,
3464 * Every goto restart call sets the last seen fd where
3465 * here we don't really care since we gracefully
3466 * continue the loop after the connection is deleted.
3469 /* Keep last seen port. */
3470 last_seen_data_fd
= pollfd
;
3471 connection_put(data_conn
);
3474 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3475 relay_thread_close_connection(&events
, pollfd
,
3478 ERR("Unknown poll events %u for data sock %d",
3481 put_data_connection
:
3482 connection_put(data_conn
);
3484 last_seen_data_fd
= -1;
3487 /* Normal exit, no error */
3492 /* Cleanup reamaining connection object. */
3494 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
,
3497 health_code_update();
3499 if (session_abort(destroy_conn
->session
)) {
3504 * No need to grab another ref, because we own
3507 relay_thread_close_connection(&events
, destroy_conn
->sock
->fd
,
3512 lttng_poll_clean(&events
);
3514 lttng_ht_destroy(relay_connections_ht
);
3515 relay_connections_ht_error
:
3516 /* Close relay conn pipes */
3517 utils_close_pipe(relay_conn_pipe
);
3519 DBG("Thread exited with error");
3521 DBG("Worker thread cleanup complete");
3525 ERR("Health error occurred in %s", __func__
);
3527 health_unregister(health_relayd
);
3528 rcu_unregister_thread();
3529 lttng_relay_stop_threads();
3534 * Create the relay command pipe to wake thread_manage_apps.
3535 * Closed in cleanup().
3537 static int create_relay_conn_pipe(void)
3541 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
3549 int main(int argc
, char **argv
)
3551 int ret
= 0, retval
= 0;
3554 /* Parse arguments */
3556 if (set_options(argc
, argv
)) {
3561 if (set_signal_handler()) {
3566 /* Try to create directory if -o, --output is specified. */
3567 if (opt_output_path
) {
3568 if (*opt_output_path
!= '/') {
3569 ERR("Please specify an absolute path for -o, --output PATH");
3574 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
,
3577 ERR("Unable to create %s", opt_output_path
);
3584 if (opt_daemon
|| opt_background
) {
3587 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
3595 * We are in the child. Make sure all other file
3596 * descriptors are closed, in case we are called with
3597 * more opened file descriptors than the standard ones.
3599 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
3604 /* Initialize thread health monitoring */
3605 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
3606 if (!health_relayd
) {
3607 PERROR("health_app_create error");
3609 goto exit_health_app_create
;
3612 /* Create thread quit pipe */
3613 if (init_thread_quit_pipe()) {
3615 goto exit_init_data
;
3618 /* Setup the thread apps communication pipe. */
3619 if (create_relay_conn_pipe()) {
3621 goto exit_init_data
;
3624 /* Init relay command queue. */
3625 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
3627 /* Initialize communication library */
3629 lttcomm_inet_init();
3631 /* tables of sessions indexed by session ID */
3632 sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3635 goto exit_init_data
;
3638 /* tables of streams indexed by stream ID */
3639 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3640 if (!relay_streams_ht
) {
3642 goto exit_init_data
;
3645 /* tables of streams indexed by stream ID */
3646 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3647 if (!viewer_streams_ht
) {
3649 goto exit_init_data
;
3652 ret
= utils_create_pipe(health_quit_pipe
);
3655 goto exit_health_quit_pipe
;
3658 /* Create thread to manage the client socket */
3659 ret
= pthread_create(&health_thread
, default_pthread_attr(),
3660 thread_manage_health
, (void *) NULL
);
3663 PERROR("pthread_create health");
3665 goto exit_health_thread
;
3668 /* Setup the dispatcher thread */
3669 ret
= pthread_create(&dispatcher_thread
, default_pthread_attr(),
3670 relay_thread_dispatcher
, (void *) NULL
);
3673 PERROR("pthread_create dispatcher");
3675 goto exit_dispatcher_thread
;
3678 /* Setup the worker thread */
3679 ret
= pthread_create(&worker_thread
, default_pthread_attr(),
3680 relay_thread_worker
, NULL
);
3683 PERROR("pthread_create worker");
3685 goto exit_worker_thread
;
3688 /* Setup the listener thread */
3689 ret
= pthread_create(&listener_thread
, default_pthread_attr(),
3690 relay_thread_listener
, (void *) NULL
);
3693 PERROR("pthread_create listener");
3695 goto exit_listener_thread
;
3698 ret
= relayd_live_create(live_uri
);
3700 ERR("Starting live viewer threads");
3706 * This is where we start awaiting program completion (e.g. through
3707 * signal that asks threads to teardown).
3710 ret
= relayd_live_join();
3716 ret
= pthread_join(listener_thread
, &status
);
3719 PERROR("pthread_join listener_thread");
3723 exit_listener_thread
:
3724 ret
= pthread_join(worker_thread
, &status
);
3727 PERROR("pthread_join worker_thread");
3732 ret
= pthread_join(dispatcher_thread
, &status
);
3735 PERROR("pthread_join dispatcher_thread");
3738 exit_dispatcher_thread
:
3740 ret
= pthread_join(health_thread
, &status
);
3743 PERROR("pthread_join health_thread");
3748 utils_close_pipe(health_quit_pipe
);
3749 exit_health_quit_pipe
:
3752 health_app_destroy(health_relayd
);
3753 exit_health_app_create
:
3756 * Wait for all pending call_rcu work to complete before tearing
3757 * down data structures. call_rcu worker may be trying to
3758 * perform lookups in those structures.
3763 /* Ensure all prior call_rcu are done. */