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