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"
77 #include "sessiond-trace-chunks.h"
79 static const char *help_msg
=
80 #ifdef LTTNG_EMBED_HELP
81 #include <lttng-relayd.8.h>
87 enum relay_connection_status
{
88 RELAY_CONNECTION_STATUS_OK
,
89 /* An error occurred while processing an event on the connection. */
90 RELAY_CONNECTION_STATUS_ERROR
,
91 /* Connection closed/shutdown cleanly. */
92 RELAY_CONNECTION_STATUS_CLOSED
,
95 /* command line options */
96 char *opt_output_path
;
97 static int opt_daemon
, opt_background
;
100 * We need to wait for listener and live listener threads, as well as
101 * health check thread, before being ready to signal readiness.
103 #define NR_LTTNG_RELAY_READY 3
104 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
106 /* Size of receive buffer. */
107 #define RECV_DATA_BUFFER_SIZE 65536
108 #define FILE_COPY_BUFFER_SIZE 65536
110 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
111 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
113 static struct lttng_uri
*control_uri
;
114 static struct lttng_uri
*data_uri
;
115 static struct lttng_uri
*live_uri
;
117 const char *progname
;
119 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
120 static int tracing_group_name_override
;
122 const char * const config_section_name
= "relayd";
125 * Quit pipe for all threads. This permits a single cancellation point
126 * for all threads when receiving an event on the pipe.
128 int thread_quit_pipe
[2] = { -1, -1 };
131 * This pipe is used to inform the worker thread that a command is queued and
132 * ready to be processed.
134 static int relay_conn_pipe
[2] = { -1, -1 };
136 /* Shared between threads */
137 static int dispatch_thread_exit
;
139 static pthread_t listener_thread
;
140 static pthread_t dispatcher_thread
;
141 static pthread_t worker_thread
;
142 static pthread_t health_thread
;
145 * last_relay_stream_id_lock protects last_relay_stream_id increment
146 * atomicity on 32-bit architectures.
148 static pthread_mutex_t last_relay_stream_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
149 static uint64_t last_relay_stream_id
;
152 * Relay command queue.
154 * The relay_thread_listener and relay_thread_dispatcher communicate with this
157 static struct relay_conn_queue relay_conn_queue
;
159 /* Global relay stream hash table. */
160 struct lttng_ht
*relay_streams_ht
;
162 /* Global relay viewer stream hash table. */
163 struct lttng_ht
*viewer_streams_ht
;
165 /* Global relay sessions hash table. */
166 struct lttng_ht
*sessions_ht
;
168 /* Relayd health monitoring */
169 struct health_app
*health_relayd
;
171 struct sessiond_trace_chunk_registry
*sessiond_trace_chunk_registry
;
173 static struct option long_options
[] = {
174 { "control-port", 1, 0, 'C', },
175 { "data-port", 1, 0, 'D', },
176 { "live-port", 1, 0, 'L', },
177 { "daemonize", 0, 0, 'd', },
178 { "background", 0, 0, 'b', },
179 { "group", 1, 0, 'g', },
180 { "help", 0, 0, 'h', },
181 { "output", 1, 0, 'o', },
182 { "verbose", 0, 0, 'v', },
183 { "config", 1, 0, 'f' },
184 { "version", 0, 0, 'V' },
188 static const char *config_ignore_options
[] = { "help", "config", "version" };
191 * Take an option from the getopt output and set it in the right variable to be
194 * Return 0 on success else a negative value.
196 static int set_option(int opt
, const char *arg
, const char *optname
)
202 fprintf(stderr
, "option %s", optname
);
204 fprintf(stderr
, " with arg %s\n", arg
);
208 if (lttng_is_setuid_setgid()) {
209 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
210 "-C, --control-port");
212 ret
= uri_parse(arg
, &control_uri
);
214 ERR("Invalid control URI specified");
217 if (control_uri
->port
== 0) {
218 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
223 if (lttng_is_setuid_setgid()) {
224 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
227 ret
= uri_parse(arg
, &data_uri
);
229 ERR("Invalid data URI specified");
232 if (data_uri
->port
== 0) {
233 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
238 if (lttng_is_setuid_setgid()) {
239 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
242 ret
= uri_parse(arg
, &live_uri
);
244 ERR("Invalid live URI specified");
247 if (live_uri
->port
== 0) {
248 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
259 if (lttng_is_setuid_setgid()) {
260 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
263 tracing_group_name
= strdup(arg
);
264 if (tracing_group_name
== NULL
) {
269 tracing_group_name_override
= 1;
273 ret
= utils_show_help(8, "lttng-relayd", help_msg
);
275 ERR("Cannot show --help for `lttng-relayd`");
280 fprintf(stdout
, "%s\n", VERSION
);
283 if (lttng_is_setuid_setgid()) {
284 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
287 ret
= asprintf(&opt_output_path
, "%s", arg
);
290 PERROR("asprintf opt_output_path");
296 /* Verbose level can increase using multiple -v */
298 lttng_opt_verbose
= config_parse_value(arg
);
300 /* Only 3 level of verbosity (-vvv). */
301 if (lttng_opt_verbose
< 3) {
302 lttng_opt_verbose
+= 1;
307 /* Unknown option or other error.
308 * Error is printed by getopt, just return */
321 * config_entry_handler_cb used to handle options read from a config file.
322 * See config_entry_handler_cb comment in common/config/session-config.h for the
323 * return value conventions.
325 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
329 if (!entry
|| !entry
->name
|| !entry
->value
) {
334 /* Check if the option is to be ignored */
335 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
336 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
341 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1; i
++) {
342 /* Ignore if entry name is not fully matched. */
343 if (strcmp(entry
->name
, long_options
[i
].name
)) {
348 * If the option takes no argument on the command line,
349 * we have to check if the value is "true". We support
350 * non-zero numeric values, true, on and yes.
352 if (!long_options
[i
].has_arg
) {
353 ret
= config_parse_value(entry
->value
);
356 WARN("Invalid configuration value \"%s\" for option %s",
357 entry
->value
, entry
->name
);
359 /* False, skip boolean config option. */
364 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
368 WARN("Unrecognized option \"%s\" in daemon configuration file.",
375 static int set_options(int argc
, char **argv
)
377 int c
, ret
= 0, option_index
= 0, retval
= 0;
378 int orig_optopt
= optopt
, orig_optind
= optind
;
379 char *default_address
, *optstring
;
380 const char *config_path
= NULL
;
382 optstring
= utils_generate_optstring(long_options
,
383 sizeof(long_options
) / sizeof(struct option
));
389 /* Check for the --config option */
391 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
392 &option_index
)) != -1) {
396 } else if (c
!= 'f') {
400 if (lttng_is_setuid_setgid()) {
401 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
404 config_path
= utils_expand_path(optarg
);
406 ERR("Failed to resolve path: %s", optarg
);
411 ret
= config_get_section_entries(config_path
, config_section_name
,
412 config_entry_handler
, NULL
);
415 ERR("Invalid configuration option at line %i", ret
);
421 /* Reset getopt's global state */
422 optopt
= orig_optopt
;
423 optind
= orig_optind
;
425 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
430 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
437 /* assign default values */
438 if (control_uri
== NULL
) {
439 ret
= asprintf(&default_address
,
440 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
441 DEFAULT_NETWORK_CONTROL_PORT
);
443 PERROR("asprintf default data address");
448 ret
= uri_parse(default_address
, &control_uri
);
449 free(default_address
);
451 ERR("Invalid control URI specified");
456 if (data_uri
== NULL
) {
457 ret
= asprintf(&default_address
,
458 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
459 DEFAULT_NETWORK_DATA_PORT
);
461 PERROR("asprintf default data address");
466 ret
= uri_parse(default_address
, &data_uri
);
467 free(default_address
);
469 ERR("Invalid data URI specified");
474 if (live_uri
== NULL
) {
475 ret
= asprintf(&default_address
,
476 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
477 DEFAULT_NETWORK_VIEWER_PORT
);
479 PERROR("asprintf default viewer control address");
484 ret
= uri_parse(default_address
, &live_uri
);
485 free(default_address
);
487 ERR("Invalid viewer control URI specified");
498 static void print_global_objects(void)
500 rcu_register_thread();
502 print_viewer_streams();
503 print_relay_streams();
506 rcu_unregister_thread();
512 static void relayd_cleanup(void)
514 print_global_objects();
518 if (viewer_streams_ht
)
519 lttng_ht_destroy(viewer_streams_ht
);
520 if (relay_streams_ht
)
521 lttng_ht_destroy(relay_streams_ht
);
523 lttng_ht_destroy(sessions_ht
);
525 /* free the dynamically allocated opt_output_path */
526 free(opt_output_path
);
528 /* Close thread quit pipes */
529 utils_close_pipe(thread_quit_pipe
);
531 uri_free(control_uri
);
533 /* Live URI is freed in the live thread. */
535 if (tracing_group_name_override
) {
536 free((void *) tracing_group_name
);
541 * Write to writable pipe used to notify a thread.
543 static int notify_thread_pipe(int wpipe
)
547 ret
= lttng_write(wpipe
, "!", 1);
549 PERROR("write poll pipe");
557 static int notify_health_quit_pipe(int *pipe
)
561 ret
= lttng_write(pipe
[1], "4", 1);
563 PERROR("write relay health quit");
572 * Stop all relayd and relayd-live threads.
574 int lttng_relay_stop_threads(void)
578 /* Stopping all threads */
579 DBG("Terminating all threads");
580 if (notify_thread_pipe(thread_quit_pipe
[1])) {
581 ERR("write error on thread quit pipe");
585 if (notify_health_quit_pipe(health_quit_pipe
)) {
586 ERR("write error on health quit pipe");
589 /* Dispatch thread */
590 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
591 futex_nto1_wake(&relay_conn_queue
.futex
);
593 if (relayd_live_stop()) {
594 ERR("Error stopping live threads");
601 * Signal handler for the daemon
603 * Simply stop all worker threads, leaving main() return gracefully after
604 * joining all threads and calling cleanup().
606 static void sighandler(int sig
)
610 DBG("SIGINT caught");
611 if (lttng_relay_stop_threads()) {
612 ERR("Error stopping threads");
616 DBG("SIGTERM caught");
617 if (lttng_relay_stop_threads()) {
618 ERR("Error stopping threads");
622 CMM_STORE_SHARED(recv_child_signal
, 1);
630 * Setup signal handler for :
631 * SIGINT, SIGTERM, SIGPIPE
633 static int set_signal_handler(void)
639 if ((ret
= sigemptyset(&sigset
)) < 0) {
640 PERROR("sigemptyset");
647 sa
.sa_handler
= sighandler
;
648 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
653 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
658 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
663 sa
.sa_handler
= SIG_IGN
;
664 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
669 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
674 void lttng_relay_notify_ready(void)
676 /* Notify the parent of the fork() process that we are ready. */
677 if (opt_daemon
|| opt_background
) {
678 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
679 kill(child_ppid
, SIGUSR1
);
685 * Init thread quit pipe.
687 * Return -1 on error or 0 if all pipes are created.
689 static int init_thread_quit_pipe(void)
693 ret
= utils_create_pipe_cloexec(thread_quit_pipe
);
699 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
701 static int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
705 if (events
== NULL
|| size
== 0) {
710 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
716 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
728 * Check if the thread quit pipe was triggered.
730 * Return 1 if it was triggered else 0;
732 static int check_thread_quit_pipe(int fd
, uint32_t events
)
734 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
742 * Create and init socket from uri.
744 static struct lttcomm_sock
*relay_socket_create(struct lttng_uri
*uri
)
747 struct lttcomm_sock
*sock
= NULL
;
749 sock
= lttcomm_alloc_sock_from_uri(uri
);
751 ERR("Allocating socket");
755 ret
= lttcomm_create_sock(sock
);
759 DBG("Listening on sock %d", sock
->fd
);
761 ret
= sock
->ops
->bind(sock
);
763 PERROR("Failed to bind socket");
767 ret
= sock
->ops
->listen(sock
, -1);
777 lttcomm_destroy_sock(sock
);
783 * This thread manages the listening for new connections on the network
785 static void *relay_thread_listener(void *data
)
787 int i
, ret
, pollfd
, err
= -1;
788 uint32_t revents
, nb_fd
;
789 struct lttng_poll_event events
;
790 struct lttcomm_sock
*control_sock
, *data_sock
;
792 DBG("[thread] Relay listener started");
794 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
796 health_code_update();
798 control_sock
= relay_socket_create(control_uri
);
800 goto error_sock_control
;
803 data_sock
= relay_socket_create(data_uri
);
805 goto error_sock_relay
;
809 * Pass 3 as size here for the thread quit pipe, control and
812 ret
= create_thread_poll_set(&events
, 3);
814 goto error_create_poll
;
817 /* Add the control socket */
818 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
823 /* Add the data socket */
824 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
829 lttng_relay_notify_ready();
831 if (testpoint(relayd_thread_listener
)) {
832 goto error_testpoint
;
836 health_code_update();
838 DBG("Listener accepting connections");
842 ret
= lttng_poll_wait(&events
, -1);
846 * Restart interrupted system call.
848 if (errno
== EINTR
) {
856 DBG("Relay new connection received");
857 for (i
= 0; i
< nb_fd
; i
++) {
858 health_code_update();
860 /* Fetch once the poll data */
861 revents
= LTTNG_POLL_GETEV(&events
, i
);
862 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
864 /* Thread quit pipe has been closed. Killing thread. */
865 ret
= check_thread_quit_pipe(pollfd
, revents
);
871 if (revents
& LPOLLIN
) {
873 * A new connection is requested, therefore a
874 * sessiond/consumerd connection is allocated in
875 * this thread, enqueued to a global queue and
876 * dequeued (and freed) in the worker thread.
879 struct relay_connection
*new_conn
;
880 struct lttcomm_sock
*newsock
;
881 enum connection_type type
;
883 if (pollfd
== data_sock
->fd
) {
885 newsock
= data_sock
->ops
->accept(data_sock
);
886 DBG("Relay data connection accepted, socket %d",
889 assert(pollfd
== control_sock
->fd
);
890 type
= RELAY_CONTROL
;
891 newsock
= control_sock
->ops
->accept(control_sock
);
892 DBG("Relay control connection accepted, socket %d",
896 PERROR("accepting sock");
900 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
903 PERROR("setsockopt inet");
904 lttcomm_destroy_sock(newsock
);
908 ret
= socket_apply_keep_alive_config(newsock
->fd
);
910 ERR("Failed to apply TCP keep-alive configuration on socket (%i)",
912 lttcomm_destroy_sock(newsock
);
916 new_conn
= connection_create(newsock
, type
);
918 lttcomm_destroy_sock(newsock
);
922 /* Enqueue request for the dispatcher thread. */
923 cds_wfcq_enqueue(&relay_conn_queue
.head
, &relay_conn_queue
.tail
,
927 * Wake the dispatch queue futex.
928 * Implicit memory barrier with the
929 * exchange in cds_wfcq_enqueue.
931 futex_nto1_wake(&relay_conn_queue
.futex
);
932 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
933 ERR("socket poll error");
936 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
946 lttng_poll_clean(&events
);
948 if (data_sock
->fd
>= 0) {
949 ret
= data_sock
->ops
->close(data_sock
);
954 lttcomm_destroy_sock(data_sock
);
956 if (control_sock
->fd
>= 0) {
957 ret
= control_sock
->ops
->close(control_sock
);
962 lttcomm_destroy_sock(control_sock
);
966 ERR("Health error occurred in %s", __func__
);
968 health_unregister(health_relayd
);
969 DBG("Relay listener thread cleanup complete");
970 lttng_relay_stop_threads();
975 * This thread manages the dispatching of the requests to worker threads
977 static void *relay_thread_dispatcher(void *data
)
981 struct cds_wfcq_node
*node
;
982 struct relay_connection
*new_conn
= NULL
;
984 DBG("[thread] Relay dispatcher started");
986 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
988 if (testpoint(relayd_thread_dispatcher
)) {
989 goto error_testpoint
;
992 health_code_update();
995 health_code_update();
997 /* Atomically prepare the queue futex */
998 futex_nto1_prepare(&relay_conn_queue
.futex
);
1000 if (CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1005 health_code_update();
1007 /* Dequeue commands */
1008 node
= cds_wfcq_dequeue_blocking(&relay_conn_queue
.head
,
1009 &relay_conn_queue
.tail
);
1011 DBG("Woken up but nothing in the relay command queue");
1012 /* Continue thread execution */
1015 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
1017 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
1020 * Inform worker thread of the new request. This
1021 * call is blocking so we can be assured that
1022 * the data will be read at some point in time
1023 * or wait to the end of the world :)
1025 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
1027 PERROR("write connection pipe");
1028 connection_put(new_conn
);
1031 } while (node
!= NULL
);
1033 /* Futex wait on queue. Blocking call on futex() */
1034 health_poll_entry();
1035 futex_nto1_wait(&relay_conn_queue
.futex
);
1039 /* Normal exit, no error */
1046 ERR("Health error occurred in %s", __func__
);
1048 health_unregister(health_relayd
);
1049 DBG("Dispatch thread dying");
1050 lttng_relay_stop_threads();
1055 * Set index data from the control port to a given index object.
1057 static int set_index_control_data(struct relay_index
*index
,
1058 struct lttcomm_relayd_index
*data
,
1059 struct relay_connection
*conn
)
1061 struct ctf_packet_index index_data
;
1064 * The index on disk is encoded in big endian.
1066 index_data
.packet_size
= htobe64(data
->packet_size
);
1067 index_data
.content_size
= htobe64(data
->content_size
);
1068 index_data
.timestamp_begin
= htobe64(data
->timestamp_begin
);
1069 index_data
.timestamp_end
= htobe64(data
->timestamp_end
);
1070 index_data
.events_discarded
= htobe64(data
->events_discarded
);
1071 index_data
.stream_id
= htobe64(data
->stream_id
);
1073 if (conn
->minor
>= 8) {
1074 index
->index_data
.stream_instance_id
= htobe64(data
->stream_instance_id
);
1075 index
->index_data
.packet_seq_num
= htobe64(data
->packet_seq_num
);
1078 return relay_index_set_data(index
, &index_data
);
1081 static bool session_streams_have_index(const struct relay_session
*session
)
1083 return session
->minor
>= 4 && !session
->snapshot
;
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
= NULL
;
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;
1103 /* Left nil for peers < 2.11. */
1104 lttng_uuid sessiond_uuid
= {};
1105 LTTNG_OPTIONAL(uint64_t) id_sessiond
= {};
1106 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1107 LTTNG_OPTIONAL(time_t) creation_time
= {};
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 bool has_current_chunk
;
1118 uint64_t current_chunk_id_value
;
1119 time_t creation_time_value
;
1120 uint64_t id_sessiond_value
;
1122 /* From 2.11 to ... */
1123 ret
= cmd_create_session_2_11(payload
, session_name
, hostname
,
1124 &live_timer
, &snapshot
, &id_sessiond_value
,
1125 sessiond_uuid
, &has_current_chunk
,
1126 ¤t_chunk_id_value
, &creation_time_value
);
1127 if (lttng_uuid_is_nil(sessiond_uuid
)) {
1128 /* The nil UUID is reserved for pre-2.11 clients. */
1129 ERR("Illegal nil UUID announced by peer in create session command");
1133 LTTNG_OPTIONAL_SET(&id_sessiond
, id_sessiond_value
);
1134 LTTNG_OPTIONAL_SET(&creation_time
, creation_time_value
);
1135 if (has_current_chunk
) {
1136 LTTNG_OPTIONAL_SET(¤t_chunk_id
,
1137 current_chunk_id_value
);
1145 session
= session_create(session_name
, hostname
, live_timer
,
1146 snapshot
, sessiond_uuid
,
1147 id_sessiond
.is_set
? &id_sessiond
.value
: NULL
,
1148 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1149 creation_time
.is_set
? &creation_time
.value
: NULL
,
1150 conn
->major
, conn
->minor
);
1155 assert(!conn
->session
);
1156 conn
->session
= session
;
1157 DBG("Created session %" PRIu64
, session
->id
);
1159 reply
.session_id
= htobe64(session
->id
);
1163 reply
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1165 reply
.ret_code
= htobe32(LTTNG_OK
);
1168 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1169 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1170 ERR("Failed to send \"create session\" command reply (ret = %zd)",
1174 if (ret
< 0 && session
) {
1175 session_put(session
);
1181 * When we have received all the streams and the metadata for a channel,
1182 * we make them visible to the viewer threads.
1184 static void publish_connection_local_streams(struct relay_connection
*conn
)
1186 struct relay_stream
*stream
;
1187 struct relay_session
*session
= conn
->session
;
1190 * We publish all streams belonging to a session atomically wrt
1193 pthread_mutex_lock(&session
->lock
);
1195 cds_list_for_each_entry_rcu(stream
, &session
->recv_list
,
1197 stream_publish(stream
);
1202 * Inform the viewer that there are new streams in the session.
1204 if (session
->viewer_attached
) {
1205 uatomic_set(&session
->new_streams
, 1);
1207 pthread_mutex_unlock(&session
->lock
);
1210 static int conform_channel_path(char *channel_path
)
1214 if (strstr("../", channel_path
)) {
1215 ERR("Refusing channel path as it walks up the path hierarchy: \"%s\"",
1221 if (*channel_path
== '/') {
1222 const size_t len
= strlen(channel_path
);
1225 * Channel paths from peers prior to 2.11 are expressed as an
1226 * absolute path that is, in reality, relative to the relay
1227 * daemon's output directory. Remove the leading slash so it
1228 * is correctly interpreted as a relative path later on.
1230 * len (and not len - 1) is used to copy the trailing NULL.
1232 bcopy(channel_path
+ 1, channel_path
, len
);
1239 * relay_add_stream: allocate a new stream for a session
1241 static int relay_add_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1242 struct relay_connection
*conn
,
1243 const struct lttng_buffer_view
*payload
)
1247 struct relay_session
*session
= conn
->session
;
1248 struct relay_stream
*stream
= NULL
;
1249 struct lttcomm_relayd_status_stream reply
;
1250 struct ctf_trace
*trace
= NULL
;
1251 uint64_t stream_handle
= -1ULL;
1252 char *path_name
= NULL
, *channel_name
= NULL
;
1253 uint64_t tracefile_size
= 0, tracefile_count
= 0;
1254 LTTNG_OPTIONAL(uint64_t) stream_chunk_id
= {};
1256 if (!session
|| !conn
->version_check_done
) {
1257 ERR("Trying to add a stream before version check");
1259 goto end_no_session
;
1262 if (session
->minor
== 1) {
1264 ret
= cmd_recv_stream_2_1(payload
, &path_name
,
1266 } else if (session
->minor
> 1 && session
->minor
< 11) {
1267 /* From 2.2 to 2.10 */
1268 ret
= cmd_recv_stream_2_2(payload
, &path_name
,
1269 &channel_name
, &tracefile_size
, &tracefile_count
);
1271 /* From 2.11 to ... */
1272 ret
= cmd_recv_stream_2_11(payload
, &path_name
,
1273 &channel_name
, &tracefile_size
, &tracefile_count
,
1274 &stream_chunk_id
.value
);
1275 stream_chunk_id
.is_set
= true;
1282 if (conform_channel_path(path_name
)) {
1286 trace
= ctf_trace_get_by_path_or_create(session
, path_name
);
1290 /* This stream here has one reference on the trace. */
1292 pthread_mutex_lock(&last_relay_stream_id_lock
);
1293 stream_handle
= ++last_relay_stream_id
;
1294 pthread_mutex_unlock(&last_relay_stream_id_lock
);
1296 /* We pass ownership of path_name and channel_name. */
1297 stream
= stream_create(trace
, stream_handle
, path_name
,
1298 channel_name
, tracefile_size
, tracefile_count
);
1300 channel_name
= NULL
;
1303 * Streams are the owners of their trace. Reference to trace is
1304 * kept within stream_create().
1306 ctf_trace_put(trace
);
1309 memset(&reply
, 0, sizeof(reply
));
1310 reply
.handle
= htobe64(stream_handle
);
1312 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1314 reply
.ret_code
= htobe32(LTTNG_OK
);
1317 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1318 sizeof(struct lttcomm_relayd_status_stream
), 0);
1319 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1320 ERR("Failed to send \"add stream\" command reply (ret = %zd)",
1332 * relay_close_stream: close a specific stream
1334 static int relay_close_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
1335 struct relay_connection
*conn
,
1336 const struct lttng_buffer_view
*payload
)
1340 struct relay_session
*session
= conn
->session
;
1341 struct lttcomm_relayd_close_stream stream_info
;
1342 struct lttcomm_relayd_generic_reply reply
;
1343 struct relay_stream
*stream
;
1345 DBG("Close stream received");
1347 if (!session
|| !conn
->version_check_done
) {
1348 ERR("Trying to close a stream before version check");
1350 goto end_no_session
;
1353 if (payload
->size
< sizeof(stream_info
)) {
1354 ERR("Unexpected payload size in \"relay_close_stream\": expected >= %zu bytes, got %zu bytes",
1355 sizeof(stream_info
), payload
->size
);
1357 goto end_no_session
;
1359 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1360 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1361 stream_info
.last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1363 stream
= stream_get_by_id(stream_info
.stream_id
);
1370 * Set last_net_seq_num before the close flag. Required by data
1373 pthread_mutex_lock(&stream
->lock
);
1374 stream
->last_net_seq_num
= stream_info
.last_net_seq_num
;
1375 pthread_mutex_unlock(&stream
->lock
);
1378 * This is one of the conditions which may trigger a stream close
1379 * with the others being:
1380 * 1) A close command is received for a stream
1381 * 2) The control connection owning the stream is closed
1382 * 3) We have received all of the stream's data _after_ a close
1385 try_stream_close(stream
);
1386 if (stream
->is_metadata
) {
1387 struct relay_viewer_stream
*vstream
;
1389 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
1391 if (vstream
->metadata_sent
== stream
->metadata_received
) {
1393 * Since all the metadata has been sent to the
1394 * viewer and that we have a request to close
1395 * its stream, we can safely teardown the
1396 * corresponding metadata viewer stream.
1398 viewer_stream_put(vstream
);
1400 /* Put local reference. */
1401 viewer_stream_put(vstream
);
1408 memset(&reply
, 0, sizeof(reply
));
1410 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1412 reply
.ret_code
= htobe32(LTTNG_OK
);
1414 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1415 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1416 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1417 ERR("Failed to send \"close stream\" command reply (ret = %zd)",
1427 * relay_reset_metadata: reset a metadata stream
1430 int relay_reset_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1431 struct relay_connection
*conn
,
1432 const struct lttng_buffer_view
*payload
)
1436 struct relay_session
*session
= conn
->session
;
1437 struct lttcomm_relayd_reset_metadata stream_info
;
1438 struct lttcomm_relayd_generic_reply reply
;
1439 struct relay_stream
*stream
;
1441 DBG("Reset metadata received");
1443 if (!session
|| !conn
->version_check_done
) {
1444 ERR("Trying to reset a metadata stream before version check");
1446 goto end_no_session
;
1449 if (payload
->size
< sizeof(stream_info
)) {
1450 ERR("Unexpected payload size in \"relay_reset_metadata\": expected >= %zu bytes, got %zu bytes",
1451 sizeof(stream_info
), payload
->size
);
1453 goto end_no_session
;
1455 memcpy(&stream_info
, payload
->data
, sizeof(stream_info
));
1456 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
1457 stream_info
.version
= be64toh(stream_info
.version
);
1459 DBG("Update metadata to version %" PRIu64
, stream_info
.version
);
1461 /* Unsupported for live sessions for now. */
1462 if (session
->live_timer
!= 0) {
1467 stream
= stream_get_by_id(stream_info
.stream_id
);
1472 pthread_mutex_lock(&stream
->lock
);
1473 if (!stream
->is_metadata
) {
1478 ret
= utils_rotate_stream_file(stream
->path_name
, stream
->channel_name
,
1479 0, 0, -1, -1, stream
->stream_fd
->fd
, NULL
,
1480 &stream
->stream_fd
->fd
);
1482 ERR("Failed to rotate metadata file %s of channel %s",
1483 stream
->path_name
, stream
->channel_name
);
1488 pthread_mutex_unlock(&stream
->lock
);
1492 memset(&reply
, 0, sizeof(reply
));
1494 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1496 reply
.ret_code
= htobe32(LTTNG_OK
);
1498 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1499 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1500 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1501 ERR("Failed to send \"reset metadata\" command reply (ret = %zd)",
1511 * relay_unknown_command: send -1 if received unknown command
1513 static void relay_unknown_command(struct relay_connection
*conn
)
1515 struct lttcomm_relayd_generic_reply reply
;
1518 memset(&reply
, 0, sizeof(reply
));
1519 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1520 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1521 if (send_ret
< sizeof(reply
)) {
1522 ERR("Failed to send \"unknown command\" command reply (ret = %zd)", send_ret
);
1527 * relay_start: send an acknowledgment to the client to tell if we are
1528 * ready to receive data. We are ready if a session is established.
1530 static int relay_start(const struct lttcomm_relayd_hdr
*recv_hdr
,
1531 struct relay_connection
*conn
,
1532 const struct lttng_buffer_view
*payload
)
1536 struct lttcomm_relayd_generic_reply reply
;
1537 struct relay_session
*session
= conn
->session
;
1540 DBG("Trying to start the streaming without a session established");
1541 ret
= htobe32(LTTNG_ERR_UNK
);
1544 memset(&reply
, 0, sizeof(reply
));
1545 reply
.ret_code
= htobe32(LTTNG_OK
);
1546 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1548 if (send_ret
< (ssize_t
) sizeof(reply
)) {
1549 ERR("Failed to send \"relay_start\" command reply (ret = %zd)",
1558 * Append padding to the file pointed by the file descriptor fd.
1560 static int write_padding_to_file(int fd
, uint32_t size
)
1569 zeros
= zmalloc(size
);
1570 if (zeros
== NULL
) {
1571 PERROR("zmalloc zeros for padding");
1576 ret
= lttng_write(fd
, zeros
, size
);
1578 PERROR("write padding to file");
1588 * Close the current index file if it is open, and create a new one.
1590 * Return 0 on success, -1 on error.
1593 int create_rotate_index_file(struct relay_stream
*stream
,
1594 const char *channel_path
)
1597 uint32_t major
, minor
;
1599 ASSERT_LOCKED(stream
->lock
);
1601 /* Put ref on previous index_file. */
1602 if (stream
->index_file
) {
1603 lttng_index_file_put(stream
->index_file
);
1604 stream
->index_file
= NULL
;
1606 major
= stream
->trace
->session
->major
;
1607 minor
= stream
->trace
->session
->minor
;
1608 if (!stream
->trace
->index_folder_created
) {
1609 char *index_subpath
= NULL
;
1611 ret
= asprintf(&index_subpath
, "%s/%s", channel_path
, DEFAULT_INDEX_DIR
);
1616 ret
= lttng_trace_chunk_create_subdirectory(stream
->trace_chunk
, index_subpath
);
1617 free(index_subpath
);
1621 stream
->trace
->index_folder_created
= true;
1623 stream
->index_file
= lttng_index_file_create_from_trace_chunk(
1624 stream
->trace_chunk
, channel_path
, stream
->channel_name
,
1625 stream
->tracefile_size
, stream
->tracefile_count
,
1626 lttng_to_index_major(major
, minor
),
1627 lttng_to_index_minor(major
, minor
), true);
1628 if (!stream
->index_file
) {
1640 int do_rotate_stream_data(struct relay_stream
*stream
)
1644 DBG("Rotating stream %" PRIu64
" data file",
1645 stream
->stream_handle
);
1646 /* Perform the stream rotation. */
1647 ret
= utils_rotate_stream_file(stream
->path_name
,
1648 stream
->channel_name
, stream
->tracefile_size
,
1649 stream
->tracefile_count
, -1,
1650 -1, stream
->stream_fd
->fd
,
1651 NULL
, &stream
->stream_fd
->fd
);
1653 ERR("Rotating stream output file");
1656 stream
->tracefile_size_current
= 0;
1657 stream
->pos_after_last_complete_data_index
= 0;
1658 stream
->data_rotated
= true;
1660 if (stream
->data_rotated
&& stream
->index_rotated
) {
1661 /* Rotation completed; reset its state. */
1662 DBG("Rotation completed for stream %" PRIu64
,
1663 stream
->stream_handle
);
1664 stream
->rotate_at_seq_num
= -1ULL;
1665 stream
->data_rotated
= false;
1666 stream
->index_rotated
= false;
1673 * If too much data has been written in a tracefile before we received the
1674 * rotation command, we have to move the excess data to the new tracefile and
1675 * perform the rotation. This can happen because the control and data
1676 * connections are separate, the indexes as well as the commands arrive from
1677 * the control connection and we have no control over the order so we could be
1678 * in a situation where too much data has been received on the data connection
1679 * before the rotation command on the control connection arrives.
1682 int rotate_truncate_stream(struct relay_stream
*stream
)
1686 uint64_t diff
, pos
= 0;
1687 char buf
[FILE_COPY_BUFFER_SIZE
];
1689 assert(!stream
->is_metadata
);
1691 assert(stream
->tracefile_size_current
>
1692 stream
->pos_after_last_complete_data_index
);
1693 diff
= stream
->tracefile_size_current
-
1694 stream
->pos_after_last_complete_data_index
;
1696 /* Create the new tracefile. */
1697 new_fd
= utils_create_stream_file(stream
->path_name
,
1698 stream
->channel_name
,
1699 stream
->tracefile_size
, stream
->tracefile_count
,
1700 /* uid */ -1, /* gid */ -1, /* suffix */ NULL
);
1702 ERR("Failed to create new stream file at path %s for channel %s",
1703 stream
->path_name
, stream
->channel_name
);
1709 * Rewind the current tracefile to the position at which the rotation
1710 * should have occurred.
1712 lseek_ret
= lseek(stream
->stream_fd
->fd
,
1713 stream
->pos_after_last_complete_data_index
, SEEK_SET
);
1714 if (lseek_ret
< 0) {
1715 PERROR("seek truncate stream");
1720 /* Move data from the old file to the new file. */
1721 while (pos
< diff
) {
1722 uint64_t count
, bytes_left
;
1725 bytes_left
= diff
- pos
;
1726 count
= bytes_left
> sizeof(buf
) ? sizeof(buf
) : bytes_left
;
1727 assert(count
<= SIZE_MAX
);
1729 io_ret
= lttng_read(stream
->stream_fd
->fd
, buf
, count
);
1730 if (io_ret
< (ssize_t
) count
) {
1731 char error_string
[256];
1733 snprintf(error_string
, sizeof(error_string
),
1734 "Failed to read %" PRIu64
" bytes from fd %i in rotate_truncate_stream(), returned %zi",
1735 count
, stream
->stream_fd
->fd
, io_ret
);
1737 PERROR("%s", error_string
);
1739 ERR("%s", error_string
);
1745 io_ret
= lttng_write(new_fd
, buf
, count
);
1746 if (io_ret
< (ssize_t
) count
) {
1747 char error_string
[256];
1749 snprintf(error_string
, sizeof(error_string
),
1750 "Failed to write %" PRIu64
" bytes from fd %i in rotate_truncate_stream(), returned %zi",
1751 count
, new_fd
, io_ret
);
1753 PERROR("%s", error_string
);
1755 ERR("%s", error_string
);
1764 /* Truncate the file to get rid of the excess data. */
1765 ret
= ftruncate(stream
->stream_fd
->fd
,
1766 stream
->pos_after_last_complete_data_index
);
1768 PERROR("ftruncate");
1772 ret
= close(stream
->stream_fd
->fd
);
1774 PERROR("Closing tracefile");
1779 * Update the offset and FD of all the eventual indexes created by the
1780 * data connection before the rotation command arrived.
1782 ret
= relay_index_switch_all_files(stream
);
1784 ERR("Failed to rotate index file");
1788 stream
->stream_fd
->fd
= new_fd
;
1789 stream
->tracefile_size_current
= diff
;
1790 stream
->pos_after_last_complete_data_index
= 0;
1791 stream
->rotate_at_seq_num
= -1ULL;
1800 * Check if a stream's index file should be rotated (for session rotation).
1801 * Must be called with the stream lock held.
1803 * Return 0 on success, a negative value on error.
1806 int try_rotate_stream_index(struct relay_stream
*stream
)
1810 if (stream
->rotate_at_seq_num
== -1ULL) {
1811 /* No rotation expected. */
1815 if (stream
->index_rotated
) {
1816 /* Rotation of the index has already occurred. */
1820 if (stream
->prev_index_seq
== -1ULL ||
1821 stream
->prev_index_seq
< stream
->rotate_at_seq_num
) {
1822 DBG("Stream %" PRIu64
" index not yet ready for rotation (rotate_at_seq_num = %" PRIu64
", prev_index_seq = %" PRIu64
")",
1823 stream
->stream_handle
,
1824 stream
->rotate_at_seq_num
,
1825 stream
->prev_index_seq
);
1827 } else if (stream
->prev_index_seq
!= stream
->rotate_at_seq_num
) {
1829 * Unexpected, protocol error/bug.
1830 * It could mean that we received a rotation position
1831 * that is in the past.
1833 ERR("Stream %" PRIu64
" index is in an inconsistent state (rotate_at_seq_num = %" PRIu64
", prev_data_seq = %" PRIu64
", prev_index_seq = %" PRIu64
")",
1834 stream
->stream_handle
,
1835 stream
->rotate_at_seq_num
,
1836 stream
->prev_data_seq
,
1837 stream
->prev_index_seq
);
1841 DBG("Rotating stream %" PRIu64
" index file",
1842 stream
->stream_handle
);
1843 ret
= create_rotate_index_file(stream
, stream
->path_name
);
1844 stream
->index_rotated
= true;
1846 if (stream
->data_rotated
&& stream
->index_rotated
) {
1847 /* Rotation completed; reset its state. */
1848 DBG("Rotation completed for stream %" PRIu64
,
1849 stream
->stream_handle
);
1850 stream
->rotate_at_seq_num
= -1ULL;
1851 stream
->data_rotated
= false;
1852 stream
->index_rotated
= false;
1861 * Check if a stream's data file (as opposed to index) should be rotated
1862 * (for session rotation).
1863 * Must be called with the stream lock held.
1865 * Return 0 on success, a negative value on error.
1868 int try_rotate_stream_data(struct relay_stream
*stream
)
1872 if (stream
->rotate_at_seq_num
== -1ULL) {
1873 /* No rotation expected. */
1877 if (stream
->data_rotated
) {
1878 /* Rotation of the data file has already occurred. */
1882 if (stream
->prev_data_seq
== -1ULL ||
1883 stream
->prev_data_seq
< stream
->rotate_at_seq_num
) {
1884 DBG("Stream %" PRIu64
" not yet ready for rotation (rotate_at_seq_num = %" PRIu64
", prev_data_seq = %" PRIu64
")",
1885 stream
->stream_handle
,
1886 stream
->rotate_at_seq_num
,
1887 stream
->prev_data_seq
);
1889 } else if (stream
->prev_data_seq
> stream
->rotate_at_seq_num
) {
1891 * prev_data_seq is checked here since indexes and rotation
1892 * commands are serialized with respect to each other.
1894 DBG("Rotation after too much data has been written in tracefile "
1895 "for stream %" PRIu64
", need to truncate before "
1896 "rotating", stream
->stream_handle
);
1897 ret
= rotate_truncate_stream(stream
);
1899 ERR("Failed to truncate stream");
1902 } else if (stream
->prev_data_seq
!= stream
->rotate_at_seq_num
) {
1904 * Unexpected, protocol error/bug.
1905 * It could mean that we received a rotation position
1906 * that is in the past.
1908 ERR("Stream %" PRIu64
" data is in an inconsistent state (rotate_at_seq_num = %" PRIu64
", prev_data_seq = %" PRIu64
")",
1909 stream
->stream_handle
,
1910 stream
->rotate_at_seq_num
,
1911 stream
->prev_data_seq
);
1915 ret
= do_rotate_stream_data(stream
);
1923 * relay_recv_metadata: receive the metadata for the session.
1925 static int relay_recv_metadata(const struct lttcomm_relayd_hdr
*recv_hdr
,
1926 struct relay_connection
*conn
,
1927 const struct lttng_buffer_view
*payload
)
1931 struct relay_session
*session
= conn
->session
;
1932 struct lttcomm_relayd_metadata_payload metadata_payload_header
;
1933 struct relay_stream
*metadata_stream
;
1934 uint64_t metadata_payload_size
;
1937 ERR("Metadata sent before version check");
1942 if (recv_hdr
->data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1943 ERR("Incorrect data size");
1947 metadata_payload_size
= recv_hdr
->data_size
-
1948 sizeof(struct lttcomm_relayd_metadata_payload
);
1950 memcpy(&metadata_payload_header
, payload
->data
,
1951 sizeof(metadata_payload_header
));
1952 metadata_payload_header
.stream_id
= be64toh(
1953 metadata_payload_header
.stream_id
);
1954 metadata_payload_header
.padding_size
= be32toh(
1955 metadata_payload_header
.padding_size
);
1957 metadata_stream
= stream_get_by_id(metadata_payload_header
.stream_id
);
1958 if (!metadata_stream
) {
1963 pthread_mutex_lock(&metadata_stream
->lock
);
1965 size_ret
= lttng_write(metadata_stream
->stream_fd
->fd
,
1966 payload
->data
+ sizeof(metadata_payload_header
),
1967 metadata_payload_size
);
1968 if (size_ret
< metadata_payload_size
) {
1969 ERR("Relay error writing metadata on file");
1974 size_ret
= write_padding_to_file(metadata_stream
->stream_fd
->fd
,
1975 metadata_payload_header
.padding_size
);
1976 if (size_ret
< (int64_t) metadata_payload_header
.padding_size
) {
1981 metadata_stream
->metadata_received
+=
1982 metadata_payload_size
+ metadata_payload_header
.padding_size
;
1983 DBG2("Relay metadata written. Updated metadata_received %" PRIu64
,
1984 metadata_stream
->metadata_received
);
1986 ret
= try_rotate_stream_data(metadata_stream
);
1992 pthread_mutex_unlock(&metadata_stream
->lock
);
1993 stream_put(metadata_stream
);
1999 * relay_send_version: send relayd version number
2001 static int relay_send_version(const struct lttcomm_relayd_hdr
*recv_hdr
,
2002 struct relay_connection
*conn
,
2003 const struct lttng_buffer_view
*payload
)
2007 struct lttcomm_relayd_version reply
, msg
;
2008 bool compatible
= true;
2010 conn
->version_check_done
= true;
2012 /* Get version from the other side. */
2013 if (payload
->size
< sizeof(msg
)) {
2014 ERR("Unexpected payload size in \"relay_send_version\": expected >= %zu bytes, got %zu bytes",
2015 sizeof(msg
), payload
->size
);
2020 memcpy(&msg
, payload
->data
, sizeof(msg
));
2021 msg
.major
= be32toh(msg
.major
);
2022 msg
.minor
= be32toh(msg
.minor
);
2024 memset(&reply
, 0, sizeof(reply
));
2025 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
2026 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
2028 /* Major versions must be the same */
2029 if (reply
.major
!= msg
.major
) {
2030 DBG("Incompatible major versions (%u vs %u), deleting session",
2031 reply
.major
, msg
.major
);
2035 conn
->major
= reply
.major
;
2036 /* We adapt to the lowest compatible version */
2037 if (reply
.minor
<= msg
.minor
) {
2038 conn
->minor
= reply
.minor
;
2040 conn
->minor
= msg
.minor
;
2043 reply
.major
= htobe32(reply
.major
);
2044 reply
.minor
= htobe32(reply
.minor
);
2045 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2047 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2048 ERR("Failed to send \"send version\" command reply (ret = %zd)",
2061 DBG("Version check done using protocol %u.%u", conn
->major
,
2069 * Check for data pending for a given stream id from the session daemon.
2071 static int relay_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2072 struct relay_connection
*conn
,
2073 const struct lttng_buffer_view
*payload
)
2075 struct relay_session
*session
= conn
->session
;
2076 struct lttcomm_relayd_data_pending msg
;
2077 struct lttcomm_relayd_generic_reply reply
;
2078 struct relay_stream
*stream
;
2081 uint64_t stream_seq
;
2083 DBG("Data pending command received");
2085 if (!session
|| !conn
->version_check_done
) {
2086 ERR("Trying to check for data before version check");
2088 goto end_no_session
;
2091 if (payload
->size
< sizeof(msg
)) {
2092 ERR("Unexpected payload size in \"relay_data_pending\": expected >= %zu bytes, got %zu bytes",
2093 sizeof(msg
), payload
->size
);
2095 goto end_no_session
;
2097 memcpy(&msg
, payload
->data
, sizeof(msg
));
2098 msg
.stream_id
= be64toh(msg
.stream_id
);
2099 msg
.last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
2101 stream
= stream_get_by_id(msg
.stream_id
);
2102 if (stream
== NULL
) {
2107 pthread_mutex_lock(&stream
->lock
);
2109 if (session_streams_have_index(session
)) {
2111 * Ensure that both the index and stream data have been
2112 * flushed up to the requested point.
2114 stream_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
2116 stream_seq
= stream
->prev_data_seq
;
2118 DBG("Data pending for stream id %" PRIu64
": prev_data_seq %" PRIu64
2119 ", prev_index_seq %" PRIu64
2120 ", and last_seq %" PRIu64
, msg
.stream_id
,
2121 stream
->prev_data_seq
, stream
->prev_index_seq
,
2122 msg
.last_net_seq_num
);
2124 /* Avoid wrapping issue */
2125 if (((int64_t) (stream_seq
- msg
.last_net_seq_num
)) >= 0) {
2126 /* Data has in fact been written and is NOT pending */
2129 /* Data still being streamed thus pending */
2133 stream
->data_pending_check_done
= true;
2134 pthread_mutex_unlock(&stream
->lock
);
2139 memset(&reply
, 0, sizeof(reply
));
2140 reply
.ret_code
= htobe32(ret
);
2141 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2142 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2143 ERR("Failed to send \"data pending\" command reply (ret = %zd)",
2153 * Wait for the control socket to reach a quiescent state.
2155 * Note that for now, when receiving this command from the session
2156 * daemon, this means that every subsequent commands or data received on
2157 * the control socket has been handled. So, this is why we simply return
2160 static int relay_quiescent_control(const struct lttcomm_relayd_hdr
*recv_hdr
,
2161 struct relay_connection
*conn
,
2162 const struct lttng_buffer_view
*payload
)
2166 struct relay_stream
*stream
;
2167 struct lttcomm_relayd_quiescent_control msg
;
2168 struct lttcomm_relayd_generic_reply reply
;
2170 DBG("Checking quiescent state on control socket");
2172 if (!conn
->session
|| !conn
->version_check_done
) {
2173 ERR("Trying to check for data before version check");
2175 goto end_no_session
;
2178 if (payload
->size
< sizeof(msg
)) {
2179 ERR("Unexpected payload size in \"relay_quiescent_control\": expected >= %zu bytes, got %zu bytes",
2180 sizeof(msg
), payload
->size
);
2182 goto end_no_session
;
2184 memcpy(&msg
, payload
->data
, sizeof(msg
));
2185 msg
.stream_id
= be64toh(msg
.stream_id
);
2187 stream
= stream_get_by_id(msg
.stream_id
);
2191 pthread_mutex_lock(&stream
->lock
);
2192 stream
->data_pending_check_done
= true;
2193 pthread_mutex_unlock(&stream
->lock
);
2195 DBG("Relay quiescent control pending flag set to %" PRIu64
, msg
.stream_id
);
2198 memset(&reply
, 0, sizeof(reply
));
2199 reply
.ret_code
= htobe32(LTTNG_OK
);
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 \"quiescent control\" command reply (ret = %zd)",
2214 * Initialize a data pending command. This means that a consumer is about
2215 * to ask for data pending for each stream it holds. Simply iterate over
2216 * all streams of a session and set the data_pending_check_done flag.
2218 * This command returns to the client a LTTNG_OK code.
2220 static int relay_begin_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2221 struct relay_connection
*conn
,
2222 const struct lttng_buffer_view
*payload
)
2226 struct lttng_ht_iter iter
;
2227 struct lttcomm_relayd_begin_data_pending msg
;
2228 struct lttcomm_relayd_generic_reply reply
;
2229 struct relay_stream
*stream
;
2234 DBG("Init streams for data pending");
2236 if (!conn
->session
|| !conn
->version_check_done
) {
2237 ERR("Trying to check for data before version check");
2239 goto end_no_session
;
2242 if (payload
->size
< sizeof(msg
)) {
2243 ERR("Unexpected payload size in \"relay_begin_data_pending\": expected >= %zu bytes, got %zu bytes",
2244 sizeof(msg
), payload
->size
);
2246 goto end_no_session
;
2248 memcpy(&msg
, payload
->data
, sizeof(msg
));
2249 msg
.session_id
= be64toh(msg
.session_id
);
2252 * Iterate over all streams to set the begin data pending flag.
2253 * For now, the streams are indexed by stream handle so we have
2254 * to iterate over all streams to find the one associated with
2255 * the right session_id.
2258 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2260 if (!stream_get(stream
)) {
2263 if (stream
->trace
->session
->id
== msg
.session_id
) {
2264 pthread_mutex_lock(&stream
->lock
);
2265 stream
->data_pending_check_done
= false;
2266 pthread_mutex_unlock(&stream
->lock
);
2267 DBG("Set begin data pending flag to stream %" PRIu64
,
2268 stream
->stream_handle
);
2274 memset(&reply
, 0, sizeof(reply
));
2275 /* All good, send back reply. */
2276 reply
.ret_code
= htobe32(LTTNG_OK
);
2278 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2279 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2280 ERR("Failed to send \"begin data pending\" command reply (ret = %zd)",
2292 * End data pending command. This will check, for a given session id, if
2293 * each stream associated with it has its data_pending_check_done flag
2294 * set. If not, this means that the client lost track of the stream but
2295 * the data is still being streamed on our side. In this case, we inform
2296 * the client that data is in flight.
2298 * Return to the client if there is data in flight or not with a ret_code.
2300 static int relay_end_data_pending(const struct lttcomm_relayd_hdr
*recv_hdr
,
2301 struct relay_connection
*conn
,
2302 const struct lttng_buffer_view
*payload
)
2306 struct lttng_ht_iter iter
;
2307 struct lttcomm_relayd_end_data_pending msg
;
2308 struct lttcomm_relayd_generic_reply reply
;
2309 struct relay_stream
*stream
;
2310 uint32_t is_data_inflight
= 0;
2312 DBG("End data pending command");
2314 if (!conn
->session
|| !conn
->version_check_done
) {
2315 ERR("Trying to check for data before version check");
2317 goto end_no_session
;
2320 if (payload
->size
< sizeof(msg
)) {
2321 ERR("Unexpected payload size in \"relay_end_data_pending\": expected >= %zu bytes, got %zu bytes",
2322 sizeof(msg
), payload
->size
);
2324 goto end_no_session
;
2326 memcpy(&msg
, payload
->data
, sizeof(msg
));
2327 msg
.session_id
= be64toh(msg
.session_id
);
2330 * Iterate over all streams to see if the begin data pending
2334 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
2336 if (!stream_get(stream
)) {
2339 if (stream
->trace
->session
->id
!= msg
.session_id
) {
2343 pthread_mutex_lock(&stream
->lock
);
2344 if (!stream
->data_pending_check_done
) {
2345 uint64_t stream_seq
;
2347 if (session_streams_have_index(conn
->session
)) {
2349 * Ensure that both the index and stream data have been
2350 * flushed up to the requested point.
2352 stream_seq
= min(stream
->prev_data_seq
, stream
->prev_index_seq
);
2354 stream_seq
= stream
->prev_data_seq
;
2356 if (!stream
->closed
|| !(((int64_t) (stream_seq
- stream
->last_net_seq_num
)) >= 0)) {
2357 is_data_inflight
= 1;
2358 DBG("Data is still in flight for stream %" PRIu64
,
2359 stream
->stream_handle
);
2360 pthread_mutex_unlock(&stream
->lock
);
2365 pthread_mutex_unlock(&stream
->lock
);
2370 memset(&reply
, 0, sizeof(reply
));
2371 /* All good, send back reply. */
2372 reply
.ret_code
= htobe32(is_data_inflight
);
2374 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2375 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2376 ERR("Failed to send \"end data pending\" command reply (ret = %zd)",
2388 * Receive an index for a specific stream.
2390 * Return 0 on success else a negative value.
2392 static int relay_recv_index(const struct lttcomm_relayd_hdr
*recv_hdr
,
2393 struct relay_connection
*conn
,
2394 const struct lttng_buffer_view
*payload
)
2398 struct relay_session
*session
= conn
->session
;
2399 struct lttcomm_relayd_index index_info
;
2400 struct relay_index
*index
;
2401 struct lttcomm_relayd_generic_reply reply
;
2402 struct relay_stream
*stream
;
2407 DBG("Relay receiving index");
2409 if (!session
|| !conn
->version_check_done
) {
2410 ERR("Trying to close a stream before version check");
2412 goto end_no_session
;
2415 msg_len
= lttcomm_relayd_index_len(
2416 lttng_to_index_major(conn
->major
, conn
->minor
),
2417 lttng_to_index_minor(conn
->major
, conn
->minor
));
2418 if (payload
->size
< msg_len
) {
2419 ERR("Unexpected payload size in \"relay_recv_index\": expected >= %zu bytes, got %zu bytes",
2420 msg_len
, payload
->size
);
2422 goto end_no_session
;
2424 memcpy(&index_info
, payload
->data
, msg_len
);
2425 index_info
.relay_stream_id
= be64toh(index_info
.relay_stream_id
);
2426 index_info
.net_seq_num
= be64toh(index_info
.net_seq_num
);
2427 index_info
.packet_size
= be64toh(index_info
.packet_size
);
2428 index_info
.content_size
= be64toh(index_info
.content_size
);
2429 index_info
.timestamp_begin
= be64toh(index_info
.timestamp_begin
);
2430 index_info
.timestamp_end
= be64toh(index_info
.timestamp_end
);
2431 index_info
.events_discarded
= be64toh(index_info
.events_discarded
);
2432 index_info
.stream_id
= be64toh(index_info
.stream_id
);
2434 if (conn
->minor
>= 8) {
2435 index_info
.stream_instance_id
=
2436 be64toh(index_info
.stream_instance_id
);
2437 index_info
.packet_seq_num
= be64toh(index_info
.packet_seq_num
);
2440 stream
= stream_get_by_id(index_info
.relay_stream_id
);
2442 ERR("stream_get_by_id not found");
2446 pthread_mutex_lock(&stream
->lock
);
2448 /* Live beacon handling */
2449 if (index_info
.packet_size
== 0) {
2450 DBG("Received live beacon for stream %" PRIu64
,
2451 stream
->stream_handle
);
2454 * Only flag a stream inactive when it has already
2455 * received data and no indexes are in flight.
2457 if (stream
->index_received_seqcount
> 0
2458 && stream
->indexes_in_flight
== 0) {
2459 stream
->beacon_ts_end
= index_info
.timestamp_end
;
2462 goto end_stream_put
;
2464 stream
->beacon_ts_end
= -1ULL;
2467 if (stream
->ctf_stream_id
== -1ULL) {
2468 stream
->ctf_stream_id
= index_info
.stream_id
;
2470 index
= relay_index_get_by_id_or_create(stream
, index_info
.net_seq_num
);
2473 ERR("relay_index_get_by_id_or_create index NULL");
2474 goto end_stream_put
;
2476 if (set_index_control_data(index
, &index_info
, conn
)) {
2477 ERR("set_index_control_data error");
2478 relay_index_put(index
);
2480 goto end_stream_put
;
2482 ret
= relay_index_try_flush(index
);
2484 tracefile_array_commit_seq(stream
->tfa
);
2485 stream
->index_received_seqcount
++;
2486 stream
->pos_after_last_complete_data_index
+= index
->total_size
;
2487 stream
->prev_index_seq
= index_info
.net_seq_num
;
2489 ret
= try_rotate_stream_index(stream
);
2491 goto end_stream_put
;
2493 } else if (ret
> 0) {
2500 * relay_index_try_flush is responsible for the self-reference
2501 * put of the index object on error.
2503 ERR("relay_index_try_flush error %d", ret
);
2508 pthread_mutex_unlock(&stream
->lock
);
2513 memset(&reply
, 0, sizeof(reply
));
2515 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2517 reply
.ret_code
= htobe32(LTTNG_OK
);
2519 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2520 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2521 ERR("Failed to send \"recv index\" command reply (ret = %zd)", send_ret
);
2530 * Receive the streams_sent message.
2532 * Return 0 on success else a negative value.
2534 static int relay_streams_sent(const struct lttcomm_relayd_hdr
*recv_hdr
,
2535 struct relay_connection
*conn
,
2536 const struct lttng_buffer_view
*payload
)
2540 struct lttcomm_relayd_generic_reply reply
;
2544 DBG("Relay receiving streams_sent");
2546 if (!conn
->session
|| !conn
->version_check_done
) {
2547 ERR("Trying to close a stream before version check");
2549 goto end_no_session
;
2553 * Publish every pending stream in the connection recv list which are
2554 * now ready to be used by the viewer.
2556 publish_connection_local_streams(conn
);
2558 memset(&reply
, 0, sizeof(reply
));
2559 reply
.ret_code
= htobe32(LTTNG_OK
);
2560 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2561 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2562 ERR("Failed to send \"streams sent\" command reply (ret = %zd)",
2575 * relay_rotate_session_stream: rotate a stream to a new tracefile for the session
2576 * rotation feature (not the tracefile rotation feature).
2578 static int relay_rotate_session_stream(const struct lttcomm_relayd_hdr
*recv_hdr
,
2579 struct relay_connection
*conn
,
2580 const struct lttng_buffer_view
*payload
)
2584 struct relay_session
*session
= conn
->session
;
2585 struct lttcomm_relayd_rotate_stream stream_info
;
2586 struct lttcomm_relayd_generic_reply reply
;
2587 struct relay_stream
*stream
;
2590 struct lttng_buffer_view new_path_view
;
2592 if (!session
|| !conn
->version_check_done
) {
2593 ERR("Trying to rotate a stream before version check");
2598 if (session
->major
== 2 && session
->minor
< 11) {
2599 ERR("Unsupported feature before 2.11");
2604 header_len
= sizeof(struct lttcomm_relayd_rotate_stream
);
2606 if (payload
->size
< header_len
) {
2607 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected >= %zu bytes, got %zu bytes",
2608 header_len
, payload
->size
);
2613 memcpy(&stream_info
, payload
->data
, header_len
);
2615 /* Convert to host */
2616 stream_info
.pathname_length
= be32toh(stream_info
.pathname_length
);
2617 stream_info
.stream_id
= be64toh(stream_info
.stream_id
);
2618 stream_info
.new_chunk_id
= be64toh(stream_info
.new_chunk_id
);
2619 stream_info
.rotate_at_seq_num
= be64toh(stream_info
.rotate_at_seq_num
);
2621 path_len
= stream_info
.pathname_length
;
2622 if (payload
->size
< header_len
+ path_len
) {
2623 ERR("Unexpected payload size in \"relay_rotate_session_stream\" including path: expected >= %zu bytes, got %zu bytes",
2624 header_len
+ path_len
, payload
->size
);
2629 /* Ensure it fits in local filename length. */
2630 if (path_len
>= LTTNG_PATH_MAX
) {
2631 ret
= -ENAMETOOLONG
;
2632 ERR("Length of relay_rotate_session_stream command's path name (%zu bytes) exceeds the maximal allowed length of %i bytes",
2633 path_len
, LTTNG_PATH_MAX
);
2637 new_path_view
= lttng_buffer_view_from_view(payload
, header_len
,
2638 stream_info
.pathname_length
);
2640 stream
= stream_get_by_id(stream_info
.stream_id
);
2646 pthread_mutex_lock(&stream
->lock
);
2649 * Update the trace path (just the folder, the stream name does not
2652 free(stream
->prev_path_name
);
2653 stream
->prev_path_name
= stream
->path_name
;
2654 stream
->path_name
= create_output_path(new_path_view
.data
);
2655 if (!stream
->path_name
) {
2656 ERR("Failed to create a new output path");
2658 goto end_stream_unlock
;
2660 ret
= utils_mkdir_recursive(stream
->path_name
, S_IRWXU
| S_IRWXG
,
2663 ERR("relay creating output directory");
2665 goto end_stream_unlock
;
2668 if (stream
->is_metadata
) {
2670 * Metadata streams have no index; consider its rotation
2673 stream
->index_rotated
= true;
2675 * The metadata stream is sent only over the control connection
2676 * so we know we have all the data to perform the stream
2679 ret
= do_rotate_stream_data(stream
);
2681 stream
->rotate_at_seq_num
= stream_info
.rotate_at_seq_num
;
2682 ret
= try_rotate_stream_data(stream
);
2684 goto end_stream_unlock
;
2687 ret
= try_rotate_stream_index(stream
);
2689 goto end_stream_unlock
;
2694 pthread_mutex_unlock(&stream
->lock
);
2697 memset(&reply
, 0, sizeof(reply
));
2699 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2701 reply
.ret_code
= htobe32(LTTNG_OK
);
2703 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
2704 sizeof(struct lttcomm_relayd_generic_reply
), 0);
2705 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2706 ERR("Failed to send \"rotate session stream\" command reply (ret = %zd)",
2715 static int init_session_output_directory_handle(struct relay_session
*session
,
2716 struct lttng_directory_handle
*handle
)
2719 /* hostname/session_name */
2720 char *session_directory
= NULL
;
2722 * base path + session_directory
2723 * e.g. /home/user/lttng-traces/hostname/session_name
2725 char *full_session_path
= NULL
;
2726 char creation_time_str
[16];
2727 struct tm
*timeinfo
;
2729 assert(session
->creation_time
.is_set
);
2730 timeinfo
= localtime(&session
->creation_time
.value
);
2735 strftime(creation_time_str
, sizeof(creation_time_str
), "%Y%m%d-%H%M%S",
2738 pthread_mutex_lock(&session
->lock
);
2739 ret
= asprintf(&session_directory
, "%s/%s-%s", session
->hostname
,
2740 session
->session_name
, creation_time_str
);
2741 pthread_mutex_unlock(&session
->lock
);
2743 PERROR("Failed to format session directory name");
2747 full_session_path
= create_output_path(session_directory
);
2748 if (!full_session_path
) {
2753 ret
= utils_mkdir_recursive(
2754 full_session_path
, S_IRWXU
| S_IRWXG
, -1, -1);
2756 ERR("Failed to create session output path \"%s\"",
2761 ret
= lttng_directory_handle_init(handle
, full_session_path
);
2766 free(session_directory
);
2767 free(full_session_path
);
2772 * relay_create_trace_chunk: create a new trace chunk
2774 static int relay_create_trace_chunk(const struct lttcomm_relayd_hdr
*recv_hdr
,
2775 struct relay_connection
*conn
,
2776 const struct lttng_buffer_view
*payload
)
2780 struct relay_session
*session
= conn
->session
;
2781 struct lttcomm_relayd_create_trace_chunk
*msg
;
2782 struct lttcomm_relayd_generic_reply reply
= {};
2783 struct lttng_buffer_view header_view
;
2784 struct lttng_buffer_view chunk_name_view
;
2785 struct lttng_trace_chunk
*chunk
= NULL
, *published_chunk
= NULL
;
2786 enum lttng_error_code reply_code
= LTTNG_OK
;
2787 enum lttng_trace_chunk_status chunk_status
;
2788 struct lttng_directory_handle session_output
;
2790 if (!session
|| !conn
->version_check_done
) {
2791 ERR("Trying to create a trace chunk before version check");
2796 if (session
->major
== 2 && session
->minor
< 11) {
2797 ERR("Chunk creation command is unsupported before 2.11");
2802 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
2803 if (!header_view
.data
) {
2804 ERR("Failed to receive payload of chunk creation command");
2809 /* Convert to host endianness. */
2810 msg
= (typeof(msg
)) header_view
.data
;
2811 msg
->chunk_id
= be64toh(msg
->chunk_id
);
2812 msg
->creation_timestamp
= be64toh(msg
->creation_timestamp
);
2813 msg
->override_name_length
= be32toh(msg
->override_name_length
);
2815 chunk
= lttng_trace_chunk_create(
2816 msg
->chunk_id
, msg
->creation_timestamp
);
2818 ERR("Failed to create trace chunk in trace chunk creation command");
2820 reply_code
= LTTNG_ERR_NOMEM
;
2824 if (msg
->override_name_length
) {
2827 chunk_name_view
= lttng_buffer_view_from_view(payload
,
2829 msg
->override_name_length
);
2830 name
= chunk_name_view
.data
;
2831 if (!name
|| name
[msg
->override_name_length
- 1]) {
2832 ERR("Failed to receive payload of chunk creation command");
2834 reply_code
= LTTNG_ERR_INVALID
;
2838 chunk_status
= lttng_trace_chunk_override_name(
2839 chunk
, chunk_name_view
.data
);
2840 switch (chunk_status
) {
2841 case LTTNG_TRACE_CHUNK_STATUS_OK
:
2843 case LTTNG_TRACE_CHUNK_STATUS_INVALID_ARGUMENT
:
2844 ERR("Failed to set the name of new trace chunk in trace chunk creation command (invalid name)");
2845 reply_code
= LTTNG_ERR_INVALID
;
2849 ERR("Failed to set the name of new trace chunk in trace chunk creation command (unknown error)");
2850 reply_code
= LTTNG_ERR_UNK
;
2856 ret
= init_session_output_directory_handle(
2857 conn
->session
, &session_output
);
2859 reply_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
2863 chunk_status
= lttng_trace_chunk_set_credentials_current_user(chunk
);
2864 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2865 reply_code
= LTTNG_ERR_UNK
;
2870 chunk_status
= lttng_trace_chunk_set_as_owner(chunk
, &session_output
);
2871 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2872 reply_code
= LTTNG_ERR_UNK
;
2877 published_chunk
= sessiond_trace_chunk_registry_publish_chunk(
2878 sessiond_trace_chunk_registry
,
2879 conn
->session
->sessiond_uuid
,
2882 if (!published_chunk
) {
2883 char uuid_str
[UUID_STR_LEN
];
2885 lttng_uuid_to_str(conn
->session
->sessiond_uuid
, uuid_str
);
2886 ERR("Failed to publish chunk: sessiond_uuid = %s, session_id = %" PRIu64
", chunk_id = %" PRIu64
,
2891 reply_code
= LTTNG_ERR_NOMEM
;
2895 pthread_mutex_lock(&conn
->session
->lock
);
2896 lttng_trace_chunk_put(conn
->session
->current_trace_chunk
);
2897 conn
->session
->current_trace_chunk
= published_chunk
;
2898 pthread_mutex_unlock(&conn
->session
->lock
);
2899 published_chunk
= NULL
;
2902 reply
.ret_code
= htobe32((uint32_t) reply_code
);
2903 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
,
2905 sizeof(struct lttcomm_relayd_generic_reply
),
2907 if (send_ret
< (ssize_t
) sizeof(reply
)) {
2908 ERR("Failed to send \"create trace chunk\" command reply (ret = %zd)",
2913 lttng_trace_chunk_put(chunk
);
2914 lttng_trace_chunk_put(published_chunk
);
2915 lttng_directory_handle_fini(&session_output
);
2920 * relay_close_trace_chunk: close a trace chunk
2922 static int relay_close_trace_chunk(const struct lttcomm_relayd_hdr
*recv_hdr
,
2923 struct relay_connection
*conn
,
2924 const struct lttng_buffer_view
*payload
)
2928 struct relay_session
*session
= conn
->session
;
2929 struct lttcomm_relayd_close_trace_chunk
*msg
;
2930 struct lttcomm_relayd_generic_reply reply
= {};
2931 struct lttng_buffer_view header_view
;
2932 struct lttng_trace_chunk
*chunk
= NULL
;
2933 enum lttng_error_code reply_code
= LTTNG_OK
;
2934 enum lttng_trace_chunk_status chunk_status
;
2936 LTTNG_OPTIONAL(enum lttng_trace_chunk_command_type
) close_command
;
2937 time_t close_timestamp
;
2939 if (!session
|| !conn
->version_check_done
) {
2940 ERR("Trying to close a trace chunk before version check");
2945 if (session
->major
== 2 && session
->minor
< 11) {
2946 ERR("Chunk close command is unsupported before 2.11");
2951 header_view
= lttng_buffer_view_from_view(payload
, 0, sizeof(*msg
));
2952 if (!header_view
.data
) {
2953 ERR("Failed to receive payload of chunk close command");
2958 /* Convert to host endianness. */
2959 msg
= (typeof(msg
)) header_view
.data
;
2960 chunk_id
= be64toh(msg
->chunk_id
);
2961 close_timestamp
= (time_t) be64toh(msg
->close_timestamp
);
2962 close_command
= (typeof(close_command
)){
2963 .value
= be32toh(msg
->close_command
.value
),
2964 .is_set
= msg
->close_command
.is_set
,
2967 chunk
= sessiond_trace_chunk_registry_get_chunk(
2968 sessiond_trace_chunk_registry
,
2969 conn
->session
->sessiond_uuid
,
2973 char uuid_str
[UUID_STR_LEN
];
2975 lttng_uuid_to_str(conn
->session
->sessiond_uuid
, uuid_str
);
2976 ERR("Failed to find chunk to close: sessiond_uuid = %s, session_id = %" PRIu64
", chunk_id = %" PRIu64
,
2981 reply_code
= LTTNG_ERR_NOMEM
;
2985 chunk_status
= lttng_trace_chunk_set_close_timestamp(
2986 chunk
, close_timestamp
);
2987 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2988 ERR("Failed to set trace chunk close timestamp");
2990 reply_code
= LTTNG_ERR_UNK
;
2994 if (close_command
.is_set
) {
2995 chunk_status
= lttng_trace_chunk_set_close_command(
2996 chunk
, close_command
.value
);
2997 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2999 reply_code
= LTTNG_ERR_INVALID
;
3005 reply
.ret_code
= htobe32((uint32_t) reply_code
);
3006 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
,
3008 sizeof(struct lttcomm_relayd_generic_reply
),
3010 if (send_ret
< (ssize_t
) sizeof(reply
)) {
3011 ERR("Failed to send \"create trace chunk\" command reply (ret = %zd)",
3016 lttng_trace_chunk_put(chunk
);
3020 #define DBG_CMD(cmd_name, conn) \
3021 DBG3("Processing \"%s\" command for socket %i", cmd_name, conn->sock->fd);
3023 static int relay_process_control_command(struct relay_connection
*conn
,
3024 const struct lttcomm_relayd_hdr
*header
,
3025 const struct lttng_buffer_view
*payload
)
3029 switch (header
->cmd
) {
3030 case RELAYD_CREATE_SESSION
:
3031 DBG_CMD("RELAYD_CREATE_SESSION", conn
);
3032 ret
= relay_create_session(header
, conn
, payload
);
3034 case RELAYD_ADD_STREAM
:
3035 DBG_CMD("RELAYD_ADD_STREAM", conn
);
3036 ret
= relay_add_stream(header
, conn
, payload
);
3038 case RELAYD_START_DATA
:
3039 DBG_CMD("RELAYD_START_DATA", conn
);
3040 ret
= relay_start(header
, conn
, payload
);
3042 case RELAYD_SEND_METADATA
:
3043 DBG_CMD("RELAYD_SEND_METADATA", conn
);
3044 ret
= relay_recv_metadata(header
, conn
, payload
);
3046 case RELAYD_VERSION
:
3047 DBG_CMD("RELAYD_VERSION", conn
);
3048 ret
= relay_send_version(header
, conn
, payload
);
3050 case RELAYD_CLOSE_STREAM
:
3051 DBG_CMD("RELAYD_CLOSE_STREAM", conn
);
3052 ret
= relay_close_stream(header
, conn
, payload
);
3054 case RELAYD_DATA_PENDING
:
3055 DBG_CMD("RELAYD_DATA_PENDING", conn
);
3056 ret
= relay_data_pending(header
, conn
, payload
);
3058 case RELAYD_QUIESCENT_CONTROL
:
3059 DBG_CMD("RELAYD_QUIESCENT_CONTROL", conn
);
3060 ret
= relay_quiescent_control(header
, conn
, payload
);
3062 case RELAYD_BEGIN_DATA_PENDING
:
3063 DBG_CMD("RELAYD_BEGIN_DATA_PENDING", conn
);
3064 ret
= relay_begin_data_pending(header
, conn
, payload
);
3066 case RELAYD_END_DATA_PENDING
:
3067 DBG_CMD("RELAYD_END_DATA_PENDING", conn
);
3068 ret
= relay_end_data_pending(header
, conn
, payload
);
3070 case RELAYD_SEND_INDEX
:
3071 DBG_CMD("RELAYD_SEND_INDEX", conn
);
3072 ret
= relay_recv_index(header
, conn
, payload
);
3074 case RELAYD_STREAMS_SENT
:
3075 DBG_CMD("RELAYD_STREAMS_SENT", conn
);
3076 ret
= relay_streams_sent(header
, conn
, payload
);
3078 case RELAYD_RESET_METADATA
:
3079 DBG_CMD("RELAYD_RESET_METADATA", conn
);
3080 ret
= relay_reset_metadata(header
, conn
, payload
);
3082 case RELAYD_ROTATE_STREAM
:
3083 DBG_CMD("RELAYD_ROTATE_STREAM", conn
);
3084 ret
= relay_rotate_session_stream(header
, conn
, payload
);
3086 case RELAYD_CREATE_TRACE_CHUNK
:
3087 DBG_CMD("RELAYD_CREATE_TRACE_CHUNK", conn
);
3088 ret
= relay_create_trace_chunk(header
, conn
, payload
);
3090 case RELAYD_CLOSE_TRACE_CHUNK
:
3091 DBG_CMD("RELAYD_CLOSE_TRACE_CHUNK", conn
);
3092 ret
= relay_close_trace_chunk(header
, conn
, payload
);
3094 case RELAYD_UPDATE_SYNC_INFO
:
3096 ERR("Received unknown command (%u)", header
->cmd
);
3097 relay_unknown_command(conn
);
3106 static enum relay_connection_status
relay_process_control_receive_payload(
3107 struct relay_connection
*conn
)
3110 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3111 struct lttng_dynamic_buffer
*reception_buffer
=
3112 &conn
->protocol
.ctrl
.reception_buffer
;
3113 struct ctrl_connection_state_receive_payload
*state
=
3114 &conn
->protocol
.ctrl
.state
.receive_payload
;
3115 struct lttng_buffer_view payload_view
;
3117 if (state
->left_to_receive
== 0) {
3118 /* Short-circuit for payload-less commands. */
3119 goto reception_complete
;
3122 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3123 reception_buffer
->data
+ state
->received
,
3124 state
->left_to_receive
, MSG_DONTWAIT
);
3126 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3127 PERROR("Unable to receive command payload on sock %d",
3129 status
= RELAY_CONNECTION_STATUS_ERROR
;
3132 } else if (ret
== 0) {
3133 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3134 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3139 assert(ret
<= state
->left_to_receive
);
3141 state
->left_to_receive
-= ret
;
3142 state
->received
+= ret
;
3144 if (state
->left_to_receive
> 0) {
3146 * Can't transition to the protocol's next state, wait to
3147 * receive the rest of the header.
3149 DBG3("Partial reception of control connection protocol payload (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3150 state
->received
, state
->left_to_receive
,
3156 DBG("Done receiving control command payload: fd = %i, payload size = %" PRIu64
" bytes",
3157 conn
->sock
->fd
, state
->received
);
3159 * The payload required to process the command has been received.
3160 * A view to the reception buffer is forwarded to the various
3161 * commands and the state of the control is reset on success.
3163 * Commands are responsible for sending their reply to the peer.
3165 payload_view
= lttng_buffer_view_from_dynamic_buffer(reception_buffer
,
3167 ret
= relay_process_control_command(conn
,
3168 &state
->header
, &payload_view
);
3170 status
= RELAY_CONNECTION_STATUS_ERROR
;
3174 ret
= connection_reset_protocol_state(conn
);
3176 status
= RELAY_CONNECTION_STATUS_ERROR
;
3182 static enum relay_connection_status
relay_process_control_receive_header(
3183 struct relay_connection
*conn
)
3186 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3187 struct lttcomm_relayd_hdr header
;
3188 struct lttng_dynamic_buffer
*reception_buffer
=
3189 &conn
->protocol
.ctrl
.reception_buffer
;
3190 struct ctrl_connection_state_receive_header
*state
=
3191 &conn
->protocol
.ctrl
.state
.receive_header
;
3193 assert(state
->left_to_receive
!= 0);
3195 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3196 reception_buffer
->data
+ state
->received
,
3197 state
->left_to_receive
, MSG_DONTWAIT
);
3199 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3200 PERROR("Unable to receive control command header on sock %d",
3202 status
= RELAY_CONNECTION_STATUS_ERROR
;
3205 } else if (ret
== 0) {
3206 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3207 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3212 assert(ret
<= state
->left_to_receive
);
3214 state
->left_to_receive
-= ret
;
3215 state
->received
+= ret
;
3217 if (state
->left_to_receive
> 0) {
3219 * Can't transition to the protocol's next state, wait to
3220 * receive the rest of the header.
3222 DBG3("Partial reception of control connection protocol header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3223 state
->received
, state
->left_to_receive
,
3228 /* Transition to next state: receiving the command's payload. */
3229 conn
->protocol
.ctrl
.state_id
=
3230 CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3231 memcpy(&header
, reception_buffer
->data
, sizeof(header
));
3232 header
.circuit_id
= be64toh(header
.circuit_id
);
3233 header
.data_size
= be64toh(header
.data_size
);
3234 header
.cmd
= be32toh(header
.cmd
);
3235 header
.cmd_version
= be32toh(header
.cmd_version
);
3236 memcpy(&conn
->protocol
.ctrl
.state
.receive_payload
.header
,
3237 &header
, sizeof(header
));
3239 DBG("Done receiving control command header: fd = %i, cmd = %" PRIu32
", cmd_version = %" PRIu32
", payload size = %" PRIu64
" bytes",
3240 conn
->sock
->fd
, header
.cmd
, header
.cmd_version
,
3243 if (header
.data_size
> DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE
) {
3244 ERR("Command header indicates a payload (%" PRIu64
" bytes) that exceeds the maximal payload size allowed on a control connection.",
3246 status
= RELAY_CONNECTION_STATUS_ERROR
;
3250 conn
->protocol
.ctrl
.state
.receive_payload
.left_to_receive
=
3252 conn
->protocol
.ctrl
.state
.receive_payload
.received
= 0;
3253 ret
= lttng_dynamic_buffer_set_size(reception_buffer
,
3256 status
= RELAY_CONNECTION_STATUS_ERROR
;
3260 if (header
.data_size
== 0) {
3262 * Manually invoke the next state as the poll loop
3263 * will not wake-up to allow us to proceed further.
3265 status
= relay_process_control_receive_payload(conn
);
3272 * Process the commands received on the control socket
3274 static enum relay_connection_status
relay_process_control(
3275 struct relay_connection
*conn
)
3277 enum relay_connection_status status
;
3279 switch (conn
->protocol
.ctrl
.state_id
) {
3280 case CTRL_CONNECTION_STATE_RECEIVE_HEADER
:
3281 status
= relay_process_control_receive_header(conn
);
3283 case CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3284 status
= relay_process_control_receive_payload(conn
);
3287 ERR("Unknown control connection protocol state encountered.");
3295 * Handle index for a data stream.
3297 * Called with the stream lock held.
3299 * Return 0 on success else a negative value.
3301 static int handle_index_data(struct relay_stream
*stream
, uint64_t net_seq_num
,
3302 bool rotate_index
, bool *flushed
, uint64_t total_size
)
3305 uint64_t data_offset
;
3306 struct relay_index
*index
;
3308 /* Get data offset because we are about to update the index. */
3309 data_offset
= htobe64(stream
->tracefile_size_current
);
3311 DBG("handle_index_data: stream %" PRIu64
" net_seq_num %" PRIu64
" data offset %" PRIu64
,
3312 stream
->stream_handle
, net_seq_num
, stream
->tracefile_size_current
);
3315 * Lookup for an existing index for that stream id/sequence
3316 * number. If it exists, the control thread has already received the
3317 * data for it, thus we need to write it to disk.
3319 index
= relay_index_get_by_id_or_create(stream
, net_seq_num
);
3325 if (rotate_index
|| !stream
->index_file
) {
3326 const char *stream_path
;
3329 * The data connection creates the stream's first index file.
3331 * This can happen _after_ a ROTATE_STREAM command. In
3332 * other words, the data of the first packet of this stream
3333 * can be received after a ROTATE_STREAM command.
3335 * The ROTATE_STREAM command changes the stream's path_name
3336 * to point to the "next" chunk. If a rotation is pending for
3337 * this stream, as indicated by "rotate_at_seq_num != -1ULL",
3338 * it means that we are still receiving data that belongs in the
3339 * stream's former path.
3341 * In this very specific case, we must ensure that the index
3342 * file is created in the streams's former path,
3345 * All other rotations beyond the first one are not affected
3346 * by this problem since the actual rotation operation creates
3347 * the new chunk's index file.
3349 stream_path
= stream
->rotate_at_seq_num
== -1ULL ?
3351 stream
->prev_path_name
;
3353 ret
= create_rotate_index_file(stream
, stream_path
);
3355 ERR("Failed to rotate index");
3356 /* Put self-ref for this index due to error. */
3357 relay_index_put(index
);
3363 if (relay_index_set_file(index
, stream
->index_file
, data_offset
)) {
3365 /* Put self-ref for this index due to error. */
3366 relay_index_put(index
);
3371 ret
= relay_index_try_flush(index
);
3373 tracefile_array_commit_seq(stream
->tfa
);
3374 stream
->index_received_seqcount
++;
3376 } else if (ret
> 0) {
3377 index
->total_size
= total_size
;
3384 * relay_index_try_flush is responsible for the self-reference
3385 * put of the index object on error.
3387 ERR("relay_index_try_flush error %d", ret
);
3394 static enum relay_connection_status
relay_process_data_receive_header(
3395 struct relay_connection
*conn
)
3398 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3399 struct data_connection_state_receive_header
*state
=
3400 &conn
->protocol
.data
.state
.receive_header
;
3401 struct lttcomm_relayd_data_hdr header
;
3402 struct relay_stream
*stream
;
3404 assert(state
->left_to_receive
!= 0);
3406 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
,
3407 state
->header_reception_buffer
+ state
->received
,
3408 state
->left_to_receive
, MSG_DONTWAIT
);
3410 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3411 PERROR("Unable to receive data header on sock %d", conn
->sock
->fd
);
3412 status
= RELAY_CONNECTION_STATUS_ERROR
;
3415 } else if (ret
== 0) {
3416 /* Orderly shutdown. Not necessary to print an error. */
3417 DBG("Socket %d performed an orderly shutdown (received EOF)", conn
->sock
->fd
);
3418 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3423 assert(ret
<= state
->left_to_receive
);
3425 state
->left_to_receive
-= ret
;
3426 state
->received
+= ret
;
3428 if (state
->left_to_receive
> 0) {
3430 * Can't transition to the protocol's next state, wait to
3431 * receive the rest of the header.
3433 DBG3("Partial reception of data connection header (received %" PRIu64
" bytes, %" PRIu64
" bytes left to receive, fd = %i)",
3434 state
->received
, state
->left_to_receive
,
3439 /* Transition to next state: receiving the payload. */
3440 conn
->protocol
.data
.state_id
= DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
;
3442 memcpy(&header
, state
->header_reception_buffer
, sizeof(header
));
3443 header
.circuit_id
= be64toh(header
.circuit_id
);
3444 header
.stream_id
= be64toh(header
.stream_id
);
3445 header
.data_size
= be32toh(header
.data_size
);
3446 header
.net_seq_num
= be64toh(header
.net_seq_num
);
3447 header
.padding_size
= be32toh(header
.padding_size
);
3448 memcpy(&conn
->protocol
.data
.state
.receive_payload
.header
, &header
, sizeof(header
));
3450 conn
->protocol
.data
.state
.receive_payload
.left_to_receive
=
3452 conn
->protocol
.data
.state
.receive_payload
.received
= 0;
3453 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= false;
3455 DBG("Received data connection header on fd %i: circuit_id = %" PRIu64
", stream_id = %" PRIu64
", data_size = %" PRIu32
", net_seq_num = %" PRIu64
", padding_size = %" PRIu32
,
3456 conn
->sock
->fd
, header
.circuit_id
,
3457 header
.stream_id
, header
.data_size
,
3458 header
.net_seq_num
, header
.padding_size
);
3460 stream
= stream_get_by_id(header
.stream_id
);
3462 DBG("relay_process_data_receive_payload: Cannot find stream %" PRIu64
,
3464 /* Protocol error. */
3465 status
= RELAY_CONNECTION_STATUS_ERROR
;
3469 pthread_mutex_lock(&stream
->lock
);
3471 /* Check if a rotation is needed. */
3472 if (stream
->tracefile_size
> 0 &&
3473 (stream
->tracefile_size_current
+ header
.data_size
) >
3474 stream
->tracefile_size
) {
3475 uint64_t old_id
, new_id
;
3477 old_id
= tracefile_array_get_file_index_head(stream
->tfa
);
3478 tracefile_array_file_rotate(stream
->tfa
);
3480 /* new_id is updated by utils_rotate_stream_file. */
3483 ret
= utils_rotate_stream_file(stream
->path_name
,
3484 stream
->channel_name
, stream
->tracefile_size
,
3485 stream
->tracefile_count
, -1,
3486 -1, stream
->stream_fd
->fd
,
3487 &new_id
, &stream
->stream_fd
->fd
);
3489 ERR("Failed to rotate stream output file");
3490 status
= RELAY_CONNECTION_STATUS_ERROR
;
3491 goto end_stream_unlock
;
3495 * Reset current size because we just performed a stream
3498 stream
->tracefile_size_current
= 0;
3499 conn
->protocol
.data
.state
.receive_payload
.rotate_index
= true;
3503 pthread_mutex_unlock(&stream
->lock
);
3509 static enum relay_connection_status
relay_process_data_receive_payload(
3510 struct relay_connection
*conn
)
3513 enum relay_connection_status status
= RELAY_CONNECTION_STATUS_OK
;
3514 struct relay_stream
*stream
;
3515 struct data_connection_state_receive_payload
*state
=
3516 &conn
->protocol
.data
.state
.receive_payload
;
3517 const size_t chunk_size
= RECV_DATA_BUFFER_SIZE
;
3518 char data_buffer
[chunk_size
];
3519 bool partial_recv
= false;
3520 bool new_stream
= false, close_requested
= false, index_flushed
= false;
3521 uint64_t left_to_receive
= state
->left_to_receive
;
3522 struct relay_session
*session
;
3524 DBG3("Receiving data for stream id %" PRIu64
" seqnum %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3525 state
->header
.stream_id
, state
->header
.net_seq_num
,
3526 state
->received
, left_to_receive
);
3528 stream
= stream_get_by_id(state
->header
.stream_id
);
3530 /* Protocol error. */
3531 ERR("relay_process_data_receive_payload: cannot find stream %" PRIu64
,
3532 state
->header
.stream_id
);
3533 status
= RELAY_CONNECTION_STATUS_ERROR
;
3537 pthread_mutex_lock(&stream
->lock
);
3538 session
= stream
->trace
->session
;
3539 if (!conn
->session
) {
3540 ret
= connection_set_session(conn
, session
);
3542 status
= RELAY_CONNECTION_STATUS_ERROR
;
3543 goto end_stream_unlock
;
3548 * The size of the "chunk" received on any iteration is bounded by:
3549 * - the data left to receive,
3550 * - the data immediately available on the socket,
3551 * - the on-stack data buffer
3553 while (left_to_receive
> 0 && !partial_recv
) {
3555 size_t recv_size
= min(left_to_receive
, chunk_size
);
3557 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
,
3558 recv_size
, MSG_DONTWAIT
);
3560 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
3561 PERROR("Socket %d error", conn
->sock
->fd
);
3562 status
= RELAY_CONNECTION_STATUS_ERROR
;
3564 goto end_stream_unlock
;
3565 } else if (ret
== 0) {
3566 /* No more data ready to be consumed on socket. */
3567 DBG3("No more data ready for consumption on data socket of stream id %" PRIu64
,
3568 state
->header
.stream_id
);
3569 status
= RELAY_CONNECTION_STATUS_CLOSED
;
3571 } else if (ret
< (int) recv_size
) {
3573 * All the data available on the socket has been
3576 partial_recv
= true;
3581 /* Write data to stream output fd. */
3582 write_ret
= lttng_write(stream
->stream_fd
->fd
, data_buffer
,
3584 if (write_ret
< (ssize_t
) recv_size
) {
3585 ERR("Relay error writing data to file");
3586 status
= RELAY_CONNECTION_STATUS_ERROR
;
3587 goto end_stream_unlock
;
3590 left_to_receive
-= recv_size
;
3591 state
->received
+= recv_size
;
3592 state
->left_to_receive
= left_to_receive
;
3594 DBG2("Relay wrote %zd bytes to tracefile for stream id %" PRIu64
,
3595 write_ret
, stream
->stream_handle
);
3598 if (state
->left_to_receive
> 0) {
3600 * Did not receive all the data expected, wait for more data to
3601 * become available on the socket.
3603 DBG3("Partial receive on data connection of stream id %" PRIu64
", %" PRIu64
" bytes received, %" PRIu64
" bytes left to receive",
3604 state
->header
.stream_id
, state
->received
,
3605 state
->left_to_receive
);
3606 goto end_stream_unlock
;
3609 ret
= write_padding_to_file(stream
->stream_fd
->fd
,
3610 state
->header
.padding_size
);
3611 if ((int64_t) ret
< (int64_t) state
->header
.padding_size
) {
3612 ERR("write_padding_to_file: fail stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3613 stream
->stream_handle
,
3614 state
->header
.net_seq_num
, ret
);
3615 status
= RELAY_CONNECTION_STATUS_ERROR
;
3616 goto end_stream_unlock
;
3620 if (session_streams_have_index(session
)) {
3621 ret
= handle_index_data(stream
, state
->header
.net_seq_num
,
3622 state
->rotate_index
, &index_flushed
, state
->header
.data_size
+ state
->header
.padding_size
);
3624 ERR("handle_index_data: fail stream %" PRIu64
" net_seq_num %" PRIu64
" ret %d",
3625 stream
->stream_handle
,
3626 state
->header
.net_seq_num
, ret
);
3627 status
= RELAY_CONNECTION_STATUS_ERROR
;
3628 goto end_stream_unlock
;
3632 stream
->tracefile_size_current
+= state
->header
.data_size
+
3633 state
->header
.padding_size
;
3635 if (stream
->prev_data_seq
== -1ULL) {
3638 if (index_flushed
) {
3639 stream
->pos_after_last_complete_data_index
=
3640 stream
->tracefile_size_current
;
3641 stream
->prev_index_seq
= state
->header
.net_seq_num
;
3642 ret
= try_rotate_stream_index(stream
);
3644 goto end_stream_unlock
;
3648 stream
->prev_data_seq
= state
->header
.net_seq_num
;
3651 * Resetting the protocol state (to RECEIVE_HEADER) will trash the
3652 * contents of *state which are aliased (union) to the same location as
3653 * the new state. Don't use it beyond this point.
3655 connection_reset_protocol_state(conn
);
3658 ret
= try_rotate_stream_data(stream
);
3660 status
= RELAY_CONNECTION_STATUS_ERROR
;
3661 goto end_stream_unlock
;
3665 close_requested
= stream
->close_requested
;
3666 pthread_mutex_unlock(&stream
->lock
);
3667 if (close_requested
&& left_to_receive
== 0) {
3668 try_stream_close(stream
);
3672 pthread_mutex_lock(&session
->lock
);
3673 uatomic_set(&session
->new_streams
, 1);
3674 pthread_mutex_unlock(&session
->lock
);
3683 * relay_process_data: Process the data received on the data socket
3685 static enum relay_connection_status
relay_process_data(
3686 struct relay_connection
*conn
)
3688 enum relay_connection_status status
;
3690 switch (conn
->protocol
.data
.state_id
) {
3691 case DATA_CONNECTION_STATE_RECEIVE_HEADER
:
3692 status
= relay_process_data_receive_header(conn
);
3694 case DATA_CONNECTION_STATE_RECEIVE_PAYLOAD
:
3695 status
= relay_process_data_receive_payload(conn
);
3698 ERR("Unexpected data connection communication state.");
3705 static void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
3709 (void) lttng_poll_del(events
, pollfd
);
3711 ret
= close(pollfd
);
3713 ERR("Closing pollfd %d", pollfd
);
3717 static void relay_thread_close_connection(struct lttng_poll_event
*events
,
3718 int pollfd
, struct relay_connection
*conn
)
3720 const char *type_str
;
3722 switch (conn
->type
) {
3727 type_str
= "Control";
3729 case RELAY_VIEWER_COMMAND
:
3730 type_str
= "Viewer Command";
3732 case RELAY_VIEWER_NOTIFICATION
:
3733 type_str
= "Viewer Notification";
3736 type_str
= "Unknown";
3738 cleanup_connection_pollfd(events
, pollfd
);
3739 connection_put(conn
);
3740 DBG("%s connection closed with %d", type_str
, pollfd
);
3744 * This thread does the actual work
3746 static void *relay_thread_worker(void *data
)
3748 int ret
, err
= -1, last_seen_data_fd
= -1;
3750 struct lttng_poll_event events
;
3751 struct lttng_ht
*relay_connections_ht
;
3752 struct lttng_ht_iter iter
;
3753 struct relay_connection
*destroy_conn
= NULL
;
3755 DBG("[thread] Relay worker started");
3757 rcu_register_thread();
3759 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
3761 if (testpoint(relayd_thread_worker
)) {
3762 goto error_testpoint
;
3765 health_code_update();
3767 /* table of connections indexed on socket */
3768 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3769 if (!relay_connections_ht
) {
3770 goto relay_connections_ht_error
;
3773 ret
= create_thread_poll_set(&events
, 2);
3775 goto error_poll_create
;
3778 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
3785 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
3787 health_code_update();
3789 /* Infinite blocking call, waiting for transmission */
3790 DBG3("Relayd worker thread polling...");
3791 health_poll_entry();
3792 ret
= lttng_poll_wait(&events
, -1);
3796 * Restart interrupted system call.
3798 if (errno
== EINTR
) {
3807 * Process control. The control connection is
3808 * prioritized so we don't starve it with high
3809 * throughput tracing data on the data connection.
3811 for (i
= 0; i
< nb_fd
; i
++) {
3812 /* Fetch once the poll data */
3813 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3814 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3816 health_code_update();
3818 /* Thread quit pipe has been closed. Killing thread. */
3819 ret
= check_thread_quit_pipe(pollfd
, revents
);
3825 /* Inspect the relay conn pipe for new connection */
3826 if (pollfd
== relay_conn_pipe
[0]) {
3827 if (revents
& LPOLLIN
) {
3828 struct relay_connection
*conn
;
3830 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
3834 lttng_poll_add(&events
, conn
->sock
->fd
,
3835 LPOLLIN
| LPOLLRDHUP
);
3836 connection_ht_add(relay_connections_ht
, conn
);
3837 DBG("Connection socket %d added", conn
->sock
->fd
);
3838 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3839 ERR("Relay connection pipe error");
3842 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3846 struct relay_connection
*ctrl_conn
;
3848 ctrl_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3849 /* If not found, there is a synchronization issue. */
3852 if (ctrl_conn
->type
== RELAY_DATA
) {
3853 if (revents
& LPOLLIN
) {
3855 * Flag the last seen data fd not deleted. It will be
3856 * used as the last seen fd if any fd gets deleted in
3859 last_notdel_data_fd
= pollfd
;
3861 goto put_ctrl_connection
;
3863 assert(ctrl_conn
->type
== RELAY_CONTROL
);
3865 if (revents
& LPOLLIN
) {
3866 enum relay_connection_status status
;
3868 status
= relay_process_control(ctrl_conn
);
3869 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
3871 * On socket error flag the session as aborted to force
3872 * the cleanup of its stream otherwise it can leak
3873 * during the lifetime of the relayd.
3875 * This prevents situations in which streams can be
3876 * left opened because an index was received, the
3877 * control connection is closed, and the data
3878 * connection is closed (uncleanly) before the packet's
3881 * Since the control connection encountered an error,
3882 * it is okay to be conservative and close the
3883 * session right now as we can't rely on the protocol
3884 * being respected anymore.
3886 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
3887 session_abort(ctrl_conn
->session
);
3890 /* Clear the connection on error or close. */
3891 relay_thread_close_connection(&events
,
3896 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3897 relay_thread_close_connection(&events
,
3899 if (last_seen_data_fd
== pollfd
) {
3900 last_seen_data_fd
= last_notdel_data_fd
;
3903 ERR("Unexpected poll events %u for control sock %d",
3905 connection_put(ctrl_conn
);
3908 put_ctrl_connection
:
3909 connection_put(ctrl_conn
);
3914 * The last loop handled a control request, go back to poll to make
3915 * sure we prioritise the control socket.
3921 if (last_seen_data_fd
>= 0) {
3922 for (i
= 0; i
< nb_fd
; i
++) {
3923 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3925 health_code_update();
3927 if (last_seen_data_fd
== pollfd
) {
3934 /* Process data connection. */
3935 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
3936 /* Fetch the poll data. */
3937 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
3938 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3939 struct relay_connection
*data_conn
;
3941 health_code_update();
3944 /* No activity for this FD (poll implementation). */
3948 /* Skip the command pipe. It's handled in the first loop. */
3949 if (pollfd
== relay_conn_pipe
[0]) {
3953 data_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
3955 /* Skip it. Might be removed before. */
3958 if (data_conn
->type
== RELAY_CONTROL
) {
3959 goto put_data_connection
;
3961 assert(data_conn
->type
== RELAY_DATA
);
3963 if (revents
& LPOLLIN
) {
3964 enum relay_connection_status status
;
3966 status
= relay_process_data(data_conn
);
3967 /* Connection closed or error. */
3968 if (status
!= RELAY_CONNECTION_STATUS_OK
) {
3970 * On socket error flag the session as aborted to force
3971 * the cleanup of its stream otherwise it can leak
3972 * during the lifetime of the relayd.
3974 * This prevents situations in which streams can be
3975 * left opened because an index was received, the
3976 * control connection is closed, and the data
3977 * connection is closed (uncleanly) before the packet's
3980 * Since the data connection encountered an error,
3981 * it is okay to be conservative and close the
3982 * session right now as we can't rely on the protocol
3983 * being respected anymore.
3985 if (status
== RELAY_CONNECTION_STATUS_ERROR
) {
3986 session_abort(data_conn
->session
);
3988 relay_thread_close_connection(&events
, pollfd
,
3991 * Every goto restart call sets the last seen fd where
3992 * here we don't really care since we gracefully
3993 * continue the loop after the connection is deleted.
3996 /* Keep last seen port. */
3997 last_seen_data_fd
= pollfd
;
3998 connection_put(data_conn
);
4001 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4002 relay_thread_close_connection(&events
, pollfd
,
4005 ERR("Unknown poll events %u for data sock %d",
4008 put_data_connection
:
4009 connection_put(data_conn
);
4011 last_seen_data_fd
= -1;
4014 /* Normal exit, no error */
4019 /* Cleanup remaining connection object. */
4021 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
,
4024 health_code_update();
4026 session_abort(destroy_conn
->session
);
4029 * No need to grab another ref, because we own
4032 relay_thread_close_connection(&events
, destroy_conn
->sock
->fd
,
4037 lttng_poll_clean(&events
);
4039 lttng_ht_destroy(relay_connections_ht
);
4040 relay_connections_ht_error
:
4041 /* Close relay conn pipes */
4042 utils_close_pipe(relay_conn_pipe
);
4044 DBG("Thread exited with error");
4046 DBG("Worker thread cleanup complete");
4050 ERR("Health error occurred in %s", __func__
);
4052 health_unregister(health_relayd
);
4053 rcu_unregister_thread();
4054 lttng_relay_stop_threads();
4059 * Create the relay command pipe to wake thread_manage_apps.
4060 * Closed in cleanup().
4062 static int create_relay_conn_pipe(void)
4066 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
4074 int main(int argc
, char **argv
)
4076 int ret
= 0, retval
= 0;
4079 /* Parse arguments */
4081 if (set_options(argc
, argv
)) {
4086 if (set_signal_handler()) {
4091 /* Try to create directory if -o, --output is specified. */
4092 if (opt_output_path
) {
4093 if (*opt_output_path
!= '/') {
4094 ERR("Please specify an absolute path for -o, --output PATH");
4099 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
,
4102 ERR("Unable to create %s", opt_output_path
);
4109 if (opt_daemon
|| opt_background
) {
4112 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
4120 * We are in the child. Make sure all other file
4121 * descriptors are closed, in case we are called with
4122 * more opened file descriptors than the standard ones.
4124 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
4129 sessiond_trace_chunk_registry
= sessiond_trace_chunk_registry_create();
4130 if (!sessiond_trace_chunk_registry
) {
4131 ERR("Failed to initialize session daemon trace chunk registry");
4133 goto exit_sessiond_trace_chunk_registry
;
4136 /* Initialize thread health monitoring */
4137 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
4138 if (!health_relayd
) {
4139 PERROR("health_app_create error");
4141 goto exit_health_app_create
;
4144 /* Create thread quit pipe */
4145 if (init_thread_quit_pipe()) {
4147 goto exit_init_data
;
4150 /* Setup the thread apps communication pipe. */
4151 if (create_relay_conn_pipe()) {
4153 goto exit_init_data
;
4156 /* Init relay command queue. */
4157 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
4159 /* Initialize communication library */
4161 lttcomm_inet_init();
4163 /* tables of sessions indexed by session ID */
4164 sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4167 goto exit_init_data
;
4170 /* tables of streams indexed by stream ID */
4171 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4172 if (!relay_streams_ht
) {
4174 goto exit_init_data
;
4177 /* tables of streams indexed by stream ID */
4178 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4179 if (!viewer_streams_ht
) {
4181 goto exit_init_data
;
4184 ret
= utils_create_pipe(health_quit_pipe
);
4187 goto exit_health_quit_pipe
;
4190 /* Create thread to manage the client socket */
4191 ret
= pthread_create(&health_thread
, default_pthread_attr(),
4192 thread_manage_health
, (void *) NULL
);
4195 PERROR("pthread_create health");
4197 goto exit_health_thread
;
4200 /* Setup the dispatcher thread */
4201 ret
= pthread_create(&dispatcher_thread
, default_pthread_attr(),
4202 relay_thread_dispatcher
, (void *) NULL
);
4205 PERROR("pthread_create dispatcher");
4207 goto exit_dispatcher_thread
;
4210 /* Setup the worker thread */
4211 ret
= pthread_create(&worker_thread
, default_pthread_attr(),
4212 relay_thread_worker
, NULL
);
4215 PERROR("pthread_create worker");
4217 goto exit_worker_thread
;
4220 /* Setup the listener thread */
4221 ret
= pthread_create(&listener_thread
, default_pthread_attr(),
4222 relay_thread_listener
, (void *) NULL
);
4225 PERROR("pthread_create listener");
4227 goto exit_listener_thread
;
4230 ret
= relayd_live_create(live_uri
);
4232 ERR("Starting live viewer threads");
4238 * This is where we start awaiting program completion (e.g. through
4239 * signal that asks threads to teardown).
4242 ret
= relayd_live_join();
4248 ret
= pthread_join(listener_thread
, &status
);
4251 PERROR("pthread_join listener_thread");
4255 exit_listener_thread
:
4256 ret
= pthread_join(worker_thread
, &status
);
4259 PERROR("pthread_join worker_thread");
4264 ret
= pthread_join(dispatcher_thread
, &status
);
4267 PERROR("pthread_join dispatcher_thread");
4270 exit_dispatcher_thread
:
4272 ret
= pthread_join(health_thread
, &status
);
4275 PERROR("pthread_join health_thread");
4280 utils_close_pipe(health_quit_pipe
);
4281 exit_health_quit_pipe
:
4284 health_app_destroy(health_relayd
);
4285 sessiond_trace_chunk_registry_destroy(sessiond_trace_chunk_registry
);
4286 exit_health_app_create
:
4287 exit_sessiond_trace_chunk_registry
:
4290 * Wait for all pending call_rcu work to complete before tearing
4291 * down data structures. call_rcu worker may be trying to
4292 * perform lookups in those structures.
4297 /* Ensure all prior call_rcu are done. */