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>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 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>
44 #include <lttng/lttng.h>
45 #include <common/common.h>
46 #include <common/compat/poll.h>
47 #include <common/compat/socket.h>
48 #include <common/compat/endian.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/config/config.h>
60 #include "ctf-trace.h"
63 #include "lttng-relayd.h"
65 #include "health-relayd.h"
66 #include "testpoint.h"
67 #include "viewer-stream.h"
70 #include "connection.h"
72 /* command line options */
73 char *opt_output_path
;
74 static int opt_daemon
, opt_background
;
77 * We need to wait for listener and live listener threads, as well as
78 * health check thread, before being ready to signal readiness.
80 #define NR_LTTNG_RELAY_READY 3
81 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
82 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
83 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
85 static struct lttng_uri
*control_uri
;
86 static struct lttng_uri
*data_uri
;
87 static struct lttng_uri
*live_uri
;
91 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
92 static int tracing_group_name_override
;
94 const char * const config_section_name
= "relayd";
97 * Quit pipe for all threads. This permits a single cancellation point
98 * for all threads when receiving an event on the pipe.
100 int thread_quit_pipe
[2] = { -1, -1 };
103 * This pipe is used to inform the worker thread that a command is queued and
104 * ready to be processed.
106 static int relay_conn_pipe
[2] = { -1, -1 };
108 /* Shared between threads */
109 static int dispatch_thread_exit
;
111 static pthread_t listener_thread
;
112 static pthread_t dispatcher_thread
;
113 static pthread_t worker_thread
;
114 static pthread_t health_thread
;
116 static uint64_t last_relay_stream_id
;
119 * Relay command queue.
121 * The relay_thread_listener and relay_thread_dispatcher communicate with this
124 static struct relay_conn_queue relay_conn_queue
;
126 /* buffer allocated at startup, used to store the trace data */
127 static char *data_buffer
;
128 static unsigned int data_buffer_size
;
130 /* We need those values for the file/dir creation. */
131 static uid_t relayd_uid
;
132 static gid_t relayd_gid
;
134 /* Global relay stream hash table. */
135 struct lttng_ht
*relay_streams_ht
;
137 /* Global relay viewer stream hash table. */
138 struct lttng_ht
*viewer_streams_ht
;
140 /* Global hash table that stores relay index object. */
141 struct lttng_ht
*indexes_ht
;
143 /* Relayd health monitoring */
144 struct health_app
*health_relayd
;
146 static struct option long_options
[] = {
147 { "control-port", 1, 0, 'C', },
148 { "data-port", 1, 0, 'D', },
149 { "live-port", 1, 0, 'L', },
150 { "daemonize", 0, 0, 'd', },
151 { "background", 0, 0, 'b', },
152 { "group", 1, 0, 'g', },
153 { "help", 0, 0, 'h', },
154 { "output", 1, 0, 'o', },
155 { "verbose", 0, 0, 'v', },
156 { "config", 1, 0, 'f' },
160 static const char *config_ignore_options
[] = { "help", "config" };
163 * usage function on stderr
168 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
169 fprintf(stderr
, " -h, --help Display this usage.\n");
170 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
171 fprintf(stderr
, " -b, --background Start as a daemon, keeping console open.\n");
172 fprintf(stderr
, " -C, --control-port URL Control port listening.\n");
173 fprintf(stderr
, " -D, --data-port URL Data port listening.\n");
174 fprintf(stderr
, " -L, --live-port URL Live view port listening.\n");
175 fprintf(stderr
, " -o, --output PATH Output path for traces. Must use an absolute path.\n");
176 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
177 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
178 fprintf(stderr
, " -f --config Load daemon configuration file\n");
182 * Take an option from the getopt output and set it in the right variable to be
185 * Return 0 on success else a negative value.
188 int set_option(int opt
, const char *arg
, const char *optname
)
194 fprintf(stderr
, "option %s", optname
);
196 fprintf(stderr
, " with arg %s\n", arg
);
200 ret
= uri_parse(arg
, &control_uri
);
202 ERR("Invalid control URI specified");
205 if (control_uri
->port
== 0) {
206 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
210 ret
= uri_parse(arg
, &data_uri
);
212 ERR("Invalid data URI specified");
215 if (data_uri
->port
== 0) {
216 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
220 ret
= uri_parse(arg
, &live_uri
);
222 ERR("Invalid live URI specified");
225 if (live_uri
->port
== 0) {
226 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
236 tracing_group_name
= strdup(arg
);
237 tracing_group_name_override
= 1;
243 ret
= asprintf(&opt_output_path
, "%s", arg
);
246 PERROR("asprintf opt_output_path");
251 /* Verbose level can increase using multiple -v */
253 lttng_opt_verbose
= config_parse_value(arg
);
255 /* Only 3 level of verbosity (-vvv). */
256 if (lttng_opt_verbose
< 3) {
257 lttng_opt_verbose
+= 1;
262 /* Unknown option or other error.
263 * Error is printed by getopt, just return */
276 * config_entry_handler_cb used to handle options read from a config file.
277 * See config_entry_handler_cb comment in common/config/config.h for the
278 * return value conventions.
281 int config_entry_handler(const struct config_entry
*entry
, void *unused
)
285 if (!entry
|| !entry
->name
|| !entry
->value
) {
290 /* Check if the option is to be ignored */
291 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
292 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
297 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1; i
++) {
298 /* Ignore if entry name is not fully matched. */
299 if (strcmp(entry
->name
, long_options
[i
].name
)) {
304 * If the option takes no argument on the command line, we have to
305 * check if the value is "true". We support non-zero numeric values,
308 if (!long_options
[i
].has_arg
) {
309 ret
= config_parse_value(entry
->value
);
312 WARN("Invalid configuration value \"%s\" for option %s",
313 entry
->value
, entry
->name
);
315 /* False, skip boolean config option. */
320 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
324 WARN("Unrecognized option \"%s\" in daemon configuration file.",
332 int set_options(int argc
, char **argv
)
334 int c
, ret
= 0, option_index
= 0;
335 int orig_optopt
= optopt
, orig_optind
= optind
;
336 char *default_address
, *optstring
;
337 const char *config_path
= NULL
;
339 optstring
= utils_generate_optstring(long_options
,
340 sizeof(long_options
) / sizeof(struct option
));
346 /* Check for the --config option */
348 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
349 &option_index
)) != -1) {
353 } else if (c
!= 'f') {
357 config_path
= utils_expand_path(optarg
);
359 ERR("Failed to resolve path: %s", optarg
);
363 ret
= config_get_section_entries(config_path
, config_section_name
,
364 config_entry_handler
, NULL
);
367 ERR("Invalid configuration option at line %i", ret
);
373 /* Reset getopt's global state */
374 optopt
= orig_optopt
;
375 optind
= orig_optind
;
377 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
382 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
388 /* assign default values */
389 if (control_uri
== NULL
) {
390 ret
= asprintf(&default_address
,
391 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
392 DEFAULT_NETWORK_CONTROL_PORT
);
394 PERROR("asprintf default data address");
398 ret
= uri_parse(default_address
, &control_uri
);
399 free(default_address
);
401 ERR("Invalid control URI specified");
405 if (data_uri
== NULL
) {
406 ret
= asprintf(&default_address
,
407 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
408 DEFAULT_NETWORK_DATA_PORT
);
410 PERROR("asprintf default data address");
414 ret
= uri_parse(default_address
, &data_uri
);
415 free(default_address
);
417 ERR("Invalid data URI specified");
421 if (live_uri
== NULL
) {
422 ret
= asprintf(&default_address
,
423 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
424 DEFAULT_NETWORK_VIEWER_PORT
);
426 PERROR("asprintf default viewer control address");
430 ret
= uri_parse(default_address
, &live_uri
);
431 free(default_address
);
433 ERR("Invalid viewer control URI specified");
451 /* free the dynamically allocated opt_output_path */
452 free(opt_output_path
);
454 /* Close thread quit pipes */
455 utils_close_pipe(thread_quit_pipe
);
457 uri_free(control_uri
);
459 /* Live URI is freed in the live thread. */
461 if (tracing_group_name_override
) {
462 free((void *) tracing_group_name
);
467 * Write to writable pipe used to notify a thread.
470 int notify_thread_pipe(int wpipe
)
474 ret
= lttng_write(wpipe
, "!", 1);
476 PERROR("write poll pipe");
482 static void notify_health_quit_pipe(int *pipe
)
486 ret
= lttng_write(pipe
[1], "4", 1);
488 PERROR("write relay health quit");
493 * Stop all threads by closing the thread quit pipe.
496 void stop_threads(void)
500 /* Stopping all threads */
501 DBG("Terminating all threads");
502 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
504 ERR("write error on thread quit pipe");
507 notify_health_quit_pipe(health_quit_pipe
);
509 /* Dispatch thread */
510 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
511 futex_nto1_wake(&relay_conn_queue
.futex
);
515 * Signal handler for the daemon
517 * Simply stop all worker threads, leaving main() return gracefully after
518 * joining all threads and calling cleanup().
521 void sighandler(int sig
)
525 DBG("SIGPIPE caught");
528 DBG("SIGINT caught");
532 DBG("SIGTERM caught");
536 CMM_STORE_SHARED(recv_child_signal
, 1);
544 * Setup signal handler for :
545 * SIGINT, SIGTERM, SIGPIPE
548 int set_signal_handler(void)
554 if ((ret
= sigemptyset(&sigset
)) < 0) {
555 PERROR("sigemptyset");
559 sa
.sa_handler
= sighandler
;
562 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
567 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
572 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
577 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
582 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
587 void lttng_relay_notify_ready(void)
589 /* Notify the parent of the fork() process that we are ready. */
590 if (opt_daemon
|| opt_background
) {
591 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
592 kill(child_ppid
, SIGUSR1
);
598 * Init thread quit pipe.
600 * Return -1 on error or 0 if all pipes are created.
603 int init_thread_quit_pipe(void)
607 ret
= utils_create_pipe_cloexec(thread_quit_pipe
);
613 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
616 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
620 if (events
== NULL
|| size
== 0) {
625 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
631 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
643 * Check if the thread quit pipe was triggered.
645 * Return 1 if it was triggered else 0;
648 int check_thread_quit_pipe(int fd
, uint32_t events
)
650 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
658 * Create and init socket from uri.
661 struct lttcomm_sock
*relay_init_sock(struct lttng_uri
*uri
)
664 struct lttcomm_sock
*sock
= NULL
;
666 sock
= lttcomm_alloc_sock_from_uri(uri
);
668 ERR("Allocating socket");
672 ret
= lttcomm_create_sock(sock
);
676 DBG("Listening on sock %d", sock
->fd
);
678 ret
= sock
->ops
->bind(sock
);
683 ret
= sock
->ops
->listen(sock
, -1);
693 lttcomm_destroy_sock(sock
);
699 * Return nonzero if stream needs to be closed.
702 int close_stream_check(struct relay_stream
*stream
)
704 if (stream
->close_flag
&& stream
->prev_seq
== stream
->last_net_seq_num
) {
706 * We are about to close the stream so set the data pending flag to 1
707 * which will make the end data pending command skip the stream which
708 * is now closed and ready. Note that after proceeding to a file close,
709 * the written file is ready for reading.
711 stream
->data_pending_check_done
= 1;
717 static void try_close_stream(struct relay_session
*session
,
718 struct relay_stream
*stream
)
721 struct ctf_trace
*ctf_trace
;
726 if (!close_stream_check(stream
)) {
727 /* Can't close it, not ready for that. */
731 ctf_trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
,
735 pthread_mutex_lock(&session
->viewer_ready_lock
);
736 ctf_trace
->invalid_flag
= 1;
737 pthread_mutex_unlock(&session
->viewer_ready_lock
);
739 ret
= stream_close(session
, stream
);
740 if (ret
|| session
->snapshot
) {
741 /* Already close thus the ctf trace is being or has been destroyed. */
745 ctf_trace_try_destroy(session
, ctf_trace
);
752 * This thread manages the listening for new connections on the network
755 void *relay_thread_listener(void *data
)
757 int i
, ret
, pollfd
, err
= -1;
758 uint32_t revents
, nb_fd
;
759 struct lttng_poll_event events
;
760 struct lttcomm_sock
*control_sock
, *data_sock
;
762 DBG("[thread] Relay listener started");
764 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
766 health_code_update();
768 control_sock
= relay_init_sock(control_uri
);
770 goto error_sock_control
;
773 data_sock
= relay_init_sock(data_uri
);
775 goto error_sock_relay
;
779 * Pass 3 as size here for the thread quit pipe, control and data socket.
781 ret
= create_thread_poll_set(&events
, 3);
783 goto error_create_poll
;
786 /* Add the control socket */
787 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
792 /* Add the data socket */
793 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
798 lttng_relay_notify_ready();
800 if (testpoint(relayd_thread_listener
)) {
801 goto error_testpoint
;
805 health_code_update();
807 DBG("Listener accepting connections");
811 ret
= lttng_poll_wait(&events
, -1);
815 * Restart interrupted system call.
817 if (errno
== EINTR
) {
825 DBG("Relay new connection received");
826 for (i
= 0; i
< nb_fd
; i
++) {
827 health_code_update();
829 /* Fetch once the poll data */
830 revents
= LTTNG_POLL_GETEV(&events
, i
);
831 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
833 /* Thread quit pipe has been closed. Killing thread. */
834 ret
= check_thread_quit_pipe(pollfd
, revents
);
840 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
841 ERR("socket poll error");
843 } else if (revents
& LPOLLIN
) {
845 * Get allocated in this thread, enqueued to a global queue,
846 * dequeued and freed in the worker thread.
849 struct relay_connection
*new_conn
;
850 struct lttcomm_sock
*newsock
;
852 new_conn
= connection_create();
857 if (pollfd
== data_sock
->fd
) {
858 new_conn
->type
= RELAY_DATA
;
859 newsock
= data_sock
->ops
->accept(data_sock
);
860 DBG("Relay data connection accepted, socket %d",
863 assert(pollfd
== control_sock
->fd
);
864 new_conn
->type
= RELAY_CONTROL
;
865 newsock
= control_sock
->ops
->accept(control_sock
);
866 DBG("Relay control connection accepted, socket %d",
870 PERROR("accepting sock");
871 connection_free(new_conn
);
875 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
878 PERROR("setsockopt inet");
879 lttcomm_destroy_sock(newsock
);
880 connection_free(new_conn
);
883 new_conn
->sock
= newsock
;
885 /* Enqueue request for the dispatcher thread. */
886 cds_wfcq_enqueue(&relay_conn_queue
.head
, &relay_conn_queue
.tail
,
890 * Wake the dispatch queue futex. Implicit memory barrier with
891 * the exchange in cds_wfcq_enqueue.
893 futex_nto1_wake(&relay_conn_queue
.futex
);
902 lttng_poll_clean(&events
);
904 if (data_sock
->fd
>= 0) {
905 ret
= data_sock
->ops
->close(data_sock
);
910 lttcomm_destroy_sock(data_sock
);
912 if (control_sock
->fd
>= 0) {
913 ret
= control_sock
->ops
->close(control_sock
);
918 lttcomm_destroy_sock(control_sock
);
922 ERR("Health error occurred in %s", __func__
);
924 health_unregister(health_relayd
);
925 DBG("Relay listener thread cleanup complete");
931 * This thread manages the dispatching of the requests to worker threads
934 void *relay_thread_dispatcher(void *data
)
938 struct cds_wfcq_node
*node
;
939 struct relay_connection
*new_conn
= NULL
;
941 DBG("[thread] Relay dispatcher started");
943 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
945 if (testpoint(relayd_thread_dispatcher
)) {
946 goto error_testpoint
;
949 health_code_update();
951 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
952 health_code_update();
954 /* Atomically prepare the queue futex */
955 futex_nto1_prepare(&relay_conn_queue
.futex
);
958 health_code_update();
960 /* Dequeue commands */
961 node
= cds_wfcq_dequeue_blocking(&relay_conn_queue
.head
,
962 &relay_conn_queue
.tail
);
964 DBG("Woken up but nothing in the relay command queue");
965 /* Continue thread execution */
968 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
970 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
973 * Inform worker thread of the new request. This call is blocking
974 * so we can be assured that the data will be read at some point in
975 * time or wait to the end of the world :)
977 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
979 PERROR("write connection pipe");
980 connection_destroy(new_conn
);
983 } while (node
!= NULL
);
985 /* Futex wait on queue. Blocking call on futex() */
987 futex_nto1_wait(&relay_conn_queue
.futex
);
991 /* Normal exit, no error */
998 ERR("Health error occurred in %s", __func__
);
1000 health_unregister(health_relayd
);
1001 DBG("Dispatch thread dying");
1006 static void try_close_streams(struct relay_session
*session
)
1008 struct ctf_trace
*ctf_trace
;
1009 struct lttng_ht_iter iter
;
1013 pthread_mutex_lock(&session
->viewer_ready_lock
);
1015 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
, &iter
.iter
, ctf_trace
,
1017 struct relay_stream
*stream
;
1019 /* Close streams. */
1020 cds_list_for_each_entry(stream
, &ctf_trace
->stream_list
, trace_list
) {
1021 stream_close(session
, stream
);
1024 ctf_trace
->invalid_flag
= 1;
1025 ctf_trace_try_destroy(session
, ctf_trace
);
1028 pthread_mutex_unlock(&session
->viewer_ready_lock
);
1032 * Try to destroy a session within a connection.
1034 static void destroy_session(struct relay_session
*session
,
1035 struct lttng_ht
*sessions_ht
)
1038 assert(sessions_ht
);
1040 /* Indicate that this session can be destroyed from now on. */
1041 session
->close_flag
= 1;
1043 try_close_streams(session
);
1046 * This will try to delete and destroy the session if no viewer is attached
1047 * to it meaning the refcount is down to zero.
1049 session_try_destroy(sessions_ht
, session
);
1053 * Copy index data from the control port to a given index object.
1055 static void copy_index_control_data(struct relay_index
*index
,
1056 struct lttcomm_relayd_index
*data
)
1062 * The index on disk is encoded in big endian, so we don't need to convert
1063 * the data received on the network. The data_offset value is NEVER
1064 * modified here and is updated by the data thread.
1066 index
->index_data
.packet_size
= data
->packet_size
;
1067 index
->index_data
.content_size
= data
->content_size
;
1068 index
->index_data
.timestamp_begin
= data
->timestamp_begin
;
1069 index
->index_data
.timestamp_end
= data
->timestamp_end
;
1070 index
->index_data
.events_discarded
= data
->events_discarded
;
1071 index
->index_data
.stream_id
= data
->stream_id
;
1075 * Handle the RELAYD_CREATE_SESSION command.
1077 * On success, send back the session id or else return a negative value.
1080 int relay_create_session(struct lttcomm_relayd_hdr
*recv_hdr
,
1081 struct relay_connection
*conn
)
1083 int ret
= 0, send_ret
;
1084 struct relay_session
*session
;
1085 struct lttcomm_relayd_status_session reply
;
1090 memset(&reply
, 0, sizeof(reply
));
1092 session
= session_create();
1097 session
->minor
= conn
->minor
;
1098 session
->major
= conn
->major
;
1099 conn
->session_id
= session
->id
;
1100 conn
->session
= session
;
1102 reply
.session_id
= htobe64(session
->id
);
1104 switch (conn
->minor
) {
1109 case 4: /* LTTng sessiond 2.4 */
1111 ret
= cmd_create_session_2_4(conn
, session
);
1114 lttng_ht_add_unique_u64(conn
->sessions_ht
, &session
->session_n
);
1115 DBG("Created session %" PRIu64
, session
->id
);
1119 reply
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1121 reply
.ret_code
= htobe32(LTTNG_OK
);
1124 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1126 ERR("Relayd sending session id");
1134 * When we have received all the streams and the metadata for a channel,
1135 * we make them visible to the viewer threads.
1138 void set_viewer_ready_flag(struct relay_connection
*conn
)
1140 struct relay_stream
*stream
, *tmp_stream
;
1142 pthread_mutex_lock(&conn
->session
->viewer_ready_lock
);
1143 cds_list_for_each_entry_safe(stream
, tmp_stream
, &conn
->recv_head
,
1145 stream
->viewer_ready
= 1;
1146 cds_list_del(&stream
->recv_list
);
1148 pthread_mutex_unlock(&conn
->session
->viewer_ready_lock
);
1153 * Add a recv handle node to the connection recv list with the given stream
1154 * handle. A new node is allocated thus must be freed when the node is deleted
1157 static void queue_stream(struct relay_stream
*stream
,
1158 struct relay_connection
*conn
)
1163 cds_list_add(&stream
->recv_list
, &conn
->recv_head
);
1167 * relay_add_stream: allocate a new stream for a session
1170 int relay_add_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1171 struct relay_connection
*conn
)
1174 struct relay_session
*session
= conn
->session
;
1175 struct relay_stream
*stream
= NULL
;
1176 struct lttcomm_relayd_status_stream reply
;
1177 struct ctf_trace
*trace
;
1179 if (!session
|| conn
->version_check_done
== 0) {
1180 ERR("Trying to add a stream before version check");
1182 goto end_no_session
;
1185 stream
= zmalloc(sizeof(struct relay_stream
));
1186 if (stream
== NULL
) {
1187 PERROR("relay stream zmalloc");
1189 goto end_no_session
;
1192 switch (conn
->minor
) {
1193 case 1: /* LTTng sessiond 2.1 */
1194 ret
= cmd_recv_stream_2_1(conn
, stream
);
1196 case 2: /* LTTng sessiond 2.2 */
1198 ret
= cmd_recv_stream_2_2(conn
, stream
);
1202 goto err_free_stream
;
1206 stream
->stream_handle
= ++last_relay_stream_id
;
1207 stream
->prev_seq
= -1ULL;
1208 stream
->session_id
= session
->id
;
1209 stream
->index_fd
= -1;
1210 stream
->read_index_fd
= -1;
1211 stream
->ctf_stream_id
= -1ULL;
1212 lttng_ht_node_init_u64(&stream
->node
, stream
->stream_handle
);
1213 pthread_mutex_init(&stream
->lock
, NULL
);
1215 ret
= utils_mkdir_recursive(stream
->path_name
, S_IRWXU
| S_IRWXG
);
1217 ERR("relay creating output directory");
1222 * No need to use run_as API here because whatever we receives, the relayd
1223 * uses its own credentials for the stream files.
1225 ret
= utils_create_stream_file(stream
->path_name
, stream
->channel_name
,
1226 stream
->tracefile_size
, 0, relayd_uid
, relayd_gid
, NULL
);
1228 ERR("Create output file");
1232 if (stream
->tracefile_size
) {
1233 DBG("Tracefile %s/%s_0 created", stream
->path_name
, stream
->channel_name
);
1235 DBG("Tracefile %s/%s created", stream
->path_name
, stream
->channel_name
);
1238 trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
, stream
->path_name
);
1240 trace
= ctf_trace_create(stream
->path_name
);
1245 ctf_trace_add(session
->ctf_traces_ht
, trace
);
1247 ctf_trace_get_ref(trace
);
1249 if (!strncmp(stream
->channel_name
, DEFAULT_METADATA_NAME
, NAME_MAX
)) {
1250 stream
->metadata_flag
= 1;
1251 /* Assign quick reference to the metadata stream in the trace. */
1252 trace
->metadata_stream
= stream
;
1256 * Add the stream in the recv list of the connection. Once the end stream
1257 * message is received, this list is emptied and streams are set with the
1258 * viewer ready flag.
1260 queue_stream(stream
, conn
);
1263 * Both in the ctf_trace object and the global stream ht since the data
1264 * side of the relayd does not have the concept of session.
1266 lttng_ht_add_unique_u64(relay_streams_ht
, &stream
->node
);
1267 cds_list_add_tail(&stream
->trace_list
, &trace
->stream_list
);
1269 session
->stream_count
++;
1271 DBG("Relay new stream added %s with ID %" PRIu64
, stream
->channel_name
,
1272 stream
->stream_handle
);
1275 memset(&reply
, 0, sizeof(reply
));
1276 reply
.handle
= htobe64(stream
->stream_handle
);
1277 /* send the session id to the client or a negative return code on error */
1279 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1280 /* stream was not properly added to the ht, so free it */
1283 reply
.ret_code
= htobe32(LTTNG_OK
);
1286 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1287 sizeof(struct lttcomm_relayd_status_stream
), 0);
1289 ERR("Relay sending stream id");
1298 free(stream
->path_name
);
1299 free(stream
->channel_name
);
1305 * relay_close_stream: close a specific stream
1308 int relay_close_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1309 struct relay_connection
*conn
)
1312 struct relay_session
*session
= conn
->session
;
1313 struct lttcomm_relayd_close_stream stream_info
;
1314 struct lttcomm_relayd_generic_reply reply
;
1315 struct relay_stream
*stream
;
1317 DBG("Close stream received");
1319 if (!session
|| conn
->version_check_done
== 0) {
1320 ERR("Trying to close a stream before version check");
1322 goto end_no_session
;
1325 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &stream_info
,
1326 sizeof(struct lttcomm_relayd_close_stream
), 0);
1327 if (ret
< sizeof(struct lttcomm_relayd_close_stream
)) {
1329 /* Orderly shutdown. Not necessary to print an error. */
1330 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1332 ERR("Relay didn't receive valid add_stream struct size : %d", ret
);
1335 goto end_no_session
;
1339 stream
= stream_find_by_id(relay_streams_ht
,
1340 be64toh(stream_info
.stream_id
));
1346 stream
->last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1347 stream
->close_flag
= 1;
1348 session
->stream_count
--;
1350 /* Check if we can close it or else the data will do it. */
1351 try_close_stream(session
, stream
);
1356 memset(&reply
, 0, sizeof(reply
));
1358 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1360 reply
.ret_code
= htobe32(LTTNG_OK
);
1362 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1363 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1365 ERR("Relay sending stream id");
1374 * relay_unknown_command: send -1 if received unknown command
1377 void relay_unknown_command(struct relay_connection
*conn
)
1379 struct lttcomm_relayd_generic_reply reply
;
1382 memset(&reply
, 0, sizeof(reply
));
1383 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1384 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1385 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1387 ERR("Relay sending unknown command");
1392 * relay_start: send an acknowledgment to the client to tell if we are
1393 * ready to receive data. We are ready if a session is established.
1396 int relay_start(struct lttcomm_relayd_hdr
*recv_hdr
,
1397 struct relay_connection
*conn
)
1399 int ret
= htobe32(LTTNG_OK
);
1400 struct lttcomm_relayd_generic_reply reply
;
1401 struct relay_session
*session
= conn
->session
;
1404 DBG("Trying to start the streaming without a session established");
1405 ret
= htobe32(LTTNG_ERR_UNK
);
1408 memset(&reply
, 0, sizeof(reply
));
1409 reply
.ret_code
= ret
;
1410 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1411 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1413 ERR("Relay sending start ack");
1420 * Append padding to the file pointed by the file descriptor fd.
1422 static int write_padding_to_file(int fd
, uint32_t size
)
1431 zeros
= zmalloc(size
);
1432 if (zeros
== NULL
) {
1433 PERROR("zmalloc zeros for padding");
1438 ret
= lttng_write(fd
, zeros
, size
);
1440 PERROR("write padding to file");
1450 * relay_recv_metadata: receive the metada for the session.
1453 int relay_recv_metadata(struct lttcomm_relayd_hdr
*recv_hdr
,
1454 struct relay_connection
*conn
)
1456 int ret
= htobe32(LTTNG_OK
);
1458 struct relay_session
*session
= conn
->session
;
1459 struct lttcomm_relayd_metadata_payload
*metadata_struct
;
1460 struct relay_stream
*metadata_stream
;
1461 uint64_t data_size
, payload_size
;
1462 struct ctf_trace
*ctf_trace
;
1465 ERR("Metadata sent before version check");
1470 data_size
= payload_size
= be64toh(recv_hdr
->data_size
);
1471 if (data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1472 ERR("Incorrect data size");
1476 payload_size
-= sizeof(struct lttcomm_relayd_metadata_payload
);
1478 if (data_buffer_size
< data_size
) {
1479 /* In case the realloc fails, we can free the memory */
1482 tmp_data_ptr
= realloc(data_buffer
, data_size
);
1483 if (!tmp_data_ptr
) {
1484 ERR("Allocating data buffer");
1489 data_buffer
= tmp_data_ptr
;
1490 data_buffer_size
= data_size
;
1492 memset(data_buffer
, 0, data_size
);
1493 DBG2("Relay receiving metadata, waiting for %" PRIu64
" bytes", data_size
);
1494 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
1495 if (ret
< 0 || ret
!= data_size
) {
1497 /* Orderly shutdown. Not necessary to print an error. */
1498 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1500 ERR("Relay didn't receive the whole metadata");
1505 metadata_struct
= (struct lttcomm_relayd_metadata_payload
*) data_buffer
;
1508 metadata_stream
= stream_find_by_id(relay_streams_ht
,
1509 be64toh(metadata_struct
->stream_id
));
1510 if (!metadata_stream
) {
1515 size_ret
= lttng_write(metadata_stream
->fd
, metadata_struct
->payload
,
1517 if (size_ret
< payload_size
) {
1518 ERR("Relay error writing metadata on file");
1523 ret
= write_padding_to_file(metadata_stream
->fd
,
1524 be32toh(metadata_struct
->padding_size
));
1529 ctf_trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
,
1530 metadata_stream
->path_name
);
1532 ctf_trace
->metadata_received
+=
1533 payload_size
+ be32toh(metadata_struct
->padding_size
);
1535 DBG2("Relay metadata written");
1544 * relay_send_version: send relayd version number
1547 int relay_send_version(struct lttcomm_relayd_hdr
*recv_hdr
,
1548 struct relay_connection
*conn
)
1551 struct lttcomm_relayd_version reply
, msg
;
1555 conn
->version_check_done
= 1;
1557 /* Get version from the other side. */
1558 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1559 if (ret
< 0 || ret
!= sizeof(msg
)) {
1561 /* Orderly shutdown. Not necessary to print an error. */
1562 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1564 ERR("Relay failed to receive the version values.");
1570 memset(&reply
, 0, sizeof(reply
));
1571 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
1572 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
1574 /* Major versions must be the same */
1575 if (reply
.major
!= be32toh(msg
.major
)) {
1576 DBG("Incompatible major versions (%u vs %u), deleting session",
1577 reply
.major
, be32toh(msg
.major
));
1578 destroy_session(conn
->session
, conn
->sessions_ht
);
1583 conn
->major
= reply
.major
;
1584 /* We adapt to the lowest compatible version */
1585 if (reply
.minor
<= be32toh(msg
.minor
)) {
1586 conn
->minor
= reply
.minor
;
1588 conn
->minor
= be32toh(msg
.minor
);
1591 reply
.major
= htobe32(reply
.major
);
1592 reply
.minor
= htobe32(reply
.minor
);
1593 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1594 sizeof(struct lttcomm_relayd_version
), 0);
1596 ERR("Relay sending version");
1599 DBG("Version check done using protocol %u.%u", conn
->major
,
1607 * Check for data pending for a given stream id from the session daemon.
1610 int relay_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1611 struct relay_connection
*conn
)
1613 struct relay_session
*session
= conn
->session
;
1614 struct lttcomm_relayd_data_pending msg
;
1615 struct lttcomm_relayd_generic_reply reply
;
1616 struct relay_stream
*stream
;
1618 uint64_t last_net_seq_num
, stream_id
;
1620 DBG("Data pending command received");
1622 if (!session
|| conn
->version_check_done
== 0) {
1623 ERR("Trying to check for data before version check");
1625 goto end_no_session
;
1628 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1629 if (ret
< sizeof(msg
)) {
1631 /* Orderly shutdown. Not necessary to print an error. */
1632 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1634 ERR("Relay didn't receive valid data_pending struct size : %d",
1638 goto end_no_session
;
1641 stream_id
= be64toh(msg
.stream_id
);
1642 last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
1645 stream
= stream_find_by_id(relay_streams_ht
, stream_id
);
1646 if (stream
== NULL
) {
1651 DBG("Data pending for stream id %" PRIu64
" prev_seq %" PRIu64
1652 " and last_seq %" PRIu64
, stream_id
, stream
->prev_seq
,
1655 /* Avoid wrapping issue */
1656 if (((int64_t) (stream
->prev_seq
- last_net_seq_num
)) >= 0) {
1657 /* Data has in fact been written and is NOT pending */
1660 /* Data still being streamed thus pending */
1664 /* Pending check is now done. */
1665 stream
->data_pending_check_done
= 1;
1670 memset(&reply
, 0, sizeof(reply
));
1671 reply
.ret_code
= htobe32(ret
);
1672 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1674 ERR("Relay data pending ret code failed");
1682 * Wait for the control socket to reach a quiescent state.
1684 * Note that for now, when receiving this command from the session daemon, this
1685 * means that every subsequent commands or data received on the control socket
1686 * has been handled. So, this is why we simply return OK here.
1689 int relay_quiescent_control(struct lttcomm_relayd_hdr
*recv_hdr
,
1690 struct relay_connection
*conn
)
1694 struct relay_stream
*stream
;
1695 struct lttng_ht_iter iter
;
1696 struct lttcomm_relayd_quiescent_control msg
;
1697 struct lttcomm_relayd_generic_reply reply
;
1699 DBG("Checking quiescent state on control socket");
1701 if (!conn
->session
|| conn
->version_check_done
== 0) {
1702 ERR("Trying to check for data before version check");
1704 goto end_no_session
;
1707 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1708 if (ret
< sizeof(msg
)) {
1710 /* Orderly shutdown. Not necessary to print an error. */
1711 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1713 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1717 goto end_no_session
;
1720 stream_id
= be64toh(msg
.stream_id
);
1723 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1725 if (stream
->stream_handle
== stream_id
) {
1726 stream
->data_pending_check_done
= 1;
1727 DBG("Relay quiescent control pending flag set to %" PRIu64
,
1734 memset(&reply
, 0, sizeof(reply
));
1735 reply
.ret_code
= htobe32(LTTNG_OK
);
1736 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1738 ERR("Relay data quiescent control ret code failed");
1746 * Initialize a data pending command. This means that a client is about to ask
1747 * for data pending for each stream he/she holds. Simply iterate over all
1748 * streams of a session and set the data_pending_check_done flag.
1750 * This command returns to the client a LTTNG_OK code.
1753 int relay_begin_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1754 struct relay_connection
*conn
)
1757 struct lttng_ht_iter iter
;
1758 struct lttcomm_relayd_begin_data_pending msg
;
1759 struct lttcomm_relayd_generic_reply reply
;
1760 struct relay_stream
*stream
;
1761 uint64_t session_id
;
1766 DBG("Init streams for data pending");
1768 if (!conn
->session
|| conn
->version_check_done
== 0) {
1769 ERR("Trying to check for data before version check");
1771 goto end_no_session
;
1774 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1775 if (ret
< sizeof(msg
)) {
1777 /* Orderly shutdown. Not necessary to print an error. */
1778 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1780 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1784 goto end_no_session
;
1787 session_id
= be64toh(msg
.session_id
);
1790 * Iterate over all streams to set the begin data pending flag. For now, the
1791 * streams are indexed by stream handle so we have to iterate over all
1792 * streams to find the one associated with the right session_id.
1795 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1797 if (stream
->session_id
== session_id
) {
1798 stream
->data_pending_check_done
= 0;
1799 DBG("Set begin data pending flag to stream %" PRIu64
,
1800 stream
->stream_handle
);
1805 memset(&reply
, 0, sizeof(reply
));
1806 /* All good, send back reply. */
1807 reply
.ret_code
= htobe32(LTTNG_OK
);
1809 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1811 ERR("Relay begin data pending send reply failed");
1819 * End data pending command. This will check, for a given session id, if each
1820 * stream associated with it has its data_pending_check_done flag set. If not,
1821 * this means that the client lost track of the stream but the data is still
1822 * being streamed on our side. In this case, we inform the client that data is
1825 * Return to the client if there is data in flight or not with a ret_code.
1828 int relay_end_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1829 struct relay_connection
*conn
)
1832 struct lttng_ht_iter iter
;
1833 struct lttcomm_relayd_end_data_pending msg
;
1834 struct lttcomm_relayd_generic_reply reply
;
1835 struct relay_stream
*stream
;
1836 uint64_t session_id
;
1837 uint32_t is_data_inflight
= 0;
1842 DBG("End data pending command");
1844 if (!conn
->session
|| conn
->version_check_done
== 0) {
1845 ERR("Trying to check for data before version check");
1847 goto end_no_session
;
1850 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1851 if (ret
< sizeof(msg
)) {
1853 /* Orderly shutdown. Not necessary to print an error. */
1854 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1856 ERR("Relay didn't receive valid end data_pending struct size: %d",
1860 goto end_no_session
;
1863 session_id
= be64toh(msg
.session_id
);
1865 /* Iterate over all streams to see if the begin data pending flag is set. */
1867 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1869 if (stream
->session_id
== session_id
&&
1870 !stream
->data_pending_check_done
&& !stream
->terminated_flag
) {
1871 is_data_inflight
= 1;
1872 DBG("Data is still in flight for stream %" PRIu64
,
1873 stream
->stream_handle
);
1879 memset(&reply
, 0, sizeof(reply
));
1880 /* All good, send back reply. */
1881 reply
.ret_code
= htobe32(is_data_inflight
);
1883 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1885 ERR("Relay end data pending send reply failed");
1893 * Receive an index for a specific stream.
1895 * Return 0 on success else a negative value.
1898 int relay_recv_index(struct lttcomm_relayd_hdr
*recv_hdr
,
1899 struct relay_connection
*conn
)
1901 int ret
, send_ret
, index_created
= 0;
1902 struct relay_session
*session
= conn
->session
;
1903 struct lttcomm_relayd_index index_info
;
1904 struct relay_index
*index
, *wr_index
= NULL
;
1905 struct lttcomm_relayd_generic_reply reply
;
1906 struct relay_stream
*stream
;
1907 uint64_t net_seq_num
;
1911 DBG("Relay receiving index");
1913 if (!session
|| conn
->version_check_done
== 0) {
1914 ERR("Trying to close a stream before version check");
1916 goto end_no_session
;
1919 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &index_info
,
1920 sizeof(index_info
), 0);
1921 if (ret
< sizeof(index_info
)) {
1923 /* Orderly shutdown. Not necessary to print an error. */
1924 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1926 ERR("Relay didn't receive valid index struct size : %d", ret
);
1929 goto end_no_session
;
1932 net_seq_num
= be64toh(index_info
.net_seq_num
);
1935 stream
= stream_find_by_id(relay_streams_ht
,
1936 be64toh(index_info
.relay_stream_id
));
1939 goto end_rcu_unlock
;
1942 /* Live beacon handling */
1943 if (index_info
.packet_size
== 0) {
1944 DBG("Received live beacon for stream %" PRIu64
, stream
->stream_handle
);
1947 * Only flag a stream inactive when it has already received data
1948 * and no indexes are in flight.
1950 if (stream
->total_index_received
> 0 && stream
->indexes_in_flight
== 0) {
1951 stream
->beacon_ts_end
= be64toh(index_info
.timestamp_end
);
1954 goto end_rcu_unlock
;
1956 stream
->beacon_ts_end
= -1ULL;
1959 index
= relay_index_find(stream
->stream_handle
, net_seq_num
);
1961 /* A successful creation will add the object to the HT. */
1962 index
= relay_index_create(stream
->stream_handle
, net_seq_num
);
1964 goto end_rcu_unlock
;
1967 stream
->indexes_in_flight
++;
1970 copy_index_control_data(index
, &index_info
);
1971 if (stream
->ctf_stream_id
== -1ULL) {
1972 stream
->ctf_stream_id
= be64toh(index_info
.stream_id
);
1975 if (index_created
) {
1977 * Try to add the relay index object to the hash table. If an object
1978 * already exist, destroy back the index created, set the data in this
1979 * object and write it on disk.
1981 relay_index_add(index
, &wr_index
);
1983 copy_index_control_data(wr_index
, &index_info
);
1987 /* The index already exists so write it on disk. */
1991 /* Do we have a writable ready index to write on disk. */
1993 ret
= relay_index_write(wr_index
->fd
, wr_index
);
1995 goto end_rcu_unlock
;
1997 stream
->total_index_received
++;
1998 stream
->indexes_in_flight
--;
1999 assert(stream
->indexes_in_flight
>= 0);
2005 memset(&reply
, 0, sizeof(reply
));
2007 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2009 reply
.ret_code
= htobe32(LTTNG_OK
);
2011 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2013 ERR("Relay sending close index id reply");
2022 * Receive the streams_sent message.
2024 * Return 0 on success else a negative value.
2027 int relay_streams_sent(struct lttcomm_relayd_hdr
*recv_hdr
,
2028 struct relay_connection
*conn
)
2031 struct lttcomm_relayd_generic_reply reply
;
2035 DBG("Relay receiving streams_sent");
2037 if (!conn
->session
|| conn
->version_check_done
== 0) {
2038 ERR("Trying to close a stream before version check");
2040 goto end_no_session
;
2044 * Flag every pending stream in the connection recv list that they are
2045 * ready to be used by the viewer.
2047 set_viewer_ready_flag(conn
);
2050 * Inform the viewer that there are new streams in the session.
2052 if (conn
->session
->viewer_refcount
) {
2053 uatomic_set(&conn
->session
->new_streams
, 1);
2056 memset(&reply
, 0, sizeof(reply
));
2057 reply
.ret_code
= htobe32(LTTNG_OK
);
2058 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2060 ERR("Relay sending sent_stream reply");
2072 * Process the commands received on the control socket
2075 int relay_process_control(struct lttcomm_relayd_hdr
*recv_hdr
,
2076 struct relay_connection
*conn
)
2080 switch (be32toh(recv_hdr
->cmd
)) {
2081 case RELAYD_CREATE_SESSION
:
2082 ret
= relay_create_session(recv_hdr
, conn
);
2084 case RELAYD_ADD_STREAM
:
2085 ret
= relay_add_stream(recv_hdr
, conn
);
2087 case RELAYD_START_DATA
:
2088 ret
= relay_start(recv_hdr
, conn
);
2090 case RELAYD_SEND_METADATA
:
2091 ret
= relay_recv_metadata(recv_hdr
, conn
);
2093 case RELAYD_VERSION
:
2094 ret
= relay_send_version(recv_hdr
, conn
);
2096 case RELAYD_CLOSE_STREAM
:
2097 ret
= relay_close_stream(recv_hdr
, conn
);
2099 case RELAYD_DATA_PENDING
:
2100 ret
= relay_data_pending(recv_hdr
, conn
);
2102 case RELAYD_QUIESCENT_CONTROL
:
2103 ret
= relay_quiescent_control(recv_hdr
, conn
);
2105 case RELAYD_BEGIN_DATA_PENDING
:
2106 ret
= relay_begin_data_pending(recv_hdr
, conn
);
2108 case RELAYD_END_DATA_PENDING
:
2109 ret
= relay_end_data_pending(recv_hdr
, conn
);
2111 case RELAYD_SEND_INDEX
:
2112 ret
= relay_recv_index(recv_hdr
, conn
);
2114 case RELAYD_STREAMS_SENT
:
2115 ret
= relay_streams_sent(recv_hdr
, conn
);
2117 case RELAYD_UPDATE_SYNC_INFO
:
2119 ERR("Received unknown command (%u)", be32toh(recv_hdr
->cmd
));
2120 relay_unknown_command(conn
);
2130 * Handle index for a data stream.
2132 * RCU read side lock MUST be acquired.
2134 * Return 0 on success else a negative value.
2136 static int handle_index_data(struct relay_stream
*stream
, uint64_t net_seq_num
,
2139 int ret
= 0, index_created
= 0;
2140 uint64_t stream_id
, data_offset
;
2141 struct relay_index
*index
, *wr_index
= NULL
;
2145 stream_id
= stream
->stream_handle
;
2146 /* Get data offset because we are about to update the index. */
2147 data_offset
= htobe64(stream
->tracefile_size_current
);
2150 * Lookup for an existing index for that stream id/sequence number. If on
2151 * exists, the control thread already received the data for it thus we need
2152 * to write it on disk.
2154 index
= relay_index_find(stream_id
, net_seq_num
);
2156 /* A successful creation will add the object to the HT. */
2157 index
= relay_index_create(stream_id
, net_seq_num
);
2163 stream
->indexes_in_flight
++;
2166 if (rotate_index
|| stream
->index_fd
< 0) {
2167 index
->to_close_fd
= stream
->index_fd
;
2168 ret
= index_create_file(stream
->path_name
, stream
->channel_name
,
2169 relayd_uid
, relayd_gid
, stream
->tracefile_size
,
2170 stream
->tracefile_count_current
);
2172 /* This will close the stream's index fd if one. */
2173 relay_index_free_safe(index
);
2176 stream
->index_fd
= ret
;
2178 index
->fd
= stream
->index_fd
;
2179 index
->index_data
.offset
= data_offset
;
2181 if (index_created
) {
2183 * Try to add the relay index object to the hash table. If an object
2184 * already exist, destroy back the index created and set the data.
2186 relay_index_add(index
, &wr_index
);
2188 /* Copy back data from the created index. */
2189 wr_index
->fd
= index
->fd
;
2190 wr_index
->to_close_fd
= index
->to_close_fd
;
2191 wr_index
->index_data
.offset
= data_offset
;
2195 /* The index already exists so write it on disk. */
2199 /* Do we have a writable ready index to write on disk. */
2201 ret
= relay_index_write(wr_index
->fd
, wr_index
);
2205 stream
->total_index_received
++;
2206 stream
->indexes_in_flight
--;
2207 assert(stream
->indexes_in_flight
>= 0);
2215 * relay_process_data: Process the data received on the data socket
2218 int relay_process_data(struct relay_connection
*conn
)
2220 int ret
= 0, rotate_index
= 0;
2222 struct relay_stream
*stream
;
2223 struct lttcomm_relayd_data_hdr data_hdr
;
2225 uint64_t net_seq_num
;
2227 struct relay_session
*session
;
2231 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &data_hdr
,
2232 sizeof(struct lttcomm_relayd_data_hdr
), 0);
2235 /* Orderly shutdown. Not necessary to print an error. */
2236 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2238 ERR("Unable to receive data header on sock %d", conn
->sock
->fd
);
2244 stream_id
= be64toh(data_hdr
.stream_id
);
2247 stream
= stream_find_by_id(relay_streams_ht
, stream_id
);
2250 goto end_rcu_unlock
;
2253 session
= session_find_by_id(conn
->sessions_ht
, stream
->session_id
);
2256 data_size
= be32toh(data_hdr
.data_size
);
2257 if (data_buffer_size
< data_size
) {
2260 tmp_data_ptr
= realloc(data_buffer
, data_size
);
2261 if (!tmp_data_ptr
) {
2262 ERR("Allocating data buffer");
2265 goto end_rcu_unlock
;
2267 data_buffer
= tmp_data_ptr
;
2268 data_buffer_size
= data_size
;
2270 memset(data_buffer
, 0, data_size
);
2272 net_seq_num
= be64toh(data_hdr
.net_seq_num
);
2274 DBG3("Receiving data of size %u for stream id %" PRIu64
" seqnum %" PRIu64
,
2275 data_size
, stream_id
, net_seq_num
);
2276 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
2279 /* Orderly shutdown. Not necessary to print an error. */
2280 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2283 goto end_rcu_unlock
;
2286 /* Check if a rotation is needed. */
2287 if (stream
->tracefile_size
> 0 &&
2288 (stream
->tracefile_size_current
+ data_size
) >
2289 stream
->tracefile_size
) {
2290 struct relay_viewer_stream
*vstream
;
2293 new_id
= (stream
->tracefile_count_current
+ 1) %
2294 stream
->tracefile_count
;
2296 * When we wrap-around back to 0, we start overwriting old
2299 if (!stream
->tracefile_overwrite
&& new_id
== 0) {
2300 stream
->tracefile_overwrite
= 1;
2302 pthread_mutex_lock(&stream
->viewer_stream_rotation_lock
);
2303 if (stream
->tracefile_overwrite
) {
2304 stream
->oldest_tracefile_id
=
2305 (stream
->oldest_tracefile_id
+ 1) %
2306 stream
->tracefile_count
;
2308 vstream
= viewer_stream_find_by_id(stream
->stream_handle
);
2311 * The viewer is reading a file about to be
2312 * overwritten. Close the FDs it is
2313 * currently using and let it handle the fault.
2315 if (vstream
->tracefile_count_current
== new_id
) {
2316 pthread_mutex_lock(&vstream
->overwrite_lock
);
2317 vstream
->abort_flag
= 1;
2318 pthread_mutex_unlock(&vstream
->overwrite_lock
);
2319 DBG("Streaming side setting abort_flag on stream %s_%lu\n",
2320 stream
->channel_name
, new_id
);
2321 } else if (vstream
->tracefile_count_current
==
2322 stream
->tracefile_count_current
) {
2324 * The reader and writer were in the
2325 * same trace file, inform the viewer
2326 * that no new index will ever be added
2329 vstream
->close_write_flag
= 1;
2332 ret
= utils_rotate_stream_file(stream
->path_name
, stream
->channel_name
,
2333 stream
->tracefile_size
, stream
->tracefile_count
,
2334 relayd_uid
, relayd_gid
, stream
->fd
,
2335 &(stream
->tracefile_count_current
), &stream
->fd
);
2336 stream
->total_index_received
= 0;
2337 pthread_mutex_unlock(&stream
->viewer_stream_rotation_lock
);
2339 ERR("Rotating stream output file");
2340 goto end_rcu_unlock
;
2342 /* Reset current size because we just perform a stream rotation. */
2343 stream
->tracefile_size_current
= 0;
2348 * Index are handled in protocol version 2.4 and above. Also, snapshot and
2349 * index are NOT supported.
2351 if (session
->minor
>= 4 && !session
->snapshot
) {
2352 ret
= handle_index_data(stream
, net_seq_num
, rotate_index
);
2354 goto end_rcu_unlock
;
2358 /* Write data to stream output fd. */
2359 size_ret
= lttng_write(stream
->fd
, data_buffer
, data_size
);
2360 if (size_ret
< data_size
) {
2361 ERR("Relay error writing data to file");
2363 goto end_rcu_unlock
;
2366 DBG2("Relay wrote %d bytes to tracefile for stream id %" PRIu64
,
2367 ret
, stream
->stream_handle
);
2369 ret
= write_padding_to_file(stream
->fd
, be32toh(data_hdr
.padding_size
));
2371 goto end_rcu_unlock
;
2373 stream
->tracefile_size_current
+= data_size
+ be32toh(data_hdr
.padding_size
);
2375 stream
->prev_seq
= net_seq_num
;
2377 try_close_stream(session
, stream
);
2386 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
2392 (void) lttng_poll_del(events
, pollfd
);
2394 ret
= close(pollfd
);
2396 ERR("Closing pollfd %d", pollfd
);
2400 static void destroy_connection(struct lttng_ht
*relay_connections_ht
,
2401 struct relay_connection
*conn
)
2403 assert(relay_connections_ht
);
2406 connection_delete(relay_connections_ht
, conn
);
2408 /* For the control socket, we try to destroy the session. */
2409 if (conn
->type
== RELAY_CONTROL
&& conn
->session
) {
2410 destroy_session(conn
->session
, conn
->sessions_ht
);
2413 connection_destroy(conn
);
2417 * This thread does the actual work
2420 void *relay_thread_worker(void *data
)
2422 int ret
, err
= -1, last_seen_data_fd
= -1;
2424 struct relay_connection
*conn
;
2425 struct lttng_poll_event events
;
2426 struct lttng_ht
*relay_connections_ht
;
2427 struct lttng_ht_iter iter
;
2428 struct lttcomm_relayd_hdr recv_hdr
;
2429 struct relay_local_data
*relay_ctx
= (struct relay_local_data
*) data
;
2430 struct lttng_ht
*sessions_ht
= relay_ctx
->sessions_ht
;
2432 DBG("[thread] Relay worker started");
2434 rcu_register_thread();
2436 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
2438 if (testpoint(relayd_thread_worker
)) {
2439 goto error_testpoint
;
2442 health_code_update();
2444 /* table of connections indexed on socket */
2445 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2446 if (!relay_connections_ht
) {
2447 goto relay_connections_ht_error
;
2450 /* Tables of received indexes indexed by index handle and net_seq_num. */
2451 indexes_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_TWO_U64
);
2453 goto indexes_ht_error
;
2456 ret
= create_thread_poll_set(&events
, 2);
2458 goto error_poll_create
;
2461 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2468 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
2470 health_code_update();
2472 /* Infinite blocking call, waiting for transmission */
2473 DBG3("Relayd worker thread polling...");
2474 health_poll_entry();
2475 ret
= lttng_poll_wait(&events
, -1);
2479 * Restart interrupted system call.
2481 if (errno
== EINTR
) {
2490 * Process control. The control connection is prioritised so we don't
2491 * starve it with high throughout put tracing data on the data
2494 for (i
= 0; i
< nb_fd
; i
++) {
2495 /* Fetch once the poll data */
2496 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2497 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2499 health_code_update();
2501 /* Thread quit pipe has been closed. Killing thread. */
2502 ret
= check_thread_quit_pipe(pollfd
, revents
);
2508 /* Inspect the relay conn pipe for new connection */
2509 if (pollfd
== relay_conn_pipe
[0]) {
2510 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2511 ERR("Relay connection pipe error");
2513 } else if (revents
& LPOLLIN
) {
2514 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
2518 conn
->sessions_ht
= sessions_ht
;
2519 connection_init(conn
);
2520 lttng_poll_add(&events
, conn
->sock
->fd
,
2521 LPOLLIN
| LPOLLRDHUP
);
2523 lttng_ht_add_unique_ulong(relay_connections_ht
,
2526 DBG("Connection socket %d added", conn
->sock
->fd
);
2530 conn
= connection_find_by_sock(relay_connections_ht
, pollfd
);
2531 /* If not found, there is a synchronization issue. */
2534 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2535 cleanup_connection_pollfd(&events
, pollfd
);
2536 destroy_connection(relay_connections_ht
, conn
);
2537 if (last_seen_data_fd
== pollfd
) {
2538 last_seen_data_fd
= last_notdel_data_fd
;
2540 } else if (revents
& LPOLLIN
) {
2541 if (conn
->type
== RELAY_CONTROL
) {
2542 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2543 sizeof(recv_hdr
), 0);
2545 /* Connection closed */
2546 cleanup_connection_pollfd(&events
, pollfd
);
2547 destroy_connection(relay_connections_ht
, conn
);
2548 DBG("Control connection closed with %d", pollfd
);
2550 ret
= relay_process_control(&recv_hdr
, conn
);
2552 /* Clear the session on error. */
2553 cleanup_connection_pollfd(&events
, pollfd
);
2554 destroy_connection(relay_connections_ht
, conn
);
2555 DBG("Connection closed with %d", pollfd
);
2561 * Flag the last seen data fd not deleted. It will be
2562 * used as the last seen fd if any fd gets deleted in
2565 last_notdel_data_fd
= pollfd
;
2568 ERR("Unknown poll events %u for sock %d", revents
, pollfd
);
2575 * The last loop handled a control request, go back to poll to make
2576 * sure we prioritise the control socket.
2582 if (last_seen_data_fd
>= 0) {
2583 for (i
= 0; i
< nb_fd
; i
++) {
2584 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2586 health_code_update();
2588 if (last_seen_data_fd
== pollfd
) {
2595 /* Process data connection. */
2596 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
2597 /* Fetch the poll data. */
2598 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2599 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2601 health_code_update();
2603 /* Skip the command pipe. It's handled in the first loop. */
2604 if (pollfd
== relay_conn_pipe
[0]) {
2610 conn
= connection_find_by_sock(relay_connections_ht
, pollfd
);
2612 /* Skip it. Might be removed before. */
2617 if (revents
& LPOLLIN
) {
2618 if (conn
->type
!= RELAY_DATA
) {
2622 ret
= relay_process_data(conn
);
2623 /* Connection closed */
2625 cleanup_connection_pollfd(&events
, pollfd
);
2626 destroy_connection(relay_connections_ht
, conn
);
2627 DBG("Data connection closed with %d", pollfd
);
2629 * Every goto restart call sets the last seen fd where
2630 * here we don't really care since we gracefully
2631 * continue the loop after the connection is deleted.
2634 /* Keep last seen port. */
2635 last_seen_data_fd
= pollfd
;
2643 last_seen_data_fd
= -1;
2646 /* Normal exit, no error */
2651 lttng_poll_clean(&events
);
2653 /* Cleanup reamaining connection object. */
2655 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
, conn
,
2657 health_code_update();
2658 destroy_connection(relay_connections_ht
, conn
);
2662 lttng_ht_destroy(indexes_ht
);
2664 lttng_ht_destroy(relay_connections_ht
);
2665 relay_connections_ht_error
:
2666 /* Close relay conn pipes */
2667 utils_close_pipe(relay_conn_pipe
);
2669 DBG("Thread exited with error");
2671 DBG("Worker thread cleanup complete");
2676 ERR("Health error occurred in %s", __func__
);
2678 health_unregister(health_relayd
);
2679 rcu_unregister_thread();
2685 * Create the relay command pipe to wake thread_manage_apps.
2686 * Closed in cleanup().
2688 static int create_relay_conn_pipe(void)
2692 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
2700 int main(int argc
, char **argv
)
2704 struct relay_local_data
*relay_ctx
;
2706 /* Parse arguments */
2708 if ((ret
= set_options(argc
, argv
)) < 0) {
2712 if ((ret
= set_signal_handler()) < 0) {
2716 /* Try to create directory if -o, --output is specified. */
2717 if (opt_output_path
) {
2718 if (*opt_output_path
!= '/') {
2719 ERR("Please specify an absolute path for -o, --output PATH");
2723 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
);
2725 ERR("Unable to create %s", opt_output_path
);
2731 if (opt_daemon
|| opt_background
) {
2734 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
2741 * We are in the child. Make sure all other file
2742 * descriptors are closed, in case we are called with
2743 * more opened file descriptors than the standard ones.
2745 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
2750 /* Create thread quit pipe */
2751 if ((ret
= init_thread_quit_pipe()) < 0) {
2755 /* We need those values for the file/dir creation. */
2756 relayd_uid
= getuid();
2757 relayd_gid
= getgid();
2759 /* Check if daemon is UID = 0 */
2760 if (relayd_uid
== 0) {
2761 if (control_uri
->port
< 1024 || data_uri
->port
< 1024 || live_uri
->port
< 1024) {
2762 ERR("Need to be root to use ports < 1024");
2768 /* Setup the thread apps communication pipe. */
2769 if ((ret
= create_relay_conn_pipe()) < 0) {
2773 /* Init relay command queue. */
2774 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
2776 /* Set up max poll set size */
2777 lttng_poll_set_max_size();
2779 /* Initialize communication library */
2781 lttcomm_inet_init();
2783 relay_ctx
= zmalloc(sizeof(struct relay_local_data
));
2785 PERROR("relay_ctx");
2789 /* tables of sessions indexed by session ID */
2790 relay_ctx
->sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2791 if (!relay_ctx
->sessions_ht
) {
2792 goto exit_relay_ctx_sessions
;
2795 /* tables of streams indexed by stream ID */
2796 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2797 if (!relay_streams_ht
) {
2798 goto exit_relay_ctx_streams
;
2801 /* tables of streams indexed by stream ID */
2802 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2803 if (!viewer_streams_ht
) {
2804 goto exit_relay_ctx_viewer_streams
;
2807 /* Initialize thread health monitoring */
2808 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
2809 if (!health_relayd
) {
2810 PERROR("health_app_create error");
2811 goto exit_health_app_create
;
2814 ret
= utils_create_pipe(health_quit_pipe
);
2816 goto error_health_pipe
;
2819 /* Create thread to manage the client socket */
2820 ret
= pthread_create(&health_thread
, NULL
,
2821 thread_manage_health
, (void *) NULL
);
2823 PERROR("pthread_create health");
2827 /* Setup the dispatcher thread */
2828 ret
= pthread_create(&dispatcher_thread
, NULL
,
2829 relay_thread_dispatcher
, (void *) NULL
);
2831 PERROR("pthread_create dispatcher");
2832 goto exit_dispatcher
;
2835 /* Setup the worker thread */
2836 ret
= pthread_create(&worker_thread
, NULL
,
2837 relay_thread_worker
, (void *) relay_ctx
);
2839 PERROR("pthread_create worker");
2843 /* Setup the listener thread */
2844 ret
= pthread_create(&listener_thread
, NULL
,
2845 relay_thread_listener
, (void *) NULL
);
2847 PERROR("pthread_create listener");
2851 ret
= live_start_threads(live_uri
, relay_ctx
);
2853 ERR("Starting live viewer threads");
2858 ret
= pthread_join(listener_thread
, &status
);
2860 PERROR("pthread_join");
2861 goto error
; /* join error, exit without cleanup */
2865 ret
= pthread_join(worker_thread
, &status
);
2867 PERROR("pthread_join");
2868 goto error
; /* join error, exit without cleanup */
2872 ret
= pthread_join(dispatcher_thread
, &status
);
2874 PERROR("pthread_join");
2875 goto error
; /* join error, exit without cleanup */
2879 ret
= pthread_join(health_thread
, &status
);
2881 PERROR("pthread_join health thread");
2882 goto error
; /* join error, exit without cleanup */
2886 * Stop live threads only after joining other threads.
2888 live_stop_threads();
2891 utils_close_pipe(health_quit_pipe
);
2894 health_app_destroy(health_relayd
);
2896 exit_health_app_create
:
2897 lttng_ht_destroy(viewer_streams_ht
);
2899 exit_relay_ctx_viewer_streams
:
2900 lttng_ht_destroy(relay_streams_ht
);
2902 exit_relay_ctx_streams
:
2903 lttng_ht_destroy(relay_ctx
->sessions_ht
);
2905 exit_relay_ctx_sessions
: