Fix: unreported error in relay_close_trace_chunk
[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 <urcu/rculist.h>
41 #include <unistd.h>
42 #include <fcntl.h>
43 #include <strings.h>
44
45 #include <lttng/lttng.h>
46 #include <common/common.h>
47 #include <common/compat/poll.h>
48 #include <common/compat/socket.h>
49 #include <common/compat/endian.h>
50 #include <common/compat/getenv.h>
51 #include <common/defaults.h>
52 #include <common/daemonize.h>
53 #include <common/futex.h>
54 #include <common/sessiond-comm/sessiond-comm.h>
55 #include <common/sessiond-comm/inet.h>
56 #include <common/sessiond-comm/relayd.h>
57 #include <common/uri.h>
58 #include <common/utils.h>
59 #include <common/align.h>
60 #include <common/config/session-config.h>
61 #include <common/dynamic-buffer.h>
62 #include <common/buffer-view.h>
63 #include <common/string-utils/format.h>
64
65 #include "cmd.h"
66 #include "ctf-trace.h"
67 #include "index.h"
68 #include "utils.h"
69 #include "lttng-relayd.h"
70 #include "live.h"
71 #include "health-relayd.h"
72 #include "testpoint.h"
73 #include "viewer-stream.h"
74 #include "session.h"
75 #include "stream.h"
76 #include "connection.h"
77 #include "tracefile-array.h"
78 #include "tcp_keep_alive.h"
79 #include "sessiond-trace-chunks.h"
80
81 static const char *help_msg =
82 #ifdef LTTNG_EMBED_HELP
83 #include <lttng-relayd.8.h>
84 #else
85 NULL
86 #endif
87 ;
88
89 enum relay_connection_status {
90 RELAY_CONNECTION_STATUS_OK,
91 /* An error occurred while processing an event on the connection. */
92 RELAY_CONNECTION_STATUS_ERROR,
93 /* Connection closed/shutdown cleanly. */
94 RELAY_CONNECTION_STATUS_CLOSED,
95 };
96
97 /* command line options */
98 char *opt_output_path;
99 static int opt_daemon, opt_background;
100
101 /*
102 * We need to wait for listener and live listener threads, as well as
103 * health check thread, before being ready to signal readiness.
104 */
105 #define NR_LTTNG_RELAY_READY 3
106 static int lttng_relay_ready = NR_LTTNG_RELAY_READY;
107
108 /* Size of receive buffer. */
109 #define RECV_DATA_BUFFER_SIZE 65536
110
111 static int recv_child_signal; /* Set to 1 when a SIGUSR1 signal is received. */
112 static pid_t child_ppid; /* Internal parent PID use with daemonize. */
113
114 static struct lttng_uri *control_uri;
115 static struct lttng_uri *data_uri;
116 static struct lttng_uri *live_uri;
117
118 const char *progname;
119
120 const char *tracing_group_name = DEFAULT_TRACING_GROUP;
121 static int tracing_group_name_override;
122
123 const char * const config_section_name = "relayd";
124
125 /*
126 * Quit pipe for all threads. This permits a single cancellation point
127 * for all threads when receiving an event on the pipe.
128 */
129 int thread_quit_pipe[2] = { -1, -1 };
130
131 /*
132 * This pipe is used to inform the worker thread that a command is queued and
133 * ready to be processed.
134 */
135 static int relay_conn_pipe[2] = { -1, -1 };
136
137 /* Shared between threads */
138 static int dispatch_thread_exit;
139
140 static pthread_t listener_thread;
141 static pthread_t dispatcher_thread;
142 static pthread_t worker_thread;
143 static pthread_t health_thread;
144
145 /*
146 * last_relay_stream_id_lock protects last_relay_stream_id increment
147 * atomicity on 32-bit architectures.
148 */
149 static pthread_mutex_t last_relay_stream_id_lock = PTHREAD_MUTEX_INITIALIZER;
150 static uint64_t last_relay_stream_id;
151
152 /*
153 * Relay command queue.
154 *
155 * The relay_thread_listener and relay_thread_dispatcher communicate with this
156 * queue.
157 */
158 static struct relay_conn_queue relay_conn_queue;
159
160 /* Global relay stream hash table. */
161 struct lttng_ht *relay_streams_ht;
162
163 /* Global relay viewer stream hash table. */
164 struct lttng_ht *viewer_streams_ht;
165
166 /* Global relay sessions hash table. */
167 struct lttng_ht *sessions_ht;
168
169 /* Relayd health monitoring */
170 struct health_app *health_relayd;
171
172 struct sessiond_trace_chunk_registry *sessiond_trace_chunk_registry;
173
174 static struct option long_options[] = {
175 { "control-port", 1, 0, 'C', },
176 { "data-port", 1, 0, 'D', },
177 { "live-port", 1, 0, 'L', },
178 { "daemonize", 0, 0, 'd', },
179 { "background", 0, 0, 'b', },
180 { "group", 1, 0, 'g', },
181 { "help", 0, 0, 'h', },
182 { "output", 1, 0, 'o', },
183 { "verbose", 0, 0, 'v', },
184 { "config", 1, 0, 'f' },
185 { "version", 0, 0, 'V' },
186 { NULL, 0, 0, 0, },
187 };
188
189 static const char *config_ignore_options[] = { "help", "config", "version" };
190
191 /*
192 * Take an option from the getopt output and set it in the right variable to be
193 * used later.
194 *
195 * Return 0 on success else a negative value.
196 */
197 static int set_option(int opt, const char *arg, const char *optname)
198 {
199 int ret;
200
201 switch (opt) {
202 case 0:
203 fprintf(stderr, "option %s", optname);
204 if (arg) {
205 fprintf(stderr, " with arg %s\n", arg);
206 }
207 break;
208 case 'C':
209 if (lttng_is_setuid_setgid()) {
210 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
211 "-C, --control-port");
212 } else {
213 ret = uri_parse(arg, &control_uri);
214 if (ret < 0) {
215 ERR("Invalid control URI specified");
216 goto end;
217 }
218 if (control_uri->port == 0) {
219 control_uri->port = DEFAULT_NETWORK_CONTROL_PORT;
220 }
221 }
222 break;
223 case 'D':
224 if (lttng_is_setuid_setgid()) {
225 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
226 "-D, -data-port");
227 } else {
228 ret = uri_parse(arg, &data_uri);
229 if (ret < 0) {
230 ERR("Invalid data URI specified");
231 goto end;
232 }
233 if (data_uri->port == 0) {
234 data_uri->port = DEFAULT_NETWORK_DATA_PORT;
235 }
236 }
237 break;
238 case 'L':
239 if (lttng_is_setuid_setgid()) {
240 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
241 "-L, -live-port");
242 } else {
243 ret = uri_parse(arg, &live_uri);
244 if (ret < 0) {
245 ERR("Invalid live URI specified");
246 goto end;
247 }
248 if (live_uri->port == 0) {
249 live_uri->port = DEFAULT_NETWORK_VIEWER_PORT;
250 }
251 }
252 break;
253 case 'd':
254 opt_daemon = 1;
255 break;
256 case 'b':
257 opt_background = 1;
258 break;
259 case 'g':
260 if (lttng_is_setuid_setgid()) {
261 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
262 "-g, --group");
263 } else {
264 tracing_group_name = strdup(arg);
265 if (tracing_group_name == NULL) {
266 ret = -errno;
267 PERROR("strdup");
268 goto end;
269 }
270 tracing_group_name_override = 1;
271 }
272 break;
273 case 'h':
274 ret = utils_show_help(8, "lttng-relayd", help_msg);
275 if (ret) {
276 ERR("Cannot show --help for `lttng-relayd`");
277 perror("exec");
278 }
279 exit(EXIT_FAILURE);
280 case 'V':
281 fprintf(stdout, "%s\n", VERSION);
282 exit(EXIT_SUCCESS);
283 case 'o':
284 if (lttng_is_setuid_setgid()) {
285 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
286 "-o, --output");
287 } else {
288 ret = asprintf(&opt_output_path, "%s", arg);
289 if (ret < 0) {
290 ret = -errno;
291 PERROR("asprintf opt_output_path");
292 goto end;
293 }
294 }
295 break;
296 case 'v':
297 /* Verbose level can increase using multiple -v */
298 if (arg) {
299 lttng_opt_verbose = config_parse_value(arg);
300 } else {
301 /* Only 3 level of verbosity (-vvv). */
302 if (lttng_opt_verbose < 3) {
303 lttng_opt_verbose += 1;
304 }
305 }
306 break;
307 default:
308 /* Unknown option or other error.
309 * Error is printed by getopt, just return */
310 ret = -1;
311 goto end;
312 }
313
314 /* All good. */
315 ret = 0;
316
317 end:
318 return ret;
319 }
320
321 /*
322 * config_entry_handler_cb used to handle options read from a config file.
323 * See config_entry_handler_cb comment in common/config/session-config.h for the
324 * return value conventions.
325 */
326 static int config_entry_handler(const struct config_entry *entry, void *unused)
327 {
328 int ret = 0, i;
329
330 if (!entry || !entry->name || !entry->value) {
331 ret = -EINVAL;
332 goto end;
333 }
334
335 /* Check if the option is to be ignored */
336 for (i = 0; i < sizeof(config_ignore_options) / sizeof(char *); i++) {
337 if (!strcmp(entry->name, config_ignore_options[i])) {
338 goto end;
339 }
340 }
341
342 for (i = 0; i < (sizeof(long_options) / sizeof(struct option)) - 1; i++) {
343 /* Ignore if entry name is not fully matched. */
344 if (strcmp(entry->name, long_options[i].name)) {
345 continue;
346 }
347
348 /*
349 * If the option takes no argument on the command line,
350 * we have to check if the value is "true". We support
351 * non-zero numeric values, true, on and yes.
352 */
353 if (!long_options[i].has_arg) {
354 ret = config_parse_value(entry->value);
355 if (ret <= 0) {
356 if (ret) {
357 WARN("Invalid configuration value \"%s\" for option %s",
358 entry->value, entry->name);
359 }
360 /* False, skip boolean config option. */
361 goto end;
362 }
363 }
364
365 ret = set_option(long_options[i].val, entry->value, entry->name);
366 goto end;
367 }
368
369 WARN("Unrecognized option \"%s\" in daemon configuration file.",
370 entry->name);
371
372 end:
373 return ret;
374 }
375
376 static int set_options(int argc, char **argv)
377 {
378 int c, ret = 0, option_index = 0, retval = 0;
379 int orig_optopt = optopt, orig_optind = optind;
380 char *default_address, *optstring;
381 const char *config_path = NULL;
382
383 optstring = utils_generate_optstring(long_options,
384 sizeof(long_options) / sizeof(struct option));
385 if (!optstring) {
386 retval = -ENOMEM;
387 goto exit;
388 }
389
390 /* Check for the --config option */
391
392 while ((c = getopt_long(argc, argv, optstring, long_options,
393 &option_index)) != -1) {
394 if (c == '?') {
395 retval = -EINVAL;
396 goto exit;
397 } else if (c != 'f') {
398 continue;
399 }
400
401 if (lttng_is_setuid_setgid()) {
402 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
403 "-f, --config");
404 } else {
405 config_path = utils_expand_path(optarg);
406 if (!config_path) {
407 ERR("Failed to resolve path: %s", optarg);
408 }
409 }
410 }
411
412 ret = config_get_section_entries(config_path, config_section_name,
413 config_entry_handler, NULL);
414 if (ret) {
415 if (ret > 0) {
416 ERR("Invalid configuration option at line %i", ret);
417 }
418 retval = -1;
419 goto exit;
420 }
421
422 /* Reset getopt's global state */
423 optopt = orig_optopt;
424 optind = orig_optind;
425 while (1) {
426 c = getopt_long(argc, argv, optstring, long_options, &option_index);
427 if (c == -1) {
428 break;
429 }
430
431 ret = set_option(c, optarg, long_options[option_index].name);
432 if (ret < 0) {
433 retval = -1;
434 goto exit;
435 }
436 }
437
438 /* assign default values */
439 if (control_uri == NULL) {
440 ret = asprintf(&default_address,
441 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS ":%d",
442 DEFAULT_NETWORK_CONTROL_PORT);
443 if (ret < 0) {
444 PERROR("asprintf default data address");
445 retval = -1;
446 goto exit;
447 }
448
449 ret = uri_parse(default_address, &control_uri);
450 free(default_address);
451 if (ret < 0) {
452 ERR("Invalid control URI specified");
453 retval = -1;
454 goto exit;
455 }
456 }
457 if (data_uri == NULL) {
458 ret = asprintf(&default_address,
459 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS ":%d",
460 DEFAULT_NETWORK_DATA_PORT);
461 if (ret < 0) {
462 PERROR("asprintf default data address");
463 retval = -1;
464 goto exit;
465 }
466
467 ret = uri_parse(default_address, &data_uri);
468 free(default_address);
469 if (ret < 0) {
470 ERR("Invalid data URI specified");
471 retval = -1;
472 goto exit;
473 }
474 }
475 if (live_uri == NULL) {
476 ret = asprintf(&default_address,
477 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS ":%d",
478 DEFAULT_NETWORK_VIEWER_PORT);
479 if (ret < 0) {
480 PERROR("asprintf default viewer control address");
481 retval = -1;
482 goto exit;
483 }
484
485 ret = uri_parse(default_address, &live_uri);
486 free(default_address);
487 if (ret < 0) {
488 ERR("Invalid viewer control URI specified");
489 retval = -1;
490 goto exit;
491 }
492 }
493
494 exit:
495 free(optstring);
496 return retval;
497 }
498
499 static void print_global_objects(void)
500 {
501 rcu_register_thread();
502
503 print_viewer_streams();
504 print_relay_streams();
505 print_sessions();
506
507 rcu_unregister_thread();
508 }
509
510 /*
511 * Cleanup the daemon
512 */
513 static void relayd_cleanup(void)
514 {
515 print_global_objects();
516
517 DBG("Cleaning up");
518
519 if (viewer_streams_ht)
520 lttng_ht_destroy(viewer_streams_ht);
521 if (relay_streams_ht)
522 lttng_ht_destroy(relay_streams_ht);
523 if (sessions_ht)
524 lttng_ht_destroy(sessions_ht);
525
526 /* free the dynamically allocated opt_output_path */
527 free(opt_output_path);
528
529 /* Close thread quit pipes */
530 utils_close_pipe(thread_quit_pipe);
531
532 uri_free(control_uri);
533 uri_free(data_uri);
534 /* Live URI is freed in the live thread. */
535
536 if (tracing_group_name_override) {
537 free((void *) tracing_group_name);
538 }
539 }
540
541 /*
542 * Write to writable pipe used to notify a thread.
543 */
544 static int notify_thread_pipe(int wpipe)
545 {
546 ssize_t ret;
547
548 ret = lttng_write(wpipe, "!", 1);
549 if (ret < 1) {
550 PERROR("write poll pipe");
551 goto end;
552 }
553 ret = 0;
554 end:
555 return ret;
556 }
557
558 static int notify_health_quit_pipe(int *pipe)
559 {
560 ssize_t ret;
561
562 ret = lttng_write(pipe[1], "4", 1);
563 if (ret < 1) {
564 PERROR("write relay health quit");
565 goto end;
566 }
567 ret = 0;
568 end:
569 return ret;
570 }
571
572 /*
573 * Stop all relayd and relayd-live threads.
574 */
575 int lttng_relay_stop_threads(void)
576 {
577 int retval = 0;
578
579 /* Stopping all threads */
580 DBG("Terminating all threads");
581 if (notify_thread_pipe(thread_quit_pipe[1])) {
582 ERR("write error on thread quit pipe");
583 retval = -1;
584 }
585
586 if (notify_health_quit_pipe(health_quit_pipe)) {
587 ERR("write error on health quit pipe");
588 }
589
590 /* Dispatch thread */
591 CMM_STORE_SHARED(dispatch_thread_exit, 1);
592 futex_nto1_wake(&relay_conn_queue.futex);
593
594 if (relayd_live_stop()) {
595 ERR("Error stopping live threads");
596 retval = -1;
597 }
598 return retval;
599 }
600
601 /*
602 * Signal handler for the daemon
603 *
604 * Simply stop all worker threads, leaving main() return gracefully after
605 * joining all threads and calling cleanup().
606 */
607 static void sighandler(int sig)
608 {
609 switch (sig) {
610 case SIGINT:
611 DBG("SIGINT caught");
612 if (lttng_relay_stop_threads()) {
613 ERR("Error stopping threads");
614 }
615 break;
616 case SIGTERM:
617 DBG("SIGTERM caught");
618 if (lttng_relay_stop_threads()) {
619 ERR("Error stopping threads");
620 }
621 break;
622 case SIGUSR1:
623 CMM_STORE_SHARED(recv_child_signal, 1);
624 break;
625 default:
626 break;
627 }
628 }
629
630 /*
631 * Setup signal handler for :
632 * SIGINT, SIGTERM, SIGPIPE
633 */
634 static int set_signal_handler(void)
635 {
636 int ret = 0;
637 struct sigaction sa;
638 sigset_t sigset;
639
640 if ((ret = sigemptyset(&sigset)) < 0) {
641 PERROR("sigemptyset");
642 return ret;
643 }
644
645 sa.sa_mask = sigset;
646 sa.sa_flags = 0;
647
648 sa.sa_handler = sighandler;
649 if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
650 PERROR("sigaction");
651 return ret;
652 }
653
654 if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
655 PERROR("sigaction");
656 return ret;
657 }
658
659 if ((ret = sigaction(SIGUSR1, &sa, NULL)) < 0) {
660 PERROR("sigaction");
661 return ret;
662 }
663
664 sa.sa_handler = SIG_IGN;
665 if ((ret = sigaction(SIGPIPE, &sa, NULL)) < 0) {
666 PERROR("sigaction");
667 return ret;
668 }
669
670 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
671
672 return ret;
673 }
674
675 void lttng_relay_notify_ready(void)
676 {
677 /* Notify the parent of the fork() process that we are ready. */
678 if (opt_daemon || opt_background) {
679 if (uatomic_sub_return(&lttng_relay_ready, 1) == 0) {
680 kill(child_ppid, SIGUSR1);
681 }
682 }
683 }
684
685 /*
686 * Init thread quit pipe.
687 *
688 * Return -1 on error or 0 if all pipes are created.
689 */
690 static int init_thread_quit_pipe(void)
691 {
692 int ret;
693
694 ret = utils_create_pipe_cloexec(thread_quit_pipe);
695
696 return ret;
697 }
698
699 /*
700 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
701 */
702 static int create_thread_poll_set(struct lttng_poll_event *events, int size)
703 {
704 int ret;
705
706 if (events == NULL || size == 0) {
707 ret = -1;
708 goto error;
709 }
710
711 ret = lttng_poll_create(events, size, LTTNG_CLOEXEC);
712 if (ret < 0) {
713 goto error;
714 }
715
716 /* Add quit pipe */
717 ret = lttng_poll_add(events, thread_quit_pipe[0], LPOLLIN | LPOLLERR);
718 if (ret < 0) {
719 goto error;
720 }
721
722 return 0;
723
724 error:
725 return ret;
726 }
727
728 /*
729 * Check if the thread quit pipe was triggered.
730 *
731 * Return 1 if it was triggered else 0;
732 */
733 static int check_thread_quit_pipe(int fd, uint32_t events)
734 {
735 if (fd == thread_quit_pipe[0] && (events & LPOLLIN)) {
736 return 1;
737 }
738
739 return 0;
740 }
741
742 /*
743 * Create and init socket from uri.
744 */
745 static struct lttcomm_sock *relay_socket_create(struct lttng_uri *uri)
746 {
747 int ret;
748 struct lttcomm_sock *sock = NULL;
749
750 sock = lttcomm_alloc_sock_from_uri(uri);
751 if (sock == NULL) {
752 ERR("Allocating socket");
753 goto error;
754 }
755
756 ret = lttcomm_create_sock(sock);
757 if (ret < 0) {
758 goto error;
759 }
760 DBG("Listening on sock %d", sock->fd);
761
762 ret = sock->ops->bind(sock);
763 if (ret < 0) {
764 PERROR("Failed to bind socket");
765 goto error;
766 }
767
768 ret = sock->ops->listen(sock, -1);
769 if (ret < 0) {
770 goto error;
771
772 }
773
774 return sock;
775
776 error:
777 if (sock) {
778 lttcomm_destroy_sock(sock);
779 }
780 return NULL;
781 }
782
783 /*
784 * This thread manages the listening for new connections on the network
785 */
786 static void *relay_thread_listener(void *data)
787 {
788 int i, ret, pollfd, err = -1;
789 uint32_t revents, nb_fd;
790 struct lttng_poll_event events;
791 struct lttcomm_sock *control_sock, *data_sock;
792
793 DBG("[thread] Relay listener started");
794
795 health_register(health_relayd, HEALTH_RELAYD_TYPE_LISTENER);
796
797 health_code_update();
798
799 control_sock = relay_socket_create(control_uri);
800 if (!control_sock) {
801 goto error_sock_control;
802 }
803
804 data_sock = relay_socket_create(data_uri);
805 if (!data_sock) {
806 goto error_sock_relay;
807 }
808
809 /*
810 * Pass 3 as size here for the thread quit pipe, control and
811 * data socket.
812 */
813 ret = create_thread_poll_set(&events, 3);
814 if (ret < 0) {
815 goto error_create_poll;
816 }
817
818 /* Add the control socket */
819 ret = lttng_poll_add(&events, control_sock->fd, LPOLLIN | LPOLLRDHUP);
820 if (ret < 0) {
821 goto error_poll_add;
822 }
823
824 /* Add the data socket */
825 ret = lttng_poll_add(&events, data_sock->fd, LPOLLIN | LPOLLRDHUP);
826 if (ret < 0) {
827 goto error_poll_add;
828 }
829
830 lttng_relay_notify_ready();
831
832 if (testpoint(relayd_thread_listener)) {
833 goto error_testpoint;
834 }
835
836 while (1) {
837 health_code_update();
838
839 DBG("Listener accepting connections");
840
841 restart:
842 health_poll_entry();
843 ret = lttng_poll_wait(&events, -1);
844 health_poll_exit();
845 if (ret < 0) {
846 /*
847 * Restart interrupted system call.
848 */
849 if (errno == EINTR) {
850 goto restart;
851 }
852 goto error;
853 }
854
855 nb_fd = ret;
856
857 DBG("Relay new connection received");
858 for (i = 0; i < nb_fd; i++) {
859 health_code_update();
860
861 /* Fetch once the poll data */
862 revents = LTTNG_POLL_GETEV(&events, i);
863 pollfd = LTTNG_POLL_GETFD(&events, i);
864
865 /* Thread quit pipe has been closed. Killing thread. */
866 ret = check_thread_quit_pipe(pollfd, revents);
867 if (ret) {
868 err = 0;
869 goto exit;
870 }
871
872 if (revents & LPOLLIN) {
873 /*
874 * A new connection is requested, therefore a
875 * sessiond/consumerd connection is allocated in
876 * this thread, enqueued to a global queue and
877 * dequeued (and freed) in the worker thread.
878 */
879 int val = 1;
880 struct relay_connection *new_conn;
881 struct lttcomm_sock *newsock;
882 enum connection_type type;
883
884 if (pollfd == data_sock->fd) {
885 type = RELAY_DATA;
886 newsock = data_sock->ops->accept(data_sock);
887 DBG("Relay data connection accepted, socket %d",
888 newsock->fd);
889 } else {
890 assert(pollfd == control_sock->fd);
891 type = RELAY_CONTROL;
892 newsock = control_sock->ops->accept(control_sock);
893 DBG("Relay control connection accepted, socket %d",
894 newsock->fd);
895 }
896 if (!newsock) {
897 PERROR("accepting sock");
898 goto error;
899 }
900
901 ret = setsockopt(newsock->fd, SOL_SOCKET, SO_REUSEADDR, &val,
902 sizeof(val));
903 if (ret < 0) {
904 PERROR("setsockopt inet");
905 lttcomm_destroy_sock(newsock);
906 goto error;
907 }
908
909 ret = socket_apply_keep_alive_config(newsock->fd);
910 if (ret < 0) {
911 ERR("Failed to apply TCP keep-alive configuration on socket (%i)",
912 newsock->fd);
913 lttcomm_destroy_sock(newsock);
914 goto error;
915 }
916
917 new_conn = connection_create(newsock, type);
918 if (!new_conn) {
919 lttcomm_destroy_sock(newsock);
920 goto error;
921 }
922
923 /* Enqueue request for the dispatcher thread. */
924 cds_wfcq_enqueue(&relay_conn_queue.head, &relay_conn_queue.tail,
925 &new_conn->qnode);
926
927 /*
928 * Wake the dispatch queue futex.
929 * Implicit memory barrier with the
930 * exchange in cds_wfcq_enqueue.
931 */
932 futex_nto1_wake(&relay_conn_queue.futex);
933 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
934 ERR("socket poll error");
935 goto error;
936 } else {
937 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
938 goto error;
939 }
940 }
941 }
942
943 exit:
944 error:
945 error_poll_add:
946 error_testpoint:
947 lttng_poll_clean(&events);
948 error_create_poll:
949 if (data_sock->fd >= 0) {
950 ret = data_sock->ops->close(data_sock);
951 if (ret) {
952 PERROR("close");
953 }
954 }
955 lttcomm_destroy_sock(data_sock);
956 error_sock_relay:
957 if (control_sock->fd >= 0) {
958 ret = control_sock->ops->close(control_sock);
959 if (ret) {
960 PERROR("close");
961 }
962 }
963 lttcomm_destroy_sock(control_sock);
964 error_sock_control:
965 if (err) {
966 health_error();
967 ERR("Health error occurred in %s", __func__);
968 }
969 health_unregister(health_relayd);
970 DBG("Relay listener thread cleanup complete");
971 lttng_relay_stop_threads();
972 return NULL;
973 }
974
975 /*
976 * This thread manages the dispatching of the requests to worker threads
977 */
978 static void *relay_thread_dispatcher(void *data)
979 {
980 int err = -1;
981 ssize_t ret;
982 struct cds_wfcq_node *node;
983 struct relay_connection *new_conn = NULL;
984
985 DBG("[thread] Relay dispatcher started");
986
987 health_register(health_relayd, HEALTH_RELAYD_TYPE_DISPATCHER);
988
989 if (testpoint(relayd_thread_dispatcher)) {
990 goto error_testpoint;
991 }
992
993 health_code_update();
994
995 for (;;) {
996 health_code_update();
997
998 /* Atomically prepare the queue futex */
999 futex_nto1_prepare(&relay_conn_queue.futex);
1000
1001 if (CMM_LOAD_SHARED(dispatch_thread_exit)) {
1002 break;
1003 }
1004
1005 do {
1006 health_code_update();
1007
1008 /* Dequeue commands */
1009 node = cds_wfcq_dequeue_blocking(&relay_conn_queue.head,
1010 &relay_conn_queue.tail);
1011 if (node == NULL) {
1012 DBG("Woken up but nothing in the relay command queue");
1013 /* Continue thread execution */
1014 break;
1015 }
1016 new_conn = caa_container_of(node, struct relay_connection, qnode);
1017
1018 DBG("Dispatching request waiting on sock %d", new_conn->sock->fd);
1019
1020 /*
1021 * Inform worker thread of the new request. This
1022 * call is blocking so we can be assured that
1023 * the data will be read at some point in time
1024 * or wait to the end of the world :)
1025 */
1026 ret = lttng_write(relay_conn_pipe[1], &new_conn, sizeof(new_conn));
1027 if (ret < 0) {
1028 PERROR("write connection pipe");
1029 connection_put(new_conn);
1030 goto error;
1031 }
1032 } while (node != NULL);
1033
1034 /* Futex wait on queue. Blocking call on futex() */
1035 health_poll_entry();
1036 futex_nto1_wait(&relay_conn_queue.futex);
1037 health_poll_exit();
1038 }
1039
1040 /* Normal exit, no error */
1041 err = 0;
1042
1043 error:
1044 error_testpoint:
1045 if (err) {
1046 health_error();
1047 ERR("Health error occurred in %s", __func__);
1048 }
1049 health_unregister(health_relayd);
1050 DBG("Dispatch thread dying");
1051 lttng_relay_stop_threads();
1052 return NULL;
1053 }
1054
1055 static bool session_streams_have_index(const struct relay_session *session)
1056 {
1057 return session->minor >= 4 && !session->snapshot;
1058 }
1059
1060 /*
1061 * Handle the RELAYD_CREATE_SESSION command.
1062 *
1063 * On success, send back the session id or else return a negative value.
1064 */
1065 static int relay_create_session(const struct lttcomm_relayd_hdr *recv_hdr,
1066 struct relay_connection *conn,
1067 const struct lttng_buffer_view *payload)
1068 {
1069 int ret = 0;
1070 ssize_t send_ret;
1071 struct relay_session *session = NULL;
1072 struct lttcomm_relayd_create_session_reply_2_11 reply = {};
1073 char session_name[LTTNG_NAME_MAX] = {};
1074 char hostname[LTTNG_HOST_NAME_MAX] = {};
1075 uint32_t live_timer = 0;
1076 bool snapshot = false;
1077 bool session_name_contains_creation_timestamp = false;
1078 /* Left nil for peers < 2.11. */
1079 char base_path[LTTNG_PATH_MAX] = {};
1080 lttng_uuid sessiond_uuid = {};
1081 LTTNG_OPTIONAL(uint64_t) id_sessiond = {};
1082 LTTNG_OPTIONAL(uint64_t) current_chunk_id = {};
1083 LTTNG_OPTIONAL(time_t) creation_time = {};
1084 struct lttng_dynamic_buffer reply_payload;
1085
1086 lttng_dynamic_buffer_init(&reply_payload);
1087
1088 if (conn->minor < 4) {
1089 /* From 2.1 to 2.3 */
1090 ret = 0;
1091 } else if (conn->minor >= 4 && conn->minor < 11) {
1092 /* From 2.4 to 2.10 */
1093 ret = cmd_create_session_2_4(payload, session_name,
1094 hostname, &live_timer, &snapshot);
1095 } else {
1096 bool has_current_chunk;
1097 uint64_t current_chunk_id_value;
1098 time_t creation_time_value;
1099 uint64_t id_sessiond_value;
1100
1101 /* From 2.11 to ... */
1102 ret = cmd_create_session_2_11(payload, session_name, hostname,
1103 base_path, &live_timer, &snapshot, &id_sessiond_value,
1104 sessiond_uuid, &has_current_chunk,
1105 &current_chunk_id_value, &creation_time_value,
1106 &session_name_contains_creation_timestamp);
1107 if (lttng_uuid_is_nil(sessiond_uuid)) {
1108 /* The nil UUID is reserved for pre-2.11 clients. */
1109 ERR("Illegal nil UUID announced by peer in create session command");
1110 ret = -1;
1111 goto send_reply;
1112 }
1113 LTTNG_OPTIONAL_SET(&id_sessiond, id_sessiond_value);
1114 LTTNG_OPTIONAL_SET(&creation_time, creation_time_value);
1115 if (has_current_chunk) {
1116 LTTNG_OPTIONAL_SET(&current_chunk_id,
1117 current_chunk_id_value);
1118 }
1119 }
1120
1121 if (ret < 0) {
1122 goto send_reply;
1123 }
1124
1125 session = session_create(session_name, hostname, base_path, live_timer,
1126 snapshot, sessiond_uuid,
1127 id_sessiond.is_set ? &id_sessiond.value : NULL,
1128 current_chunk_id.is_set ? &current_chunk_id.value : NULL,
1129 creation_time.is_set ? &creation_time.value : NULL,
1130 conn->major, conn->minor,
1131 session_name_contains_creation_timestamp);
1132 if (!session) {
1133 ret = -1;
1134 goto send_reply;
1135 }
1136 assert(!conn->session);
1137 conn->session = session;
1138 DBG("Created session %" PRIu64, session->id);
1139
1140 reply.generic.session_id = htobe64(session->id);
1141
1142 send_reply:
1143 if (ret < 0) {
1144 reply.generic.ret_code = htobe32(LTTNG_ERR_FATAL);
1145 } else {
1146 reply.generic.ret_code = htobe32(LTTNG_OK);
1147 }
1148
1149 if (conn->minor < 11) {
1150 /* From 2.1 to 2.10 */
1151 ret = lttng_dynamic_buffer_append(&reply_payload,
1152 &reply.generic, sizeof(reply.generic));
1153 if (ret) {
1154 ERR("Failed to append \"create session\" command reply header to payload buffer");
1155 ret = -1;
1156 goto end;
1157 }
1158 } else {
1159 const uint32_t output_path_length =
1160 session ? strlen(session->output_path) + 1 : 0;
1161
1162 reply.output_path_length = htobe32(output_path_length);
1163 ret = lttng_dynamic_buffer_append(
1164 &reply_payload, &reply, sizeof(reply));
1165 if (ret) {
1166 ERR("Failed to append \"create session\" command reply header to payload buffer");
1167 goto end;
1168 }
1169
1170 if (output_path_length) {
1171 ret = lttng_dynamic_buffer_append(&reply_payload,
1172 session->output_path,
1173 output_path_length);
1174 if (ret) {
1175 ERR("Failed to append \"create session\" command reply path to payload buffer");
1176 goto end;
1177 }
1178 }
1179 }
1180
1181 send_ret = conn->sock->ops->sendmsg(conn->sock, reply_payload.data,
1182 reply_payload.size, 0);
1183 if (send_ret < (ssize_t) reply_payload.size) {
1184 ERR("Failed to send \"create session\" command reply of %zu bytes (ret = %zd)",
1185 reply_payload.size, send_ret);
1186 ret = -1;
1187 }
1188 end:
1189 if (ret < 0 && session) {
1190 session_put(session);
1191 }
1192 lttng_dynamic_buffer_reset(&reply_payload);
1193 return ret;
1194 }
1195
1196 /*
1197 * When we have received all the streams and the metadata for a channel,
1198 * we make them visible to the viewer threads.
1199 */
1200 static void publish_connection_local_streams(struct relay_connection *conn)
1201 {
1202 struct relay_stream *stream;
1203 struct relay_session *session = conn->session;
1204
1205 /*
1206 * We publish all streams belonging to a session atomically wrt
1207 * session lock.
1208 */
1209 pthread_mutex_lock(&session->lock);
1210 rcu_read_lock();
1211 cds_list_for_each_entry_rcu(stream, &session->recv_list,
1212 recv_node) {
1213 stream_publish(stream);
1214 }
1215 rcu_read_unlock();
1216
1217 /*
1218 * Inform the viewer that there are new streams in the session.
1219 */
1220 if (session->viewer_attached) {
1221 uatomic_set(&session->new_streams, 1);
1222 }
1223 pthread_mutex_unlock(&session->lock);
1224 }
1225
1226 static int conform_channel_path(char *channel_path)
1227 {
1228 int ret = 0;
1229
1230 if (strstr("../", channel_path)) {
1231 ERR("Refusing channel path as it walks up the path hierarchy: \"%s\"",
1232 channel_path);
1233 ret = -1;
1234 goto end;
1235 }
1236
1237 if (*channel_path == '/') {
1238 const size_t len = strlen(channel_path);
1239
1240 /*
1241 * Channel paths from peers prior to 2.11 are expressed as an
1242 * absolute path that is, in reality, relative to the relay
1243 * daemon's output directory. Remove the leading slash so it
1244 * is correctly interpreted as a relative path later on.
1245 *
1246 * len (and not len - 1) is used to copy the trailing NULL.
1247 */
1248 bcopy(channel_path + 1, channel_path, len);
1249 }
1250 end:
1251 return ret;
1252 }
1253
1254 /*
1255 * relay_add_stream: allocate a new stream for a session
1256 */
1257 static int relay_add_stream(const struct lttcomm_relayd_hdr *recv_hdr,
1258 struct relay_connection *conn,
1259 const struct lttng_buffer_view *payload)
1260 {
1261 int ret;
1262 ssize_t send_ret;
1263 struct relay_session *session = conn->session;
1264 struct relay_stream *stream = NULL;
1265 struct lttcomm_relayd_status_stream reply;
1266 struct ctf_trace *trace = NULL;
1267 uint64_t stream_handle = -1ULL;
1268 char *path_name = NULL, *channel_name = NULL;
1269 uint64_t tracefile_size = 0, tracefile_count = 0;
1270 LTTNG_OPTIONAL(uint64_t) stream_chunk_id = {};
1271
1272 if (!session || !conn->version_check_done) {
1273 ERR("Trying to add a stream before version check");
1274 ret = -1;
1275 goto end_no_session;
1276 }
1277
1278 if (session->minor == 1) {
1279 /* For 2.1 */
1280 ret = cmd_recv_stream_2_1(payload, &path_name,
1281 &channel_name);
1282 } else if (session->minor > 1 && session->minor < 11) {
1283 /* From 2.2 to 2.10 */
1284 ret = cmd_recv_stream_2_2(payload, &path_name,
1285 &channel_name, &tracefile_size, &tracefile_count);
1286 } else {
1287 /* From 2.11 to ... */
1288 ret = cmd_recv_stream_2_11(payload, &path_name,
1289 &channel_name, &tracefile_size, &tracefile_count,
1290 &stream_chunk_id.value);
1291 stream_chunk_id.is_set = true;
1292 }
1293
1294 if (ret < 0) {
1295 goto send_reply;
1296 }
1297
1298 if (conform_channel_path(path_name)) {
1299 goto send_reply;
1300 }
1301
1302 trace = ctf_trace_get_by_path_or_create(session, path_name);
1303 if (!trace) {
1304 goto send_reply;
1305 }
1306 /* This stream here has one reference on the trace. */
1307
1308 pthread_mutex_lock(&last_relay_stream_id_lock);
1309 stream_handle = ++last_relay_stream_id;
1310 pthread_mutex_unlock(&last_relay_stream_id_lock);
1311
1312 /* We pass ownership of path_name and channel_name. */
1313 stream = stream_create(trace, stream_handle, path_name,
1314 channel_name, tracefile_size, tracefile_count);
1315 path_name = NULL;
1316 channel_name = NULL;
1317
1318 /*
1319 * Streams are the owners of their trace. Reference to trace is
1320 * kept within stream_create().
1321 */
1322 ctf_trace_put(trace);
1323
1324 send_reply:
1325 memset(&reply, 0, sizeof(reply));
1326 reply.handle = htobe64(stream_handle);
1327 if (!stream) {
1328 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1329 } else {
1330 reply.ret_code = htobe32(LTTNG_OK);
1331 }
1332
1333 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1334 sizeof(struct lttcomm_relayd_status_stream), 0);
1335 if (send_ret < (ssize_t) sizeof(reply)) {
1336 ERR("Failed to send \"add stream\" command reply (ret = %zd)",
1337 send_ret);
1338 ret = -1;
1339 }
1340
1341 end_no_session:
1342 free(path_name);
1343 free(channel_name);
1344 return ret;
1345 }
1346
1347 /*
1348 * relay_close_stream: close a specific stream
1349 */
1350 static int relay_close_stream(const struct lttcomm_relayd_hdr *recv_hdr,
1351 struct relay_connection *conn,
1352 const struct lttng_buffer_view *payload)
1353 {
1354 int ret;
1355 ssize_t send_ret;
1356 struct relay_session *session = conn->session;
1357 struct lttcomm_relayd_close_stream stream_info;
1358 struct lttcomm_relayd_generic_reply reply;
1359 struct relay_stream *stream;
1360
1361 DBG("Close stream received");
1362
1363 if (!session || !conn->version_check_done) {
1364 ERR("Trying to close a stream before version check");
1365 ret = -1;
1366 goto end_no_session;
1367 }
1368
1369 if (payload->size < sizeof(stream_info)) {
1370 ERR("Unexpected payload size in \"relay_close_stream\": expected >= %zu bytes, got %zu bytes",
1371 sizeof(stream_info), payload->size);
1372 ret = -1;
1373 goto end_no_session;
1374 }
1375 memcpy(&stream_info, payload->data, sizeof(stream_info));
1376 stream_info.stream_id = be64toh(stream_info.stream_id);
1377 stream_info.last_net_seq_num = be64toh(stream_info.last_net_seq_num);
1378
1379 stream = stream_get_by_id(stream_info.stream_id);
1380 if (!stream) {
1381 ret = -1;
1382 goto end;
1383 }
1384
1385 /*
1386 * Set last_net_seq_num before the close flag. Required by data
1387 * pending check.
1388 */
1389 pthread_mutex_lock(&stream->lock);
1390 stream->last_net_seq_num = stream_info.last_net_seq_num;
1391 pthread_mutex_unlock(&stream->lock);
1392
1393 /*
1394 * This is one of the conditions which may trigger a stream close
1395 * with the others being:
1396 * 1) A close command is received for a stream
1397 * 2) The control connection owning the stream is closed
1398 * 3) We have received all of the stream's data _after_ a close
1399 * request.
1400 */
1401 try_stream_close(stream);
1402 if (stream->is_metadata) {
1403 struct relay_viewer_stream *vstream;
1404
1405 vstream = viewer_stream_get_by_id(stream->stream_handle);
1406 if (vstream) {
1407 if (vstream->metadata_sent == stream->metadata_received) {
1408 /*
1409 * Since all the metadata has been sent to the
1410 * viewer and that we have a request to close
1411 * its stream, we can safely teardown the
1412 * corresponding metadata viewer stream.
1413 */
1414 viewer_stream_put(vstream);
1415 }
1416 /* Put local reference. */
1417 viewer_stream_put(vstream);
1418 }
1419 }
1420 stream_put(stream);
1421 ret = 0;
1422
1423 end:
1424 memset(&reply, 0, sizeof(reply));
1425 if (ret < 0) {
1426 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1427 } else {
1428 reply.ret_code = htobe32(LTTNG_OK);
1429 }
1430 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1431 sizeof(struct lttcomm_relayd_generic_reply), 0);
1432 if (send_ret < (ssize_t) sizeof(reply)) {
1433 ERR("Failed to send \"close stream\" command reply (ret = %zd)",
1434 send_ret);
1435 ret = -1;
1436 }
1437
1438 end_no_session:
1439 return ret;
1440 }
1441
1442 /*
1443 * relay_reset_metadata: reset a metadata stream
1444 */
1445 static
1446 int relay_reset_metadata(const struct lttcomm_relayd_hdr *recv_hdr,
1447 struct relay_connection *conn,
1448 const struct lttng_buffer_view *payload)
1449 {
1450 int ret;
1451 ssize_t send_ret;
1452 struct relay_session *session = conn->session;
1453 struct lttcomm_relayd_reset_metadata stream_info;
1454 struct lttcomm_relayd_generic_reply reply;
1455 struct relay_stream *stream;
1456
1457 DBG("Reset metadata received");
1458
1459 if (!session || !conn->version_check_done) {
1460 ERR("Trying to reset a metadata stream before version check");
1461 ret = -1;
1462 goto end_no_session;
1463 }
1464
1465 if (payload->size < sizeof(stream_info)) {
1466 ERR("Unexpected payload size in \"relay_reset_metadata\": expected >= %zu bytes, got %zu bytes",
1467 sizeof(stream_info), payload->size);
1468 ret = -1;
1469 goto end_no_session;
1470 }
1471 memcpy(&stream_info, payload->data, sizeof(stream_info));
1472 stream_info.stream_id = be64toh(stream_info.stream_id);
1473 stream_info.version = be64toh(stream_info.version);
1474
1475 DBG("Update metadata to version %" PRIu64, stream_info.version);
1476
1477 /* Unsupported for live sessions for now. */
1478 if (session->live_timer != 0) {
1479 ret = -1;
1480 goto end;
1481 }
1482
1483 stream = stream_get_by_id(stream_info.stream_id);
1484 if (!stream) {
1485 ret = -1;
1486 goto end;
1487 }
1488 pthread_mutex_lock(&stream->lock);
1489 if (!stream->is_metadata) {
1490 ret = -1;
1491 goto end_unlock;
1492 }
1493
1494 ret = stream_reset_file(stream);
1495 if (ret < 0) {
1496 ERR("Failed to reset metadata stream %" PRIu64
1497 ": stream_path = %s, channel = %s",
1498 stream->stream_handle, stream->path_name,
1499 stream->channel_name);
1500 goto end_unlock;
1501 }
1502 end_unlock:
1503 pthread_mutex_unlock(&stream->lock);
1504 stream_put(stream);
1505
1506 end:
1507 memset(&reply, 0, sizeof(reply));
1508 if (ret < 0) {
1509 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1510 } else {
1511 reply.ret_code = htobe32(LTTNG_OK);
1512 }
1513 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1514 sizeof(struct lttcomm_relayd_generic_reply), 0);
1515 if (send_ret < (ssize_t) sizeof(reply)) {
1516 ERR("Failed to send \"reset metadata\" command reply (ret = %zd)",
1517 send_ret);
1518 ret = -1;
1519 }
1520
1521 end_no_session:
1522 return ret;
1523 }
1524
1525 /*
1526 * relay_unknown_command: send -1 if received unknown command
1527 */
1528 static void relay_unknown_command(struct relay_connection *conn)
1529 {
1530 struct lttcomm_relayd_generic_reply reply;
1531 ssize_t send_ret;
1532
1533 memset(&reply, 0, sizeof(reply));
1534 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1535 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1536 if (send_ret < sizeof(reply)) {
1537 ERR("Failed to send \"unknown command\" command reply (ret = %zd)", send_ret);
1538 }
1539 }
1540
1541 /*
1542 * relay_start: send an acknowledgment to the client to tell if we are
1543 * ready to receive data. We are ready if a session is established.
1544 */
1545 static int relay_start(const struct lttcomm_relayd_hdr *recv_hdr,
1546 struct relay_connection *conn,
1547 const struct lttng_buffer_view *payload)
1548 {
1549 int ret = 0;
1550 ssize_t send_ret;
1551 struct lttcomm_relayd_generic_reply reply;
1552 struct relay_session *session = conn->session;
1553
1554 if (!session) {
1555 DBG("Trying to start the streaming without a session established");
1556 ret = htobe32(LTTNG_ERR_UNK);
1557 }
1558
1559 memset(&reply, 0, sizeof(reply));
1560 reply.ret_code = htobe32(LTTNG_OK);
1561 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1562 sizeof(reply), 0);
1563 if (send_ret < (ssize_t) sizeof(reply)) {
1564 ERR("Failed to send \"relay_start\" command reply (ret = %zd)",
1565 send_ret);
1566 ret = -1;
1567 }
1568
1569 return ret;
1570 }
1571
1572 /*
1573 * relay_recv_metadata: receive the metadata for the session.
1574 */
1575 static int relay_recv_metadata(const struct lttcomm_relayd_hdr *recv_hdr,
1576 struct relay_connection *conn,
1577 const struct lttng_buffer_view *payload)
1578 {
1579 int ret = 0;
1580 struct relay_session *session = conn->session;
1581 struct lttcomm_relayd_metadata_payload metadata_payload_header;
1582 struct relay_stream *metadata_stream;
1583 uint64_t metadata_payload_size;
1584 struct lttng_buffer_view packet_view;
1585
1586 if (!session) {
1587 ERR("Metadata sent before version check");
1588 ret = -1;
1589 goto end;
1590 }
1591
1592 if (recv_hdr->data_size < sizeof(struct lttcomm_relayd_metadata_payload)) {
1593 ERR("Incorrect data size");
1594 ret = -1;
1595 goto end;
1596 }
1597 metadata_payload_size = recv_hdr->data_size -
1598 sizeof(struct lttcomm_relayd_metadata_payload);
1599
1600 memcpy(&metadata_payload_header, payload->data,
1601 sizeof(metadata_payload_header));
1602 metadata_payload_header.stream_id = be64toh(
1603 metadata_payload_header.stream_id);
1604 metadata_payload_header.padding_size = be32toh(
1605 metadata_payload_header.padding_size);
1606
1607 metadata_stream = stream_get_by_id(metadata_payload_header.stream_id);
1608 if (!metadata_stream) {
1609 ret = -1;
1610 goto end;
1611 }
1612
1613 packet_view = lttng_buffer_view_from_view(payload,
1614 sizeof(metadata_payload_header), metadata_payload_size);
1615 if (!packet_view.data) {
1616 ERR("Invalid metadata packet length announced by header");
1617 ret = -1;
1618 goto end_put;
1619 }
1620
1621 pthread_mutex_lock(&metadata_stream->lock);
1622 ret = stream_write(metadata_stream, &packet_view,
1623 metadata_payload_header.padding_size);
1624 pthread_mutex_unlock(&metadata_stream->lock);
1625 if (ret){
1626 ret = -1;
1627 goto end_put;
1628 }
1629 end_put:
1630 stream_put(metadata_stream);
1631 end:
1632 return ret;
1633 }
1634
1635 /*
1636 * relay_send_version: send relayd version number
1637 */
1638 static int relay_send_version(const struct lttcomm_relayd_hdr *recv_hdr,
1639 struct relay_connection *conn,
1640 const struct lttng_buffer_view *payload)
1641 {
1642 int ret;
1643 ssize_t send_ret;
1644 struct lttcomm_relayd_version reply, msg;
1645 bool compatible = true;
1646
1647 conn->version_check_done = true;
1648
1649 /* Get version from the other side. */
1650 if (payload->size < sizeof(msg)) {
1651 ERR("Unexpected payload size in \"relay_send_version\": expected >= %zu bytes, got %zu bytes",
1652 sizeof(msg), payload->size);
1653 ret = -1;
1654 goto end;
1655 }
1656
1657 memcpy(&msg, payload->data, sizeof(msg));
1658 msg.major = be32toh(msg.major);
1659 msg.minor = be32toh(msg.minor);
1660
1661 memset(&reply, 0, sizeof(reply));
1662 reply.major = RELAYD_VERSION_COMM_MAJOR;
1663 reply.minor = RELAYD_VERSION_COMM_MINOR;
1664
1665 /* Major versions must be the same */
1666 if (reply.major != msg.major) {
1667 DBG("Incompatible major versions (%u vs %u), deleting session",
1668 reply.major, msg.major);
1669 compatible = false;
1670 }
1671
1672 conn->major = reply.major;
1673 /* We adapt to the lowest compatible version */
1674 if (reply.minor <= msg.minor) {
1675 conn->minor = reply.minor;
1676 } else {
1677 conn->minor = msg.minor;
1678 }
1679
1680 reply.major = htobe32(reply.major);
1681 reply.minor = htobe32(reply.minor);
1682 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1683 sizeof(reply), 0);
1684 if (send_ret < (ssize_t) sizeof(reply)) {
1685 ERR("Failed to send \"send version\" command reply (ret = %zd)",
1686 send_ret);
1687 ret = -1;
1688 goto end;
1689 } else {
1690 ret = 0;
1691 }
1692
1693 if (!compatible) {
1694 ret = -1;
1695 goto end;
1696 }
1697
1698 DBG("Version check done using protocol %u.%u", conn->major,
1699 conn->minor);
1700
1701 end:
1702 return ret;
1703 }
1704
1705 /*
1706 * Check for data pending for a given stream id from the session daemon.
1707 */
1708 static int relay_data_pending(const struct lttcomm_relayd_hdr *recv_hdr,
1709 struct relay_connection *conn,
1710 const struct lttng_buffer_view *payload)
1711 {
1712 struct relay_session *session = conn->session;
1713 struct lttcomm_relayd_data_pending msg;
1714 struct lttcomm_relayd_generic_reply reply;
1715 struct relay_stream *stream;
1716 ssize_t send_ret;
1717 int ret;
1718 uint64_t stream_seq;
1719
1720 DBG("Data pending command received");
1721
1722 if (!session || !conn->version_check_done) {
1723 ERR("Trying to check for data before version check");
1724 ret = -1;
1725 goto end_no_session;
1726 }
1727
1728 if (payload->size < sizeof(msg)) {
1729 ERR("Unexpected payload size in \"relay_data_pending\": expected >= %zu bytes, got %zu bytes",
1730 sizeof(msg), payload->size);
1731 ret = -1;
1732 goto end_no_session;
1733 }
1734 memcpy(&msg, payload->data, sizeof(msg));
1735 msg.stream_id = be64toh(msg.stream_id);
1736 msg.last_net_seq_num = be64toh(msg.last_net_seq_num);
1737
1738 stream = stream_get_by_id(msg.stream_id);
1739 if (stream == NULL) {
1740 ret = -1;
1741 goto end;
1742 }
1743
1744 pthread_mutex_lock(&stream->lock);
1745
1746 if (session_streams_have_index(session)) {
1747 /*
1748 * Ensure that both the index and stream data have been
1749 * flushed up to the requested point.
1750 */
1751 stream_seq = min(stream->prev_data_seq, stream->prev_index_seq);
1752 } else {
1753 stream_seq = stream->prev_data_seq;
1754 }
1755 DBG("Data pending for stream id %" PRIu64 ": prev_data_seq %" PRIu64
1756 ", prev_index_seq %" PRIu64
1757 ", and last_seq %" PRIu64, msg.stream_id,
1758 stream->prev_data_seq, stream->prev_index_seq,
1759 msg.last_net_seq_num);
1760
1761 /* Avoid wrapping issue */
1762 if (((int64_t) (stream_seq - msg.last_net_seq_num)) >= 0) {
1763 /* Data has in fact been written and is NOT pending */
1764 ret = 0;
1765 } else {
1766 /* Data still being streamed thus pending */
1767 ret = 1;
1768 }
1769
1770 stream->data_pending_check_done = true;
1771 pthread_mutex_unlock(&stream->lock);
1772
1773 stream_put(stream);
1774 end:
1775
1776 memset(&reply, 0, sizeof(reply));
1777 reply.ret_code = htobe32(ret);
1778 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1779 if (send_ret < (ssize_t) sizeof(reply)) {
1780 ERR("Failed to send \"data pending\" command reply (ret = %zd)",
1781 send_ret);
1782 ret = -1;
1783 }
1784
1785 end_no_session:
1786 return ret;
1787 }
1788
1789 /*
1790 * Wait for the control socket to reach a quiescent state.
1791 *
1792 * Note that for now, when receiving this command from the session
1793 * daemon, this means that every subsequent commands or data received on
1794 * the control socket has been handled. So, this is why we simply return
1795 * OK here.
1796 */
1797 static int relay_quiescent_control(const struct lttcomm_relayd_hdr *recv_hdr,
1798 struct relay_connection *conn,
1799 const struct lttng_buffer_view *payload)
1800 {
1801 int ret;
1802 ssize_t send_ret;
1803 struct relay_stream *stream;
1804 struct lttcomm_relayd_quiescent_control msg;
1805 struct lttcomm_relayd_generic_reply reply;
1806
1807 DBG("Checking quiescent state on control socket");
1808
1809 if (!conn->session || !conn->version_check_done) {
1810 ERR("Trying to check for data before version check");
1811 ret = -1;
1812 goto end_no_session;
1813 }
1814
1815 if (payload->size < sizeof(msg)) {
1816 ERR("Unexpected payload size in \"relay_quiescent_control\": expected >= %zu bytes, got %zu bytes",
1817 sizeof(msg), payload->size);
1818 ret = -1;
1819 goto end_no_session;
1820 }
1821 memcpy(&msg, payload->data, sizeof(msg));
1822 msg.stream_id = be64toh(msg.stream_id);
1823
1824 stream = stream_get_by_id(msg.stream_id);
1825 if (!stream) {
1826 goto reply;
1827 }
1828 pthread_mutex_lock(&stream->lock);
1829 stream->data_pending_check_done = true;
1830 pthread_mutex_unlock(&stream->lock);
1831
1832 DBG("Relay quiescent control pending flag set to %" PRIu64, msg.stream_id);
1833 stream_put(stream);
1834 reply:
1835 memset(&reply, 0, sizeof(reply));
1836 reply.ret_code = htobe32(LTTNG_OK);
1837 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1838 if (send_ret < (ssize_t) sizeof(reply)) {
1839 ERR("Failed to send \"quiescent control\" command reply (ret = %zd)",
1840 send_ret);
1841 ret = -1;
1842 } else {
1843 ret = 0;
1844 }
1845
1846 end_no_session:
1847 return ret;
1848 }
1849
1850 /*
1851 * Initialize a data pending command. This means that a consumer is about
1852 * to ask for data pending for each stream it holds. Simply iterate over
1853 * all streams of a session and set the data_pending_check_done flag.
1854 *
1855 * This command returns to the client a LTTNG_OK code.
1856 */
1857 static int relay_begin_data_pending(const struct lttcomm_relayd_hdr *recv_hdr,
1858 struct relay_connection *conn,
1859 const struct lttng_buffer_view *payload)
1860 {
1861 int ret;
1862 ssize_t send_ret;
1863 struct lttng_ht_iter iter;
1864 struct lttcomm_relayd_begin_data_pending msg;
1865 struct lttcomm_relayd_generic_reply reply;
1866 struct relay_stream *stream;
1867
1868 assert(recv_hdr);
1869 assert(conn);
1870
1871 DBG("Init streams for data pending");
1872
1873 if (!conn->session || !conn->version_check_done) {
1874 ERR("Trying to check for data before version check");
1875 ret = -1;
1876 goto end_no_session;
1877 }
1878
1879 if (payload->size < sizeof(msg)) {
1880 ERR("Unexpected payload size in \"relay_begin_data_pending\": expected >= %zu bytes, got %zu bytes",
1881 sizeof(msg), payload->size);
1882 ret = -1;
1883 goto end_no_session;
1884 }
1885 memcpy(&msg, payload->data, sizeof(msg));
1886 msg.session_id = be64toh(msg.session_id);
1887
1888 /*
1889 * Iterate over all streams to set the begin data pending flag.
1890 * For now, the streams are indexed by stream handle so we have
1891 * to iterate over all streams to find the one associated with
1892 * the right session_id.
1893 */
1894 rcu_read_lock();
1895 cds_lfht_for_each_entry(relay_streams_ht->ht, &iter.iter, stream,
1896 node.node) {
1897 if (!stream_get(stream)) {
1898 continue;
1899 }
1900 if (stream->trace->session->id == msg.session_id) {
1901 pthread_mutex_lock(&stream->lock);
1902 stream->data_pending_check_done = false;
1903 pthread_mutex_unlock(&stream->lock);
1904 DBG("Set begin data pending flag to stream %" PRIu64,
1905 stream->stream_handle);
1906 }
1907 stream_put(stream);
1908 }
1909 rcu_read_unlock();
1910
1911 memset(&reply, 0, sizeof(reply));
1912 /* All good, send back reply. */
1913 reply.ret_code = htobe32(LTTNG_OK);
1914
1915 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1916 if (send_ret < (ssize_t) sizeof(reply)) {
1917 ERR("Failed to send \"begin data pending\" command reply (ret = %zd)",
1918 send_ret);
1919 ret = -1;
1920 } else {
1921 ret = 0;
1922 }
1923
1924 end_no_session:
1925 return ret;
1926 }
1927
1928 /*
1929 * End data pending command. This will check, for a given session id, if
1930 * each stream associated with it has its data_pending_check_done flag
1931 * set. If not, this means that the client lost track of the stream but
1932 * the data is still being streamed on our side. In this case, we inform
1933 * the client that data is in flight.
1934 *
1935 * Return to the client if there is data in flight or not with a ret_code.
1936 */
1937 static int relay_end_data_pending(const struct lttcomm_relayd_hdr *recv_hdr,
1938 struct relay_connection *conn,
1939 const struct lttng_buffer_view *payload)
1940 {
1941 int ret;
1942 ssize_t send_ret;
1943 struct lttng_ht_iter iter;
1944 struct lttcomm_relayd_end_data_pending msg;
1945 struct lttcomm_relayd_generic_reply reply;
1946 struct relay_stream *stream;
1947 uint32_t is_data_inflight = 0;
1948
1949 DBG("End data pending command");
1950
1951 if (!conn->session || !conn->version_check_done) {
1952 ERR("Trying to check for data before version check");
1953 ret = -1;
1954 goto end_no_session;
1955 }
1956
1957 if (payload->size < sizeof(msg)) {
1958 ERR("Unexpected payload size in \"relay_end_data_pending\": expected >= %zu bytes, got %zu bytes",
1959 sizeof(msg), payload->size);
1960 ret = -1;
1961 goto end_no_session;
1962 }
1963 memcpy(&msg, payload->data, sizeof(msg));
1964 msg.session_id = be64toh(msg.session_id);
1965
1966 /*
1967 * Iterate over all streams to see if the begin data pending
1968 * flag is set.
1969 */
1970 rcu_read_lock();
1971 cds_lfht_for_each_entry(relay_streams_ht->ht, &iter.iter, stream,
1972 node.node) {
1973 if (!stream_get(stream)) {
1974 continue;
1975 }
1976 if (stream->trace->session->id != msg.session_id) {
1977 stream_put(stream);
1978 continue;
1979 }
1980 pthread_mutex_lock(&stream->lock);
1981 if (!stream->data_pending_check_done) {
1982 uint64_t stream_seq;
1983
1984 if (session_streams_have_index(conn->session)) {
1985 /*
1986 * Ensure that both the index and stream data have been
1987 * flushed up to the requested point.
1988 */
1989 stream_seq = min(stream->prev_data_seq, stream->prev_index_seq);
1990 } else {
1991 stream_seq = stream->prev_data_seq;
1992 }
1993 if (!stream->closed || !(((int64_t) (stream_seq - stream->last_net_seq_num)) >= 0)) {
1994 is_data_inflight = 1;
1995 DBG("Data is still in flight for stream %" PRIu64,
1996 stream->stream_handle);
1997 pthread_mutex_unlock(&stream->lock);
1998 stream_put(stream);
1999 break;
2000 }
2001 }
2002 pthread_mutex_unlock(&stream->lock);
2003 stream_put(stream);
2004 }
2005 rcu_read_unlock();
2006
2007 memset(&reply, 0, sizeof(reply));
2008 /* All good, send back reply. */
2009 reply.ret_code = htobe32(is_data_inflight);
2010
2011 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2012 if (send_ret < (ssize_t) sizeof(reply)) {
2013 ERR("Failed to send \"end data pending\" command reply (ret = %zd)",
2014 send_ret);
2015 ret = -1;
2016 } else {
2017 ret = 0;
2018 }
2019
2020 end_no_session:
2021 return ret;
2022 }
2023
2024 /*
2025 * Receive an index for a specific stream.
2026 *
2027 * Return 0 on success else a negative value.
2028 */
2029 static int relay_recv_index(const struct lttcomm_relayd_hdr *recv_hdr,
2030 struct relay_connection *conn,
2031 const struct lttng_buffer_view *payload)
2032 {
2033 int ret;
2034 ssize_t send_ret;
2035 struct relay_session *session = conn->session;
2036 struct lttcomm_relayd_index index_info;
2037 struct lttcomm_relayd_generic_reply reply;
2038 struct relay_stream *stream;
2039 size_t msg_len;
2040
2041 assert(conn);
2042
2043 DBG("Relay receiving index");
2044
2045 if (!session || !conn->version_check_done) {
2046 ERR("Trying to close a stream before version check");
2047 ret = -1;
2048 goto end_no_session;
2049 }
2050
2051 msg_len = lttcomm_relayd_index_len(
2052 lttng_to_index_major(conn->major, conn->minor),
2053 lttng_to_index_minor(conn->major, conn->minor));
2054 if (payload->size < msg_len) {
2055 ERR("Unexpected payload size in \"relay_recv_index\": expected >= %zu bytes, got %zu bytes",
2056 msg_len, payload->size);
2057 ret = -1;
2058 goto end_no_session;
2059 }
2060 memcpy(&index_info, payload->data, msg_len);
2061 index_info.relay_stream_id = be64toh(index_info.relay_stream_id);
2062 index_info.net_seq_num = be64toh(index_info.net_seq_num);
2063 index_info.packet_size = be64toh(index_info.packet_size);
2064 index_info.content_size = be64toh(index_info.content_size);
2065 index_info.timestamp_begin = be64toh(index_info.timestamp_begin);
2066 index_info.timestamp_end = be64toh(index_info.timestamp_end);
2067 index_info.events_discarded = be64toh(index_info.events_discarded);
2068 index_info.stream_id = be64toh(index_info.stream_id);
2069
2070 if (conn->minor >= 8) {
2071 index_info.stream_instance_id =
2072 be64toh(index_info.stream_instance_id);
2073 index_info.packet_seq_num = be64toh(index_info.packet_seq_num);
2074 }
2075
2076 stream = stream_get_by_id(index_info.relay_stream_id);
2077 if (!stream) {
2078 ERR("stream_get_by_id not found");
2079 ret = -1;
2080 goto end;
2081 }
2082
2083 pthread_mutex_lock(&stream->lock);
2084 ret = stream_add_index(stream, &index_info);
2085 pthread_mutex_unlock(&stream->lock);
2086 if (ret) {
2087 goto end_stream_put;
2088 }
2089
2090 end_stream_put:
2091 stream_put(stream);
2092 end:
2093 memset(&reply, 0, sizeof(reply));
2094 if (ret < 0) {
2095 reply.ret_code = htobe32(LTTNG_ERR_UNK);
2096 } else {
2097 reply.ret_code = htobe32(LTTNG_OK);
2098 }
2099 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2100 if (send_ret < (ssize_t) sizeof(reply)) {
2101 ERR("Failed to send \"recv index\" command reply (ret = %zd)", send_ret);
2102 ret = -1;
2103 }
2104
2105 end_no_session:
2106 return ret;
2107 }
2108
2109 /*
2110 * Receive the streams_sent message.
2111 *
2112 * Return 0 on success else a negative value.
2113 */
2114 static int relay_streams_sent(const struct lttcomm_relayd_hdr *recv_hdr,
2115 struct relay_connection *conn,
2116 const struct lttng_buffer_view *payload)
2117 {
2118 int ret;
2119 ssize_t send_ret;
2120 struct lttcomm_relayd_generic_reply reply;
2121
2122 assert(conn);
2123
2124 DBG("Relay receiving streams_sent");
2125
2126 if (!conn->session || !conn->version_check_done) {
2127 ERR("Trying to close a stream before version check");
2128 ret = -1;
2129 goto end_no_session;
2130 }
2131
2132 /*
2133 * Publish every pending stream in the connection recv list which are
2134 * now ready to be used by the viewer.
2135 */
2136 publish_connection_local_streams(conn);
2137
2138 memset(&reply, 0, sizeof(reply));
2139 reply.ret_code = htobe32(LTTNG_OK);
2140 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2141 if (send_ret < (ssize_t) sizeof(reply)) {
2142 ERR("Failed to send \"streams sent\" command reply (ret = %zd)",
2143 send_ret);
2144 ret = -1;
2145 } else {
2146 /* Success. */
2147 ret = 0;
2148 }
2149
2150 end_no_session:
2151 return ret;
2152 }
2153
2154 /*
2155 * relay_rotate_session_stream: rotate a stream to a new tracefile for the
2156 * session rotation feature (not the tracefile rotation feature).
2157 */
2158 static int relay_rotate_session_streams(
2159 const struct lttcomm_relayd_hdr *recv_hdr,
2160 struct relay_connection *conn,
2161 const struct lttng_buffer_view *payload)
2162 {
2163 int ret = 0;
2164 uint32_t i;
2165 ssize_t send_ret;
2166 enum lttng_error_code reply_code = LTTNG_ERR_UNK;
2167 struct relay_session *session = conn->session;
2168 struct lttcomm_relayd_rotate_streams rotate_streams;
2169 struct lttcomm_relayd_generic_reply reply = {};
2170 struct relay_stream *stream = NULL;
2171 const size_t header_len = sizeof(struct lttcomm_relayd_rotate_streams);
2172 struct lttng_trace_chunk *next_trace_chunk = NULL;
2173 struct lttng_buffer_view stream_positions;
2174 char chunk_id_buf[MAX_INT_DEC_LEN(uint64_t)];
2175 const char *chunk_id_str = "none";
2176
2177 if (!session || !conn->version_check_done) {
2178 ERR("Trying to rotate a stream before version check");
2179 ret = -1;
2180 goto end_no_reply;
2181 }
2182
2183 if (session->major == 2 && session->minor < 11) {
2184 ERR("Unsupported feature before 2.11");
2185 ret = -1;
2186 goto end_no_reply;
2187 }
2188
2189 if (payload->size < header_len) {
2190 ERR("Unexpected payload size in \"relay_rotate_session_stream\": expected >= %zu bytes, got %zu bytes",
2191 header_len, payload->size);
2192 ret = -1;
2193 goto end_no_reply;
2194 }
2195
2196 memcpy(&rotate_streams, payload->data, header_len);
2197
2198 /* Convert header to host endianness. */
2199 rotate_streams = (typeof(rotate_streams)) {
2200 .stream_count = be32toh(rotate_streams.stream_count),
2201 .new_chunk_id = (typeof(rotate_streams.new_chunk_id)) {
2202 .is_set = !!rotate_streams.new_chunk_id.is_set,
2203 .value = be64toh(rotate_streams.new_chunk_id.value),
2204 }
2205 };
2206
2207 if (rotate_streams.new_chunk_id.is_set) {
2208 /*
2209 * Retrieve the trace chunk the stream must transition to. As
2210 * per the protocol, this chunk should have been created
2211 * before this command is received.
2212 */
2213 next_trace_chunk = sessiond_trace_chunk_registry_get_chunk(
2214 sessiond_trace_chunk_registry,
2215 session->sessiond_uuid, session->id,
2216 rotate_streams.new_chunk_id.value);
2217 if (!next_trace_chunk) {
2218 char uuid_str[UUID_STR_LEN];
2219
2220 lttng_uuid_to_str(session->sessiond_uuid, uuid_str);
2221 ERR("Unknown next trace chunk in ROTATE_STREAMS command: sessiond_uuid = {%s}, session_id = %" PRIu64
2222 ", trace_chunk_id = %" PRIu64,
2223 uuid_str, session->id,
2224 rotate_streams.new_chunk_id.value);
2225 reply_code = LTTNG_ERR_INVALID_PROTOCOL;
2226 ret = -1;
2227 goto end;
2228 }
2229
2230 ret = snprintf(chunk_id_buf, sizeof(chunk_id_buf), "%" PRIu64,
2231 rotate_streams.new_chunk_id.value);
2232 if (ret < 0 || ret >= sizeof(chunk_id_buf)) {
2233 chunk_id_str = "formatting error";
2234 } else {
2235 chunk_id_str = chunk_id_buf;
2236 }
2237 session->has_rotated = true;
2238 }
2239
2240 DBG("Rotate %" PRIu32 " streams of session \"%s\" to chunk \"%s\"",
2241 rotate_streams.stream_count, session->session_name,
2242 chunk_id_str);
2243
2244 stream_positions = lttng_buffer_view_from_view(payload,
2245 sizeof(rotate_streams), -1);
2246 if (!stream_positions.data ||
2247 stream_positions.size <
2248 (rotate_streams.stream_count *
2249 sizeof(struct lttcomm_relayd_stream_rotation_position))) {
2250 reply_code = LTTNG_ERR_INVALID_PROTOCOL;
2251 ret = -1;
2252 goto end;
2253 }
2254
2255 for (i = 0; i < rotate_streams.stream_count; i++) {
2256 struct lttcomm_relayd_stream_rotation_position *position_comm =
2257 &((typeof(position_comm)) stream_positions.data)[i];
2258 const struct lttcomm_relayd_stream_rotation_position pos = {
2259 .stream_id = be64toh(position_comm->stream_id),
2260 .rotate_at_seq_num = be64toh(
2261 position_comm->rotate_at_seq_num),
2262 };
2263
2264 stream = stream_get_by_id(pos.stream_id);
2265 if (!stream) {
2266 reply_code = LTTNG_ERR_INVALID;
2267 ret = -1;
2268 goto end;
2269 }
2270
2271 pthread_mutex_lock(&stream->lock);
2272 ret = stream_set_pending_rotation(stream, next_trace_chunk,
2273 pos.rotate_at_seq_num);
2274 pthread_mutex_unlock(&stream->lock);
2275 if (ret) {
2276 reply_code = LTTNG_ERR_FILE_CREATION_ERROR;
2277 goto end;
2278 }
2279
2280 stream_put(stream);
2281 stream = NULL;
2282 }
2283
2284 reply_code = LTTNG_OK;
2285 end:
2286 if (stream) {
2287 stream_put(stream);
2288 }
2289
2290 reply.ret_code = htobe32((uint32_t) reply_code);
2291 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
2292 sizeof(struct lttcomm_relayd_generic_reply), 0);
2293 if (send_ret < (ssize_t) sizeof(reply)) {
2294 ERR("Failed to send \"rotate session stream\" command reply (ret = %zd)",
2295 send_ret);
2296 ret = -1;
2297 }
2298
2299 ret = 0;
2300 end_no_reply:
2301 lttng_trace_chunk_put(next_trace_chunk);
2302 return ret;
2303 }
2304
2305
2306
2307 /*
2308 * relay_create_trace_chunk: create a new trace chunk
2309 */
2310 static int relay_create_trace_chunk(const struct lttcomm_relayd_hdr *recv_hdr,
2311 struct relay_connection *conn,
2312 const struct lttng_buffer_view *payload)
2313 {
2314 int ret = 0;
2315 ssize_t send_ret;
2316 struct relay_session *session = conn->session;
2317 struct lttcomm_relayd_create_trace_chunk *msg;
2318 struct lttcomm_relayd_generic_reply reply = {};
2319 struct lttng_buffer_view header_view;
2320 struct lttng_buffer_view chunk_name_view;
2321 struct lttng_trace_chunk *chunk = NULL, *published_chunk = NULL;
2322 enum lttng_error_code reply_code = LTTNG_OK;
2323 enum lttng_trace_chunk_status chunk_status;
2324 struct lttng_directory_handle session_output;
2325
2326 if (!session || !conn->version_check_done) {
2327 ERR("Trying to create a trace chunk before version check");
2328 ret = -1;
2329 goto end_no_reply;
2330 }
2331
2332 if (session->major == 2 && session->minor < 11) {
2333 ERR("Chunk creation command is unsupported before 2.11");
2334 ret = -1;
2335 goto end_no_reply;
2336 }
2337
2338 header_view = lttng_buffer_view_from_view(payload, 0, sizeof(*msg));
2339 if (!header_view.data) {
2340 ERR("Failed to receive payload of chunk creation command");
2341 ret = -1;
2342 goto end_no_reply;
2343 }
2344
2345 /* Convert to host endianness. */
2346 msg = (typeof(msg)) header_view.data;
2347 msg->chunk_id = be64toh(msg->chunk_id);
2348 msg->creation_timestamp = be64toh(msg->creation_timestamp);
2349 msg->override_name_length = be32toh(msg->override_name_length);
2350
2351 chunk = lttng_trace_chunk_create(
2352 msg->chunk_id, msg->creation_timestamp);
2353 if (!chunk) {
2354 ERR("Failed to create trace chunk in trace chunk creation command");
2355 ret = -1;
2356 reply_code = LTTNG_ERR_NOMEM;
2357 goto end;
2358 }
2359
2360 if (msg->override_name_length) {
2361 const char *name;
2362
2363 chunk_name_view = lttng_buffer_view_from_view(payload,
2364 sizeof(*msg),
2365 msg->override_name_length);
2366 name = chunk_name_view.data;
2367 if (!name || name[msg->override_name_length - 1]) {
2368 ERR("Failed to receive payload of chunk creation command");
2369 ret = -1;
2370 reply_code = LTTNG_ERR_INVALID;
2371 goto end;
2372 }
2373
2374 chunk_status = lttng_trace_chunk_override_name(
2375 chunk, chunk_name_view.data);
2376 switch (chunk_status) {
2377 case LTTNG_TRACE_CHUNK_STATUS_OK:
2378 break;
2379 case LTTNG_TRACE_CHUNK_STATUS_INVALID_ARGUMENT:
2380 ERR("Failed to set the name of new trace chunk in trace chunk creation command (invalid name)");
2381 reply_code = LTTNG_ERR_INVALID;
2382 ret = -1;
2383 goto end;
2384 default:
2385 ERR("Failed to set the name of new trace chunk in trace chunk creation command (unknown error)");
2386 reply_code = LTTNG_ERR_UNK;
2387 ret = -1;
2388 goto end;
2389 }
2390 }
2391
2392 chunk_status = lttng_trace_chunk_set_credentials_current_user(chunk);
2393 if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) {
2394 reply_code = LTTNG_ERR_UNK;
2395 ret = -1;
2396 goto end;
2397 }
2398
2399 ret = session_init_output_directory_handle(
2400 conn->session, &session_output);
2401 if (ret) {
2402 reply_code = LTTNG_ERR_CREATE_DIR_FAIL;
2403 goto end;
2404 }
2405 chunk_status = lttng_trace_chunk_set_as_owner(chunk, &session_output);
2406 lttng_directory_handle_fini(&session_output);
2407 if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) {
2408 reply_code = LTTNG_ERR_UNK;
2409 ret = -1;
2410 goto end;
2411 }
2412
2413 published_chunk = sessiond_trace_chunk_registry_publish_chunk(
2414 sessiond_trace_chunk_registry,
2415 conn->session->sessiond_uuid,
2416 conn->session->id,
2417 chunk);
2418 if (!published_chunk) {
2419 char uuid_str[UUID_STR_LEN];
2420
2421 lttng_uuid_to_str(conn->session->sessiond_uuid, uuid_str);
2422 ERR("Failed to publish chunk: sessiond_uuid = %s, session_id = %" PRIu64 ", chunk_id = %" PRIu64,
2423 uuid_str,
2424 conn->session->id,
2425 msg->chunk_id);
2426 ret = -1;
2427 reply_code = LTTNG_ERR_NOMEM;
2428 goto end;
2429 }
2430
2431 pthread_mutex_lock(&conn->session->lock);
2432 if (conn->session->pending_closure_trace_chunk) {
2433 /*
2434 * Invalid; this means a second create_trace_chunk command was
2435 * received before a close_trace_chunk.
2436 */
2437 ERR("Invalid trace chunk close command received; a trace chunk is already waiting for a trace chunk close command");
2438 reply_code = LTTNG_ERR_INVALID_PROTOCOL;
2439 ret = -1;
2440 goto end_unlock_session;
2441 }
2442 conn->session->pending_closure_trace_chunk =
2443 conn->session->current_trace_chunk;
2444 conn->session->current_trace_chunk = published_chunk;
2445 published_chunk = NULL;
2446 end_unlock_session:
2447 pthread_mutex_unlock(&conn->session->lock);
2448 end:
2449 reply.ret_code = htobe32((uint32_t) reply_code);
2450 send_ret = conn->sock->ops->sendmsg(conn->sock,
2451 &reply,
2452 sizeof(struct lttcomm_relayd_generic_reply),
2453 0);
2454 if (send_ret < (ssize_t) sizeof(reply)) {
2455 ERR("Failed to send \"create trace chunk\" command reply (ret = %zd)",
2456 send_ret);
2457 ret = -1;
2458 }
2459 end_no_reply:
2460 lttng_trace_chunk_put(chunk);
2461 lttng_trace_chunk_put(published_chunk);
2462 return ret;
2463 }
2464
2465 /*
2466 * relay_close_trace_chunk: close a trace chunk
2467 */
2468 static int relay_close_trace_chunk(const struct lttcomm_relayd_hdr *recv_hdr,
2469 struct relay_connection *conn,
2470 const struct lttng_buffer_view *payload)
2471 {
2472 int ret = 0, buf_ret;
2473 ssize_t send_ret;
2474 struct relay_session *session = conn->session;
2475 struct lttcomm_relayd_close_trace_chunk *msg;
2476 struct lttcomm_relayd_close_trace_chunk_reply reply = {};
2477 struct lttng_buffer_view header_view;
2478 struct lttng_trace_chunk *chunk = NULL;
2479 enum lttng_error_code reply_code = LTTNG_OK;
2480 enum lttng_trace_chunk_status chunk_status;
2481 uint64_t chunk_id;
2482 LTTNG_OPTIONAL(enum lttng_trace_chunk_command_type) close_command = {};
2483 time_t close_timestamp;
2484 char closed_trace_chunk_path[LTTNG_PATH_MAX];
2485 size_t path_length = 0;
2486 const char *chunk_name = NULL;
2487 struct lttng_dynamic_buffer reply_payload;
2488
2489 lttng_dynamic_buffer_init(&reply_payload);
2490
2491 if (!session || !conn->version_check_done) {
2492 ERR("Trying to close a trace chunk before version check");
2493 ret = -1;
2494 goto end_no_reply;
2495 }
2496
2497 if (session->major == 2 && session->minor < 11) {
2498 ERR("Chunk close command is unsupported before 2.11");
2499 ret = -1;
2500 goto end_no_reply;
2501 }
2502
2503 header_view = lttng_buffer_view_from_view(payload, 0, sizeof(*msg));
2504 if (!header_view.data) {
2505 ERR("Failed to receive payload of chunk close command");
2506 ret = -1;
2507 goto end_no_reply;
2508 }
2509
2510 /* Convert to host endianness. */
2511 msg = (typeof(msg)) header_view.data;
2512 chunk_id = be64toh(msg->chunk_id);
2513 close_timestamp = (time_t) be64toh(msg->close_timestamp);
2514 close_command = (typeof(close_command)){
2515 .value = be32toh(msg->close_command.value),
2516 .is_set = msg->close_command.is_set,
2517 };
2518
2519 chunk = sessiond_trace_chunk_registry_get_chunk(
2520 sessiond_trace_chunk_registry,
2521 conn->session->sessiond_uuid,
2522 conn->session->id,
2523 chunk_id);
2524 if (!chunk) {
2525 char uuid_str[UUID_STR_LEN];
2526
2527 lttng_uuid_to_str(conn->session->sessiond_uuid, uuid_str);
2528 ERR("Failed to find chunk to close: sessiond_uuid = %s, session_id = %" PRIu64 ", chunk_id = %" PRIu64,
2529 uuid_str,
2530 conn->session->id,
2531 msg->chunk_id);
2532 ret = -1;
2533 reply_code = LTTNG_ERR_NOMEM;
2534 goto end;
2535 }
2536
2537 pthread_mutex_lock(&session->lock);
2538 if (session->pending_closure_trace_chunk &&
2539 session->pending_closure_trace_chunk != chunk) {
2540 ERR("Trace chunk close command for session \"%s\" does not target the trace chunk pending closure",
2541 session->session_name);
2542 reply_code = LTTNG_ERR_INVALID_PROTOCOL;
2543 ret = -1;
2544 goto end_unlock_session;
2545 }
2546
2547 chunk_status = lttng_trace_chunk_set_close_timestamp(
2548 chunk, close_timestamp);
2549 if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) {
2550 ERR("Failed to set trace chunk close timestamp");
2551 ret = -1;
2552 reply_code = LTTNG_ERR_UNK;
2553 goto end_unlock_session;
2554 }
2555
2556 if (close_command.is_set) {
2557 chunk_status = lttng_trace_chunk_set_close_command(
2558 chunk, close_command.value);
2559 if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) {
2560 ret = -1;
2561 reply_code = LTTNG_ERR_INVALID;
2562 goto end_unlock_session;
2563 }
2564 }
2565 chunk_status = lttng_trace_chunk_get_name(chunk, &chunk_name, NULL);
2566 if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) {
2567 ERR("Failed to get chunk name");
2568 ret = -1;
2569 reply_code = LTTNG_ERR_UNK;
2570 goto end_unlock_session;
2571 }
2572 if (!session->has_rotated && !session->snapshot) {
2573 ret = lttng_strncpy(closed_trace_chunk_path,
2574 session->output_path,
2575 sizeof(closed_trace_chunk_path));
2576 if (ret) {
2577 ERR("Failed to send trace chunk path: path length of %zu bytes exceeds the maximal allowed length of %zu bytes",
2578 strlen(session->output_path),
2579 sizeof(closed_trace_chunk_path));
2580 reply_code = LTTNG_ERR_NOMEM;
2581 ret = -1;
2582 goto end_unlock_session;
2583 }
2584 } else {
2585 if (session->snapshot) {
2586 ret = snprintf(closed_trace_chunk_path,
2587 sizeof(closed_trace_chunk_path),
2588 "%s/%s", session->output_path,
2589 chunk_name);
2590 } else {
2591 ret = snprintf(closed_trace_chunk_path,
2592 sizeof(closed_trace_chunk_path),
2593 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
2594 "/%s",
2595 session->output_path, chunk_name);
2596 }
2597 if (ret < 0 || ret == sizeof(closed_trace_chunk_path)) {
2598 ERR("Failed to format closed trace chunk resulting path");
2599 reply_code = ret < 0 ? LTTNG_ERR_UNK : LTTNG_ERR_NOMEM;
2600 ret = -1;
2601 goto end_unlock_session;
2602 }
2603 }
2604 DBG("Reply chunk path on close: %s", closed_trace_chunk_path);
2605 path_length = strlen(closed_trace_chunk_path) + 1;
2606 if (path_length > UINT32_MAX) {
2607 ERR("Closed trace chunk path exceeds the maximal length allowed by the protocol");
2608 ret = -1;
2609 reply_code = LTTNG_ERR_INVALID_PROTOCOL;
2610 goto end_unlock_session;
2611 }
2612
2613 if (session->current_trace_chunk == chunk) {
2614 /*
2615 * After a trace chunk close command, no new streams
2616 * referencing the chunk may be created. Hence, on the
2617 * event that no new trace chunk have been created for
2618 * the session, the reference to the current trace chunk
2619 * is released in order to allow it to be reclaimed when
2620 * the last stream releases its reference to it.
2621 */
2622 lttng_trace_chunk_put(session->current_trace_chunk);
2623 session->current_trace_chunk = NULL;
2624 }
2625 lttng_trace_chunk_put(session->pending_closure_trace_chunk);
2626 session->pending_closure_trace_chunk = NULL;
2627 end_unlock_session:
2628 pthread_mutex_unlock(&session->lock);
2629
2630 end:
2631 reply.generic.ret_code = htobe32((uint32_t) reply_code);
2632 reply.path_length = htobe32((uint32_t) path_length);
2633 buf_ret = lttng_dynamic_buffer_append(
2634 &reply_payload, &reply, sizeof(reply));
2635 if (buf_ret) {
2636 ERR("Failed to append \"close trace chunk\" command reply header to payload buffer");
2637 goto end_no_reply;
2638 }
2639
2640 if (reply_code == LTTNG_OK) {
2641 buf_ret = lttng_dynamic_buffer_append(&reply_payload,
2642 closed_trace_chunk_path, path_length);
2643 if (buf_ret) {
2644 ERR("Failed to append \"close trace chunk\" command reply path to payload buffer");
2645 goto end_no_reply;
2646 }
2647 }
2648
2649 send_ret = conn->sock->ops->sendmsg(conn->sock,
2650 reply_payload.data,
2651 reply_payload.size,
2652 0);
2653 if (send_ret < reply_payload.size) {
2654 ERR("Failed to send \"close trace chunk\" command reply of %zu bytes (ret = %zd)",
2655 reply_payload.size, send_ret);
2656 ret = -1;
2657 goto end_no_reply;
2658 }
2659 end_no_reply:
2660 lttng_trace_chunk_put(chunk);
2661 lttng_dynamic_buffer_reset(&reply_payload);
2662 return ret;
2663 }
2664
2665 /*
2666 * relay_trace_chunk_exists: check if a trace chunk exists
2667 */
2668 static int relay_trace_chunk_exists(const struct lttcomm_relayd_hdr *recv_hdr,
2669 struct relay_connection *conn,
2670 const struct lttng_buffer_view *payload)
2671 {
2672 int ret = 0;
2673 ssize_t send_ret;
2674 struct relay_session *session = conn->session;
2675 struct lttcomm_relayd_trace_chunk_exists *msg;
2676 struct lttcomm_relayd_trace_chunk_exists_reply reply = {};
2677 struct lttng_buffer_view header_view;
2678 struct lttng_trace_chunk *chunk = NULL;
2679 uint64_t chunk_id;
2680
2681 if (!session || !conn->version_check_done) {
2682 ERR("Trying to close a trace chunk before version check");
2683 ret = -1;
2684 goto end_no_reply;
2685 }
2686
2687 if (session->major == 2 && session->minor < 11) {
2688 ERR("Chunk close command is unsupported before 2.11");
2689 ret = -1;
2690 goto end_no_reply;
2691 }
2692
2693 header_view = lttng_buffer_view_from_view(payload, 0, sizeof(*msg));
2694 if (!header_view.data) {
2695 ERR("Failed to receive payload of chunk close command");
2696 ret = -1;
2697 goto end_no_reply;
2698 }
2699
2700 /* Convert to host endianness. */
2701 msg = (typeof(msg)) header_view.data;
2702 chunk_id = be64toh(msg->chunk_id);
2703
2704 chunk = sessiond_trace_chunk_registry_get_chunk(
2705 sessiond_trace_chunk_registry,
2706 conn->session->sessiond_uuid,
2707 conn->session->id,
2708 chunk_id);
2709
2710 reply = (typeof(reply)) {
2711 .generic.ret_code = htobe32((uint32_t) LTTNG_OK),
2712 .trace_chunk_exists = !!chunk,
2713 };
2714 send_ret = conn->sock->ops->sendmsg(conn->sock,
2715 &reply, sizeof(reply), 0);
2716 if (send_ret < (ssize_t) sizeof(reply)) {
2717 ERR("Failed to send \"create trace chunk\" command reply (ret = %zd)",
2718 send_ret);
2719 ret = -1;
2720 }
2721 end_no_reply:
2722 lttng_trace_chunk_put(chunk);
2723 return ret;
2724 }
2725
2726 #define DBG_CMD(cmd_name, conn) \
2727 DBG3("Processing \"%s\" command for socket %i", cmd_name, conn->sock->fd);
2728
2729 static int relay_process_control_command(struct relay_connection *conn,
2730 const struct lttcomm_relayd_hdr *header,
2731 const struct lttng_buffer_view *payload)
2732 {
2733 int ret = 0;
2734
2735 switch (header->cmd) {
2736 case RELAYD_CREATE_SESSION:
2737 DBG_CMD("RELAYD_CREATE_SESSION", conn);
2738 ret = relay_create_session(header, conn, payload);
2739 break;
2740 case RELAYD_ADD_STREAM:
2741 DBG_CMD("RELAYD_ADD_STREAM", conn);
2742 ret = relay_add_stream(header, conn, payload);
2743 break;
2744 case RELAYD_START_DATA:
2745 DBG_CMD("RELAYD_START_DATA", conn);
2746 ret = relay_start(header, conn, payload);
2747 break;
2748 case RELAYD_SEND_METADATA:
2749 DBG_CMD("RELAYD_SEND_METADATA", conn);
2750 ret = relay_recv_metadata(header, conn, payload);
2751 break;
2752 case RELAYD_VERSION:
2753 DBG_CMD("RELAYD_VERSION", conn);
2754 ret = relay_send_version(header, conn, payload);
2755 break;
2756 case RELAYD_CLOSE_STREAM:
2757 DBG_CMD("RELAYD_CLOSE_STREAM", conn);
2758 ret = relay_close_stream(header, conn, payload);
2759 break;
2760 case RELAYD_DATA_PENDING:
2761 DBG_CMD("RELAYD_DATA_PENDING", conn);
2762 ret = relay_data_pending(header, conn, payload);
2763 break;
2764 case RELAYD_QUIESCENT_CONTROL:
2765 DBG_CMD("RELAYD_QUIESCENT_CONTROL", conn);
2766 ret = relay_quiescent_control(header, conn, payload);
2767 break;
2768 case RELAYD_BEGIN_DATA_PENDING:
2769 DBG_CMD("RELAYD_BEGIN_DATA_PENDING", conn);
2770 ret = relay_begin_data_pending(header, conn, payload);
2771 break;
2772 case RELAYD_END_DATA_PENDING:
2773 DBG_CMD("RELAYD_END_DATA_PENDING", conn);
2774 ret = relay_end_data_pending(header, conn, payload);
2775 break;
2776 case RELAYD_SEND_INDEX:
2777 DBG_CMD("RELAYD_SEND_INDEX", conn);
2778 ret = relay_recv_index(header, conn, payload);
2779 break;
2780 case RELAYD_STREAMS_SENT:
2781 DBG_CMD("RELAYD_STREAMS_SENT", conn);
2782 ret = relay_streams_sent(header, conn, payload);
2783 break;
2784 case RELAYD_RESET_METADATA:
2785 DBG_CMD("RELAYD_RESET_METADATA", conn);
2786 ret = relay_reset_metadata(header, conn, payload);
2787 break;
2788 case RELAYD_ROTATE_STREAMS:
2789 DBG_CMD("RELAYD_ROTATE_STREAMS", conn);
2790 ret = relay_rotate_session_streams(header, conn, payload);
2791 break;
2792 case RELAYD_CREATE_TRACE_CHUNK:
2793 DBG_CMD("RELAYD_CREATE_TRACE_CHUNK", conn);
2794 ret = relay_create_trace_chunk(header, conn, payload);
2795 break;
2796 case RELAYD_CLOSE_TRACE_CHUNK:
2797 DBG_CMD("RELAYD_CLOSE_TRACE_CHUNK", conn);
2798 ret = relay_close_trace_chunk(header, conn, payload);
2799 break;
2800 case RELAYD_TRACE_CHUNK_EXISTS:
2801 DBG_CMD("RELAYD_TRACE_CHUNK_EXISTS", conn);
2802 ret = relay_trace_chunk_exists(header, conn, payload);
2803 break;
2804 case RELAYD_UPDATE_SYNC_INFO:
2805 default:
2806 ERR("Received unknown command (%u)", header->cmd);
2807 relay_unknown_command(conn);
2808 ret = -1;
2809 goto end;
2810 }
2811
2812 end:
2813 return ret;
2814 }
2815
2816 static enum relay_connection_status relay_process_control_receive_payload(
2817 struct relay_connection *conn)
2818 {
2819 int ret = 0;
2820 enum relay_connection_status status = RELAY_CONNECTION_STATUS_OK;
2821 struct lttng_dynamic_buffer *reception_buffer =
2822 &conn->protocol.ctrl.reception_buffer;
2823 struct ctrl_connection_state_receive_payload *state =
2824 &conn->protocol.ctrl.state.receive_payload;
2825 struct lttng_buffer_view payload_view;
2826
2827 if (state->left_to_receive == 0) {
2828 /* Short-circuit for payload-less commands. */
2829 goto reception_complete;
2830 }
2831
2832 ret = conn->sock->ops->recvmsg(conn->sock,
2833 reception_buffer->data + state->received,
2834 state->left_to_receive, MSG_DONTWAIT);
2835 if (ret < 0) {
2836 if (errno != EAGAIN && errno != EWOULDBLOCK) {
2837 PERROR("Unable to receive command payload on sock %d",
2838 conn->sock->fd);
2839 status = RELAY_CONNECTION_STATUS_ERROR;
2840 }
2841 goto end;
2842 } else if (ret == 0) {
2843 DBG("Socket %d performed an orderly shutdown (received EOF)", conn->sock->fd);
2844 status = RELAY_CONNECTION_STATUS_CLOSED;
2845 goto end;
2846 }
2847
2848 assert(ret > 0);
2849 assert(ret <= state->left_to_receive);
2850
2851 state->left_to_receive -= ret;
2852 state->received += ret;
2853
2854 if (state->left_to_receive > 0) {
2855 /*
2856 * Can't transition to the protocol's next state, wait to
2857 * receive the rest of the header.
2858 */
2859 DBG3("Partial reception of control connection protocol payload (received %" PRIu64 " bytes, %" PRIu64 " bytes left to receive, fd = %i)",
2860 state->received, state->left_to_receive,
2861 conn->sock->fd);
2862 goto end;
2863 }
2864
2865 reception_complete:
2866 DBG("Done receiving control command payload: fd = %i, payload size = %" PRIu64 " bytes",
2867 conn->sock->fd, state->received);
2868 /*
2869 * The payload required to process the command has been received.
2870 * A view to the reception buffer is forwarded to the various
2871 * commands and the state of the control is reset on success.
2872 *
2873 * Commands are responsible for sending their reply to the peer.
2874 */
2875 payload_view = lttng_buffer_view_from_dynamic_buffer(reception_buffer,
2876 0, -1);
2877 ret = relay_process_control_command(conn,
2878 &state->header, &payload_view);
2879 if (ret < 0) {
2880 status = RELAY_CONNECTION_STATUS_ERROR;
2881 goto end;
2882 }
2883
2884 ret = connection_reset_protocol_state(conn);
2885 if (ret) {
2886 status = RELAY_CONNECTION_STATUS_ERROR;
2887 }
2888 end:
2889 return status;
2890 }
2891
2892 static enum relay_connection_status relay_process_control_receive_header(
2893 struct relay_connection *conn)
2894 {
2895 int ret = 0;
2896 enum relay_connection_status status = RELAY_CONNECTION_STATUS_OK;
2897 struct lttcomm_relayd_hdr header;
2898 struct lttng_dynamic_buffer *reception_buffer =
2899 &conn->protocol.ctrl.reception_buffer;
2900 struct ctrl_connection_state_receive_header *state =
2901 &conn->protocol.ctrl.state.receive_header;
2902
2903 assert(state->left_to_receive != 0);
2904
2905 ret = conn->sock->ops->recvmsg(conn->sock,
2906 reception_buffer->data + state->received,
2907 state->left_to_receive, MSG_DONTWAIT);
2908 if (ret < 0) {
2909 if (errno != EAGAIN && errno != EWOULDBLOCK) {
2910 PERROR("Unable to receive control command header on sock %d",
2911 conn->sock->fd);
2912 status = RELAY_CONNECTION_STATUS_ERROR;
2913 }
2914 goto end;
2915 } else if (ret == 0) {
2916 DBG("Socket %d performed an orderly shutdown (received EOF)", conn->sock->fd);
2917 status = RELAY_CONNECTION_STATUS_CLOSED;
2918 goto end;
2919 }
2920
2921 assert(ret > 0);
2922 assert(ret <= state->left_to_receive);
2923
2924 state->left_to_receive -= ret;
2925 state->received += ret;
2926
2927 if (state->left_to_receive > 0) {
2928 /*
2929 * Can't transition to the protocol's next state, wait to
2930 * receive the rest of the header.
2931 */
2932 DBG3("Partial reception of control connection protocol header (received %" PRIu64 " bytes, %" PRIu64 " bytes left to receive, fd = %i)",
2933 state->received, state->left_to_receive,
2934 conn->sock->fd);
2935 goto end;
2936 }
2937
2938 /* Transition to next state: receiving the command's payload. */
2939 conn->protocol.ctrl.state_id =
2940 CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD;
2941 memcpy(&header, reception_buffer->data, sizeof(header));
2942 header.circuit_id = be64toh(header.circuit_id);
2943 header.data_size = be64toh(header.data_size);
2944 header.cmd = be32toh(header.cmd);
2945 header.cmd_version = be32toh(header.cmd_version);
2946 memcpy(&conn->protocol.ctrl.state.receive_payload.header,
2947 &header, sizeof(header));
2948
2949 DBG("Done receiving control command header: fd = %i, cmd = %" PRIu32 ", cmd_version = %" PRIu32 ", payload size = %" PRIu64 " bytes",
2950 conn->sock->fd, header.cmd, header.cmd_version,
2951 header.data_size);
2952
2953 if (header.data_size > DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE) {
2954 ERR("Command header indicates a payload (%" PRIu64 " bytes) that exceeds the maximal payload size allowed on a control connection.",
2955 header.data_size);
2956 status = RELAY_CONNECTION_STATUS_ERROR;
2957 goto end;
2958 }
2959
2960 conn->protocol.ctrl.state.receive_payload.left_to_receive =
2961 header.data_size;
2962 conn->protocol.ctrl.state.receive_payload.received = 0;
2963 ret = lttng_dynamic_buffer_set_size(reception_buffer,
2964 header.data_size);
2965 if (ret) {
2966 status = RELAY_CONNECTION_STATUS_ERROR;
2967 goto end;
2968 }
2969
2970 if (header.data_size == 0) {
2971 /*
2972 * Manually invoke the next state as the poll loop
2973 * will not wake-up to allow us to proceed further.
2974 */
2975 status = relay_process_control_receive_payload(conn);
2976 }
2977 end:
2978 return status;
2979 }
2980
2981 /*
2982 * Process the commands received on the control socket
2983 */
2984 static enum relay_connection_status relay_process_control(
2985 struct relay_connection *conn)
2986 {
2987 enum relay_connection_status status;
2988
2989 switch (conn->protocol.ctrl.state_id) {
2990 case CTRL_CONNECTION_STATE_RECEIVE_HEADER:
2991 status = relay_process_control_receive_header(conn);
2992 break;
2993 case CTRL_CONNECTION_STATE_RECEIVE_PAYLOAD:
2994 status = relay_process_control_receive_payload(conn);
2995 break;
2996 default:
2997 ERR("Unknown control connection protocol state encountered.");
2998 abort();
2999 }
3000
3001 return status;
3002 }
3003
3004 static enum relay_connection_status relay_process_data_receive_header(
3005 struct relay_connection *conn)
3006 {
3007 int ret;
3008 enum relay_connection_status status = RELAY_CONNECTION_STATUS_OK;
3009 struct data_connection_state_receive_header *state =
3010 &conn->protocol.data.state.receive_header;
3011 struct lttcomm_relayd_data_hdr header;
3012 struct relay_stream *stream;
3013
3014 assert(state->left_to_receive != 0);
3015
3016 ret = conn->sock->ops->recvmsg(conn->sock,
3017 state->header_reception_buffer + state->received,
3018 state->left_to_receive, MSG_DONTWAIT);
3019 if (ret < 0) {
3020 if (errno != EAGAIN && errno != EWOULDBLOCK) {
3021 PERROR("Unable to receive data header on sock %d", conn->sock->fd);
3022 status = RELAY_CONNECTION_STATUS_ERROR;
3023 }
3024 goto end;
3025 } else if (ret == 0) {
3026 /* Orderly shutdown. Not necessary to print an error. */
3027 DBG("Socket %d performed an orderly shutdown (received EOF)", conn->sock->fd);
3028 status = RELAY_CONNECTION_STATUS_CLOSED;
3029 goto end;
3030 }
3031
3032 assert(ret > 0);
3033 assert(ret <= state->left_to_receive);
3034
3035 state->left_to_receive -= ret;
3036 state->received += ret;
3037
3038 if (state->left_to_receive > 0) {
3039 /*
3040 * Can't transition to the protocol's next state, wait to
3041 * receive the rest of the header.
3042 */
3043 DBG3("Partial reception of data connection header (received %" PRIu64 " bytes, %" PRIu64 " bytes left to receive, fd = %i)",
3044 state->received, state->left_to_receive,
3045 conn->sock->fd);
3046 goto end;
3047 }
3048
3049 /* Transition to next state: receiving the payload. */
3050 conn->protocol.data.state_id = DATA_CONNECTION_STATE_RECEIVE_PAYLOAD;
3051
3052 memcpy(&header, state->header_reception_buffer, sizeof(header));
3053 header.circuit_id = be64toh(header.circuit_id);
3054 header.stream_id = be64toh(header.stream_id);
3055 header.data_size = be32toh(header.data_size);
3056 header.net_seq_num = be64toh(header.net_seq_num);
3057 header.padding_size = be32toh(header.padding_size);
3058 memcpy(&conn->protocol.data.state.receive_payload.header, &header, sizeof(header));
3059
3060 conn->protocol.data.state.receive_payload.left_to_receive =
3061 header.data_size;
3062 conn->protocol.data.state.receive_payload.received = 0;
3063 conn->protocol.data.state.receive_payload.rotate_index = false;
3064
3065 DBG("Received data connection header on fd %i: circuit_id = %" PRIu64 ", stream_id = %" PRIu64 ", data_size = %" PRIu32 ", net_seq_num = %" PRIu64 ", padding_size = %" PRIu32,
3066 conn->sock->fd, header.circuit_id,
3067 header.stream_id, header.data_size,
3068 header.net_seq_num, header.padding_size);
3069
3070 stream = stream_get_by_id(header.stream_id);
3071 if (!stream) {
3072 DBG("relay_process_data_receive_payload: Cannot find stream %" PRIu64,
3073 header.stream_id);
3074 /* Protocol error. */
3075 status = RELAY_CONNECTION_STATUS_ERROR;
3076 goto end;
3077 }
3078
3079 pthread_mutex_lock(&stream->lock);
3080 /* Prepare stream for the reception of a new packet. */
3081 ret = stream_init_packet(stream, header.data_size,
3082 &conn->protocol.data.state.receive_payload.rotate_index);
3083 pthread_mutex_unlock(&stream->lock);
3084 if (ret) {
3085 ERR("Failed to rotate stream output file");
3086 status = RELAY_CONNECTION_STATUS_ERROR;
3087 goto end_stream_unlock;
3088 }
3089
3090 end_stream_unlock:
3091 stream_put(stream);
3092 end:
3093 return status;
3094 }
3095
3096 static enum relay_connection_status relay_process_data_receive_payload(
3097 struct relay_connection *conn)
3098 {
3099 int ret;
3100 enum relay_connection_status status = RELAY_CONNECTION_STATUS_OK;
3101 struct relay_stream *stream;
3102 struct data_connection_state_receive_payload *state =
3103 &conn->protocol.data.state.receive_payload;
3104 const size_t chunk_size = RECV_DATA_BUFFER_SIZE;
3105 char data_buffer[chunk_size];
3106 bool partial_recv = false;
3107 bool new_stream = false, close_requested = false, index_flushed = false;
3108 uint64_t left_to_receive = state->left_to_receive;
3109 struct relay_session *session;
3110
3111 DBG3("Receiving data for stream id %" PRIu64 " seqnum %" PRIu64 ", %" PRIu64" bytes received, %" PRIu64 " bytes left to receive",
3112 state->header.stream_id, state->header.net_seq_num,
3113 state->received, left_to_receive);
3114
3115 stream = stream_get_by_id(state->header.stream_id);
3116 if (!stream) {
3117 /* Protocol error. */
3118 ERR("relay_process_data_receive_payload: cannot find stream %" PRIu64,
3119 state->header.stream_id);
3120 status = RELAY_CONNECTION_STATUS_ERROR;
3121 goto end;
3122 }
3123
3124 pthread_mutex_lock(&stream->lock);
3125 session = stream->trace->session;
3126 if (!conn->session) {
3127 ret = connection_set_session(conn, session);
3128 if (ret) {
3129 status = RELAY_CONNECTION_STATUS_ERROR;
3130 goto end_stream_unlock;
3131 }
3132 }
3133
3134 /*
3135 * The size of the "chunk" received on any iteration is bounded by:
3136 * - the data left to receive,
3137 * - the data immediately available on the socket,
3138 * - the on-stack data buffer
3139 */
3140 while (left_to_receive > 0 && !partial_recv) {
3141 size_t recv_size = min(left_to_receive, chunk_size);
3142 struct lttng_buffer_view packet_chunk;
3143
3144 ret = conn->sock->ops->recvmsg(conn->sock, data_buffer,
3145 recv_size, MSG_DONTWAIT);
3146 if (ret < 0) {
3147 if (errno != EAGAIN && errno != EWOULDBLOCK) {
3148 PERROR("Socket %d error", conn->sock->fd);
3149 status = RELAY_CONNECTION_STATUS_ERROR;
3150 }
3151 goto end_stream_unlock;
3152 } else if (ret == 0) {
3153 /* No more data ready to be consumed on socket. */
3154 DBG3("No more data ready for consumption on data socket of stream id %" PRIu64,
3155 state->header.stream_id);
3156 status = RELAY_CONNECTION_STATUS_CLOSED;
3157 break;
3158 } else if (ret < (int) recv_size) {
3159 /*
3160 * All the data available on the socket has been
3161 * consumed.
3162 */