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