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