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