44fb2e27cb99a1bc34feeeaaa7d7d618bcbb72f3
[lttng-tools.git] / src / bin / lttng-relayd / main.c
1 /*
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>
6 *
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.
10 *
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
14 * more details.
15 *
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.
19 */
20
21 #define _LGPL_SOURCE
22 #include <getopt.h>
23 #include <grp.h>
24 #include <limits.h>
25 #include <pthread.h>
26 #include <signal.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <sys/mman.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
34 #include <sys/stat.h>
35 #include <sys/types.h>
36 #include <sys/wait.h>
37 #include <inttypes.h>
38 #include <urcu/futex.h>
39 #include <urcu/uatomic.h>
40 #include <unistd.h>
41 #include <fcntl.h>
42
43 #include <lttng/lttng.h>
44 #include <common/common.h>
45 #include <common/compat/poll.h>
46 #include <common/compat/socket.h>
47 #include <common/compat/endian.h>
48 #include <common/compat/getenv.h>
49 #include <common/defaults.h>
50 #include <common/daemonize.h>
51 #include <common/futex.h>
52 #include <common/sessiond-comm/sessiond-comm.h>
53 #include <common/sessiond-comm/inet.h>
54 #include <common/sessiond-comm/relayd.h>
55 #include <common/uri.h>
56 #include <common/utils.h>
57 #include <common/align.h>
58 #include <common/config/session-config.h>
59 #include <common/dynamic-buffer.h>
60 #include <common/buffer-view.h>
61 #include <urcu/rculist.h>
62
63 #include "cmd.h"
64 #include "ctf-trace.h"
65 #include "index.h"
66 #include "utils.h"
67 #include "lttng-relayd.h"
68 #include "live.h"
69 #include "health-relayd.h"
70 #include "testpoint.h"
71 #include "viewer-stream.h"
72 #include "session.h"
73 #include "stream.h"
74 #include "connection.h"
75 #include "tracefile-array.h"
76 #include "tcp_keep_alive.h"
77
78 static const char *help_msg =
79 #ifdef LTTNG_EMBED_HELP
80 #include <lttng-relayd.8.h>
81 #else
82 NULL
83 #endif
84 ;
85
86 enum relay_connection_status {
87 RELAY_CONNECTION_STATUS_OK,
88 /* An error occured while processing an event on the connection. */
89 RELAY_CONNECTION_STATUS_ERROR,
90 /* Connection closed/shutdown cleanly. */
91 RELAY_CONNECTION_STATUS_CLOSED,
92 };
93
94 /* command line options */
95 char *opt_output_path;
96 static int opt_daemon, opt_background;
97
98 /*
99 * We need to wait for listener and live listener threads, as well as
100 * health check thread, before being ready to signal readiness.
101 */
102 #define NR_LTTNG_RELAY_READY 3
103 static int lttng_relay_ready = NR_LTTNG_RELAY_READY;
104
105 /* Size of receive buffer. */
106 #define RECV_DATA_BUFFER_SIZE 65536
107 #define FILE_COPY_BUFFER_SIZE 65536
108
109 static int recv_child_signal; /* Set to 1 when a SIGUSR1 signal is received. */
110 static pid_t child_ppid; /* Internal parent PID use with daemonize. */
111
112 static struct lttng_uri *control_uri;
113 static struct lttng_uri *data_uri;
114 static struct lttng_uri *live_uri;
115
116 const char *progname;
117
118 const char *tracing_group_name = DEFAULT_TRACING_GROUP;
119 static int tracing_group_name_override;
120
121 const char * const config_section_name = "relayd";
122
123 /*
124 * Quit pipe for all threads. This permits a single cancellation point
125 * for all threads when receiving an event on the pipe.
126 */
127 int thread_quit_pipe[2] = { -1, -1 };
128
129 /*
130 * This pipe is used to inform the worker thread that a command is queued and
131 * ready to be processed.
132 */
133 static int relay_conn_pipe[2] = { -1, -1 };
134
135 /* Shared between threads */
136 static int dispatch_thread_exit;
137
138 static pthread_t listener_thread;
139 static pthread_t dispatcher_thread;
140 static pthread_t worker_thread;
141 static pthread_t health_thread;
142
143 /*
144 * last_relay_stream_id_lock protects last_relay_stream_id increment
145 * atomicity on 32-bit architectures.
146 */
147 static pthread_mutex_t last_relay_stream_id_lock = PTHREAD_MUTEX_INITIALIZER;
148 static uint64_t last_relay_stream_id;
149
150 /*
151 * Relay command queue.
152 *
153 * The relay_thread_listener and relay_thread_dispatcher communicate with this
154 * queue.
155 */
156 static struct relay_conn_queue relay_conn_queue;
157
158 /* Global relay stream hash table. */
159 struct lttng_ht *relay_streams_ht;
160
161 /* Global relay viewer stream hash table. */
162 struct lttng_ht *viewer_streams_ht;
163
164 /* Global relay sessions hash table. */
165 struct lttng_ht *sessions_ht;
166
167 /* Relayd health monitoring */
168 struct health_app *health_relayd;
169
170 static struct option long_options[] = {
171 { "control-port", 1, 0, 'C', },
172 { "data-port", 1, 0, 'D', },
173 { "live-port", 1, 0, 'L', },
174 { "daemonize", 0, 0, 'd', },
175 { "background", 0, 0, 'b', },
176 { "group", 1, 0, 'g', },
177 { "help", 0, 0, 'h', },
178 { "output", 1, 0, 'o', },
179 { "verbose", 0, 0, 'v', },
180 { "config", 1, 0, 'f' },
181 { "version", 0, 0, 'V' },
182 { NULL, 0, 0, 0, },
183 };
184
185 static const char *config_ignore_options[] = { "help", "config", "version" };
186
187 /*
188 * Take an option from the getopt output and set it in the right variable to be
189 * used later.
190 *
191 * Return 0 on success else a negative value.
192 */
193 static int set_option(int opt, const char *arg, const char *optname)
194 {
195 int ret;
196
197 switch (opt) {
198 case 0:
199 fprintf(stderr, "option %s", optname);
200 if (arg) {
201 fprintf(stderr, " with arg %s\n", arg);
202 }
203 break;
204 case 'C':
205 if (lttng_is_setuid_setgid()) {
206 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
207 "-C, --control-port");
208 } else {
209 ret = uri_parse(arg, &control_uri);
210 if (ret < 0) {
211 ERR("Invalid control URI specified");
212 goto end;
213 }
214 if (control_uri->port == 0) {
215 control_uri->port = DEFAULT_NETWORK_CONTROL_PORT;
216 }
217 }
218 break;
219 case 'D':
220 if (lttng_is_setuid_setgid()) {
221 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
222 "-D, -data-port");
223 } else {
224 ret = uri_parse(arg, &data_uri);
225 if (ret < 0) {
226 ERR("Invalid data URI specified");
227 goto end;
228 }
229 if (data_uri->port == 0) {
230 data_uri->port = DEFAULT_NETWORK_DATA_PORT;
231 }
232 }
233 break;
234 case 'L':
235 if (lttng_is_setuid_setgid()) {
236 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
237 "-L, -live-port");
238 } else {
239 ret = uri_parse(arg, &live_uri);
240 if (ret < 0) {
241 ERR("Invalid live URI specified");
242 goto end;
243 }
244 if (live_uri->port == 0) {
245 live_uri->port = DEFAULT_NETWORK_VIEWER_PORT;
246 }
247 }
248 break;
249 case 'd':
250 opt_daemon = 1;
251 break;
252 case 'b':
253 opt_background = 1;
254 break;
255 case 'g':
256 if (lttng_is_setuid_setgid()) {
257 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
258 "-g, --group");
259 } else {
260 tracing_group_name = strdup(arg);
261 if (tracing_group_name == NULL) {
262 ret = -errno;
263 PERROR("strdup");
264 goto end;
265 }
266 tracing_group_name_override = 1;
267 }
268 break;
269 case 'h':
270 ret = utils_show_help(8, "lttng-relayd", help_msg);
271 if (ret) {
272 ERR("Cannot show --help for `lttng-relayd`");
273 perror("exec");
274 }
275 exit(EXIT_FAILURE);
276 case 'V':
277 fprintf(stdout, "%s\n", VERSION);
278 exit(EXIT_SUCCESS);
279 case 'o':
280 if (lttng_is_setuid_setgid()) {
281 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
282 "-o, --output");
283 } else {
284 ret = asprintf(&opt_output_path, "%s", arg);
285 if (ret < 0) {
286 ret = -errno;
287 PERROR("asprintf opt_output_path");
288 goto end;
289 }
290 }
291 break;
292 case 'v':
293 /* Verbose level can increase using multiple -v */
294 if (arg) {
295 lttng_opt_verbose = config_parse_value(arg);
296 } else {
297 /* Only 3 level of verbosity (-vvv). */
298 if (lttng_opt_verbose < 3) {
299 lttng_opt_verbose += 1;
300 }
301 }
302 break;
303 default:
304 /* Unknown option or other error.
305 * Error is printed by getopt, just return */
306 ret = -1;
307 goto end;
308 }
309
310 /* All good. */
311 ret = 0;
312
313 end:
314 return ret;
315 }
316
317 /*
318 * config_entry_handler_cb used to handle options read from a config file.
319 * See config_entry_handler_cb comment in common/config/session-config.h for the
320 * return value conventions.
321 */
322 static int config_entry_handler(const struct config_entry *entry, void *unused)
323 {
324 int ret = 0, i;
325
326 if (!entry || !entry->name || !entry->value) {
327 ret = -EINVAL;
328 goto end;
329 }
330
331 /* Check if the option is to be ignored */
332 for (i = 0; i < sizeof(config_ignore_options) / sizeof(char *); i++) {
333 if (!strcmp(entry->name, config_ignore_options[i])) {
334 goto end;
335 }
336 }
337
338 for (i = 0; i < (sizeof(long_options) / sizeof(struct option)) - 1; i++) {
339 /* Ignore if entry name is not fully matched. */
340 if (strcmp(entry->name, long_options[i].name)) {
341 continue;
342 }
343
344 /*
345 * If the option takes no argument on the command line,
346 * we have to check if the value is "true". We support
347 * non-zero numeric values, true, on and yes.
348 */
349 if (!long_options[i].has_arg) {
350 ret = config_parse_value(entry->value);
351 if (ret <= 0) {
352 if (ret) {
353 WARN("Invalid configuration value \"%s\" for option %s",
354 entry->value, entry->name);
355 }
356 /* False, skip boolean config option. */
357 goto end;
358 }
359 }
360
361 ret = set_option(long_options[i].val, entry->value, entry->name);
362 goto end;
363 }
364
365 WARN("Unrecognized option \"%s\" in daemon configuration file.",
366 entry->name);
367
368 end:
369 return ret;
370 }
371
372 static int set_options(int argc, char **argv)
373 {
374 int c, ret = 0, option_index = 0, retval = 0;
375 int orig_optopt = optopt, orig_optind = optind;
376 char *default_address, *optstring;
377 const char *config_path = NULL;
378
379 optstring = utils_generate_optstring(long_options,
380 sizeof(long_options) / sizeof(struct option));
381 if (!optstring) {
382 retval = -ENOMEM;
383 goto exit;
384 }
385
386 /* Check for the --config option */
387
388 while ((c = getopt_long(argc, argv, optstring, long_options,
389 &option_index)) != -1) {
390 if (c == '?') {
391 retval = -EINVAL;
392 goto exit;
393 } else if (c != 'f') {
394 continue;
395 }
396
397 if (lttng_is_setuid_setgid()) {
398 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
399 "-f, --config");
400 } else {
401 config_path = utils_expand_path(optarg);
402 if (!config_path) {
403 ERR("Failed to resolve path: %s", optarg);
404 }
405 }
406 }
407
408 ret = config_get_section_entries(config_path, config_section_name,
409 config_entry_handler, NULL);
410 if (ret) {
411 if (ret > 0) {
412 ERR("Invalid configuration option at line %i", ret);
413 }
414 retval = -1;
415 goto exit;
416 }
417
418 /* Reset getopt's global state */
419 optopt = orig_optopt;
420 optind = orig_optind;
421 while (1) {
422 c = getopt_long(argc, argv, optstring, long_options, &option_index);
423 if (c == -1) {
424 break;
425 }
426
427 ret = set_option(c, optarg, long_options[option_index].name);
428 if (ret < 0) {
429 retval = -1;
430 goto exit;
431 }
432 }
433
434 /* assign default values */
435 if (control_uri == NULL) {
436 ret = asprintf(&default_address,
437 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS ":%d",
438 DEFAULT_NETWORK_CONTROL_PORT);
439 if (ret < 0) {
440 PERROR("asprintf default data address");
441 retval = -1;
442 goto exit;
443 }
444
445 ret = uri_parse(default_address, &control_uri);
446 free(default_address);
447 if (ret < 0) {
448 ERR("Invalid control URI specified");
449 retval = -1;
450 goto exit;
451 }
452 }
453 if (data_uri == NULL) {
454 ret = asprintf(&default_address,
455 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS ":%d",
456 DEFAULT_NETWORK_DATA_PORT);
457 if (ret < 0) {
458 PERROR("asprintf default data address");
459 retval = -1;
460 goto exit;
461 }
462
463 ret = uri_parse(default_address, &data_uri);
464 free(default_address);
465 if (ret < 0) {
466 ERR("Invalid data URI specified");
467 retval = -1;
468 goto exit;
469 }
470 }
471 if (live_uri == NULL) {
472 ret = asprintf(&default_address,
473 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS ":%d",
474 DEFAULT_NETWORK_VIEWER_PORT);
475 if (ret < 0) {
476 PERROR("asprintf default viewer control address");
477 retval = -1;
478 goto exit;
479 }
480
481 ret = uri_parse(default_address, &live_uri);
482 free(default_address);
483 if (ret < 0) {
484 ERR("Invalid viewer control URI specified");
485 retval = -1;
486 goto exit;
487 }
488 }
489
490 exit:
491 free(optstring);
492 return retval;
493 }
494
495 static void print_global_objects(void)
496 {
497 rcu_register_thread();
498
499 print_viewer_streams();
500 print_relay_streams();
501 print_sessions();
502
503 rcu_unregister_thread();
504 }
505
506 /*
507 * Cleanup the daemon
508 */
509 static void relayd_cleanup(void)
510 {
511 print_global_objects();
512
513 DBG("Cleaning up");
514
515 if (viewer_streams_ht)
516 lttng_ht_destroy(viewer_streams_ht);
517 if (relay_streams_ht)
518 lttng_ht_destroy(relay_streams_ht);
519 if (sessions_ht)
520 lttng_ht_destroy(sessions_ht);
521
522 /* free the dynamically allocated opt_output_path */
523 free(opt_output_path);
524
525 /* Close thread quit pipes */
526 utils_close_pipe(thread_quit_pipe);
527
528 uri_free(control_uri);
529 uri_free(data_uri);
530 /* Live URI is freed in the live thread. */
531
532 if (tracing_group_name_override) {
533 free((void *) tracing_group_name);
534 }
535 }
536
537 /*
538 * Write to writable pipe used to notify a thread.
539 */
540 static int notify_thread_pipe(int wpipe)
541 {
542 ssize_t ret;
543
544 ret = lttng_write(wpipe, "!", 1);
545 if (ret < 1) {
546 PERROR("write poll pipe");
547 goto end;
548 }
549 ret = 0;
550 end:
551 return ret;
552 }
553
554 static int notify_health_quit_pipe(int *pipe)
555 {
556 ssize_t ret;
557
558 ret = lttng_write(pipe[1], "4", 1);
559 if (ret < 1) {
560 PERROR("write relay health quit");
561 goto end;
562 }
563 ret = 0;
564 end:
565 return ret;
566 }
567
568 /*
569 * Stop all relayd and relayd-live threads.
570 */
571 int lttng_relay_stop_threads(void)
572 {
573 int retval = 0;
574
575 /* Stopping all threads */
576 DBG("Terminating all threads");
577 if (notify_thread_pipe(thread_quit_pipe[1])) {
578 ERR("write error on thread quit pipe");
579 retval = -1;
580 }
581
582 if (notify_health_quit_pipe(health_quit_pipe)) {
583 ERR("write error on health quit pipe");
584 }
585
586 /* Dispatch thread */
587 CMM_STORE_SHARED(dispatch_thread_exit, 1);
588 futex_nto1_wake(&relay_conn_queue.futex);
589
590 if (relayd_live_stop()) {
591 ERR("Error stopping live threads");
592 retval = -1;
593 }
594 return retval;
595 }
596
597 /*
598 * Signal handler for the daemon
599 *
600 * Simply stop all worker threads, leaving main() return gracefully after
601 * joining all threads and calling cleanup().
602 */
603 static void sighandler(int sig)
604 {
605 switch (sig) {
606 case SIGINT:
607 DBG("SIGINT caught");
608 if (lttng_relay_stop_threads()) {
609 ERR("Error stopping threads");
610 }
611 break;
612 case SIGTERM:
613 DBG("SIGTERM caught");
614 if (lttng_relay_stop_threads()) {
615 ERR("Error stopping threads");
616 }
617 break;
618 case SIGUSR1:
619 CMM_STORE_SHARED(recv_child_signal, 1);
620 break;
621 default:
622 break;
623 }
624 }
625
626 /*
627 * Setup signal handler for :
628 * SIGINT, SIGTERM, SIGPIPE
629 */
630 static int set_signal_handler(void)
631 {
632 int ret = 0;
633 struct sigaction sa;
634 sigset_t sigset;
635
636 if ((ret = sigemptyset(&sigset)) < 0) {
637 PERROR("sigemptyset");
638 return ret;
639 }
640
641 sa.sa_mask = sigset;
642 sa.sa_flags = 0;
643
644 sa.sa_handler = sighandler;
645 if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
646 PERROR("sigaction");
647 return ret;
648 }
649
650 if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
651 PERROR("sigaction");
652 return ret;
653 }
654
655 if ((ret = sigaction(SIGUSR1, &sa, NULL)) < 0) {
656 PERROR("sigaction");
657 return ret;
658 }
659
660 sa.sa_handler = SIG_IGN;
661 if ((ret = sigaction(SIGPIPE, &sa, NULL)) < 0) {
662 PERROR("sigaction");
663 return ret;
664 }
665
666 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
667
668 return ret;
669 }
670
671 void lttng_relay_notify_ready(void)
672 {
673 /* Notify the parent of the fork() process that we are ready. */
674 if (opt_daemon || opt_background) {
675 if (uatomic_sub_return(&lttng_relay_ready, 1) == 0) {
676 kill(child_ppid, SIGUSR1);
677 }
678 }
679 }
680
681 /*
682 * Init thread quit pipe.
683 *
684 * Return -1 on error or 0 if all pipes are created.
685 */
686 static int init_thread_quit_pipe(void)
687 {
688 int ret;
689
690 ret = utils_create_pipe_cloexec(thread_quit_pipe);
691
692 return ret;
693 }
694
695 /*
696 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
697 */
698 static int create_thread_poll_set(struct lttng_poll_event *events, int size)
699 {
700 int ret;
701
702 if (events == NULL || size == 0) {
703 ret = -1;
704 goto error;
705 }
706
707 ret = lttng_poll_create(events, size, LTTNG_CLOEXEC);
708 if (ret < 0) {
709 goto error;
710 }
711
712 /* Add quit pipe */
713 ret = lttng_poll_add(events, thread_quit_pipe[0], LPOLLIN | LPOLLERR);
714 if (ret < 0) {
715 goto error;
716 }
717
718 return 0;
719
720 error:
721 return ret;
722 }
723
724 /*
725 * Check if the thread quit pipe was triggered.
726 *
727 * Return 1 if it was triggered else 0;
728 */
729 static int check_thread_quit_pipe(int fd, uint32_t events)
730 {
731 if (fd == thread_quit_pipe[0] && (events & LPOLLIN)) {
732 return 1;
733 }
734
735 return 0;
736 }
737
738 /*
739 * Create and init socket from uri.
740 */
741 static struct lttcomm_sock *relay_socket_create(struct lttng_uri *uri)
742 {
743 int ret;
744 struct lttcomm_sock *sock = NULL;
745
746 sock = lttcomm_alloc_sock_from_uri(uri);
747 if (sock == NULL) {
748 ERR("Allocating socket");
749 goto error;
750 }
751
752 ret = lttcomm_create_sock(sock);
753 if (ret < 0) {
754 goto error;
755 }
756 DBG("Listening on sock %d", sock->fd);
757
758 ret = sock->ops->bind(sock);
759 if (ret < 0) {
760 PERROR("Failed to bind socket");
761 goto error;
762 }
763
764 ret = sock->ops->listen(sock, -1);
765 if (ret < 0) {
766 goto error;
767
768 }
769
770 return sock;
771
772 error:
773 if (sock) {
774 lttcomm_destroy_sock(sock);
775 }
776 return NULL;
777 }
778
779 /*
780 * This thread manages the listening for new connections on the network
781 */
782 static void *relay_thread_listener(void *data)
783 {
784 int i, ret, pollfd, err = -1;
785 uint32_t revents, nb_fd;
786 struct lttng_poll_event events;
787 struct lttcomm_sock *control_sock, *data_sock;
788
789 DBG("[thread] Relay listener started");
790
791 health_register(health_relayd, HEALTH_RELAYD_TYPE_LISTENER);
792
793 health_code_update();
794
795 control_sock = relay_socket_create(control_uri);
796 if (!control_sock) {
797 goto error_sock_control;
798 }
799
800 data_sock = relay_socket_create(data_uri);
801 if (!data_sock) {
802 goto error_sock_relay;
803 }
804
805 /*
806 * Pass 3 as size here for the thread quit pipe, control and
807 * data socket.
808 */
809 ret = create_thread_poll_set(&events, 3);
810 if (ret < 0) {
811 goto error_create_poll;
812 }
813
814 /* Add the control socket */
815 ret = lttng_poll_add(&events, control_sock->fd, LPOLLIN | LPOLLRDHUP);
816 if (ret < 0) {
817 goto error_poll_add;
818 }
819
820 /* Add the data socket */
821 ret = lttng_poll_add(&events, data_sock->fd, LPOLLIN | LPOLLRDHUP);
822 if (ret < 0) {
823 goto error_poll_add;
824 }
825
826 lttng_relay_notify_ready();
827
828 if (testpoint(relayd_thread_listener)) {
829 goto error_testpoint;
830 }
831
832 while (1) {
833 health_code_update();
834
835 DBG("Listener accepting connections");
836
837 restart:
838 health_poll_entry();
839 ret = lttng_poll_wait(&events, -1);
840 health_poll_exit();
841 if (ret < 0) {
842 /*
843 * Restart interrupted system call.
844 */
845 if (errno == EINTR) {
846 goto restart;
847 }
848 goto error;
849 }
850
851 nb_fd = ret;
852
853 DBG("Relay new connection received");
854 for (i = 0; i < nb_fd; i++) {
855 health_code_update();
856
857 /* Fetch once the poll data */
858 revents = LTTNG_POLL_GETEV(&events, i);
859 pollfd = LTTNG_POLL_GETFD(&events, i);
860
861 if (!revents) {
862 /*
863 * No activity for this FD (poll
864 * implementation).
865 */
866 continue;
867 }
868
869 /* Thread quit pipe has been closed. Killing thread. */
870 ret = check_thread_quit_pipe(pollfd, revents);
871 if (ret) {
872 err = 0;
873 goto exit;
874 }
875
876 if (revents & LPOLLIN) {
877 /*
878 * A new connection is requested, therefore a
879 * sessiond/consumerd connection is allocated in
880 * this thread, enqueued to a global queue and
881 * dequeued (and freed) in the worker thread.
882 */
883 int val = 1;
884 struct relay_connection *new_conn;
885 struct lttcomm_sock *newsock;
886 enum connection_type type;
887
888 if (pollfd == data_sock->fd) {
889 type = RELAY_DATA;
890 newsock = data_sock->ops->accept(data_sock);
891 DBG("Relay data connection accepted, socket %d",
892 newsock->fd);
893 } else {
894 assert(pollfd == control_sock->fd);
895 type = RELAY_CONTROL;
896 newsock = control_sock->ops->accept(control_sock);
897 DBG("Relay control connection accepted, socket %d",
898 newsock->fd);
899 }
900 if (!newsock) {
901 PERROR("accepting sock");
902 goto error;
903 }
904
905 ret = setsockopt(newsock->fd, SOL_SOCKET, SO_REUSEADDR, &val,
906 sizeof(val));
907 if (ret < 0) {
908 PERROR("setsockopt inet");
909 lttcomm_destroy_sock(newsock);
910 goto error;
911 }
912
913 ret = socket_apply_keep_alive_config(newsock->fd);
914 if (ret < 0) {
915 ERR("Failed to apply TCP keep-alive configuration on socket (%i)",
916 newsock->fd);
917 lttcomm_destroy_sock(newsock);
918 goto error;
919 }
920
921 new_conn = connection_create(newsock, type);
922 if (!new_conn) {
923 lttcomm_destroy_sock(newsock);
924 goto error;
925 }
926
927 /* Enqueue request for the dispatcher thread. */
928 cds_wfcq_enqueue(&relay_conn_queue.head, &relay_conn_queue.tail,
929 &new_conn->qnode);
930
931 /*
932 * Wake the dispatch queue futex.
933 * Implicit memory barrier with the
934 * exchange in cds_wfcq_enqueue.
935 */
936 futex_nto1_wake(&relay_conn_queue.futex);
937 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
938 ERR("socket poll error");
939 goto error;
940 } else {
941 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
942 goto error;
943 }
944 }
945 }
946
947 exit:
948 error:
949 error_poll_add:
950 error_testpoint:
951 lttng_poll_clean(&events);
952 error_create_poll:
953 if (data_sock->fd >= 0) {
954 ret = data_sock->ops->close(data_sock);
955 if (ret) {
956 PERROR("close");
957 }
958 }
959 lttcomm_destroy_sock(data_sock);
960 error_sock_relay:
961 if (control_sock->fd >= 0) {
962 ret = control_sock->ops->close(control_sock);
963 if (ret) {
964 PERROR("close");
965 }
966 }
967 lttcomm_destroy_sock(control_sock);
968 error_sock_control:
969 if (err) {
970 health_error();
971 ERR("Health error occurred in %s", __func__);
972 }
973 health_unregister(health_relayd);
974 DBG("Relay listener thread cleanup complete");
975 lttng_relay_stop_threads();
976 return NULL;
977 }
978
979 /*
980 * This thread manages the dispatching of the requests to worker threads
981 */
982 static void *relay_thread_dispatcher(void *data)
983 {
984 int err = -1;
985 ssize_t ret;
986 struct cds_wfcq_node *node;
987 struct relay_connection *new_conn = NULL;
988
989 DBG("[thread] Relay dispatcher started");
990
991 health_register(health_relayd, HEALTH_RELAYD_TYPE_DISPATCHER);
992
993 if (testpoint(relayd_thread_dispatcher)) {
994 goto error_testpoint;
995 }
996
997 health_code_update();
998
999 for (;;) {
1000 health_code_update();
1001
1002 /* Atomically prepare the queue futex */
1003 futex_nto1_prepare(&relay_conn_queue.futex);
1004
1005 if (CMM_LOAD_SHARED(dispatch_thread_exit)) {
1006 break;
1007 }
1008
1009 do {
1010 health_code_update();
1011
1012 /* Dequeue commands */
1013 node = cds_wfcq_dequeue_blocking(&relay_conn_queue.head,
1014 &relay_conn_queue.tail);
1015 if (node == NULL) {
1016 DBG("Woken up but nothing in the relay command queue");
1017 /* Continue thread execution */
1018 break;
1019 }
1020 new_conn = caa_container_of(node, struct relay_connection, qnode);
1021
1022 DBG("Dispatching request waiting on sock %d", new_conn->sock->fd);
1023
1024 /*
1025 * Inform worker thread of the new request. This
1026 * call is blocking so we can be assured that
1027 * the data will be read at some point in time
1028 * or wait to the end of the world :)
1029 */
1030 ret = lttng_write(relay_conn_pipe[1], &new_conn, sizeof(new_conn));
1031 if (ret < 0) {
1032 PERROR("write connection pipe");
1033 connection_put(new_conn);
1034 goto error;
1035 }
1036 } while (node != NULL);
1037
1038 /* Futex wait on queue. Blocking call on futex() */
1039 health_poll_entry();
1040 futex_nto1_wait(&relay_conn_queue.futex);
1041 health_poll_exit();
1042 }
1043
1044 /* Normal exit, no error */
1045 err = 0;
1046
1047 error:
1048 error_testpoint:
1049 if (err) {
1050 health_error();
1051 ERR("Health error occurred in %s", __func__);
1052 }
1053 health_unregister(health_relayd);
1054 DBG("Dispatch thread dying");
1055 lttng_relay_stop_threads();
1056 return NULL;
1057 }
1058
1059 /*
1060 * Set index data from the control port to a given index object.
1061 */
1062 static int set_index_control_data(struct relay_index *index,
1063 struct lttcomm_relayd_index *data,
1064 struct relay_connection *conn)
1065 {
1066 struct ctf_packet_index index_data;
1067
1068 /*
1069 * The index on disk is encoded in big endian.
1070 */
1071 index_data.packet_size = htobe64(data->packet_size);
1072 index_data.content_size = htobe64(data->content_size);
1073 index_data.timestamp_begin = htobe64(data->timestamp_begin);
1074 index_data.timestamp_end = htobe64(data->timestamp_end);
1075 index_data.events_discarded = htobe64(data->events_discarded);
1076 index_data.stream_id = htobe64(data->stream_id);
1077
1078 if (conn->minor >= 8) {
1079 index->index_data.stream_instance_id = htobe64(data->stream_instance_id);
1080 index->index_data.packet_seq_num = htobe64(data->packet_seq_num);
1081 }
1082
1083 return relay_index_set_data(index, &index_data);
1084 }
1085
1086 /*
1087 * Handle the RELAYD_CREATE_SESSION command.
1088 *
1089 * On success, send back the session id or else return a negative value.
1090 */
1091 static int relay_create_session(const struct lttcomm_relayd_hdr *recv_hdr,
1092 struct relay_connection *conn,
1093 const struct lttng_buffer_view *payload)
1094 {
1095 int ret = 0;
1096 ssize_t send_ret;
1097 struct relay_session *session;
1098 struct lttcomm_relayd_status_session reply;
1099 char session_name[LTTNG_NAME_MAX];
1100 char hostname[LTTNG_HOST_NAME_MAX];
1101 uint32_t live_timer = 0;
1102 bool snapshot = false;
1103
1104 memset(session_name, 0, LTTNG_NAME_MAX);
1105 memset(hostname, 0, LTTNG_HOST_NAME_MAX);
1106
1107 memset(&reply, 0, sizeof(reply));
1108
1109 if (conn->minor < 4) {
1110 /* From 2.1 to 2.3 */
1111 ret = 0;
1112 } else if (conn->minor >= 4 && conn->minor < 11) {
1113 /* From 2.4 to 2.10 */
1114 ret = cmd_create_session_2_4(payload, session_name,
1115 hostname, &live_timer, &snapshot);
1116 } else {
1117 /* From 2.11 to ... */
1118 ret = cmd_create_session_2_11(payload, session_name,
1119 hostname, &live_timer, &snapshot);
1120 }
1121
1122 if (ret < 0) {
1123 goto send_reply;
1124 }
1125
1126 session = session_create(session_name, hostname, live_timer,
1127 snapshot, conn->major, conn->minor);
1128 if (!session) {
1129 ret = -1;
1130 goto send_reply;
1131 }
1132 assert(!conn->session);
1133 conn->session = session;
1134 DBG("Created session %" PRIu64, session->id);
1135
1136 reply.session_id = htobe64(session->id);
1137
1138 send_reply:
1139 if (ret < 0) {
1140 reply.ret_code = htobe32(LTTNG_ERR_FATAL);
1141 } else {
1142 reply.ret_code = htobe32(LTTNG_OK);
1143 }
1144
1145 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1146 if (send_ret < (ssize_t) sizeof(reply)) {
1147 ERR("Failed to send \"create session\" command reply (ret = %zd)",
1148 send_ret);
1149 ret = -1;
1150 }
1151
1152 return ret;
1153 }
1154
1155 /*
1156 * When we have received all the streams and the metadata for a channel,
1157 * we make them visible to the viewer threads.
1158 */
1159 static void publish_connection_local_streams(struct relay_connection *conn)
1160 {
1161 struct relay_stream *stream;
1162 struct relay_session *session = conn->session;
1163
1164 /*
1165 * We publish all streams belonging to a session atomically wrt
1166 * session lock.
1167 */
1168 pthread_mutex_lock(&session->lock);
1169 rcu_read_lock();
1170 cds_list_for_each_entry_rcu(stream, &session->recv_list,
1171 recv_node) {
1172 stream_publish(stream);
1173 }
1174 rcu_read_unlock();
1175
1176 /*
1177 * Inform the viewer that there are new streams in the session.
1178 */
1179 if (session->viewer_attached) {
1180 uatomic_set(&session->new_streams, 1);
1181 }
1182 pthread_mutex_unlock(&session->lock);
1183 }
1184
1185 /*
1186 * relay_add_stream: allocate a new stream for a session
1187 */
1188 static int relay_add_stream(const struct lttcomm_relayd_hdr *recv_hdr,
1189 struct relay_connection *conn,
1190 const struct lttng_buffer_view *payload)
1191 {
1192 int ret;
1193 ssize_t send_ret;
1194 struct relay_session *session = conn->session;
1195 struct relay_stream *stream = NULL;
1196 struct lttcomm_relayd_status_stream reply;
1197 struct ctf_trace *trace = NULL;
1198 uint64_t stream_handle = -1ULL;
1199 char *path_name = NULL, *channel_name = NULL;
1200 uint64_t tracefile_size = 0, tracefile_count = 0;
1201 struct relay_stream_chunk_id stream_chunk_id = { 0 };
1202
1203 if (!session || !conn->version_check_done) {
1204 ERR("Trying to add a stream before version check");
1205 ret = -1;
1206 goto end_no_session;
1207 }
1208
1209 if (session->minor == 1) {
1210 /* For 2.1 */
1211 ret = cmd_recv_stream_2_1(payload, &path_name,
1212 &channel_name);
1213 } else if (session->minor > 1 && session->minor < 11) {
1214 /* From 2.2 to 2.10 */
1215 ret = cmd_recv_stream_2_2(payload, &path_name,
1216 &channel_name, &tracefile_size, &tracefile_count);
1217 } else {
1218 /* From 2.11 to ... */
1219 ret = cmd_recv_stream_2_11(payload, &path_name,
1220 &channel_name, &tracefile_size, &tracefile_count,
1221 &stream_chunk_id.value);
1222 stream_chunk_id.is_set = true;
1223 }
1224
1225 if (ret < 0) {
1226 goto send_reply;
1227 }
1228
1229 trace = ctf_trace_get_by_path_or_create(session, path_name);
1230 if (!trace) {
1231 goto send_reply;
1232 }
1233 /* This stream here has one reference on the trace. */
1234
1235 pthread_mutex_lock(&last_relay_stream_id_lock);
1236 stream_handle = ++last_relay_stream_id;
1237 pthread_mutex_unlock(&last_relay_stream_id_lock);
1238
1239 /* We pass ownership of path_name and channel_name. */
1240 stream = stream_create(trace, stream_handle, path_name,
1241 channel_name, tracefile_size, tracefile_count,
1242 &stream_chunk_id);
1243 path_name = NULL;
1244 channel_name = NULL;
1245
1246 /*
1247 * Streams are the owners of their trace. Reference to trace is
1248 * kept within stream_create().
1249 */
1250 ctf_trace_put(trace);
1251
1252 send_reply:
1253 memset(&reply, 0, sizeof(reply));
1254 reply.handle = htobe64(stream_handle);
1255 if (!stream) {
1256 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1257 } else {
1258 reply.ret_code = htobe32(LTTNG_OK);
1259 }
1260
1261 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1262 sizeof(struct lttcomm_relayd_status_stream), 0);
1263 if (send_ret < (ssize_t) sizeof(reply)) {
1264 ERR("Failed to send \"add stream\" command reply (ret = %zd)",
1265 send_ret);
1266 ret = -1;
1267 }
1268
1269 end_no_session:
1270 free(path_name);
1271 free(channel_name);
1272 return ret;
1273 }
1274
1275 /*
1276 * relay_close_stream: close a specific stream
1277 */
1278 static int relay_close_stream(const struct lttcomm_relayd_hdr *recv_hdr,
1279 struct relay_connection *conn,
1280 const struct lttng_buffer_view *payload)
1281 {
1282 int ret;
1283 ssize_t send_ret;
1284 struct relay_session *session = conn->session;
1285 struct lttcomm_relayd_close_stream stream_info;
1286 struct lttcomm_relayd_generic_reply reply;
1287 struct relay_stream *stream;
1288
1289 DBG("Close stream received");
1290
1291 if (!session || !conn->version_check_done) {
1292 ERR("Trying to close a stream before version check");
1293 ret = -1;
1294 goto end_no_session;
1295 }
1296
1297 if (payload->size < sizeof(stream_info)) {
1298 ERR("Unexpected payload size in \"relay_close_stream\": expected >= %zu bytes, got %zu bytes",
1299 sizeof(stream_info), payload->size);
1300 ret = -1;
1301 goto end_no_session;
1302 }
1303 memcpy(&stream_info, payload->data, sizeof(stream_info));
1304 stream_info.stream_id = be64toh(stream_info.stream_id);
1305 stream_info.last_net_seq_num = be64toh(stream_info.last_net_seq_num);
1306
1307 stream = stream_get_by_id(stream_info.stream_id);
1308 if (!stream) {
1309 ret = -1;
1310 goto end;
1311 }
1312
1313 /*
1314 * Set last_net_seq_num before the close flag. Required by data
1315 * pending check.
1316 */
1317 pthread_mutex_lock(&stream->lock);
1318 stream->last_net_seq_num = stream_info.last_net_seq_num;
1319 pthread_mutex_unlock(&stream->lock);
1320
1321 /*
1322 * This is one of the conditions which may trigger a stream close
1323 * with the others being:
1324 * 1) A close command is received for a stream
1325 * 2) The control connection owning the stream is closed
1326 * 3) We have received all of the stream's data _after_ a close
1327 * request.
1328 */
1329 try_stream_close(stream);
1330 if (stream->is_metadata) {
1331 struct relay_viewer_stream *vstream;
1332
1333 vstream = viewer_stream_get_by_id(stream->stream_handle);
1334 if (vstream) {
1335 if (vstream->metadata_sent == stream->metadata_received) {
1336 /*
1337 * Since all the metadata has been sent to the
1338 * viewer and that we have a request to close
1339 * its stream, we can safely teardown the
1340 * corresponding metadata viewer stream.
1341 */
1342 viewer_stream_put(vstream);
1343 }
1344 /* Put local reference. */
1345 viewer_stream_put(vstream);
1346 }
1347 }
1348 stream_put(stream);
1349 ret = 0;
1350
1351 end:
1352 memset(&reply, 0, sizeof(reply));
1353 if (ret < 0) {
1354 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1355 } else {
1356 reply.ret_code = htobe32(LTTNG_OK);
1357 }
1358 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1359 sizeof(struct lttcomm_relayd_generic_reply), 0);
1360 if (send_ret < (ssize_t) sizeof(reply)) {
1361 ERR("Failed to send \"close stream\" command reply (ret = %zd)",
1362 send_ret);
1363 ret = -1;
1364 }
1365
1366 end_no_session:
1367 return ret;
1368 }
1369
1370 /*
1371 * relay_reset_metadata: reset a metadata stream
1372 */
1373 static
1374 int relay_reset_metadata(const struct lttcomm_relayd_hdr *recv_hdr,
1375 struct relay_connection *conn,
1376 const struct lttng_buffer_view *payload)
1377 {
1378 int ret;
1379 ssize_t send_ret;
1380 struct relay_session *session = conn->session;
1381 struct lttcomm_relayd_reset_metadata stream_info;
1382 struct lttcomm_relayd_generic_reply reply;
1383 struct relay_stream *stream;
1384
1385 DBG("Reset metadata received");
1386
1387 if (!session || !conn->version_check_done) {
1388 ERR("Trying to reset a metadata stream before version check");
1389 ret = -1;
1390 goto end_no_session;
1391 }
1392
1393 if (payload->size < sizeof(stream_info)) {
1394 ERR("Unexpected payload size in \"relay_reset_metadata\": expected >= %zu bytes, got %zu bytes",
1395 sizeof(stream_info), payload->size);
1396 ret = -1;
1397 goto end_no_session;
1398 }
1399 memcpy(&stream_info, payload->data, sizeof(stream_info));
1400 stream_info.stream_id = be64toh(stream_info.stream_id);
1401 stream_info.version = be64toh(stream_info.version);
1402
1403 DBG("Update metadata to version %" PRIu64, stream_info.version);
1404
1405 /* Unsupported for live sessions for now. */
1406 if (session->live_timer != 0) {
1407 ret = -1;
1408 goto end;
1409 }
1410
1411 stream = stream_get_by_id(stream_info.stream_id);
1412 if (!stream) {
1413 ret = -1;
1414 goto end;
1415 }
1416 pthread_mutex_lock(&stream->lock);
1417 if (!stream->is_metadata) {
1418 ret = -1;
1419 goto end_unlock;
1420 }
1421
1422 ret = utils_rotate_stream_file(stream->path_name, stream->channel_name,
1423 0, 0, -1, -1, stream->stream_fd->fd, NULL,
1424 &stream->stream_fd->fd);
1425 if (ret < 0) {
1426 ERR("Failed to rotate metadata file %s of channel %s",
1427 stream->path_name, stream->channel_name);
1428 goto end_unlock;
1429 }
1430
1431 end_unlock:
1432 pthread_mutex_unlock(&stream->lock);
1433 stream_put(stream);
1434
1435 end:
1436 memset(&reply, 0, sizeof(reply));
1437 if (ret < 0) {
1438 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1439 } else {
1440 reply.ret_code = htobe32(LTTNG_OK);
1441 }
1442 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1443 sizeof(struct lttcomm_relayd_generic_reply), 0);
1444 if (send_ret < (ssize_t) sizeof(reply)) {
1445 ERR("Failed to send \"reset metadata\" command reply (ret = %zd)",
1446 send_ret);
1447 ret = -1;
1448 }
1449
1450 end_no_session:
1451 return ret;
1452 }
1453
1454 /*
1455 * relay_unknown_command: send -1 if received unknown command
1456 */
1457 static void relay_unknown_command(struct relay_connection *conn)
1458 {
1459 struct lttcomm_relayd_generic_reply reply;
1460 ssize_t send_ret;
1461
1462 memset(&reply, 0, sizeof(reply));
1463 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1464 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1465 if (send_ret < sizeof(reply)) {
1466 ERR("Failed to send \"unknown command\" command reply (ret = %zd)", send_ret);
1467 }
1468 }
1469
1470 /*
1471 * relay_start: send an acknowledgment to the client to tell if we are
1472 * ready to receive data. We are ready if a session is established.
1473 */
1474 static int relay_start(const struct lttcomm_relayd_hdr *recv_hdr,
1475 struct relay_connection *conn,
1476 const struct lttng_buffer_view *payload)
1477 {
1478 int ret = 0;
1479 ssize_t send_ret;
1480 struct lttcomm_relayd_generic_reply reply;
1481 struct relay_session *session = conn->session;
1482
1483 if (!session) {
1484 DBG("Trying to start the streaming without a session established");
1485 ret = htobe32(LTTNG_ERR_UNK);
1486 }
1487
1488 memset(&reply, 0, sizeof(reply));
1489 reply.ret_code = htobe32(LTTNG_OK);
1490 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1491 sizeof(reply), 0);
1492 if (send_ret < (ssize_t) sizeof(reply)) {
1493 ERR("Failed to send \"relay_start\" command reply (ret = %zd)",
1494 send_ret);
1495 ret = -1;
1496 }
1497
1498 return ret;
1499 }
1500
1501 /*
1502 * Append padding to the file pointed by the file descriptor fd.
1503 */
1504 static int write_padding_to_file(int fd, uint32_t size)
1505 {
1506 ssize_t ret = 0;
1507 char *zeros;
1508
1509 if (size == 0) {
1510 goto end;
1511 }
1512
1513 zeros = zmalloc(size);
1514 if (zeros == NULL) {
1515 PERROR("zmalloc zeros for padding");
1516 ret = -1;
1517 goto end;
1518 }
1519
1520 ret = lttng_write(fd, zeros, size);
1521 if (ret < size) {
1522 PERROR("write padding to file");
1523 }
1524
1525 free(zeros);
1526
1527 end:
1528 return ret;
1529 }
1530
1531 /*
1532 * Close the current index file if it is open, and create a new one.
1533 *
1534 * Return 0 on success, -1 on error.
1535 */
1536 static
1537 int create_rotate_index_file(struct relay_stream *stream)
1538 {
1539 int ret;
1540 uint32_t major, minor;
1541
1542 /* Put ref on previous index_file. */
1543 if (stream->index_file) {
1544 lttng_index_file_put(stream->index_file);
1545 stream->index_file = NULL;
1546 }
1547 major = stream->trace->session->major;
1548 minor = stream->trace->session->minor;
1549 stream->index_file = lttng_index_file_create(stream->path_name,
1550 stream->channel_name,
1551 -1, -1, stream->tracefile_size,
1552 tracefile_array_get_file_index_head(stream->tfa),
1553 lttng_to_index_major(major, minor),
1554 lttng_to_index_minor(major, minor));
1555 if (!stream->index_file) {
1556 ret = -1;
1557 goto end;
1558 }
1559
1560 ret = 0;
1561
1562 end:
1563 return ret;
1564 }
1565
1566 static
1567 int do_rotate_stream(struct relay_stream *stream)
1568 {
1569 int ret;
1570
1571 /* Perform the stream rotation. */
1572 ret = utils_rotate_stream_file(stream->path_name,
1573 stream->channel_name, stream->tracefile_size,
1574 stream->tracefile_count, -1,
1575 -1, stream->stream_fd->fd,
1576 NULL, &stream->stream_fd->fd);
1577 if (ret < 0) {
1578 ERR("Rotating stream output file");
1579 goto end;
1580 }
1581 stream->tracefile_size_current = 0;
1582
1583 /* Rotate also the index if the stream is not a metadata stream. */
1584 if (!stream->is_metadata) {
1585 ret = create_rotate_index_file(stream);
1586 if (ret < 0) {
1587 ERR("Failed to rotate index file");
1588 goto end;
1589 }
1590 }
1591
1592 stream->rotate_at_seq_num = -1ULL;
1593 stream->pos_after_last_complete_data_index = 0;
1594
1595 end:
1596 return ret;
1597 }
1598
1599 /*
1600 * If too much data has been written in a tracefile before we received the
1601 * rotation command, we have to move the excess data to the new tracefile and
1602 * perform the rotation. This can happen because the control and data
1603 * connections are separate, the indexes as well as the commands arrive from
1604 * the control connection and we have no control over the order so we could be
1605 * in a situation where too much data has been received on the data connection
1606 * before the rotation command on the control connection arrives. We don't need
1607 * to update the index because its order is guaranteed with the rotation
1608 * command message.
1609 */
1610 static
1611 int rotate_truncate_stream(struct relay_stream *stream)
1612 {
1613 int ret, new_fd;
1614 off_t lseek_ret;
1615 uint64_t diff, pos = 0;
1616 char buf[FILE_COPY_BUFFER_SIZE];
1617
1618 assert(!stream->is_metadata);
1619
1620 assert(stream->tracefile_size_current >
1621 stream->pos_after_last_complete_data_index);
1622 diff = stream->tracefile_size_current -
1623 stream->pos_after_last_complete_data_index;
1624
1625 /* Create the new tracefile. */
1626 new_fd = utils_create_stream_file(stream->path_name,
1627 stream->channel_name,
1628 stream->tracefile_size, stream->tracefile_count,
1629 /* uid */ -1, /* gid */ -1, /* suffix */ NULL);
1630 if (new_fd < 0) {
1631 ERR("Failed to create new stream file at path %s for channel %s",
1632 stream->path_name, stream->channel_name);
1633 ret = -1;
1634 goto end;
1635 }
1636
1637 /*
1638 * Rewind the current tracefile to the position at which the rotation
1639 * should have occured.
1640 */
1641 lseek_ret = lseek(stream->stream_fd->fd,
1642 stream->pos_after_last_complete_data_index, SEEK_SET);
1643 if (lseek_ret < 0) {
1644 PERROR("seek truncate stream");
1645 ret = -1;
1646 goto end;
1647 }
1648
1649 /* Move data from the old file to the new file. */
1650 while (pos < diff) {
1651 uint64_t count, bytes_left;
1652 ssize_t io_ret;
1653
1654 bytes_left = diff - pos;
1655 count = bytes_left > sizeof(buf) ? sizeof(buf) : bytes_left;
1656 assert(count <= SIZE_MAX);
1657
1658 io_ret = lttng_read(stream->stream_fd->fd, buf, count);
1659 if (io_ret < (ssize_t) count) {
1660 char error_string[256];
1661
1662 snprintf(error_string, sizeof(error_string),
1663 "Failed to read %" PRIu64 " bytes from fd %i in rotate_truncate_stream(), returned %zi",
1664 count, stream->stream_fd->fd, io_ret);
1665 if (io_ret == -1) {
1666 PERROR("%s", error_string);
1667 } else {
1668 ERR("%s", error_string);
1669 }
1670 ret = -1;
1671 goto end;
1672 }
1673
1674 io_ret = lttng_write(new_fd, buf, count);
1675 if (io_ret < (ssize_t) count) {
1676 char error_string[256];
1677
1678 snprintf(error_string, sizeof(error_string),
1679 "Failed to write %" PRIu64 " bytes from fd %i in rotate_truncate_stream(), returned %zi",
1680 count, new_fd, io_ret);
1681 if (io_ret == -1) {
1682 PERROR("%s", error_string);
1683 } else {
1684 ERR("%s", error_string);
1685 }
1686 ret = -1;
1687 goto end;
1688 }
1689
1690 pos += count;
1691 }
1692
1693 /* Truncate the file to get rid of the excess data. */
1694 ret = ftruncate(stream->stream_fd->fd,
1695 stream->pos_after_last_complete_data_index);
1696 if (ret) {
1697 PERROR("ftruncate");
1698 goto end;
1699 }
1700
1701 ret = close(stream->stream_fd->fd);
1702 if (ret < 0) {
1703 PERROR("Closing tracefile");
1704 goto end;
1705 }
1706
1707 ret = create_rotate_index_file(stream);
1708 if (ret < 0) {
1709 ERR("Rotate stream index file");
1710 goto end;
1711 }
1712
1713 /*
1714 * Update the offset and FD of all the eventual indexes created by the
1715 * data connection before the rotation command arrived.
1716 */
1717 ret = relay_index_switch_all_files(stream);
1718 if (ret < 0) {
1719 ERR("Failed to rotate index file");
1720 goto end;
1721 }
1722
1723 stream->stream_fd->fd = new_fd;
1724 stream->tracefile_size_current = diff;
1725 stream->pos_after_last_complete_data_index = 0;
1726 stream->rotate_at_seq_num = -1ULL;
1727
1728 ret = 0;
1729
1730 end:
1731 return ret;
1732 }
1733
1734 /*
1735 * Check if a stream should perform a rotation (for session rotation).
1736 * Must be called with the stream lock held.
1737 *
1738 * Return 0 on success, a negative value on error.
1739 */
1740 static
1741 int try_rotate_stream(struct relay_stream *stream)
1742 {
1743 int ret = 0;
1744
1745 /* No rotation expected. */
1746 if (stream->rotate_at_seq_num == -1ULL) {
1747 goto end;
1748 }
1749
1750 if (stream->prev_seq < stream->rotate_at_seq_num ||
1751 stream->prev_seq == -1ULL) {
1752 DBG("Stream %" PRIu64 " no yet ready for rotation",
1753 stream->stream_handle);
1754 goto end;
1755 } else if (stream->prev_seq > stream->rotate_at_seq_num) {
1756 DBG("Rotation after too much data has been written in tracefile "
1757 "for stream %" PRIu64 ", need to truncate before "
1758 "rotating", stream->stream_handle);
1759 ret = rotate_truncate_stream(stream);
1760 if (ret) {
1761 ERR("Failed to truncate stream");
1762 goto end;
1763 }
1764 } else {
1765 /* stream->prev_seq == stream->rotate_at_seq_num */
1766 DBG("Stream %" PRIu64 " ready for rotation",
1767 stream->stream_handle);
1768 ret = do_rotate_stream(stream);
1769 }
1770
1771 end:
1772 return ret;
1773 }
1774
1775 /*
1776 * relay_recv_metadata: receive the metadata for the session.
1777 */
1778 static int relay_recv_metadata(const struct lttcomm_relayd_hdr *recv_hdr,
1779 struct relay_connection *conn,
1780 const struct lttng_buffer_view *payload)
1781 {
1782 int ret = 0;
1783 ssize_t size_ret;
1784 struct relay_session *session = conn->session;
1785 struct lttcomm_relayd_metadata_payload metadata_payload_header;
1786 struct relay_stream *metadata_stream;
1787 uint64_t metadata_payload_size;
1788
1789 if (!session) {
1790 ERR("Metadata sent before version check");
1791 ret = -1;
1792 goto end;
1793 }
1794
1795 if (recv_hdr->data_size < sizeof(struct lttcomm_relayd_metadata_payload)) {
1796 ERR("Incorrect data size");
1797 ret = -1;
1798 goto end;
1799 }
1800 metadata_payload_size = recv_hdr->data_size -
1801 sizeof(struct lttcomm_relayd_metadata_payload);
1802
1803 memcpy(&metadata_payload_header, payload->data,
1804 sizeof(metadata_payload_header));
1805 metadata_payload_header.stream_id = be64toh(
1806 metadata_payload_header.stream_id);
1807 metadata_payload_header.padding_size = be32toh(
1808 metadata_payload_header.padding_size);
1809
1810 metadata_stream = stream_get_by_id(metadata_payload_header.stream_id);
1811 if (!metadata_stream) {
1812 ret = -1;
1813 goto end;
1814 }
1815
1816 pthread_mutex_lock(&metadata_stream->lock);
1817
1818 size_ret = lttng_write(metadata_stream->stream_fd->fd,
1819 payload->data + sizeof(metadata_payload_header),
1820 metadata_payload_size);
1821 if (size_ret < metadata_payload_size) {
1822 ERR("Relay error writing metadata on file");
1823 ret = -1;
1824 goto end_put;
1825 }
1826
1827 size_ret = write_padding_to_file(metadata_stream->stream_fd->fd,
1828 metadata_payload_header.padding_size);
1829 if (size_ret < (int64_t) metadata_payload_header.padding_size) {
1830 ret = -1;
1831 goto end_put;
1832 }
1833
1834 metadata_stream->metadata_received +=
1835 metadata_payload_size + metadata_payload_header.padding_size;
1836 DBG2("Relay metadata written. Updated metadata_received %" PRIu64,
1837 metadata_stream->metadata_received);
1838
1839 ret = try_rotate_stream(metadata_stream);
1840 if (ret < 0) {
1841 goto end_put;
1842 }
1843
1844 end_put:
1845 pthread_mutex_unlock(&metadata_stream->lock);
1846 stream_put(metadata_stream);
1847 end:
1848 return ret;
1849 }
1850
1851 /*
1852 * relay_send_version: send relayd version number
1853 */
1854 static int relay_send_version(const struct lttcomm_relayd_hdr *recv_hdr,
1855 struct relay_connection *conn,
1856 const struct lttng_buffer_view *payload)
1857 {
1858 int ret;
1859 ssize_t send_ret;
1860 struct lttcomm_relayd_version reply, msg;
1861 bool compatible = true;
1862
1863 conn->version_check_done = true;
1864
1865 /* Get version from the other side. */
1866 if (payload->size < sizeof(msg)) {
1867 ERR("Unexpected payload size in \"relay_send_version\": expected >= %zu bytes, got %zu bytes",
1868 sizeof(msg), payload->size);
1869 ret = -1;
1870 goto end;
1871 }
1872
1873 memcpy(&msg, payload->data, sizeof(msg));
1874 msg.major = be32toh(msg.major);
1875 msg.minor = be32toh(msg.minor);
1876
1877 memset(&reply, 0, sizeof(reply));
1878 reply.major = RELAYD_VERSION_COMM_MAJOR;
1879 reply.minor = RELAYD_VERSION_COMM_MINOR;
1880
1881 /* Major versions must be the same */
1882 if (reply.major != msg.major) {
1883 DBG("Incompatible major versions (%u vs %u), deleting session",
1884 reply.major, msg.major);
1885 compatible = false;
1886 }
1887
1888 conn->major = reply.major;
1889 /* We adapt to the lowest compatible version */
1890 if (reply.minor <= msg.minor) {
1891 conn->minor = reply.minor;
1892 } else {
1893 conn->minor = msg.minor;
1894 }
1895
1896 reply.major = htobe32(reply.major);
1897 reply.minor = htobe32(reply.minor);
1898 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1899 sizeof(reply), 0);
1900 if (send_ret < (ssize_t) sizeof(reply)) {
1901 ERR("Failed to send \"send version\" command reply (ret = %zd)",
1902 send_ret);
1903 ret = -1;
1904 goto end;
1905 } else {
1906 ret = 0;
1907 }
1908
1909 if (!compatible) {
1910 ret = -1;
1911 goto end;
1912 }
1913
1914 DBG("Version check done using protocol %u.%u", conn->major,
1915 conn->minor);
1916
1917 end:
1918 return ret;
1919 }
1920
1921 /*
1922 * Check for data pending for a given stream id from the session daemon.
1923 */
1924 static int relay_data_pending(const struct lttcomm_relayd_hdr *recv_hdr,
1925 struct relay_connection *conn,
1926 const struct lttng_buffer_view *payload)
1927 {
1928 struct relay_session *session = conn->session;
1929 struct lttcomm_relayd_data_pending msg;
1930 struct lttcomm_relayd_generic_reply reply;
1931 struct relay_stream *stream;
1932 ssize_t send_ret;
1933 int ret;
1934
1935 DBG("Data pending command received");
1936
1937 if (!session || !conn->version_check_done) {
1938 ERR("Trying to check for data before version check");
1939 ret = -1;
1940 goto end_no_session;
1941 }
1942
1943 if (payload->size < sizeof(msg)) {
1944 ERR("Unexpected payload size in \"relay_data_pending\": expected >= %zu bytes, got %zu bytes",
1945 sizeof(msg), payload->size);
1946 ret = -1;
1947 goto end_no_session;
1948 }
1949 memcpy(&msg, payload->data, sizeof(msg));
1950 msg.stream_id = be64toh(msg.stream_id);
1951 msg.last_net_seq_num = be64toh(msg.last_net_seq_num);
1952
1953 stream = stream_get_by_id(msg.stream_id);
1954 if (stream == NULL) {
1955 ret = -1;
1956 goto end;
1957 }
1958
1959 pthread_mutex_lock(&stream->lock);
1960
1961 DBG("Data pending for stream id %" PRIu64 " prev_seq %" PRIu64
1962 " and last_seq %" PRIu64, msg.stream_id,
1963 stream->prev_seq, msg.last_net_seq_num);
1964
1965 /* Avoid wrapping issue */
1966 if (((int64_t) (stream->prev_seq - msg.last_net_seq_num)) >= 0) {
1967 /* Data has in fact been written and is NOT pending */
1968 ret = 0;
1969 } else {
1970 /* Data still being streamed thus pending */
1971 ret = 1;
1972 }
1973
1974 stream->data_pending_check_done = true;
1975 pthread_mutex_unlock(&stream->lock);
1976
1977 stream_put(stream);
1978 end:
1979
1980 memset(&reply, 0, sizeof(reply));
1981 reply.ret_code = htobe32(ret);
1982 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1983 if (send_ret < (ssize_t) sizeof(reply)) {
1984 ERR("Failed to send \"data pending\" command reply (ret = %zd)",
1985 send_ret);
1986 ret = -1;
1987 }
1988
1989 end_no_session:
1990 return ret;
1991 }
1992
1993 /*
1994 * Wait for the control socket to reach a quiescent state.
1995 *
1996 * Note that for now, when receiving this command from the session
1997 * daemon, this means that every subsequent commands or data received on
1998 * the control socket has been handled. So, this is why we simply return
1999 * OK here.
2000 */
2001 static int relay_quiescent_control(const struct lttcomm_relayd_hdr *recv_hdr,
2002 struct relay_connection *conn,
2003 const struct lttng_buffer_view *payload)
2004 {
2005 int ret;
2006 ssize_t send_ret;
2007 struct relay_stream *stream;
2008 struct lttcomm_relayd_quiescent_control msg;
2009 struct lttcomm_relayd_generic_reply reply;
2010
2011 DBG("Checking quiescent state on control socket");
2012
2013 if (!conn->session || !conn->version_check_done) {
2014 ERR("Trying to check for data before version check");
2015 ret = -1;
2016 goto end_no_session;
2017 }
2018
2019 if (payload->size < sizeof(msg)) {
2020 ERR("Unexpected payload size in \"relay_quiescent_control\": expected >= %zu bytes, got %zu bytes",
2021 sizeof(msg), payload->size);
2022 ret = -1;
2023 goto end_no_session;
2024 }
2025 memcpy(&msg, payload->data, sizeof(msg));
2026 msg.stream_id = be64toh(msg.stream_id);
2027
2028 stream = stream_get_by_id(msg.stream_id);
2029 if (!stream) {
2030 goto reply;
2031 }
2032 pthread_mutex_lock(&stream->lock);
2033 stream->data_pending_check_done = true;
2034 pthread_mutex_unlock(&stream->lock);
2035
2036 DBG("Relay quiescent control pending flag set to %" PRIu64, msg.stream_id);
2037 stream_put(stream);
2038 reply:
2039 memset(&reply, 0, sizeof(reply));
2040 reply.ret_code = htobe32(LTTNG_OK);
2041 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2042 if (send_ret < (ssize_t) sizeof(reply)) {
2043 ERR("Failed to send \"quiescent control\" command reply (ret = %zd)",
2044 send_ret);
2045 ret = -1;
2046 } else {
2047 ret = 0;
2048 }
2049
2050 end_no_session:
2051 return ret;
2052 }
2053
2054 /*
2055 * Initialize a data pending command. This means that a consumer is about
2056 * to ask for data pending for each stream it holds. Simply iterate over
2057 * all streams of a session and set the data_pending_check_done flag.
2058 *
2059 * This command returns to the client a LTTNG_OK code.
2060 */
2061 static int relay_begin_data_pending(const struct lttcomm_relayd_hdr *recv_hdr,
2062 struct relay_connection *conn,
2063 const struct lttng_buffer_view *payload)
2064 {
2065 int ret;
2066 ssize_t send_ret;
2067 struct lttng_ht_iter iter;
2068 struct lttcomm_relayd_begin_data_pending msg;
2069 struct lttcomm_relayd_generic_reply reply;
2070 struct relay_stream *stream;
2071
2072 assert(recv_hdr);
2073 assert(conn);
2074
2075 DBG("Init streams for data pending");
2076
2077 if (!conn->session || !conn->version_check_done) {
2078 ERR("Trying to check for data before version check");
2079 ret = -1;
2080 goto end_no_session;
2081 }
2082
2083 if (payload->size < sizeof(msg)) {
2084 ERR("Unexpected payload size in \"relay_begin_data_pending\": expected >= %zu bytes, got %zu bytes",
2085 sizeof(msg), payload->size);
2086 ret = -1;
2087 goto end_no_session;
2088 }
2089 memcpy(&msg, payload->data, sizeof(msg));
2090 msg.session_id = be64toh(msg.session_id);
2091
2092 /*
2093 * Iterate over all streams to set the begin data pending flag.
2094 * For now, the streams are indexed by stream handle so we have
2095 * to iterate over all streams to find the one associated with
2096 * the right session_id.
2097 */
2098 rcu_read_lock();
2099 cds_lfht_for_each_entry(relay_streams_ht->ht, &iter.iter, stream,
2100 node.node) {
2101 if (!stream_get(stream)) {
2102 continue;
2103 }
2104 if (stream->trace->session->id == msg.session_id) {
2105 pthread_mutex_lock(&stream->lock);
2106 stream->data_pending_check_done = false;
2107 pthread_mutex_unlock(&stream->lock);
2108 DBG("Set begin data pending flag to stream %" PRIu64,
2109 stream->stream_handle);
2110 }
2111 stream_put(stream);
2112 }
2113 rcu_read_unlock();
2114
2115 memset(&reply, 0, sizeof(reply));
2116 /* All good, send back reply. */
2117 reply.ret_code = htobe32(LTTNG_OK);
2118
2119 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2120 if (send_ret < (ssize_t) sizeof(reply)) {
2121 ERR("Failed to send \"begin data pending\" command reply (ret = %zd)",
2122 send_ret);
2123 ret = -1;
2124 } else {
2125 ret = 0;
2126 }
2127
2128 end_no_session:
2129 return ret;
2130 }
2131
2132 /*
2133 * End data pending command. This will check, for a given session id, if
2134 * each stream associated with it has its data_pending_check_done flag
2135 * set. If not, this means that the client lost track of the stream but
2136 * the data is still being streamed on our side. In this case, we inform
2137 * the client that data is in flight.
2138 *
2139 * Return to the client if there is data in flight or not with a ret_code.
2140 */
2141 static int relay_end_data_pending(const struct lttcomm_relayd_hdr *recv_hdr,
2142 struct relay_connection *conn,
2143 const struct lttng_buffer_view *payload)
2144 {
2145 int ret;
2146 ssize_t send_ret;
2147 struct lttng_ht_iter iter;
2148 struct lttcomm_relayd_end_data_pending msg;
2149 struct lttcomm_relayd_generic_reply reply;
2150 struct relay_stream *stream;
2151 uint32_t is_data_inflight = 0;
2152
2153 DBG("End data pending command");
2154
2155 if (!conn->session || !conn->version_check_done) {
2156 ERR("Trying to check for data before version check");
2157 ret = -1;
2158 goto end_no_session;
2159 }
2160
2161 if (payload->size < sizeof(msg)) {
2162 ERR("Unexpected payload size in \"relay_end_data_pending\": expected >= %zu bytes, got %zu bytes",
2163 sizeof(msg), payload->size);
2164 ret = -1;
2165 goto end_no_session;
2166 }
2167 memcpy(&msg, payload->data, sizeof(msg));
2168 msg.session_id = be64toh(msg.session_id);
2169
2170 /*
2171 * Iterate over all streams to see if the begin data pending
2172 * flag is set.
2173 */
2174 rcu_read_lock();
2175 cds_lfht_for_each_entry(relay_streams_ht->ht, &iter.iter, stream,
2176 node.node) {
2177 if (!stream_get(stream)) {
2178 continue;
2179 }
2180 if (stream->trace->session->id != msg.session_id) {
2181 stream_put(stream);
2182 continue;
2183 }
2184 pthread_mutex_lock(&stream->lock);
2185 if (!stream->data_pending_check_done) {
2186 if (!stream->closed || !(((int64_t) (stream->prev_seq - stream->last_net_seq_num)) >= 0)) {
2187 is_data_inflight = 1;
2188 DBG("Data is still in flight for stream %" PRIu64,
2189 stream->stream_handle);
2190 pthread_mutex_unlock(&stream->lock);
2191 stream_put(stream);
2192 break;
2193 }
2194 }
2195 pthread_mutex_unlock(&stream->lock);
2196 stream_put(stream);
2197 }
2198 rcu_read_unlock();
2199
2200 memset(&reply, 0, sizeof(reply));
2201 /* All good, send back reply. */
2202 reply.ret_code = htobe32(is_data_inflight);
2203
2204 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2205 if (send_ret < (ssize_t) sizeof(reply)) {
2206 ERR("Failed to send \"end data pending\" command reply (ret = %zd)",
2207 send_ret);
2208 ret = -1;
2209 } else {
2210 ret = 0;
2211 }
2212
2213 end_no_session:
2214 return ret;
2215 }
2216
2217 /*
2218 * Receive an index for a specific stream.
2219 *
2220 * Return 0 on success else a negative value.
2221 */
2222 static int relay_recv_index(const struct lttcomm_relayd_hdr *recv_hdr,
2223 struct relay_connection *conn,
2224 const struct lttng_buffer_view *payload)
2225 {
2226 int ret;
2227 ssize_t send_ret;
2228 struct relay_session *session = conn->session;
2229 struct lttcomm_relayd_index index_info;
2230 struct relay_index *index;
2231 struct lttcomm_relayd_generic_reply reply;
2232 struct relay_stream *stream;
2233 size_t msg_len;
2234
2235 assert(conn);
2236
2237 DBG("Relay receiving index");
2238
2239 if (!session || !conn->version_check_done) {
2240 ERR("Trying to close a stream before version check");
2241 ret = -1;
2242 goto end_no_session;
2243 }
2244
2245 msg_len = lttcomm_relayd_index_len(
2246 lttng_to_index_major(conn->major, conn->minor),
2247 lttng_to_index_minor(conn->major, conn->minor));
2248 if (payload->size < msg_len) {
2249 ERR("Unexpected payload size in \"relay_recv_index\": expected >= %zu bytes, got %zu bytes",
2250 msg_len, payload->size);
2251 ret = -1;
2252 goto end_no_session;
2253 }
2254 memcpy(&index_info, payload->data, msg_len);
2255 index_info.relay_stream_id = be64toh(index_info.relay_stream_id);
2256 index_info.net_seq_num = be64toh(index_info.net_seq_num);
2257 index_info.packet_size = be64toh(index_info.packet_size);
2258 index_info.content_size = be64toh(index_info.content_size);
2259 index_info.timestamp_begin = be64toh(index_info.timestamp_begin);
2260 index_info.timestamp_end = be64toh(index_info.timestamp_end);
2261 index_info.events_discarded = be64toh(index_info.events_discarded);
2262 index_info.stream_id = be64toh(index_info.stream_id);
2263
2264 if (conn->minor >= 8) {
2265 index_info.stream_instance_id =
2266 be64toh(index_info.stream_instance_id);
2267 index_info.packet_seq_num = be64toh(index_info.packet_seq_num);
2268 }
2269
2270 stream = stream_get_by_id(index_info.relay_stream_id);
2271 if (!stream) {
2272 ERR("stream_get_by_id not found");
2273 ret = -1;
2274 goto end;
2275 }
2276 pthread_mutex_lock(&stream->lock);
2277
2278 /* Live beacon handling */
2279 if (index_info.packet_size == 0) {
2280 DBG("Received live beacon for stream %" PRIu64,
2281 stream->stream_handle);
2282
2283 /*
2284 * Only flag a stream inactive when it has already
2285 * received data and no indexes are in flight.
2286 */
2287 if (stream->index_received_seqcount > 0
2288 && stream->indexes_in_flight == 0) {
2289 stream->beacon_ts_end = index_info.timestamp_end;
2290 }
2291 ret = 0;
2292 goto end_stream_put;
2293 } else {
2294 stream->beacon_ts_end = -1ULL;
2295 }
2296
2297 if (stream->ctf_stream_id == -1ULL) {
2298 stream->ctf_stream_id = index_info.stream_id;
2299 }
2300 index = relay_index_get_by_id_or_create(stream, index_info.net_seq_num);
2301 if (!index) {
2302 ret = -1;
2303 ERR("relay_index_get_by_id_or_create index NULL");
2304 goto end_stream_put;
2305 }
2306 if (set_index_control_data(index, &index_info, conn)) {
2307 ERR("set_index_control_data error");
2308 relay_index_put(index);
2309 ret = -1;
2310 goto end_stream_put;
2311 }
2312 ret = relay_index_try_flush(index);
2313 if (ret == 0) {
2314 tracefile_array_commit_seq(stream->tfa);
2315 stream->index_received_seqcount++;
2316 stream->pos_after_last_complete_data_index += index->total_size;
2317 } else if (ret > 0) {
2318 /* no flush. */
2319 ret = 0;
2320 } else {
2321 ERR("relay_index_try_flush error %d", ret);
2322 relay_index_put(index);
2323 ret = -1;
2324 }
2325
2326 end_stream_put:
2327 pthread_mutex_unlock(&stream->lock);
2328 stream_put(stream);
2329
2330 end:
2331
2332 memset(&reply, 0, sizeof(reply));
2333 if (ret < 0) {
2334 reply.ret_code = htobe32(LTTNG_ERR_UNK);
2335 } else {
2336 reply.ret_code = htobe32(LTTNG_OK);
2337 }
2338 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2339 if (send_ret < (ssize_t) sizeof(reply)) {
2340 ERR("Failed to send \"recv index\" command reply (ret = %zd)", send_ret);
2341 ret = -1;
2342 }
2343
2344 end_no_session:
2345 return ret;
2346 }
2347
2348 /*
2349 * Receive the streams_sent message.
2350 *
2351 * Return 0 on success else a negative value.
2352 */
2353 static int relay_streams_sent(const struct lttcomm_relayd_hdr *recv_hdr,
2354 struct relay_connection *conn,
2355 const struct lttng_buffer_view *payload)
2356 {
2357 int ret;
2358 ssize_t send_ret;
2359 struct lttcomm_relayd_generic_reply reply;
2360
2361 assert(conn);
2362
2363 DBG("Relay receiving streams_sent");
2364
2365 if (!conn->session || !conn->version_check_done) {
2366 ERR("Trying to close a stream before version check");
2367 ret = -1;
2368 goto end_no_session;
2369 }
2370
2371 /*
2372 * Publish every pending stream in the connection recv list which are
2373 * now ready to be used by the viewer.
2374 */
2375 publish_connection_local_streams(conn);
2376
2377 memset(&reply, 0, sizeof(reply));
2378 reply.ret_code = htobe32(LTTNG_OK);
2379 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2380 if (send_ret < (ssize_t) sizeof(reply)) {
2381 ERR("Failed to send \"streams sent\" command reply (ret = %zd)",
2382 send_ret);
2383 ret = -1;
2384 } else {
2385 /* Success. */
2386 ret = 0;
2387 }
2388
2389 end_no_session:
2390 return ret;
2391 }
2392
2393 /*
2394 * relay_rotate_session_stream: rotate a stream to a new tracefile for the session
2395 * rotation feature (not the tracefile rotation feature).
2396 */
2397 static int relay_rotate_session_stream(const struct lttcomm_relayd_hdr *recv_hdr,
2398 struct relay_connection *conn,
2399 const struct lttng_buffer_view *payload)
2400 {
2401 int ret;
2402 ssize_t send_ret;
2403 struct relay_session *session = conn->session;
2404 struct lttcomm_relayd_rotate_stream stream_info;
2405 struct lttcomm_relayd_generic_reply reply;
2406 struct relay_stream *stream;
2407 size_t header_len;
2408 size_t path_len;
2409 struct lttng_buffer_view new_path_view;
2410
2411 DBG("Rotate stream received");
2412
2413 if (!session || !conn->version_check_done) {
2414 ERR("Trying to rotate a stream before version check");
2415 ret = -1;
2416 goto end_no_reply;
2417 }
2418
2419 if (session->major == 2 && session->minor < 11) {
2420 ERR("Unsupported feature before 2.11");
2421 ret = -1;
2422 goto end_no_reply;
2423 }
2424
2425 header_len = sizeof(struct lttcomm_relayd_rotate_stream);
2426
2427 if (payload->size < header_len) {
2428 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected >= %zu bytes, got %zu bytes",
2429 header_len, payload->size);
2430 ret = -1;
2431 goto end_no_reply;
2432 }
2433
2434 memcpy(&stream_info, payload->data, header_len);
2435
2436 /* Convert to host */
2437 stream_info.pathname_length = be32toh(stream_info.pathname_length);
2438 stream_info.stream_id = be64toh(stream_info.stream_id);
2439 stream_info.new_chunk_id = be64toh(stream_info.new_chunk_id);
2440 stream_info.rotate_at_seq_num = be64toh(stream_info.rotate_at_seq_num);
2441
2442 path_len = stream_info.pathname_length;
2443 if (payload->size < header_len + path_len) {
2444 ERR("Unexpected payload size in \"relay_rotate_session_stream\" including path: expected >= %zu bytes, got %zu bytes",
2445 header_len + path_len, payload->size);
2446 ret = -1;
2447 goto end_no_reply;
2448 }
2449
2450 /* Ensure it fits in local filename length. */
2451 if (path_len >= LTTNG_PATH_MAX) {
2452 ret = -ENAMETOOLONG;
2453 ERR("Length of relay_rotate_session_stream command's path name (%zu bytes) exceeds the maximal allowed length of %i bytes",
2454 path_len, LTTNG_PATH_MAX);
2455 goto end;
2456 }
2457
2458 new_path_view = lttng_buffer_view_from_view(payload, header_len,
2459 stream_info.pathname_length);
2460
2461 stream = stream_get_by_id(stream_info.stream_id);
2462 if (!stream) {
2463 ret = -1;
2464 goto end;
2465 }
2466
2467 pthread_mutex_lock(&stream->lock);
2468
2469 /*
2470 * Update the trace path (just the folder, the stream name does not
2471 * change).
2472 */
2473 free(stream->path_name);
2474 stream->path_name = create_output_path(new_path_view.data);
2475 if (!stream->path_name) {
2476 ERR("Failed to create a new output path");
2477 ret = -1;
2478 goto end_stream_unlock;
2479 }
2480 ret = utils_mkdir_recursive(stream->path_name, S_IRWXU | S_IRWXG,
2481 -1, -1);
2482 if (ret < 0) {
2483 ERR("relay creating output directory");
2484 ret = -1;
2485 goto end_stream_unlock;
2486 }
2487
2488 assert(stream->current_chunk_id.is_set);
2489 stream->current_chunk_id.value = stream_info.new_chunk_id;
2490
2491 if (stream->is_metadata) {
2492 /*
2493 * The metadata stream is sent only over the control connection
2494 * so we know we have all the data to perform the stream
2495 * rotation.
2496 */
2497 ret = do_rotate_stream(stream);
2498 } else {
2499 stream->rotate_at_seq_num = stream_info.rotate_at_seq_num;
2500 ret = try_rotate_stream(stream);
2501 }
2502 if (ret < 0) {
2503 goto end_stream_unlock;
2504 }
2505
2506 end_stream_unlock:
2507 pthread_mutex_unlock(&stream->lock);
2508 stream_put(stream);
2509 end:
2510 memset(&reply, 0, sizeof(reply));
2511 if (ret < 0) {
2512 reply.ret_code = htobe32(LTTNG_ERR_UNK);
2513 } else {
2514 reply.ret_code = htobe32(LTTNG_OK);
2515 }
2516 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
2517 sizeof(struct lttcomm_relayd_generic_reply), 0);
2518 if (send_ret < (ssize_t) sizeof(reply)) {
2519 ERR("Failed to send \"rotate session stream\" command reply (ret = %zd)",
2520 send_ret);
2521 ret = -1;
2522 }
2523
2524 end_no_reply:
2525 return ret;
2526 }
2527
2528 /*
2529 * relay_mkdir: Create a folder on the disk.
2530 */
2531 static int relay_mkdir(const struct lttcomm_relayd_hdr *recv_hdr,
2532 struct relay_connection *conn,
2533 const struct lttng_buffer_view *payload)
2534 {
2535 int ret;
2536 struct relay_session *session = conn->session;
2537 struct lttcomm_relayd_mkdir path_info_header;
2538 struct lttcomm_relayd_generic_reply reply;
2539 char *path = NULL;
2540 size_t header_len;
2541 ssize_t send_ret;
2542 struct lttng_buffer_view path_view;
2543
2544 if (!session || !conn->version_check_done) {
2545 ERR("Trying to create a directory before version check");
2546 ret = -1;
2547 goto end_no_session;
2548 }
2549
2550 if (session->major == 2 && session->minor < 11) {
2551 /*
2552 * This client is not supposed to use this command since
2553 * it predates its introduction.
2554 */
2555 ERR("relay_mkdir command is unsupported before LTTng 2.11");
2556 ret = -1;
2557 goto end_no_session;
2558 }
2559
2560 header_len = sizeof(path_info_header);
2561 if (payload->size < header_len) {
2562 ERR("Unexpected payload size in \"relay_mkdir\": expected >= %zu bytes, got %zu bytes",
2563 header_len, payload->size);
2564 ret = -1;
2565 goto end_no_session;
2566 }
2567
2568 memcpy(&path_info_header, payload->data, header_len);
2569
2570 path_info_header.length = be32toh(path_info_header.length);
2571
2572 if (payload->size < header_len + path_info_header.length) {
2573 ERR("Unexpected payload size in \"relay_mkdir\" including path: expected >= %zu bytes, got %zu bytes",
2574 header_len + path_info_header.length, payload->size);
2575 ret = -1;
2576 goto end_no_session;
2577 }
2578
2579 /* Ensure that it fits in local path length. */
2580 if (path_info_header.length >= LTTNG_PATH_MAX) {
2581 ret = -ENAMETOOLONG;
2582 ERR("Path name argument of mkdir command (%" PRIu32 " bytes) exceeds the maximal length allowed (%d bytes)",
2583 path_info_header.length, LTTNG_PATH_MAX);
2584 goto end;
2585 }
2586
2587 path_view = lttng_buffer_view_from_view(payload, header_len,
2588 path_info_header.length);
2589
2590 path = create_output_path(path_view.data);
2591 if (!path) {
2592 ERR("Failed to create output path");
2593 ret = -1;
2594 goto end;
2595 }
2596
2597 ret = utils_mkdir_recursive(path, S_IRWXU | S_IRWXG, -1, -1);
2598 if (ret < 0) {
2599 ERR("relay creating output directory");
2600 goto end;
2601 }
2602
2603 ret = 0;
2604
2605 end:
2606 memset(&reply, 0, sizeof(reply));
2607 if (ret < 0) {
2608 reply.ret_code = htobe32(LTTNG_ERR_UNK);
2609 } else {
2610 reply.ret_code = htobe32(LTTNG_OK);
2611 }
2612 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2613 if (send_ret < (ssize_t) sizeof(reply)) {
2614 ERR("Failed to send \"mkdir\" command reply (ret = %zd)", send_ret);
2615 ret = -1;
2616 }
2617
2618 end_no_session:
2619 free(path);
2620 return ret;
2621 }
2622
2623 static int validate_rotate_rename_path_length(const char *path_type,
2624 uint32_t path_length)
2625 {
2626 int ret = 0;
2627
2628 if (path_length > LTTNG_PATH_MAX) {
2629 ret = -ENAMETOOLONG;
2630 ERR("rotate rename \"%s\" path name length (%" PRIu32 " bytes) exceeds the allowed size of %i bytes",
2631 path_type, path_length, LTTNG_PATH_MAX);
2632 } else if (path_length == 0) {
2633 ret = -EINVAL;
2634 ERR("rotate rename \"%s\" path name has an illegal length of 0", path_type);
2635 }
2636 return ret;
2637 }
2638
2639 /*
2640 * relay_rotate_rename: rename the trace folder after a rotation is
2641 * completed. We are not closing any fd here, just moving the folder, so it
2642 * works even if data is still in-flight.
2643 */
2644 static int relay_rotate_rename(const struct lttcomm_relayd_hdr *recv_hdr,
2645 struct relay_connection *conn,
2646 const struct lttng_buffer_view *payload)
2647 {
2648 int ret;
2649 ssize_t send_ret;
2650 struct relay_session *session = conn->session;
2651 struct lttcomm_relayd_generic_reply reply;
2652 struct lttcomm_relayd_rotate_rename header;
2653 size_t header_len;
2654 size_t received_paths_size;
2655 char *complete_old_path = NULL, *complete_new_path = NULL;
2656 struct lttng_buffer_view old_path_view;
2657 struct lttng_buffer_view new_path_view;
2658
2659 if (!session || !conn->version_check_done) {
2660 ERR("Trying to rename a trace folder before version check");
2661 ret = -1;
2662 goto end_no_reply;
2663 }
2664
2665 if (session->major == 2 && session->minor < 11) {
2666 ERR("relay_rotate_rename command is unsupported before LTTng 2.11");
2667 ret = -1;
2668 goto end_no_reply;
2669 }
2670
2671 header_len = sizeof(header);
2672 if (payload->size < header_len) {
2673 ERR("Unexpected payload size in \"relay_rotate_rename\": expected >= %zu bytes, got %zu bytes",
2674 header_len, payload->size);
2675 ret = -1;
2676 goto end_no_reply;
2677 }
2678
2679 memcpy(&header, payload->data, header_len);
2680
2681 header.old_path_length = be32toh(header.old_path_length);
2682 header.new_path_length = be32toh(header.new_path_length);
2683 received_paths_size = header.old_path_length + header.new_path_length;
2684
2685 if (payload->size < header_len + received_paths_size) {
2686 ERR("Unexpected payload size in \"relay_rotate_rename\" including paths: expected >= %zu bytes, got %zu bytes",
2687 header_len, payload->size);
2688 ret = -1;
2689 goto end_no_reply;
2690 }
2691
2692 /* Ensure the paths don't exceed their allowed size. */
2693 ret = validate_rotate_rename_path_length("old", header.old_path_length);
2694 if (ret) {
2695 goto end;
2696 }
2697 ret = validate_rotate_rename_path_length("new", header.new_path_length);
2698 if (ret) {
2699 goto end;
2700 }
2701
2702 old_path_view = lttng_buffer_view_from_view(payload, header_len,
2703 header.old_path_length);
2704 new_path_view = lttng_buffer_view_from_view(payload,
2705 header_len + header.old_path_length,
2706 header.new_path_length);
2707
2708 /* Validate that both paths received are NULL terminated. */
2709 if (old_path_view.data[old_path_view.size - 1] != '\0') {
2710 ERR("relay_rotate_rename command's \"old\" path is invalid (not NULL terminated)");
2711 ret = -1;
2712 goto end;
2713 }
2714 if (new_path_view.data[new_path_view.size - 1] != '\0') {
2715 ERR("relay_rotate_rename command's \"new\" path is invalid (not NULL terminated)");
2716 ret = -1;
2717 goto end;
2718 }
2719
2720 complete_old_path = create_output_path(old_path_view.data);
2721 if (!complete_old_path) {
2722 ERR("Failed to build old output path in rotate_rename command");
2723 ret = -1;
2724 goto end;
2725 }
2726
2727 complete_new_path = create_output_path(new_path_view.data);
2728 if (!complete_new_path) {
2729 ERR("Failed to build new output path in rotate_rename command");
2730 ret = -1;
2731 goto end;
2732 }
2733
2734 ret = utils_mkdir_recursive(complete_new_path, S_IRWXU | S_IRWXG,
2735 -1, -1);
2736 if (ret < 0) {
2737 ERR("Failed to mkdir() rotate_rename's \"new\" output directory at \"%s\"",
2738 complete_new_path);
2739 goto end;
2740 }
2741
2742 /*
2743 * If a domain has not yet created its channel, the domain-specific
2744 * folder might not exist, but this is not an error.
2745 */
2746 ret = rename(complete_old_path, complete_new_path);
2747 if (ret < 0 && errno != ENOENT) {
2748 PERROR("Renaming chunk in rotate_rename command from \"%s\" to \"%s\"",
2749 complete_old_path, complete_new_path);
2750 goto end;
2751 }
2752 ret = 0;
2753
2754 end:
2755 memset(&reply, 0, sizeof(reply));
2756 if (ret < 0) {
2757 reply.ret_code = htobe32(LTTNG_ERR_UNK);
2758 } else {
2759 reply.ret_code = htobe32(LTTNG_OK);
2760 }
2761 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
2762 sizeof(reply), 0);
2763 if (send_ret < sizeof(reply)) {
2764 ERR("Failed to send \"rotate rename\" command reply (ret = %zd)",
2765 send_ret);
2766 ret = -1;
2767 }
2768
2769 end_no_reply:
2770 free(complete_old_path);
2771 free(complete_new_path);
2772 return ret;
2773 }
2774
2775 /*
2776 * Check if all the streams in the session have completed the last rotation.
2777 * The chunk_id value is used to distinguish the cases where a stream was
2778 * closed on the consumerd before the rotation started but it still active on
2779 * the relayd, and the case where a stream appeared on the consumerd/relayd
2780 * after the last rotation started (in that case, it is already writing in the
2781 * new chunk folder).
2782 */
2783 static
2784 int relay_rotate_pending(const struct lttcomm_relayd_hdr *recv_hdr,
2785 struct relay_connection *conn,
2786 const struct lttng_buffer_view *payload)
2787 {
2788 struct relay_session *session = conn->session;
2789 struct lttcomm_relayd_rotate_pending msg;
2790 struct lttcomm_relayd_rotate_pending_reply reply;
2791 struct lttng_ht_iter iter;
2792 struct relay_stream *stream;
2793 int ret = 0;
2794 ssize_t send_ret;
2795 uint64_t chunk_id;
2796 bool rotate_pending = false;
2797
2798 DBG("Rotate pending command received");
2799
2800 if (!session || !conn->version_check_done) {
2801 ERR("Trying to check for data before version check");
2802 ret = -1;
2803 goto end_no_reply;
2804 }
2805
2806 if (session->major == 2 && session->minor < 11) {
2807 ERR("Unsupported feature before 2.11");
2808 ret = -1;
2809 goto end_no_reply;
2810 }
2811
2812 if (payload->size < sizeof(msg)) {
2813 ERR("Unexpected payload size in \"relay_rotate_pending\": expected >= %zu bytes, got %zu bytes",
2814 sizeof(msg), payload->size);
2815 ret = -1;
2816 goto end_no_reply;
2817 }
2818
2819 memcpy(&msg, payload->data, sizeof(msg));
2820
2821 chunk_id = be64toh(msg.chunk_id);
2822
2823 DBG("Evaluating rotate pending for chunk id %" PRIu64, chunk_id);
2824
2825 /*
2826 * Iterate over all the streams in the session and check if they are
2827 * still waiting for data to perform their rotation.
2828 */
2829 rcu_read_lock();
2830 cds_lfht_for_each_entry(relay_streams_ht->ht, &iter.iter, stream,
2831 node.node) {
2832 if (!stream_get(stream)) {
2833 continue;
2834 }
2835 if (stream->trace->session != session) {
2836 stream_put(stream);
2837 continue;
2838 }
2839 pthread_mutex_lock(&stream->lock);
2840 if (stream->rotate_at_seq_num != -1ULL) {
2841 /* We have not yet performed the rotation. */
2842 rotate_pending = true;
2843 DBG("Stream %" PRIu64 " is still rotating",
2844 stream->stream_handle);
2845 } else if (stream->current_chunk_id.value < chunk_id) {
2846 /*
2847 * Stream closed on the consumer but still active on the
2848 * relay.
2849 */
2850 rotate_pending = true;
2851 DBG("Stream %" PRIu64 " did not exist on the consumer "
2852 "when the last rotation started, but is"
2853 "still waiting for data before getting"
2854 "closed",
2855 stream->stream_handle);
2856 }
2857 pthread_mutex_unlock(&stream->lock);
2858 stream_put(stream);
2859 if (rotate_pending) {
2860 goto send_reply;
2861 }
2862 }
2863
2864 send_reply:
2865 rcu_read_unlock();
2866 memset(&reply, 0, sizeof(reply));
2867 reply.generic.ret_code = htobe32((uint32_t) LTTNG_OK);
2868 reply.is_pending = (uint8_t) !!rotate_pending;
2869 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
2870 sizeof(reply), 0);
2871 if (send_ret < (ssize_t) sizeof(reply)) {
2872 ERR("Failed to send \"rotate pending\" command reply (ret = %zd)",
2873 send_ret);
2874 ret = -1;
2875 }
2876
2877 end_no_reply:
2878 return ret;
2879 }
2880
2881 #define DBG_CMD(cmd_name, conn) \
2882 DBG3("Processing \"%s\" command for socket %i", cmd_name, conn->sock->fd);
2883
2884 static int relay_process_control_command(struct relay_connection *conn,
2885 const struct lttcomm_relayd_hdr *header,
2886 const struct lttng_buffer_view *payload)
2887 {
2888 int ret = 0;
2889
2890 switch (header->cmd) {
2891 case RELAYD_CREATE_SESSION:
2892 DBG_CMD("RELAYD_CREATE_SESSION", conn);
2893 ret = relay_create_session(header, conn, payload);
2894 break;
2895 case RELAYD_ADD_STREAM:
2896 DBG_CMD("RELAYD_ADD_STREAM", conn);
2897 ret = relay_add_stream(header, conn, payload);
2898 break;
2899 case RELAYD_START_DATA:
2900 DBG_CMD("RELAYD_START_DATA", conn);
2901 ret = relay_start(header, conn, payload);
2902 break;
2903 case RELAYD_SEND_METADATA:
2904 DBG_CMD("RELAYD_SEND_METADATA", conn);
2905 ret = relay_recv_metadata(header, conn, payload);
2906 break;
2907 case RELAYD_VERSION:
2908 DBG_CMD("RELAYD_VERSION", conn);
2909 ret = relay_send_version(header, conn, payload);
2910 break;
2911 case RELAYD_CLOSE_STREAM:
2912 DBG_CMD("RELAYD_CLOSE_STREAM", conn);
2913 ret = relay_close_stream(header, conn, payload);
2914 break;
2915 case RELAYD_DATA_PENDING:
2916 DBG_CMD("RELAYD_DATA_PENDING", conn);
2917 ret = relay_data_pending(header, conn, payload);
2918 break;
2919 case RELAYD_QUIESCENT_CONTROL:
2920 DBG_CMD("RELAYD_QUIESCENT_CONTROL", conn);
2921 ret = relay_quiescent_control(header, conn, payload);
2922 break;
2923 case RELAYD_BEGIN_DATA_PENDING:
2924 DBG_CMD("RELAYD_BEGIN_DATA_PENDING", conn);
2925 ret = relay_begin_data_pending(header, conn, payload);
2926 break;
2927 case RELAYD_END_DATA_PENDING:
2928 DBG_CMD("RELAYD_END_DATA_PENDING", conn);
2929 ret = relay_end_data_pending(header, conn, payload);
2930 break;
2931 case RELAYD_SEND_INDEX:
2932 DBG_CMD("RELAYD_SEND_INDEX", conn);
2933 ret = relay_recv_index(header, conn, payload);
2934 break;
2935 case RELAYD_STREAMS_SENT:
2936 DBG_CMD("RELAYD_STREAMS_SENT", conn);
2937 ret = relay_streams_sent(header, conn, payload);
2938 break;
2939 case RELAYD_RESET_METADATA:
2940 DBG_CMD("RELAYD_RESET_METADATA", conn);
2941 ret = relay_reset_metadata(header, conn, payload);
2942 break;
2943 case RELAYD_ROTATE_STREAM:
2944 DBG_CMD("RELAYD_ROTATE_STREAM", conn);
2945 ret = relay_rotate_session_stream(header, conn, payload);
2946 break;
2947 case RELAYD_ROTATE_RENAME:
2948 DBG_CMD("RELAYD_ROTATE_RENAME", conn);
2949 ret = relay_rotate_rename(header, conn, payload);
2950 break;
2951 case RELAYD_ROTATE_PENDING:
2952 DBG_CMD("RELAYD_ROTATE_PENDING", conn);
2953 ret = relay_rotate_pending(header, conn, payload);
2954 break;
2955 case RELAYD_MKDIR:
2956 DBG_CMD("RELAYD_MKDIR", conn);
2957 ret = relay_mkdir(header, conn, payload);
2958 break;
2959 case RELAYD_UPDATE_SYNC_INFO:
2960 default:
2961 ERR("Received unknown command (%u)", header->cmd);
2962 relay_unknown_command(conn);
2963 ret = -1;
2964 goto end;
2965 }
2966
2967 end:
2968 return ret;
2969 }
2970
2971 static enum relay_connection_status relay_process_control_receive_payload(
2972 struct relay_connection *conn)
2973 {
2974 int ret = 0;
2975 enum relay_connection_status status = RELAY_CONNECTION_STATUS_OK;
2976 struct lttng_dynamic_buffer *reception_buffer =
2977 &conn->protocol.ctrl.reception_buffer;
2978 struct ctrl_connection_state_receive_payload *state =
2979 &conn->protocol.ctrl.state.receive_payload;
2980 struct lttng_buffer_view payload_view;
2981
2982 if (state->left_to_receive == 0) {
2983 /* Short-circuit for payload-less commands. */
2984 goto reception_complete;
2985 }
2986
2987 ret = conn->sock->ops->recvmsg(conn->sock,
2988 reception_buffer->data + state->received,
2989 state->left_to_receive, MSG_DONTWAIT);
2990 if (ret < 0) {
2991 if (errno != EAGAIN && errno != EWOULDBLOCK) {
2992 PERROR("Unable to receive command payload on sock %d",
2993 conn->sock->fd);
2994 status = RELAY_CONNECTION_STATUS_ERROR;
2995 }
2996 goto end;
2997 } else if (ret == 0) {
2998 DBG("Socket %d performed an orderly shutdown (received EOF)", conn->sock->fd);
2999 status = RELAY_CONNECTION_STATUS_CLOSED;
3000 goto end;
3001 }
3002
3003 assert(ret > 0);
3004 assert(ret <= state->left_to_receive);
3005
3006 state->left_to_receive -= ret;
3007 state->received += ret;
3008
3009 if (state->left_to_receive > 0) {
3010 /*
3011 * Can't transition to the protocol's next state, wait to
3012 * receive the rest of the header.
3013 */
3014 DBG3("Partial reception of control connection protocol payload (received %" PRIu64 " bytes, %" PRIu64 " bytes left to receive, fd = %i)",
3015 state->received, state->left_to_receive,
3016 conn->sock->fd);
3017 goto end;
3018 }
3019
3020 reception_complete:
3021 DBG("Done receiving control command payload: fd = %i, payload size = %" PRIu64 " bytes",
3022 conn->sock->fd, state->received);
3023 /*
3024 * The payload required to process the command has been received.
3025 * A view to the reception buffer is forwarded to the various
3026 * commands and the state of the control is reset on success.
3027 *
3028 * Commands are responsible for sending their reply to the peer.
3029 */
3030 payload_view = lttng_buffer_view_from_dynamic_buffer(reception_buffer,
3031 0, -1);
3032 ret = relay_process_control_command(conn,
3033 &state->header, &payload_view);
3034 if (ret < 0) {
3035 status = RELAY_CONNECTION_STATUS_ERROR;
3036 goto end;
3037 }
3038
3039 ret = connection_reset_protocol_state(conn);
3040 if (ret) {
3041 status = RELAY_CONNECTION_STATUS_ERROR;
3042 }
3043 end:
3044 return status;
3045 }
3046
3047 static enum relay_connection_status relay_process_control_receive_header(
3048 struct relay_connection *conn)
3049 {
3050 int ret = 0;
3051 enum relay_connection_status status = RELAY_CONNECTION_STATUS_OK;
3052 struct lttcomm_relayd_hdr header;
3053 struct lttng_dynamic_buffer *reception_buffer =
3054 &conn->protocol.ctrl.reception_buffer;
3055 struct ctrl_connection_state_receive_header *state =
3056 &conn->protocol.ctrl.state.receive_header;
3057
3058 assert(state->left_to_receive != 0);
3059
3060 ret = conn->sock->ops->recvmsg(conn->sock,
3061 reception_buffer->data + state->received,
3062 state->left_to_receive, MSG_DONTWAIT);
3063 if (ret < 0) {
3064 if (errno != EAGAIN && errno != EWOULDBLOCK) {
3065 PERROR("Unable to receive control command header on sock %d",
3066 conn->sock->fd);
3067 status = RELAY_CONNECTION_STATUS_ERROR;
3068 }
3069 goto end;
3070 } else if (ret == 0) {
3071 DBG("Socket %d performed an orderly shutdown (received EOF)", conn->sock->fd);
3072 status = RELAY_CONNECTION_STATUS_CLOSED;
3073 goto end;
3074 }
3075
3076 assert(ret > 0);
3077 assert(ret <= state->left_to_receive);
3078
3079 state->left_to_receive -= ret;
3080 state->received += ret;
3081
3082 if (state->left_to_receive > 0) {
3083 /*
3084 * Can't transition to the protocol's next state, wait to
3085 * receive the rest of the header.
3086 */
3087 DBG3("Partial reception of control connection protocol header (received %" PRIu64 " bytes, %" PRIu64 " bytes left to receive, fd = %i)",
3088 state->received, state->left_to_receive,
3089 conn->sock->fd);
3090 goto end;
3091 }
3092
3093 /* Transition to next state: receiving the command's payload. */
3094 conn->protocol.ctrl.state_id =
3095 CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD;
3096 memcpy(&header, reception_buffer->data, sizeof(header));
3097 header.circuit_id = be64toh(header.circuit_id);
3098 header.data_size = be64toh(header.data_size);
3099 header.cmd = be32toh(header.cmd);
3100 header.cmd_version = be32toh(header.cmd_version);
3101 memcpy(&conn->protocol.ctrl.state.receive_payload.header,
3102 &header, sizeof(header));
3103
3104 DBG("Done receiving control command header: fd = %i, cmd = %" PRIu32 ", cmd_version = %" PRIu32 ", payload size = %" PRIu64 " bytes",
3105 conn->sock->fd, header.cmd, header.cmd_version,
3106 header.data_size);
3107
3108 if (header.data_size > DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE) {
3109 ERR("Command header indicates a payload (%" PRIu64 " bytes) that exceeds the maximal payload size allowed on a control connection.",
3110 header.data_size);
3111 status = RELAY_CONNECTION_STATUS_ERROR;
3112 goto end;
3113 }
3114
3115 conn->protocol.ctrl.state.receive_payload.left_to_receive =
3116 header.data_size;
3117 conn->protocol.ctrl.state.receive_payload.received = 0;
3118 ret = lttng_dynamic_buffer_set_size(reception_buffer,
3119 header.data_size);
3120 if (ret) {
3121 status = RELAY_CONNECTION_STATUS_ERROR;
3122 goto end;
3123 }
3124
3125 if (header.data_size == 0) {
3126 /*
3127 * Manually invoke the next state as the poll loop
3128 * will not wake-up to allow us to proceed further.
3129 */
3130 status = relay_process_control_receive_payload(conn);
3131 }
3132 end:
3133 return status;
3134 }
3135
3136 /*
3137 * Process the commands received on the control socket
3138 */
3139 static enum relay_connection_status relay_process_control(
3140 struct relay_connection *conn)
3141 {
3142 enum relay_connection_status status;
3143
3144 switch (conn->protocol.ctrl.state_id) {
3145 case CTRL_CONNECTION_STATE_RECEIVE_HEADER:
3146 status = relay_process_control_receive_header(conn);
3147 break;
3148 case CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD:
3149 status = relay_process_control_receive_payload(conn);
3150 break;
3151 default:
3152 ERR("Unknown control connection protocol state encountered.");
3153 abort();
3154 }
3155
3156 return status;
3157 }
3158
3159 /*
3160 * Handle index for a data stream.
3161 *
3162 * Called with the stream lock held.
3163 *
3164 * Return 0 on success else a negative value.
3165 */
3166 static int handle_index_data(struct relay_stream *stream, uint64_t net_seq_num,
3167 bool rotate_index, bool *flushed, uint64_t total_size)
3168 {
3169 int ret = 0;
3170 uint64_t data_offset;
3171 struct relay_index *index;
3172
3173 /* Get data offset because we are about to update the index. */
3174 data_offset = htobe64(stream->tracefile_size_current);
3175
3176 DBG("handle_index_data: stream %" PRIu64 " net_seq_num %" PRIu64 " data offset %" PRIu64,
3177 stream->stream_handle, net_seq_num, stream->tracefile_size_current);
3178
3179 /*
3180 * Lookup for an existing index for that stream id/sequence
3181 * number. If it exists, the control thread has already received the
3182 * data for it, thus we need to write it to disk.
3183 */
3184 index = relay_index_get_by_id_or_create(stream, net_seq_num);
3185 if (!index) {
3186 ret = -1;
3187 goto end;
3188 }
3189
3190 if (rotate_index || !stream->index_file) {
3191 ret = create_rotate_index_file(stream);
3192 if (ret < 0) {
3193 ERR("Failed to rotate index");
3194 /* Put self-ref for this index due to error. */
3195 relay_index_put(index);
3196 index = NULL;
3197 goto end;
3198 }
3199 }
3200
3201 if (relay_index_set_file(index, stream->index_file, data_offset)) {
3202 ret = -1;
3203 /* Put self-ref for this index due to error. */
3204 relay_index_put(index);
3205 index = NULL;
3206 goto end;
3207 }
3208
3209 ret = relay_index_try_flush(index);
3210 if (ret == 0) {
3211 tracefile_array_commit_seq(stream->tfa);
3212 stream->index_received_seqcount++;
3213 *flushed = true;
3214 } else if (ret > 0) {
3215 index->total_size = total_size;
3216 /* No flush. */
3217 ret = 0;
3218 } else {
3219 /* Put self-ref for this index due to error. */
3220 relay_index_put(index);
3221 index = NULL;
3222 ret = -1;
3223 }
3224 end:
3225 return ret;
3226 }
3227
3228 static enum relay_connection_status relay_process_data_receive_header(
3229 struct relay_connection *conn)
3230 {
3231 int ret;
3232 enum relay_connection_status status = RELAY_CONNECTION_STATUS_OK;
3233 struct data_connection_state_receive_header *state =
3234 &conn->protocol.data.state.receive_header;
3235 struct lttcomm_relayd_data_hdr header;
3236 struct relay_stream *stream;
3237
3238 assert(state->left_to_receive != 0);
3239
3240 ret = conn->sock->ops->recvmsg(conn->sock,
3241 state->header_reception_buffer + state->received,
3242 state->left_to_receive, MSG_DONTWAIT);
3243 if (ret < 0) {
3244 if (errno != EAGAIN && errno != EWOULDBLOCK) {
3245 PERROR("Unable to receive data header on sock %d", conn->sock->fd);
3246 status = RELAY_CONNECTION_STATUS_ERROR;
3247 }
3248 goto end;
3249 } else if (ret == 0) {
3250 /* Orderly shutdown. Not necessary to print an error. */
3251 DBG("Socket %d performed an orderly shutdown (received EOF)", conn->sock->fd);
3252 status = RELAY_CONNECTION_STATUS_CLOSED;
3253 goto end;
3254 }
3255
3256 assert(ret > 0);
3257 assert(ret <= state->left_to_receive);
3258
3259 state->left_to_receive -= ret;
3260 state->received += ret;
3261
3262 if (state->left_to_receive > 0) {
3263 /*
3264 * Can't transition to the protocol's next state, wait to
3265 * receive the rest of the header.
3266 */
3267 DBG3("Partial reception of data connection header (received %" PRIu64 " bytes, %" PRIu64 " bytes left to receive, fd = %i)",
3268 state->received, state->left_to_receive,
3269 conn->sock->fd);
3270 goto end;
3271 }
3272
3273 /* Transition to next state: receiving the payload. */
3274 conn->protocol.data.state_id = DATA_CONNECTION_STATE_RECEIVE_PAYLOAD;
3275
3276 memcpy(&header, state->header_reception_buffer, sizeof(header));
3277 header.circuit_id = be64toh(header.circuit_id);
3278 header.stream_id = be64toh(header.stream_id);
3279 header.data_size = be32toh(header.data_size);
3280 header.net_seq_num = be64toh(header.net_seq_num);
3281 header.padding_size = be32toh(header.padding_size);
3282 memcpy(&conn->protocol.data.state.receive_payload.header, &header, sizeof(header));
3283
3284 conn->protocol.data.state.receive_payload.left_to_receive =
3285 header.data_size;
3286 conn->protocol.data.state.receive_payload.received = 0;
3287 conn->protocol.data.state.receive_payload.rotate_index = false;
3288
3289 DBG("Received data connection header on fd %i: circuit_id = %" PRIu64 ", stream_id = %" PRIu64 ", data_size = %" PRIu32 ", net_seq_num = %" PRIu64 ", padding_size = %" PRIu32,
3290 conn->sock->fd, header.circuit_id,
3291 header.stream_id, header.data_size,
3292 header.net_seq_num, header.padding_size);
3293
3294 stream = stream_get_by_id(header.stream_id);
3295 if (!stream) {
3296 DBG("relay_process_data_receive_payload: Cannot find stream %" PRIu64,
3297 header.stream_id);
3298 /* Protocol error. */
3299 status = RELAY_CONNECTION_STATUS_ERROR;
3300 goto end;
3301 }
3302
3303 pthread_mutex_lock(&stream->lock);
3304
3305 /* Check if a rotation is needed. */
3306 if (stream->tracefile_size > 0 &&
3307 (stream->tracefile_size_current + header.data_size) >
3308 stream->tracefile_size) {
3309 uint64_t old_id, new_id;
3310
3311 old_id = tracefile_array_get_file_index_head(stream->tfa);
3312 tracefile_array_file_rotate(stream->tfa);
3313
3314 /* new_id is updated by utils_rotate_stream_file. */
3315 new_id = old_id;
3316
3317 ret = utils_rotate_stream_file(stream->path_name,
3318 stream->channel_name, stream->tracefile_size,
3319 stream->tracefile_count, -1,
3320 -1, stream->stream_fd->fd,
3321 &new_id, &stream->stream_fd->fd);
3322 if (ret < 0) {
3323 ERR("Failed to rotate stream output file");
3324 status = RELAY_CONNECTION_STATUS_ERROR;
3325 goto end_stream_unlock;
3326 }
3327
3328 /*
3329 * Reset current size because we just performed a stream
3330 * rotation.
3331 */
3332 stream->tracefile_size_current = 0;
3333 conn->protocol.data.state.receive_payload.rotate_index = true;
3334 }
3335
3336 end_stream_unlock:
3337 pthread_mutex_unlock(&stream->lock);
3338 stream_put(stream);
3339 end:
3340 return status;
3341 }
3342
3343 static enum relay_connection_status relay_process_data_receive_payload(
3344 struct relay_connection *conn)
3345 {
3346 int ret;
3347 enum relay_connection_status status = RELAY_CONNECTION_STATUS_OK;
3348 struct relay_stream *stream;
3349 struct data_connection_state_receive_payload *state =
3350 &conn->protocol.data.state.receive_payload;
3351 const size_t chunk_size = RECV_DATA_BUFFER_SIZE;
3352 char data_buffer[chunk_size];
3353 bool partial_recv = false;
3354 bool new_stream = false, close_requested = false, index_flushed = false;
3355 uint64_t left_to_receive = state->left_to_receive;
3356 struct relay_session *session;
3357
3358 DBG3("Receiving data for stream id %" PRIu64 " seqnum %" PRIu64 ", %" PRIu64" bytes received, %" PRIu64 " bytes left to receive",
3359 state->header.stream_id, state->header.net_seq_num,
3360 state->received, left_to_receive);
3361
3362 stream = stream_get_by_id(state->header.stream_id);
3363 if (!stream) {
3364 /* Protocol error. */
3365 ERR("relay_process_data_receive_payload: cannot find stream %" PRIu64,
3366 state->header.stream_id);
3367 status = RELAY_CONNECTION_STATUS_ERROR;
3368 goto end;
3369 }
3370
3371 pthread_mutex_lock(&stream->lock);
3372 session = stream->trace->session;
3373 if (!conn->session) {
3374 ret = connection_set_session(conn, session);
3375 if (ret) {
3376 status = RELAY_CONNECTION_STATUS_ERROR;
3377 goto end_stream_unlock;
3378 }
3379 }
3380
3381 /*
3382 * The size of the "chunk" received on any iteration is bounded by:
3383 * - the data left to receive,
3384 * - the data immediately available on the socket,
3385 * - the on-stack data buffer
3386 */
3387 while (left_to_receive > 0 && !partial_recv) {
3388 ssize_t write_ret;
3389 size_t recv_size = min(left_to_receive, chunk_size);
3390
3391 ret = conn->sock->ops->recvmsg(conn->sock, data_buffer,
3392 recv_size, MSG_DONTWAIT);
3393 if (ret < 0) {
3394 if (errno != EAGAIN && errno != EWOULDBLOCK) {
3395 PERROR("Socket %d error", conn->sock->fd);
3396 status = RELAY_CONNECTION_STATUS_ERROR;
3397 }
3398 goto end_stream_unlock;
3399 } else if (ret == 0) {
3400 /* No more data ready to be consumed on socket. */
3401 DBG3("No more data ready for consumption on data socket of stream id %" PRIu64,
3402 state->header.stream_id);
3403 status = RELAY_CONNECTION_STATUS_CLOSED;
3404 break;
3405 } else if (ret < (int) recv_size) {
3406 /*
3407 * All the data available on the socket has been
3408 * consumed.
3409 */
3410 partial_recv = true;
3411 }
3412
3413 recv_size = ret;
3414
3415 /* Write data to stream output fd. */
3416 write_ret = lttng_write(stream->stream_fd->fd, data_buffer,
3417 recv_size);
3418 if (write_ret < (ssize_t) recv_size) {
3419 ERR("Relay error writing data to file");
3420 status = RELAY_CONNECTION_STATUS_ERROR;
3421 goto end_stream_unlock;
3422 }
3423
3424 left_to_receive -= recv_size;
3425 state->received += recv_size;
3426 state->left_to_receive = left_to_receive;
3427
3428 DBG2("Relay wrote %zd bytes to tracefile for stream id %" PRIu64,
3429 write_ret, stream->stream_handle);
3430 }
3431
3432 if (state->left_to_receive > 0) {
3433 /*
3434 * Did not receive all the data expected, wait for more data to
3435 * become available on the socket.
3436 */
3437 DBG3("Partial receive on data connection of stream id %" PRIu64 ", %" PRIu64 " bytes received, %" PRIu64 " bytes left to receive",
3438 state->header.stream_id, state->received,
3439 state->left_to_receive);
3440 goto end_stream_unlock;
3441 }
3442
3443 ret = write_padding_to_file(stream->stream_fd->fd,
3444 state->header.padding_size);
3445 if ((int64_t) ret < (int64_t) state->header.padding_size) {
3446 ERR("write_padding_to_file: fail stream %" PRIu64 " net_seq_num %" PRIu64 " ret %d",
3447 stream->stream_handle,
3448 state->header.net_seq_num, ret);
3449 status = RELAY_CONNECTION_STATUS_ERROR;
3450 goto end_stream_unlock;
3451 }
3452
3453
3454 if (session->minor >= 4 && !session->snapshot) {
3455 ret = handle_index_data(stream, state->header.net_seq_num,
3456 state->rotate_index, &index_flushed, state->header.data_size + state->header.padding_size);
3457 if (ret < 0) {
3458 ERR("handle_index_data: fail stream %" PRIu64 " net_seq_num %" PRIu64 " ret %d",
3459 stream->stream_handle,
3460 state->header.net_seq_num, ret);
3461 status = RELAY_CONNECTION_STATUS_ERROR;
3462 goto end_stream_unlock;
3463 }
3464 }
3465
3466 stream->tracefile_size_current += state->header.data_size +
3467 state->header.padding_size;
3468
3469 if (stream->prev_seq == -1ULL) {
3470 new_stream = true;
3471 }
3472 if (index_flushed) {
3473 stream->pos_after_last_complete_data_index =
3474 stream->tracefile_size_current;
3475 }
3476
3477 stream->prev_seq = state->header.net_seq_num;
3478
3479 /*
3480 * Resetting the protocol state (to RECEIVE_HEADER) will trash the
3481 * contents of *state which are aliased (union) to the same location as
3482 * the new state. Don't use it beyond this point.
3483 */
3484 connection_reset_protocol_state(conn);
3485 state = NULL;
3486
3487 ret = try_rotate_stream(stream);
3488 if (ret < 0) {
3489 status = RELAY_CONNECTION_STATUS_ERROR;
3490 goto end_stream_unlock;
3491 }
3492
3493 end_stream_unlock:
3494 close_requested = stream->close_requested;
3495 pthread_mutex_unlock(&stream->lock);
3496 if (close_requested && left_to_receive == 0) {
3497 try_stream_close(stream);
3498 }
3499
3500 if (new_stream) {
3501 pthread_mutex_lock(&session->lock);
3502 uatomic_set(&session->new_streams, 1);
3503 pthread_mutex_unlock(&session->lock);
3504 }
3505
3506 stream_put(stream);
3507 end:
3508 return status;
3509 }
3510
3511 /*
3512 * relay_process_data: Process the data received on the data socket
3513 */
3514 static enum relay_connection_status relay_process_data(
3515 struct relay_connection *conn)
3516 {
3517 enum relay_connection_status status;
3518
3519 switch (conn->protocol.data.state_id) {
3520 case DATA_CONNECTION_STATE_RECEIVE_HEADER:
3521 status = relay_process_data_receive_header(conn);
3522 break;
3523 case DATA_CONNECTION_STATE_RECEIVE_PAYLOAD:
3524 status = relay_process_data_receive_payload(conn);
3525 break;
3526 default:
3527 ERR("Unexpected data connection communication state.");
3528 abort();
3529 }
3530
3531 return status;
3532 }
3533
3534 static void cleanup_connection_pollfd(struct lttng_poll_event *events, int pollfd)
3535 {
3536 int ret;
3537
3538 (void) lttng_poll_del(events, pollfd);
3539
3540 ret = close(pollfd);
3541 if (ret < 0) {
3542 ERR("Closing pollfd %d", pollfd);
3543 }
3544 }
3545
3546 static void relay_thread_close_connection(struct lttng_poll_event *events,
3547 int pollfd, struct relay_connection *conn)
3548 {
3549 const char *type_str;
3550
3551 switch (conn->type) {
3552 case RELAY_DATA:
3553 type_str = "Data";
3554 break;
3555 case RELAY_CONTROL:
3556 type_str = "Control";
3557 break;
3558 case RELAY_VIEWER_COMMAND:
3559 type_str = "Viewer Command";
3560 break;
3561 case RELAY_VIEWER_NOTIFICATION:
3562 type_str = "Viewer Notification";
3563 break;
3564 default:
3565 type_str = "Unknown";
3566 }
3567 cleanup_connection_pollfd(events, pollfd);
3568 connection_put(conn);
3569 DBG("%s connection closed with %d", type_str, pollfd);
3570 }
3571
3572 /*
3573 * This thread does the actual work
3574 */
3575 static void *relay_thread_worker(void *data)
3576 {
3577 int ret, err = -1, last_seen_data_fd = -1;
3578 uint32_t nb_fd;
3579 struct lttng_poll_event events;
3580 struct lttng_ht *relay_connections_ht;
3581 struct lttng_ht_iter iter;
3582 struct relay_connection *destroy_conn = NULL;
3583
3584 DBG("[thread] Relay worker started");
3585
3586 rcu_register_thread();
3587
3588 health_register(health_relayd, HEALTH_RELAYD_TYPE_WORKER);
3589
3590 if (testpoint(relayd_thread_worker)) {
3591 goto error_testpoint;
3592 }
3593
3594 health_code_update();
3595
3596 /* table of connections indexed on socket */
3597 relay_connections_ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3598 if (!relay_connections_ht) {
3599 goto relay_connections_ht_error;
3600 }
3601
3602 ret = create_thread_poll_set(&events, 2);
3603 if (ret < 0) {
3604 goto error_poll_create;
3605 }
3606
3607 ret = lttng_poll_add(&events, relay_conn_pipe[0], LPOLLIN | LPOLLRDHUP);
3608 if (ret < 0) {
3609 goto error;
3610 }
3611
3612 restart:
3613 while (1) {
3614 int idx = -1, i, seen_control = 0, last_notdel_data_fd = -1;
3615
3616 health_code_update();
3617
3618 /* Infinite blocking call, waiting for transmission */
3619 DBG3("Relayd worker thread polling...");
3620 health_poll_entry();
3621 ret = lttng_poll_wait(&events, -1);
3622 health_poll_exit();
3623 if (ret < 0) {
3624 /*
3625 * Restart interrupted system call.
3626 */
3627 if (errno == EINTR) {
3628 goto restart;
3629 }
3630 goto error;
3631 }
3632
3633 nb_fd = ret;
3634
3635 /*
3636 * Process control. The control connection is
3637 * prioritized so we don't starve it with high
3638 * throughput tracing data on the data connection.
3639 */
3640 for (i = 0; i < nb_fd; i++) {
3641 /* Fetch once the poll data */
3642 uint32_t revents = LTTNG_POLL_GETEV(&events, i);
3643 int pollfd = LTTNG_POLL_GETFD(&events, i);
3644
3645 health_code_update();
3646
3647 if (!revents) {
3648 /*
3649 * No activity for this FD (poll
3650 * implementation).
3651 */
3652 continue;
3653 }
3654
3655 /* Thread quit pipe has been closed. Killing thread. */
3656 ret = check_thread_quit_pipe(pollfd, revents);
3657 if (ret) {
3658 err = 0;
3659 goto exit;
3660 }
3661
3662 /* Inspect the relay conn pipe for new connection */
3663 if (pollfd == relay_conn_pipe[0]) {
3664 if (revents & LPOLLIN) {
3665 struct relay_connection *conn;
3666
3667 ret = lttng_read(relay_conn_pipe[0], &conn, sizeof(conn));
3668 if (ret < 0) {
3669 goto error;
3670 }
3671 lttng_poll_add(&events, conn->sock->fd,
3672 LPOLLIN | LPOLLRDHUP);
3673 connection_ht_add(relay_connections_ht, conn);
3674 DBG("Connection socket %d added", conn->sock->fd);
3675 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
3676 ERR("Relay connection pipe error");
3677 goto error;
3678 } else {
3679 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
3680 goto error;
3681 }
3682 } else {
3683 struct relay_connection *ctrl_conn;
3684
3685 ctrl_conn = connection_get_by_sock(relay_connections_ht, pollfd);
3686 /* If not found, there is a synchronization issue. */
3687 assert(ctrl_conn);
3688
3689 if (ctrl_conn->type == RELAY_DATA) {
3690 if (revents & LPOLLIN) {
3691 /*
3692 * Flag the last seen data fd not deleted. It will be
3693 * used as the last seen fd if any fd gets deleted in
3694 * this first loop.
3695 */
3696 last_notdel_data_fd = pollfd;
3697 }
3698 goto put_ctrl_connection;
3699 }
3700 assert(ctrl_conn->type == RELAY_CONTROL);
3701
3702 if (revents & LPOLLIN) {
3703 enum relay_connection_status status;
3704
3705 status = relay_process_control(ctrl_conn);
3706 if (status != RELAY_CONNECTION_STATUS_OK) {
3707 /*
3708 * On socket error flag the session as aborted to force
3709 * the cleanup of its stream otherwise it can leak
3710 * during the lifetime of the relayd.
3711 *
3712 * This prevents situations in which streams can be
3713 * left opened because an index was received, the
3714 * control connection is closed, and the data
3715 * connection is closed (uncleanly) before the packet's
3716 * data provided.
3717 *
3718 * Since the control connection encountered an error,
3719 * it is okay to be conservative and close the
3720 * session right now as we can't rely on the protocol
3721 * being respected anymore.
3722 */
3723 if (status == RELAY_CONNECTION_STATUS_ERROR) {
3724 session_abort(ctrl_conn->session);
3725 }
3726
3727 /* Clear the connection on error or close. */
3728 relay_thread_close_connection(&events,
3729 pollfd,
3730 ctrl_conn);
3731 }
3732 seen_control = 1;
3733 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
3734 relay_thread_close_connection(&events,
3735 pollfd, ctrl_conn);
3736 if (last_seen_data_fd == pollfd) {
3737 last_seen_data_fd = last_notdel_data_fd;
3738 }
3739 } else {
3740 ERR("Unexpected poll events %u for control sock %d",
3741 revents, pollfd);
3742 connection_put(ctrl_conn);
3743 goto error;
3744 }
3745 put_ctrl_connection:
3746 connection_put(ctrl_conn);
3747 }
3748 }
3749
3750 /*
3751 * The last loop handled a control request, go back to poll to make
3752 * sure we prioritise the control socket.
3753 */
3754 if (seen_control) {
3755 continue;
3756 }
3757
3758 if (last_seen_data_fd >= 0) {
3759 for (i = 0; i < nb_fd; i++) {
3760 int pollfd = LTTNG_POLL_GETFD(&events, i);
3761
3762 health_code_update();
3763
3764 if (last_seen_data_fd == pollfd) {
3765 idx = i;
3766 break;
3767 }
3768 }
3769 }
3770
3771 /* Process data connection. */
3772 for (i = idx + 1; i < nb_fd; i++) {
3773 /* Fetch the poll data. */
3774 uint32_t revents = LTTNG_POLL_GETEV(&events, i);
3775 int pollfd = LTTNG_POLL_GETFD(&events, i);
3776 struct relay_connection *data_conn;
3777
3778 health_code_update();
3779
3780 if (!revents) {
3781 /* No activity for this FD (poll implementation). */
3782 continue;
3783 }
3784
3785 /* Skip the command pipe. It's handled in the first loop. */
3786 if (pollfd == relay_conn_pipe[0]) {
3787 continue;
3788 }
3789
3790 data_conn = connection_get_by_sock(relay_connections_ht, pollfd);
3791 if (!data_conn) {
3792 /* Skip it. Might be removed before. */
3793 continue;
3794 }
3795 if (data_conn->type == RELAY_CONTROL) {
3796 goto put_data_connection;
3797 }
3798 assert(data_conn->type == RELAY_DATA);
3799
3800 if (revents & LPOLLIN) {
3801 enum relay_connection_status status;
3802
3803 status = relay_process_data(data_conn);
3804 /* Connection closed or error. */
3805 if (status != RELAY_CONNECTION_STATUS_OK) {
3806 /*
3807 * On socket error flag the session as aborted to force
3808 * the cleanup of its stream otherwise it can leak
3809 * during the lifetime of the relayd.
3810 *
3811 * This prevents situations in which streams can be
3812 * left opened because an index was received, the
3813 * control connection is closed, and the data
3814 * connection is closed (uncleanly) before the packet's
3815 * data provided.
3816 *
3817 * Since the data connection encountered an error,
3818 * it is okay to be conservative and close the
3819 * session right now as we can't rely on the protocol
3820 * being respected anymore.
3821 */
3822 if (status == RELAY_CONNECTION_STATUS_ERROR) {
3823 session_abort(data_conn->session);
3824 }
3825 relay_thread_close_connection(&events, pollfd,
3826 data_conn);
3827 /*
3828 * Every goto restart call sets the last seen fd where
3829 * here we don't really care since we gracefully
3830 * continue the loop after the connection is deleted.
3831 */
3832 } else {
3833 /* Keep last seen port. */
3834 last_seen_data_fd = pollfd;
3835 connection_put(data_conn);
3836 goto restart;
3837 }
3838 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
3839 relay_thread_close_connection(&events, pollfd,
3840 data_conn);
3841 } else {
3842 ERR("Unknown poll events %u for data sock %d",
3843 revents, pollfd);
3844 }
3845 put_data_connection:
3846 connection_put(data_conn);
3847 }
3848 last_seen_data_fd = -1;
3849 }
3850
3851 /* Normal exit, no error */
3852 ret = 0;
3853
3854 exit:
3855 error:
3856 /* Cleanup remaining connection object. */
3857 rcu_read_lock();
3858 cds_lfht_for_each_entry(relay_connections_ht->ht, &iter.iter,
3859 destroy_conn,
3860 sock_n.node) {
3861 health_code_update();
3862
3863 session_abort(destroy_conn->session);
3864
3865 /*
3866 * No need to grab another ref, because we own
3867 * destroy_conn.
3868 */
3869 relay_thread_close_connection(&events, destroy_conn->sock->fd,
3870 destroy_conn);
3871 }
3872 rcu_read_unlock();
3873
3874 lttng_poll_clean(&events);
3875 error_poll_create:
3876 lttng_ht_destroy(relay_connections_ht);
3877 relay_connections_ht_error:
3878 /* Close relay conn pipes */
3879 utils_close_pipe(relay_conn_pipe);
3880 if (err) {
3881 DBG("Thread exited with error");
3882 }
3883 DBG("Worker thread cleanup complete");
3884 error_testpoint:
3885 if (err) {
3886 health_error();
3887 ERR("Health error occurred in %s", __func__);
3888 }
3889 health_unregister(health_relayd);
3890 rcu_unregister_thread();
3891 lttng_relay_stop_threads();
3892 return NULL;
3893 }
3894
3895 /*
3896 * Create the relay command pipe to wake thread_manage_apps.
3897 * Closed in cleanup().
3898 */
3899 static int create_relay_conn_pipe(void)
3900 {
3901 int ret;
3902
3903 ret = utils_create_pipe_cloexec(relay_conn_pipe);
3904
3905 return ret;
3906 }
3907
3908 /*
3909 * main
3910 */
3911 int main(int argc, char **argv)
3912 {
3913 int ret = 0, retval = 0;
3914 void *status;
3915
3916 /* Parse arguments */
3917 progname = argv[0];
3918 if (set_options(argc, argv)) {
3919 retval = -1;
3920 goto exit_options;
3921 }
3922
3923 if (set_signal_handler()) {
3924 retval = -1;
3925 goto exit_options;
3926 }
3927
3928 /* Try to create directory if -o, --output is specified. */
3929 if (opt_output_path) {
3930 if (*opt_output_path != '/') {
3931 ERR("Please specify an absolute path for -o, --output PATH");
3932 retval = -1;
3933 goto exit_options;
3934 }
3935
3936 ret = utils_mkdir_recursive(opt_output_path, S_IRWXU | S_IRWXG,
3937 -1, -1);
3938 if (ret < 0) {
3939 ERR("Unable to create %s", opt_output_path);
3940 retval = -1;
3941 goto exit_options;
3942 }
3943 }
3944
3945 /* Daemonize */
3946 if (opt_daemon || opt_background) {
3947 int i;
3948
3949 ret = lttng_daemonize(&child_ppid, &recv_child_signal,
3950 !opt_background);
3951 if (ret < 0) {
3952 retval = -1;
3953 goto exit_options;
3954 }
3955
3956 /*
3957 * We are in the child. Make sure all other file
3958 * descriptors are closed, in case we are called with
3959 * more opened file descriptors than the standard ones.
3960 */
3961 for (i = 3; i < sysconf(_SC_OPEN_MAX); i++) {
3962 (void) close(i);
3963 }
3964 }
3965
3966 /* Initialize thread health monitoring */
3967 health_relayd = health_app_create(NR_HEALTH_RELAYD_TYPES);
3968 if (!health_relayd) {
3969 PERROR("health_app_create error");
3970 retval = -1;
3971 goto exit_health_app_create;
3972 }
3973
3974 /* Create thread quit pipe */
3975 if (init_thread_quit_pipe()) {
3976 retval = -1;
3977 goto exit_init_data;
3978 }
3979
3980 /* Setup the thread apps communication pipe. */
3981 if (create_relay_conn_pipe()) {
3982 retval = -1;
3983 goto exit_init_data;
3984 }
3985
3986 /* Init relay command queue. */
3987 cds_wfcq_init(&relay_conn_queue.head, &relay_conn_queue.tail);
3988
3989 /* Initialize communication library */
3990 lttcomm_init();
3991 lttcomm_inet_init();
3992
3993 /* tables of sessions indexed by session ID */
3994 sessions_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
3995 if (!sessions_ht) {
3996 retval = -1;
3997 goto exit_init_data;
3998 }
3999
4000 /* tables of streams indexed by stream ID */
4001 relay_streams_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
4002 if (!relay_streams_ht) {
4003 retval = -1;
4004 goto exit_init_data;
4005 }
4006
4007 /* tables of streams indexed by stream ID */
4008 viewer_streams_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
4009 if (!viewer_streams_ht) {
4010 retval = -1;
4011 goto exit_init_data;
4012 }
4013
4014 ret = utils_create_pipe(health_quit_pipe);
4015 if (ret) {
4016 retval = -1;
4017 goto exit_health_quit_pipe;
4018 }
4019
4020 /* Create thread to manage the client socket */
4021 ret = pthread_create(&health_thread, default_pthread_attr(),
4022 thread_manage_health, (void *) NULL);
4023 if (ret) {
4024 errno = ret;
4025 PERROR("pthread_create health");
4026 retval = -1;
4027 goto exit_health_thread;
4028 }
4029
4030 /* Setup the dispatcher thread */
4031 ret = pthread_create(&dispatcher_thread, default_pthread_attr(),
4032 relay_thread_dispatcher, (void *) NULL);
4033 if (ret) {
4034 errno = ret;
4035 PERROR("pthread_create dispatcher");
4036 retval = -1;
4037 goto exit_dispatcher_thread;
4038 }
4039
4040 /* Setup the worker thread */
4041 ret = pthread_create(&worker_thread, default_pthread_attr(),
4042 relay_thread_worker, NULL);
4043 if (ret) {
4044 errno = ret;
4045 PERROR("pthread_create worker");
4046 retval = -1;
4047 goto exit_worker_thread;
4048 }
4049
4050 /* Setup the listener thread */
4051 ret = pthread_create(&listener_thread, default_pthread_attr(),
4052 relay_thread_listener, (void *) NULL);
4053 if (ret) {
4054 errno = ret;
4055 PERROR("pthread_create listener");
4056 retval = -1;
4057 goto exit_listener_thread;
4058 }
4059
4060 ret = relayd_live_create(live_uri);
4061 if (ret) {
4062 ERR("Starting live viewer threads");
4063 retval = -1;
4064 goto exit_live;
4065 }
4066
4067 /*
4068 * This is where we start awaiting program completion (e.g. through
4069 * signal that asks threads to teardown).
4070 */
4071
4072 ret = relayd_live_join();
4073 if (ret) {
4074 retval = -1;
4075 }
4076 exit_live:
4077
4078 ret = pthread_join(listener_thread, &status);
4079 if (ret) {
4080 errno = ret;
4081 PERROR("pthread_join listener_thread");
4082 retval = -1;
4083 }
4084
4085 exit_listener_thread:
4086 ret = pthread_join(worker_thread, &status);
4087 if (ret) {
4088 errno = ret;
4089 PERROR("pthread_join worker_thread");
4090 retval = -1;
4091 }
4092
4093 exit_worker_thread:
4094 ret = pthread_join(dispatcher_thread, &status);
4095 if (ret) {
4096 errno = ret;
4097 PERROR("pthread_join dispatcher_thread");
4098 retval = -1;
4099 }
4100 exit_dispatcher_thread:
4101
4102 ret = pthread_join(health_thread, &status);
4103 if (ret) {
4104 errno = ret;
4105 PERROR("pthread_join health_thread");
4106 retval = -1;
4107 }
4108 exit_health_thread:
4109
4110 utils_close_pipe(health_quit_pipe);
4111 exit_health_quit_pipe:
4112
4113 exit_init_data:
4114 health_app_destroy(health_relayd);
4115 exit_health_app_create:
4116 exit_options:
4117 /*
4118 * Wait for all pending call_rcu work to complete before tearing
4119 * down data structures. call_rcu worker may be trying to
4120 * perform lookups in those structures.
4121 */
4122 rcu_barrier();
4123 relayd_cleanup();
4124
4125 /* Ensure all prior call_rcu are done. */
4126 rcu_barrier();
4127
4128 if (!retval) {
4129 exit(EXIT_SUCCESS);
4130 } else {
4131 exit(EXIT_FAILURE);
4132 }
4133 }
This page took 2.736868 seconds and 4 git commands to generate.