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