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