src/bin/lttng-sessiond/consumer.c

   1 /*
   2  * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License, version 2 only, as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with
  14  * this program; if not, write to the Free Software Foundation, Inc., 51
  15  * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #define _LGPL_SOURCE
  19 #include <assert.h>
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <sys/stat.h>
  24 #include <sys/types.h>
  25 #include <unistd.h>
  26 #include <inttypes.h>
  27
  28 #include <common/common.h>
  29 #include <common/defaults.h>
  30 #include <common/uri.h>
  31 #include <common/relayd/relayd.h>
  32
  33 #include "consumer.h"
  34 #include "health-sessiond.h"
  35 #include "ust-app.h"
  36 #include "utils.h"
  37
  38 /*
  39  * Send a data payload using a given consumer socket of size len.
  40  *
  41  * The consumer socket lock MUST be acquired before calling this since this
  42  * function can change the fd value.
  43  *
  44  * Return 0 on success else a negative value on error.
  45  */
  46 int consumer_socket_send(struct consumer_socket *socket, void *msg, size_t len)
  47 {
  48         int fd;
  49         ssize_t size;
  50
  51         assert(socket);
  52         assert(socket->fd_ptr);
  53         assert(msg);
  54
  55         /* Consumer socket is invalid. Stopping. */
  56         fd = *socket->fd_ptr;
  57         if (fd < 0) {
  58                 goto error;
  59         }
  60
  61         size = lttcomm_send_unix_sock(fd, msg, len);
  62         if (size < 0) {
  63                 /* The above call will print a PERROR on error. */
  64                 DBG("Error when sending data to consumer on sock %d", fd);
  65                 /*
  66                  * At this point, the socket is not usable anymore thus closing it and
  67                  * setting the file descriptor to -1 so it is not reused.
  68                  */
  69
  70                 /* This call will PERROR on error. */
  71                 (void) lttcomm_close_unix_sock(fd);
  72                 *socket->fd_ptr = -1;
  73                 goto error;
  74         }
  75
  76         return 0;
  77
  78 error:
  79         return -1;
  80 }
  81
  82 /*
  83  * Receive a data payload using a given consumer socket of size len.
  84  *
  85  * The consumer socket lock MUST be acquired before calling this since this
  86  * function can change the fd value.
  87  *
  88  * Return 0 on success else a negative value on error.
  89  */
  90 int consumer_socket_recv(struct consumer_socket *socket, void *msg, size_t len)
  91 {
  92         int fd;
  93         ssize_t size;
  94
  95         assert(socket);
  96         assert(socket->fd_ptr);
  97         assert(msg);
  98
  99         /* Consumer socket is invalid. Stopping. */
 100         fd = *socket->fd_ptr;
 101         if (fd < 0) {
 102                 goto error;
 103         }
 104
 105         size = lttcomm_recv_unix_sock(fd, msg, len);
 106         if (size <= 0) {
 107                 /* The above call will print a PERROR on error. */
 108                 DBG("Error when receiving data from the consumer socket %d", fd);
 109                 /*
 110                  * At this point, the socket is not usable anymore thus closing it and
 111                  * setting the file descriptor to -1 so it is not reused.
 112                  */
 113
 114                 /* This call will PERROR on error. */
 115                 (void) lttcomm_close_unix_sock(fd);
 116                 *socket->fd_ptr = -1;
 117                 goto error;
 118         }
 119
 120         return 0;
 121
 122 error:
 123         return -1;
 124 }
 125
 126 /*
 127  * Receive a reply command status message from the consumer. Consumer socket
 128  * lock MUST be acquired before calling this function.
 129  *
 130  * Return 0 on success, -1 on recv error or a negative lttng error code which
 131  * was possibly returned by the consumer.
 132  */
 133 int consumer_recv_status_reply(struct consumer_socket *sock)
 134 {
 135         int ret;
 136         struct lttcomm_consumer_status_msg reply;
 137
 138         assert(sock);
 139
 140         ret = consumer_socket_recv(sock, &reply, sizeof(reply));
 141         if (ret < 0) {
 142                 goto end;
 143         }
 144
 145         if (reply.ret_code == LTTCOMM_CONSUMERD_SUCCESS) {
 146                 /* All good. */
 147                 ret = 0;
 148         } else {
 149                 ret = -reply.ret_code;
 150                 DBG("Consumer ret code %d", ret);
 151         }
 152
 153 end:
 154         return ret;
 155 }
 156
 157 /*
 158  * Once the ASK_CHANNEL command is sent to the consumer, the channel
 159  * information are sent back. This call receives that data and populates key
 160  * and stream_count.
 161  *
 162  * On success return 0 and both key and stream_count are set. On error, a
 163  * negative value is sent back and both parameters are untouched.
 164  */
 165 int consumer_recv_status_channel(struct consumer_socket *sock,
 166                 uint64_t *key, unsigned int *stream_count)
 167 {
 168         int ret;
 169         struct lttcomm_consumer_status_channel reply;
 170
 171         assert(sock);
 172         assert(stream_count);
 173         assert(key);
 174
 175         ret = consumer_socket_recv(sock, &reply, sizeof(reply));
 176         if (ret < 0) {
 177                 goto end;
 178         }
 179
 180         /* An error is possible so don't touch the key and stream_count. */
 181         if (reply.ret_code != LTTCOMM_CONSUMERD_SUCCESS) {
 182                 ret = -1;
 183                 goto end;
 184         }
 185
 186         *key = reply.key;
 187         *stream_count = reply.stream_count;
 188         ret = 0;
 189
 190 end:
 191         return ret;
 192 }
 193
 194 /*
 195  * Send destroy relayd command to consumer.
 196  *
 197  * On success return positive value. On error, negative value.
 198  */
 199 int consumer_send_destroy_relayd(struct consumer_socket *sock,
 200                 struct consumer_output *consumer)
 201 {
 202         int ret;
 203         struct lttcomm_consumer_msg msg;
 204
 205         assert(consumer);
 206         assert(sock);
 207
 208         DBG2("Sending destroy relayd command to consumer sock %d", *sock->fd_ptr);
 209
 210         memset(&msg, 0, sizeof(msg));
 211         msg.cmd_type = LTTNG_CONSUMER_DESTROY_RELAYD;
 212         msg.u.destroy_relayd.net_seq_idx = consumer->net_seq_index;
 213
 214         pthread_mutex_lock(sock->lock);
 215         ret = consumer_socket_send(sock, &msg, sizeof(msg));
 216         if (ret < 0) {
 217                 goto error;
 218         }
 219
 220         /* Don't check the return value. The caller will do it. */
 221         ret = consumer_recv_status_reply(sock);
 222
 223         DBG2("Consumer send destroy relayd command done");
 224
 225 error:
 226         pthread_mutex_unlock(sock->lock);
 227         return ret;
 228 }
 229
 230 /*
 231  * For each consumer socket in the consumer output object, send a destroy
 232  * relayd command.
 233  */
 234 void consumer_output_send_destroy_relayd(struct consumer_output *consumer)
 235 {
 236         struct lttng_ht_iter iter;
 237         struct consumer_socket *socket;
 238
 239         assert(consumer);
 240
 241         /* Destroy any relayd connection */
 242         if (consumer->type == CONSUMER_DST_NET) {
 243                 rcu_read_lock();
 244                 cds_lfht_for_each_entry(consumer->socks->ht, &iter.iter, socket,
 245                                 node.node) {
 246                         int ret;
 247
 248                         /* Send destroy relayd command */
 249                         ret = consumer_send_destroy_relayd(socket, consumer);
 250                         if (ret < 0) {
 251                                 DBG("Unable to send destroy relayd command to consumer");
 252                                 /* Continue since we MUST delete everything at this point. */
 253                         }
 254                 }
 255                 rcu_read_unlock();
 256         }
 257 }
 258
 259 /*
 260  * From a consumer_data structure, allocate and add a consumer socket to the
 261  * consumer output.
 262  *
 263  * Return 0 on success, else negative value on error
 264  */
 265 int consumer_create_socket(struct consumer_data *data,
 266                 struct consumer_output *output)
 267 {
 268         int ret = 0;
 269         struct consumer_socket *socket;
 270
 271         assert(data);
 272
 273         if (output == NULL || data->cmd_sock < 0) {
 274                 /*
 275                  * Not an error. Possible there is simply not spawned consumer or it's
 276                  * disabled for the tracing session asking the socket.
 277                  */
 278                 goto error;
 279         }
 280
 281         rcu_read_lock();
 282         socket = consumer_find_socket(data->cmd_sock, output);
 283         rcu_read_unlock();
 284         if (socket == NULL) {
 285                 socket = consumer_allocate_socket(&data->cmd_sock);
 286                 if (socket == NULL) {
 287                         ret = -1;
 288                         goto error;
 289                 }
 290
 291                 socket->registered = 0;
 292                 socket->lock = &data->lock;
 293                 rcu_read_lock();
 294                 consumer_add_socket(socket, output);
 295                 rcu_read_unlock();
 296         }
 297
 298         socket->type = data->type;
 299
 300         DBG3("Consumer socket created (fd: %d) and added to output",
 301                         data->cmd_sock);
 302
 303 error:
 304         return ret;
 305 }
 306
 307 /*
 308  * Return the consumer socket from the given consumer output with the right
 309  * bitness. On error, returns NULL.
 310  *
 311  * The caller MUST acquire a rcu read side lock and keep it until the socket
 312  * object reference is not needed anymore.
 313  */
 314 struct consumer_socket *consumer_find_socket_by_bitness(int bits,
 315                 struct consumer_output *consumer)
 316 {
 317         int consumer_fd;
 318         struct consumer_socket *socket = NULL;
 319
 320         switch (bits) {
 321         case 64:
 322                 consumer_fd = uatomic_read(&ust_consumerd64_fd);
 323                 break;
 324         case 32:
 325                 consumer_fd = uatomic_read(&ust_consumerd32_fd);
 326                 break;
 327         default:
 328                 assert(0);
 329                 goto end;
 330         }
 331
 332         socket = consumer_find_socket(consumer_fd, consumer);
 333         if (!socket) {
 334                 ERR("Consumer socket fd %d not found in consumer obj %p",
 335                                 consumer_fd, consumer);
 336         }
 337
 338 end:
 339         return socket;
 340 }
 341
 342 /*
 343  * Find a consumer_socket in a consumer_output hashtable. Read side lock must
 344  * be acquired before calling this function and across use of the
 345  * returned consumer_socket.
 346  */
 347 struct consumer_socket *consumer_find_socket(int key,
 348                 struct consumer_output *consumer)
 349 {
 350         struct lttng_ht_iter iter;
 351         struct lttng_ht_node_ulong *node;
 352         struct consumer_socket *socket = NULL;
 353
 354         /* Negative keys are lookup failures */
 355         if (key < 0 || consumer == NULL) {
 356                 return NULL;
 357         }
 358
 359         lttng_ht_lookup(consumer->socks, (void *)((unsigned long) key),
 360                         &iter);
 361         node = lttng_ht_iter_get_node_ulong(&iter);
 362         if (node != NULL) {
 363                 socket = caa_container_of(node, struct consumer_socket, node);
 364         }
 365
 366         return socket;
 367 }
 368
 369 /*
 370  * Allocate a new consumer_socket and return the pointer.
 371  */
 372 struct consumer_socket *consumer_allocate_socket(int *fd)
 373 {
 374         struct consumer_socket *socket = NULL;
 375
 376         assert(fd);
 377
 378         socket = zmalloc(sizeof(struct consumer_socket));
 379         if (socket == NULL) {
 380                 PERROR("zmalloc consumer socket");
 381                 goto error;
 382         }
 383
 384         socket->fd_ptr = fd;
 385         lttng_ht_node_init_ulong(&socket->node, *fd);
 386
 387 error:
 388         return socket;
 389 }
 390
 391 /*
 392  * Add consumer socket to consumer output object. Read side lock must be
 393  * acquired before calling this function.
 394  */
 395 void consumer_add_socket(struct consumer_socket *sock,
 396                 struct consumer_output *consumer)
 397 {
 398         assert(sock);
 399         assert(consumer);
 400
 401         lttng_ht_add_unique_ulong(consumer->socks, &sock->node);
 402 }
 403
 404 /*
 405  * Delte consumer socket to consumer output object. Read side lock must be
 406  * acquired before calling this function.
 407  */
 408 void consumer_del_socket(struct consumer_socket *sock,
 409                 struct consumer_output *consumer)
 410 {
 411         int ret;
 412         struct lttng_ht_iter iter;
 413
 414         assert(sock);
 415         assert(consumer);
 416
 417         iter.iter.node = &sock->node.node;
 418         ret = lttng_ht_del(consumer->socks, &iter);
 419         assert(!ret);
 420 }
 421
 422 /*
 423  * RCU destroy call function.
 424  */
 425 static void destroy_socket_rcu(struct rcu_head *head)
 426 {
 427         struct lttng_ht_node_ulong *node =
 428                 caa_container_of(head, struct lttng_ht_node_ulong, head);
 429         struct consumer_socket *socket =
 430                 caa_container_of(node, struct consumer_socket, node);
 431
 432         free(socket);
 433 }
 434
 435 /*
 436  * Destroy and free socket pointer in a call RCU. Read side lock must be
 437  * acquired before calling this function.
 438  */
 439 void consumer_destroy_socket(struct consumer_socket *sock)
 440 {
 441         assert(sock);
 442
 443         /*
 444          * We DO NOT close the file descriptor here since it is global to the
 445          * session daemon and is closed only if the consumer dies or a custom
 446          * consumer was registered,
 447          */
 448         if (sock->registered) {
 449                 DBG3("Consumer socket was registered. Closing fd %d", *sock->fd_ptr);
 450                 lttcomm_close_unix_sock(*sock->fd_ptr);
 451         }
 452
 453         call_rcu(&sock->node.head, destroy_socket_rcu);
 454 }
 455
 456 /*
 457  * Allocate and assign data to a consumer_output object.
 458  *
 459  * Return pointer to structure.
 460  */
 461 struct consumer_output *consumer_create_output(enum consumer_dst_type type)
 462 {
 463         struct consumer_output *output = NULL;
 464
 465         output = zmalloc(sizeof(struct consumer_output));
 466         if (output == NULL) {
 467                 PERROR("zmalloc consumer_output");
 468                 goto error;
 469         }
 470
 471         /* By default, consumer output is enabled */
 472         output->enabled = 1;
 473         output->type = type;
 474         output->net_seq_index = (uint64_t) -1ULL;
 475         urcu_ref_init(&output->ref);
 476
 477         output->socks = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
 478
 479 error:
 480         return output;
 481 }
 482
 483 /*
 484  * Iterate over the consumer output socket hash table and destroy them. The
 485  * socket file descriptor are only closed if the consumer output was
 486  * registered meaning it's an external consumer.
 487  */
 488 void consumer_destroy_output_sockets(struct consumer_output *obj)
 489 {
 490         struct lttng_ht_iter iter;
 491         struct consumer_socket *socket;
 492
 493         if (!obj->socks) {
 494                 return;
 495         }
 496
 497         rcu_read_lock();
 498         cds_lfht_for_each_entry(obj->socks->ht, &iter.iter, socket, node.node) {
 499                 consumer_del_socket(socket, obj);
 500                 consumer_destroy_socket(socket);
 501         }
 502         rcu_read_unlock();
 503 }
 504
 505 /*
 506  * Delete the consumer_output object from the list and free the ptr.
 507  *
 508  * Should *NOT* be called with RCU read-side lock held.
 509  */
 510 static void consumer_release_output(struct urcu_ref *ref)
 511 {
 512         struct consumer_output *obj =
 513                 caa_container_of(ref, struct consumer_output, ref);
 514
 515         consumer_destroy_output_sockets(obj);
 516
 517         if (obj->socks) {
 518                 /* Finally destroy HT */
 519                 ht_cleanup_push(obj->socks);
 520         }
 521
 522         free(obj);
 523 }
 524
 525 /*
 526  * Get the consumer_output object.
 527  */
 528 void consumer_output_get(struct consumer_output *obj)
 529 {
 530         urcu_ref_get(&obj->ref);
 531 }
 532
 533 /*
 534  * Put the consumer_output object.
 535  *
 536  * Should *NOT* be called with RCU read-side lock held.
 537  */
 538 void consumer_output_put(struct consumer_output *obj)
 539 {
 540         if (!obj) {
 541                 return;
 542         }
 543         urcu_ref_put(&obj->ref, consumer_release_output);
 544 }
 545
 546 /*
 547  * Copy consumer output and returned the newly allocated copy.
 548  *
 549  * Should *NOT* be called with RCU read-side lock held.
 550  */
 551 struct consumer_output *consumer_copy_output(struct consumer_output *obj)
 552 {
 553         int ret;
 554         struct consumer_output *output;
 555
 556         assert(obj);
 557
 558         output = consumer_create_output(obj->type);
 559         if (output == NULL) {
 560                 goto end;
 561         }
 562         output->enabled = obj->enabled;
 563         output->net_seq_index = obj->net_seq_index;
 564         memcpy(output->subdir, obj->subdir, sizeof(output->subdir));
 565         output->snapshot = obj->snapshot;
 566         output->relay_major_version = obj->relay_major_version;
 567         output->relay_minor_version = obj->relay_minor_version;
 568         memcpy(&output->dst, &obj->dst, sizeof(output->dst));
 569         ret = consumer_copy_sockets(output, obj);
 570         if (ret < 0) {
 571                 goto error_put;
 572         }
 573 end:
 574         return output;
 575
 576 error_put:
 577         consumer_output_put(output);
 578         return NULL;
 579 }
 580
 581 /*
 582  * Copy consumer sockets from src to dst.
 583  *
 584  * Return 0 on success or else a negative value.
 585  */
 586 int consumer_copy_sockets(struct consumer_output *dst,
 587                 struct consumer_output *src)
 588 {
 589         int ret = 0;
 590         struct lttng_ht_iter iter;
 591         struct consumer_socket *socket, *copy_sock;
 592
 593         assert(dst);
 594         assert(src);
 595
 596         rcu_read_lock();
 597         cds_lfht_for_each_entry(src->socks->ht, &iter.iter, socket, node.node) {
 598                 /* Ignore socket that are already there. */
 599                 copy_sock = consumer_find_socket(*socket->fd_ptr, dst);
 600                 if (copy_sock) {
 601                         continue;
 602                 }
 603
 604                 /* Create new socket object. */
 605                 copy_sock = consumer_allocate_socket(socket->fd_ptr);
 606                 if (copy_sock == NULL) {
 607                         rcu_read_unlock();
 608                         ret = -ENOMEM;
 609                         goto error;
 610                 }
 611
 612                 copy_sock->registered = socket->registered;
 613                 /*
 614                  * This is valid because this lock is shared accross all consumer
 615                  * object being the global lock of the consumer data structure of the
 616                  * session daemon.
 617                  */
 618                 copy_sock->lock = socket->lock;
 619                 consumer_add_socket(copy_sock, dst);
 620         }
 621         rcu_read_unlock();
 622
 623 error:
 624         return ret;
 625 }
 626
 627 /*
 628  * Set network URI to the consumer output object.
 629  *
 630  * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
 631  * error.
 632  */
 633 int consumer_set_network_uri(struct consumer_output *obj,
 634                 struct lttng_uri *uri)
 635 {
 636         int ret;
 637         char tmp_path[PATH_MAX];
 638         char hostname[HOST_NAME_MAX];
 639         struct lttng_uri *dst_uri = NULL;
 640
 641         /* Code flow error safety net. */
 642         assert(obj);
 643         assert(uri);
 644
 645         switch (uri->stype) {
 646         case LTTNG_STREAM_CONTROL:
 647                 dst_uri = &obj->dst.net.control;
 648                 obj->dst.net.control_isset = 1;
 649                 if (uri->port == 0) {
 650                         /* Assign default port. */
 651                         uri->port = DEFAULT_NETWORK_CONTROL_PORT;
 652                 } else {
 653                         if (obj->dst.net.data_isset && uri->port ==
 654                                         obj->dst.net.data.port) {
 655                                 ret = -LTTNG_ERR_INVALID;
 656                                 goto error;
 657                         }
 658                 }
 659                 DBG3("Consumer control URI set with port %d", uri->port);
 660                 break;
 661         case LTTNG_STREAM_DATA:
 662                 dst_uri = &obj->dst.net.data;
 663                 obj->dst.net.data_isset = 1;
 664                 if (uri->port == 0) {
 665                         /* Assign default port. */
 666                         uri->port = DEFAULT_NETWORK_DATA_PORT;
 667                 } else {
 668                         if (obj->dst.net.control_isset && uri->port ==
 669                                         obj->dst.net.control.port) {
 670                                 ret = -LTTNG_ERR_INVALID;
 671                                 goto error;
 672                         }
 673                 }
 674                 DBG3("Consumer data URI set with port %d", uri->port);
 675                 break;
 676         default:
 677                 ERR("Set network uri type unknown %d", uri->stype);
 678                 ret = -LTTNG_ERR_INVALID;
 679                 goto error;
 680         }
 681
 682         ret = uri_compare(dst_uri, uri);
 683         if (!ret) {
 684                 /* Same URI, don't touch it and return success. */
 685                 DBG3("URI network compare are the same");
 686                 goto equal;
 687         }
 688
 689         /* URIs were not equal, replacing it. */
 690         memset(dst_uri, 0, sizeof(struct lttng_uri));
 691         memcpy(dst_uri, uri, sizeof(struct lttng_uri));
 692         obj->type = CONSUMER_DST_NET;
 693
 694         /* Handle subdir and add hostname in front. */
 695         if (dst_uri->stype == LTTNG_STREAM_CONTROL) {
 696                 /* Get hostname to append it in the pathname */
 697                 ret = gethostname(hostname, sizeof(hostname));
 698                 if (ret < 0) {
 699                         PERROR("gethostname. Fallback on default localhost");
 700                         strncpy(hostname, "localhost", sizeof(hostname));
 701                 }
 702                 hostname[sizeof(hostname) - 1] = '\0';
 703
 704                 /* Setup consumer subdir if none present in the control URI */
 705                 if (strlen(dst_uri->subdir) == 0) {
 706                         ret = snprintf(tmp_path, sizeof(tmp_path), "%s/%s",
 707                                         hostname, obj->subdir);
 708                 } else {
 709                         ret = snprintf(tmp_path, sizeof(tmp_path), "%s/%s",
 710                                         hostname, dst_uri->subdir);
 711                 }
 712                 if (ret < 0) {
 713                         PERROR("snprintf set consumer uri subdir");
 714                         ret = -LTTNG_ERR_NOMEM;
 715                         goto error;
 716                 }
 717
 718                 if (lttng_strncpy(obj->dst.net.base_dir, tmp_path,
 719                                 sizeof(obj->dst.net.base_dir))) {
 720                         ret = -LTTNG_ERR_INVALID;
 721                         goto error;
 722                 }
 723                 DBG3("Consumer set network uri base_dir path %s", tmp_path);
 724         }
 725
 726         return 0;
 727 equal:
 728         return 1;
 729 error:
 730         return ret;
 731 }
 732
 733 /*
 734  * Send file descriptor to consumer via sock.
 735  *
 736  * The consumer socket lock must be held by the caller.
 737  */
 738 int consumer_send_fds(struct consumer_socket *sock, const int *fds,
 739                 size_t nb_fd)
 740 {
 741         int ret;
 742
 743         assert(fds);
 744         assert(sock);
 745         assert(nb_fd > 0);
 746         assert(pthread_mutex_trylock(sock->lock) == EBUSY);
 747
 748         ret = lttcomm_send_fds_unix_sock(*sock->fd_ptr, fds, nb_fd);
 749         if (ret < 0) {
 750                 /* The above call will print a PERROR on error. */
 751                 DBG("Error when sending consumer fds on sock %d", *sock->fd_ptr);
 752                 goto error;
 753         }
 754
 755         ret = consumer_recv_status_reply(sock);
 756 error:
 757         return ret;
 758 }
 759
 760 /*
 761  * Consumer send communication message structure to consumer.
 762  *
 763  * The consumer socket lock must be held by the caller.
 764  */
 765 int consumer_send_msg(struct consumer_socket *sock,
 766                 struct lttcomm_consumer_msg *msg)
 767 {
 768         int ret;
 769
 770         assert(msg);
 771         assert(sock);
 772         assert(pthread_mutex_trylock(sock->lock) == EBUSY);
 773
 774         ret = consumer_socket_send(sock, msg, sizeof(struct lttcomm_consumer_msg));
 775         if (ret < 0) {
 776                 goto error;
 777         }
 778
 779         ret = consumer_recv_status_reply(sock);
 780
 781 error:
 782         return ret;
 783 }
 784
 785 /*
 786  * Consumer send channel communication message structure to consumer.
 787  *
 788  * The consumer socket lock must be held by the caller.
 789  */
 790 int consumer_send_channel(struct consumer_socket *sock,
 791                 struct lttcomm_consumer_msg *msg)
 792 {
 793         int ret;
 794
 795         assert(msg);
 796         assert(sock);
 797
 798         ret = consumer_send_msg(sock, msg);
 799         if (ret < 0) {
 800                 goto error;
 801         }
 802
 803 error:
 804         return ret;
 805 }
 806
 807 /*
 808  * Populate the given consumer msg structure with the ask_channel command
 809  * information.
 810  */
 811 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 812                 uint64_t subbuf_size,
 813                 uint64_t num_subbuf,
 814                 int overwrite,
 815                 unsigned int switch_timer_interval,
 816                 unsigned int read_timer_interval,
 817                 unsigned int live_timer_interval,
 818                 unsigned int monitor_timer_interval,
 819                 int output,
 820                 int type,
 821                 uint64_t session_id,
 822                 const char *pathname,
 823                 const char *name,
 824                 uid_t uid,
 825                 gid_t gid,
 826                 uint64_t relayd_id,
 827                 uint64_t key,
 828                 unsigned char *uuid,
 829                 uint32_t chan_id,
 830                 uint64_t tracefile_size,
 831                 uint64_t tracefile_count,
 832                 uint64_t session_id_per_pid,
 833                 unsigned int monitor,
 834                 uint32_t ust_app_uid,
 835                 int64_t blocking_timeout,
 836                 const char *root_shm_path,
 837                 const char *shm_path,
 838                 uint64_t trace_archive_id)
 839 {
 840         assert(msg);
 841
 842         /* Zeroed structure */
 843         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 844
 845         msg->cmd_type = LTTNG_CONSUMER_ASK_CHANNEL_CREATION;
 846         msg->u.ask_channel.subbuf_size = subbuf_size;
 847         msg->u.ask_channel.num_subbuf = num_subbuf ;
 848         msg->u.ask_channel.overwrite = overwrite;
 849         msg->u.ask_channel.switch_timer_interval = switch_timer_interval;
 850         msg->u.ask_channel.read_timer_interval = read_timer_interval;
 851         msg->u.ask_channel.live_timer_interval = live_timer_interval;
 852         msg->u.ask_channel.monitor_timer_interval = monitor_timer_interval;
 853         msg->u.ask_channel.output = output;
 854         msg->u.ask_channel.type = type;
 855         msg->u.ask_channel.session_id = session_id;
 856         msg->u.ask_channel.session_id_per_pid = session_id_per_pid;
 857         msg->u.ask_channel.uid = uid;
 858         msg->u.ask_channel.gid = gid;
 859         msg->u.ask_channel.relayd_id = relayd_id;
 860         msg->u.ask_channel.key = key;
 861         msg->u.ask_channel.chan_id = chan_id;
 862         msg->u.ask_channel.tracefile_size = tracefile_size;
 863         msg->u.ask_channel.tracefile_count = tracefile_count;
 864         msg->u.ask_channel.monitor = monitor;
 865         msg->u.ask_channel.ust_app_uid = ust_app_uid;
 866         msg->u.ask_channel.blocking_timeout = blocking_timeout;
 867         msg->u.ask_channel.trace_archive_id = trace_archive_id;
 868
 869         memcpy(msg->u.ask_channel.uuid, uuid, sizeof(msg->u.ask_channel.uuid));
 870
 871         if (pathname) {
 872                 strncpy(msg->u.ask_channel.pathname, pathname,
 873                                 sizeof(msg->u.ask_channel.pathname));
 874                 msg->u.ask_channel.pathname[sizeof(msg->u.ask_channel.pathname)-1] = '\0';
 875         }
 876
 877         strncpy(msg->u.ask_channel.name, name, sizeof(msg->u.ask_channel.name));
 878         msg->u.ask_channel.name[sizeof(msg->u.ask_channel.name) - 1] = '\0';
 879
 880         if (root_shm_path) {
 881                 strncpy(msg->u.ask_channel.root_shm_path, root_shm_path,
 882                         sizeof(msg->u.ask_channel.root_shm_path));
 883                 msg->u.ask_channel.root_shm_path[sizeof(msg->u.ask_channel.root_shm_path) - 1] = '\0';
 884         }
 885         if (shm_path) {
 886                 strncpy(msg->u.ask_channel.shm_path, shm_path,
 887                         sizeof(msg->u.ask_channel.shm_path));
 888                 msg->u.ask_channel.shm_path[sizeof(msg->u.ask_channel.shm_path) - 1] = '\0';
 889         }
 890 }
 891
 892 /*
 893  * Init channel communication message structure.
 894  */
 895 void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 896                 uint64_t channel_key,
 897                 uint64_t session_id,
 898                 const char *pathname,
 899                 uid_t uid,
 900                 gid_t gid,
 901                 uint64_t relayd_id,
 902                 const char *name,
 903                 unsigned int nb_init_streams,
 904                 enum lttng_event_output output,
 905                 int type,
 906                 uint64_t tracefile_size,
 907                 uint64_t tracefile_count,
 908                 unsigned int monitor,
 909                 unsigned int live_timer_interval,
 910                 unsigned int monitor_timer_interval)
 911 {
 912         assert(msg);
 913
 914         /* Zeroed structure */
 915         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 916
 917         /* Send channel */
 918         msg->cmd_type = LTTNG_CONSUMER_ADD_CHANNEL;
 919         msg->u.channel.channel_key = channel_key;
 920         msg->u.channel.session_id = session_id;
 921         msg->u.channel.uid = uid;
 922         msg->u.channel.gid = gid;
 923         msg->u.channel.relayd_id = relayd_id;
 924         msg->u.channel.nb_init_streams = nb_init_streams;
 925         msg->u.channel.output = output;
 926         msg->u.channel.type = type;
 927         msg->u.channel.tracefile_size = tracefile_size;
 928         msg->u.channel.tracefile_count = tracefile_count;
 929         msg->u.channel.monitor = monitor;
 930         msg->u.channel.live_timer_interval = live_timer_interval;
 931         msg->u.channel.monitor_timer_interval = monitor_timer_interval;
 932
 933         strncpy(msg->u.channel.pathname, pathname,
 934                         sizeof(msg->u.channel.pathname));
 935         msg->u.channel.pathname[sizeof(msg->u.channel.pathname) - 1] = '\0';
 936
 937         strncpy(msg->u.channel.name, name, sizeof(msg->u.channel.name));
 938         msg->u.channel.name[sizeof(msg->u.channel.name) - 1] = '\0';
 939 }
 940
 941 /*
 942  * Init stream communication message structure.
 943  */
 944 void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg *msg,
 945                 uint64_t channel_key,
 946                 uint64_t stream_key,
 947                 int32_t cpu,
 948                 uint64_t trace_archive_id)
 949 {
 950         assert(msg);
 951
 952         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 953
 954         msg->cmd_type = LTTNG_CONSUMER_ADD_STREAM;
 955         msg->u.stream.channel_key = channel_key;
 956         msg->u.stream.stream_key = stream_key;
 957         msg->u.stream.cpu = cpu;
 958         msg->u.stream.trace_archive_id = trace_archive_id;
 959 }
 960
 961 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg,
 962                 enum lttng_consumer_command cmd,
 963                 uint64_t channel_key, uint64_t net_seq_idx)
 964 {
 965         assert(msg);
 966
 967         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 968
 969         msg->cmd_type = cmd;
 970         msg->u.sent_streams.channel_key = channel_key;
 971         msg->u.sent_streams.net_seq_idx = net_seq_idx;
 972 }
 973
 974 /*
 975  * Send stream communication structure to the consumer.
 976  */
 977 int consumer_send_stream(struct consumer_socket *sock,
 978                 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
 979                 const int *fds, size_t nb_fd)
 980 {
 981         int ret;
 982
 983         assert(msg);
 984         assert(dst);
 985         assert(sock);
 986         assert(fds);
 987
 988         ret = consumer_send_msg(sock, msg);
 989         if (ret < 0) {
 990                 goto error;
 991         }
 992
 993         ret = consumer_send_fds(sock, fds, nb_fd);
 994         if (ret < 0) {
 995                 goto error;
 996         }
 997
 998 error:
 999         return ret;
1000 }
1001
1002 /*
1003  * Send relayd socket to consumer associated with a session name.
1004  *
1005  * The consumer socket lock must be held by the caller.
1006  *
1007  * On success return positive value. On error, negative value.
1008  */
1009 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
1010                 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
1011                 enum lttng_stream_type type, uint64_t session_id,
1012                 char *session_name, char *hostname, int session_live_timer)
1013 {
1014         int ret;
1015         struct lttcomm_consumer_msg msg;
1016
1017         /* Code flow error. Safety net. */
1018         assert(rsock);
1019         assert(consumer);
1020         assert(consumer_sock);
1021
1022         memset(&msg, 0, sizeof(msg));
1023         /* Bail out if consumer is disabled */
1024         if (!consumer->enabled) {
1025                 ret = LTTNG_OK;
1026                 goto error;
1027         }
1028
1029         if (type == LTTNG_STREAM_CONTROL) {
1030                 ret = relayd_create_session(rsock,
1031                                 &msg.u.relayd_sock.relayd_session_id,
1032                                 session_name, hostname, session_live_timer,
1033                                 consumer->snapshot);
1034                 if (ret < 0) {
1035                         /* Close the control socket. */
1036                         (void) relayd_close(rsock);
1037                         goto error;
1038                 }
1039         }
1040
1041         msg.cmd_type = LTTNG_CONSUMER_ADD_RELAYD_SOCKET;
1042         /*
1043          * Assign network consumer output index using the temporary consumer since
1044          * this call should only be made from within a set_consumer_uri() function
1045          * call in the session daemon.
1046          */
1047         msg.u.relayd_sock.net_index = consumer->net_seq_index;
1048         msg.u.relayd_sock.type = type;
1049         msg.u.relayd_sock.session_id = session_id;
1050         memcpy(&msg.u.relayd_sock.sock, rsock, sizeof(msg.u.relayd_sock.sock));
1051
1052         DBG3("Sending relayd sock info to consumer on %d", *consumer_sock->fd_ptr);
1053         ret = consumer_send_msg(consumer_sock, &msg);
1054         if (ret < 0) {
1055                 goto error;
1056         }
1057
1058         DBG3("Sending relayd socket file descriptor to consumer");
1059         ret = consumer_send_fds(consumer_sock, &rsock->sock.fd, 1);
1060         if (ret < 0) {
1061                 goto error;
1062         }
1063
1064         DBG2("Consumer relayd socket sent");
1065
1066 error:
1067         return ret;
1068 }
1069
1070 static
1071 int consumer_send_pipe(struct consumer_socket *consumer_sock,
1072                 enum lttng_consumer_command cmd, int pipe)
1073 {
1074         int ret;
1075         struct lttcomm_consumer_msg msg;
1076         const char *pipe_name;
1077         const char *command_name;
1078
1079         switch (cmd) {
1080         case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE:
1081                 pipe_name = "channel monitor";
1082                 command_name = "SET_CHANNEL_MONITOR_PIPE";
1083                 break;
1084         case LTTNG_CONSUMER_SET_CHANNEL_ROTATE_PIPE:
1085                 pipe_name = "channel rotate";
1086                 command_name = "SET_CHANNEL_ROTATE_PIPE";
1087                 break;
1088         default:
1089                 ERR("Unexpected command received in %s (cmd = %d)", __func__,
1090                                 (int) cmd);
1091                 abort();
1092         }
1093
1094         /* Code flow error. Safety net. */
1095
1096         memset(&msg, 0, sizeof(msg));
1097         msg.cmd_type = cmd;
1098
1099         pthread_mutex_lock(consumer_sock->lock);
1100         DBG3("Sending %s command to consumer", command_name);
1101         ret = consumer_send_msg(consumer_sock, &msg);
1102         if (ret < 0) {
1103                 goto error;
1104         }
1105
1106         DBG3("Sending %s pipe %d to consumer on socket %d",
1107                         pipe_name,
1108                         pipe, *consumer_sock->fd_ptr);
1109         ret = consumer_send_fds(consumer_sock, &pipe, 1);
1110         if (ret < 0) {
1111                 goto error;
1112         }
1113
1114         DBG2("%s pipe successfully sent", pipe_name);
1115 error:
1116         pthread_mutex_unlock(consumer_sock->lock);
1117         return ret;
1118 }
1119
1120 int consumer_send_channel_monitor_pipe(struct consumer_socket *consumer_sock,
1121                 int pipe)
1122 {
1123         return consumer_send_pipe(consumer_sock,
1124                         LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE, pipe);
1125 }
1126
1127 int consumer_send_channel_rotate_pipe(struct consumer_socket *consumer_sock,
1128                 int pipe)
1129 {
1130         return consumer_send_pipe(consumer_sock,
1131                         LTTNG_CONSUMER_SET_CHANNEL_ROTATE_PIPE, pipe);
1132 }
1133
1134 /*
1135  * Set consumer subdirectory using the session name and a generated datetime if
1136  * needed. This is appended to the current subdirectory.
1137  */
1138 int consumer_set_subdir(struct consumer_output *consumer,
1139                 const char *session_name)
1140 {
1141         int ret = 0;
1142         unsigned int have_default_name = 0;
1143         char datetime[16], tmp_path[PATH_MAX];
1144         time_t rawtime;
1145         struct tm *timeinfo;
1146
1147         assert(consumer);
1148         assert(session_name);
1149
1150         memset(tmp_path, 0, sizeof(tmp_path));
1151
1152         /* Flag if we have a default session. */
1153         if (strncmp(session_name, DEFAULT_SESSION_NAME "-",
1154                                 strlen(DEFAULT_SESSION_NAME) + 1) == 0) {
1155                 have_default_name = 1;
1156         } else {
1157                 /* Get date and time for session path */
1158                 time(&rawtime);
1159                 timeinfo = localtime(&rawtime);
1160                 strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
1161         }
1162
1163         if (have_default_name) {
1164                 ret = snprintf(tmp_path, sizeof(tmp_path),
1165                                 "%s/%s", consumer->subdir, session_name);
1166         } else {
1167                 ret = snprintf(tmp_path, sizeof(tmp_path),
1168                                 "%s/%s-%s/", consumer->subdir, session_name, datetime);
1169         }
1170         if (ret < 0) {
1171                 PERROR("snprintf session name date");
1172                 goto error;
1173         }
1174
1175         if (lttng_strncpy(consumer->subdir, tmp_path,
1176                         sizeof(consumer->subdir))) {
1177                 ret = -EINVAL;
1178                 goto error;
1179         }
1180         DBG2("Consumer subdir set to %s", consumer->subdir);
1181
1182 error:
1183         return ret;
1184 }
1185
1186 /*
1187  * Ask the consumer if the data is pending for the specific session id.
1188  * Returns 1 if data is pending, 0 otherwise, or < 0 on error.
1189  */
1190 int consumer_is_data_pending(uint64_t session_id,
1191                 struct consumer_output *consumer)
1192 {
1193         int ret;
1194         int32_t ret_code = 0;  /* Default is that the data is NOT pending */
1195         struct consumer_socket *socket;
1196         struct lttng_ht_iter iter;
1197         struct lttcomm_consumer_msg msg;
1198
1199         assert(consumer);
1200
1201         DBG3("Consumer data pending for id %" PRIu64, session_id);
1202
1203         memset(&msg, 0, sizeof(msg));
1204         msg.cmd_type = LTTNG_CONSUMER_DATA_PENDING;
1205         msg.u.data_pending.session_id = session_id;
1206
1207         /* Send command for each consumer */
1208         rcu_read_lock();
1209         cds_lfht_for_each_entry(consumer->socks->ht, &iter.iter, socket,
1210                         node.node) {
1211                 pthread_mutex_lock(socket->lock);
1212                 ret = consumer_socket_send(socket, &msg, sizeof(msg));
1213                 if (ret < 0) {
1214                         pthread_mutex_unlock(socket->lock);
1215                         goto error_unlock;
1216                 }
1217
1218                 /*
1219                  * No need for a recv reply status because the answer to the command is
1220                  * the reply status message.
1221                  */
1222
1223                 ret = consumer_socket_recv(socket, &ret_code, sizeof(ret_code));
1224                 if (ret < 0) {
1225                         pthread_mutex_unlock(socket->lock);
1226                         goto error_unlock;
1227                 }
1228                 pthread_mutex_unlock(socket->lock);
1229
1230                 if (ret_code == 1) {
1231                         break;
1232                 }
1233         }
1234         rcu_read_unlock();
1235
1236         DBG("Consumer data is %s pending for session id %" PRIu64,
1237                         ret_code == 1 ? "" : "NOT", session_id);
1238         return ret_code;
1239
1240 error_unlock:
1241         rcu_read_unlock();
1242         return -1;
1243 }
1244
1245 /*
1246  * Send a flush command to consumer using the given channel key.
1247  *
1248  * Return 0 on success else a negative value.
1249  */
1250 int consumer_flush_channel(struct consumer_socket *socket, uint64_t key)
1251 {
1252         int ret;
1253         struct lttcomm_consumer_msg msg;
1254
1255         assert(socket);
1256
1257         DBG2("Consumer flush channel key %" PRIu64, key);
1258
1259         memset(&msg, 0, sizeof(msg));
1260         msg.cmd_type = LTTNG_CONSUMER_FLUSH_CHANNEL;
1261         msg.u.flush_channel.key = key;
1262
1263         pthread_mutex_lock(socket->lock);
1264         health_code_update();
1265
1266         ret = consumer_send_msg(socket, &msg);
1267         if (ret < 0) {
1268                 goto end;
1269         }
1270
1271 end:
1272         health_code_update();
1273         pthread_mutex_unlock(socket->lock);
1274         return ret;
1275 }
1276
1277 /*
1278  * Send a clear quiescent command to consumer using the given channel key.
1279  *
1280  * Return 0 on success else a negative value.
1281  */
1282 int consumer_clear_quiescent_channel(struct consumer_socket *socket, uint64_t key)
1283 {
1284         int ret;
1285         struct lttcomm_consumer_msg msg;
1286
1287         assert(socket);
1288
1289         DBG2("Consumer clear quiescent channel key %" PRIu64, key);
1290
1291         memset(&msg, 0, sizeof(msg));
1292         msg.cmd_type = LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL;
1293         msg.u.clear_quiescent_channel.key = key;
1294
1295         pthread_mutex_lock(socket->lock);
1296         health_code_update();
1297
1298         ret = consumer_send_msg(socket, &msg);
1299         if (ret < 0) {
1300                 goto end;
1301         }
1302
1303 end:
1304         health_code_update();
1305         pthread_mutex_unlock(socket->lock);
1306         return ret;
1307 }
1308
1309 /*
1310  * Send a close metadata command to consumer using the given channel key.
1311  * Called with registry lock held.
1312  *
1313  * Return 0 on success else a negative value.
1314  */
1315 int consumer_close_metadata(struct consumer_socket *socket,
1316                 uint64_t metadata_key)
1317 {
1318         int ret;
1319         struct lttcomm_consumer_msg msg;
1320
1321         assert(socket);
1322
1323         DBG2("Consumer close metadata channel key %" PRIu64, metadata_key);
1324
1325         memset(&msg, 0, sizeof(msg));
1326         msg.cmd_type = LTTNG_CONSUMER_CLOSE_METADATA;
1327         msg.u.close_metadata.key = metadata_key;
1328
1329         pthread_mutex_lock(socket->lock);
1330         health_code_update();
1331
1332         ret = consumer_send_msg(socket, &msg);
1333         if (ret < 0) {
1334                 goto end;
1335         }
1336
1337 end:
1338         health_code_update();
1339         pthread_mutex_unlock(socket->lock);
1340         return ret;
1341 }
1342
1343 /*
1344  * Send a setup metdata command to consumer using the given channel key.
1345  *
1346  * Return 0 on success else a negative value.
1347  */
1348 int consumer_setup_metadata(struct consumer_socket *socket,
1349                 uint64_t metadata_key)
1350 {
1351         int ret;
1352         struct lttcomm_consumer_msg msg;
1353
1354         assert(socket);
1355
1356         DBG2("Consumer setup metadata channel key %" PRIu64, metadata_key);
1357
1358         memset(&msg, 0, sizeof(msg));
1359         msg.cmd_type = LTTNG_CONSUMER_SETUP_METADATA;
1360         msg.u.setup_metadata.key = metadata_key;
1361
1362         pthread_mutex_lock(socket->lock);
1363         health_code_update();
1364
1365         ret = consumer_send_msg(socket, &msg);
1366         if (ret < 0) {
1367                 goto end;
1368         }
1369
1370 end:
1371         health_code_update();
1372         pthread_mutex_unlock(socket->lock);
1373         return ret;
1374 }
1375
1376 /*
1377  * Send metadata string to consumer.
1378  * RCU read-side lock must be held to guarantee existence of socket.
1379  *
1380  * Return 0 on success else a negative value.
1381  */
1382 int consumer_push_metadata(struct consumer_socket *socket,
1383                 uint64_t metadata_key, char *metadata_str, size_t len,
1384                 size_t target_offset, uint64_t version)
1385 {
1386         int ret;
1387         struct lttcomm_consumer_msg msg;
1388
1389         assert(socket);
1390
1391         DBG2("Consumer push metadata to consumer socket %d", *socket->fd_ptr);
1392
1393         pthread_mutex_lock(socket->lock);
1394
1395         memset(&msg, 0, sizeof(msg));
1396         msg.cmd_type = LTTNG_CONSUMER_PUSH_METADATA;
1397         msg.u.push_metadata.key = metadata_key;
1398         msg.u.push_metadata.target_offset = target_offset;
1399         msg.u.push_metadata.len = len;
1400         msg.u.push_metadata.version = version;
1401
1402         health_code_update();
1403         ret = consumer_send_msg(socket, &msg);
1404         if (ret < 0 || len == 0) {
1405                 goto end;
1406         }
1407
1408         DBG3("Consumer pushing metadata on sock %d of len %zu", *socket->fd_ptr,
1409                         len);
1410
1411         ret = consumer_socket_send(socket, metadata_str, len);
1412         if (ret < 0) {
1413                 goto end;
1414         }
1415
1416         health_code_update();
1417         ret = consumer_recv_status_reply(socket);
1418         if (ret < 0) {
1419                 goto end;
1420         }
1421
1422 end:
1423         pthread_mutex_unlock(socket->lock);
1424         health_code_update();
1425         return ret;
1426 }
1427
1428 /*
1429  * Ask the consumer to snapshot a specific channel using the key.
1430  *
1431  * Return 0 on success or else a negative error.
1432  */
1433 int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key,
1434                 struct snapshot_output *output, int metadata, uid_t uid, gid_t gid,
1435                 const char *session_path, int wait, uint64_t nb_packets_per_stream,
1436                 uint64_t trace_archive_id)
1437 {
1438         int ret;
1439         struct lttcomm_consumer_msg msg;
1440
1441         assert(socket);
1442         assert(output);
1443         assert(output->consumer);
1444
1445         DBG("Consumer snapshot channel key %" PRIu64, key);
1446
1447         memset(&msg, 0, sizeof(msg));
1448         msg.cmd_type = LTTNG_CONSUMER_SNAPSHOT_CHANNEL;
1449         msg.u.snapshot_channel.key = key;
1450         msg.u.snapshot_channel.nb_packets_per_stream = nb_packets_per_stream;
1451         msg.u.snapshot_channel.metadata = metadata;
1452         msg.u.snapshot_channel.trace_archive_id = trace_archive_id;
1453
1454         if (output->consumer->type == CONSUMER_DST_NET) {
1455                 msg.u.snapshot_channel.relayd_id = output->consumer->net_seq_index;
1456                 msg.u.snapshot_channel.use_relayd = 1;
1457                 ret = snprintf(msg.u.snapshot_channel.pathname,
1458                                 sizeof(msg.u.snapshot_channel.pathname),
1459                                 "%s/%s/%s-%s-%" PRIu64 "%s",
1460                                 output->consumer->dst.net.base_dir,
1461                                 output->consumer->subdir,
1462                                 output->name, output->datetime,
1463                                 output->nb_snapshot,
1464                                 session_path);
1465                 if (ret < 0) {
1466                         ret = -LTTNG_ERR_NOMEM;
1467                         goto error;
1468                 } else if (ret >= sizeof(msg.u.snapshot_channel.pathname)) {
1469                         ERR("Snapshot path exceeds the maximal allowed length of %zu bytes (%i bytes required) with path \"%s/%s/%s-%s-%" PRIu64 "%s\"",
1470                                         sizeof(msg.u.snapshot_channel.pathname),
1471                                         ret, output->consumer->dst.net.base_dir,
1472                                         output->consumer->subdir,
1473                                         output->name, output->datetime,
1474                                         output->nb_snapshot,
1475                                         session_path);
1476                         ret = -LTTNG_ERR_SNAPSHOT_FAIL;
1477                         goto error;
1478                 }
1479         } else {
1480                 ret = snprintf(msg.u.snapshot_channel.pathname,
1481                                 sizeof(msg.u.snapshot_channel.pathname),
1482                                 "%s/%s-%s-%" PRIu64 "%s",
1483                                 output->consumer->dst.session_root_path,
1484                                 output->name, output->datetime,
1485                                 output->nb_snapshot,
1486                                 session_path);
1487                 if (ret < 0) {
1488                         ret = -LTTNG_ERR_NOMEM;
1489                         goto error;
1490                 } else if (ret >= sizeof(msg.u.snapshot_channel.pathname)) {
1491                         ERR("Snapshot path exceeds the maximal allowed length of %zu bytes (%i bytes required) with path \"%s/%s-%s-%" PRIu64 "%s\"",
1492                                         sizeof(msg.u.snapshot_channel.pathname),
1493                                         ret, output->consumer->dst.session_root_path,
1494                                         output->name, output->datetime, output->nb_snapshot,
1495                                         session_path);
1496                         ret = -LTTNG_ERR_SNAPSHOT_FAIL;
1497                         goto error;
1498                 }
1499
1500                 msg.u.snapshot_channel.relayd_id = (uint64_t) -1ULL;
1501
1502                 /* Create directory. Ignore if exist. */
1503                 ret = run_as_mkdir_recursive(msg.u.snapshot_channel.pathname,
1504                                 S_IRWXU | S_IRWXG, uid, gid);
1505                 if (ret < 0) {
1506                         if (errno != EEXIST) {
1507                                 ERR("Trace directory creation error");
1508                                 goto error;
1509                         }
1510                 }
1511         }
1512
1513         health_code_update();
1514         pthread_mutex_lock(socket->lock);
1515         ret = consumer_send_msg(socket, &msg);
1516         pthread_mutex_unlock(socket->lock);
1517         if (ret < 0) {
1518                 goto error;
1519         }
1520
1521 error:
1522         health_code_update();
1523         return ret;
1524 }
1525
1526 /*
1527  * Ask the consumer the number of discarded events for a channel.
1528  */
1529 int consumer_get_discarded_events(uint64_t session_id, uint64_t channel_key,
1530                 struct consumer_output *consumer, uint64_t *discarded)
1531 {
1532         int ret;
1533         struct consumer_socket *socket;
1534         struct lttng_ht_iter iter;
1535         struct lttcomm_consumer_msg msg;
1536
1537         assert(consumer);
1538
1539         DBG3("Consumer discarded events id %" PRIu64, session_id);
1540
1541         memset(&msg, 0, sizeof(msg));
1542         msg.cmd_type = LTTNG_CONSUMER_DISCARDED_EVENTS;
1543         msg.u.discarded_events.session_id = session_id;
1544         msg.u.discarded_events.channel_key = channel_key;
1545
1546         *discarded = 0;
1547
1548         /* Send command for each consumer */
1549         rcu_read_lock();
1550         cds_lfht_for_each_entry(consumer->socks->ht, &iter.iter, socket,
1551                         node.node) {
1552                 uint64_t consumer_discarded = 0;
1553                 pthread_mutex_lock(socket->lock);
1554                 ret = consumer_socket_send(socket, &msg, sizeof(msg));
1555                 if (ret < 0) {
1556                         pthread_mutex_unlock(socket->lock);
1557                         goto end;
1558                 }
1559
1560                 /*
1561                  * No need for a recv reply status because the answer to the
1562                  * command is the reply status message.
1563                  */
1564                 ret = consumer_socket_recv(socket, &consumer_discarded,
1565                                 sizeof(consumer_discarded));
1566                 if (ret < 0) {
1567                         ERR("get discarded events");
1568                         pthread_mutex_unlock(socket->lock);
1569                         goto end;
1570                 }
1571                 pthread_mutex_unlock(socket->lock);
1572                 *discarded += consumer_discarded;
1573         }
1574         ret = 0;
1575         DBG("Consumer discarded %" PRIu64 " events in session id %" PRIu64,
1576                         *discarded, session_id);
1577
1578 end:
1579         rcu_read_unlock();
1580         return ret;
1581 }
1582
1583 /*
1584  * Ask the consumer the number of lost packets for a channel.
1585  */
1586 int consumer_get_lost_packets(uint64_t session_id, uint64_t channel_key,
1587                 struct consumer_output *consumer, uint64_t *lost)
1588 {
1589         int ret;
1590         struct consumer_socket *socket;
1591         struct lttng_ht_iter iter;
1592         struct lttcomm_consumer_msg msg;
1593
1594         assert(consumer);
1595
1596         DBG3("Consumer lost packets id %" PRIu64, session_id);
1597
1598         memset(&msg, 0, sizeof(msg));
1599         msg.cmd_type = LTTNG_CONSUMER_LOST_PACKETS;
1600         msg.u.lost_packets.session_id = session_id;
1601         msg.u.lost_packets.channel_key = channel_key;
1602
1603         *lost = 0;
1604
1605         /* Send command for each consumer */
1606         rcu_read_lock();
1607         cds_lfht_for_each_entry(consumer->socks->ht, &iter.iter, socket,
1608                         node.node) {
1609                 uint64_t consumer_lost = 0;
1610                 pthread_mutex_lock(socket->lock);
1611                 ret = consumer_socket_send(socket, &msg, sizeof(msg));
1612                 if (ret < 0) {
1613                         pthread_mutex_unlock(socket->lock);
1614                         goto end;
1615                 }
1616
1617                 /*
1618                  * No need for a recv reply status because the answer to the
1619                  * command is the reply status message.
1620                  */
1621                 ret = consumer_socket_recv(socket, &consumer_lost,
1622                                 sizeof(consumer_lost));
1623                 if (ret < 0) {
1624                         ERR("get lost packets");
1625                         pthread_mutex_unlock(socket->lock);
1626                         goto end;
1627                 }
1628                 pthread_mutex_unlock(socket->lock);
1629                 *lost += consumer_lost;
1630         }
1631         ret = 0;
1632         DBG("Consumer lost %" PRIu64 " packets in session id %" PRIu64,
1633                         *lost, session_id);
1634
1635 end:
1636         rcu_read_unlock();
1637         return ret;
1638 }
1639
1640 /*
1641  * Ask the consumer to rotate a channel.
1642  * domain_path contains "/kernel" for kernel or the complete path for UST
1643  * (ex: /ust/uid/1000/64-bit);
1644  *
1645  * The new_chunk_id is the session->rotate_count that has been incremented
1646  * when the rotation started. On the relay, this allows to keep track in which
1647  * chunk each stream is currently writing to (for the rotate_pending operation).
1648  */
1649 int consumer_rotate_channel(struct consumer_socket *socket, uint64_t key,
1650                 uid_t uid, gid_t gid, struct consumer_output *output,
1651                 char *domain_path, bool is_metadata_channel,
1652                 uint64_t new_chunk_id,
1653                 bool *rotate_pending_relay)
1654 {
1655         int ret;
1656         struct lttcomm_consumer_msg msg;
1657
1658         assert(socket);
1659
1660         DBG("Consumer rotate channel key %" PRIu64, key);
1661
1662         pthread_mutex_lock(socket->lock);
1663         memset(&msg, 0, sizeof(msg));
1664         msg.cmd_type = LTTNG_CONSUMER_ROTATE_CHANNEL;
1665         msg.u.rotate_channel.key = key;
1666         msg.u.rotate_channel.metadata = !!is_metadata_channel;
1667         msg.u.rotate_channel.new_chunk_id = new_chunk_id;
1668
1669         if (output->type == CONSUMER_DST_NET) {
1670                 msg.u.rotate_channel.relayd_id = output->net_seq_index;
1671                 ret = snprintf(msg.u.rotate_channel.pathname,
1672                                 sizeof(msg.u.rotate_channel.pathname), "%s%s%s",
1673                                 output->dst.net.base_dir,
1674                                 output->chunk_path, domain_path);
1675                 if (ret < 0 || ret == sizeof(msg.u.rotate_channel.pathname)) {
1676                         ERR("Failed to format channel path name when asking consumer to rotate channel");
1677                         ret = -1;
1678                         goto error;
1679                 }
1680                 *rotate_pending_relay = true;
1681         } else {
1682                 msg.u.rotate_channel.relayd_id = (uint64_t) -1ULL;
1683                 ret = snprintf(msg.u.rotate_channel.pathname,
1684                                 sizeof(msg.u.rotate_channel.pathname), "%s%s%s",
1685                                 output->dst.session_root_path,
1686                                 output->chunk_path, domain_path);
1687                 if (ret < 0 || ret == sizeof(msg.u.rotate_channel.pathname)) {
1688                         ERR("Failed to format channel path name when asking consumer to rotate channel");
1689                         ret = -1;
1690                         goto error;
1691                 }
1692         }
1693
1694         health_code_update();
1695         ret = consumer_send_msg(socket, &msg);
1696         if (ret < 0) {
1697                 goto error;
1698         }
1699
1700 error:
1701         pthread_mutex_unlock(socket->lock);
1702         health_code_update();
1703         return ret;
1704 }
1705
1706 int consumer_rotate_rename(struct consumer_socket *socket, uint64_t session_id,
1707                 const struct consumer_output *output, const char *old_path,
1708                 const char *new_path, uid_t uid, gid_t gid)
1709 {
1710         int ret;
1711         struct lttcomm_consumer_msg msg;
1712         size_t old_path_length, new_path_length;
1713
1714         assert(socket);
1715         assert(old_path);
1716         assert(new_path);
1717
1718         DBG("Consumer rotate rename session %" PRIu64 ", old path = \"%s\", new_path = \"%s\"",
1719                         session_id, old_path, new_path);
1720
1721         old_path_length = strlen(old_path);
1722         if (old_path_length >= sizeof(msg.u.rotate_rename.old_path)) {
1723                 ERR("consumer_rotate_rename: old path length (%zu bytes) exceeds the maximal length allowed by the consumer protocol (%zu bytes)",
1724                                 old_path_length + 1, sizeof(msg.u.rotate_rename.old_path));
1725                 ret = -1;
1726                 goto error;
1727         }
1728
1729         new_path_length = strlen(new_path);
1730         if (new_path_length >= sizeof(msg.u.rotate_rename.new_path)) {
1731                 ERR("consumer_rotate_rename: new path length (%zu bytes) exceeds the maximal length allowed by the consumer protocol (%zu bytes)",
1732                                 new_path_length + 1, sizeof(msg.u.rotate_rename.new_path));
1733                 ret = -1;
1734                 goto error;
1735         }
1736
1737         memset(&msg, 0, sizeof(msg));
1738         msg.cmd_type = LTTNG_CONSUMER_ROTATE_RENAME;
1739         msg.u.rotate_rename.session_id = session_id;
1740         msg.u.rotate_rename.uid = uid;
1741         msg.u.rotate_rename.gid = gid;
1742         strcpy(msg.u.rotate_rename.old_path, old_path);
1743         strcpy(msg.u.rotate_rename.new_path, new_path);
1744
1745         if (output->type == CONSUMER_DST_NET) {
1746                 msg.u.rotate_rename.relayd_id = output->net_seq_index;
1747         } else {
1748                 msg.u.rotate_rename.relayd_id = -1ULL;
1749         }
1750
1751         health_code_update();
1752         ret = consumer_send_msg(socket, &msg);
1753         if (ret < 0) {
1754                 goto error;
1755         }
1756
1757 error:
1758         health_code_update();
1759         return ret;
1760 }
1761
1762 /*
1763  * Ask the relay if a rotation is still pending. Must be called with the socket
1764  * lock held.
1765  *
1766  * Return 1 if the rotation is still pending, 0 if finished, a negative value
1767  * on error.
1768  */
1769 int consumer_rotate_pending_relay(struct consumer_socket *socket,
1770                 struct consumer_output *output, uint64_t session_id,
1771                 uint64_t chunk_id)
1772 {
1773         int ret;
1774         struct lttcomm_consumer_msg msg;
1775         uint32_t pending = 0;
1776
1777         assert(socket);
1778
1779         DBG("Consumer rotate pending on relay for session %" PRIu64 ", chunk id %" PRIu64,
1780                         session_id, chunk_id);
1781         assert(output->type == CONSUMER_DST_NET);
1782
1783         memset(&msg, 0, sizeof(msg));
1784         msg.cmd_type = LTTNG_CONSUMER_ROTATE_PENDING_RELAY;
1785         msg.u.rotate_pending_relay.session_id = session_id;
1786         msg.u.rotate_pending_relay.relayd_id = output->net_seq_index;
1787         msg.u.rotate_pending_relay.chunk_id = chunk_id;
1788
1789         health_code_update();
1790         ret = consumer_send_msg(socket, &msg);
1791         if (ret < 0) {
1792                 goto error;
1793         }
1794
1795         ret = consumer_socket_recv(socket, &pending, sizeof(pending));
1796         if (ret < 0) {
1797                 goto error;
1798         }
1799
1800         ret = pending;
1801
1802 error:
1803         health_code_update();
1804         return ret;
1805 }
1806
1807 /*
1808  * Ask the consumer to create a directory.
1809  *
1810  * Called with the consumer socket lock held.
1811  */
1812 int consumer_mkdir(struct consumer_socket *socket, uint64_t session_id,
1813                 const struct consumer_output *output, const char *path,
1814                 uid_t uid, gid_t gid)
1815 {
1816         int ret;
1817         struct lttcomm_consumer_msg msg;
1818
1819         assert(socket);
1820
1821         DBG("Consumer mkdir %s in session %" PRIu64, path, session_id);
1822
1823         memset(&msg, 0, sizeof(msg));
1824         msg.cmd_type = LTTNG_CONSUMER_MKDIR;
1825         msg.u.mkdir.session_id = session_id;
1826         msg.u.mkdir.uid = uid;
1827         msg.u.mkdir.gid = gid;
1828         ret = snprintf(msg.u.mkdir.path, sizeof(msg.u.mkdir.path), "%s", path);
1829         if (ret < 0 || ret >= sizeof(msg.u.mkdir.path)) {
1830                 ERR("Format path");
1831                 ret = -1;
1832                 goto error;
1833         }
1834
1835         if (output->type == CONSUMER_DST_NET) {
1836                 msg.u.mkdir.relayd_id = output->net_seq_index;
1837         } else {
1838                 msg.u.mkdir.relayd_id = -1ULL;
1839         }
1840
1841         health_code_update();
1842         ret = consumer_send_msg(socket, &msg);
1843         if (ret < 0) {
1844                 goto error;
1845         }
1846
1847 error:
1848         health_code_update();
1849         return ret;
1850 }