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.
30 #include <sys/mount.h>
31 #include <sys/resource.h>
32 #include <sys/socket.h>
34 #include <sys/types.h>
37 #include <urcu/futex.h>
38 #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/defaults.h>
48 #include <common/daemonize.h>
49 #include <common/futex.h>
50 #include <common/sessiond-comm/sessiond-comm.h>
51 #include <common/sessiond-comm/inet.h>
52 #include <common/sessiond-comm/relayd.h>
53 #include <common/uri.h>
54 #include <common/utils.h>
55 #include <common/config/config.h>
58 #include "ctf-trace.h"
61 #include "lttng-relayd.h"
63 #include "health-relayd.h"
64 #include "testpoint.h"
65 #include "viewer-stream.h"
68 #include "connection.h"
70 /* command line options */
71 char *opt_output_path
;
72 static int opt_daemon
, opt_background
;
75 * We need to wait for listener and live listener threads, as well as
76 * health check thread, before being ready to signal readiness.
78 #define NR_LTTNG_RELAY_READY 3
79 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
80 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
81 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
83 static struct lttng_uri
*control_uri
;
84 static struct lttng_uri
*data_uri
;
85 static struct lttng_uri
*live_uri
;
89 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
90 static int tracing_group_name_override
;
92 const char * const config_section_name
= "relayd";
95 * Quit pipe for all threads. This permits a single cancellation point
96 * for all threads when receiving an event on the pipe.
98 int thread_quit_pipe
[2] = { -1, -1 };
101 * This pipe is used to inform the worker thread that a command is queued and
102 * ready to be processed.
104 static int relay_conn_pipe
[2] = { -1, -1 };
106 /* Shared between threads */
107 static int dispatch_thread_exit
;
109 static pthread_t listener_thread
;
110 static pthread_t dispatcher_thread
;
111 static pthread_t worker_thread
;
112 static pthread_t health_thread
;
114 static uint64_t last_relay_stream_id
;
117 * Relay command queue.
119 * The relay_thread_listener and relay_thread_dispatcher communicate with this
122 static struct relay_conn_queue relay_conn_queue
;
124 /* buffer allocated at startup, used to store the trace data */
125 static char *data_buffer
;
126 static unsigned int data_buffer_size
;
128 /* We need those values for the file/dir creation. */
129 static uid_t relayd_uid
;
130 static gid_t relayd_gid
;
132 /* Global relay stream hash table. */
133 struct lttng_ht
*relay_streams_ht
;
135 /* Global relay viewer stream hash table. */
136 struct lttng_ht
*viewer_streams_ht
;
138 /* Global hash table that stores relay index object. */
139 struct lttng_ht
*indexes_ht
;
141 /* Relayd health monitoring */
142 struct health_app
*health_relayd
;
144 static struct option long_options
[] = {
145 { "control-port", 1, 0, 'C', },
146 { "data-port", 1, 0, 'D', },
147 { "live-port", 1, 0, 'L', },
148 { "daemonize", 0, 0, 'd', },
149 { "background", 0, 0, 'b', },
150 { "group", 1, 0, 'g', },
151 { "help", 0, 0, 'h', },
152 { "output", 1, 0, 'o', },
153 { "verbose", 0, 0, 'v', },
154 { "config", 1, 0, 'f' },
158 static const char *config_ignore_options
[] = { "help", "config" };
161 * usage function on stderr
166 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
167 fprintf(stderr
, " -h, --help Display this usage.\n");
168 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
169 fprintf(stderr
, " -b, --background Start as a daemon, keeping console open.\n");
170 fprintf(stderr
, " -C, --control-port URL Control port listening.\n");
171 fprintf(stderr
, " -D, --data-port URL Data port listening.\n");
172 fprintf(stderr
, " -L, --live-port URL Live view port listening.\n");
173 fprintf(stderr
, " -o, --output PATH Output path for traces. Must use an absolute path.\n");
174 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
175 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
176 fprintf(stderr
, " -f --config Load daemon configuration file\n");
180 * Take an option from the getopt output and set it in the right variable to be
183 * Return 0 on success else a negative value.
186 int set_option(int opt
, const char *arg
, const char *optname
)
192 fprintf(stderr
, "option %s", optname
);
194 fprintf(stderr
, " with arg %s\n", arg
);
198 ret
= uri_parse(arg
, &control_uri
);
200 ERR("Invalid control URI specified");
203 if (control_uri
->port
== 0) {
204 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
208 ret
= uri_parse(arg
, &data_uri
);
210 ERR("Invalid data URI specified");
213 if (data_uri
->port
== 0) {
214 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
218 ret
= uri_parse(arg
, &live_uri
);
220 ERR("Invalid live URI specified");
223 if (live_uri
->port
== 0) {
224 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
234 tracing_group_name
= strdup(arg
);
235 tracing_group_name_override
= 1;
241 ret
= asprintf(&opt_output_path
, "%s", arg
);
244 PERROR("asprintf opt_output_path");
249 /* Verbose level can increase using multiple -v */
251 lttng_opt_verbose
= config_parse_value(arg
);
253 lttng_opt_verbose
+= 1;
257 /* Unknown option or other error.
258 * Error is printed by getopt, just return */
271 * config_entry_handler_cb used to handle options read from a config file.
272 * See config_entry_handler_cb comment in common/config/config.h for the
273 * return value conventions.
276 int config_entry_handler(const struct config_entry
*entry
, void *unused
)
280 if (!entry
|| !entry
->name
|| !entry
->value
) {
285 /* Check if the option is to be ignored */
286 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
287 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
292 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1; i
++) {
293 /* Ignore if entry name is not fully matched. */
294 if (strcmp(entry
->name
, long_options
[i
].name
)) {
299 * If the option takes no argument on the command line, we have to
300 * check if the value is "true". We support non-zero numeric values,
303 if (!long_options
[i
].has_arg
) {
304 ret
= config_parse_value(entry
->value
);
307 WARN("Invalid configuration value \"%s\" for option %s",
308 entry
->value
, entry
->name
);
310 /* False, skip boolean config option. */
315 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
319 WARN("Unrecognized option \"%s\" in daemon configuration file.",
327 int set_options(int argc
, char **argv
)
329 int c
, ret
= 0, option_index
= 0;
330 int orig_optopt
= optopt
, orig_optind
= optind
;
331 char *default_address
, *optstring
;
332 const char *config_path
= NULL
;
334 optstring
= utils_generate_optstring(long_options
,
335 sizeof(long_options
) / sizeof(struct option
));
341 /* Check for the --config option */
343 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
344 &option_index
)) != -1) {
348 } else if (c
!= 'f') {
352 config_path
= utils_expand_path(optarg
);
354 ERR("Failed to resolve path: %s", optarg
);
358 ret
= config_get_section_entries(config_path
, config_section_name
,
359 config_entry_handler
, NULL
);
362 ERR("Invalid configuration option at line %i", ret
);
368 /* Reset getopt's global state */
369 optopt
= orig_optopt
;
370 optind
= orig_optind
;
372 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
377 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
383 /* assign default values */
384 if (control_uri
== NULL
) {
385 ret
= asprintf(&default_address
,
386 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
387 DEFAULT_NETWORK_CONTROL_PORT
);
389 PERROR("asprintf default data address");
393 ret
= uri_parse(default_address
, &control_uri
);
394 free(default_address
);
396 ERR("Invalid control URI specified");
400 if (data_uri
== NULL
) {
401 ret
= asprintf(&default_address
,
402 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
403 DEFAULT_NETWORK_DATA_PORT
);
405 PERROR("asprintf default data address");
409 ret
= uri_parse(default_address
, &data_uri
);
410 free(default_address
);
412 ERR("Invalid data URI specified");
416 if (live_uri
== NULL
) {
417 ret
= asprintf(&default_address
,
418 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
419 DEFAULT_NETWORK_VIEWER_PORT
);
421 PERROR("asprintf default viewer control address");
425 ret
= uri_parse(default_address
, &live_uri
);
426 free(default_address
);
428 ERR("Invalid viewer control URI specified");
446 /* free the dynamically allocated opt_output_path */
447 free(opt_output_path
);
449 /* Close thread quit pipes */
450 utils_close_pipe(thread_quit_pipe
);
452 uri_free(control_uri
);
454 /* Live URI is freed in the live thread. */
456 if (tracing_group_name_override
) {
457 free((void *) tracing_group_name
);
462 * Write to writable pipe used to notify a thread.
465 int notify_thread_pipe(int wpipe
)
469 ret
= lttng_write(wpipe
, "!", 1);
471 PERROR("write poll pipe");
477 static void notify_health_quit_pipe(int *pipe
)
481 ret
= lttng_write(pipe
[1], "4", 1);
483 PERROR("write relay health quit");
488 * Stop all threads by closing the thread quit pipe.
491 void stop_threads(void)
495 /* Stopping all threads */
496 DBG("Terminating all threads");
497 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
499 ERR("write error on thread quit pipe");
502 notify_health_quit_pipe(health_quit_pipe
);
504 /* Dispatch thread */
505 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
506 futex_nto1_wake(&relay_conn_queue
.futex
);
510 * Signal handler for the daemon
512 * Simply stop all worker threads, leaving main() return gracefully after
513 * joining all threads and calling cleanup().
516 void sighandler(int sig
)
520 DBG("SIGPIPE caught");
523 DBG("SIGINT caught");
527 DBG("SIGTERM caught");
531 CMM_STORE_SHARED(recv_child_signal
, 1);
539 * Setup signal handler for :
540 * SIGINT, SIGTERM, SIGPIPE
543 int set_signal_handler(void)
549 if ((ret
= sigemptyset(&sigset
)) < 0) {
550 PERROR("sigemptyset");
554 sa
.sa_handler
= sighandler
;
557 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
562 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
567 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
572 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
577 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
582 void lttng_relay_notify_ready(void)
584 /* Notify the parent of the fork() process that we are ready. */
585 if (opt_daemon
|| opt_background
) {
586 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
587 kill(child_ppid
, SIGUSR1
);
593 * Init thread quit pipe.
595 * Return -1 on error or 0 if all pipes are created.
598 int init_thread_quit_pipe(void)
602 ret
= utils_create_pipe_cloexec(thread_quit_pipe
);
608 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
611 int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
615 if (events
== NULL
|| size
== 0) {
620 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
626 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
638 * Check if the thread quit pipe was triggered.
640 * Return 1 if it was triggered else 0;
643 int check_thread_quit_pipe(int fd
, uint32_t events
)
645 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
653 * Create and init socket from uri.
656 struct lttcomm_sock
*relay_init_sock(struct lttng_uri
*uri
)
659 struct lttcomm_sock
*sock
= NULL
;
661 sock
= lttcomm_alloc_sock_from_uri(uri
);
663 ERR("Allocating socket");
667 ret
= lttcomm_create_sock(sock
);
671 DBG("Listening on sock %d", sock
->fd
);
673 ret
= sock
->ops
->bind(sock
);
678 ret
= sock
->ops
->listen(sock
, -1);
688 lttcomm_destroy_sock(sock
);
694 * Return nonzero if stream needs to be closed.
697 int close_stream_check(struct relay_stream
*stream
)
699 if (stream
->close_flag
&& stream
->prev_seq
== stream
->last_net_seq_num
) {
701 * We are about to close the stream so set the data pending flag to 1
702 * which will make the end data pending command skip the stream which
703 * is now closed and ready. Note that after proceeding to a file close,
704 * the written file is ready for reading.
706 stream
->data_pending_check_done
= 1;
712 static void try_close_stream(struct relay_session
*session
,
713 struct relay_stream
*stream
)
716 struct ctf_trace
*ctf_trace
;
721 if (!close_stream_check(stream
)) {
722 /* Can't close it, not ready for that. */
726 ctf_trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
,
730 pthread_mutex_lock(&session
->viewer_ready_lock
);
731 ctf_trace
->invalid_flag
= 1;
732 pthread_mutex_unlock(&session
->viewer_ready_lock
);
734 ret
= stream_close(session
, stream
);
735 if (ret
|| session
->snapshot
) {
736 /* Already close thus the ctf trace is being or has been destroyed. */
740 ctf_trace_try_destroy(session
, ctf_trace
);
747 * This thread manages the listening for new connections on the network
750 void *relay_thread_listener(void *data
)
752 int i
, ret
, pollfd
, err
= -1;
753 uint32_t revents
, nb_fd
;
754 struct lttng_poll_event events
;
755 struct lttcomm_sock
*control_sock
, *data_sock
;
757 DBG("[thread] Relay listener started");
759 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
761 health_code_update();
763 control_sock
= relay_init_sock(control_uri
);
765 goto error_sock_control
;
768 data_sock
= relay_init_sock(data_uri
);
770 goto error_sock_relay
;
774 * Pass 3 as size here for the thread quit pipe, control and data socket.
776 ret
= create_thread_poll_set(&events
, 3);
778 goto error_create_poll
;
781 /* Add the control socket */
782 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
787 /* Add the data socket */
788 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
793 lttng_relay_notify_ready();
795 if (testpoint(relayd_thread_listener
)) {
796 goto error_testpoint
;
800 health_code_update();
802 DBG("Listener accepting connections");
806 ret
= lttng_poll_wait(&events
, -1);
810 * Restart interrupted system call.
812 if (errno
== EINTR
) {
820 DBG("Relay new connection received");
821 for (i
= 0; i
< nb_fd
; i
++) {
822 health_code_update();
824 /* Fetch once the poll data */
825 revents
= LTTNG_POLL_GETEV(&events
, i
);
826 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
828 /* Thread quit pipe has been closed. Killing thread. */
829 ret
= check_thread_quit_pipe(pollfd
, revents
);
835 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
836 ERR("socket poll error");
838 } else if (revents
& LPOLLIN
) {
840 * Get allocated in this thread, enqueued to a global queue,
841 * dequeued and freed in the worker thread.
844 struct relay_connection
*new_conn
;
845 struct lttcomm_sock
*newsock
;
847 new_conn
= connection_create();
852 if (pollfd
== data_sock
->fd
) {
853 new_conn
->type
= RELAY_DATA
;
854 newsock
= data_sock
->ops
->accept(data_sock
);
855 DBG("Relay data connection accepted, socket %d",
858 assert(pollfd
== control_sock
->fd
);
859 new_conn
->type
= RELAY_CONTROL
;
860 newsock
= control_sock
->ops
->accept(control_sock
);
861 DBG("Relay control connection accepted, socket %d",
865 PERROR("accepting sock");
866 connection_free(new_conn
);
870 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
873 PERROR("setsockopt inet");
874 lttcomm_destroy_sock(newsock
);
875 connection_free(new_conn
);
878 new_conn
->sock
= newsock
;
880 /* Enqueue request for the dispatcher thread. */
881 cds_wfq_enqueue(&relay_conn_queue
.queue
, &new_conn
->qnode
);
884 * Wake the dispatch queue futex. Implicit memory barrier with
885 * the exchange in cds_wfq_enqueue.
887 futex_nto1_wake(&relay_conn_queue
.futex
);
896 lttng_poll_clean(&events
);
898 if (data_sock
->fd
>= 0) {
899 ret
= data_sock
->ops
->close(data_sock
);
904 lttcomm_destroy_sock(data_sock
);
906 if (control_sock
->fd
>= 0) {
907 ret
= control_sock
->ops
->close(control_sock
);
912 lttcomm_destroy_sock(control_sock
);
916 ERR("Health error occurred in %s", __func__
);
918 health_unregister(health_relayd
);
919 DBG("Relay listener thread cleanup complete");
925 * This thread manages the dispatching of the requests to worker threads
928 void *relay_thread_dispatcher(void *data
)
932 struct cds_wfq_node
*node
;
933 struct relay_connection
*new_conn
= NULL
;
935 DBG("[thread] Relay dispatcher started");
937 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
939 if (testpoint(relayd_thread_dispatcher
)) {
940 goto error_testpoint
;
943 health_code_update();
945 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
946 health_code_update();
948 /* Atomically prepare the queue futex */
949 futex_nto1_prepare(&relay_conn_queue
.futex
);
952 health_code_update();
954 /* Dequeue commands */
955 node
= cds_wfq_dequeue_blocking(&relay_conn_queue
.queue
);
957 DBG("Woken up but nothing in the relay command queue");
958 /* Continue thread execution */
961 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
963 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
966 * Inform worker thread of the new request. This call is blocking
967 * so we can be assured that the data will be read at some point in
968 * time or wait to the end of the world :)
970 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
972 PERROR("write connection pipe");
973 connection_destroy(new_conn
);
976 } while (node
!= NULL
);
978 /* Futex wait on queue. Blocking call on futex() */
980 futex_nto1_wait(&relay_conn_queue
.futex
);
984 /* Normal exit, no error */
991 ERR("Health error occurred in %s", __func__
);
993 health_unregister(health_relayd
);
994 DBG("Dispatch thread dying");
999 static void try_close_streams(struct relay_session
*session
)
1001 struct ctf_trace
*ctf_trace
;
1002 struct lttng_ht_iter iter
;
1006 pthread_mutex_lock(&session
->viewer_ready_lock
);
1008 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
, &iter
.iter
, ctf_trace
,
1010 struct relay_stream
*stream
;
1012 /* Close streams. */
1013 cds_list_for_each_entry(stream
, &ctf_trace
->stream_list
, trace_list
) {
1014 stream_close(session
, stream
);
1017 ctf_trace
->invalid_flag
= 1;
1018 ctf_trace_try_destroy(session
, ctf_trace
);
1021 pthread_mutex_unlock(&session
->viewer_ready_lock
);
1025 * Try to destroy a session within a connection.
1027 static void destroy_session(struct relay_session
*session
,
1028 struct lttng_ht
*sessions_ht
)
1031 assert(sessions_ht
);
1033 /* Indicate that this session can be destroyed from now on. */
1034 session
->close_flag
= 1;
1036 try_close_streams(session
);
1039 * This will try to delete and destroy the session if no viewer is attached
1040 * to it meaning the refcount is down to zero.
1042 session_try_destroy(sessions_ht
, session
);
1046 * Copy index data from the control port to a given index object.
1048 static void copy_index_control_data(struct relay_index
*index
,
1049 struct lttcomm_relayd_index
*data
)
1055 * The index on disk is encoded in big endian, so we don't need to convert
1056 * the data received on the network. The data_offset value is NEVER
1057 * modified here and is updated by the data thread.
1059 index
->index_data
.packet_size
= data
->packet_size
;
1060 index
->index_data
.content_size
= data
->content_size
;
1061 index
->index_data
.timestamp_begin
= data
->timestamp_begin
;
1062 index
->index_data
.timestamp_end
= data
->timestamp_end
;
1063 index
->index_data
.events_discarded
= data
->events_discarded
;
1064 index
->index_data
.stream_id
= data
->stream_id
;
1068 * Handle the RELAYD_CREATE_SESSION command.
1070 * On success, send back the session id or else return a negative value.
1073 int relay_create_session(struct lttcomm_relayd_hdr
*recv_hdr
,
1074 struct relay_connection
*conn
)
1076 int ret
= 0, send_ret
;
1077 struct relay_session
*session
;
1078 struct lttcomm_relayd_status_session reply
;
1083 memset(&reply
, 0, sizeof(reply
));
1085 session
= session_create();
1090 session
->minor
= conn
->minor
;
1091 session
->major
= conn
->major
;
1092 conn
->session_id
= session
->id
;
1093 conn
->session
= session
;
1095 reply
.session_id
= htobe64(session
->id
);
1097 switch (conn
->minor
) {
1102 case 4: /* LTTng sessiond 2.4 */
1104 ret
= cmd_create_session_2_4(conn
, session
);
1107 lttng_ht_add_unique_u64(conn
->sessions_ht
, &session
->session_n
);
1108 DBG("Created session %" PRIu64
, session
->id
);
1112 reply
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1114 reply
.ret_code
= htobe32(LTTNG_OK
);
1117 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1119 ERR("Relayd sending session id");
1127 * When we have received all the streams and the metadata for a channel,
1128 * we make them visible to the viewer threads.
1131 void set_viewer_ready_flag(struct relay_connection
*conn
)
1133 struct relay_stream
*stream
, *tmp_stream
;
1135 pthread_mutex_lock(&conn
->session
->viewer_ready_lock
);
1136 cds_list_for_each_entry_safe(stream
, tmp_stream
, &conn
->recv_head
,
1138 stream
->viewer_ready
= 1;
1139 cds_list_del(&stream
->recv_list
);
1141 pthread_mutex_unlock(&conn
->session
->viewer_ready_lock
);
1146 * Add a recv handle node to the connection recv list with the given stream
1147 * handle. A new node is allocated thus must be freed when the node is deleted
1150 static void queue_stream(struct relay_stream
*stream
,
1151 struct relay_connection
*conn
)
1156 cds_list_add(&stream
->recv_list
, &conn
->recv_head
);
1160 * relay_add_stream: allocate a new stream for a session
1163 int relay_add_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1164 struct relay_connection
*conn
)
1167 struct relay_session
*session
= conn
->session
;
1168 struct relay_stream
*stream
= NULL
;
1169 struct lttcomm_relayd_status_stream reply
;
1170 struct ctf_trace
*trace
;
1172 if (!session
|| conn
->version_check_done
== 0) {
1173 ERR("Trying to add a stream before version check");
1175 goto end_no_session
;
1178 stream
= zmalloc(sizeof(struct relay_stream
));
1179 if (stream
== NULL
) {
1180 PERROR("relay stream zmalloc");
1182 goto end_no_session
;
1185 switch (conn
->minor
) {
1186 case 1: /* LTTng sessiond 2.1 */
1187 ret
= cmd_recv_stream_2_1(conn
, stream
);
1189 case 2: /* LTTng sessiond 2.2 */
1191 ret
= cmd_recv_stream_2_2(conn
, stream
);
1195 goto err_free_stream
;
1199 stream
->stream_handle
= ++last_relay_stream_id
;
1200 stream
->prev_seq
= -1ULL;
1201 stream
->session_id
= session
->id
;
1202 stream
->index_fd
= -1;
1203 stream
->read_index_fd
= -1;
1204 lttng_ht_node_init_u64(&stream
->node
, stream
->stream_handle
);
1205 pthread_mutex_init(&stream
->lock
, NULL
);
1207 ret
= utils_mkdir_recursive(stream
->path_name
, S_IRWXU
| S_IRWXG
);
1209 ERR("relay creating output directory");
1214 * No need to use run_as API here because whatever we receives, the relayd
1215 * uses its own credentials for the stream files.
1217 ret
= utils_create_stream_file(stream
->path_name
, stream
->channel_name
,
1218 stream
->tracefile_size
, 0, relayd_uid
, relayd_gid
, NULL
);
1220 ERR("Create output file");
1224 if (stream
->tracefile_size
) {
1225 DBG("Tracefile %s/%s_0 created", stream
->path_name
, stream
->channel_name
);
1227 DBG("Tracefile %s/%s created", stream
->path_name
, stream
->channel_name
);
1230 trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
, stream
->path_name
);
1232 trace
= ctf_trace_create(stream
->path_name
);
1237 ctf_trace_add(session
->ctf_traces_ht
, trace
);
1239 ctf_trace_get_ref(trace
);
1241 if (!strncmp(stream
->channel_name
, DEFAULT_METADATA_NAME
, NAME_MAX
)) {
1242 stream
->metadata_flag
= 1;
1243 /* Assign quick reference to the metadata stream in the trace. */
1244 trace
->metadata_stream
= stream
;
1248 * Add the stream in the recv list of the connection. Once the end stream
1249 * message is received, this list is emptied and streams are set with the
1250 * viewer ready flag.
1252 queue_stream(stream
, conn
);
1255 * Both in the ctf_trace object and the global stream ht since the data
1256 * side of the relayd does not have the concept of session.
1258 lttng_ht_add_unique_u64(relay_streams_ht
, &stream
->node
);
1259 cds_list_add_tail(&stream
->trace_list
, &trace
->stream_list
);
1261 session
->stream_count
++;
1263 DBG("Relay new stream added %s with ID %" PRIu64
, stream
->channel_name
,
1264 stream
->stream_handle
);
1267 memset(&reply
, 0, sizeof(reply
));
1268 reply
.handle
= htobe64(stream
->stream_handle
);
1269 /* send the session id to the client or a negative return code on error */
1271 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1272 /* stream was not properly added to the ht, so free it */
1275 reply
.ret_code
= htobe32(LTTNG_OK
);
1278 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1279 sizeof(struct lttcomm_relayd_status_stream
), 0);
1281 ERR("Relay sending stream id");
1290 free(stream
->path_name
);
1291 free(stream
->channel_name
);
1297 * relay_close_stream: close a specific stream
1300 int relay_close_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1301 struct relay_connection
*conn
)
1304 struct relay_session
*session
= conn
->session
;
1305 struct lttcomm_relayd_close_stream stream_info
;
1306 struct lttcomm_relayd_generic_reply reply
;
1307 struct relay_stream
*stream
;
1309 DBG("Close stream received");
1311 if (!session
|| conn
->version_check_done
== 0) {
1312 ERR("Trying to close a stream before version check");
1314 goto end_no_session
;
1317 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &stream_info
,
1318 sizeof(struct lttcomm_relayd_close_stream
), 0);
1319 if (ret
< sizeof(struct lttcomm_relayd_close_stream
)) {
1321 /* Orderly shutdown. Not necessary to print an error. */
1322 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1324 ERR("Relay didn't receive valid add_stream struct size : %d", ret
);
1327 goto end_no_session
;
1331 stream
= stream_find_by_id(relay_streams_ht
,
1332 be64toh(stream_info
.stream_id
));
1338 stream
->last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1339 stream
->close_flag
= 1;
1340 session
->stream_count
--;
1341 assert(session
->stream_count
>= 0);
1344 * Remove the stream from the connection recv list since we are about to
1345 * flag it invalid and thus might be freed. This has to be done here since
1346 * only the control thread can do actions on that list.
1348 * Note that this stream might NOT be in the list but we have to try to
1349 * remove it here else this can race with the stream destruction freeing
1350 * the object and the connection destroy doing a use after free when
1351 * deleting the remaining nodes in this list.
1353 cds_list_del(&stream
->recv_list
);
1355 /* Check if we can close it or else the data will do it. */
1356 try_close_stream(session
, stream
);
1361 memset(&reply
, 0, sizeof(reply
));
1363 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1365 reply
.ret_code
= htobe32(LTTNG_OK
);
1367 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1368 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1370 ERR("Relay sending stream id");
1379 * relay_unknown_command: send -1 if received unknown command
1382 void relay_unknown_command(struct relay_connection
*conn
)
1384 struct lttcomm_relayd_generic_reply reply
;
1387 memset(&reply
, 0, sizeof(reply
));
1388 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1389 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1390 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1392 ERR("Relay sending unknown command");
1397 * relay_start: send an acknowledgment to the client to tell if we are
1398 * ready to receive data. We are ready if a session is established.
1401 int relay_start(struct lttcomm_relayd_hdr
*recv_hdr
,
1402 struct relay_connection
*conn
)
1404 int ret
= htobe32(LTTNG_OK
);
1405 struct lttcomm_relayd_generic_reply reply
;
1406 struct relay_session
*session
= conn
->session
;
1409 DBG("Trying to start the streaming without a session established");
1410 ret
= htobe32(LTTNG_ERR_UNK
);
1413 memset(&reply
, 0, sizeof(reply
));
1414 reply
.ret_code
= ret
;
1415 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1416 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1418 ERR("Relay sending start ack");
1425 * Append padding to the file pointed by the file descriptor fd.
1427 static int write_padding_to_file(int fd
, uint32_t size
)
1436 zeros
= zmalloc(size
);
1437 if (zeros
== NULL
) {
1438 PERROR("zmalloc zeros for padding");
1443 ret
= lttng_write(fd
, zeros
, size
);
1445 PERROR("write padding to file");
1455 * relay_recv_metadata: receive the metada for the session.
1458 int relay_recv_metadata(struct lttcomm_relayd_hdr
*recv_hdr
,
1459 struct relay_connection
*conn
)
1461 int ret
= htobe32(LTTNG_OK
);
1463 struct relay_session
*session
= conn
->session
;
1464 struct lttcomm_relayd_metadata_payload
*metadata_struct
;
1465 struct relay_stream
*metadata_stream
;
1466 uint64_t data_size
, payload_size
;
1467 struct ctf_trace
*ctf_trace
;
1470 ERR("Metadata sent before version check");
1475 data_size
= payload_size
= be64toh(recv_hdr
->data_size
);
1476 if (data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1477 ERR("Incorrect data size");
1481 payload_size
-= sizeof(struct lttcomm_relayd_metadata_payload
);
1483 if (data_buffer_size
< data_size
) {
1484 /* In case the realloc fails, we can free the memory */
1487 tmp_data_ptr
= realloc(data_buffer
, data_size
);
1488 if (!tmp_data_ptr
) {
1489 ERR("Allocating data buffer");
1494 data_buffer
= tmp_data_ptr
;
1495 data_buffer_size
= data_size
;
1497 memset(data_buffer
, 0, data_size
);
1498 DBG2("Relay receiving metadata, waiting for %" PRIu64
" bytes", data_size
);
1499 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
1500 if (ret
< 0 || ret
!= data_size
) {
1502 /* Orderly shutdown. Not necessary to print an error. */
1503 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1505 ERR("Relay didn't receive the whole metadata");
1510 metadata_struct
= (struct lttcomm_relayd_metadata_payload
*) data_buffer
;
1513 metadata_stream
= stream_find_by_id(relay_streams_ht
,
1514 be64toh(metadata_struct
->stream_id
));
1515 if (!metadata_stream
) {
1520 size_ret
= lttng_write(metadata_stream
->fd
, metadata_struct
->payload
,
1522 if (size_ret
< payload_size
) {
1523 ERR("Relay error writing metadata on file");
1528 ret
= write_padding_to_file(metadata_stream
->fd
,
1529 be32toh(metadata_struct
->padding_size
));
1534 ctf_trace
= ctf_trace_find_by_path(session
->ctf_traces_ht
,
1535 metadata_stream
->path_name
);
1537 ctf_trace
->metadata_received
+=
1538 payload_size
+ be32toh(metadata_struct
->padding_size
);
1540 DBG2("Relay metadata written");
1549 * relay_send_version: send relayd version number
1552 int relay_send_version(struct lttcomm_relayd_hdr
*recv_hdr
,
1553 struct relay_connection
*conn
)
1556 struct lttcomm_relayd_version reply
, msg
;
1560 conn
->version_check_done
= 1;
1562 /* Get version from the other side. */
1563 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1564 if (ret
< 0 || ret
!= sizeof(msg
)) {
1566 /* Orderly shutdown. Not necessary to print an error. */
1567 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1569 ERR("Relay failed to receive the version values.");
1575 memset(&reply
, 0, sizeof(reply
));
1576 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
1577 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
1579 /* Major versions must be the same */
1580 if (reply
.major
!= be32toh(msg
.major
)) {
1581 DBG("Incompatible major versions (%u vs %u), deleting session",
1582 reply
.major
, be32toh(msg
.major
));
1583 destroy_session(conn
->session
, conn
->sessions_ht
);
1588 conn
->major
= reply
.major
;
1589 /* We adapt to the lowest compatible version */
1590 if (reply
.minor
<= be32toh(msg
.minor
)) {
1591 conn
->minor
= reply
.minor
;
1593 conn
->minor
= be32toh(msg
.minor
);
1596 reply
.major
= htobe32(reply
.major
);
1597 reply
.minor
= htobe32(reply
.minor
);
1598 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1599 sizeof(struct lttcomm_relayd_version
), 0);
1601 ERR("Relay sending version");
1604 DBG("Version check done using protocol %u.%u", conn
->major
,
1612 * Check for data pending for a given stream id from the session daemon.
1615 int relay_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1616 struct relay_connection
*conn
)
1618 struct relay_session
*session
= conn
->session
;
1619 struct lttcomm_relayd_data_pending msg
;
1620 struct lttcomm_relayd_generic_reply reply
;
1621 struct relay_stream
*stream
;
1623 uint64_t last_net_seq_num
, stream_id
;
1625 DBG("Data pending command received");
1627 if (!session
|| conn
->version_check_done
== 0) {
1628 ERR("Trying to check for data before version check");
1630 goto end_no_session
;
1633 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1634 if (ret
< sizeof(msg
)) {
1636 /* Orderly shutdown. Not necessary to print an error. */
1637 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1639 ERR("Relay didn't receive valid data_pending struct size : %d",
1643 goto end_no_session
;
1646 stream_id
= be64toh(msg
.stream_id
);
1647 last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
1650 stream
= stream_find_by_id(relay_streams_ht
, stream_id
);
1651 if (stream
== NULL
) {
1656 DBG("Data pending for stream id %" PRIu64
" prev_seq %" PRIu64
1657 " and last_seq %" PRIu64
, stream_id
, stream
->prev_seq
,
1660 /* Avoid wrapping issue */
1661 if (((int64_t) (stream
->prev_seq
- last_net_seq_num
)) >= 0) {
1662 /* Data has in fact been written and is NOT pending */
1665 /* Data still being streamed thus pending */
1669 /* Pending check is now done. */
1670 stream
->data_pending_check_done
= 1;
1675 memset(&reply
, 0, sizeof(reply
));
1676 reply
.ret_code
= htobe32(ret
);
1677 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1679 ERR("Relay data pending ret code failed");
1687 * Wait for the control socket to reach a quiescent state.
1689 * Note that for now, when receiving this command from the session daemon, this
1690 * means that every subsequent commands or data received on the control socket
1691 * has been handled. So, this is why we simply return OK here.
1694 int relay_quiescent_control(struct lttcomm_relayd_hdr
*recv_hdr
,
1695 struct relay_connection
*conn
)
1699 struct relay_stream
*stream
;
1700 struct lttng_ht_iter iter
;
1701 struct lttcomm_relayd_quiescent_control msg
;
1702 struct lttcomm_relayd_generic_reply reply
;
1704 DBG("Checking quiescent state on control socket");
1706 if (!conn
->session
|| conn
->version_check_done
== 0) {
1707 ERR("Trying to check for data before version check");
1709 goto end_no_session
;
1712 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1713 if (ret
< sizeof(msg
)) {
1715 /* Orderly shutdown. Not necessary to print an error. */
1716 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1718 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1722 goto end_no_session
;
1725 stream_id
= be64toh(msg
.stream_id
);
1728 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1730 if (stream
->stream_handle
== stream_id
) {
1731 stream
->data_pending_check_done
= 1;
1732 DBG("Relay quiescent control pending flag set to %" PRIu64
,
1739 memset(&reply
, 0, sizeof(reply
));
1740 reply
.ret_code
= htobe32(LTTNG_OK
);
1741 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1743 ERR("Relay data quiescent control ret code failed");
1751 * Initialize a data pending command. This means that a client is about to ask
1752 * for data pending for each stream he/she holds. Simply iterate over all
1753 * streams of a session and set the data_pending_check_done flag.
1755 * This command returns to the client a LTTNG_OK code.
1758 int relay_begin_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1759 struct relay_connection
*conn
)
1762 struct lttng_ht_iter iter
;
1763 struct lttcomm_relayd_begin_data_pending msg
;
1764 struct lttcomm_relayd_generic_reply reply
;
1765 struct relay_stream
*stream
;
1766 uint64_t session_id
;
1771 DBG("Init streams for data pending");
1773 if (!conn
->session
|| conn
->version_check_done
== 0) {
1774 ERR("Trying to check for data before version check");
1776 goto end_no_session
;
1779 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1780 if (ret
< sizeof(msg
)) {
1782 /* Orderly shutdown. Not necessary to print an error. */
1783 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1785 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1789 goto end_no_session
;
1792 session_id
= be64toh(msg
.session_id
);
1795 * Iterate over all streams to set the begin data pending flag. For now, the
1796 * streams are indexed by stream handle so we have to iterate over all
1797 * streams to find the one associated with the right session_id.
1800 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1802 if (stream
->session_id
== session_id
) {
1803 stream
->data_pending_check_done
= 0;
1804 DBG("Set begin data pending flag to stream %" PRIu64
,
1805 stream
->stream_handle
);
1810 memset(&reply
, 0, sizeof(reply
));
1811 /* All good, send back reply. */
1812 reply
.ret_code
= htobe32(LTTNG_OK
);
1814 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1816 ERR("Relay begin data pending send reply failed");
1824 * End data pending command. This will check, for a given session id, if each
1825 * stream associated with it has its data_pending_check_done flag set. If not,
1826 * this means that the client lost track of the stream but the data is still
1827 * being streamed on our side. In this case, we inform the client that data is
1830 * Return to the client if there is data in flight or not with a ret_code.
1833 int relay_end_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1834 struct relay_connection
*conn
)
1837 struct lttng_ht_iter iter
;
1838 struct lttcomm_relayd_end_data_pending msg
;
1839 struct lttcomm_relayd_generic_reply reply
;
1840 struct relay_stream
*stream
;
1841 uint64_t session_id
;
1842 uint32_t is_data_inflight
= 0;
1847 DBG("End data pending command");
1849 if (!conn
->session
|| conn
->version_check_done
== 0) {
1850 ERR("Trying to check for data before version check");
1852 goto end_no_session
;
1855 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1856 if (ret
< sizeof(msg
)) {
1858 /* Orderly shutdown. Not necessary to print an error. */
1859 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1861 ERR("Relay didn't receive valid end data_pending struct size: %d",
1865 goto end_no_session
;
1868 session_id
= be64toh(msg
.session_id
);
1870 /* Iterate over all streams to see if the begin data pending flag is set. */
1872 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1874 if (stream
->session_id
== session_id
&&
1875 !stream
->data_pending_check_done
&& !stream
->terminated_flag
) {
1876 is_data_inflight
= 1;
1877 DBG("Data is still in flight for stream %" PRIu64
,
1878 stream
->stream_handle
);
1884 memset(&reply
, 0, sizeof(reply
));
1885 /* All good, send back reply. */
1886 reply
.ret_code
= htobe32(is_data_inflight
);
1888 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1890 ERR("Relay end data pending send reply failed");
1898 * Receive an index for a specific stream.
1900 * Return 0 on success else a negative value.
1903 int relay_recv_index(struct lttcomm_relayd_hdr
*recv_hdr
,
1904 struct relay_connection
*conn
)
1906 int ret
, send_ret
, index_created
= 0;
1907 struct relay_session
*session
= conn
->session
;
1908 struct lttcomm_relayd_index index_info
;
1909 struct relay_index
*index
, *wr_index
= NULL
;
1910 struct lttcomm_relayd_generic_reply reply
;
1911 struct relay_stream
*stream
;
1912 uint64_t net_seq_num
;
1916 DBG("Relay receiving index");
1918 if (!session
|| conn
->version_check_done
== 0) {
1919 ERR("Trying to close a stream before version check");
1921 goto end_no_session
;
1924 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &index_info
,
1925 sizeof(index_info
), 0);
1926 if (ret
< sizeof(index_info
)) {
1928 /* Orderly shutdown. Not necessary to print an error. */
1929 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1931 ERR("Relay didn't receive valid index struct size : %d", ret
);
1934 goto end_no_session
;
1937 net_seq_num
= be64toh(index_info
.net_seq_num
);
1940 stream
= stream_find_by_id(relay_streams_ht
,
1941 be64toh(index_info
.relay_stream_id
));
1944 goto end_rcu_unlock
;
1947 /* Live beacon handling */
1948 if (index_info
.packet_size
== 0) {
1949 DBG("Received live beacon for stream %" PRIu64
, stream
->stream_handle
);
1952 * Only flag a stream inactive when it has already received data.
1954 if (stream
->total_index_received
> 0) {
1955 stream
->beacon_ts_end
= be64toh(index_info
.timestamp_end
);
1958 goto end_rcu_unlock
;
1960 stream
->beacon_ts_end
= -1ULL;
1963 index
= relay_index_find(stream
->stream_handle
, net_seq_num
);
1965 /* A successful creation will add the object to the HT. */
1966 index
= relay_index_create(stream
->stream_handle
, net_seq_num
);
1968 goto end_rcu_unlock
;
1973 copy_index_control_data(index
, &index_info
);
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
++;
2003 memset(&reply
, 0, sizeof(reply
));
2005 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
2007 reply
.ret_code
= htobe32(LTTNG_OK
);
2009 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2011 ERR("Relay sending close index id reply");
2020 * Receive the streams_sent message.
2022 * Return 0 on success else a negative value.
2025 int relay_streams_sent(struct lttcomm_relayd_hdr
*recv_hdr
,
2026 struct relay_connection
*conn
)
2029 struct lttcomm_relayd_generic_reply reply
;
2033 DBG("Relay receiving streams_sent");
2035 if (!conn
->session
|| conn
->version_check_done
== 0) {
2036 ERR("Trying to close a stream before version check");
2038 goto end_no_session
;
2042 * Flag every pending stream in the connection recv list that they are
2043 * ready to be used by the viewer.
2045 set_viewer_ready_flag(conn
);
2048 * Inform the viewer that there are new streams in the session.
2050 if (conn
->session
->viewer_refcount
) {
2051 uatomic_set(&conn
->session
->new_streams
, 1);
2054 memset(&reply
, 0, sizeof(reply
));
2055 reply
.ret_code
= htobe32(LTTNG_OK
);
2056 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
2058 ERR("Relay sending sent_stream reply");
2070 * Process the commands received on the control socket
2073 int relay_process_control(struct lttcomm_relayd_hdr
*recv_hdr
,
2074 struct relay_connection
*conn
)
2078 switch (be32toh(recv_hdr
->cmd
)) {
2079 case RELAYD_CREATE_SESSION
:
2080 ret
= relay_create_session(recv_hdr
, conn
);
2082 case RELAYD_ADD_STREAM
:
2083 ret
= relay_add_stream(recv_hdr
, conn
);
2085 case RELAYD_START_DATA
:
2086 ret
= relay_start(recv_hdr
, conn
);
2088 case RELAYD_SEND_METADATA
:
2089 ret
= relay_recv_metadata(recv_hdr
, conn
);
2091 case RELAYD_VERSION
:
2092 ret
= relay_send_version(recv_hdr
, conn
);
2094 case RELAYD_CLOSE_STREAM
:
2095 ret
= relay_close_stream(recv_hdr
, conn
);
2097 case RELAYD_DATA_PENDING
:
2098 ret
= relay_data_pending(recv_hdr
, conn
);
2100 case RELAYD_QUIESCENT_CONTROL
:
2101 ret
= relay_quiescent_control(recv_hdr
, conn
);
2103 case RELAYD_BEGIN_DATA_PENDING
:
2104 ret
= relay_begin_data_pending(recv_hdr
, conn
);
2106 case RELAYD_END_DATA_PENDING
:
2107 ret
= relay_end_data_pending(recv_hdr
, conn
);
2109 case RELAYD_SEND_INDEX
:
2110 ret
= relay_recv_index(recv_hdr
, conn
);
2112 case RELAYD_STREAMS_SENT
:
2113 ret
= relay_streams_sent(recv_hdr
, conn
);
2115 case RELAYD_UPDATE_SYNC_INFO
:
2117 ERR("Received unknown command (%u)", be32toh(recv_hdr
->cmd
));
2118 relay_unknown_command(conn
);
2128 * Handle index for a data stream.
2130 * RCU read side lock MUST be acquired.
2132 * Return 0 on success else a negative value.
2134 static int handle_index_data(struct relay_stream
*stream
, uint64_t net_seq_num
,
2137 int ret
= 0, index_created
= 0;
2138 uint64_t stream_id
, data_offset
;
2139 struct relay_index
*index
, *wr_index
= NULL
;
2143 stream_id
= stream
->stream_handle
;
2144 /* Get data offset because we are about to update the index. */
2145 data_offset
= htobe64(stream
->tracefile_size_current
);
2148 * Lookup for an existing index for that stream id/sequence number. If on
2149 * exists, the control thread already received the data for it thus we need
2150 * to write it on disk.
2152 index
= relay_index_find(stream_id
, net_seq_num
);
2154 /* A successful creation will add the object to the HT. */
2155 index
= relay_index_create(stream_id
, net_seq_num
);
2163 if (rotate_index
|| stream
->index_fd
< 0) {
2164 index
->to_close_fd
= stream
->index_fd
;
2165 ret
= index_create_file(stream
->path_name
, stream
->channel_name
,
2166 relayd_uid
, relayd_gid
, stream
->tracefile_size
,
2167 stream
->tracefile_count_current
);
2169 /* This will close the stream's index fd if one. */
2170 relay_index_free_safe(index
);
2173 stream
->index_fd
= ret
;
2175 index
->fd
= stream
->index_fd
;
2176 index
->index_data
.offset
= data_offset
;
2178 if (index_created
) {
2180 * Try to add the relay index object to the hash table. If an object
2181 * already exist, destroy back the index created and set the data.
2183 relay_index_add(index
, &wr_index
);
2185 /* Copy back data from the created index. */
2186 wr_index
->fd
= index
->fd
;
2187 wr_index
->to_close_fd
= index
->to_close_fd
;
2188 wr_index
->index_data
.offset
= data_offset
;
2192 /* The index already exists so write it on disk. */
2196 /* Do we have a writable ready index to write on disk. */
2198 ret
= relay_index_write(wr_index
->fd
, wr_index
);
2202 stream
->total_index_received
++;
2210 * relay_process_data: Process the data received on the data socket
2213 int relay_process_data(struct relay_connection
*conn
)
2215 int ret
= 0, rotate_index
= 0;
2217 struct relay_stream
*stream
;
2218 struct lttcomm_relayd_data_hdr data_hdr
;
2220 uint64_t net_seq_num
;
2222 struct relay_session
*session
;
2226 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &data_hdr
,
2227 sizeof(struct lttcomm_relayd_data_hdr
), 0);
2230 /* Orderly shutdown. Not necessary to print an error. */
2231 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2233 ERR("Unable to receive data header on sock %d", conn
->sock
->fd
);
2239 stream_id
= be64toh(data_hdr
.stream_id
);
2242 stream
= stream_find_by_id(relay_streams_ht
, stream_id
);
2245 goto end_rcu_unlock
;
2248 session
= session_find_by_id(conn
->sessions_ht
, stream
->session_id
);
2251 data_size
= be32toh(data_hdr
.data_size
);
2252 if (data_buffer_size
< data_size
) {
2255 tmp_data_ptr
= realloc(data_buffer
, data_size
);
2256 if (!tmp_data_ptr
) {
2257 ERR("Allocating data buffer");
2260 goto end_rcu_unlock
;
2262 data_buffer
= tmp_data_ptr
;
2263 data_buffer_size
= data_size
;
2265 memset(data_buffer
, 0, data_size
);
2267 net_seq_num
= be64toh(data_hdr
.net_seq_num
);
2269 DBG3("Receiving data of size %u for stream id %" PRIu64
" seqnum %" PRIu64
,
2270 data_size
, stream_id
, net_seq_num
);
2271 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
2274 /* Orderly shutdown. Not necessary to print an error. */
2275 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2278 goto end_rcu_unlock
;
2281 /* Check if a rotation is needed. */
2282 if (stream
->tracefile_size
> 0 &&
2283 (stream
->tracefile_size_current
+ data_size
) >
2284 stream
->tracefile_size
) {
2285 struct relay_viewer_stream
*vstream
;
2288 new_id
= (stream
->tracefile_count_current
+ 1) %
2289 stream
->tracefile_count
;
2291 * When we wrap-around back to 0, we start overwriting old
2294 if (!stream
->tracefile_overwrite
&& new_id
== 0) {
2295 stream
->tracefile_overwrite
= 1;
2297 pthread_mutex_lock(&stream
->viewer_stream_rotation_lock
);
2298 if (stream
->tracefile_overwrite
) {
2299 stream
->oldest_tracefile_id
=
2300 (stream
->oldest_tracefile_id
+ 1) %
2301 stream
->tracefile_count
;
2303 vstream
= viewer_stream_find_by_id(stream
->stream_handle
);
2306 * The viewer is reading a file about to be
2307 * overwritten. Close the FDs it is
2308 * currently using and let it handle the fault.
2310 if (vstream
->tracefile_count_current
== new_id
) {
2311 pthread_mutex_lock(&vstream
->overwrite_lock
);
2312 vstream
->abort_flag
= 1;
2313 pthread_mutex_unlock(&vstream
->overwrite_lock
);
2314 DBG("Streaming side setting abort_flag on stream %s_%lu\n",
2315 stream
->channel_name
, new_id
);
2316 } else if (vstream
->tracefile_count_current
==
2317 stream
->tracefile_count_current
) {
2319 * The reader and writer were in the
2320 * same trace file, inform the viewer
2321 * that no new index will ever be added
2324 vstream
->close_write_flag
= 1;
2327 ret
= utils_rotate_stream_file(stream
->path_name
, stream
->channel_name
,
2328 stream
->tracefile_size
, stream
->tracefile_count
,
2329 relayd_uid
, relayd_gid
, stream
->fd
,
2330 &(stream
->tracefile_count_current
), &stream
->fd
);
2331 stream
->total_index_received
= 0;
2332 pthread_mutex_unlock(&stream
->viewer_stream_rotation_lock
);
2334 ERR("Rotating stream output file");
2335 goto end_rcu_unlock
;
2337 /* Reset current size because we just perform a stream rotation. */
2338 stream
->tracefile_size_current
= 0;
2343 * Index are handled in protocol version 2.4 and above. Also, snapshot and
2344 * index are NOT supported.
2346 if (session
->minor
>= 4 && !session
->snapshot
) {
2347 ret
= handle_index_data(stream
, net_seq_num
, rotate_index
);
2349 goto end_rcu_unlock
;
2353 /* Write data to stream output fd. */
2354 size_ret
= lttng_write(stream
->fd
, data_buffer
, data_size
);
2355 if (size_ret
< data_size
) {
2356 ERR("Relay error writing data to file");
2358 goto end_rcu_unlock
;
2361 DBG2("Relay wrote %d bytes to tracefile for stream id %" PRIu64
,
2362 ret
, stream
->stream_handle
);
2364 ret
= write_padding_to_file(stream
->fd
, be32toh(data_hdr
.padding_size
));
2366 goto end_rcu_unlock
;
2368 stream
->tracefile_size_current
+= data_size
+ be32toh(data_hdr
.padding_size
);
2370 stream
->prev_seq
= net_seq_num
;
2372 try_close_stream(session
, stream
);
2381 void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
2387 (void) lttng_poll_del(events
, pollfd
);
2389 ret
= close(pollfd
);
2391 ERR("Closing pollfd %d", pollfd
);
2395 static void destroy_connection(struct lttng_ht
*relay_connections_ht
,
2396 struct relay_connection
*conn
)
2398 assert(relay_connections_ht
);
2401 connection_delete(relay_connections_ht
, conn
);
2403 /* For the control socket, we try to destroy the session. */
2404 if (conn
->type
== RELAY_CONTROL
&& conn
->session
) {
2405 destroy_session(conn
->session
, conn
->sessions_ht
);
2408 connection_destroy(conn
);
2412 * This thread does the actual work
2415 void *relay_thread_worker(void *data
)
2417 int ret
, err
= -1, last_seen_data_fd
= -1;
2419 struct relay_connection
*conn
;
2420 struct lttng_poll_event events
;
2421 struct lttng_ht
*relay_connections_ht
;
2422 struct lttng_ht_iter iter
;
2423 struct lttcomm_relayd_hdr recv_hdr
;
2424 struct relay_local_data
*relay_ctx
= (struct relay_local_data
*) data
;
2425 struct lttng_ht
*sessions_ht
= relay_ctx
->sessions_ht
;
2427 DBG("[thread] Relay worker started");
2429 rcu_register_thread();
2431 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
2433 if (testpoint(relayd_thread_worker
)) {
2434 goto error_testpoint
;
2437 health_code_update();
2439 /* table of connections indexed on socket */
2440 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2441 if (!relay_connections_ht
) {
2442 goto relay_connections_ht_error
;
2445 /* Tables of received indexes indexed by index handle and net_seq_num. */
2446 indexes_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_TWO_U64
);
2448 goto indexes_ht_error
;
2451 ret
= create_thread_poll_set(&events
, 2);
2453 goto error_poll_create
;
2456 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2463 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
2465 health_code_update();
2467 /* Infinite blocking call, waiting for transmission */
2468 DBG3("Relayd worker thread polling...");
2469 health_poll_entry();
2470 ret
= lttng_poll_wait(&events
, -1);
2474 * Restart interrupted system call.
2476 if (errno
== EINTR
) {
2485 * Process control. The control connection is prioritised so we don't
2486 * starve it with high throughout put tracing data on the data
2489 for (i
= 0; i
< nb_fd
; i
++) {
2490 /* Fetch once the poll data */
2491 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2492 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2494 health_code_update();
2496 /* Thread quit pipe has been closed. Killing thread. */
2497 ret
= check_thread_quit_pipe(pollfd
, revents
);
2503 /* Inspect the relay conn pipe for new connection */
2504 if (pollfd
== relay_conn_pipe
[0]) {
2505 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2506 ERR("Relay connection pipe error");
2508 } else if (revents
& LPOLLIN
) {
2509 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
2513 conn
->sessions_ht
= sessions_ht
;
2514 connection_init(conn
);
2515 lttng_poll_add(&events
, conn
->sock
->fd
,
2516 LPOLLIN
| LPOLLRDHUP
);
2518 lttng_ht_add_unique_ulong(relay_connections_ht
,
2521 DBG("Connection socket %d added", conn
->sock
->fd
);
2525 conn
= connection_find_by_sock(relay_connections_ht
, pollfd
);
2526 /* If not found, there is a synchronization issue. */
2529 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2530 cleanup_connection_pollfd(&events
, pollfd
);
2531 destroy_connection(relay_connections_ht
, conn
);
2532 if (last_seen_data_fd
== pollfd
) {
2533 last_seen_data_fd
= last_notdel_data_fd
;
2535 } else if (revents
& LPOLLIN
) {
2536 if (conn
->type
== RELAY_CONTROL
) {
2537 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &recv_hdr
,
2538 sizeof(recv_hdr
), 0);
2540 /* Connection closed */
2541 cleanup_connection_pollfd(&events
, pollfd
);
2542 destroy_connection(relay_connections_ht
, conn
);
2543 DBG("Control connection closed with %d", pollfd
);
2545 ret
= relay_process_control(&recv_hdr
, conn
);
2547 /* Clear the session on error. */
2548 cleanup_connection_pollfd(&events
, pollfd
);
2549 destroy_connection(relay_connections_ht
, conn
);
2550 DBG("Connection closed with %d", pollfd
);
2556 * Flag the last seen data fd not deleted. It will be
2557 * used as the last seen fd if any fd gets deleted in
2560 last_notdel_data_fd
= pollfd
;
2563 ERR("Unknown poll events %u for sock %d", revents
, pollfd
);
2570 * The last loop handled a control request, go back to poll to make
2571 * sure we prioritise the control socket.
2577 if (last_seen_data_fd
>= 0) {
2578 for (i
= 0; i
< nb_fd
; i
++) {
2579 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2581 health_code_update();
2583 if (last_seen_data_fd
== pollfd
) {
2590 /* Process data connection. */
2591 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
2592 /* Fetch the poll data. */
2593 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2594 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2596 health_code_update();
2598 /* Skip the command pipe. It's handled in the first loop. */
2599 if (pollfd
== relay_conn_pipe
[0]) {
2605 conn
= connection_find_by_sock(relay_connections_ht
, pollfd
);
2607 /* Skip it. Might be removed before. */
2612 if (revents
& LPOLLIN
) {
2613 if (conn
->type
!= RELAY_DATA
) {
2617 ret
= relay_process_data(conn
);
2618 /* Connection closed */
2620 cleanup_connection_pollfd(&events
, pollfd
);
2621 destroy_connection(relay_connections_ht
, conn
);
2622 DBG("Data connection closed with %d", pollfd
);
2624 * Every goto restart call sets the last seen fd where
2625 * here we don't really care since we gracefully
2626 * continue the loop after the connection is deleted.
2629 /* Keep last seen port. */
2630 last_seen_data_fd
= pollfd
;
2638 last_seen_data_fd
= -1;
2641 /* Normal exit, no error */
2646 lttng_poll_clean(&events
);
2648 /* Cleanup reamaining connection object. */
2650 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
, conn
,
2652 health_code_update();
2653 destroy_connection(relay_connections_ht
, conn
);
2657 lttng_ht_destroy(indexes_ht
);
2659 lttng_ht_destroy(relay_connections_ht
);
2660 relay_connections_ht_error
:
2661 /* Close relay conn pipes */
2662 utils_close_pipe(relay_conn_pipe
);
2664 DBG("Thread exited with error");
2666 DBG("Worker thread cleanup complete");
2671 ERR("Health error occurred in %s", __func__
);
2673 health_unregister(health_relayd
);
2674 rcu_unregister_thread();
2680 * Create the relay command pipe to wake thread_manage_apps.
2681 * Closed in cleanup().
2683 static int create_relay_conn_pipe(void)
2687 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
2695 int main(int argc
, char **argv
)
2699 struct relay_local_data
*relay_ctx
;
2701 /* Parse arguments */
2703 if ((ret
= set_options(argc
, argv
)) < 0) {
2707 if ((ret
= set_signal_handler()) < 0) {
2711 /* Try to create directory if -o, --output is specified. */
2712 if (opt_output_path
) {
2713 if (*opt_output_path
!= '/') {
2714 ERR("Please specify an absolute path for -o, --output PATH");
2718 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
);
2720 ERR("Unable to create %s", opt_output_path
);
2726 if (opt_daemon
|| opt_background
) {
2729 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
2736 * We are in the child. Make sure all other file
2737 * descriptors are closed, in case we are called with
2738 * more opened file descriptors than the standard ones.
2740 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
2745 /* Create thread quit pipe */
2746 if ((ret
= init_thread_quit_pipe()) < 0) {
2750 /* We need those values for the file/dir creation. */
2751 relayd_uid
= getuid();
2752 relayd_gid
= getgid();
2754 /* Check if daemon is UID = 0 */
2755 if (relayd_uid
== 0) {
2756 if (control_uri
->port
< 1024 || data_uri
->port
< 1024 || live_uri
->port
< 1024) {
2757 ERR("Need to be root to use ports < 1024");
2763 /* Setup the thread apps communication pipe. */
2764 if ((ret
= create_relay_conn_pipe()) < 0) {
2768 /* Init relay command queue. */
2769 cds_wfq_init(&relay_conn_queue
.queue
);
2771 /* Set up max poll set size */
2772 lttng_poll_set_max_size();
2774 /* Initialize communication library */
2776 lttcomm_inet_init();
2778 relay_ctx
= zmalloc(sizeof(struct relay_local_data
));
2780 PERROR("relay_ctx");
2784 /* tables of sessions indexed by session ID */
2785 relay_ctx
->sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2786 if (!relay_ctx
->sessions_ht
) {
2787 goto exit_relay_ctx_sessions
;
2790 /* tables of streams indexed by stream ID */
2791 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2792 if (!relay_streams_ht
) {
2793 goto exit_relay_ctx_streams
;
2796 /* tables of streams indexed by stream ID */
2797 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2798 if (!viewer_streams_ht
) {
2799 goto exit_relay_ctx_viewer_streams
;
2802 /* Initialize thread health monitoring */
2803 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
2804 if (!health_relayd
) {
2805 PERROR("health_app_create error");
2806 goto exit_health_app_create
;
2809 ret
= utils_create_pipe(health_quit_pipe
);
2811 goto error_health_pipe
;
2814 /* Create thread to manage the client socket */
2815 ret
= pthread_create(&health_thread
, NULL
,
2816 thread_manage_health
, (void *) NULL
);
2818 PERROR("pthread_create health");
2822 /* Setup the dispatcher thread */
2823 ret
= pthread_create(&dispatcher_thread
, NULL
,
2824 relay_thread_dispatcher
, (void *) NULL
);
2826 PERROR("pthread_create dispatcher");
2827 goto exit_dispatcher
;
2830 /* Setup the worker thread */
2831 ret
= pthread_create(&worker_thread
, NULL
,
2832 relay_thread_worker
, (void *) relay_ctx
);
2834 PERROR("pthread_create worker");
2838 /* Setup the listener thread */
2839 ret
= pthread_create(&listener_thread
, NULL
,
2840 relay_thread_listener
, (void *) NULL
);
2842 PERROR("pthread_create listener");
2846 ret
= live_start_threads(live_uri
, relay_ctx
);
2848 ERR("Starting live viewer threads");
2853 ret
= pthread_join(listener_thread
, &status
);
2855 PERROR("pthread_join");
2856 goto error
; /* join error, exit without cleanup */
2860 ret
= pthread_join(worker_thread
, &status
);
2862 PERROR("pthread_join");
2863 goto error
; /* join error, exit without cleanup */
2867 ret
= pthread_join(dispatcher_thread
, &status
);
2869 PERROR("pthread_join");
2870 goto error
; /* join error, exit without cleanup */
2874 ret
= pthread_join(health_thread
, &status
);
2876 PERROR("pthread_join health thread");
2877 goto error
; /* join error, exit without cleanup */
2881 * Stop live threads only after joining other threads.
2883 live_stop_threads();
2886 utils_close_pipe(health_quit_pipe
);
2889 health_app_destroy(health_relayd
);
2891 exit_health_app_create
:
2892 lttng_ht_destroy(viewer_streams_ht
);
2894 exit_relay_ctx_viewer_streams
:
2895 lttng_ht_destroy(relay_streams_ht
);
2897 exit_relay_ctx_streams
:
2898 lttng_ht_destroy(relay_ctx
->sessions_ht
);
2900 exit_relay_ctx_sessions
: