Fix: Unbalanced rcu_read_unlock() on stream file creation failure
[lttng-tools.git] / src / bin / lttng-relayd / main.c
1 /*
2 * Copyright (C) 2012 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
4 * 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #define _GNU_SOURCE
21 #define _LGPL_SOURCE
22 #include <getopt.h>
23 #include <grp.h>
24 #include <limits.h>
25 #include <pthread.h>
26 #include <signal.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <sys/mman.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
34 #include <sys/stat.h>
35 #include <sys/types.h>
36 #include <sys/wait.h>
37 #include <inttypes.h>
38 #include <urcu/futex.h>
39 #include <urcu/uatomic.h>
40 #include <unistd.h>
41 #include <fcntl.h>
42 #include <config.h>
43
44 #include <lttng/lttng.h>
45 #include <common/common.h>
46 #include <common/compat/poll.h>
47 #include <common/compat/socket.h>
48 #include <common/compat/endian.h>
49 #include <common/compat/getenv.h>
50 #include <common/defaults.h>
51 #include <common/daemonize.h>
52 #include <common/futex.h>
53 #include <common/sessiond-comm/sessiond-comm.h>
54 #include <common/sessiond-comm/inet.h>
55 #include <common/sessiond-comm/relayd.h>
56 #include <common/uri.h>
57 #include <common/utils.h>
58 #include <common/config/config.h>
59
60 #include "cmd.h"
61 #include "ctf-trace.h"
62 #include "index.h"
63 #include "utils.h"
64 #include "lttng-relayd.h"
65 #include "live.h"
66 #include "health-relayd.h"
67 #include "testpoint.h"
68 #include "viewer-stream.h"
69 #include "session.h"
70 #include "stream.h"
71 #include "connection.h"
72
73 /* command line options */
74 char *opt_output_path;
75 static int opt_daemon, opt_background;
76
77 /*
78 * We need to wait for listener and live listener threads, as well as
79 * health check thread, before being ready to signal readiness.
80 */
81 #define NR_LTTNG_RELAY_READY 3
82 static int lttng_relay_ready = NR_LTTNG_RELAY_READY;
83 static int recv_child_signal; /* Set to 1 when a SIGUSR1 signal is received. */
84 static pid_t child_ppid; /* Internal parent PID use with daemonize. */
85
86 static struct lttng_uri *control_uri;
87 static struct lttng_uri *data_uri;
88 static struct lttng_uri *live_uri;
89
90 const char *progname;
91
92 const char *tracing_group_name = DEFAULT_TRACING_GROUP;
93 static int tracing_group_name_override;
94
95 const char * const config_section_name = "relayd";
96
97 /*
98 * Quit pipe for all threads. This permits a single cancellation point
99 * for all threads when receiving an event on the pipe.
100 */
101 int thread_quit_pipe[2] = { -1, -1 };
102
103 /*
104 * This pipe is used to inform the worker thread that a command is queued and
105 * ready to be processed.
106 */
107 static int relay_conn_pipe[2] = { -1, -1 };
108
109 /* Shared between threads */
110 static int dispatch_thread_exit;
111
112 static pthread_t listener_thread;
113 static pthread_t dispatcher_thread;
114 static pthread_t worker_thread;
115 static pthread_t health_thread;
116
117 static uint64_t last_relay_stream_id;
118
119 /*
120 * Relay command queue.
121 *
122 * The relay_thread_listener and relay_thread_dispatcher communicate with this
123 * queue.
124 */
125 static struct relay_conn_queue relay_conn_queue;
126
127 /* buffer allocated at startup, used to store the trace data */
128 static char *data_buffer;
129 static unsigned int data_buffer_size;
130
131 /* We need those values for the file/dir creation. */
132 static uid_t relayd_uid;
133 static gid_t relayd_gid;
134
135 /* Global relay stream hash table. */
136 struct lttng_ht *relay_streams_ht;
137
138 /* Global relay viewer stream hash table. */
139 struct lttng_ht *viewer_streams_ht;
140
141 /* Global hash table that stores relay index object. */
142 struct lttng_ht *indexes_ht;
143
144 /* Relayd health monitoring */
145 struct health_app *health_relayd;
146
147 static struct option long_options[] = {
148 { "control-port", 1, 0, 'C', },
149 { "data-port", 1, 0, 'D', },
150 { "live-port", 1, 0, 'L', },
151 { "daemonize", 0, 0, 'd', },
152 { "background", 0, 0, 'b', },
153 { "group", 1, 0, 'g', },
154 { "help", 0, 0, 'h', },
155 { "output", 1, 0, 'o', },
156 { "verbose", 0, 0, 'v', },
157 { "config", 1, 0, 'f' },
158 { NULL, 0, 0, 0, },
159 };
160
161 static const char *config_ignore_options[] = { "help", "config" };
162
163 /*
164 * usage function on stderr
165 */
166 static
167 void usage(void)
168 {
169 fprintf(stderr, "Usage: %s OPTIONS\n\nOptions:\n", progname);
170 fprintf(stderr, " -h, --help Display this usage.\n");
171 fprintf(stderr, " -d, --daemonize Start as a daemon.\n");
172 fprintf(stderr, " -b, --background Start as a daemon, keeping console open.\n");
173 fprintf(stderr, " -C, --control-port URL Control port listening.\n");
174 fprintf(stderr, " -D, --data-port URL Data port listening.\n");
175 fprintf(stderr, " -L, --live-port URL Live view port listening.\n");
176 fprintf(stderr, " -o, --output PATH Output path for traces. Must use an absolute path.\n");
177 fprintf(stderr, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
178 fprintf(stderr, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
179 fprintf(stderr, " -f --config Load daemon configuration file\n");
180 }
181
182 /*
183 * Take an option from the getopt output and set it in the right variable to be
184 * used later.
185 *
186 * Return 0 on success else a negative value.
187 */
188 static
189 int set_option(int opt, const char *arg, const char *optname)
190 {
191 int ret;
192
193 switch (opt) {
194 case 0:
195 fprintf(stderr, "option %s", optname);
196 if (arg) {
197 fprintf(stderr, " with arg %s\n", arg);
198 }
199 break;
200 case 'C':
201 if (lttng_is_setuid_setgid()) {
202 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
203 "-C, --control-port");
204 } else {
205 ret = uri_parse(arg, &control_uri);
206 if (ret < 0) {
207 ERR("Invalid control URI specified");
208 goto end;
209 }
210 if (control_uri->port == 0) {
211 control_uri->port = DEFAULT_NETWORK_CONTROL_PORT;
212 }
213 }
214 break;
215 case 'D':
216 if (lttng_is_setuid_setgid()) {
217 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
218 "-D, -data-port");
219 } else {
220 ret = uri_parse(arg, &data_uri);
221 if (ret < 0) {
222 ERR("Invalid data URI specified");
223 goto end;
224 }
225 if (data_uri->port == 0) {
226 data_uri->port = DEFAULT_NETWORK_DATA_PORT;
227 }
228 }
229 break;
230 case 'L':
231 if (lttng_is_setuid_setgid()) {
232 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
233 "-L, -live-port");
234 } else {
235 ret = uri_parse(arg, &live_uri);
236 if (ret < 0) {
237 ERR("Invalid live URI specified");
238 goto end;
239 }
240 if (live_uri->port == 0) {
241 live_uri->port = DEFAULT_NETWORK_VIEWER_PORT;
242 }
243 }
244 break;
245 case 'd':
246 opt_daemon = 1;
247 break;
248 case 'b':
249 opt_background = 1;
250 break;
251 case 'g':
252 if (lttng_is_setuid_setgid()) {
253 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
254 "-g, --group");
255 } else {
256 tracing_group_name = strdup(arg);
257 if (tracing_group_name == NULL) {
258 ret = -errno;
259 PERROR("strdup");
260 goto end;
261 }
262 tracing_group_name_override = 1;
263 }
264 break;
265 case 'h':
266 usage();
267 exit(EXIT_FAILURE);
268 case 'o':
269 if (lttng_is_setuid_setgid()) {
270 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
271 "-o, --output");
272 } else {
273 ret = asprintf(&opt_output_path, "%s", arg);
274 if (ret < 0) {
275 ret = -errno;
276 PERROR("asprintf opt_output_path");
277 goto end;
278 }
279 }
280 break;
281 case 'v':
282 /* Verbose level can increase using multiple -v */
283 if (arg) {
284 lttng_opt_verbose = config_parse_value(arg);
285 } else {
286 /* Only 3 level of verbosity (-vvv). */
287 if (lttng_opt_verbose < 3) {
288 lttng_opt_verbose += 1;
289 }
290 }
291 break;
292 default:
293 /* Unknown option or other error.
294 * Error is printed by getopt, just return */
295 ret = -1;
296 goto end;
297 }
298
299 /* All good. */
300 ret = 0;
301
302 end:
303 return ret;
304 }
305
306 /*
307 * config_entry_handler_cb used to handle options read from a config file.
308 * See config_entry_handler_cb comment in common/config/config.h for the
309 * return value conventions.
310 */
311 static
312 int config_entry_handler(const struct config_entry *entry, void *unused)
313 {
314 int ret = 0, i;
315
316 if (!entry || !entry->name || !entry->value) {
317 ret = -EINVAL;
318 goto end;
319 }
320
321 /* Check if the option is to be ignored */
322 for (i = 0; i < sizeof(config_ignore_options) / sizeof(char *); i++) {
323 if (!strcmp(entry->name, config_ignore_options[i])) {
324 goto end;
325 }
326 }
327
328 for (i = 0; i < (sizeof(long_options) / sizeof(struct option)) - 1; i++) {
329 /* Ignore if entry name is not fully matched. */
330 if (strcmp(entry->name, long_options[i].name)) {
331 continue;
332 }
333
334 /*
335 * If the option takes no argument on the command line, we have to
336 * check if the value is "true". We support non-zero numeric values,
337 * true, on and yes.
338 */
339 if (!long_options[i].has_arg) {
340 ret = config_parse_value(entry->value);
341 if (ret <= 0) {
342 if (ret) {
343 WARN("Invalid configuration value \"%s\" for option %s",
344 entry->value, entry->name);
345 }
346 /* False, skip boolean config option. */
347 goto end;
348 }
349 }
350
351 ret = set_option(long_options[i].val, entry->value, entry->name);
352 goto end;
353 }
354
355 WARN("Unrecognized option \"%s\" in daemon configuration file.",
356 entry->name);
357
358 end:
359 return ret;
360 }
361
362 static
363 int set_options(int argc, char **argv)
364 {
365 int c, ret = 0, option_index = 0, retval = 0;
366 int orig_optopt = optopt, orig_optind = optind;
367 char *default_address, *optstring;
368 const char *config_path = NULL;
369
370 optstring = utils_generate_optstring(long_options,
371 sizeof(long_options) / sizeof(struct option));
372 if (!optstring) {
373 retval = -ENOMEM;
374 goto exit;
375 }
376
377 /* Check for the --config option */
378
379 while ((c = getopt_long(argc, argv, optstring, long_options,
380 &option_index)) != -1) {
381 if (c == '?') {
382 retval = -EINVAL;
383 goto exit;
384 } else if (c != 'f') {
385 continue;
386 }
387
388 if (lttng_is_setuid_setgid()) {
389 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
390 "-f, --config");
391 } else {
392 config_path = utils_expand_path(optarg);
393 if (!config_path) {
394 ERR("Failed to resolve path: %s", optarg);
395 }
396 }
397 }
398
399 ret = config_get_section_entries(config_path, config_section_name,
400 config_entry_handler, NULL);
401 if (ret) {
402 if (ret > 0) {
403 ERR("Invalid configuration option at line %i", ret);
404 }
405 retval = -1;
406 goto exit;
407 }
408
409 /* Reset getopt's global state */
410 optopt = orig_optopt;
411 optind = orig_optind;
412 while (1) {
413 c = getopt_long(argc, argv, optstring, long_options, &option_index);
414 if (c == -1) {
415 break;
416 }
417
418 ret = set_option(c, optarg, long_options[option_index].name);
419 if (ret < 0) {
420 retval = -1;
421 goto exit;
422 }
423 }
424
425 /* assign default values */
426 if (control_uri == NULL) {
427 ret = asprintf(&default_address,
428 "tcp://" DEFAULT_NETWORK_CONTROL_BIND_ADDRESS ":%d",
429 DEFAULT_NETWORK_CONTROL_PORT);
430 if (ret < 0) {
431 PERROR("asprintf default data address");
432 retval = -1;
433 goto exit;
434 }
435
436 ret = uri_parse(default_address, &control_uri);
437 free(default_address);
438 if (ret < 0) {
439 ERR("Invalid control URI specified");
440 retval = -1;
441 goto exit;
442 }
443 }
444 if (data_uri == NULL) {
445 ret = asprintf(&default_address,
446 "tcp://" DEFAULT_NETWORK_DATA_BIND_ADDRESS ":%d",
447 DEFAULT_NETWORK_DATA_PORT);
448 if (ret < 0) {
449 PERROR("asprintf default data address");
450 retval = -1;
451 goto exit;
452 }
453
454 ret = uri_parse(default_address, &data_uri);
455 free(default_address);
456 if (ret < 0) {
457 ERR("Invalid data URI specified");
458 retval = -1;
459 goto exit;
460 }
461 }
462 if (live_uri == NULL) {
463 ret = asprintf(&default_address,
464 "tcp://" DEFAULT_NETWORK_VIEWER_BIND_ADDRESS ":%d",
465 DEFAULT_NETWORK_VIEWER_PORT);
466 if (ret < 0) {
467 PERROR("asprintf default viewer control address");
468 retval = -1;
469 goto exit;
470 }
471
472 ret = uri_parse(default_address, &live_uri);
473 free(default_address);
474 if (ret < 0) {
475 ERR("Invalid viewer control URI specified");
476 retval = -1;
477 goto exit;
478 }
479 }
480
481 exit:
482 free(optstring);
483 return retval;
484 }
485
486 /*
487 * Cleanup the daemon
488 */
489 static
490 void relayd_cleanup(struct relay_local_data *relay_ctx)
491 {
492 DBG("Cleaning up");
493
494 if (viewer_streams_ht)
495 lttng_ht_destroy(viewer_streams_ht);
496 if (relay_streams_ht)
497 lttng_ht_destroy(relay_streams_ht);
498 if (relay_ctx && relay_ctx->sessions_ht)
499 lttng_ht_destroy(relay_ctx->sessions_ht);
500 free(relay_ctx);
501
502 /* free the dynamically allocated opt_output_path */
503 free(opt_output_path);
504
505 /* Close thread quit pipes */
506 utils_close_pipe(thread_quit_pipe);
507
508 uri_free(control_uri);
509 uri_free(data_uri);
510 /* Live URI is freed in the live thread. */
511
512 if (tracing_group_name_override) {
513 free((void *) tracing_group_name);
514 }
515 }
516
517 /*
518 * Write to writable pipe used to notify a thread.
519 */
520 static
521 int notify_thread_pipe(int wpipe)
522 {
523 ssize_t ret;
524
525 ret = lttng_write(wpipe, "!", 1);
526 if (ret < 1) {
527 PERROR("write poll pipe");
528 goto end;
529 }
530 ret = 0;
531 end:
532 return ret;
533 }
534
535 static
536 int notify_health_quit_pipe(int *pipe)
537 {
538 ssize_t ret;
539
540 ret = lttng_write(pipe[1], "4", 1);
541 if (ret < 1) {
542 PERROR("write relay health quit");
543 goto end;
544 }
545 ret = 0;
546 end:
547 return ret;
548 }
549
550 /*
551 * Stop all relayd and relayd-live threads.
552 */
553 int lttng_relay_stop_threads(void)
554 {
555 int retval = 0;
556
557 /* Stopping all threads */
558 DBG("Terminating all threads");
559 if (notify_thread_pipe(thread_quit_pipe[1])) {
560 ERR("write error on thread quit pipe");
561 retval = -1;
562 }
563
564 if (notify_health_quit_pipe(health_quit_pipe)) {
565 ERR("write error on health quit pipe");
566 }
567
568 /* Dispatch thread */
569 CMM_STORE_SHARED(dispatch_thread_exit, 1);
570 futex_nto1_wake(&relay_conn_queue.futex);
571
572 if (relayd_live_stop()) {
573 ERR("Error stopping live threads");
574 retval = -1;
575 }
576 return retval;
577 }
578
579 /*
580 * Signal handler for the daemon
581 *
582 * Simply stop all worker threads, leaving main() return gracefully after
583 * joining all threads and calling cleanup().
584 */
585 static
586 void sighandler(int sig)
587 {
588 switch (sig) {
589 case SIGPIPE:
590 DBG("SIGPIPE caught");
591 return;
592 case SIGINT:
593 DBG("SIGINT caught");
594 if (lttng_relay_stop_threads()) {
595 ERR("Error stopping threads");
596 }
597 break;
598 case SIGTERM:
599 DBG("SIGTERM caught");
600 if (lttng_relay_stop_threads()) {
601 ERR("Error stopping threads");
602 }
603 break;
604 case SIGUSR1:
605 CMM_STORE_SHARED(recv_child_signal, 1);
606 break;
607 default:
608 break;
609 }
610 }
611
612 /*
613 * Setup signal handler for :
614 * SIGINT, SIGTERM, SIGPIPE
615 */
616 static
617 int set_signal_handler(void)
618 {
619 int ret = 0;
620 struct sigaction sa;
621 sigset_t sigset;
622
623 if ((ret = sigemptyset(&sigset)) < 0) {
624 PERROR("sigemptyset");
625 return ret;
626 }
627
628 sa.sa_handler = sighandler;
629 sa.sa_mask = sigset;
630 sa.sa_flags = 0;
631 if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
632 PERROR("sigaction");
633 return ret;
634 }
635
636 if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
637 PERROR("sigaction");
638 return ret;
639 }
640
641 if ((ret = sigaction(SIGPIPE, &sa, NULL)) < 0) {
642 PERROR("sigaction");
643 return ret;
644 }
645
646 if ((ret = sigaction(SIGUSR1, &sa, NULL)) < 0) {
647 PERROR("sigaction");
648 return ret;
649 }
650
651 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
652
653 return ret;
654 }
655
656 void lttng_relay_notify_ready(void)
657 {
658 /* Notify the parent of the fork() process that we are ready. */
659 if (opt_daemon || opt_background) {
660 if (uatomic_sub_return(&lttng_relay_ready, 1) == 0) {
661 kill(child_ppid, SIGUSR1);
662 }
663 }
664 }
665
666 /*
667 * Init thread quit pipe.
668 *
669 * Return -1 on error or 0 if all pipes are created.
670 */
671 static
672 int init_thread_quit_pipe(void)
673 {
674 int ret;
675
676 ret = utils_create_pipe_cloexec(thread_quit_pipe);
677
678 return ret;
679 }
680
681 /*
682 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
683 */
684 static
685 int create_thread_poll_set(struct lttng_poll_event *events, int size)
686 {
687 int ret;
688
689 if (events == NULL || size == 0) {
690 ret = -1;
691 goto error;
692 }
693
694 ret = lttng_poll_create(events, size, LTTNG_CLOEXEC);
695 if (ret < 0) {
696 goto error;
697 }
698
699 /* Add quit pipe */
700 ret = lttng_poll_add(events, thread_quit_pipe[0], LPOLLIN | LPOLLERR);
701 if (ret < 0) {
702 goto error;
703 }
704
705 return 0;
706
707 error:
708 return ret;
709 }
710
711 /*
712 * Check if the thread quit pipe was triggered.
713 *
714 * Return 1 if it was triggered else 0;
715 */
716 static
717 int check_thread_quit_pipe(int fd, uint32_t events)
718 {
719 if (fd == thread_quit_pipe[0] && (events & LPOLLIN)) {
720 return 1;
721 }
722
723 return 0;
724 }
725
726 /*
727 * Create and init socket from uri.
728 */
729 static
730 struct lttcomm_sock *relay_init_sock(struct lttng_uri *uri)
731 {
732 int ret;
733 struct lttcomm_sock *sock = NULL;
734
735 sock = lttcomm_alloc_sock_from_uri(uri);
736 if (sock == NULL) {
737 ERR("Allocating socket");
738 goto error;
739 }
740
741 ret = lttcomm_create_sock(sock);
742 if (ret < 0) {
743 goto error;
744 }
745 DBG("Listening on sock %d", sock->fd);
746
747 ret = sock->ops->bind(sock);
748 if (ret < 0) {
749 goto error;
750 }
751
752 ret = sock->ops->listen(sock, -1);
753 if (ret < 0) {
754 goto error;
755
756 }
757
758 return sock;
759
760 error:
761 if (sock) {
762 lttcomm_destroy_sock(sock);
763 }
764 return NULL;
765 }
766
767 /*
768 * Return nonzero if stream needs to be closed.
769 */
770 static
771 int close_stream_check(struct relay_stream *stream)
772 {
773 if (stream->close_flag && stream->prev_seq == stream->last_net_seq_num) {
774 /*
775 * We are about to close the stream so set the data pending flag to 1
776 * which will make the end data pending command skip the stream which
777 * is now closed and ready. Note that after proceeding to a file close,
778 * the written file is ready for reading.
779 */
780 stream->data_pending_check_done = 1;
781 return 1;
782 }
783 return 0;
784 }
785
786 static void try_close_stream(struct relay_session *session,
787 struct relay_stream *stream)
788 {
789 int ret;
790 struct ctf_trace *ctf_trace;
791
792 assert(session);
793 assert(stream);
794
795 if (!close_stream_check(stream)) {
796 /* Can't close it, not ready for that. */
797 goto end;
798 }
799
800 ctf_trace = ctf_trace_find_by_path(session->ctf_traces_ht,
801 stream->path_name);
802 assert(ctf_trace);
803
804 pthread_mutex_lock(&session->viewer_ready_lock);
805 ctf_trace->invalid_flag = 1;
806 pthread_mutex_unlock(&session->viewer_ready_lock);
807
808 ret = stream_close(session, stream);
809 if (ret || session->snapshot) {
810 /* Already close thus the ctf trace is being or has been destroyed. */
811 goto end;
812 }
813
814 ctf_trace_try_destroy(session, ctf_trace);
815
816 end:
817 return;
818 }
819
820 /*
821 * This thread manages the listening for new connections on the network
822 */
823 static
824 void *relay_thread_listener(void *data)
825 {
826 int i, ret, pollfd, err = -1;
827 uint32_t revents, nb_fd;
828 struct lttng_poll_event events;
829 struct lttcomm_sock *control_sock, *data_sock;
830
831 DBG("[thread] Relay listener started");
832
833 health_register(health_relayd, HEALTH_RELAYD_TYPE_LISTENER);
834
835 health_code_update();
836
837 control_sock = relay_init_sock(control_uri);
838 if (!control_sock) {
839 goto error_sock_control;
840 }
841
842 data_sock = relay_init_sock(data_uri);
843 if (!data_sock) {
844 goto error_sock_relay;
845 }
846
847 /*
848 * Pass 3 as size here for the thread quit pipe, control and data socket.
849 */
850 ret = create_thread_poll_set(&events, 3);
851 if (ret < 0) {
852 goto error_create_poll;
853 }
854
855 /* Add the control socket */
856 ret = lttng_poll_add(&events, control_sock->fd, LPOLLIN | LPOLLRDHUP);
857 if (ret < 0) {
858 goto error_poll_add;
859 }
860
861 /* Add the data socket */
862 ret = lttng_poll_add(&events, data_sock->fd, LPOLLIN | LPOLLRDHUP);
863 if (ret < 0) {
864 goto error_poll_add;
865 }
866
867 lttng_relay_notify_ready();
868
869 if (testpoint(relayd_thread_listener)) {
870 goto error_testpoint;
871 }
872
873 while (1) {
874 health_code_update();
875
876 DBG("Listener accepting connections");
877
878 restart:
879 health_poll_entry();
880 ret = lttng_poll_wait(&events, -1);
881 health_poll_exit();
882 if (ret < 0) {
883 /*
884 * Restart interrupted system call.
885 */
886 if (errno == EINTR) {
887 goto restart;
888 }
889 goto error;
890 }
891
892 nb_fd = ret;
893
894 DBG("Relay new connection received");
895 for (i = 0; i < nb_fd; i++) {
896 health_code_update();
897
898 /* Fetch once the poll data */
899 revents = LTTNG_POLL_GETEV(&events, i);
900 pollfd = LTTNG_POLL_GETFD(&events, i);
901
902 if (!revents) {
903 /* No activity for this FD (poll implementation). */
904 continue;
905 }
906
907 /* Thread quit pipe has been closed. Killing thread. */
908 ret = check_thread_quit_pipe(pollfd, revents);
909 if (ret) {
910 err = 0;
911 goto exit;
912 }
913
914 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
915 ERR("socket poll error");
916 goto error;
917 } else if (revents & LPOLLIN) {
918 /*
919 * Get allocated in this thread, enqueued to a global queue,
920 * dequeued and freed in the worker thread.
921 */
922 int val = 1;
923 struct relay_connection *new_conn;
924 struct lttcomm_sock *newsock;
925
926 new_conn = connection_create();
927 if (!new_conn) {
928 goto error;
929 }
930
931 if (pollfd == data_sock->fd) {
932 new_conn->type = RELAY_DATA;
933 newsock = data_sock->ops->accept(data_sock);
934 DBG("Relay data connection accepted, socket %d",
935 newsock->fd);
936 } else {
937 assert(pollfd == control_sock->fd);
938 new_conn->type = RELAY_CONTROL;
939 newsock = control_sock->ops->accept(control_sock);
940 DBG("Relay control connection accepted, socket %d",
941 newsock->fd);
942 }
943 if (!newsock) {
944 PERROR("accepting sock");
945 connection_free(new_conn);
946 goto error;
947 }
948
949 ret = setsockopt(newsock->fd, SOL_SOCKET, SO_REUSEADDR, &val,
950 sizeof(val));
951 if (ret < 0) {
952 PERROR("setsockopt inet");
953 lttcomm_destroy_sock(newsock);
954 connection_free(new_conn);
955 goto error;
956 }
957 new_conn->sock = newsock;
958
959 /* Enqueue request for the dispatcher thread. */
960 cds_wfcq_enqueue(&relay_conn_queue.head, &relay_conn_queue.tail,
961 &new_conn->qnode);
962
963 /*
964 * Wake the dispatch queue futex. Implicit memory barrier with
965 * the exchange in cds_wfcq_enqueue.
966 */
967 futex_nto1_wake(&relay_conn_queue.futex);
968 }
969 }
970 }
971
972 exit:
973 error:
974 error_poll_add:
975 error_testpoint:
976 lttng_poll_clean(&events);
977 error_create_poll:
978 if (data_sock->fd >= 0) {
979 ret = data_sock->ops->close(data_sock);
980 if (ret) {
981 PERROR("close");
982 }
983 }
984 lttcomm_destroy_sock(data_sock);
985 error_sock_relay:
986 if (control_sock->fd >= 0) {
987 ret = control_sock->ops->close(control_sock);
988 if (ret) {
989 PERROR("close");
990 }
991 }
992 lttcomm_destroy_sock(control_sock);
993 error_sock_control:
994 if (err) {
995 health_error();
996 ERR("Health error occurred in %s", __func__);
997 }
998 health_unregister(health_relayd);
999 DBG("Relay listener thread cleanup complete");
1000 lttng_relay_stop_threads();
1001 return NULL;
1002 }
1003
1004 /*
1005 * This thread manages the dispatching of the requests to worker threads
1006 */
1007 static
1008 void *relay_thread_dispatcher(void *data)
1009 {
1010 int err = -1;
1011 ssize_t ret;
1012 struct cds_wfcq_node *node;
1013 struct relay_connection *new_conn = NULL;
1014
1015 DBG("[thread] Relay dispatcher started");
1016
1017 health_register(health_relayd, HEALTH_RELAYD_TYPE_DISPATCHER);
1018
1019 if (testpoint(relayd_thread_dispatcher)) {
1020 goto error_testpoint;
1021 }
1022
1023 health_code_update();
1024
1025 while (!CMM_LOAD_SHARED(dispatch_thread_exit)) {
1026 health_code_update();
1027
1028 /* Atomically prepare the queue futex */
1029 futex_nto1_prepare(&relay_conn_queue.futex);
1030
1031 do {
1032 health_code_update();
1033
1034 /* Dequeue commands */
1035 node = cds_wfcq_dequeue_blocking(&relay_conn_queue.head,
1036 &relay_conn_queue.tail);
1037 if (node == NULL) {
1038 DBG("Woken up but nothing in the relay command queue");
1039 /* Continue thread execution */
1040 break;
1041 }
1042 new_conn = caa_container_of(node, struct relay_connection, qnode);
1043
1044 DBG("Dispatching request waiting on sock %d", new_conn->sock->fd);
1045
1046 /*
1047 * Inform worker thread of the new request. This call is blocking
1048 * so we can be assured that the data will be read at some point in
1049 * time or wait to the end of the world :)
1050 */
1051 ret = lttng_write(relay_conn_pipe[1], &new_conn, sizeof(new_conn));
1052 if (ret < 0) {
1053 PERROR("write connection pipe");
1054 connection_destroy(new_conn);
1055 goto error;
1056 }
1057 } while (node != NULL);
1058
1059 /* Futex wait on queue. Blocking call on futex() */
1060 health_poll_entry();
1061 futex_nto1_wait(&relay_conn_queue.futex);
1062 health_poll_exit();
1063 }
1064
1065 /* Normal exit, no error */
1066 err = 0;
1067
1068 error:
1069 error_testpoint:
1070 if (err) {
1071 health_error();
1072 ERR("Health error occurred in %s", __func__);
1073 }
1074 health_unregister(health_relayd);
1075 DBG("Dispatch thread dying");
1076 lttng_relay_stop_threads();
1077 return NULL;
1078 }
1079
1080 static void try_close_streams(struct relay_session *session)
1081 {
1082 struct ctf_trace *ctf_trace;
1083 struct lttng_ht_iter iter;
1084
1085 assert(session);
1086
1087 pthread_mutex_lock(&session->viewer_ready_lock);
1088 rcu_read_lock();
1089 cds_lfht_for_each_entry(session->ctf_traces_ht->ht, &iter.iter, ctf_trace,
1090 node.node) {
1091 struct relay_stream *stream;
1092
1093 /* Close streams. */
1094 cds_list_for_each_entry(stream, &ctf_trace->stream_list, trace_list) {
1095 stream_close(session, stream);
1096 }
1097
1098 ctf_trace->invalid_flag = 1;
1099 ctf_trace_try_destroy(session, ctf_trace);
1100 }
1101 rcu_read_unlock();
1102 pthread_mutex_unlock(&session->viewer_ready_lock);
1103 }
1104
1105 /*
1106 * Try to destroy a session within a connection.
1107 */
1108 static void destroy_session(struct relay_session *session,
1109 struct lttng_ht *sessions_ht)
1110 {
1111 assert(session);
1112 assert(sessions_ht);
1113
1114 /* Indicate that this session can be destroyed from now on. */
1115 session->close_flag = 1;
1116
1117 try_close_streams(session);
1118
1119 /*
1120 * This will try to delete and destroy the session if no viewer is attached
1121 * to it meaning the refcount is down to zero.
1122 */
1123 session_try_destroy(sessions_ht, session);
1124 }
1125
1126 /*
1127 * Copy index data from the control port to a given index object.
1128 */
1129 static void copy_index_control_data(struct relay_index *index,
1130 struct lttcomm_relayd_index *data)
1131 {
1132 assert(index);
1133 assert(data);
1134
1135 /*
1136 * The index on disk is encoded in big endian, so we don't need to convert
1137 * the data received on the network. The data_offset value is NEVER
1138 * modified here and is updated by the data thread.
1139 */
1140 index->index_data.packet_size = data->packet_size;
1141 index->index_data.content_size = data->content_size;
1142 index->index_data.timestamp_begin = data->timestamp_begin;
1143 index->index_data.timestamp_end = data->timestamp_end;
1144 index->index_data.events_discarded = data->events_discarded;
1145 index->index_data.stream_id = data->stream_id;
1146 }
1147
1148 /*
1149 * Handle the RELAYD_CREATE_SESSION command.
1150 *
1151 * On success, send back the session id or else return a negative value.
1152 */
1153 static
1154 int relay_create_session(struct lttcomm_relayd_hdr *recv_hdr,
1155 struct relay_connection *conn)
1156 {
1157 int ret = 0, send_ret;
1158 struct relay_session *session;
1159 struct lttcomm_relayd_status_session reply;
1160
1161 assert(recv_hdr);
1162 assert(conn);
1163
1164 memset(&reply, 0, sizeof(reply));
1165
1166 session = session_create();
1167 if (!session) {
1168 ret = -1;
1169 goto error;
1170 }
1171 session->minor = conn->minor;
1172 session->major = conn->major;
1173 conn->session_id = session->id;
1174 conn->session = session;
1175
1176 reply.session_id = htobe64(session->id);
1177
1178 switch (conn->minor) {
1179 case 1:
1180 case 2:
1181 case 3:
1182 break;
1183 case 4: /* LTTng sessiond 2.4 */
1184 default:
1185 ret = cmd_create_session_2_4(conn, session);
1186 }
1187
1188 lttng_ht_add_unique_u64(conn->sessions_ht, &session->session_n);
1189 DBG("Created session %" PRIu64, session->id);
1190
1191 error:
1192 if (ret < 0) {
1193 reply.ret_code = htobe32(LTTNG_ERR_FATAL);
1194 } else {
1195 reply.ret_code = htobe32(LTTNG_OK);
1196 }
1197
1198 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1199 if (send_ret < 0) {
1200 ERR("Relayd sending session id");
1201 ret = send_ret;
1202 }
1203
1204 return ret;
1205 }
1206
1207 /*
1208 * When we have received all the streams and the metadata for a channel,
1209 * we make them visible to the viewer threads.
1210 */
1211 static
1212 void set_viewer_ready_flag(struct relay_connection *conn)
1213 {
1214 struct relay_stream *stream, *tmp_stream;
1215
1216 pthread_mutex_lock(&conn->session->viewer_ready_lock);
1217 cds_list_for_each_entry_safe(stream, tmp_stream, &conn->recv_head,
1218 recv_list) {
1219 stream->viewer_ready = 1;
1220 cds_list_del(&stream->recv_list);
1221 }
1222 pthread_mutex_unlock(&conn->session->viewer_ready_lock);
1223 return;
1224 }
1225
1226 /*
1227 * Add a recv handle node to the connection recv list with the given stream
1228 * handle. A new node is allocated thus must be freed when the node is deleted
1229 * from the list.
1230 */
1231 static void queue_stream(struct relay_stream *stream,
1232 struct relay_connection *conn)
1233 {
1234 assert(conn);
1235 assert(stream);
1236
1237 cds_list_add(&stream->recv_list, &conn->recv_head);
1238 }
1239
1240 /*
1241 * relay_add_stream: allocate a new stream for a session
1242 */
1243 static
1244 int relay_add_stream(struct lttcomm_relayd_hdr *recv_hdr,
1245 struct relay_connection *conn)
1246 {
1247 int ret, send_ret;
1248 struct relay_session *session = conn->session;
1249 struct relay_stream *stream = NULL;
1250 struct lttcomm_relayd_status_stream reply;
1251 struct ctf_trace *trace;
1252
1253 if (!session || conn->version_check_done == 0) {
1254 ERR("Trying to add a stream before version check");
1255 ret = -1;
1256 goto end_no_session;
1257 }
1258
1259 stream = zmalloc(sizeof(struct relay_stream));
1260 if (stream == NULL) {
1261 PERROR("relay stream zmalloc");
1262 ret = -1;
1263 goto end_no_session;
1264 }
1265
1266 switch (conn->minor) {
1267 case 1: /* LTTng sessiond 2.1 */
1268 ret = cmd_recv_stream_2_1(conn, stream);
1269 break;
1270 case 2: /* LTTng sessiond 2.2 */
1271 default:
1272 ret = cmd_recv_stream_2_2(conn, stream);
1273 break;
1274 }
1275 if (ret < 0) {
1276 goto err_free_stream;
1277 }
1278
1279 rcu_read_lock();
1280 stream->stream_handle = ++last_relay_stream_id;
1281 stream->prev_seq = -1ULL;
1282 stream->session_id = session->id;
1283 stream->index_fd = -1;
1284 stream->read_index_fd = -1;
1285 stream->ctf_stream_id = -1ULL;
1286 lttng_ht_node_init_u64(&stream->node, stream->stream_handle);
1287 pthread_mutex_init(&stream->lock, NULL);
1288
1289 ret = utils_mkdir_recursive(stream->path_name, S_IRWXU | S_IRWXG);
1290 if (ret < 0) {
1291 ERR("relay creating output directory");
1292 goto err_free_stream;
1293 }
1294
1295 /*
1296 * No need to use run_as API here because whatever we receives, the relayd
1297 * uses its own credentials for the stream files.
1298 */
1299 ret = utils_create_stream_file(stream->path_name, stream->channel_name,
1300 stream->tracefile_size, 0, relayd_uid, relayd_gid, NULL);
1301 if (ret < 0) {
1302 ERR("Create output file");
1303 goto err_free_stream;
1304 }
1305 stream->fd = ret;
1306 if (stream->tracefile_size) {
1307 DBG("Tracefile %s/%s_0 created", stream->path_name, stream->channel_name);
1308 } else {
1309 DBG("Tracefile %s/%s created", stream->path_name, stream->channel_name);
1310 }
1311
1312 trace = ctf_trace_find_by_path(session->ctf_traces_ht, stream->path_name);
1313 if (!trace) {
1314 trace = ctf_trace_create(stream->path_name);
1315 if (!trace) {
1316 ret = -1;
1317 goto end;
1318 }
1319 ctf_trace_add(session->ctf_traces_ht, trace);
1320 }
1321 ctf_trace_get_ref(trace);
1322
1323 if (!strncmp(stream->channel_name, DEFAULT_METADATA_NAME, NAME_MAX)) {
1324 stream->metadata_flag = 1;
1325 /* Assign quick reference to the metadata stream in the trace. */
1326 trace->metadata_stream = stream;
1327 }
1328
1329 /*
1330 * Add the stream in the recv list of the connection. Once the end stream
1331 * message is received, this list is emptied and streams are set with the
1332 * viewer ready flag.
1333 */
1334 queue_stream(stream, conn);
1335
1336 /*
1337 * Both in the ctf_trace object and the global stream ht since the data
1338 * side of the relayd does not have the concept of session.
1339 */
1340 lttng_ht_add_unique_u64(relay_streams_ht, &stream->node);
1341 cds_list_add_tail(&stream->trace_list, &trace->stream_list);
1342
1343 session->stream_count++;
1344
1345 DBG("Relay new stream added %s with ID %" PRIu64, stream->channel_name,
1346 stream->stream_handle);
1347
1348 end:
1349 memset(&reply, 0, sizeof(reply));
1350 reply.handle = htobe64(stream->stream_handle);
1351 /* send the session id to the client or a negative return code on error */
1352 if (ret < 0) {
1353 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1354 /* stream was not properly added to the ht, so free it */
1355 stream_destroy(stream);
1356 } else {
1357 reply.ret_code = htobe32(LTTNG_OK);
1358 }
1359
1360 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1361 sizeof(struct lttcomm_relayd_status_stream), 0);
1362 if (send_ret < 0) {
1363 ERR("Relay sending stream id");
1364 ret = send_ret;
1365 }
1366 rcu_read_unlock();
1367
1368 end_no_session:
1369 return ret;
1370
1371 err_free_stream:
1372 stream_destroy(stream);
1373 return ret;
1374 }
1375
1376 /*
1377 * relay_close_stream: close a specific stream
1378 */
1379 static
1380 int relay_close_stream(struct lttcomm_relayd_hdr *recv_hdr,
1381 struct relay_connection *conn)
1382 {
1383 int ret, send_ret;
1384 struct relay_session *session = conn->session;
1385 struct lttcomm_relayd_close_stream stream_info;
1386 struct lttcomm_relayd_generic_reply reply;
1387 struct relay_stream *stream;
1388
1389 DBG("Close stream received");
1390
1391 if (!session || conn->version_check_done == 0) {
1392 ERR("Trying to close a stream before version check");
1393 ret = -1;
1394 goto end_no_session;
1395 }
1396
1397 ret = conn->sock->ops->recvmsg(conn->sock, &stream_info,
1398 sizeof(struct lttcomm_relayd_close_stream), 0);
1399 if (ret < sizeof(struct lttcomm_relayd_close_stream)) {
1400 if (ret == 0) {
1401 /* Orderly shutdown. Not necessary to print an error. */
1402 DBG("Socket %d did an orderly shutdown", conn->sock->fd);
1403 } else {
1404 ERR("Relay didn't receive valid add_stream struct size : %d", ret);
1405 }
1406 ret = -1;
1407 goto end_no_session;
1408 }
1409
1410 rcu_read_lock();
1411 stream = stream_find_by_id(relay_streams_ht,
1412 be64toh(stream_info.stream_id));
1413 if (!stream) {
1414 ret = -1;
1415 goto end_unlock;
1416 }
1417
1418 stream->last_net_seq_num = be64toh(stream_info.last_net_seq_num);
1419 stream->close_flag = 1;
1420 session->stream_count--;
1421
1422 /* Check if we can close it or else the data will do it. */
1423 try_close_stream(session, stream);
1424
1425 end_unlock:
1426 rcu_read_unlock();
1427
1428 memset(&reply, 0, sizeof(reply));
1429 if (ret < 0) {
1430 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1431 } else {
1432 reply.ret_code = htobe32(LTTNG_OK);
1433 }
1434 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1435 sizeof(struct lttcomm_relayd_generic_reply), 0);
1436 if (send_ret < 0) {
1437 ERR("Relay sending stream id");
1438 ret = send_ret;
1439 }
1440
1441 end_no_session:
1442 return ret;
1443 }
1444
1445 /*
1446 * relay_unknown_command: send -1 if received unknown command
1447 */
1448 static
1449 void relay_unknown_command(struct relay_connection *conn)
1450 {
1451 struct lttcomm_relayd_generic_reply reply;
1452 int ret;
1453
1454 memset(&reply, 0, sizeof(reply));
1455 reply.ret_code = htobe32(LTTNG_ERR_UNK);
1456 ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1457 sizeof(struct lttcomm_relayd_generic_reply), 0);
1458 if (ret < 0) {
1459 ERR("Relay sending unknown command");
1460 }
1461 }
1462
1463 /*
1464 * relay_start: send an acknowledgment to the client to tell if we are
1465 * ready to receive data. We are ready if a session is established.
1466 */
1467 static
1468 int relay_start(struct lttcomm_relayd_hdr *recv_hdr,
1469 struct relay_connection *conn)
1470 {
1471 int ret = htobe32(LTTNG_OK);
1472 struct lttcomm_relayd_generic_reply reply;
1473 struct relay_session *session = conn->session;
1474
1475 if (!session) {
1476 DBG("Trying to start the streaming without a session established");
1477 ret = htobe32(LTTNG_ERR_UNK);
1478 }
1479
1480 memset(&reply, 0, sizeof(reply));
1481 reply.ret_code = ret;
1482 ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1483 sizeof(struct lttcomm_relayd_generic_reply), 0);
1484 if (ret < 0) {
1485 ERR("Relay sending start ack");
1486 }
1487
1488 return ret;
1489 }
1490
1491 /*
1492 * Append padding to the file pointed by the file descriptor fd.
1493 */
1494 static int write_padding_to_file(int fd, uint32_t size)
1495 {
1496 ssize_t ret = 0;
1497 char *zeros;
1498
1499 if (size == 0) {
1500 goto end;
1501 }
1502
1503 zeros = zmalloc(size);
1504 if (zeros == NULL) {
1505 PERROR("zmalloc zeros for padding");
1506 ret = -1;
1507 goto end;
1508 }
1509
1510 ret = lttng_write(fd, zeros, size);
1511 if (ret < size) {
1512 PERROR("write padding to file");
1513 }
1514
1515 free(zeros);
1516
1517 end:
1518 return ret;
1519 }
1520
1521 /*
1522 * relay_recv_metadata: receive the metada for the session.
1523 */
1524 static
1525 int relay_recv_metadata(struct lttcomm_relayd_hdr *recv_hdr,
1526 struct relay_connection *conn)
1527 {
1528 int ret = htobe32(LTTNG_OK);
1529 ssize_t size_ret;
1530 struct relay_session *session = conn->session;
1531 struct lttcomm_relayd_metadata_payload *metadata_struct;
1532 struct relay_stream *metadata_stream;
1533 uint64_t data_size, payload_size;
1534 struct ctf_trace *ctf_trace;
1535
1536 if (!session) {
1537 ERR("Metadata sent before version check");
1538 ret = -1;
1539 goto end;
1540 }
1541
1542 data_size = payload_size = be64toh(recv_hdr->data_size);
1543 if (data_size < sizeof(struct lttcomm_relayd_metadata_payload)) {
1544 ERR("Incorrect data size");
1545 ret = -1;
1546 goto end;
1547 }
1548 payload_size -= sizeof(struct lttcomm_relayd_metadata_payload);
1549
1550 if (data_buffer_size < data_size) {
1551 /* In case the realloc fails, we can free the memory */
1552 char *tmp_data_ptr;
1553
1554 tmp_data_ptr = realloc(data_buffer, data_size);
1555 if (!tmp_data_ptr) {
1556 ERR("Allocating data buffer");
1557 free(data_buffer);
1558 ret = -1;
1559 goto end;
1560 }
1561 data_buffer = tmp_data_ptr;
1562 data_buffer_size = data_size;
1563 }
1564 memset(data_buffer, 0, data_size);
1565 DBG2("Relay receiving metadata, waiting for %" PRIu64 " bytes", data_size);
1566 ret = conn->sock->ops->recvmsg(conn->sock, data_buffer, data_size, 0);
1567 if (ret < 0 || ret != data_size) {
1568 if (ret == 0) {
1569 /* Orderly shutdown. Not necessary to print an error. */
1570 DBG("Socket %d did an orderly shutdown", conn->sock->fd);
1571 } else {
1572 ERR("Relay didn't receive the whole metadata");
1573 }
1574 ret = -1;
1575 goto end;
1576 }
1577 metadata_struct = (struct lttcomm_relayd_metadata_payload *) data_buffer;
1578
1579 rcu_read_lock();
1580 metadata_stream = stream_find_by_id(relay_streams_ht,
1581 be64toh(metadata_struct->stream_id));
1582 if (!metadata_stream) {
1583 ret = -1;
1584 goto end_unlock;
1585 }
1586
1587 size_ret = lttng_write(metadata_stream->fd, metadata_struct->payload,
1588 payload_size);
1589 if (size_ret < payload_size) {
1590 ERR("Relay error writing metadata on file");
1591 ret = -1;
1592 goto end_unlock;
1593 }
1594
1595 ret = write_padding_to_file(metadata_stream->fd,
1596 be32toh(metadata_struct->padding_size));
1597 if (ret < 0) {
1598 goto end_unlock;
1599 }
1600
1601 ctf_trace = ctf_trace_find_by_path(session->ctf_traces_ht,
1602 metadata_stream->path_name);
1603 assert(ctf_trace);
1604 ctf_trace->metadata_received +=
1605 payload_size + be32toh(metadata_struct->padding_size);
1606
1607 DBG2("Relay metadata written");
1608
1609 end_unlock:
1610 rcu_read_unlock();
1611 end:
1612 return ret;
1613 }
1614
1615 /*
1616 * relay_send_version: send relayd version number
1617 */
1618 static
1619 int relay_send_version(struct lttcomm_relayd_hdr *recv_hdr,
1620 struct relay_connection *conn)
1621 {
1622 int ret;
1623 struct lttcomm_relayd_version reply, msg;
1624
1625 assert(conn);
1626
1627 conn->version_check_done = 1;
1628
1629 /* Get version from the other side. */
1630 ret = conn->sock->ops->recvmsg(conn->sock, &msg, sizeof(msg), 0);
1631 if (ret < 0 || ret != sizeof(msg)) {
1632 if (ret == 0) {
1633 /* Orderly shutdown. Not necessary to print an error. */
1634 DBG("Socket %d did an orderly shutdown", conn->sock->fd);
1635 } else {
1636 ERR("Relay failed to receive the version values.");
1637 }
1638 ret = -1;
1639 goto end;
1640 }
1641
1642 memset(&reply, 0, sizeof(reply));
1643 reply.major = RELAYD_VERSION_COMM_MAJOR;
1644 reply.minor = RELAYD_VERSION_COMM_MINOR;
1645
1646 /* Major versions must be the same */
1647 if (reply.major != be32toh(msg.major)) {
1648 DBG("Incompatible major versions (%u vs %u), deleting session",
1649 reply.major, be32toh(msg.major));
1650 destroy_session(conn->session, conn->sessions_ht);
1651 ret = 0;
1652 goto end;
1653 }
1654
1655 conn->major = reply.major;
1656 /* We adapt to the lowest compatible version */
1657 if (reply.minor <= be32toh(msg.minor)) {
1658 conn->minor = reply.minor;
1659 } else {
1660 conn->minor = be32toh(msg.minor);
1661 }
1662
1663 reply.major = htobe32(reply.major);
1664 reply.minor = htobe32(reply.minor);
1665 ret = conn->sock->ops->sendmsg(conn->sock, &reply,
1666 sizeof(struct lttcomm_relayd_version), 0);
1667 if (ret < 0) {
1668 ERR("Relay sending version");
1669 }
1670
1671 DBG("Version check done using protocol %u.%u", conn->major,
1672 conn->minor);
1673
1674 end:
1675 return ret;
1676 }
1677
1678 /*
1679 * Check for data pending for a given stream id from the session daemon.
1680 */
1681 static
1682 int relay_data_pending(struct lttcomm_relayd_hdr *recv_hdr,
1683 struct relay_connection *conn)
1684 {
1685 struct relay_session *session = conn->session;
1686 struct lttcomm_relayd_data_pending msg;
1687 struct lttcomm_relayd_generic_reply reply;
1688 struct relay_stream *stream;
1689 int ret;
1690 uint64_t last_net_seq_num, stream_id;
1691
1692 DBG("Data pending command received");
1693
1694 if (!session || conn->version_check_done == 0) {
1695 ERR("Trying to check for data before version check");
1696 ret = -1;
1697 goto end_no_session;
1698 }
1699
1700 ret = conn->sock->ops->recvmsg(conn->sock, &msg, sizeof(msg), 0);
1701 if (ret < sizeof(msg)) {
1702 if (ret == 0) {
1703 /* Orderly shutdown. Not necessary to print an error. */
1704 DBG("Socket %d did an orderly shutdown", conn->sock->fd);
1705 } else {
1706 ERR("Relay didn't receive valid data_pending struct size : %d",
1707 ret);
1708 }
1709 ret = -1;
1710 goto end_no_session;
1711 }
1712
1713 stream_id = be64toh(msg.stream_id);
1714 last_net_seq_num = be64toh(msg.last_net_seq_num);
1715
1716 rcu_read_lock();
1717 stream = stream_find_by_id(relay_streams_ht, stream_id);
1718 if (stream == NULL) {
1719 ret = -1;
1720 goto end_unlock;
1721 }
1722
1723 DBG("Data pending for stream id %" PRIu64 " prev_seq %" PRIu64
1724 " and last_seq %" PRIu64, stream_id, stream->prev_seq,
1725 last_net_seq_num);
1726
1727 /* Avoid wrapping issue */
1728 if (((int64_t) (stream->prev_seq - last_net_seq_num)) >= 0) {
1729 /* Data has in fact been written and is NOT pending */
1730 ret = 0;
1731 } else {
1732 /* Data still being streamed thus pending */
1733 ret = 1;
1734 }
1735
1736 /* Pending check is now done. */
1737 stream->data_pending_check_done = 1;
1738
1739 end_unlock:
1740 rcu_read_unlock();
1741
1742 memset(&reply, 0, sizeof(reply));
1743 reply.ret_code = htobe32(ret);
1744 ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1745 if (ret < 0) {
1746 ERR("Relay data pending ret code failed");
1747 }
1748
1749 end_no_session:
1750 return ret;
1751 }
1752
1753 /*
1754 * Wait for the control socket to reach a quiescent state.
1755 *
1756 * Note that for now, when receiving this command from the session daemon, this
1757 * means that every subsequent commands or data received on the control socket
1758 * has been handled. So, this is why we simply return OK here.
1759 */
1760 static
1761 int relay_quiescent_control(struct lttcomm_relayd_hdr *recv_hdr,
1762 struct relay_connection *conn)
1763 {
1764 int ret;
1765 uint64_t stream_id;
1766 struct relay_stream *stream;
1767 struct lttng_ht_iter iter;
1768 struct lttcomm_relayd_quiescent_control msg;
1769 struct lttcomm_relayd_generic_reply reply;
1770
1771 DBG("Checking quiescent state on control socket");
1772
1773 if (!conn->session || conn->version_check_done == 0) {
1774 ERR("Trying to check for data before version check");
1775 ret = -1;
1776 goto end_no_session;
1777 }
1778
1779 ret = conn->sock->ops->recvmsg(conn->sock, &msg, sizeof(msg), 0);
1780 if (ret < sizeof(msg)) {
1781 if (ret == 0) {
1782 /* Orderly shutdown. Not necessary to print an error. */
1783 DBG("Socket %d did an orderly shutdown", conn->sock->fd);
1784 } else {
1785 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1786 ret);
1787 }
1788 ret = -1;
1789 goto end_no_session;
1790 }
1791
1792 stream_id = be64toh(msg.stream_id);
1793
1794 rcu_read_lock();
1795 cds_lfht_for_each_entry(relay_streams_ht->ht, &iter.iter, stream,
1796 node.node) {
1797 if (stream->stream_handle == stream_id) {
1798 stream->data_pending_check_done = 1;
1799 DBG("Relay quiescent control pending flag set to %" PRIu64,
1800 stream_id);
1801 break;
1802 }
1803 }
1804 rcu_read_unlock();
1805
1806 memset(&reply, 0, sizeof(reply));
1807 reply.ret_code = htobe32(LTTNG_OK);
1808 ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1809 if (ret < 0) {
1810 ERR("Relay data quiescent control ret code failed");
1811 }
1812
1813 end_no_session:
1814 return ret;
1815 }
1816
1817 /*
1818 * Initialize a data pending command. This means that a client is about to ask
1819 * for data pending for each stream he/she holds. Simply iterate over all
1820 * streams of a session and set the data_pending_check_done flag.
1821 *
1822 * This command returns to the client a LTTNG_OK code.
1823 */
1824 static
1825 int relay_begin_data_pending(struct lttcomm_relayd_hdr *recv_hdr,
1826 struct relay_connection *conn)
1827 {
1828 int ret;
1829 struct lttng_ht_iter iter;
1830 struct lttcomm_relayd_begin_data_pending msg;
1831 struct lttcomm_relayd_generic_reply reply;
1832 struct relay_stream *stream;
1833 uint64_t session_id;
1834
1835 assert(recv_hdr);
1836 assert(conn);
1837
1838 DBG("Init streams for data pending");
1839
1840 if (!conn->session || conn->version_check_done == 0) {
1841 ERR("Trying to check for data before version check");
1842 ret = -1;
1843 goto end_no_session;
1844 }
1845
1846 ret = conn->sock->ops->recvmsg(conn->sock, &msg, sizeof(msg), 0);
1847 if (ret < sizeof(msg)) {
1848 if (ret == 0) {
1849 /* Orderly shutdown. Not necessary to print an error. */
1850 DBG("Socket %d did an orderly shutdown", conn->sock->fd);
1851 } else {
1852 ERR("Relay didn't receive valid begin data_pending struct size: %d",
1853 ret);
1854 }
1855 ret = -1;
1856 goto end_no_session;
1857 }
1858
1859 session_id = be64toh(msg.session_id);
1860
1861 /*
1862 * Iterate over all streams to set the begin data pending flag. For now, the
1863 * streams are indexed by stream handle so we have to iterate over all
1864 * streams to find the one associated with the right session_id.
1865 */
1866 rcu_read_lock();
1867 cds_lfht_for_each_entry(relay_streams_ht->ht, &iter.iter, stream,
1868 node.node) {
1869 if (stream->session_id == session_id) {
1870 stream->data_pending_check_done = 0;
1871 DBG("Set begin data pending flag to stream %" PRIu64,
1872 stream->stream_handle);
1873 }
1874 }
1875 rcu_read_unlock();
1876
1877 memset(&reply, 0, sizeof(reply));
1878 /* All good, send back reply. */
1879 reply.ret_code = htobe32(LTTNG_OK);
1880
1881 ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1882 if (ret < 0) {
1883 ERR("Relay begin data pending send reply failed");
1884 }
1885
1886 end_no_session:
1887 return ret;
1888 }
1889
1890 /*
1891 * End data pending command. This will check, for a given session id, if each
1892 * stream associated with it has its data_pending_check_done flag set. If not,
1893 * this means that the client lost track of the stream but the data is still
1894 * being streamed on our side. In this case, we inform the client that data is
1895 * inflight.
1896 *
1897 * Return to the client if there is data in flight or not with a ret_code.
1898 */
1899 static
1900 int relay_end_data_pending(struct lttcomm_relayd_hdr *recv_hdr,
1901 struct relay_connection *conn)
1902 {
1903 int ret;
1904 struct lttng_ht_iter iter;
1905 struct lttcomm_relayd_end_data_pending msg;
1906 struct lttcomm_relayd_generic_reply reply;
1907 struct relay_stream *stream;
1908 uint64_t session_id;
1909 uint32_t is_data_inflight = 0;
1910
1911 assert(recv_hdr);
1912 assert(conn);
1913
1914 DBG("End data pending command");
1915
1916 if (!conn->session || conn->version_check_done == 0) {
1917 ERR("Trying to check for data before version check");
1918 ret = -1;
1919 goto end_no_session;
1920 }
1921
1922 ret = conn->sock->ops->recvmsg(conn->sock, &msg, sizeof(msg), 0);
1923 if (ret < sizeof(msg)) {
1924 if (ret == 0) {
1925 /* Orderly shutdown. Not necessary to print an error. */
1926 DBG("Socket %d did an orderly shutdown", conn->sock->fd);
1927 } else {
1928 ERR("Relay didn't receive valid end data_pending struct size: %d",
1929 ret);
1930 }
1931 ret = -1;
1932 goto end_no_session;
1933 }
1934
1935 session_id = be64toh(msg.session_id);
1936
1937 /* Iterate over all streams to see if the begin data pending flag is set. */
1938 rcu_read_lock();
1939 cds_lfht_for_each_entry(relay_streams_ht->ht, &iter.iter, stream,
1940 node.node) {
1941 if (stream->session_id == session_id &&
1942 !stream->data_pending_check_done && !stream->terminated_flag) {
1943 is_data_inflight = 1;
1944 DBG("Data is still in flight for stream %" PRIu64,
1945 stream->stream_handle);
1946 break;
1947 }
1948 }
1949 rcu_read_unlock();
1950
1951 memset(&reply, 0, sizeof(reply));
1952 /* All good, send back reply. */
1953 reply.ret_code = htobe32(is_data_inflight);
1954
1955 ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
1956 if (ret < 0) {
1957 ERR("Relay end data pending send reply failed");
1958 }
1959
1960 end_no_session:
1961 return ret;
1962 }
1963
1964 /*
1965 * Receive an index for a specific stream.
1966 *
1967 * Return 0 on success else a negative value.
1968 */
1969 static
1970 int relay_recv_index(struct lttcomm_relayd_hdr *recv_hdr,
1971 struct relay_connection *conn)
1972 {
1973 int ret, send_ret, index_created = 0;
1974 struct relay_session *session = conn->session;
1975 struct lttcomm_relayd_index index_info;
1976 struct relay_index *index, *wr_index = NULL;
1977 struct lttcomm_relayd_generic_reply reply;
1978 struct relay_stream *stream;
1979 uint64_t net_seq_num;
1980
1981 assert(conn);
1982
1983 DBG("Relay receiving index");
1984
1985 if (!session || conn->version_check_done == 0) {
1986 ERR("Trying to close a stream before version check");
1987 ret = -1;
1988 goto end_no_session;
1989 }
1990
1991 ret = conn->sock->ops->recvmsg(conn->sock, &index_info,
1992 sizeof(index_info), 0);
1993 if (ret < sizeof(index_info)) {
1994 if (ret == 0) {
1995 /* Orderly shutdown. Not necessary to print an error. */
1996 DBG("Socket %d did an orderly shutdown", conn->sock->fd);
1997 } else {
1998 ERR("Relay didn't receive valid index struct size : %d", ret);
1999 }
2000 ret = -1;
2001 goto end_no_session;
2002 }
2003
2004 net_seq_num = be64toh(index_info.net_seq_num);
2005
2006 rcu_read_lock();
2007 stream = stream_find_by_id(relay_streams_ht,
2008 be64toh(index_info.relay_stream_id));
2009 if (!stream) {
2010 ret = -1;
2011 goto end_rcu_unlock;
2012 }
2013
2014 /* Live beacon handling */
2015 if (index_info.packet_size == 0) {
2016 DBG("Received live beacon for stream %" PRIu64, stream->stream_handle);
2017
2018 /*
2019 * Only flag a stream inactive when it has already received data
2020 * and no indexes are in flight.
2021 */
2022 if (stream->total_index_received > 0 && stream->indexes_in_flight == 0) {
2023 stream->beacon_ts_end = be64toh(index_info.timestamp_end);
2024 }
2025 ret = 0;
2026 goto end_rcu_unlock;
2027 } else {
2028 stream->beacon_ts_end = -1ULL;
2029 }
2030
2031 index = relay_index_find(stream->stream_handle, net_seq_num);
2032 if (!index) {
2033 /* A successful creation will add the object to the HT. */
2034 index = relay_index_create(stream->stream_handle, net_seq_num);
2035 if (!index) {
2036 goto end_rcu_unlock;
2037 }
2038 index_created = 1;
2039 stream->indexes_in_flight++;
2040 }
2041
2042 copy_index_control_data(index, &index_info);
2043 if (stream->ctf_stream_id == -1ULL) {
2044 stream->ctf_stream_id = be64toh(index_info.stream_id);
2045 }
2046
2047 if (index_created) {
2048 /*
2049 * Try to add the relay index object to the hash table. If an object
2050 * already exist, destroy back the index created, set the data in this
2051 * object and write it on disk.
2052 */
2053 relay_index_add(index, &wr_index);
2054 if (wr_index) {
2055 copy_index_control_data(wr_index, &index_info);
2056 free(index);
2057 }
2058 } else {
2059 /* The index already exists so write it on disk. */
2060 wr_index = index;
2061 }
2062
2063 /* Do we have a writable ready index to write on disk. */
2064 if (wr_index) {
2065 ret = relay_index_write(wr_index->fd, wr_index);
2066 if (ret < 0) {
2067 goto end_rcu_unlock;
2068 }
2069 stream->total_index_received++;
2070 stream->indexes_in_flight--;
2071 assert(stream->indexes_in_flight >= 0);
2072 }
2073
2074 end_rcu_unlock:
2075 rcu_read_unlock();
2076
2077 memset(&reply, 0, sizeof(reply));
2078 if (ret < 0) {
2079 reply.ret_code = htobe32(LTTNG_ERR_UNK);
2080 } else {
2081 reply.ret_code = htobe32(LTTNG_OK);
2082 }
2083 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2084 if (send_ret < 0) {
2085 ERR("Relay sending close index id reply");
2086 ret = send_ret;
2087 }
2088
2089 end_no_session:
2090 return ret;
2091 }
2092
2093 /*
2094 * Receive the streams_sent message.
2095 *
2096 * Return 0 on success else a negative value.
2097 */
2098 static
2099 int relay_streams_sent(struct lttcomm_relayd_hdr *recv_hdr,
2100 struct relay_connection *conn)
2101 {
2102 int ret, send_ret;
2103 struct lttcomm_relayd_generic_reply reply;
2104
2105 assert(conn);
2106
2107 DBG("Relay receiving streams_sent");
2108
2109 if (!conn->session || conn->version_check_done == 0) {
2110 ERR("Trying to close a stream before version check");
2111 ret = -1;
2112 goto end_no_session;
2113 }
2114
2115 /*
2116 * Flag every pending stream in the connection recv list that they are
2117 * ready to be used by the viewer.
2118 */
2119 set_viewer_ready_flag(conn);
2120
2121 /*
2122 * Inform the viewer that there are new streams in the session.
2123 */
2124 if (conn->session->viewer_refcount) {
2125 uatomic_set(&conn->session->new_streams, 1);
2126 }
2127
2128 memset(&reply, 0, sizeof(reply));
2129 reply.ret_code = htobe32(LTTNG_OK);
2130 send_ret = conn->sock->ops->sendmsg(conn->sock, &reply, sizeof(reply), 0);
2131 if (send_ret < 0) {
2132 ERR("Relay sending sent_stream reply");
2133 ret = send_ret;
2134 } else {
2135 /* Success. */
2136 ret = 0;
2137 }
2138
2139 end_no_session:
2140 return ret;
2141 }
2142
2143 /*
2144 * Process the commands received on the control socket
2145 */
2146 static
2147 int relay_process_control(struct lttcomm_relayd_hdr *recv_hdr,
2148 struct relay_connection *conn)
2149 {
2150 int ret = 0;
2151
2152 switch (be32toh(recv_hdr->cmd)) {
2153 case RELAYD_CREATE_SESSION:
2154 ret = relay_create_session(recv_hdr, conn);
2155 break;
2156 case RELAYD_ADD_STREAM:
2157 ret = relay_add_stream(recv_hdr, conn);
2158 break;
2159 case RELAYD_START_DATA:
2160 ret = relay_start(recv_hdr, conn);
2161 break;
2162 case RELAYD_SEND_METADATA:
2163 ret = relay_recv_metadata(recv_hdr, conn);
2164 break;
2165 case RELAYD_VERSION:
2166 ret = relay_send_version(recv_hdr, conn);
2167 break;
2168 case RELAYD_CLOSE_STREAM:
2169 ret = relay_close_stream(recv_hdr, conn);
2170 break;
2171 case RELAYD_DATA_PENDING:
2172 ret = relay_data_pending(recv_hdr, conn);
2173 break;
2174 case RELAYD_QUIESCENT_CONTROL:
2175 ret = relay_quiescent_control(recv_hdr, conn);
2176 break;
2177 case RELAYD_BEGIN_DATA_PENDING:
2178 ret = relay_begin_data_pending(recv_hdr, conn);
2179 break;
2180 case RELAYD_END_DATA_PENDING:
2181 ret = relay_end_data_pending(recv_hdr, conn);
2182 break;
2183 case RELAYD_SEND_INDEX:
2184 ret = relay_recv_index(recv_hdr, conn);
2185 break;
2186 case RELAYD_STREAMS_SENT:
2187 ret = relay_streams_sent(recv_hdr, conn);
2188 break;
2189 case RELAYD_UPDATE_SYNC_INFO:
2190 default:
2191 ERR("Received unknown command (%u)", be32toh(recv_hdr->cmd));
2192 relay_unknown_command(conn);
2193 ret = -1;
2194 goto end;
2195 }
2196
2197 end:
2198 return ret;
2199 }
2200
2201 /*
2202 * Handle index for a data stream.
2203 *
2204 * RCU read side lock MUST be acquired.
2205 *
2206 * Return 0 on success else a negative value.
2207 */
2208 static int handle_index_data(struct relay_stream *stream, uint64_t net_seq_num,
2209 int rotate_index)
2210 {
2211 int ret = 0, index_created = 0;
2212 uint64_t stream_id, data_offset;
2213 struct relay_index *index, *wr_index = NULL;
2214
2215 assert(stream);
2216
2217 stream_id = stream->stream_handle;
2218 /* Get data offset because we are about to update the index. */
2219 data_offset = htobe64(stream->tracefile_size_current);
2220
2221 /*
2222 * Lookup for an existing index for that stream id/sequence number. If on
2223 * exists, the control thread already received the data for it thus we need
2224 * to write it on disk.
2225 */
2226 index = relay_index_find(stream_id, net_seq_num);
2227 if (!index) {
2228 /* A successful creation will add the object to the HT. */
2229 index = relay_index_create(stream_id, net_seq_num);
2230 if (!index) {
2231 ret = -1;
2232 goto error;
2233 }
2234 index_created = 1;
2235 stream->indexes_in_flight++;
2236 }
2237
2238 if (rotate_index || stream->index_fd < 0) {
2239 index->to_close_fd = stream->index_fd;
2240 ret = index_create_file(stream->path_name, stream->channel_name,
2241 relayd_uid, relayd_gid, stream->tracefile_size,
2242 stream->tracefile_count_current);
2243 if (ret < 0) {
2244 /* This will close the stream's index fd if one. */
2245 relay_index_free_safe(index);
2246 goto error;
2247 }
2248 stream->index_fd = ret;
2249 }
2250 index->fd = stream->index_fd;
2251 index->index_data.offset = data_offset;
2252
2253 if (index_created) {
2254 /*
2255 * Try to add the relay index object to the hash table. If an object
2256 * already exist, destroy back the index created and set the data.
2257 */
2258 relay_index_add(index, &wr_index);
2259 if (wr_index) {
2260 /* Copy back data from the created index. */
2261 wr_index->fd = index->fd;
2262 wr_index->to_close_fd = index->to_close_fd;
2263 wr_index->index_data.offset = data_offset;
2264 free(index);
2265 }
2266 } else {
2267 /* The index already exists so write it on disk. */
2268 wr_index = index;
2269 }
2270
2271 /* Do we have a writable ready index to write on disk. */
2272 if (wr_index) {
2273 ret = relay_index_write(wr_index->fd, wr_index);
2274 if (ret < 0) {
2275 goto error;
2276 }
2277 stream->total_index_received++;
2278 stream->indexes_in_flight--;
2279 assert(stream->indexes_in_flight >= 0);
2280 }
2281
2282 error:
2283 return ret;
2284 }
2285
2286 /*
2287 * relay_process_data: Process the data received on the data socket
2288 */
2289 static
2290 int relay_process_data(struct relay_connection *conn)
2291 {
2292 int ret = 0, rotate_index = 0;
2293 ssize_t size_ret;
2294 struct relay_stream *stream;
2295 struct lttcomm_relayd_data_hdr data_hdr;
2296 uint64_t stream_id;
2297 uint64_t net_seq_num;
2298 uint32_t data_size;
2299 struct relay_session *session;
2300
2301 assert(conn);
2302
2303 ret = conn->sock->ops->recvmsg(conn->sock, &data_hdr,
2304 sizeof(struct lttcomm_relayd_data_hdr), 0);
2305 if (ret <= 0) {
2306 if (ret == 0) {
2307 /* Orderly shutdown. Not necessary to print an error. */
2308 DBG("Socket %d did an orderly shutdown", conn->sock->fd);
2309 } else {
2310 ERR("Unable to receive data header on sock %d", conn->sock->fd);
2311 }
2312 ret = -1;
2313 goto end;
2314 }
2315
2316 stream_id = be64toh(data_hdr.stream_id);
2317
2318 rcu_read_lock();
2319 stream = stream_find_by_id(relay_streams_ht, stream_id);
2320 if (!stream) {
2321 ret = -1;
2322 goto end_rcu_unlock;
2323 }
2324
2325 session = session_find_by_id(conn->sessions_ht, stream->session_id);
2326 assert(session);
2327
2328 data_size = be32toh(data_hdr.data_size);
2329 if (data_buffer_size < data_size) {
2330 char *tmp_data_ptr;
2331
2332 tmp_data_ptr = realloc(data_buffer, data_size);
2333 if (!tmp_data_ptr) {
2334 ERR("Allocating data buffer");
2335 free(data_buffer);
2336 ret = -1;
2337 goto end_rcu_unlock;
2338 }
2339 data_buffer = tmp_data_ptr;
2340 data_buffer_size = data_size;
2341 }
2342 memset(data_buffer, 0, data_size);
2343
2344 net_seq_num = be64toh(data_hdr.net_seq_num);
2345
2346 DBG3("Receiving data of size %u for stream id %" PRIu64 " seqnum %" PRIu64,
2347 data_size, stream_id, net_seq_num);
2348 ret = conn->sock->ops->recvmsg(conn->sock, data_buffer, data_size, 0);
2349 if (ret <= 0) {
2350 if (ret == 0) {
2351 /* Orderly shutdown. Not necessary to print an error. */
2352 DBG("Socket %d did an orderly shutdown", conn->sock->fd);
2353 }
2354 ret = -1;
2355 goto end_rcu_unlock;
2356 }
2357
2358 /* Check if a rotation is needed. */
2359 if (stream->tracefile_size > 0 &&
2360 (stream->tracefile_size_current + data_size) >
2361 stream->tracefile_size) {
2362 struct relay_viewer_stream *vstream;
2363 uint64_t new_id;
2364
2365 new_id = (stream->tracefile_count_current + 1) %
2366 stream->tracefile_count;
2367 /*
2368 * When we wrap-around back to 0, we start overwriting old
2369 * trace data.
2370 */
2371 if (!stream->tracefile_overwrite && new_id == 0) {
2372 stream->tracefile_overwrite = 1;
2373 }
2374 pthread_mutex_lock(&stream->viewer_stream_rotation_lock);
2375 if (stream->tracefile_overwrite) {
2376 stream->oldest_tracefile_id =
2377 (stream->oldest_tracefile_id + 1) %
2378 stream->tracefile_count;
2379 }
2380 vstream = viewer_stream_find_by_id(stream->stream_handle);
2381 if (vstream) {
2382 /*
2383 * The viewer is reading a file about to be
2384 * overwritten. Close the FDs it is
2385 * currently using and let it handle the fault.
2386 */
2387 if (vstream->tracefile_count_current == new_id) {
2388 pthread_mutex_lock(&vstream->overwrite_lock);
2389 vstream->abort_flag = 1;
2390 pthread_mutex_unlock(&vstream->overwrite_lock);
2391 DBG("Streaming side setting abort_flag on stream %s_%" PRIu64 "\n",
2392 stream->channel_name, new_id);
2393 } else if (vstream->tracefile_count_current ==
2394 stream->tracefile_count_current) {
2395 /*
2396 * The reader and writer were in the
2397 * same trace file, inform the viewer
2398 * that no new index will ever be added
2399 * to this file.
2400 */
2401 vstream->close_write_flag = 1;
2402 }
2403 }
2404 ret = utils_rotate_stream_file(stream->path_name, stream->channel_name,
2405 stream->tracefile_size, stream->tracefile_count,
2406 relayd_uid, relayd_gid, stream->fd,
2407 &(stream->tracefile_count_current), &stream->fd);
2408 pthread_mutex_unlock(&stream->viewer_stream_rotation_lock);
2409 if (ret < 0) {
2410 ERR("Rotating stream output file");
2411 goto end_rcu_unlock;
2412 }
2413 /* Reset current size because we just perform a stream rotation. */
2414 stream->tracefile_size_current = 0;
2415 rotate_index = 1;
2416 }
2417
2418 /*
2419 * Index are handled in protocol version 2.4 and above. Also, snapshot and
2420 * index are NOT supported.
2421 */
2422 if (session->minor >= 4 && !session->snapshot) {
2423 ret = handle_index_data(stream, net_seq_num, rotate_index);
2424 if (ret < 0) {
2425 goto end_rcu_unlock;
2426 }
2427 }
2428
2429 /* Write data to stream output fd. */
2430 size_ret = lttng_write(stream->fd, data_buffer, data_size);
2431 if (size_ret < data_size) {
2432 ERR("Relay error writing data to file");
2433 ret = -1;
2434 goto end_rcu_unlock;
2435 }
2436
2437 DBG2("Relay wrote %d bytes to tracefile for stream id %" PRIu64,
2438 ret, stream->stream_handle);
2439
2440 ret = write_padding_to_file(stream->fd, be32toh(data_hdr.padding_size));
2441 if (ret < 0) {
2442 goto end_rcu_unlock;
2443 }
2444 stream->tracefile_size_current += data_size + be32toh(data_hdr.padding_size);
2445
2446 stream->prev_seq = net_seq_num;
2447
2448 try_close_stream(session, stream);
2449
2450 end_rcu_unlock:
2451 rcu_read_unlock();
2452 end:
2453 return ret;
2454 }
2455
2456 static
2457 void cleanup_connection_pollfd(struct lttng_poll_event *events, int pollfd)
2458 {
2459 int ret;
2460
2461 assert(events);
2462
2463 (void) lttng_poll_del(events, pollfd);
2464
2465 ret = close(pollfd);
2466 if (ret < 0) {
2467 ERR("Closing pollfd %d", pollfd);
2468 }
2469 }
2470
2471 static void destroy_connection(struct lttng_ht *relay_connections_ht,
2472 struct relay_connection *conn)
2473 {
2474 assert(relay_connections_ht);
2475 assert(conn);
2476
2477 connection_delete(relay_connections_ht, conn);
2478
2479 /* For the control socket, we try to destroy the session. */
2480 if (conn->type == RELAY_CONTROL && conn->session) {
2481 destroy_session(conn->session, conn->sessions_ht);
2482 }
2483
2484 connection_destroy(conn);
2485 }
2486
2487 /*
2488 * This thread does the actual work
2489 */
2490 static
2491 void *relay_thread_worker(void *data)
2492 {
2493 int ret, err = -1, last_seen_data_fd = -1;
2494 uint32_t nb_fd;
2495 struct lttng_poll_event events;
2496 struct lttng_ht *relay_connections_ht;
2497 struct lttng_ht_iter iter;
2498 struct lttcomm_relayd_hdr recv_hdr;
2499 struct relay_local_data *relay_ctx = (struct relay_local_data *) data;
2500 struct lttng_ht *sessions_ht = relay_ctx->sessions_ht;
2501 struct relay_index *index;
2502 struct relay_connection *destroy_conn = NULL;
2503
2504 DBG("[thread] Relay worker started");
2505
2506 rcu_register_thread();
2507
2508 health_register(health_relayd, HEALTH_RELAYD_TYPE_WORKER);
2509
2510 if (testpoint(relayd_thread_worker)) {
2511 goto error_testpoint;
2512 }
2513
2514 health_code_update();
2515
2516 /* table of connections indexed on socket */
2517 relay_connections_ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
2518 if (!relay_connections_ht) {
2519 goto relay_connections_ht_error;
2520 }
2521
2522 /* Tables of received indexes indexed by index handle and net_seq_num. */
2523 indexes_ht = lttng_ht_new(0, LTTNG_HT_TYPE_TWO_U64);
2524 if (!indexes_ht) {
2525 goto indexes_ht_error;
2526 }
2527
2528 ret = create_thread_poll_set(&events, 2);
2529 if (ret < 0) {
2530 goto error_poll_create;
2531 }
2532
2533 ret = lttng_poll_add(&events, relay_conn_pipe[0], LPOLLIN | LPOLLRDHUP);
2534 if (ret < 0) {
2535 goto error;
2536 }
2537
2538 restart:
2539 while (1) {
2540 int idx = -1, i, seen_control = 0, last_notdel_data_fd = -1;
2541
2542 health_code_update();
2543
2544 /* Infinite blocking call, waiting for transmission */
2545 DBG3("Relayd worker thread polling...");
2546 health_poll_entry();
2547 ret = lttng_poll_wait(&events, -1);
2548 health_poll_exit();
2549 if (ret < 0) {
2550 /*
2551 * Restart interrupted system call.
2552 */
2553 if (errno == EINTR) {
2554 goto restart;
2555 }
2556 goto error;
2557 }
2558
2559 nb_fd = ret;
2560
2561 /*
2562 * Process control. The control connection is prioritised so we don't
2563 * starve it with high throughout put tracing data on the data
2564 * connection.
2565 */
2566 for (i = 0; i < nb_fd; i++) {
2567 /* Fetch once the poll data */
2568 uint32_t revents = LTTNG_POLL_GETEV(&events, i);
2569 int pollfd = LTTNG_POLL_GETFD(&events, i);
2570
2571 health_code_update();
2572
2573 if (!revents) {
2574 /* No activity for this FD (poll implementation). */
2575 continue;
2576 }
2577
2578 /* Thread quit pipe has been closed. Killing thread. */
2579 ret = check_thread_quit_pipe(pollfd, revents);
2580 if (ret) {
2581 err = 0;
2582 goto exit;
2583 }
2584
2585 /* Inspect the relay conn pipe for new connection */
2586 if (pollfd == relay_conn_pipe[0]) {
2587 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
2588 ERR("Relay connection pipe error");
2589 goto error;
2590 } else if (revents & LPOLLIN) {
2591 struct relay_connection *conn;
2592
2593 ret = lttng_read(relay_conn_pipe[0], &conn, sizeof(conn));
2594 if (ret < 0) {
2595 goto error;
2596 }
2597 conn->sessions_ht = sessions_ht;
2598 connection_init(conn);
2599 lttng_poll_add(&events, conn->sock->fd,
2600 LPOLLIN | LPOLLRDHUP);
2601 rcu_read_lock();
2602 lttng_ht_add_unique_ulong(relay_connections_ht,
2603 &conn->sock_n);
2604 rcu_read_unlock();
2605 DBG("Connection socket %d added", conn->sock->fd);
2606 }
2607 } else {
2608 struct relay_connection *ctrl_conn;
2609
2610 rcu_read_lock();
2611 ctrl_conn = connection_find_by_sock(relay_connections_ht, pollfd);
2612 /* If not found, there is a synchronization issue. */
2613 assert(ctrl_conn);
2614
2615 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
2616 cleanup_connection_pollfd(&events, pollfd);
2617 destroy_connection(relay_connections_ht, ctrl_conn);
2618 if (last_seen_data_fd == pollfd) {
2619 last_seen_data_fd = last_notdel_data_fd;
2620 }
2621 } else if (revents & LPOLLIN) {
2622 if (ctrl_conn->type == RELAY_CONTROL) {
2623 ret = ctrl_conn->sock->ops->recvmsg(ctrl_conn->sock, &recv_hdr,
2624 sizeof(recv_hdr), 0);
2625 if (ret <= 0) {
2626 /* Connection closed */
2627 cleanup_connection_pollfd(&events, pollfd);
2628 destroy_connection(relay_connections_ht, ctrl_conn);
2629 DBG("Control connection closed with %d", pollfd);
2630 } else {
2631 ret = relay_process_control(&recv_hdr, ctrl_conn);
2632 if (ret < 0) {
2633 /* Clear the session on error. */
2634 cleanup_connection_pollfd(&events, pollfd);
2635 destroy_connection(relay_connections_ht, ctrl_conn);
2636 DBG("Connection closed with %d", pollfd);
2637 }
2638 seen_control = 1;
2639 }
2640 } else {
2641 /*
2642 * Flag the last seen data fd not deleted. It will be
2643 * used as the last seen fd if any fd gets deleted in
2644 * this first loop.
2645 */
2646 last_notdel_data_fd = pollfd;
2647 }
2648 } else {
2649 ERR("Unknown poll events %u for sock %d", revents, pollfd);
2650 }
2651 rcu_read_unlock();
2652 }
2653 }
2654
2655 /*
2656 * The last loop handled a control request, go back to poll to make
2657 * sure we prioritise the control socket.
2658 */
2659 if (seen_control) {
2660 continue;
2661 }
2662
2663 if (last_seen_data_fd >= 0) {
2664 for (i = 0; i < nb_fd; i++) {
2665 int pollfd = LTTNG_POLL_GETFD(&events, i);
2666
2667 health_code_update();
2668
2669 if (last_seen_data_fd == pollfd) {
2670 idx = i;
2671 break;
2672 }
2673 }
2674 }
2675
2676 /* Process data connection. */
2677 for (i = idx + 1; i < nb_fd; i++) {
2678 /* Fetch the poll data. */
2679 uint32_t revents = LTTNG_POLL_GETEV(&events, i);
2680 int pollfd = LTTNG_POLL_GETFD(&events, i);
2681 struct relay_connection *data_conn;
2682
2683 health_code_update();
2684
2685 if (!revents) {
2686 /* No activity for this FD (poll implementation). */
2687 continue;
2688 }
2689
2690 /* Skip the command pipe. It's handled in the first loop. */
2691 if (pollfd == relay_conn_pipe[0]) {
2692 continue;
2693 }
2694
2695 rcu_read_lock();
2696 data_conn = connection_find_by_sock(relay_connections_ht, pollfd);
2697 if (!data_conn) {
2698 /* Skip it. Might be removed before. */
2699 rcu_read_unlock();
2700 continue;
2701 }
2702
2703 if (revents & LPOLLIN) {
2704 if (data_conn->type != RELAY_DATA) {
2705 rcu_read_unlock();
2706 continue;
2707 }
2708
2709 ret = relay_process_data(data_conn);
2710 /* Connection closed */
2711 if (ret < 0) {
2712 cleanup_connection_pollfd(&events, pollfd);
2713 destroy_connection(relay_connections_ht, data_conn);
2714 DBG("Data connection closed with %d", pollfd);
2715 /*
2716 * Every goto restart call sets the last seen fd where
2717 * here we don't really care since we gracefully
2718 * continue the loop after the connection is deleted.
2719 */
2720 } else {
2721 /* Keep last seen port. */
2722 last_seen_data_fd = pollfd;
2723 rcu_read_unlock();
2724 goto restart;
2725 }
2726 }
2727 rcu_read_unlock();
2728 }
2729 last_seen_data_fd = -1;
2730 }
2731
2732 /* Normal exit, no error */
2733 ret = 0;
2734
2735 exit:
2736 error:
2737 lttng_poll_clean(&events);
2738
2739 /* Cleanup reamaining connection object. */
2740 rcu_read_lock();
2741 cds_lfht_for_each_entry(relay_connections_ht->ht, &iter.iter,
2742 destroy_conn,
2743 sock_n.node) {
2744 health_code_update();
2745 destroy_connection(relay_connections_ht, destroy_conn);
2746 }
2747 rcu_read_unlock();
2748 error_poll_create:
2749 rcu_read_lock();
2750 cds_lfht_for_each_entry(indexes_ht->ht, &iter.iter, index,
2751 index_n.node) {
2752 health_code_update();
2753 relay_index_delete(index);
2754 relay_index_free_safe(index);
2755 }
2756 rcu_read_unlock();
2757 lttng_ht_destroy(indexes_ht);
2758 indexes_ht_error:
2759 lttng_ht_destroy(relay_connections_ht);
2760 relay_connections_ht_error:
2761 /* Close relay conn pipes */
2762 utils_close_pipe(relay_conn_pipe);
2763 if (err) {
2764 DBG("Thread exited with error");
2765 }
2766 DBG("Worker thread cleanup complete");
2767 free(data_buffer);
2768 error_testpoint:
2769 if (err) {
2770 health_error();
2771 ERR("Health error occurred in %s", __func__);
2772 }
2773 health_unregister(health_relayd);
2774 rcu_unregister_thread();
2775 lttng_relay_stop_threads();
2776 return NULL;
2777 }
2778
2779 /*
2780 * Create the relay command pipe to wake thread_manage_apps.
2781 * Closed in cleanup().
2782 */
2783 static int create_relay_conn_pipe(void)
2784 {
2785 int ret;
2786
2787 ret = utils_create_pipe_cloexec(relay_conn_pipe);
2788
2789 return ret;
2790 }
2791
2792 /*
2793 * main
2794 */
2795 int main(int argc, char **argv)
2796 {
2797 int ret = 0, retval = 0;
2798 void *status;
2799 struct relay_local_data *relay_ctx = NULL;
2800
2801 /* Parse arguments */
2802 progname = argv[0];
2803 if (set_options(argc, argv)) {
2804 retval = -1;
2805 goto exit_options;
2806 }
2807
2808 if (set_signal_handler()) {
2809 retval = -1;
2810 goto exit_options;
2811 }
2812
2813 /* Try to create directory if -o, --output is specified. */
2814 if (opt_output_path) {
2815 if (*opt_output_path != '/') {
2816 ERR("Please specify an absolute path for -o, --output PATH");
2817 retval = -1;
2818 goto exit_options;
2819 }
2820
2821 ret = utils_mkdir_recursive(opt_output_path, S_IRWXU | S_IRWXG);
2822 if (ret < 0) {
2823 ERR("Unable to create %s", opt_output_path);
2824 retval = -1;
2825 goto exit_options;
2826 }
2827 }
2828
2829 /* Daemonize */
2830 if (opt_daemon || opt_background) {
2831 int i;
2832
2833 ret = lttng_daemonize(&child_ppid, &recv_child_signal,
2834 !opt_background);
2835 if (ret < 0) {
2836 retval = -1;
2837 goto exit_options;
2838 }
2839
2840 /*
2841 * We are in the child. Make sure all other file
2842 * descriptors are closed, in case we are called with
2843 * more opened file descriptors than the standard ones.
2844 */
2845 for (i = 3; i < sysconf(_SC_OPEN_MAX); i++) {
2846 (void) close(i);
2847 }
2848 }
2849
2850
2851 /* Initialize thread health monitoring */
2852 health_relayd = health_app_create(NR_HEALTH_RELAYD_TYPES);
2853 if (!health_relayd) {
2854 PERROR("health_app_create error");
2855 retval = -1;
2856 goto exit_health_app_create;
2857 }
2858
2859 /* Create thread quit pipe */
2860 if (init_thread_quit_pipe()) {
2861 retval = -1;
2862 goto exit_init_data;
2863 }
2864
2865 /* We need those values for the file/dir creation. */
2866 relayd_uid = getuid();
2867 relayd_gid = getgid();
2868
2869 /* Check if daemon is UID = 0 */
2870 if (relayd_uid == 0) {
2871 if (control_uri->port < 1024 || data_uri->port < 1024 || live_uri->port < 1024) {
2872 ERR("Need to be root to use ports < 1024");
2873 retval = -1;
2874 goto exit_init_data;
2875 }
2876 }
2877
2878 /* Setup the thread apps communication pipe. */
2879 if (create_relay_conn_pipe()) {
2880 retval = -1;
2881 goto exit_init_data;
2882 }
2883
2884 /* Init relay command queue. */
2885 cds_wfcq_init(&relay_conn_queue.head, &relay_conn_queue.tail);
2886
2887 /* Set up max poll set size */
2888 if (lttng_poll_set_max_size()) {
2889 retval = -1;
2890 goto exit_init_data;
2891 }
2892
2893 /* Initialize communication library */
2894 lttcomm_init();
2895 lttcomm_inet_init();
2896
2897 relay_ctx = zmalloc(sizeof(struct relay_local_data));
2898 if (!relay_ctx) {
2899 PERROR("relay_ctx");
2900 retval = -1;
2901 goto exit_init_data;
2902 }
2903
2904 /* tables of sessions indexed by session ID */
2905 relay_ctx->sessions_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
2906 if (!relay_ctx->sessions_ht) {
2907 retval = -1;
2908 goto exit_init_data;
2909 }
2910
2911 /* tables of streams indexed by stream ID */
2912 relay_streams_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
2913 if (!relay_streams_ht) {
2914 retval = -1;
2915 goto exit_init_data;
2916 }
2917
2918 /* tables of streams indexed by stream ID */
2919 viewer_streams_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
2920 if (!viewer_streams_ht) {
2921 retval = -1;
2922 goto exit_init_data;
2923 }
2924
2925 ret = utils_create_pipe(health_quit_pipe);
2926 if (ret) {
2927 retval = -1;
2928 goto exit_health_quit_pipe;
2929 }
2930
2931 /* Create thread to manage the client socket */
2932 ret = pthread_create(&health_thread, NULL,
2933 thread_manage_health, (void *) NULL);
2934 if (ret) {
2935 errno = ret;
2936 PERROR("pthread_create health");
2937 retval = -1;
2938 goto exit_health_thread;
2939 }
2940
2941 /* Setup the dispatcher thread */
2942 ret = pthread_create(&dispatcher_thread, NULL,
2943 relay_thread_dispatcher, (void *) NULL);
2944 if (ret) {
2945 errno = ret;
2946 PERROR("pthread_create dispatcher");
2947 retval = -1;
2948 goto exit_dispatcher_thread;
2949 }
2950
2951 /* Setup the worker thread */
2952 ret = pthread_create(&worker_thread, NULL,
2953 relay_thread_worker, (void *) relay_ctx);
2954 if (ret) {
2955 errno = ret;
2956 PERROR("pthread_create worker");
2957 retval = -1;
2958 goto exit_worker_thread;
2959 }
2960
2961 /* Setup the listener thread */
2962 ret = pthread_create(&listener_thread, NULL,
2963 relay_thread_listener, (void *) NULL);
2964 if (ret) {
2965 errno = ret;
2966 PERROR("pthread_create listener");
2967 retval = -1;
2968 goto exit_listener_thread;
2969 }
2970
2971 ret = relayd_live_create(live_uri, relay_ctx);
2972 if (ret) {
2973 ERR("Starting live viewer threads");
2974 retval = -1;
2975 goto exit_live;
2976 }
2977
2978 /*
2979 * This is where we start awaiting program completion (e.g. through
2980 * signal that asks threads to teardown).
2981 */
2982
2983 ret = relayd_live_join();
2984 if (ret) {
2985 retval = -1;
2986 }
2987 exit_live:
2988
2989 ret = pthread_join(listener_thread, &status);
2990 if (ret) {
2991 errno = ret;
2992 PERROR("pthread_join listener_thread");
2993 retval = -1;
2994 }
2995
2996 exit_listener_thread:
2997 ret = pthread_join(worker_thread, &status);
2998 if (ret) {
2999 errno = ret;
3000 PERROR("pthread_join worker_thread");
3001 retval = -1;
3002 }
3003
3004 exit_worker_thread:
3005 ret = pthread_join(dispatcher_thread, &status);
3006 if (ret) {
3007 errno = ret;
3008 PERROR("pthread_join dispatcher_thread");
3009 retval = -1;
3010 }
3011 exit_dispatcher_thread:
3012
3013 ret = pthread_join(health_thread, &status);
3014 if (ret) {
3015 errno = ret;
3016 PERROR("pthread_join health_thread");
3017 retval = -1;
3018 }
3019 exit_health_thread:
3020
3021 utils_close_pipe(health_quit_pipe);
3022 exit_health_quit_pipe:
3023
3024 exit_init_data:
3025 health_app_destroy(health_relayd);
3026 exit_health_app_create:
3027 exit_options:
3028 relayd_cleanup(relay_ctx);
3029
3030 if (!retval) {
3031 exit(EXIT_SUCCESS);
3032 } else {
3033 exit(EXIT_FAILURE);
3034 }
3035 }
This page took 0.110369 seconds and 4 git commands to generate.