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