2 * Copyright (C) 2012 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
4 * 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License, version 2 only,
9 * as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
32 #include <sys/mount.h>
33 #include <sys/resource.h>
34 #include <sys/socket.h>
36 #include <sys/types.h>
39 #include <urcu/futex.h>
40 #include <urcu/uatomic.h>
45 #include <lttng/lttng.h>
46 #include <common/common.h>
47 #include <common/compat/poll.h>
48 #include <common/compat/socket.h>
49 #include <common/compat/endian.h>
50 #include <common/compat/getenv.h>
51 #include <common/defaults.h>
52 #include <common/daemonize.h>
53 #include <common/futex.h>
54 #include <common/sessiond-comm/sessiond-comm.h>
55 #include <common/sessiond-comm/inet.h>
56 #include <common/sessiond-comm/relayd.h>
57 #include <common/uri.h>
58 #include <common/utils.h>
59 #include <common/config/config.h>
60 #include <urcu/rculist.h>
63 #include "ctf-trace.h"
66 #include "lttng-relayd.h"
68 #include "health-relayd.h"
69 #include "testpoint.h"
70 #include "viewer-stream.h"
73 #include "connection.h"
74 #include "tracefile-array.h"
76 /* command line options */
77 char *opt_output_path
;
78 static int opt_daemon
, opt_background
;
81 * We need to wait for listener and live listener threads, as well as
82 * health check thread, before being ready to signal readiness.
84 #define NR_LTTNG_RELAY_READY 3
85 static int lttng_relay_ready
= NR_LTTNG_RELAY_READY
;
86 static int recv_child_signal
; /* Set to 1 when a SIGUSR1 signal is received. */
87 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
89 static struct lttng_uri
*control_uri
;
90 static struct lttng_uri
*data_uri
;
91 static struct lttng_uri
*live_uri
;
95 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
96 static int tracing_group_name_override
;
98 const char * const config_section_name
= "relayd";
101 * Quit pipe for all threads. This permits a single cancellation point
102 * for all threads when receiving an event on the pipe.
104 int thread_quit_pipe
[2] = { -1, -1 };
107 * This pipe is used to inform the worker thread that a command is queued and
108 * ready to be processed.
110 static int relay_conn_pipe
[2] = { -1, -1 };
112 /* Shared between threads */
113 static int dispatch_thread_exit
;
115 static pthread_t listener_thread
;
116 static pthread_t dispatcher_thread
;
117 static pthread_t worker_thread
;
118 static pthread_t health_thread
;
121 * last_relay_stream_id_lock protects last_relay_stream_id increment
122 * atomicity on 32-bit architectures.
124 static pthread_mutex_t last_relay_stream_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
125 static uint64_t last_relay_stream_id
;
128 * Relay command queue.
130 * The relay_thread_listener and relay_thread_dispatcher communicate with this
133 static struct relay_conn_queue relay_conn_queue
;
135 /* buffer allocated at startup, used to store the trace data */
136 static char *data_buffer
;
137 static unsigned int data_buffer_size
;
139 /* Global relay stream hash table. */
140 struct lttng_ht
*relay_streams_ht
;
142 /* Global relay viewer stream hash table. */
143 struct lttng_ht
*viewer_streams_ht
;
145 /* Global relay sessions hash table. */
146 struct lttng_ht
*sessions_ht
;
148 /* Relayd health monitoring */
149 struct health_app
*health_relayd
;
151 static struct option long_options
[] = {
152 { "control-port", 1, 0, 'C', },
153 { "data-port", 1, 0, 'D', },
154 { "live-port", 1, 0, 'L', },
155 { "daemonize", 0, 0, 'd', },
156 { "background", 0, 0, 'b', },
157 { "group", 1, 0, 'g', },
158 { "help", 0, 0, 'h', },
159 { "output", 1, 0, 'o', },
160 { "verbose", 0, 0, 'v', },
161 { "config", 1, 0, 'f' },
165 static const char *config_ignore_options
[] = { "help", "config" };
168 * usage function on stderr
170 static void usage(void)
172 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
173 fprintf(stderr
, " -h, --help Display this usage.\n");
174 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
175 fprintf(stderr
, " -b, --background Start as a daemon, keeping console open.\n");
176 fprintf(stderr
, " -C, --control-port URL Control port listening.\n");
177 fprintf(stderr
, " -D, --data-port URL Data port listening.\n");
178 fprintf(stderr
, " -L, --live-port URL Live view port listening.\n");
179 fprintf(stderr
, " -o, --output PATH Output path for traces. Must use an absolute path.\n");
180 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
181 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
182 fprintf(stderr
, " -f --config Load daemon configuration file\n");
186 * Take an option from the getopt output and set it in the right variable to be
189 * Return 0 on success else a negative value.
191 static int set_option(int opt
, const char *arg
, const char *optname
)
197 fprintf(stderr
, "option %s", optname
);
199 fprintf(stderr
, " with arg %s\n", arg
);
203 if (lttng_is_setuid_setgid()) {
204 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
205 "-C, --control-port");
207 ret
= uri_parse(arg
, &control_uri
);
209 ERR("Invalid control URI specified");
212 if (control_uri
->port
== 0) {
213 control_uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
218 if (lttng_is_setuid_setgid()) {
219 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
222 ret
= uri_parse(arg
, &data_uri
);
224 ERR("Invalid data URI specified");
227 if (data_uri
->port
== 0) {
228 data_uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
233 if (lttng_is_setuid_setgid()) {
234 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
237 ret
= uri_parse(arg
, &live_uri
);
239 ERR("Invalid live URI specified");
242 if (live_uri
->port
== 0) {
243 live_uri
->port
= DEFAULT_NETWORK_VIEWER_PORT
;
254 if (lttng_is_setuid_setgid()) {
255 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
258 tracing_group_name
= strdup(arg
);
259 if (tracing_group_name
== NULL
) {
264 tracing_group_name_override
= 1;
271 if (lttng_is_setuid_setgid()) {
272 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
275 ret
= asprintf(&opt_output_path
, "%s", arg
);
278 PERROR("asprintf opt_output_path");
284 /* Verbose level can increase using multiple -v */
286 lttng_opt_verbose
= config_parse_value(arg
);
288 /* Only 3 level of verbosity (-vvv). */
289 if (lttng_opt_verbose
< 3) {
290 lttng_opt_verbose
+= 1;
295 /* Unknown option or other error.
296 * Error is printed by getopt, just return */
309 * config_entry_handler_cb used to handle options read from a config file.
310 * See config_entry_handler_cb comment in common/config/config.h for the
311 * return value conventions.
313 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
317 if (!entry
|| !entry
->name
|| !entry
->value
) {
322 /* Check if the option is to be ignored */
323 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
324 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
329 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1; i
++) {
330 /* Ignore if entry name is not fully matched. */
331 if (strcmp(entry
->name
, long_options
[i
].name
)) {
336 * If the option takes no argument on the command line,
337 * we have to check if the value is "true". We support
338 * non-zero numeric values, true, on and yes.
340 if (!long_options
[i
].has_arg
) {
341 ret
= config_parse_value(entry
->value
);
344 WARN("Invalid configuration value \"%s\" for option %s",
345 entry
->value
, entry
->name
);
347 /* False, skip boolean config option. */
352 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
356 WARN("Unrecognized option \"%s\" in daemon configuration file.",
363 static int set_options(int argc
, char **argv
)
365 int c
, ret
= 0, option_index
= 0, retval
= 0;
366 int orig_optopt
= optopt
, orig_optind
= optind
;
367 char *default_address
, *optstring
;
368 const char *config_path
= NULL
;
370 optstring
= utils_generate_optstring(long_options
,
371 sizeof(long_options
) / sizeof(struct option
));
377 /* Check for the --config option */
379 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
380 &option_index
)) != -1) {
384 } else if (c
!= 'f') {
388 if (lttng_is_setuid_setgid()) {
389 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
392 config_path
= utils_expand_path(optarg
);
394 ERR("Failed to resolve path: %s", optarg
);
399 ret
= config_get_section_entries(config_path
, config_section_name
,
400 config_entry_handler
, NULL
);
403 ERR("Invalid configuration option at line %i", ret
);
409 /* Reset getopt's global state */
410 optopt
= orig_optopt
;
411 optind
= orig_optind
;
413 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
418 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
425 /* assign default values */
426 if (control_uri
== NULL
) {
427 ret
= asprintf(&default_address
,
428 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
":%d",
429 DEFAULT_NETWORK_CONTROL_PORT
);
431 PERROR("asprintf default data address");
436 ret
= uri_parse(default_address
, &control_uri
);
437 free(default_address
);
439 ERR("Invalid control URI specified");
444 if (data_uri
== NULL
) {
445 ret
= asprintf(&default_address
,
446 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS
":%d",
447 DEFAULT_NETWORK_DATA_PORT
);
449 PERROR("asprintf default data address");
454 ret
= uri_parse(default_address
, &data_uri
);
455 free(default_address
);
457 ERR("Invalid data URI specified");
462 if (live_uri
== NULL
) {
463 ret
= asprintf(&default_address
,
464 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
":%d",
465 DEFAULT_NETWORK_VIEWER_PORT
);
467 PERROR("asprintf default viewer control address");
472 ret
= uri_parse(default_address
, &live_uri
);
473 free(default_address
);
475 ERR("Invalid viewer control URI specified");
486 static void print_global_objects(void)
488 rcu_register_thread();
490 print_viewer_streams();
491 print_relay_streams();
494 rcu_unregister_thread();
500 static void relayd_cleanup(void)
502 print_global_objects();
506 if (viewer_streams_ht
)
507 lttng_ht_destroy(viewer_streams_ht
);
508 if (relay_streams_ht
)
509 lttng_ht_destroy(relay_streams_ht
);
511 lttng_ht_destroy(sessions_ht
);
513 /* free the dynamically allocated opt_output_path */
514 free(opt_output_path
);
516 /* Close thread quit pipes */
517 utils_close_pipe(thread_quit_pipe
);
519 uri_free(control_uri
);
521 /* Live URI is freed in the live thread. */
523 if (tracing_group_name_override
) {
524 free((void *) tracing_group_name
);
529 * Write to writable pipe used to notify a thread.
531 static int notify_thread_pipe(int wpipe
)
535 ret
= lttng_write(wpipe
, "!", 1);
537 PERROR("write poll pipe");
545 static int notify_health_quit_pipe(int *pipe
)
549 ret
= lttng_write(pipe
[1], "4", 1);
551 PERROR("write relay health quit");
560 * Stop all relayd and relayd-live threads.
562 int lttng_relay_stop_threads(void)
566 /* Stopping all threads */
567 DBG("Terminating all threads");
568 if (notify_thread_pipe(thread_quit_pipe
[1])) {
569 ERR("write error on thread quit pipe");
573 if (notify_health_quit_pipe(health_quit_pipe
)) {
574 ERR("write error on health quit pipe");
577 /* Dispatch thread */
578 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
579 futex_nto1_wake(&relay_conn_queue
.futex
);
581 if (relayd_live_stop()) {
582 ERR("Error stopping live threads");
589 * Signal handler for the daemon
591 * Simply stop all worker threads, leaving main() return gracefully after
592 * joining all threads and calling cleanup().
594 static void sighandler(int sig
)
598 DBG("SIGPIPE caught");
601 DBG("SIGINT caught");
602 if (lttng_relay_stop_threads()) {
603 ERR("Error stopping threads");
607 DBG("SIGTERM caught");
608 if (lttng_relay_stop_threads()) {
609 ERR("Error stopping threads");
613 CMM_STORE_SHARED(recv_child_signal
, 1);
621 * Setup signal handler for :
622 * SIGINT, SIGTERM, SIGPIPE
624 static int set_signal_handler(void)
630 if ((ret
= sigemptyset(&sigset
)) < 0) {
631 PERROR("sigemptyset");
635 sa
.sa_handler
= sighandler
;
638 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
643 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
648 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
653 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
658 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
663 void lttng_relay_notify_ready(void)
665 /* Notify the parent of the fork() process that we are ready. */
666 if (opt_daemon
|| opt_background
) {
667 if (uatomic_sub_return(<tng_relay_ready
, 1) == 0) {
668 kill(child_ppid
, SIGUSR1
);
674 * Init thread quit pipe.
676 * Return -1 on error or 0 if all pipes are created.
678 static int init_thread_quit_pipe(void)
682 ret
= utils_create_pipe_cloexec(thread_quit_pipe
);
688 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
690 static int create_thread_poll_set(struct lttng_poll_event
*events
, int size
)
694 if (events
== NULL
|| size
== 0) {
699 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
705 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
717 * Check if the thread quit pipe was triggered.
719 * Return 1 if it was triggered else 0;
721 static int check_thread_quit_pipe(int fd
, uint32_t events
)
723 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
731 * Create and init socket from uri.
733 static struct lttcomm_sock
*relay_socket_create(struct lttng_uri
*uri
)
736 struct lttcomm_sock
*sock
= NULL
;
738 sock
= lttcomm_alloc_sock_from_uri(uri
);
740 ERR("Allocating socket");
744 ret
= lttcomm_create_sock(sock
);
748 DBG("Listening on sock %d", sock
->fd
);
750 ret
= sock
->ops
->bind(sock
);
755 ret
= sock
->ops
->listen(sock
, -1);
765 lttcomm_destroy_sock(sock
);
771 * This thread manages the listening for new connections on the network
773 static void *relay_thread_listener(void *data
)
775 int i
, ret
, pollfd
, err
= -1;
776 uint32_t revents
, nb_fd
;
777 struct lttng_poll_event events
;
778 struct lttcomm_sock
*control_sock
, *data_sock
;
780 DBG("[thread] Relay listener started");
782 health_register(health_relayd
, HEALTH_RELAYD_TYPE_LISTENER
);
784 health_code_update();
786 control_sock
= relay_socket_create(control_uri
);
788 goto error_sock_control
;
791 data_sock
= relay_socket_create(data_uri
);
793 goto error_sock_relay
;
797 * Pass 3 as size here for the thread quit pipe, control and
800 ret
= create_thread_poll_set(&events
, 3);
802 goto error_create_poll
;
805 /* Add the control socket */
806 ret
= lttng_poll_add(&events
, control_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
811 /* Add the data socket */
812 ret
= lttng_poll_add(&events
, data_sock
->fd
, LPOLLIN
| LPOLLRDHUP
);
817 lttng_relay_notify_ready();
819 if (testpoint(relayd_thread_listener
)) {
820 goto error_testpoint
;
824 health_code_update();
826 DBG("Listener accepting connections");
830 ret
= lttng_poll_wait(&events
, -1);
834 * Restart interrupted system call.
836 if (errno
== EINTR
) {
844 DBG("Relay new connection received");
845 for (i
= 0; i
< nb_fd
; i
++) {
846 health_code_update();
848 /* Fetch once the poll data */
849 revents
= LTTNG_POLL_GETEV(&events
, i
);
850 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
854 * No activity for this FD (poll
860 /* Thread quit pipe has been closed. Killing thread. */
861 ret
= check_thread_quit_pipe(pollfd
, revents
);
867 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
868 ERR("socket poll error");
870 } else if (revents
& LPOLLIN
) {
872 * A new connection is requested, therefore a
873 * sessiond/consumerd connection is allocated in
874 * this thread, enqueued to a global queue and
875 * dequeued (and freed) in the worker thread.
878 struct relay_connection
*new_conn
;
879 struct lttcomm_sock
*newsock
;
880 enum connection_type type
;
882 if (pollfd
== data_sock
->fd
) {
884 newsock
= data_sock
->ops
->accept(data_sock
);
885 DBG("Relay data connection accepted, socket %d",
888 assert(pollfd
== control_sock
->fd
);
889 type
= RELAY_CONTROL
;
890 newsock
= control_sock
->ops
->accept(control_sock
);
891 DBG("Relay control connection accepted, socket %d",
895 PERROR("accepting sock");
899 ret
= setsockopt(newsock
->fd
, SOL_SOCKET
, SO_REUSEADDR
, &val
,
902 PERROR("setsockopt inet");
903 lttcomm_destroy_sock(newsock
);
906 new_conn
= connection_create(newsock
, type
);
908 lttcomm_destroy_sock(newsock
);
912 /* Enqueue request for the dispatcher thread. */
913 cds_wfcq_enqueue(&relay_conn_queue
.head
, &relay_conn_queue
.tail
,
917 * Wake the dispatch queue futex.
918 * Implicit memory barrier with the
919 * exchange in cds_wfcq_enqueue.
921 futex_nto1_wake(&relay_conn_queue
.futex
);
930 lttng_poll_clean(&events
);
932 if (data_sock
->fd
>= 0) {
933 ret
= data_sock
->ops
->close(data_sock
);
938 lttcomm_destroy_sock(data_sock
);
940 if (control_sock
->fd
>= 0) {
941 ret
= control_sock
->ops
->close(control_sock
);
946 lttcomm_destroy_sock(control_sock
);
950 ERR("Health error occurred in %s", __func__
);
952 health_unregister(health_relayd
);
953 DBG("Relay listener thread cleanup complete");
954 lttng_relay_stop_threads();
959 * This thread manages the dispatching of the requests to worker threads
961 static void *relay_thread_dispatcher(void *data
)
965 struct cds_wfcq_node
*node
;
966 struct relay_connection
*new_conn
= NULL
;
968 DBG("[thread] Relay dispatcher started");
970 health_register(health_relayd
, HEALTH_RELAYD_TYPE_DISPATCHER
);
972 if (testpoint(relayd_thread_dispatcher
)) {
973 goto error_testpoint
;
976 health_code_update();
978 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
979 health_code_update();
981 /* Atomically prepare the queue futex */
982 futex_nto1_prepare(&relay_conn_queue
.futex
);
985 health_code_update();
987 /* Dequeue commands */
988 node
= cds_wfcq_dequeue_blocking(&relay_conn_queue
.head
,
989 &relay_conn_queue
.tail
);
991 DBG("Woken up but nothing in the relay command queue");
992 /* Continue thread execution */
995 new_conn
= caa_container_of(node
, struct relay_connection
, qnode
);
997 DBG("Dispatching request waiting on sock %d", new_conn
->sock
->fd
);
1000 * Inform worker thread of the new request. This
1001 * call is blocking so we can be assured that
1002 * the data will be read at some point in time
1003 * or wait to the end of the world :)
1005 ret
= lttng_write(relay_conn_pipe
[1], &new_conn
, sizeof(new_conn
));
1007 PERROR("write connection pipe");
1008 connection_put(new_conn
);
1011 } while (node
!= NULL
);
1013 /* Futex wait on queue. Blocking call on futex() */
1014 health_poll_entry();
1015 futex_nto1_wait(&relay_conn_queue
.futex
);
1019 /* Normal exit, no error */
1026 ERR("Health error occurred in %s", __func__
);
1028 health_unregister(health_relayd
);
1029 DBG("Dispatch thread dying");
1030 lttng_relay_stop_threads();
1035 * Set index data from the control port to a given index object.
1037 static int set_index_control_data(struct relay_index
*index
,
1038 struct lttcomm_relayd_index
*data
)
1040 struct ctf_packet_index index_data
;
1043 * The index on disk is encoded in big endian, so we don't need
1044 * to convert the data received on the network. The data_offset
1045 * value is NEVER modified here and is updated by the data
1048 index_data
.packet_size
= data
->packet_size
;
1049 index_data
.content_size
= data
->content_size
;
1050 index_data
.timestamp_begin
= data
->timestamp_begin
;
1051 index_data
.timestamp_end
= data
->timestamp_end
;
1052 index_data
.events_discarded
= data
->events_discarded
;
1053 index_data
.stream_id
= data
->stream_id
;
1054 return relay_index_set_data(index
, &index_data
);
1058 * Handle the RELAYD_CREATE_SESSION command.
1060 * On success, send back the session id or else return a negative value.
1062 static int relay_create_session(struct lttcomm_relayd_hdr
*recv_hdr
,
1063 struct relay_connection
*conn
)
1065 int ret
= 0, send_ret
;
1066 struct relay_session
*session
;
1067 struct lttcomm_relayd_status_session reply
;
1068 char session_name
[NAME_MAX
];
1069 char hostname
[HOST_NAME_MAX
];
1070 uint32_t live_timer
= 0;
1071 bool snapshot
= false;
1073 memset(session_name
, 0, NAME_MAX
);
1074 memset(hostname
, 0, HOST_NAME_MAX
);
1076 memset(&reply
, 0, sizeof(reply
));
1078 switch (conn
->minor
) {
1083 case 4: /* LTTng sessiond 2.4 */
1085 ret
= cmd_create_session_2_4(conn
, session_name
,
1086 hostname
, &live_timer
, &snapshot
);
1092 session
= session_create(session_name
, hostname
, live_timer
,
1093 snapshot
, conn
->major
, conn
->minor
);
1098 assert(!conn
->session
);
1099 conn
->session
= session
;
1100 DBG("Created session %" PRIu64
, session
->id
);
1102 reply
.session_id
= htobe64(session
->id
);
1106 reply
.ret_code
= htobe32(LTTNG_ERR_FATAL
);
1108 reply
.ret_code
= htobe32(LTTNG_OK
);
1111 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1113 ERR("Relayd sending session id");
1121 * When we have received all the streams and the metadata for a channel,
1122 * we make them visible to the viewer threads.
1124 static void publish_connection_local_streams(struct relay_connection
*conn
)
1126 struct relay_stream
*stream
;
1127 struct relay_session
*session
= conn
->session
;
1130 * We publish all streams belonging to a session atomically wrt
1133 pthread_mutex_lock(&session
->lock
);
1135 cds_list_for_each_entry_rcu(stream
, &session
->recv_list
,
1137 stream_publish(stream
);
1142 * Inform the viewer that there are new streams in the session.
1144 if (session
->viewer_attached
) {
1145 uatomic_set(&session
->new_streams
, 1);
1147 pthread_mutex_unlock(&session
->lock
);
1151 * relay_add_stream: allocate a new stream for a session
1153 static int relay_add_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1154 struct relay_connection
*conn
)
1158 struct relay_session
*session
= conn
->session
;
1159 struct relay_stream
*stream
= NULL
;
1160 struct lttcomm_relayd_status_stream reply
;
1161 struct ctf_trace
*trace
= NULL
;
1162 uint64_t stream_handle
= -1ULL;
1163 char *path_name
= NULL
, *channel_name
= NULL
;
1164 uint64_t tracefile_size
= 0, tracefile_count
= 0;
1166 if (!session
|| conn
->version_check_done
== 0) {
1167 ERR("Trying to add a stream before version check");
1169 goto end_no_session
;
1172 switch (session
->minor
) {
1173 case 1: /* LTTng sessiond 2.1. Allocates path_name and channel_name. */
1174 ret
= cmd_recv_stream_2_1(conn
, &path_name
,
1177 case 2: /* LTTng sessiond 2.2. Allocates path_name and channel_name. */
1179 ret
= cmd_recv_stream_2_2(conn
, &path_name
,
1180 &channel_name
, &tracefile_size
, &tracefile_count
);
1187 trace
= ctf_trace_get_by_path_or_create(session
, path_name
);
1191 /* This stream here has one reference on the trace. */
1193 pthread_mutex_lock(&last_relay_stream_id_lock
);
1194 stream_handle
= ++last_relay_stream_id
;
1195 pthread_mutex_unlock(&last_relay_stream_id_lock
);
1197 /* We pass ownership of path_name and channel_name. */
1198 stream
= stream_create(trace
, stream_handle
, path_name
,
1199 channel_name
, tracefile_size
, tracefile_count
);
1201 channel_name
= NULL
;
1204 * Streams are the owners of their trace. Reference to trace is
1205 * kept within stream_create().
1207 ctf_trace_put(trace
);
1210 memset(&reply
, 0, sizeof(reply
));
1211 reply
.handle
= htobe64(stream_handle
);
1213 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1215 reply
.ret_code
= htobe32(LTTNG_OK
);
1218 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1219 sizeof(struct lttcomm_relayd_status_stream
), 0);
1221 ERR("Relay sending stream id");
1222 ret
= (int) send_ret
;
1232 * relay_close_stream: close a specific stream
1234 static int relay_close_stream(struct lttcomm_relayd_hdr
*recv_hdr
,
1235 struct relay_connection
*conn
)
1238 struct relay_session
*session
= conn
->session
;
1239 struct lttcomm_relayd_close_stream stream_info
;
1240 struct lttcomm_relayd_generic_reply reply
;
1241 struct relay_stream
*stream
;
1243 DBG("Close stream received");
1245 if (!session
|| conn
->version_check_done
== 0) {
1246 ERR("Trying to close a stream before version check");
1248 goto end_no_session
;
1251 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &stream_info
,
1252 sizeof(struct lttcomm_relayd_close_stream
), 0);
1253 if (ret
< sizeof(struct lttcomm_relayd_close_stream
)) {
1255 /* Orderly shutdown. Not necessary to print an error. */
1256 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1258 ERR("Relay didn't receive valid add_stream struct size : %d", ret
);
1261 goto end_no_session
;
1264 stream
= stream_get_by_id(be64toh(stream_info
.stream_id
));
1271 * Set last_net_seq_num before the close flag. Required by data
1274 pthread_mutex_lock(&stream
->lock
);
1275 stream
->last_net_seq_num
= be64toh(stream_info
.last_net_seq_num
);
1276 pthread_mutex_unlock(&stream
->lock
);
1278 stream_close(stream
);
1280 if (stream
->is_metadata
) {
1281 struct relay_viewer_stream
*vstream
;
1283 vstream
= viewer_stream_get_by_id(stream
->stream_handle
);
1285 if (vstream
->metadata_sent
== stream
->metadata_received
) {
1287 * Since all the metadata has been sent to the
1288 * viewer and that we have a request to close
1289 * its stream, we can safely teardown the
1290 * corresponding metadata viewer stream.
1292 viewer_stream_put(vstream
);
1294 /* Put local reference. */
1295 viewer_stream_put(vstream
);
1301 memset(&reply
, 0, sizeof(reply
));
1303 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1305 reply
.ret_code
= htobe32(LTTNG_OK
);
1307 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1308 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1310 ERR("Relay sending stream id");
1319 * relay_unknown_command: send -1 if received unknown command
1321 static void relay_unknown_command(struct relay_connection
*conn
)
1323 struct lttcomm_relayd_generic_reply reply
;
1326 memset(&reply
, 0, sizeof(reply
));
1327 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1328 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1329 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1331 ERR("Relay sending unknown command");
1336 * relay_start: send an acknowledgment to the client to tell if we are
1337 * ready to receive data. We are ready if a session is established.
1339 static int relay_start(struct lttcomm_relayd_hdr
*recv_hdr
,
1340 struct relay_connection
*conn
)
1342 int ret
= htobe32(LTTNG_OK
);
1343 struct lttcomm_relayd_generic_reply reply
;
1344 struct relay_session
*session
= conn
->session
;
1347 DBG("Trying to start the streaming without a session established");
1348 ret
= htobe32(LTTNG_ERR_UNK
);
1351 memset(&reply
, 0, sizeof(reply
));
1352 reply
.ret_code
= ret
;
1353 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1354 sizeof(struct lttcomm_relayd_generic_reply
), 0);
1356 ERR("Relay sending start ack");
1363 * Append padding to the file pointed by the file descriptor fd.
1365 static int write_padding_to_file(int fd
, uint32_t size
)
1374 zeros
= zmalloc(size
);
1375 if (zeros
== NULL
) {
1376 PERROR("zmalloc zeros for padding");
1381 ret
= lttng_write(fd
, zeros
, size
);
1383 PERROR("write padding to file");
1393 * relay_recv_metadata: receive the metadata for the session.
1395 static int relay_recv_metadata(struct lttcomm_relayd_hdr
*recv_hdr
,
1396 struct relay_connection
*conn
)
1398 int ret
= htobe32(LTTNG_OK
);
1400 struct relay_session
*session
= conn
->session
;
1401 struct lttcomm_relayd_metadata_payload
*metadata_struct
;
1402 struct relay_stream
*metadata_stream
;
1403 uint64_t data_size
, payload_size
;
1406 ERR("Metadata sent before version check");
1411 data_size
= payload_size
= be64toh(recv_hdr
->data_size
);
1412 if (data_size
< sizeof(struct lttcomm_relayd_metadata_payload
)) {
1413 ERR("Incorrect data size");
1417 payload_size
-= sizeof(struct lttcomm_relayd_metadata_payload
);
1419 if (data_buffer_size
< data_size
) {
1420 /* In case the realloc fails, we can free the memory */
1423 tmp_data_ptr
= realloc(data_buffer
, data_size
);
1424 if (!tmp_data_ptr
) {
1425 ERR("Allocating data buffer");
1430 data_buffer
= tmp_data_ptr
;
1431 data_buffer_size
= data_size
;
1433 memset(data_buffer
, 0, data_size
);
1434 DBG2("Relay receiving metadata, waiting for %" PRIu64
" bytes", data_size
);
1435 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
1436 if (ret
< 0 || ret
!= data_size
) {
1438 /* Orderly shutdown. Not necessary to print an error. */
1439 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1441 ERR("Relay didn't receive the whole metadata");
1446 metadata_struct
= (struct lttcomm_relayd_metadata_payload
*) data_buffer
;
1448 metadata_stream
= stream_get_by_id(be64toh(metadata_struct
->stream_id
));
1449 if (!metadata_stream
) {
1454 pthread_mutex_lock(&metadata_stream
->lock
);
1456 size_ret
= lttng_write(metadata_stream
->stream_fd
->fd
, metadata_struct
->payload
,
1458 if (size_ret
< payload_size
) {
1459 ERR("Relay error writing metadata on file");
1464 ret
= write_padding_to_file(metadata_stream
->stream_fd
->fd
,
1465 be32toh(metadata_struct
->padding_size
));
1470 metadata_stream
->metadata_received
+=
1471 payload_size
+ be32toh(metadata_struct
->padding_size
);
1472 DBG2("Relay metadata written. Updated metadata_received %" PRIu64
,
1473 metadata_stream
->metadata_received
);
1476 pthread_mutex_unlock(&metadata_stream
->lock
);
1477 stream_put(metadata_stream
);
1484 * relay_send_version: send relayd version number
1486 static int relay_send_version(struct lttcomm_relayd_hdr
*recv_hdr
,
1487 struct relay_connection
*conn
)
1490 struct lttcomm_relayd_version reply
, msg
;
1492 conn
->version_check_done
= 1;
1494 /* Get version from the other side. */
1495 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1496 if (ret
< 0 || ret
!= sizeof(msg
)) {
1498 /* Orderly shutdown. Not necessary to print an error. */
1499 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1501 ERR("Relay failed to receive the version values.");
1507 memset(&reply
, 0, sizeof(reply
));
1508 reply
.major
= RELAYD_VERSION_COMM_MAJOR
;
1509 reply
.minor
= RELAYD_VERSION_COMM_MINOR
;
1511 /* Major versions must be the same */
1512 if (reply
.major
!= be32toh(msg
.major
)) {
1513 DBG("Incompatible major versions (%u vs %u), deleting session",
1514 reply
.major
, be32toh(msg
.major
));
1515 connection_put(conn
);
1520 conn
->major
= reply
.major
;
1521 /* We adapt to the lowest compatible version */
1522 if (reply
.minor
<= be32toh(msg
.minor
)) {
1523 conn
->minor
= reply
.minor
;
1525 conn
->minor
= be32toh(msg
.minor
);
1528 reply
.major
= htobe32(reply
.major
);
1529 reply
.minor
= htobe32(reply
.minor
);
1530 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
,
1531 sizeof(struct lttcomm_relayd_version
), 0);
1533 ERR("Relay sending version");
1536 DBG("Version check done using protocol %u.%u", conn
->major
,
1544 * Check for data pending for a given stream id from the session daemon.
1546 static int relay_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1547 struct relay_connection
*conn
)
1549 struct relay_session
*session
= conn
->session
;
1550 struct lttcomm_relayd_data_pending msg
;
1551 struct lttcomm_relayd_generic_reply reply
;
1552 struct relay_stream
*stream
;
1554 uint64_t last_net_seq_num
, stream_id
;
1556 DBG("Data pending command received");
1558 if (!session
|| conn
->version_check_done
== 0) {
1559 ERR("Trying to check for data before version check");
1561 goto end_no_session
;
1564 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1565 if (ret
< sizeof(msg
)) {
1567 /* Orderly shutdown. Not necessary to print an error. */
1568 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1570 ERR("Relay didn't receive valid data_pending struct size : %d",
1574 goto end_no_session
;
1577 stream_id
= be64toh(msg
.stream_id
);
1578 last_net_seq_num
= be64toh(msg
.last_net_seq_num
);
1580 stream
= stream_get_by_id(stream_id
);
1581 if (stream
== NULL
) {
1586 pthread_mutex_lock(&stream
->lock
);
1588 DBG("Data pending for stream id %" PRIu64
" prev_seq %" PRIu64
1589 " and last_seq %" PRIu64
, stream_id
, stream
->prev_seq
,
1592 /* Avoid wrapping issue */
1593 if (((int64_t) (stream
->prev_seq
- last_net_seq_num
)) >= 0) {
1594 /* Data has in fact been written and is NOT pending */
1597 /* Data still being streamed thus pending */
1601 stream
->data_pending_check_done
= true;
1602 pthread_mutex_unlock(&stream
->lock
);
1607 memset(&reply
, 0, sizeof(reply
));
1608 reply
.ret_code
= htobe32(ret
);
1609 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1611 ERR("Relay data pending ret code failed");
1619 * Wait for the control socket to reach a quiescent state.
1621 * Note that for now, when receiving this command from the session
1622 * daemon, this means that every subsequent commands or data received on
1623 * the control socket has been handled. So, this is why we simply return
1626 static int relay_quiescent_control(struct lttcomm_relayd_hdr
*recv_hdr
,
1627 struct relay_connection
*conn
)
1631 struct relay_stream
*stream
;
1632 struct lttcomm_relayd_quiescent_control msg
;
1633 struct lttcomm_relayd_generic_reply reply
;
1635 DBG("Checking quiescent state on control socket");
1637 if (!conn
->session
|| conn
->version_check_done
== 0) {
1638 ERR("Trying to check for data before version check");
1640 goto end_no_session
;
1643 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1644 if (ret
< sizeof(msg
)) {
1646 /* Orderly shutdown. Not necessary to print an error. */
1647 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1649 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1653 goto end_no_session
;
1656 stream_id
= be64toh(msg
.stream_id
);
1657 stream
= stream_get_by_id(stream_id
);
1661 pthread_mutex_lock(&stream
->lock
);
1662 stream
->data_pending_check_done
= true;
1663 pthread_mutex_unlock(&stream
->lock
);
1664 DBG("Relay quiescent control pending flag set to %" PRIu64
, stream_id
);
1667 memset(&reply
, 0, sizeof(reply
));
1668 reply
.ret_code
= htobe32(LTTNG_OK
);
1669 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1671 ERR("Relay data quiescent control ret code failed");
1679 * Initialize a data pending command. This means that a consumer is about
1680 * to ask for data pending for each stream it holds. Simply iterate over
1681 * all streams of a session and set the data_pending_check_done flag.
1683 * This command returns to the client a LTTNG_OK code.
1685 static int relay_begin_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1686 struct relay_connection
*conn
)
1689 struct lttng_ht_iter iter
;
1690 struct lttcomm_relayd_begin_data_pending msg
;
1691 struct lttcomm_relayd_generic_reply reply
;
1692 struct relay_stream
*stream
;
1693 uint64_t session_id
;
1698 DBG("Init streams for data pending");
1700 if (!conn
->session
|| conn
->version_check_done
== 0) {
1701 ERR("Trying to check for data before version check");
1703 goto end_no_session
;
1706 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1707 if (ret
< sizeof(msg
)) {
1709 /* Orderly shutdown. Not necessary to print an error. */
1710 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1712 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1716 goto end_no_session
;
1719 session_id
= be64toh(msg
.session_id
);
1722 * Iterate over all streams to set the begin data pending flag.
1723 * For now, the streams are indexed by stream handle so we have
1724 * to iterate over all streams to find the one associated with
1725 * the right session_id.
1728 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1730 if (!stream_get(stream
)) {
1733 if (stream
->trace
->session
->id
== session_id
) {
1734 pthread_mutex_lock(&stream
->lock
);
1735 stream
->data_pending_check_done
= false;
1736 pthread_mutex_unlock(&stream
->lock
);
1737 DBG("Set begin data pending flag to stream %" PRIu64
,
1738 stream
->stream_handle
);
1744 memset(&reply
, 0, sizeof(reply
));
1745 /* All good, send back reply. */
1746 reply
.ret_code
= htobe32(LTTNG_OK
);
1748 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1750 ERR("Relay begin data pending send reply failed");
1758 * End data pending command. This will check, for a given session id, if
1759 * each stream associated with it has its data_pending_check_done flag
1760 * set. If not, this means that the client lost track of the stream but
1761 * the data is still being streamed on our side. In this case, we inform
1762 * the client that data is in flight.
1764 * Return to the client if there is data in flight or not with a ret_code.
1766 static int relay_end_data_pending(struct lttcomm_relayd_hdr
*recv_hdr
,
1767 struct relay_connection
*conn
)
1770 struct lttng_ht_iter iter
;
1771 struct lttcomm_relayd_end_data_pending msg
;
1772 struct lttcomm_relayd_generic_reply reply
;
1773 struct relay_stream
*stream
;
1774 uint64_t session_id
;
1775 uint32_t is_data_inflight
= 0;
1777 DBG("End data pending command");
1779 if (!conn
->session
|| conn
->version_check_done
== 0) {
1780 ERR("Trying to check for data before version check");
1782 goto end_no_session
;
1785 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &msg
, sizeof(msg
), 0);
1786 if (ret
< sizeof(msg
)) {
1788 /* Orderly shutdown. Not necessary to print an error. */
1789 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1791 ERR("Relay didn't receive valid end data_pending struct size: %d",
1795 goto end_no_session
;
1798 session_id
= be64toh(msg
.session_id
);
1801 * Iterate over all streams to see if the begin data pending
1805 cds_lfht_for_each_entry(relay_streams_ht
->ht
, &iter
.iter
, stream
,
1807 if (!stream_get(stream
)) {
1810 if (stream
->trace
->session
->id
!= session_id
) {
1814 pthread_mutex_lock(&stream
->lock
);
1815 if (!stream
->data_pending_check_done
) {
1816 if (!stream
->closed
|| !(((int64_t) (stream
->prev_seq
- stream
->last_net_seq_num
)) >= 0)) {
1817 is_data_inflight
= 1;
1818 DBG("Data is still in flight for stream %" PRIu64
,
1819 stream
->stream_handle
);
1820 pthread_mutex_unlock(&stream
->lock
);
1825 pthread_mutex_unlock(&stream
->lock
);
1830 memset(&reply
, 0, sizeof(reply
));
1831 /* All good, send back reply. */
1832 reply
.ret_code
= htobe32(is_data_inflight
);
1834 ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1836 ERR("Relay end data pending send reply failed");
1844 * Receive an index for a specific stream.
1846 * Return 0 on success else a negative value.
1848 static int relay_recv_index(struct lttcomm_relayd_hdr
*recv_hdr
,
1849 struct relay_connection
*conn
)
1852 struct relay_session
*session
= conn
->session
;
1853 struct lttcomm_relayd_index index_info
;
1854 struct relay_index
*index
;
1855 struct lttcomm_relayd_generic_reply reply
;
1856 struct relay_stream
*stream
;
1857 uint64_t net_seq_num
;
1861 DBG("Relay receiving index");
1863 if (!session
|| conn
->version_check_done
== 0) {
1864 ERR("Trying to close a stream before version check");
1866 goto end_no_session
;
1869 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &index_info
,
1870 sizeof(index_info
), 0);
1871 if (ret
< sizeof(index_info
)) {
1873 /* Orderly shutdown. Not necessary to print an error. */
1874 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
1876 ERR("Relay didn't receive valid index struct size : %d", ret
);
1879 goto end_no_session
;
1882 net_seq_num
= be64toh(index_info
.net_seq_num
);
1884 stream
= stream_get_by_id(be64toh(index_info
.relay_stream_id
));
1886 ERR("stream_get_by_id not found");
1890 pthread_mutex_lock(&stream
->lock
);
1892 /* Live beacon handling */
1893 if (index_info
.packet_size
== 0) {
1894 DBG("Received live beacon for stream %" PRIu64
,
1895 stream
->stream_handle
);
1898 * Only flag a stream inactive when it has already
1899 * received data and no indexes are in flight.
1901 if (stream
->index_received_seqcount
> 0
1902 && stream
->indexes_in_flight
== 0) {
1903 stream
->beacon_ts_end
=
1904 be64toh(index_info
.timestamp_end
);
1907 goto end_stream_put
;
1909 stream
->beacon_ts_end
= -1ULL;
1912 if (stream
->ctf_stream_id
== -1ULL) {
1913 stream
->ctf_stream_id
= be64toh(index_info
.stream_id
);
1915 index
= relay_index_get_by_id_or_create(stream
, net_seq_num
);
1918 ERR("relay_index_get_by_id_or_create index NULL");
1919 goto end_stream_put
;
1921 if (set_index_control_data(index
, &index_info
)) {
1922 ERR("set_index_control_data error");
1923 relay_index_put(index
);
1925 goto end_stream_put
;
1927 ret
= relay_index_try_flush(index
);
1929 tracefile_array_commit_seq(stream
->tfa
);
1930 stream
->index_received_seqcount
++;
1931 } else if (ret
> 0) {
1935 ERR("relay_index_try_flush error %d", ret
);
1936 relay_index_put(index
);
1941 pthread_mutex_unlock(&stream
->lock
);
1946 memset(&reply
, 0, sizeof(reply
));
1948 reply
.ret_code
= htobe32(LTTNG_ERR_UNK
);
1950 reply
.ret_code
= htobe32(LTTNG_OK
);
1952 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1954 ERR("Relay sending close index id reply");
1963 * Receive the streams_sent message.
1965 * Return 0 on success else a negative value.
1967 static int relay_streams_sent(struct lttcomm_relayd_hdr
*recv_hdr
,
1968 struct relay_connection
*conn
)
1971 struct lttcomm_relayd_generic_reply reply
;
1975 DBG("Relay receiving streams_sent");
1977 if (!conn
->session
|| conn
->version_check_done
== 0) {
1978 ERR("Trying to close a stream before version check");
1980 goto end_no_session
;
1984 * Publish every pending stream in the connection recv list which are
1985 * now ready to be used by the viewer.
1987 publish_connection_local_streams(conn
);
1989 memset(&reply
, 0, sizeof(reply
));
1990 reply
.ret_code
= htobe32(LTTNG_OK
);
1991 send_ret
= conn
->sock
->ops
->sendmsg(conn
->sock
, &reply
, sizeof(reply
), 0);
1993 ERR("Relay sending sent_stream reply");
2005 * Process the commands received on the control socket
2007 static int relay_process_control(struct lttcomm_relayd_hdr
*recv_hdr
,
2008 struct relay_connection
*conn
)
2012 switch (be32toh(recv_hdr
->cmd
)) {
2013 case RELAYD_CREATE_SESSION
:
2014 ret
= relay_create_session(recv_hdr
, conn
);
2016 case RELAYD_ADD_STREAM
:
2017 ret
= relay_add_stream(recv_hdr
, conn
);
2019 case RELAYD_START_DATA
:
2020 ret
= relay_start(recv_hdr
, conn
);
2022 case RELAYD_SEND_METADATA
:
2023 ret
= relay_recv_metadata(recv_hdr
, conn
);
2025 case RELAYD_VERSION
:
2026 ret
= relay_send_version(recv_hdr
, conn
);
2028 case RELAYD_CLOSE_STREAM
:
2029 ret
= relay_close_stream(recv_hdr
, conn
);
2031 case RELAYD_DATA_PENDING
:
2032 ret
= relay_data_pending(recv_hdr
, conn
);
2034 case RELAYD_QUIESCENT_CONTROL
:
2035 ret
= relay_quiescent_control(recv_hdr
, conn
);
2037 case RELAYD_BEGIN_DATA_PENDING
:
2038 ret
= relay_begin_data_pending(recv_hdr
, conn
);
2040 case RELAYD_END_DATA_PENDING
:
2041 ret
= relay_end_data_pending(recv_hdr
, conn
);
2043 case RELAYD_SEND_INDEX
:
2044 ret
= relay_recv_index(recv_hdr
, conn
);
2046 case RELAYD_STREAMS_SENT
:
2047 ret
= relay_streams_sent(recv_hdr
, conn
);
2049 case RELAYD_UPDATE_SYNC_INFO
:
2051 ERR("Received unknown command (%u)", be32toh(recv_hdr
->cmd
));
2052 relay_unknown_command(conn
);
2062 * Handle index for a data stream.
2064 * Called with the stream lock held.
2066 * Return 0 on success else a negative value.
2068 static int handle_index_data(struct relay_stream
*stream
, uint64_t net_seq_num
,
2072 uint64_t data_offset
;
2073 struct relay_index
*index
;
2075 /* Get data offset because we are about to update the index. */
2076 data_offset
= htobe64(stream
->tracefile_size_current
);
2078 DBG("handle_index_data: stream %" PRIu64
" data offset %" PRIu64
,
2079 stream
->stream_handle
, stream
->tracefile_size_current
);
2082 * Lookup for an existing index for that stream id/sequence
2083 * number. If it exists, the control thread has already received the
2084 * data for it, thus we need to write it to disk.
2086 index
= relay_index_get_by_id_or_create(stream
, net_seq_num
);
2092 if (rotate_index
|| !stream
->index_fd
) {
2095 /* Put ref on previous index_fd. */
2096 if (stream
->index_fd
) {
2097 stream_fd_put(stream
->index_fd
);
2098 stream
->index_fd
= NULL
;
2101 fd
= index_create_file(stream
->path_name
, stream
->channel_name
,
2102 -1, -1, stream
->tracefile_size
,
2103 tracefile_array_get_file_index_head(stream
->tfa
));
2106 /* Put self-ref for this index due to error. */
2107 relay_index_put(index
);
2110 stream
->index_fd
= stream_fd_create(fd
);
2111 if (!stream
->index_fd
) {
2114 PERROR("Error closing FD %d", fd
);
2116 /* Put self-ref for this index due to error. */
2117 relay_index_put(index
);
2118 /* Will put the local ref. */
2123 if (relay_index_set_fd(index
, stream
->index_fd
, data_offset
)) {
2125 /* Put self-ref for this index due to error. */
2126 relay_index_put(index
);
2130 ret
= relay_index_try_flush(index
);
2132 tracefile_array_commit_seq(stream
->tfa
);
2133 stream
->index_received_seqcount
++;
2134 } else if (ret
> 0) {
2138 /* Put self-ref for this index due to error. */
2139 relay_index_put(index
);
2147 * relay_process_data: Process the data received on the data socket
2149 static int relay_process_data(struct relay_connection
*conn
)
2151 int ret
= 0, rotate_index
= 0;
2153 struct relay_stream
*stream
;
2154 struct lttcomm_relayd_data_hdr data_hdr
;
2156 uint64_t net_seq_num
;
2158 struct relay_session
*session
;
2159 bool new_stream
= false;
2161 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, &data_hdr
,
2162 sizeof(struct lttcomm_relayd_data_hdr
), 0);
2165 /* Orderly shutdown. Not necessary to print an error. */
2166 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2168 ERR("Unable to receive data header on sock %d", conn
->sock
->fd
);
2174 stream_id
= be64toh(data_hdr
.stream_id
);
2175 stream
= stream_get_by_id(stream_id
);
2180 session
= stream
->trace
->session
;
2181 data_size
= be32toh(data_hdr
.data_size
);
2182 if (data_buffer_size
< data_size
) {
2185 tmp_data_ptr
= realloc(data_buffer
, data_size
);
2186 if (!tmp_data_ptr
) {
2187 ERR("Allocating data buffer");
2190 goto end_stream_put
;
2192 data_buffer
= tmp_data_ptr
;
2193 data_buffer_size
= data_size
;
2195 memset(data_buffer
, 0, data_size
);
2197 net_seq_num
= be64toh(data_hdr
.net_seq_num
);
2199 DBG3("Receiving data of size %u for stream id %" PRIu64
" seqnum %" PRIu64
,
2200 data_size
, stream_id
, net_seq_num
);
2201 ret
= conn
->sock
->ops
->recvmsg(conn
->sock
, data_buffer
, data_size
, 0);
2204 /* Orderly shutdown. Not necessary to print an error. */
2205 DBG("Socket %d did an orderly shutdown", conn
->sock
->fd
);
2208 goto end_stream_put
;
2211 pthread_mutex_lock(&stream
->lock
);
2213 /* Check if a rotation is needed. */
2214 if (stream
->tracefile_size
> 0 &&
2215 (stream
->tracefile_size_current
+ data_size
) >
2216 stream
->tracefile_size
) {
2217 uint64_t old_id
, new_id
;
2219 old_id
= tracefile_array_get_file_index_head(stream
->tfa
);
2220 tracefile_array_file_rotate(stream
->tfa
);
2222 /* new_id is updated by utils_rotate_stream_file. */
2225 ret
= utils_rotate_stream_file(stream
->path_name
,
2226 stream
->channel_name
, stream
->tracefile_size
,
2227 stream
->tracefile_count
, -1,
2228 -1, stream
->stream_fd
->fd
,
2229 &new_id
, &stream
->stream_fd
->fd
);
2231 ERR("Rotating stream output file");
2232 goto end_stream_unlock
;
2235 * Reset current size because we just performed a stream
2238 stream
->tracefile_size_current
= 0;
2243 * Index are handled in protocol version 2.4 and above. Also,
2244 * snapshot and index are NOT supported.
2246 if (session
->minor
>= 4 && !session
->snapshot
) {
2247 ret
= handle_index_data(stream
, net_seq_num
, rotate_index
);
2249 goto end_stream_unlock
;
2253 /* Write data to stream output fd. */
2254 size_ret
= lttng_write(stream
->stream_fd
->fd
, data_buffer
, data_size
);
2255 if (size_ret
< data_size
) {
2256 ERR("Relay error writing data to file");
2258 goto end_stream_unlock
;
2261 DBG2("Relay wrote %zd bytes to tracefile for stream id %" PRIu64
,
2262 size_ret
, stream
->stream_handle
);
2264 ret
= write_padding_to_file(stream
->stream_fd
->fd
,
2265 be32toh(data_hdr
.padding_size
));
2267 goto end_stream_unlock
;
2269 stream
->tracefile_size_current
+=
2270 data_size
+ be32toh(data_hdr
.padding_size
);
2271 if (stream
->prev_seq
== -1ULL) {
2275 stream
->prev_seq
= net_seq_num
;
2278 pthread_mutex_unlock(&stream
->lock
);
2280 pthread_mutex_lock(&session
->lock
);
2281 uatomic_set(&session
->new_streams
, 1);
2282 pthread_mutex_unlock(&session
->lock
);
2290 static void cleanup_connection_pollfd(struct lttng_poll_event
*events
, int pollfd
)
2294 (void) lttng_poll_del(events
, pollfd
);
2296 ret
= close(pollfd
);
2298 ERR("Closing pollfd %d", pollfd
);
2302 static void relay_thread_close_connection(struct lttng_poll_event
*events
,
2303 int pollfd
, struct relay_connection
*conn
)
2305 const char *type_str
;
2307 switch (conn
->type
) {
2312 type_str
= "Control";
2314 case RELAY_VIEWER_COMMAND
:
2315 type_str
= "Viewer Command";
2317 case RELAY_VIEWER_NOTIFICATION
:
2318 type_str
= "Viewer Notification";
2321 type_str
= "Unknown";
2323 cleanup_connection_pollfd(events
, pollfd
);
2324 connection_put(conn
);
2325 DBG("%s connection closed with %d", type_str
, pollfd
);
2329 * This thread does the actual work
2331 static void *relay_thread_worker(void *data
)
2333 int ret
, err
= -1, last_seen_data_fd
= -1;
2335 struct lttng_poll_event events
;
2336 struct lttng_ht
*relay_connections_ht
;
2337 struct lttng_ht_iter iter
;
2338 struct lttcomm_relayd_hdr recv_hdr
;
2339 struct relay_connection
*destroy_conn
= NULL
;
2341 DBG("[thread] Relay worker started");
2343 rcu_register_thread();
2345 health_register(health_relayd
, HEALTH_RELAYD_TYPE_WORKER
);
2347 if (testpoint(relayd_thread_worker
)) {
2348 goto error_testpoint
;
2351 health_code_update();
2353 /* table of connections indexed on socket */
2354 relay_connections_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2355 if (!relay_connections_ht
) {
2356 goto relay_connections_ht_error
;
2359 ret
= create_thread_poll_set(&events
, 2);
2361 goto error_poll_create
;
2364 ret
= lttng_poll_add(&events
, relay_conn_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
2371 int idx
= -1, i
, seen_control
= 0, last_notdel_data_fd
= -1;
2373 health_code_update();
2375 /* Infinite blocking call, waiting for transmission */
2376 DBG3("Relayd worker thread polling...");
2377 health_poll_entry();
2378 ret
= lttng_poll_wait(&events
, -1);
2382 * Restart interrupted system call.
2384 if (errno
== EINTR
) {
2393 * Process control. The control connection is
2394 * prioritized so we don't starve it with high
2395 * throughput tracing data on the data connection.
2397 for (i
= 0; i
< nb_fd
; i
++) {
2398 /* Fetch once the poll data */
2399 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2400 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2402 health_code_update();
2406 * No activity for this FD (poll
2412 /* Thread quit pipe has been closed. Killing thread. */
2413 ret
= check_thread_quit_pipe(pollfd
, revents
);
2419 /* Inspect the relay conn pipe for new connection */
2420 if (pollfd
== relay_conn_pipe
[0]) {
2421 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2422 ERR("Relay connection pipe error");
2424 } else if (revents
& LPOLLIN
) {
2425 struct relay_connection
*conn
;
2427 ret
= lttng_read(relay_conn_pipe
[0], &conn
, sizeof(conn
));
2431 lttng_poll_add(&events
, conn
->sock
->fd
,
2432 LPOLLIN
| LPOLLRDHUP
);
2433 connection_ht_add(relay_connections_ht
, conn
);
2434 DBG("Connection socket %d added", conn
->sock
->fd
);
2437 struct relay_connection
*ctrl_conn
;
2439 ctrl_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
2440 /* If not found, there is a synchronization issue. */
2443 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2444 relay_thread_close_connection(&events
, pollfd
, ctrl_conn
);
2445 if (last_seen_data_fd
== pollfd
) {
2446 last_seen_data_fd
= last_notdel_data_fd
;
2448 } else if (revents
& LPOLLIN
) {
2449 if (ctrl_conn
->type
== RELAY_CONTROL
) {
2450 ret
= ctrl_conn
->sock
->ops
->recvmsg(ctrl_conn
->sock
, &recv_hdr
,
2451 sizeof(recv_hdr
), 0);
2453 /* Connection closed */
2454 relay_thread_close_connection(&events
, pollfd
,
2457 ret
= relay_process_control(&recv_hdr
, ctrl_conn
);
2459 /* Clear the session on error. */
2460 relay_thread_close_connection(&events
, pollfd
,
2467 * Flag the last seen data fd not deleted. It will be
2468 * used as the last seen fd if any fd gets deleted in
2471 last_notdel_data_fd
= pollfd
;
2474 ERR("Unknown poll events %u for sock %d", revents
, pollfd
);
2476 connection_put(ctrl_conn
);
2481 * The last loop handled a control request, go back to poll to make
2482 * sure we prioritise the control socket.
2488 if (last_seen_data_fd
>= 0) {
2489 for (i
= 0; i
< nb_fd
; i
++) {
2490 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2492 health_code_update();
2494 if (last_seen_data_fd
== pollfd
) {
2501 /* Process data connection. */
2502 for (i
= idx
+ 1; i
< nb_fd
; i
++) {
2503 /* Fetch the poll data. */
2504 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
2505 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2506 struct relay_connection
*data_conn
;
2508 health_code_update();
2511 /* No activity for this FD (poll implementation). */
2515 /* Skip the command pipe. It's handled in the first loop. */
2516 if (pollfd
== relay_conn_pipe
[0]) {
2520 data_conn
= connection_get_by_sock(relay_connections_ht
, pollfd
);
2522 /* Skip it. Might be removed before. */
2526 if (revents
& LPOLLIN
) {
2527 if (data_conn
->type
!= RELAY_DATA
) {
2528 goto put_connection
;
2531 ret
= relay_process_data(data_conn
);
2532 /* Connection closed */
2534 relay_thread_close_connection(&events
, pollfd
,
2537 * Every goto restart call sets the last seen fd where
2538 * here we don't really care since we gracefully
2539 * continue the loop after the connection is deleted.
2542 /* Keep last seen port. */
2543 last_seen_data_fd
= pollfd
;
2544 connection_put(data_conn
);
2549 connection_put(data_conn
);
2551 last_seen_data_fd
= -1;
2554 /* Normal exit, no error */
2559 /* Cleanup reamaining connection object. */
2561 cds_lfht_for_each_entry(relay_connections_ht
->ht
, &iter
.iter
,
2564 health_code_update();
2566 * No need to grab another ref, because we own
2569 relay_thread_close_connection(&events
, destroy_conn
->sock
->fd
,
2574 lttng_poll_clean(&events
);
2576 lttng_ht_destroy(relay_connections_ht
);
2577 relay_connections_ht_error
:
2578 /* Close relay conn pipes */
2579 utils_close_pipe(relay_conn_pipe
);
2581 DBG("Thread exited with error");
2583 DBG("Worker thread cleanup complete");
2588 ERR("Health error occurred in %s", __func__
);
2590 health_unregister(health_relayd
);
2591 rcu_unregister_thread();
2592 lttng_relay_stop_threads();
2597 * Create the relay command pipe to wake thread_manage_apps.
2598 * Closed in cleanup().
2600 static int create_relay_conn_pipe(void)
2604 ret
= utils_create_pipe_cloexec(relay_conn_pipe
);
2612 int main(int argc
, char **argv
)
2614 int ret
= 0, retval
= 0;
2617 /* Parse arguments */
2619 if (set_options(argc
, argv
)) {
2624 if (set_signal_handler()) {
2629 /* Try to create directory if -o, --output is specified. */
2630 if (opt_output_path
) {
2631 if (*opt_output_path
!= '/') {
2632 ERR("Please specify an absolute path for -o, --output PATH");
2637 ret
= utils_mkdir_recursive(opt_output_path
, S_IRWXU
| S_IRWXG
,
2640 ERR("Unable to create %s", opt_output_path
);
2647 if (opt_daemon
|| opt_background
) {
2650 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
2658 * We are in the child. Make sure all other file
2659 * descriptors are closed, in case we are called with
2660 * more opened file descriptors than the standard ones.
2662 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
2668 /* Initialize thread health monitoring */
2669 health_relayd
= health_app_create(NR_HEALTH_RELAYD_TYPES
);
2670 if (!health_relayd
) {
2671 PERROR("health_app_create error");
2673 goto exit_health_app_create
;
2676 /* Create thread quit pipe */
2677 if (init_thread_quit_pipe()) {
2679 goto exit_init_data
;
2682 /* Check if daemon is UID = 0 */
2684 if (control_uri
->port
< 1024 || data_uri
->port
< 1024 || live_uri
->port
< 1024) {
2685 ERR("Need to be root to use ports < 1024");
2687 goto exit_init_data
;
2691 /* Setup the thread apps communication pipe. */
2692 if (create_relay_conn_pipe()) {
2694 goto exit_init_data
;
2697 /* Init relay command queue. */
2698 cds_wfcq_init(&relay_conn_queue
.head
, &relay_conn_queue
.tail
);
2700 /* Set up max poll set size */
2701 if (lttng_poll_set_max_size()) {
2703 goto exit_init_data
;
2706 /* Initialize communication library */
2708 lttcomm_inet_init();
2710 /* tables of sessions indexed by session ID */
2711 sessions_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2714 goto exit_init_data
;
2717 /* tables of streams indexed by stream ID */
2718 relay_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2719 if (!relay_streams_ht
) {
2721 goto exit_init_data
;
2724 /* tables of streams indexed by stream ID */
2725 viewer_streams_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2726 if (!viewer_streams_ht
) {
2728 goto exit_init_data
;
2731 ret
= utils_create_pipe(health_quit_pipe
);
2734 goto exit_health_quit_pipe
;
2737 /* Create thread to manage the client socket */
2738 ret
= pthread_create(&health_thread
, NULL
,
2739 thread_manage_health
, (void *) NULL
);
2742 PERROR("pthread_create health");
2744 goto exit_health_thread
;
2747 /* Setup the dispatcher thread */
2748 ret
= pthread_create(&dispatcher_thread
, NULL
,
2749 relay_thread_dispatcher
, (void *) NULL
);
2752 PERROR("pthread_create dispatcher");
2754 goto exit_dispatcher_thread
;
2757 /* Setup the worker thread */
2758 ret
= pthread_create(&worker_thread
, NULL
,
2759 relay_thread_worker
, NULL
);
2762 PERROR("pthread_create worker");
2764 goto exit_worker_thread
;
2767 /* Setup the listener thread */
2768 ret
= pthread_create(&listener_thread
, NULL
,
2769 relay_thread_listener
, (void *) NULL
);
2772 PERROR("pthread_create listener");
2774 goto exit_listener_thread
;
2777 ret
= relayd_live_create(live_uri
);
2779 ERR("Starting live viewer threads");
2785 * This is where we start awaiting program completion (e.g. through
2786 * signal that asks threads to teardown).
2789 ret
= relayd_live_join();
2795 ret
= pthread_join(listener_thread
, &status
);
2798 PERROR("pthread_join listener_thread");
2802 exit_listener_thread
:
2803 ret
= pthread_join(worker_thread
, &status
);
2806 PERROR("pthread_join worker_thread");
2811 ret
= pthread_join(dispatcher_thread
, &status
);
2814 PERROR("pthread_join dispatcher_thread");
2817 exit_dispatcher_thread
:
2819 ret
= pthread_join(health_thread
, &status
);
2822 PERROR("pthread_join health_thread");
2827 utils_close_pipe(health_quit_pipe
);
2828 exit_health_quit_pipe
:
2831 health_app_destroy(health_relayd
);
2832 exit_health_app_create
:
2836 /* Ensure all prior call_rcu are done. */