src/bin/lttng-relayd/live.c

   1 /*
   2  * Copyright (C) 2013 - 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/futex.h>
  48 #include <common/index/index.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 "live.h"
  57 #include "lttng-relayd.h"
  58 #include "utils.h"
  59 #include "health-relayd.h"
  60 #include "testpoint.h"
  61 #include "viewer-stream.h"
  62 #include "stream.h"
  63 #include "session.h"
  64 #include "ctf-trace.h"
  65 #include "connection.h"
  66
  67 static struct lttng_uri *live_uri;
  68
  69 /*
  70  * This pipe is used to inform the worker thread that a command is queued and
  71  * ready to be processed.
  72  */
  73 static int live_conn_pipe[2] = { -1, -1 };
  74
  75 /* Shared between threads */
  76 static int live_dispatch_thread_exit;
  77
  78 static pthread_t live_listener_thread;
  79 static pthread_t live_dispatcher_thread;
  80 static pthread_t live_worker_thread;
  81
  82 /*
  83  * Relay command queue.
  84  *
  85  * The live_thread_listener and live_thread_dispatcher communicate with this
  86  * queue.
  87  */
  88 static struct relay_conn_queue viewer_conn_queue;
  89
  90 static uint64_t last_relay_viewer_session_id;
  91
  92 /*
  93  * Cleanup the daemon
  94  */
  95 static
  96 void cleanup(void)
  97 {
  98         DBG("Cleaning up");
  99
 100         free(live_uri);
 101 }
 102
 103 /*
 104  * Receive a request buffer using a given socket, destination allocated buffer
 105  * of length size.
 106  *
 107  * Return the size of the received message or else a negative value on error
 108  * with errno being set by recvmsg() syscall.
 109  */
 110 static
 111 ssize_t recv_request(struct lttcomm_sock *sock, void *buf, size_t size)
 112 {
 113         ssize_t ret;
 114
 115         assert(sock);
 116         assert(buf);
 117
 118         ret = sock->ops->recvmsg(sock, buf, size, 0);
 119         if (ret < 0 || ret != size) {
 120                 if (ret == 0) {
 121                         /* Orderly shutdown. Not necessary to print an error. */
 122                         DBG("Socket %d did an orderly shutdown", sock->fd);
 123                 } else {
 124                         ERR("Relay failed to receive request.");
 125                 }
 126                 ret = -1;
 127         }
 128
 129         return ret;
 130 }
 131
 132 /*
 133  * Send a response buffer using a given socket, source allocated buffer of
 134  * length size.
 135  *
 136  * Return the size of the sent message or else a negative value on error with
 137  * errno being set by sendmsg() syscall.
 138  */
 139 static
 140 ssize_t send_response(struct lttcomm_sock *sock, void *buf, size_t size)
 141 {
 142         ssize_t ret;
 143
 144         assert(sock);
 145         assert(buf);
 146
 147         ret = sock->ops->sendmsg(sock, buf, size, 0);
 148         if (ret < 0) {
 149                 ERR("Relayd failed to send response.");
 150         }
 151
 152         return ret;
 153 }
 154
 155 /*
 156  * Atomically check if new streams got added in one of the sessions attached
 157  * and reset the flag to 0.
 158  *
 159  * Returns 1 if new streams got added, 0 if nothing changed, a negative value
 160  * on error.
 161  */
 162 static
 163 int check_new_streams(struct relay_connection *conn)
 164 {
 165         struct relay_session *session;
 166         unsigned long current_val;
 167         int ret = 0;
 168
 169         if (!conn->viewer_session) {
 170                 goto end;
 171         }
 172         cds_list_for_each_entry(session,
 173                         &conn->viewer_session->sessions_head,
 174                         viewer_session_list) {
 175                 current_val = uatomic_cmpxchg(&session->new_streams, 1, 0);
 176                 ret = current_val;
 177                 if (ret == 1) {
 178                         goto end;
 179                 }
 180         }
 181
 182 end:
 183         return ret;
 184 }
 185
 186 /*
 187  * Send viewer streams to the given socket. The ignore_sent_flag indicates if
 188  * this function should ignore the sent flag or not.
 189  *
 190  * Return 0 on success or else a negative value.
 191  */
 192 static
 193 ssize_t send_viewer_streams(struct lttcomm_sock *sock,
 194                 struct relay_session *session, unsigned int ignore_sent_flag)
 195 {
 196         ssize_t ret;
 197         struct lttng_viewer_stream send_stream;
 198         struct lttng_ht_iter iter;
 199         struct relay_viewer_stream *vstream;
 200
 201         assert(session);
 202
 203         rcu_read_lock();
 204
 205         cds_lfht_for_each_entry(viewer_streams_ht->ht, &iter.iter, vstream,
 206                         stream_n.node) {
 207                 struct ctf_trace *ctf_trace;
 208
 209                 health_code_update();
 210
 211                 /* Ignore if not the same session. */
 212                 if (vstream->session_id != session->id ||
 213                                 (!ignore_sent_flag && vstream->sent_flag)) {
 214                         continue;
 215                 }
 216
 217                 ctf_trace = ctf_trace_find_by_path(session->ctf_traces_ht,
 218                                 vstream->path_name);
 219                 assert(ctf_trace);
 220
 221                 send_stream.id = htobe64(vstream->stream_handle);
 222                 send_stream.ctf_trace_id = htobe64(ctf_trace->id);
 223                 send_stream.metadata_flag = htobe32(vstream->metadata_flag);
 224                 strncpy(send_stream.path_name, vstream->path_name,
 225                                 sizeof(send_stream.path_name));
 226                 strncpy(send_stream.channel_name, vstream->channel_name,
 227                                 sizeof(send_stream.channel_name));
 228
 229                 DBG("Sending stream %" PRIu64 " to viewer", vstream->stream_handle);
 230                 ret = send_response(sock, &send_stream, sizeof(send_stream));
 231                 if (ret < 0) {
 232                         goto end_unlock;
 233                 }
 234                 vstream->sent_flag = 1;
 235         }
 236
 237         ret = 0;
 238
 239 end_unlock:
 240         rcu_read_unlock();
 241         return ret;
 242 }
 243
 244 /*
 245  * Create every viewer stream possible for the given session with the seek
 246  * type. Three counters *can* be return which are in order the total amount of
 247  * viewer stream of the session, the number of unsent stream and the number of
 248  * stream created. Those counters can be NULL and thus will be ignored.
 249  *
 250  * Return 0 on success or else a negative value.
 251  */
 252 static
 253 int make_viewer_streams(struct relay_session *session,
 254                 enum lttng_viewer_seek seek_t, uint32_t *nb_total, uint32_t *nb_unsent,
 255                 uint32_t *nb_created)
 256 {
 257         int ret;
 258         struct lttng_ht_iter iter;
 259         struct ctf_trace *ctf_trace;
 260
 261         assert(session);
 262
 263         /*
 264          * This is to make sure we create viewer streams for a full received
 265          * channel. For instance, if we have 8 streams for a channel that are
 266          * concurrently being flagged ready, we can end up creating just a subset
 267          * of the 8 streams (the ones that are flagged). This lock avoids this
 268          * limbo state.
 269          */
 270         pthread_mutex_lock(&session->viewer_ready_lock);
 271
 272         /*
 273          * Create viewer streams for relay streams that are ready to be used for a
 274          * the given session id only.
 275          */
 276         rcu_read_lock();
 277         cds_lfht_for_each_entry(session->ctf_traces_ht->ht, &iter.iter, ctf_trace,
 278                         node.node) {
 279                 struct relay_stream *stream;
 280
 281                 health_code_update();
 282
 283                 if (ctf_trace->invalid_flag) {
 284                         continue;
 285                 }
 286
 287                 cds_list_for_each_entry(stream, &ctf_trace->stream_list, trace_list) {
 288                         struct relay_viewer_stream *vstream;
 289
 290                         if (!stream->viewer_ready) {
 291                                 continue;
 292                         }
 293
 294                         vstream = viewer_stream_find_by_id(stream->stream_handle);
 295                         if (!vstream) {
 296                                 vstream = viewer_stream_create(stream, seek_t, ctf_trace);
 297                                 if (!vstream) {
 298                                         ret = -1;
 299                                         goto error_unlock;
 300                                 }
 301                                 /* Acquire reference to ctf_trace. */
 302                                 ctf_trace_get_ref(ctf_trace);
 303
 304                                 if (nb_created) {
 305                                         /* Update number of created stream counter. */
 306                                         (*nb_created)++;
 307                                 }
 308                         } else if (!vstream->sent_flag && nb_unsent) {
 309                                 /* Update number of unsent stream counter. */
 310                                 (*nb_unsent)++;
 311                         }
 312                         /* Update number of total stream counter. */
 313                         if (nb_total) {
 314                                 (*nb_total)++;
 315                         }
 316                 }
 317         }
 318
 319         ret = 0;
 320
 321 error_unlock:
 322         rcu_read_unlock();
 323         pthread_mutex_unlock(&session->viewer_ready_lock);
 324         return ret;
 325 }
 326
 327 /*
 328  * Write to writable pipe used to notify a thread.
 329  */
 330 static
 331 int notify_thread_pipe(int wpipe)
 332 {
 333         ssize_t ret;
 334
 335         ret = lttng_write(wpipe, "!", 1);
 336         if (ret < 1) {
 337                 PERROR("write poll pipe");
 338         }
 339
 340         return (int) ret;
 341 }
 342
 343 /*
 344  * Stop all threads by closing the thread quit pipe.
 345  */
 346 static
 347 void stop_threads(void)
 348 {
 349         int ret;
 350
 351         /* Stopping all threads */
 352         DBG("Terminating all live threads");
 353         ret = notify_thread_pipe(thread_quit_pipe[1]);
 354         if (ret < 0) {
 355                 ERR("write error on thread quit pipe");
 356         }
 357
 358         /* Dispatch thread */
 359         CMM_STORE_SHARED(live_dispatch_thread_exit, 1);
 360         futex_nto1_wake(&viewer_conn_queue.futex);
 361 }
 362
 363 /*
 364  * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
 365  */
 366 static
 367 int create_thread_poll_set(struct lttng_poll_event *events, int size)
 368 {
 369         int ret;
 370
 371         if (events == NULL || size == 0) {
 372                 ret = -1;
 373                 goto error;
 374         }
 375
 376         ret = lttng_poll_create(events, size, LTTNG_CLOEXEC);
 377         if (ret < 0) {
 378                 goto error;
 379         }
 380
 381         /* Add quit pipe */
 382         ret = lttng_poll_add(events, thread_quit_pipe[0], LPOLLIN | LPOLLERR);
 383         if (ret < 0) {
 384                 goto error;
 385         }
 386
 387         return 0;
 388
 389 error:
 390         return ret;
 391 }
 392
 393 /*
 394  * Check if the thread quit pipe was triggered.
 395  *
 396  * Return 1 if it was triggered else 0;
 397  */
 398 static
 399 int check_thread_quit_pipe(int fd, uint32_t events)
 400 {
 401         if (fd == thread_quit_pipe[0] && (events & LPOLLIN)) {
 402                 return 1;
 403         }
 404
 405         return 0;
 406 }
 407
 408 /*
 409  * Create and init socket from uri.
 410  */
 411 static
 412 struct lttcomm_sock *init_socket(struct lttng_uri *uri)
 413 {
 414         int ret;
 415         struct lttcomm_sock *sock = NULL;
 416
 417         sock = lttcomm_alloc_sock_from_uri(uri);
 418         if (sock == NULL) {
 419                 ERR("Allocating socket");
 420                 goto error;
 421         }
 422
 423         ret = lttcomm_create_sock(sock);
 424         if (ret < 0) {
 425                 goto error;
 426         }
 427         DBG("Listening on sock %d for live", sock->fd);
 428
 429         ret = sock->ops->bind(sock);
 430         if (ret < 0) {
 431                 goto error;
 432         }
 433
 434         ret = sock->ops->listen(sock, -1);
 435         if (ret < 0) {
 436                 goto error;
 437
 438         }
 439
 440         return sock;
 441
 442 error:
 443         if (sock) {
 444                 lttcomm_destroy_sock(sock);
 445         }
 446         return NULL;
 447 }
 448
 449 /*
 450  * This thread manages the listening for new connections on the network
 451  */
 452 static
 453 void *thread_listener(void *data)
 454 {
 455         int i, ret, pollfd, err = -1;
 456         uint32_t revents, nb_fd;
 457         struct lttng_poll_event events;
 458         struct lttcomm_sock *live_control_sock;
 459
 460         DBG("[thread] Relay live listener started");
 461
 462         health_register(health_relayd, HEALTH_RELAYD_TYPE_LIVE_LISTENER);
 463
 464         health_code_update();
 465
 466         live_control_sock = init_socket(live_uri);
 467         if (!live_control_sock) {
 468                 goto error_sock_control;
 469         }
 470
 471         /* Pass 2 as size here for the thread quit pipe and control sockets. */
 472         ret = create_thread_poll_set(&events, 2);
 473         if (ret < 0) {
 474                 goto error_create_poll;
 475         }
 476
 477         /* Add the control socket */
 478         ret = lttng_poll_add(&events, live_control_sock->fd, LPOLLIN | LPOLLRDHUP);
 479         if (ret < 0) {
 480                 goto error_poll_add;
 481         }
 482
 483         lttng_relay_notify_ready();
 484
 485         if (testpoint(relayd_thread_live_listener)) {
 486                 goto error_testpoint;
 487         }
 488
 489         while (1) {
 490                 health_code_update();
 491
 492                 DBG("Listener accepting live viewers connections");
 493
 494 restart:
 495                 health_poll_entry();
 496                 ret = lttng_poll_wait(&events, -1);
 497                 health_poll_exit();
 498                 if (ret < 0) {
 499                         /*
 500                          * Restart interrupted system call.
 501                          */
 502                         if (errno == EINTR) {
 503                                 goto restart;
 504                         }
 505                         goto error;
 506                 }
 507                 nb_fd = ret;
 508
 509                 DBG("Relay new viewer connection received");
 510                 for (i = 0; i < nb_fd; i++) {
 511                         health_code_update();
 512
 513                         /* Fetch once the poll data */
 514                         revents = LTTNG_POLL_GETEV(&events, i);
 515                         pollfd = LTTNG_POLL_GETFD(&events, i);
 516
 517                         /* Thread quit pipe has been closed. Killing thread. */
 518                         ret = check_thread_quit_pipe(pollfd, revents);
 519                         if (ret) {
 520                                 err = 0;
 521                                 goto exit;
 522                         }
 523
 524                         if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
 525                                 ERR("socket poll error");
 526                                 goto error;
 527                         } else if (revents & LPOLLIN) {
 528                                 /*
 529                                  * Get allocated in this thread, enqueued to a global queue,
 530                                  * dequeued and freed in the worker thread.
 531                                  */
 532                                 int val = 1;
 533                                 struct relay_connection *new_conn;
 534                                 struct lttcomm_sock *newsock;
 535
 536                                 new_conn = connection_create();
 537                                 if (!new_conn) {
 538                                         goto error;
 539                                 }
 540
 541                                 newsock = live_control_sock->ops->accept(live_control_sock);
 542                                 if (!newsock) {
 543                                         PERROR("accepting control sock");
 544                                         connection_free(new_conn);
 545                                         goto error;
 546                                 }
 547                                 DBG("Relay viewer connection accepted socket %d", newsock->fd);
 548
 549                                 ret = setsockopt(newsock->fd, SOL_SOCKET, SO_REUSEADDR, &val,
 550                                                 sizeof(val));
 551                                 if (ret < 0) {
 552                                         PERROR("setsockopt inet");
 553                                         lttcomm_destroy_sock(newsock);
 554                                         connection_free(new_conn);
 555                                         goto error;
 556                                 }
 557                                 new_conn->sock = newsock;
 558
 559                                 /* Enqueue request for the dispatcher thread. */
 560                                 cds_wfq_enqueue(&viewer_conn_queue.queue, &new_conn->qnode);
 561
 562                                 /*
 563                                  * Wake the dispatch queue futex. Implicit memory barrier with
 564                                  * the exchange in cds_wfq_enqueue.
 565                                  */
 566                                 futex_nto1_wake(&viewer_conn_queue.futex);
 567                         }
 568                 }
 569         }
 570
 571 exit:
 572 error:
 573 error_poll_add:
 574 error_testpoint:
 575         lttng_poll_clean(&events);
 576 error_create_poll:
 577         if (live_control_sock->fd >= 0) {
 578                 ret = live_control_sock->ops->close(live_control_sock);
 579                 if (ret) {
 580                         PERROR("close");
 581                 }
 582         }
 583         lttcomm_destroy_sock(live_control_sock);
 584 error_sock_control:
 585         if (err) {
 586                 health_error();
 587                 DBG("Live viewer listener thread exited with error");
 588         }
 589         health_unregister(health_relayd);
 590         DBG("Live viewer listener thread cleanup complete");
 591         stop_threads();
 592         return NULL;
 593 }
 594
 595 /*
 596  * This thread manages the dispatching of the requests to worker threads
 597  */
 598 static
 599 void *thread_dispatcher(void *data)
 600 {
 601         int err = -1;
 602         ssize_t ret;
 603         struct cds_wfq_node *node;
 604         struct relay_connection *conn = NULL;
 605
 606         DBG("[thread] Live viewer relay dispatcher started");
 607
 608         health_register(health_relayd, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER);
 609
 610         if (testpoint(relayd_thread_live_dispatcher)) {
 611                 goto error_testpoint;
 612         }
 613
 614         health_code_update();
 615
 616         while (!CMM_LOAD_SHARED(live_dispatch_thread_exit)) {
 617                 health_code_update();
 618
 619                 /* Atomically prepare the queue futex */
 620                 futex_nto1_prepare(&viewer_conn_queue.futex);
 621
 622                 do {
 623                         health_code_update();
 624
 625                         /* Dequeue commands */
 626                         node = cds_wfq_dequeue_blocking(&viewer_conn_queue.queue);
 627                         if (node == NULL) {
 628                                 DBG("Woken up but nothing in the live-viewer "
 629                                                 "relay command queue");
 630                                 /* Continue thread execution */
 631                                 break;
 632                         }
 633                         conn = caa_container_of(node, struct relay_connection, qnode);
 634                         DBG("Dispatching viewer request waiting on sock %d",
 635                                         conn->sock->fd);
 636
 637                         /*
 638                          * Inform worker thread of the new request. This call is blocking
 639                          * so we can be assured that the data will be read at some point in
 640                          * time or wait to the end of the world :)
 641                          */
 642                         ret = lttng_write(live_conn_pipe[1], &conn, sizeof(conn));
 643                         if (ret < 0) {
 644                                 PERROR("write conn pipe");
 645                                 connection_destroy(conn);
 646                                 goto error;
 647                         }
 648                 } while (node != NULL);
 649
 650                 /* Futex wait on queue. Blocking call on futex() */
 651                 health_poll_entry();
 652                 futex_nto1_wait(&viewer_conn_queue.futex);
 653                 health_poll_exit();
 654         }
 655
 656         /* Normal exit, no error */
 657         err = 0;
 658
 659 error:
 660 error_testpoint:
 661         if (err) {
 662                 health_error();
 663                 ERR("Health error occurred in %s", __func__);
 664         }
 665         health_unregister(health_relayd);
 666         DBG("Live viewer dispatch thread dying");
 667         stop_threads();
 668         return NULL;
 669 }
 670
 671 /*
 672  * Establish connection with the viewer and check the versions.
 673  *
 674  * Return 0 on success or else negative value.
 675  */
 676 static
 677 int viewer_connect(struct relay_connection *conn)
 678 {
 679         int ret;
 680         struct lttng_viewer_connect reply, msg;
 681
 682         assert(conn);
 683
 684         conn->version_check_done = 1;
 685
 686         health_code_update();
 687
 688         DBG("Viewer is establishing a connection to the relayd.");
 689
 690         ret = recv_request(conn->sock, &msg, sizeof(msg));
 691         if (ret < 0) {
 692                 goto end;
 693         }
 694
 695         health_code_update();
 696
 697         memset(&msg, 0, sizeof(msg));
 698         reply.major = RELAYD_VERSION_COMM_MAJOR;
 699         reply.minor = RELAYD_VERSION_COMM_MINOR;
 700
 701         /* Major versions must be the same */
 702         if (reply.major != be32toh(msg.major)) {
 703                 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
 704                                 reply.major, be32toh(msg.major));
 705                 ret = -1;
 706                 goto end;
 707         }
 708
 709         conn->major = reply.major;
 710         /* We adapt to the lowest compatible version */
 711         if (reply.minor <= be32toh(msg.minor)) {
 712                 conn->minor = reply.minor;
 713         } else {
 714                 conn->minor = be32toh(msg.minor);
 715         }
 716
 717         if (be32toh(msg.type) == LTTNG_VIEWER_CLIENT_COMMAND) {
 718                 conn->type = RELAY_VIEWER_COMMAND;
 719         } else if (be32toh(msg.type) == LTTNG_VIEWER_CLIENT_NOTIFICATION) {
 720                 conn->type = RELAY_VIEWER_NOTIFICATION;
 721         } else {
 722                 ERR("Unknown connection type : %u", be32toh(msg.type));
 723                 ret = -1;
 724                 goto end;
 725         }
 726
 727         reply.major = htobe32(reply.major);
 728         reply.minor = htobe32(reply.minor);
 729         if (conn->type == RELAY_VIEWER_COMMAND) {
 730                 reply.viewer_session_id = htobe64(++last_relay_viewer_session_id);
 731         }
 732
 733         health_code_update();
 734
 735         ret = send_response(conn->sock, &reply, sizeof(reply));
 736         if (ret < 0) {
 737                 goto end;
 738         }
 739
 740         health_code_update();
 741
 742         DBG("Version check done using protocol %u.%u", conn->major, conn->minor);
 743         ret = 0;
 744
 745 end:
 746         return ret;
 747 }
 748
 749 /*
 750  * Send the viewer the list of current sessions.
 751  *
 752  * Return 0 on success or else a negative value.
 753  */
 754 static
 755 int viewer_list_sessions(struct relay_connection *conn)
 756 {
 757         int ret;
 758         struct lttng_viewer_list_sessions session_list;
 759         unsigned long count;
 760         long approx_before, approx_after;
 761         struct lttng_ht_iter iter;
 762         struct lttng_viewer_session send_session;
 763         struct relay_session *session;
 764
 765         DBG("List sessions received");
 766
 767         rcu_read_lock();
 768         cds_lfht_count_nodes(conn->sessions_ht->ht, &approx_before, &count,
 769                         &approx_after);
 770         session_list.sessions_count = htobe32(count);
 771
 772         health_code_update();
 773
 774         ret = send_response(conn->sock, &session_list, sizeof(session_list));
 775         if (ret < 0) {
 776                 goto end_unlock;
 777         }
 778
 779         health_code_update();
 780
 781         cds_lfht_for_each_entry(conn->sessions_ht->ht, &iter.iter, session,
 782                         session_n.node) {
 783                 health_code_update();
 784
 785                 strncpy(send_session.session_name, session->session_name,
 786                                 sizeof(send_session.session_name));
 787                 strncpy(send_session.hostname, session->hostname,
 788                                 sizeof(send_session.hostname));
 789                 send_session.id = htobe64(session->id);
 790                 send_session.live_timer = htobe32(session->live_timer);
 791                 send_session.clients = htobe32(session->viewer_refcount);
 792                 send_session.streams = htobe32(session->stream_count);
 793
 794                 health_code_update();
 795
 796                 ret = send_response(conn->sock, &send_session, sizeof(send_session));
 797                 if (ret < 0) {
 798                         goto end_unlock;
 799                 }
 800         }
 801         health_code_update();
 802
 803         rcu_read_unlock();
 804         ret = 0;
 805         goto end;
 806
 807 end_unlock:
 808         rcu_read_unlock();
 809
 810 end:
 811         return ret;
 812 }
 813
 814 /*
 815  * Check if a connection is attached to a session.
 816  * Return 1 if attached, 0 if not attached, a negative value on error.
 817  */
 818 static
 819 int session_attached(struct relay_connection *conn, uint64_t session_id)
 820 {
 821         struct relay_session *session;
 822         int found = 0;
 823
 824         if (!conn->viewer_session) {
 825                 goto end;
 826         }
 827         cds_list_for_each_entry(session,
 828                         &conn->viewer_session->sessions_head,
 829                         viewer_session_list) {
 830                 if (session->id == session_id) {
 831                         found = 1;
 832                         goto end;
 833                 }
 834         }
 835
 836 end:
 837         return found;
 838 }
 839
 840 /*
 841  * Delete all streams for a specific session ID.
 842  */
 843 static void destroy_viewer_streams_by_session(struct relay_session *session)
 844 {
 845         struct relay_viewer_stream *stream;
 846         struct lttng_ht_iter iter;
 847
 848         assert(session);
 849
 850         rcu_read_lock();
 851         cds_lfht_for_each_entry(viewer_streams_ht->ht, &iter.iter, stream,
 852                         stream_n.node) {
 853                 struct ctf_trace *ctf_trace;
 854
 855                 health_code_update();
 856                 if (stream->session_id != session->id) {
 857                         continue;
 858                 }
 859
 860                 ctf_trace = ctf_trace_find_by_path(session->ctf_traces_ht,
 861                                 stream->path_name);
 862                 assert(ctf_trace);
 863
 864                 viewer_stream_delete(stream);
 865
 866                 if (stream->metadata_flag) {
 867                         ctf_trace->metadata_sent = 0;
 868                         ctf_trace->viewer_metadata_stream = NULL;
 869                 }
 870
 871                 viewer_stream_destroy(ctf_trace, stream);
 872         }
 873         rcu_read_unlock();
 874 }
 875
 876 static void try_destroy_streams(struct relay_session *session)
 877 {
 878         struct ctf_trace *ctf_trace;
 879         struct lttng_ht_iter iter;
 880
 881         assert(session);
 882
 883         cds_lfht_for_each_entry(session->ctf_traces_ht->ht, &iter.iter, ctf_trace,
 884                         node.node) {
 885                 /* Attempt to destroy the ctf trace of that session. */
 886                 ctf_trace_try_destroy(session, ctf_trace);
 887         }
 888 }
 889
 890 /*
 891  * Cleanup a session.
 892  */
 893 static void cleanup_session(struct relay_connection *conn,
 894                 struct relay_session *session)
 895 {
 896         /*
 897          * Very important that this is done before destroying the session so we
 898          * can put back every viewer stream reference from the ctf_trace.
 899          */
 900         destroy_viewer_streams_by_session(session);
 901         try_destroy_streams(session);
 902         cds_list_del(&session->viewer_session_list);
 903         session_viewer_try_destroy(conn->sessions_ht, session);
 904 }
 905
 906 /*
 907  * Send the viewer the list of current sessions.
 908  */
 909 static
 910 int viewer_get_new_streams(struct relay_connection *conn)
 911 {
 912         int ret, send_streams = 0;
 913         uint32_t nb_created = 0, nb_unsent = 0, nb_streams = 0;
 914         struct lttng_viewer_new_streams_request request;
 915         struct lttng_viewer_new_streams_response response;
 916         struct relay_session *session;
 917         uint64_t session_id;
 918
 919         assert(conn);
 920
 921         DBG("Get new streams received");
 922
 923         health_code_update();
 924
 925         /* Receive the request from the connected client. */
 926         ret = recv_request(conn->sock, &request, sizeof(request));
 927         if (ret < 0) {
 928                 goto error;
 929         }
 930         session_id = be64toh(request.session_id);
 931
 932         health_code_update();
 933
 934         rcu_read_lock();
 935         session = session_find_by_id(conn->sessions_ht, session_id);
 936         if (!session) {
 937                 DBG("Relay session %" PRIu64 " not found", session_id);
 938                 response.status = htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR);
 939                 goto send_reply;
 940         }
 941
 942         if (!session_attached(conn, session_id)) {
 943                 send_streams = 0;
 944                 response.status = htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR);
 945                 goto send_reply;
 946         }
 947
 948         send_streams = 1;
 949         response.status = htobe32(LTTNG_VIEWER_NEW_STREAMS_OK);
 950
 951         if (!send_streams) {
 952                 goto send_reply;
 953         }
 954
 955         ret = make_viewer_streams(session, LTTNG_VIEWER_SEEK_LAST, NULL, &nb_unsent,
 956                         &nb_created);
 957         if (ret < 0) {
 958                 goto end_unlock;
 959         }
 960         /* Only send back the newly created streams with the unsent ones. */
 961         nb_streams = nb_created + nb_unsent;
 962         response.streams_count = htobe32(nb_streams);
 963
 964         /*
 965          * If the session is closed and we have no new streams to send,
 966          * it means that the viewer has already received the whole trace
 967          * for this session and should now close it.
 968          */
 969         if (nb_streams == 0 && session->close_flag) {
 970                 send_streams = 0;
 971                 response.status = htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP);
 972                 /*
 973                  * Remove the session from the attached list of the connection
 974                  * and try to destroy it.
 975                  */
 976                 cds_list_del(&session->viewer_session_list);
 977                 cleanup_session(conn, session);
 978                 goto send_reply;
 979         }
 980
 981 send_reply:
 982         health_code_update();
 983         ret = send_response(conn->sock, &response, sizeof(response));
 984         if (ret < 0) {
 985                 goto end_unlock;
 986         }
 987         health_code_update();
 988
 989         /*
 990          * Unknown or empty session, just return gracefully, the viewer knows what
 991          * is happening.
 992          */
 993         if (!send_streams || !nb_streams) {
 994                 ret = 0;
 995                 goto end_unlock;
 996         }
 997
 998         /*
 999          * Send stream and *DON'T* ignore the sent flag so every viewer streams
1000          * that were not sent from that point will be sent to the viewer.
1001          */
1002         ret = send_viewer_streams(conn->sock, session, 0);
1003         if (ret < 0) {
1004                 goto end_unlock;
1005         }
1006
1007 end_unlock:
1008         rcu_read_unlock();
1009 error:
1010         return ret;
1011 }
1012
1013 /*
1014  * Send the viewer the list of current sessions.
1015  */
1016 static
1017 int viewer_attach_session(struct relay_connection *conn)
1018 {
1019         int send_streams = 0;
1020         ssize_t ret;
1021         uint32_t nb_streams = 0;
1022         enum lttng_viewer_seek seek_type;
1023         struct lttng_viewer_attach_session_request request;
1024         struct lttng_viewer_attach_session_response response;
1025         struct relay_session *session;
1026
1027         assert(conn);
1028
1029         health_code_update();
1030
1031         /* Receive the request from the connected client. */
1032         ret = recv_request(conn->sock, &request, sizeof(request));
1033         if (ret < 0) {
1034                 goto error;
1035         }
1036
1037         health_code_update();
1038
1039         if (!conn->viewer_session) {
1040                 DBG("Client trying to attach before creating a live viewer session");
1041                 response.status = htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION);
1042                 goto send_reply;
1043         }
1044
1045         rcu_read_lock();
1046         session = session_find_by_id(conn->sessions_ht,
1047                         be64toh(request.session_id));
1048         if (!session) {
1049                 DBG("Relay session %" PRIu64 " not found",
1050                                 be64toh(request.session_id));
1051                 response.status = htobe32(LTTNG_VIEWER_ATTACH_UNK);
1052                 goto send_reply;
1053         }
1054         session_viewer_attach(session);
1055         DBG("Attach session ID %" PRIu64 " received", be64toh(request.session_id));
1056
1057         if (uatomic_read(&session->viewer_refcount) > 1) {
1058                 DBG("Already a viewer attached");
1059                 response.status = htobe32(LTTNG_VIEWER_ATTACH_ALREADY);
1060                 session_viewer_detach(session);
1061                 goto send_reply;
1062         } else if (session->live_timer == 0) {
1063                 DBG("Not live session");
1064                 response.status = htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE);
1065                 goto send_reply;
1066         } else {
1067                 send_streams = 1;
1068                 response.status = htobe32(LTTNG_VIEWER_ATTACH_OK);
1069                 cds_list_add(&session->viewer_session_list,
1070                                 &conn->viewer_session->sessions_head);
1071         }
1072
1073         switch (be32toh(request.seek)) {
1074         case LTTNG_VIEWER_SEEK_BEGINNING:
1075         case LTTNG_VIEWER_SEEK_LAST:
1076                 seek_type = be32toh(request.seek);
1077                 break;
1078         default:
1079                 ERR("Wrong seek parameter");
1080                 response.status = htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR);
1081                 send_streams = 0;
1082                 goto send_reply;
1083         }
1084
1085         if (!send_streams) {
1086                 goto send_reply;
1087         }
1088
1089         ret = make_viewer_streams(session, seek_type, &nb_streams, NULL, NULL);
1090         if (ret < 0) {
1091                 goto end_unlock;
1092         }
1093         response.streams_count = htobe32(nb_streams);
1094
1095 send_reply:
1096         health_code_update();
1097         ret = send_response(conn->sock, &response, sizeof(response));
1098         if (ret < 0) {
1099                 goto end_unlock;
1100         }
1101         health_code_update();
1102
1103         /*
1104          * Unknown or empty session, just return gracefully, the viewer knows what
1105          * is happening.
1106          */
1107         if (!send_streams || !nb_streams) {
1108                 ret = 0;
1109                 goto end_unlock;
1110         }
1111
1112         /* Send stream and ignore the sent flag. */
1113         ret = send_viewer_streams(conn->sock, session, 1);
1114         if (ret < 0) {
1115                 goto end_unlock;
1116         }
1117
1118 end_unlock:
1119         rcu_read_unlock();
1120 error:
1121         return ret;
1122 }
1123
1124 /*
1125  * Send the next index for a stream.
1126  *
1127  * Return 0 on success or else a negative value.
1128  */
1129 static
1130 int viewer_get_next_index(struct relay_connection *conn)
1131 {
1132         int ret;
1133         struct lttng_viewer_get_next_index request_index;
1134         struct lttng_viewer_index viewer_index;
1135         struct ctf_packet_index packet_index;
1136         struct relay_viewer_stream *vstream;
1137         struct relay_stream *rstream;
1138         struct ctf_trace *ctf_trace;
1139         struct relay_session *session;
1140
1141         assert(conn);
1142
1143         DBG("Viewer get next index");
1144
1145         health_code_update();
1146
1147         ret = recv_request(conn->sock, &request_index, sizeof(request_index));
1148         if (ret < 0) {
1149                 goto end;
1150         }
1151         health_code_update();
1152
1153         rcu_read_lock();
1154         vstream = viewer_stream_find_by_id(be64toh(request_index.stream_id));
1155         if (!vstream) {
1156                 ret = -1;
1157                 goto end_unlock;
1158         }
1159
1160         session = session_find_by_id(conn->sessions_ht, vstream->session_id);
1161         if (!session) {
1162                 ret = -1;
1163                 goto end_unlock;
1164         }
1165
1166         ctf_trace = ctf_trace_find_by_path(session->ctf_traces_ht, vstream->path_name);
1167         assert(ctf_trace);
1168
1169         memset(&viewer_index, 0, sizeof(viewer_index));
1170
1171         /*
1172          * The viewer should not ask for index on metadata stream.
1173          */
1174         if (vstream->metadata_flag) {
1175                 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_HUP);
1176                 goto send_reply;
1177         }
1178
1179         /* First time, we open the index file */
1180         if (vstream->index_read_fd < 0) {
1181                 ret = index_open(vstream->path_name, vstream->channel_name,
1182                                 vstream->tracefile_count, vstream->tracefile_count_current);
1183                 if (ret == -ENOENT) {
1184                         /*
1185                          * The index is created only when the first data packet arrives, it
1186                          * might not be ready at the beginning of the session
1187                          */
1188                         viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_RETRY);
1189                         goto send_reply;
1190                 } else if (ret < 0) {
1191                         viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_ERR);
1192                         goto send_reply;
1193                 }
1194                 vstream->index_read_fd = ret;
1195         }
1196
1197         rstream = stream_find_by_id(relay_streams_ht, vstream->stream_handle);
1198         assert(rstream);
1199
1200         if (!rstream->close_flag) {
1201                 if (vstream->abort_flag) {
1202                         /* Rotate on abort (overwrite). */
1203                         DBG("Viewer rotate because of overwrite");
1204                         ret = viewer_stream_rotate(vstream, rstream);
1205                         if (ret < 0) {
1206                                 goto end_unlock;
1207                         } else if (ret == 1) {
1208                                 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_HUP);
1209                                 viewer_stream_delete(vstream);
1210                                 viewer_stream_destroy(ctf_trace, vstream);
1211                                 goto send_reply;
1212                         }
1213                         /* ret == 0 means successful so we continue. */
1214                 }
1215
1216                 pthread_mutex_lock(&rstream->viewer_stream_rotation_lock);
1217                 if (rstream->tracefile_count_current == vstream->tracefile_count_current) {
1218                         if (rstream->beacon_ts_end != -1ULL &&
1219                                 vstream->last_sent_index == rstream->total_index_received) {
1220                                 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_INACTIVE);
1221                                 viewer_index.timestamp_end = htobe64(rstream->beacon_ts_end);
1222                                 pthread_mutex_unlock(&rstream->viewer_stream_rotation_lock);
1223                                 goto send_reply;
1224                         } else if (rstream->total_index_received <= vstream->last_sent_index
1225                                         && !vstream->close_write_flag) {
1226                                 /*
1227                                  * Reader and writer are working in the same tracefile, so we care
1228                                  * about the number of index received and sent. Otherwise, we read
1229                                  * up to EOF.
1230                                  */
1231                                 pthread_mutex_unlock(&rstream->viewer_stream_rotation_lock);
1232                                 /* No new index to send, retry later. */
1233                                 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_RETRY);
1234                                 goto send_reply;
1235                         }
1236                 }
1237                 pthread_mutex_unlock(&rstream->viewer_stream_rotation_lock);
1238         } else if (rstream->close_flag && vstream->close_write_flag &&
1239                         vstream->total_index_received == vstream->last_sent_index) {
1240                 /* Last index sent and current tracefile closed in write */
1241                 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_HUP);
1242                 viewer_stream_delete(vstream);
1243                 viewer_stream_destroy(ctf_trace, vstream);
1244                 goto send_reply;
1245         } else {
1246                 vstream->close_write_flag = 1;
1247         }
1248
1249         if (!ctf_trace->metadata_received ||
1250                         ctf_trace->metadata_received > ctf_trace->metadata_sent) {
1251                 viewer_index.flags |= LTTNG_VIEWER_FLAG_NEW_METADATA;
1252         }
1253
1254         ret = check_new_streams(conn);
1255         if (ret < 0) {
1256                 goto end_unlock;
1257         } else if (ret == 1) {
1258                 viewer_index.flags |= LTTNG_VIEWER_FLAG_NEW_STREAM;
1259         }
1260
1261         pthread_mutex_lock(&vstream->overwrite_lock);
1262         if (vstream->abort_flag) {
1263                 /*
1264                  * The file is being overwritten by the writer, we cannot * use it.
1265                  */
1266                 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_RETRY);
1267                 pthread_mutex_unlock(&vstream->overwrite_lock);
1268                 ret = viewer_stream_rotate(vstream, rstream);
1269                 if (ret < 0) {
1270                         goto end_unlock;
1271                 } else if (ret == 1) {
1272                         viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_HUP);
1273                         viewer_stream_delete(vstream);
1274                         viewer_stream_destroy(ctf_trace, vstream);
1275                         goto send_reply;
1276                 }
1277                 goto send_reply;
1278         }
1279
1280         ret = lttng_read(vstream->index_read_fd, &packet_index,
1281                         sizeof(packet_index));
1282         pthread_mutex_unlock(&vstream->overwrite_lock);
1283         if (ret < sizeof(packet_index)) {
1284                 /*
1285                  * The tracefile is closed in write, so we read up to EOF.
1286                  */
1287                 if (vstream->close_write_flag == 1) {
1288                         viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_RETRY);
1289                         /* Rotate on normal EOF */
1290                         ret = viewer_stream_rotate(vstream, rstream);
1291                         if (ret < 0) {
1292                                 goto end_unlock;
1293                         } else if (ret == 1) {
1294                                 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_HUP);
1295                                 viewer_stream_delete(vstream);
1296                                 viewer_stream_destroy(ctf_trace, vstream);
1297                                 goto send_reply;
1298                         }
1299                 } else {
1300                         PERROR("Relay reading index file %d", vstream->index_read_fd);
1301                         viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_ERR);
1302                 }
1303                 goto send_reply;
1304         } else {
1305                 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_OK);
1306                 vstream->last_sent_index++;
1307         }
1308
1309         /*
1310          * Indexes are stored in big endian, no need to switch before sending.
1311          */
1312         viewer_index.offset = packet_index.offset;
1313         viewer_index.packet_size = packet_index.packet_size;
1314         viewer_index.content_size = packet_index.content_size;
1315         viewer_index.timestamp_begin = packet_index.timestamp_begin;
1316         viewer_index.timestamp_end = packet_index.timestamp_end;
1317         viewer_index.events_discarded = packet_index.events_discarded;
1318         viewer_index.stream_id = packet_index.stream_id;
1319
1320 send_reply:
1321         viewer_index.flags = htobe32(viewer_index.flags);
1322         health_code_update();
1323
1324         ret = send_response(conn->sock, &viewer_index, sizeof(viewer_index));
1325         if (ret < 0) {
1326                 goto end_unlock;
1327         }
1328         health_code_update();
1329
1330         DBG("Index %" PRIu64 " for stream %" PRIu64 " sent",
1331                         vstream->last_sent_index, vstream->stream_handle);
1332
1333 end_unlock:
1334         rcu_read_unlock();
1335
1336 end:
1337         return ret;
1338 }
1339
1340 /*
1341  * Send the next index for a stream
1342  *
1343  * Return 0 on success or else a negative value.
1344  */
1345 static
1346 int viewer_get_packet(struct relay_connection *conn)
1347 {
1348         int ret, send_data = 0;
1349         char *data = NULL;
1350         uint32_t len = 0;
1351         ssize_t read_len;
1352         struct lttng_viewer_get_packet get_packet_info;
1353         struct lttng_viewer_trace_packet reply;
1354         struct relay_viewer_stream *stream;
1355         struct relay_session *session;
1356         struct ctf_trace *ctf_trace;
1357
1358         assert(conn);
1359
1360         DBG2("Relay get data packet");
1361
1362         health_code_update();
1363
1364         ret = recv_request(conn->sock, &get_packet_info, sizeof(get_packet_info));
1365         if (ret < 0) {
1366                 goto end;
1367         }
1368         health_code_update();
1369
1370         /* From this point on, the error label can be reached. */
1371         memset(&reply, 0, sizeof(reply));
1372
1373         rcu_read_lock();
1374         stream = viewer_stream_find_by_id(be64toh(get_packet_info.stream_id));
1375         if (!stream) {
1376                 goto error;
1377         }
1378
1379         session = session_find_by_id(conn->sessions_ht, stream->session_id);
1380         if (!session) {
1381                 ret = -1;
1382                 goto error;
1383         }
1384
1385         ctf_trace = ctf_trace_find_by_path(session->ctf_traces_ht,
1386                         stream->path_name);
1387         assert(ctf_trace);
1388
1389         /*
1390          * First time we read this stream, we need open the tracefile, we should
1391          * only arrive here if an index has already been sent to the viewer, so the
1392          * tracefile must exist, if it does not it is a fatal error.
1393          */
1394         if (stream->read_fd < 0) {
1395                 char fullpath[PATH_MAX];
1396
1397                 if (stream->tracefile_count > 0) {
1398                         ret = snprintf(fullpath, PATH_MAX, "%s/%s_%" PRIu64, stream->path_name,
1399                                         stream->channel_name,
1400                                         stream->tracefile_count_current);
1401                 } else {
1402                         ret = snprintf(fullpath, PATH_MAX, "%s/%s", stream->path_name,
1403                                         stream->channel_name);
1404                 }
1405                 if (ret < 0) {
1406                         goto error;
1407                 }
1408                 ret = open(fullpath, O_RDONLY);
1409                 if (ret < 0) {
1410                         PERROR("Relay opening trace file");
1411                         goto error;
1412                 }
1413                 stream->read_fd = ret;
1414         }
1415
1416         if (!ctf_trace->metadata_received ||
1417                         ctf_trace->metadata_received > ctf_trace->metadata_sent) {
1418                 reply.status = htobe32(LTTNG_VIEWER_GET_PACKET_ERR);
1419                 reply.flags |= LTTNG_VIEWER_FLAG_NEW_METADATA;
1420                 goto send_reply;
1421         }
1422
1423         ret = check_new_streams(conn);
1424         if (ret < 0) {
1425                 goto end_unlock;
1426         } else if (ret == 1) {
1427                 reply.status = htobe32(LTTNG_VIEWER_GET_PACKET_ERR);
1428                 reply.flags |= LTTNG_VIEWER_FLAG_NEW_STREAM;
1429                 goto send_reply;
1430         }
1431
1432         len = be32toh(get_packet_info.len);
1433         data = zmalloc(len);
1434         if (!data) {
1435                 PERROR("relay data zmalloc");
1436                 goto error;
1437         }
1438
1439         ret = lseek(stream->read_fd, be64toh(get_packet_info.offset), SEEK_SET);
1440         if (ret < 0) {
1441                 /*
1442                  * If the read fd was closed by the streaming side, the
1443                  * abort_flag will be set to 1, otherwise it is an error.
1444                  */
1445                 if (stream->abort_flag == 0) {
1446                         PERROR("lseek");
1447                         goto error;
1448                 }
1449                 reply.status = htobe32(LTTNG_VIEWER_GET_PACKET_EOF);
1450                 goto send_reply;
1451         }
1452         read_len = lttng_read(stream->read_fd, data, len);
1453         if (read_len < len) {
1454                 /*
1455                  * If the read fd was closed by the streaming side, the
1456                  * abort_flag will be set to 1, otherwise it is an error.
1457                  */
1458                 if (stream->abort_flag == 0) {
1459                         PERROR("Relay reading trace file, fd: %d, offset: %" PRIu64,
1460                                         stream->read_fd,
1461                                         be64toh(get_packet_info.offset));
1462                         goto error;
1463                 } else {
1464                         reply.status = htobe32(LTTNG_VIEWER_GET_PACKET_EOF);
1465                         goto send_reply;
1466                 }
1467         }
1468         reply.status = htobe32(LTTNG_VIEWER_GET_PACKET_OK);
1469         reply.len = htobe32(len);
1470         send_data = 1;
1471         goto send_reply;
1472
1473 error:
1474         reply.status = htobe32(LTTNG_VIEWER_GET_PACKET_ERR);
1475
1476 send_reply:
1477         reply.flags = htobe32(reply.flags);
1478
1479         health_code_update();
1480
1481         ret = send_response(conn->sock, &reply, sizeof(reply));
1482         if (ret < 0) {
1483                 goto end_unlock;
1484         }
1485         health_code_update();
1486
1487         if (send_data) {
1488                 health_code_update();
1489                 ret = send_response(conn->sock, data, len);
1490                 if (ret < 0) {
1491                         goto end_unlock;
1492                 }
1493                 health_code_update();
1494         }
1495
1496         DBG("Sent %u bytes for stream %" PRIu64, len,
1497                         be64toh(get_packet_info.stream_id));
1498
1499 end_unlock:
1500         free(data);
1501         rcu_read_unlock();
1502
1503 end:
1504         return ret;
1505 }
1506
1507 /*
1508  * Send the session's metadata
1509  *
1510  * Return 0 on success else a negative value.
1511  */
1512 static
1513 int viewer_get_metadata(struct relay_connection *conn)
1514 {
1515         int ret = 0;
1516         ssize_t read_len;
1517         uint64_t len = 0;
1518         char *data = NULL;
1519         struct lttng_viewer_get_metadata request;
1520         struct lttng_viewer_metadata_packet reply;
1521         struct relay_viewer_stream *stream;
1522         struct ctf_trace *ctf_trace;
1523         struct relay_session *session;
1524
1525         assert(conn);
1526
1527         DBG("Relay get metadata");
1528
1529         health_code_update();
1530
1531         ret = recv_request(conn->sock, &request, sizeof(request));
1532         if (ret < 0) {
1533                 goto end;
1534         }
1535         health_code_update();
1536
1537         rcu_read_lock();
1538         stream = viewer_stream_find_by_id(be64toh(request.stream_id));
1539         if (!stream || !stream->metadata_flag) {
1540                 ERR("Invalid metadata stream");
1541                 goto error;
1542         }
1543
1544         session = session_find_by_id(conn->sessions_ht, stream->session_id);
1545         if (!session) {
1546                 ret = -1;
1547                 goto error;
1548         }
1549
1550         ctf_trace = ctf_trace_find_by_path(session->ctf_traces_ht,
1551                         stream->path_name);
1552         assert(ctf_trace);
1553         assert(ctf_trace->metadata_sent <= ctf_trace->metadata_received);
1554
1555         len = ctf_trace->metadata_received - ctf_trace->metadata_sent;
1556         if (len == 0) {
1557                 reply.status = htobe32(LTTNG_VIEWER_NO_NEW_METADATA);
1558                 goto send_reply;
1559         }
1560
1561         /* first time, we open the metadata file */
1562         if (stream->read_fd < 0) {
1563                 char fullpath[PATH_MAX];
1564
1565                 ret = snprintf(fullpath, PATH_MAX, "%s/%s", stream->path_name,
1566                                 stream->channel_name);
1567                 if (ret < 0) {
1568                         goto error;
1569                 }
1570                 ret = open(fullpath, O_RDONLY);
1571                 if (ret < 0) {
1572                         PERROR("Relay opening metadata file");
1573                         goto error;
1574                 }
1575                 stream->read_fd = ret;
1576         }
1577
1578         reply.len = htobe64(len);
1579         data = zmalloc(len);
1580         if (!data) {
1581                 PERROR("viewer metadata zmalloc");
1582                 goto error;
1583         }
1584
1585         read_len = lttng_read(stream->read_fd, data, len);
1586         if (read_len < len) {
1587                 PERROR("Relay reading metadata file");
1588                 goto error;
1589         }
1590         ctf_trace->metadata_sent += read_len;
1591         reply.status = htobe32(LTTNG_VIEWER_METADATA_OK);
1592         goto send_reply;
1593
1594 error:
1595         reply.status = htobe32(LTTNG_VIEWER_METADATA_ERR);
1596
1597 send_reply:
1598         health_code_update();
1599         ret = send_response(conn->sock, &reply, sizeof(reply));
1600         if (ret < 0) {
1601                 goto end_unlock;
1602         }
1603         health_code_update();
1604
1605         if (len > 0) {
1606                 ret = send_response(conn->sock, data, len);
1607                 if (ret < 0) {
1608                         goto end_unlock;
1609                 }
1610         }
1611
1612         DBG("Sent %" PRIu64 " bytes of metadata for stream %" PRIu64, len,
1613                         be64toh(request.stream_id));
1614
1615         DBG("Metadata sent");
1616
1617 end_unlock:
1618         free(data);
1619         rcu_read_unlock();
1620 end:
1621         return ret;
1622 }
1623
1624 /*
1625  * Create a viewer session.
1626  *
1627  * Return 0 on success or else a negative value.
1628  */
1629 static
1630 int viewer_create_session(struct relay_connection *conn)
1631 {
1632         int ret;
1633         struct lttng_viewer_create_session_response resp;
1634
1635         DBG("Viewer create session received");
1636
1637         resp.status = htobe32(LTTNG_VIEWER_CREATE_SESSION_OK);
1638         conn->viewer_session = zmalloc(sizeof(conn->viewer_session));
1639         if (!conn->viewer_session) {
1640                 ERR("Allocation viewer session");
1641                 resp.status = htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR);
1642                 goto send_reply;
1643         }
1644         CDS_INIT_LIST_HEAD(&conn->viewer_session->sessions_head);
1645
1646 send_reply:
1647         health_code_update();
1648         ret = send_response(conn->sock, &resp, sizeof(resp));
1649         if (ret < 0) {
1650                 goto end;
1651         }
1652         health_code_update();
1653         ret = 0;
1654
1655 end:
1656         return ret;
1657 }
1658
1659
1660 /*
1661  * live_relay_unknown_command: send -1 if received unknown command
1662  */
1663 static
1664 void live_relay_unknown_command(struct relay_connection *conn)
1665 {
1666         struct lttcomm_relayd_generic_reply reply;
1667
1668         reply.ret_code = htobe32(LTTNG_ERR_UNK);
1669         (void) send_response(conn->sock, &reply, sizeof(reply));
1670 }
1671
1672 /*
1673  * Process the commands received on the control socket
1674  */
1675 static
1676 int process_control(struct lttng_viewer_cmd *recv_hdr,
1677                 struct relay_connection *conn)
1678 {
1679         int ret = 0;
1680         uint32_t msg_value;
1681
1682         assert(recv_hdr);
1683         assert(conn);
1684
1685         msg_value = be32toh(recv_hdr->cmd);
1686
1687         /*
1688          * Make sure we've done the version check before any command other then a
1689          * new client connection.
1690          */
1691         if (msg_value != LTTNG_VIEWER_CONNECT && !conn->version_check_done) {
1692                 ERR("Viewer conn value %" PRIu32 " before version check", msg_value);
1693                 ret = -1;
1694                 goto end;
1695         }
1696
1697         switch (msg_value) {
1698         case LTTNG_VIEWER_CONNECT:
1699                 ret = viewer_connect(conn);
1700                 break;
1701         case LTTNG_VIEWER_LIST_SESSIONS:
1702                 ret = viewer_list_sessions(conn);
1703                 break;
1704         case LTTNG_VIEWER_ATTACH_SESSION:
1705                 ret = viewer_attach_session(conn);
1706                 break;
1707         case LTTNG_VIEWER_GET_NEXT_INDEX:
1708                 ret = viewer_get_next_index(conn);
1709                 break;
1710         case LTTNG_VIEWER_GET_PACKET:
1711                 ret = viewer_get_packet(conn);
1712                 break;
1713         case LTTNG_VIEWER_GET_METADATA:
1714                 ret = viewer_get_metadata(conn);
1715                 break;
1716         case LTTNG_VIEWER_GET_NEW_STREAMS:
1717                 ret = viewer_get_new_streams(conn);
1718                 break;
1719         case LTTNG_VIEWER_CREATE_SESSION:
1720                 ret = viewer_create_session(conn);
1721                 break;
1722         default:
1723                 ERR("Received unknown viewer command (%u)", be32toh(recv_hdr->cmd));
1724                 live_relay_unknown_command(conn);
1725                 ret = -1;
1726                 goto end;
1727         }
1728
1729 end:
1730         return ret;
1731 }
1732
1733 static
1734 void cleanup_connection_pollfd(struct lttng_poll_event *events, int pollfd)
1735 {
1736         int ret;
1737
1738         assert(events);
1739
1740         (void) lttng_poll_del(events, pollfd);
1741
1742         ret = close(pollfd);
1743         if (ret < 0) {
1744                 ERR("Closing pollfd %d", pollfd);
1745         }
1746 }
1747
1748 /*
1749  * Delete and destroy a connection.
1750  *
1751  * RCU read side lock MUST be acquired.
1752  */
1753 static void destroy_connection(struct lttng_ht *relay_connections_ht,
1754                 struct relay_connection *conn)
1755 {
1756         struct relay_session *session, *tmp_session;
1757
1758         assert(relay_connections_ht);
1759         assert(conn);
1760
1761         connection_delete(relay_connections_ht, conn);
1762
1763         if (!conn->viewer_session) {
1764                 goto end;
1765         }
1766
1767         rcu_read_lock();
1768         cds_list_for_each_entry_safe(session, tmp_session,
1769                         &conn->viewer_session->sessions_head,
1770                         viewer_session_list) {
1771                 DBG("Cleaning connection of session ID %" PRIu64, session->id);
1772                 cleanup_session(conn, session);
1773         }
1774         rcu_read_unlock();
1775
1776 end:
1777         connection_destroy(conn);
1778 }
1779
1780 /*
1781  * This thread does the actual work
1782  */
1783 static
1784 void *thread_worker(void *data)
1785 {
1786         int ret, err = -1;
1787         uint32_t nb_fd;
1788         struct relay_connection *conn;
1789         struct lttng_poll_event events;
1790         struct lttng_ht *relay_connections_ht;
1791         struct lttng_ht_iter iter;
1792         struct lttng_viewer_cmd recv_hdr;
1793         struct relay_local_data *relay_ctx = (struct relay_local_data *) data;
1794         struct lttng_ht *sessions_ht = relay_ctx->sessions_ht;
1795
1796         DBG("[thread] Live viewer relay worker started");
1797
1798         rcu_register_thread();
1799
1800         health_register(health_relayd, HEALTH_RELAYD_TYPE_LIVE_WORKER);
1801
1802         if (testpoint(relayd_thread_live_worker)) {
1803                 goto error_testpoint;
1804         }
1805
1806         /* table of connections indexed on socket */
1807         relay_connections_ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
1808         if (!relay_connections_ht) {
1809                 goto relay_connections_ht_error;
1810         }
1811
1812         ret = create_thread_poll_set(&events, 2);
1813         if (ret < 0) {
1814                 goto error_poll_create;
1815         }
1816
1817         ret = lttng_poll_add(&events, live_conn_pipe[0], LPOLLIN | LPOLLRDHUP);
1818         if (ret < 0) {
1819                 goto error;
1820         }
1821
1822 restart:
1823         while (1) {
1824                 int i;
1825
1826                 health_code_update();
1827
1828                 /* Infinite blocking call, waiting for transmission */
1829                 DBG3("Relayd live viewer worker thread polling...");
1830                 health_poll_entry();
1831                 ret = lttng_poll_wait(&events, -1);
1832                 health_poll_exit();
1833                 if (ret < 0) {
1834                         /*
1835                          * Restart interrupted system call.
1836                          */
1837                         if (errno == EINTR) {
1838                                 goto restart;
1839                         }
1840                         goto error;
1841                 }
1842
1843                 nb_fd = ret;
1844
1845                 /*
1846                  * Process control. The control connection is prioritised so we don't
1847                  * starve it with high throughput tracing data on the data
1848                  * connection.
1849                  */
1850                 for (i = 0; i < nb_fd; i++) {
1851                         /* Fetch once the poll data */
1852                         uint32_t revents = LTTNG_POLL_GETEV(&events, i);
1853                         int pollfd = LTTNG_POLL_GETFD(&events, i);
1854
1855                         health_code_update();
1856
1857                         /* Thread quit pipe has been closed. Killing thread. */
1858                         ret = check_thread_quit_pipe(pollfd, revents);
1859                         if (ret) {
1860                                 err = 0;
1861                                 goto exit;
1862                         }
1863
1864                         /* Inspect the relay conn pipe for new connection */
1865                         if (pollfd == live_conn_pipe[0]) {
1866                                 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
1867                                         ERR("Relay live pipe error");
1868                                         goto error;
1869                                 } else if (revents & LPOLLIN) {
1870                                         ret = lttng_read(live_conn_pipe[0], &conn, sizeof(conn));
1871                                         if (ret < 0) {
1872                                                 goto error;
1873                                         }
1874                                         conn->sessions_ht = sessions_ht;
1875                                         connection_init(conn);
1876                                         lttng_poll_add(&events, conn->sock->fd,
1877                                                         LPOLLIN | LPOLLRDHUP);
1878                                         rcu_read_lock();
1879                                         lttng_ht_add_unique_ulong(relay_connections_ht,
1880                                                         &conn->sock_n);
1881                                         rcu_read_unlock();
1882                                         DBG("Connection socket %d added", conn->sock->fd);
1883                                 }
1884                         } else {
1885                                 rcu_read_lock();
1886                                 conn = connection_find_by_sock(relay_connections_ht, pollfd);
1887                                 /* If not found, there is a synchronization issue. */
1888                                 assert(conn);
1889
1890                                 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
1891                                         cleanup_connection_pollfd(&events, pollfd);
1892                                         destroy_connection(relay_connections_ht, conn);
1893                                 } else if (revents & LPOLLIN) {
1894                                         ret = conn->sock->ops->recvmsg(conn->sock, &recv_hdr,
1895                                                         sizeof(recv_hdr), 0);
1896                                         if (ret <= 0) {
1897                                                 /* Connection closed */
1898                                                 cleanup_connection_pollfd(&events, pollfd);
1899                                                 destroy_connection(relay_connections_ht, conn);
1900                                                 DBG("Viewer control conn closed with %d", pollfd);
1901                                         } else {
1902                                                 ret = process_control(&recv_hdr, conn);
1903                                                 if (ret < 0) {
1904                                                         /* Clear the session on error. */
1905                                                         cleanup_connection_pollfd(&events, pollfd);
1906                                                         destroy_connection(relay_connections_ht, conn);
1907                                                         DBG("Viewer connection closed with %d", pollfd);
1908                                                 }
1909                                         }
1910                                 }
1911                                 rcu_read_unlock();
1912                         }
1913                 }
1914         }
1915
1916 exit:
1917 error:
1918         lttng_poll_clean(&events);
1919
1920         /* Cleanup reamaining connection object. */
1921         rcu_read_lock();
1922         cds_lfht_for_each_entry(relay_connections_ht->ht, &iter.iter, conn,
1923                         sock_n.node) {
1924                 health_code_update();
1925                 destroy_connection(relay_connections_ht, conn);
1926         }
1927         rcu_read_unlock();
1928 error_poll_create:
1929         lttng_ht_destroy(relay_connections_ht);
1930 relay_connections_ht_error:
1931         /* Close relay conn pipes */
1932         utils_close_pipe(live_conn_pipe);
1933         if (err) {
1934                 DBG("Viewer worker thread exited with error");
1935         }
1936         DBG("Viewer worker thread cleanup complete");
1937 error_testpoint:
1938         if (err) {
1939                 health_error();
1940                 ERR("Health error occurred in %s", __func__);
1941         }
1942         health_unregister(health_relayd);
1943         stop_threads();
1944         rcu_unregister_thread();
1945         return NULL;
1946 }
1947
1948 /*
1949  * Create the relay command pipe to wake thread_manage_apps.
1950  * Closed in cleanup().
1951  */
1952 static int create_conn_pipe(void)
1953 {
1954         int ret;
1955
1956         ret = utils_create_pipe_cloexec(live_conn_pipe);
1957
1958         return ret;
1959 }
1960
1961 void live_stop_threads(void)
1962 {
1963         int ret;
1964         void *status;
1965
1966         stop_threads();
1967
1968         ret = pthread_join(live_listener_thread, &status);
1969         if (ret != 0) {
1970                 PERROR("pthread_join live listener");
1971                 goto error;     /* join error, exit without cleanup */
1972         }
1973
1974         ret = pthread_join(live_worker_thread, &status);
1975         if (ret != 0) {
1976                 PERROR("pthread_join live worker");
1977                 goto error;     /* join error, exit without cleanup */
1978         }
1979
1980         ret = pthread_join(live_dispatcher_thread, &status);
1981         if (ret != 0) {
1982                 PERROR("pthread_join live dispatcher");
1983                 goto error;     /* join error, exit without cleanup */
1984         }
1985
1986         cleanup();
1987
1988 error:
1989         return;
1990 }
1991
1992 /*
1993  * main
1994  */
1995 int live_start_threads(struct lttng_uri *uri,
1996                 struct relay_local_data *relay_ctx)
1997 {
1998         int ret = 0;
1999         void *status;
2000         int is_root;
2001
2002         assert(uri);
2003         live_uri = uri;
2004
2005         /* Check if daemon is UID = 0 */
2006         is_root = !getuid();
2007
2008         if (!is_root) {
2009                 if (live_uri->port < 1024) {
2010                         ERR("Need to be root to use ports < 1024");
2011                         ret = -1;
2012                         goto exit;
2013                 }
2014         }
2015
2016         /* Setup the thread apps communication pipe. */
2017         if ((ret = create_conn_pipe()) < 0) {
2018                 goto exit;
2019         }
2020
2021         /* Init relay command queue. */
2022         cds_wfq_init(&viewer_conn_queue.queue);
2023
2024         /* Set up max poll set size */
2025         lttng_poll_set_max_size();
2026
2027         /* Setup the dispatcher thread */
2028         ret = pthread_create(&live_dispatcher_thread, NULL,
2029                         thread_dispatcher, (void *) NULL);
2030         if (ret != 0) {
2031                 PERROR("pthread_create viewer dispatcher");
2032                 goto exit_dispatcher;
2033         }
2034
2035         /* Setup the worker thread */
2036         ret = pthread_create(&live_worker_thread, NULL,
2037                         thread_worker, relay_ctx);
2038         if (ret != 0) {
2039                 PERROR("pthread_create viewer worker");
2040                 goto exit_worker;
2041         }
2042
2043         /* Setup the listener thread */
2044         ret = pthread_create(&live_listener_thread, NULL,
2045                         thread_listener, (void *) NULL);
2046         if (ret != 0) {
2047                 PERROR("pthread_create viewer listener");
2048                 goto exit_listener;
2049         }
2050
2051         ret = 0;
2052         goto end;
2053
2054 exit_listener:
2055         ret = pthread_join(live_listener_thread, &status);
2056         if (ret != 0) {
2057                 PERROR("pthread_join live listener");
2058                 goto error;     /* join error, exit without cleanup */
2059         }
2060
2061 exit_worker:
2062         ret = pthread_join(live_worker_thread, &status);
2063         if (ret != 0) {
2064                 PERROR("pthread_join live worker");
2065                 goto error;     /* join error, exit without cleanup */
2066         }
2067
2068 exit_dispatcher:
2069         ret = pthread_join(live_dispatcher_thread, &status);
2070         if (ret != 0) {
2071                 PERROR("pthread_join live dispatcher");
2072                 goto error;     /* join error, exit without cleanup */
2073         }
2074
2075 exit:
2076         cleanup();
2077
2078 end:
2079 error:
2080         return ret;
2081 }