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 _GNU_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
 476         output->socks = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
 477
 478 error:
 479         return output;
 480 }
 481
 482 /*
 483  * Iterate over the consumer output socket hash table and destroy them. The
 484  * socket file descriptor are only closed if the consumer output was
 485  * registered meaning it's an external consumer.
 486  */
 487 void consumer_destroy_output_sockets(struct consumer_output *obj)
 488 {
 489         struct lttng_ht_iter iter;
 490         struct consumer_socket *socket;
 491
 492         if (!obj->socks) {
 493                 return;
 494         }
 495
 496         rcu_read_lock();
 497         cds_lfht_for_each_entry(obj->socks->ht, &iter.iter, socket, node.node) {
 498                 consumer_del_socket(socket, obj);
 499                 consumer_destroy_socket(socket);
 500         }
 501         rcu_read_unlock();
 502 }
 503
 504 /*
 505  * Delete the consumer_output object from the list and free the ptr.
 506  *
 507  * Should *NOT* be called with RCU read-side lock held.
 508  */
 509 void consumer_destroy_output(struct consumer_output *obj)
 510 {
 511         if (obj == NULL) {
 512                 return;
 513         }
 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  * Copy consumer output and returned the newly allocated copy.
 527  *
 528  * Should *NOT* be called with RCU read-side lock held.
 529  */
 530 struct consumer_output *consumer_copy_output(struct consumer_output *obj)
 531 {
 532         int ret;
 533         struct lttng_ht *tmp_ht_ptr;
 534         struct consumer_output *output;
 535
 536         assert(obj);
 537
 538         output = consumer_create_output(obj->type);
 539         if (output == NULL) {
 540                 goto error;
 541         }
 542         /* Avoid losing the HT reference after the memcpy() */
 543         tmp_ht_ptr = output->socks;
 544
 545         memcpy(output, obj, sizeof(struct consumer_output));
 546
 547         /* Putting back the HT pointer and start copying socket(s). */
 548         output->socks = tmp_ht_ptr;
 549
 550         ret = consumer_copy_sockets(output, obj);
 551         if (ret < 0) {
 552                 goto malloc_error;
 553         }
 554
 555 error:
 556         return output;
 557
 558 malloc_error:
 559         consumer_destroy_output(output);
 560         return NULL;
 561 }
 562
 563 /*
 564  * Copy consumer sockets from src to dst.
 565  *
 566  * Return 0 on success or else a negative value.
 567  */
 568 int consumer_copy_sockets(struct consumer_output *dst,
 569                 struct consumer_output *src)
 570 {
 571         int ret = 0;
 572         struct lttng_ht_iter iter;
 573         struct consumer_socket *socket, *copy_sock;
 574
 575         assert(dst);
 576         assert(src);
 577
 578         rcu_read_lock();
 579         cds_lfht_for_each_entry(src->socks->ht, &iter.iter, socket, node.node) {
 580                 /* Ignore socket that are already there. */
 581                 copy_sock = consumer_find_socket(*socket->fd_ptr, dst);
 582                 if (copy_sock) {
 583                         continue;
 584                 }
 585
 586                 /* Create new socket object. */
 587                 copy_sock = consumer_allocate_socket(socket->fd_ptr);
 588                 if (copy_sock == NULL) {
 589                         rcu_read_unlock();
 590                         ret = -ENOMEM;
 591                         goto error;
 592                 }
 593
 594                 copy_sock->registered = socket->registered;
 595                 /*
 596                  * This is valid because this lock is shared accross all consumer
 597                  * object being the global lock of the consumer data structure of the
 598                  * session daemon.
 599                  */
 600                 copy_sock->lock = socket->lock;
 601                 consumer_add_socket(copy_sock, dst);
 602         }
 603         rcu_read_unlock();
 604
 605 error:
 606         return ret;
 607 }
 608
 609 /*
 610  * Set network URI to the consumer output object.
 611  *
 612  * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
 613  * error.
 614  */
 615 int consumer_set_network_uri(struct consumer_output *obj,
 616                 struct lttng_uri *uri)
 617 {
 618         int ret;
 619         char tmp_path[PATH_MAX];
 620         char hostname[HOST_NAME_MAX];
 621         struct lttng_uri *dst_uri = NULL;
 622
 623         /* Code flow error safety net. */
 624         assert(obj);
 625         assert(uri);
 626
 627         switch (uri->stype) {
 628         case LTTNG_STREAM_CONTROL:
 629                 dst_uri = &obj->dst.net.control;
 630                 obj->dst.net.control_isset = 1;
 631                 if (uri->port == 0) {
 632                         /* Assign default port. */
 633                         uri->port = DEFAULT_NETWORK_CONTROL_PORT;
 634                 } else {
 635                         if (obj->dst.net.data_isset && uri->port ==
 636                                         obj->dst.net.data.port) {
 637                                 ret = -LTTNG_ERR_INVALID;
 638                                 goto error;
 639                         }
 640                 }
 641                 DBG3("Consumer control URI set with port %d", uri->port);
 642                 break;
 643         case LTTNG_STREAM_DATA:
 644                 dst_uri = &obj->dst.net.data;
 645                 obj->dst.net.data_isset = 1;
 646                 if (uri->port == 0) {
 647                         /* Assign default port. */
 648                         uri->port = DEFAULT_NETWORK_DATA_PORT;
 649                 } else {
 650                         if (obj->dst.net.control_isset && uri->port ==
 651                                         obj->dst.net.control.port) {
 652                                 ret = -LTTNG_ERR_INVALID;
 653                                 goto error;
 654                         }
 655                 }
 656                 DBG3("Consumer data URI set with port %d", uri->port);
 657                 break;
 658         default:
 659                 ERR("Set network uri type unknown %d", uri->stype);
 660                 ret = -LTTNG_ERR_INVALID;
 661                 goto error;
 662         }
 663
 664         ret = uri_compare(dst_uri, uri);
 665         if (!ret) {
 666                 /* Same URI, don't touch it and return success. */
 667                 DBG3("URI network compare are the same");
 668                 goto equal;
 669         }
 670
 671         /* URIs were not equal, replacing it. */
 672         memset(dst_uri, 0, sizeof(struct lttng_uri));
 673         memcpy(dst_uri, uri, sizeof(struct lttng_uri));
 674         obj->type = CONSUMER_DST_NET;
 675
 676         /* Handle subdir and add hostname in front. */
 677         if (dst_uri->stype == LTTNG_STREAM_CONTROL) {
 678                 /* Get hostname to append it in the pathname */
 679                 ret = gethostname(hostname, sizeof(hostname));
 680                 if (ret < 0) {
 681                         PERROR("gethostname. Fallback on default localhost");
 682                         strncpy(hostname, "localhost", sizeof(hostname));
 683                 }
 684                 hostname[sizeof(hostname) - 1] = '\0';
 685
 686                 /* Setup consumer subdir if none present in the control URI */
 687                 if (strlen(dst_uri->subdir) == 0) {
 688                         ret = snprintf(tmp_path, sizeof(tmp_path), "%s/%s",
 689                                         hostname, obj->subdir);
 690                 } else {
 691                         ret = snprintf(tmp_path, sizeof(tmp_path), "%s/%s",
 692                                         hostname, dst_uri->subdir);
 693                 }
 694                 if (ret < 0) {
 695                         PERROR("snprintf set consumer uri subdir");
 696                         ret = -LTTNG_ERR_NOMEM;
 697                         goto error;
 698                 }
 699
 700                 strncpy(obj->subdir, tmp_path, sizeof(obj->subdir));
 701                 DBG3("Consumer set network uri subdir path %s", tmp_path);
 702         }
 703
 704         return 0;
 705 equal:
 706         return 1;
 707 error:
 708         return ret;
 709 }
 710
 711 /*
 712  * Send file descriptor to consumer via sock.
 713  */
 714 int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd)
 715 {
 716         int ret;
 717
 718         assert(fds);
 719         assert(sock);
 720         assert(nb_fd > 0);
 721
 722         ret = lttcomm_send_fds_unix_sock(*sock->fd_ptr, fds, nb_fd);
 723         if (ret < 0) {
 724                 /* The above call will print a PERROR on error. */
 725                 DBG("Error when sending consumer fds on sock %d", *sock->fd_ptr);
 726                 goto error;
 727         }
 728
 729         ret = consumer_recv_status_reply(sock);
 730
 731 error:
 732         return ret;
 733 }
 734
 735 /*
 736  * Consumer send communication message structure to consumer.
 737  */
 738 int consumer_send_msg(struct consumer_socket *sock,
 739                 struct lttcomm_consumer_msg *msg)
 740 {
 741         int ret;
 742
 743         assert(msg);
 744         assert(sock);
 745
 746         ret = consumer_socket_send(sock, msg, sizeof(struct lttcomm_consumer_msg));
 747         if (ret < 0) {
 748                 goto error;
 749         }
 750
 751         ret = consumer_recv_status_reply(sock);
 752
 753 error:
 754         return ret;
 755 }
 756
 757 /*
 758  * Consumer send channel communication message structure to consumer.
 759  */
 760 int consumer_send_channel(struct consumer_socket *sock,
 761                 struct lttcomm_consumer_msg *msg)
 762 {
 763         int ret;
 764
 765         assert(msg);
 766         assert(sock);
 767
 768         ret = consumer_send_msg(sock, msg);
 769         if (ret < 0) {
 770                 goto error;
 771         }
 772
 773 error:
 774         return ret;
 775 }
 776
 777 /*
 778  * Populate the given consumer msg structure with the ask_channel command
 779  * information.
 780  */
 781 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 782                 uint64_t subbuf_size,
 783                 uint64_t num_subbuf,
 784                 int overwrite,
 785                 unsigned int switch_timer_interval,
 786                 unsigned int read_timer_interval,
 787                 unsigned int live_timer_interval,
 788                 int output,
 789                 int type,
 790                 uint64_t session_id,
 791                 const char *pathname,
 792                 const char *name,
 793                 uid_t uid,
 794                 gid_t gid,
 795                 uint64_t relayd_id,
 796                 uint64_t key,
 797                 unsigned char *uuid,
 798                 uint32_t chan_id,
 799                 uint64_t tracefile_size,
 800                 uint64_t tracefile_count,
 801                 uint64_t session_id_per_pid,
 802                 unsigned int monitor,
 803                 uint32_t ust_app_uid)
 804 {
 805         assert(msg);
 806
 807         /* Zeroed structure */
 808         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 809
 810         msg->cmd_type = LTTNG_CONSUMER_ASK_CHANNEL_CREATION;
 811         msg->u.ask_channel.subbuf_size = subbuf_size;
 812         msg->u.ask_channel.num_subbuf = num_subbuf ;
 813         msg->u.ask_channel.overwrite = overwrite;
 814         msg->u.ask_channel.switch_timer_interval = switch_timer_interval;
 815         msg->u.ask_channel.read_timer_interval = read_timer_interval;
 816         msg->u.ask_channel.live_timer_interval = live_timer_interval;
 817         msg->u.ask_channel.output = output;
 818         msg->u.ask_channel.type = type;
 819         msg->u.ask_channel.session_id = session_id;
 820         msg->u.ask_channel.session_id_per_pid = session_id_per_pid;
 821         msg->u.ask_channel.uid = uid;
 822         msg->u.ask_channel.gid = gid;
 823         msg->u.ask_channel.relayd_id = relayd_id;
 824         msg->u.ask_channel.key = key;
 825         msg->u.ask_channel.chan_id = chan_id;
 826         msg->u.ask_channel.tracefile_size = tracefile_size;
 827         msg->u.ask_channel.tracefile_count = tracefile_count;
 828         msg->u.ask_channel.monitor = monitor;
 829         msg->u.ask_channel.ust_app_uid = ust_app_uid;
 830
 831         memcpy(msg->u.ask_channel.uuid, uuid, sizeof(msg->u.ask_channel.uuid));
 832
 833         if (pathname) {
 834                 strncpy(msg->u.ask_channel.pathname, pathname,
 835                                 sizeof(msg->u.ask_channel.pathname));
 836                 msg->u.ask_channel.pathname[sizeof(msg->u.ask_channel.pathname)-1] = '\0';
 837         }
 838
 839         strncpy(msg->u.ask_channel.name, name, sizeof(msg->u.ask_channel.name));
 840         msg->u.ask_channel.name[sizeof(msg->u.ask_channel.name) - 1] = '\0';
 841 }
 842
 843 /*
 844  * Init channel communication message structure.
 845  */
 846 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 847                 enum lttng_consumer_command cmd,
 848                 uint64_t channel_key,
 849                 uint64_t session_id,
 850                 const char *pathname,
 851                 uid_t uid,
 852                 gid_t gid,
 853                 uint64_t relayd_id,
 854                 const char *name,
 855                 unsigned int nb_init_streams,
 856                 enum lttng_event_output output,
 857                 int type,
 858                 uint64_t tracefile_size,
 859                 uint64_t tracefile_count,
 860                 unsigned int monitor,
 861                 unsigned int live_timer_interval)
 862 {
 863         assert(msg);
 864
 865         /* Zeroed structure */
 866         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 867
 868         /* Send channel */
 869         msg->cmd_type = cmd;
 870         msg->u.channel.channel_key = channel_key;
 871         msg->u.channel.session_id = session_id;
 872         msg->u.channel.uid = uid;
 873         msg->u.channel.gid = gid;
 874         msg->u.channel.relayd_id = relayd_id;
 875         msg->u.channel.nb_init_streams = nb_init_streams;
 876         msg->u.channel.output = output;
 877         msg->u.channel.type = type;
 878         msg->u.channel.tracefile_size = tracefile_size;
 879         msg->u.channel.tracefile_count = tracefile_count;
 880         msg->u.channel.monitor = monitor;
 881         msg->u.channel.live_timer_interval = live_timer_interval;
 882
 883         strncpy(msg->u.channel.pathname, pathname,
 884                         sizeof(msg->u.channel.pathname));
 885         msg->u.channel.pathname[sizeof(msg->u.channel.pathname) - 1] = '\0';
 886
 887         strncpy(msg->u.channel.name, name, sizeof(msg->u.channel.name));
 888         msg->u.channel.name[sizeof(msg->u.channel.name) - 1] = '\0';
 889 }
 890
 891 /*
 892  * Init stream communication message structure.
 893  */
 894 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
 895                 enum lttng_consumer_command cmd,
 896                 uint64_t channel_key,
 897                 uint64_t stream_key,
 898                 int cpu)
 899 {
 900         assert(msg);
 901
 902         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 903
 904         msg->cmd_type = cmd;
 905         msg->u.stream.channel_key = channel_key;
 906         msg->u.stream.stream_key = stream_key;
 907         msg->u.stream.cpu = cpu;
 908 }
 909
 910 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg,
 911                 enum lttng_consumer_command cmd,
 912                 uint64_t channel_key, uint64_t net_seq_idx)
 913 {
 914         assert(msg);
 915
 916         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 917
 918         msg->cmd_type = cmd;
 919         msg->u.sent_streams.channel_key = channel_key;
 920         msg->u.sent_streams.net_seq_idx = net_seq_idx;
 921 }
 922
 923 /*
 924  * Send stream communication structure to the consumer.
 925  */
 926 int consumer_send_stream(struct consumer_socket *sock,
 927                 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
 928                 int *fds, size_t nb_fd)
 929 {
 930         int ret;
 931
 932         assert(msg);
 933         assert(dst);
 934         assert(sock);
 935         assert(fds);
 936
 937         ret = consumer_send_msg(sock, msg);
 938         if (ret < 0) {
 939                 goto error;
 940         }
 941
 942         ret = consumer_send_fds(sock, fds, nb_fd);
 943         if (ret < 0) {
 944                 goto error;
 945         }
 946
 947 error:
 948         return ret;
 949 }
 950
 951 /*
 952  * Send relayd socket to consumer associated with a session name.
 953  *
 954  * On success return positive value. On error, negative value.
 955  */
 956 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
 957                 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
 958                 enum lttng_stream_type type, uint64_t session_id,
 959                 char *session_name, char *hostname, int session_live_timer)
 960 {
 961         int ret;
 962         struct lttcomm_consumer_msg msg;
 963
 964         /* Code flow error. Safety net. */
 965         assert(rsock);
 966         assert(consumer);
 967         assert(consumer_sock);
 968
 969         memset(&msg, 0, sizeof(msg));
 970         /* Bail out if consumer is disabled */
 971         if (!consumer->enabled) {
 972                 ret = LTTNG_OK;
 973                 goto error;
 974         }
 975
 976         if (type == LTTNG_STREAM_CONTROL) {
 977                 ret = relayd_create_session(rsock,
 978                                 &msg.u.relayd_sock.relayd_session_id,
 979                                 session_name, hostname, session_live_timer,
 980                                 consumer->snapshot);
 981                 if (ret < 0) {
 982                         /* Close the control socket. */
 983                         (void) relayd_close(rsock);
 984                         goto error;
 985                 }
 986         }
 987
 988         msg.cmd_type = LTTNG_CONSUMER_ADD_RELAYD_SOCKET;
 989         /*
 990          * Assign network consumer output index using the temporary consumer since
 991          * this call should only be made from within a set_consumer_uri() function
 992          * call in the session daemon.
 993          */
 994         msg.u.relayd_sock.net_index = consumer->net_seq_index;
 995         msg.u.relayd_sock.type = type;
 996         msg.u.relayd_sock.session_id = session_id;
 997         memcpy(&msg.u.relayd_sock.sock, rsock, sizeof(msg.u.relayd_sock.sock));
 998
 999         DBG3("Sending relayd sock info to consumer on %d", *consumer_sock->fd_ptr);
1000         ret = consumer_send_msg(consumer_sock, &msg);
1001         if (ret < 0) {
1002                 goto error;
1003         }
1004
1005         DBG3("Sending relayd socket file descriptor to consumer");
1006         ret = consumer_send_fds(consumer_sock, &rsock->sock.fd, 1);
1007         if (ret < 0) {
1008                 goto error;
1009         }
1010
1011         DBG2("Consumer relayd socket sent");
1012
1013 error:
1014         return ret;
1015 }
1016
1017 /*
1018  * Set consumer subdirectory using the session name and a generated datetime if
1019  * needed. This is appended to the current subdirectory.
1020  */
1021 int consumer_set_subdir(struct consumer_output *consumer,
1022                 const char *session_name)
1023 {
1024         int ret = 0;
1025         unsigned int have_default_name = 0;
1026         char datetime[16], tmp_path[PATH_MAX];
1027         time_t rawtime;
1028         struct tm *timeinfo;
1029
1030         assert(consumer);
1031         assert(session_name);
1032
1033         memset(tmp_path, 0, sizeof(tmp_path));
1034
1035         /* Flag if we have a default session. */
1036         if (strncmp(session_name, DEFAULT_SESSION_NAME "-",
1037                                 strlen(DEFAULT_SESSION_NAME) + 1) == 0) {
1038                 have_default_name = 1;
1039         } else {
1040                 /* Get date and time for session path */
1041                 time(&rawtime);
1042                 timeinfo = localtime(&rawtime);
1043                 strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
1044         }
1045
1046         if (have_default_name) {
1047                 ret = snprintf(tmp_path, sizeof(tmp_path),
1048                                 "%s/%s", consumer->subdir, session_name);
1049         } else {
1050                 ret = snprintf(tmp_path, sizeof(tmp_path),
1051                                 "%s/%s-%s/", consumer->subdir, session_name, datetime);
1052         }
1053         if (ret < 0) {
1054                 PERROR("snprintf session name date");
1055                 goto error;
1056         }
1057
1058         strncpy(consumer->subdir, tmp_path, sizeof(consumer->subdir));
1059         DBG2("Consumer subdir set to %s", consumer->subdir);
1060
1061 error:
1062         return ret;
1063 }
1064
1065 /*
1066  * Ask the consumer if the data is ready to read (NOT pending) for the specific
1067  * session id.
1068  *
1069  * This function has a different behavior with the consumer i.e. that it waits
1070  * for a reply from the consumer if yes or no the data is pending.
1071  */
1072 int consumer_is_data_pending(uint64_t session_id,
1073                 struct consumer_output *consumer)
1074 {
1075         int ret;
1076         int32_t ret_code = 0;  /* Default is that the data is NOT pending */
1077         struct consumer_socket *socket;
1078         struct lttng_ht_iter iter;
1079         struct lttcomm_consumer_msg msg;
1080
1081         assert(consumer);
1082
1083         DBG3("Consumer data pending for id %" PRIu64, session_id);
1084
1085         memset(&msg, 0, sizeof(msg));
1086         msg.cmd_type = LTTNG_CONSUMER_DATA_PENDING;
1087         msg.u.data_pending.session_id = session_id;
1088
1089         /* Send command for each consumer */
1090         rcu_read_lock();
1091         cds_lfht_for_each_entry(consumer->socks->ht, &iter.iter, socket,
1092                         node.node) {
1093                 pthread_mutex_lock(socket->lock);
1094                 ret = consumer_socket_send(socket, &msg, sizeof(msg));
1095                 if (ret < 0) {
1096                         pthread_mutex_unlock(socket->lock);
1097                         goto error_unlock;
1098                 }
1099
1100                 /*
1101                  * No need for a recv reply status because the answer to the command is
1102                  * the reply status message.
1103                  */
1104
1105                 ret = consumer_socket_recv(socket, &ret_code, sizeof(ret_code));
1106                 if (ret < 0) {
1107                         pthread_mutex_unlock(socket->lock);
1108                         goto error_unlock;
1109                 }
1110                 pthread_mutex_unlock(socket->lock);
1111
1112                 if (ret_code == 1) {
1113                         break;
1114                 }
1115         }
1116         rcu_read_unlock();
1117
1118         DBG("Consumer data is %s pending for session id %" PRIu64,
1119                         ret_code == 1 ? "" : "NOT", session_id);
1120         return ret_code;
1121
1122 error_unlock:
1123         rcu_read_unlock();
1124         return -1;
1125 }
1126
1127 /*
1128  * Send a flush command to consumer using the given channel key.
1129  *
1130  * Return 0 on success else a negative value.
1131  */
1132 int consumer_flush_channel(struct consumer_socket *socket, uint64_t key)
1133 {
1134         int ret;
1135         struct lttcomm_consumer_msg msg;
1136
1137         assert(socket);
1138
1139         DBG2("Consumer flush channel key %" PRIu64, key);
1140
1141         memset(&msg, 0, sizeof(msg));
1142         msg.cmd_type = LTTNG_CONSUMER_FLUSH_CHANNEL;
1143         msg.u.flush_channel.key = key;
1144
1145         pthread_mutex_lock(socket->lock);
1146         health_code_update();
1147
1148         ret = consumer_send_msg(socket, &msg);
1149         if (ret < 0) {
1150                 goto end;
1151         }
1152
1153 end:
1154         health_code_update();
1155         pthread_mutex_unlock(socket->lock);
1156         return ret;
1157 }
1158
1159 /*
1160  * Send a close metdata command to consumer using the given channel key.
1161  *
1162  * Return 0 on success else a negative value.
1163  */
1164 int consumer_close_metadata(struct consumer_socket *socket,
1165                 uint64_t metadata_key)
1166 {
1167         int ret;
1168         struct lttcomm_consumer_msg msg;
1169
1170         assert(socket);
1171
1172         DBG2("Consumer close metadata channel key %" PRIu64, metadata_key);
1173
1174         memset(&msg, 0, sizeof(msg));
1175         msg.cmd_type = LTTNG_CONSUMER_CLOSE_METADATA;
1176         msg.u.close_metadata.key = metadata_key;
1177
1178         pthread_mutex_lock(socket->lock);
1179         health_code_update();
1180
1181         ret = consumer_send_msg(socket, &msg);
1182         if (ret < 0) {
1183                 goto end;
1184         }
1185
1186 end:
1187         health_code_update();
1188         pthread_mutex_unlock(socket->lock);
1189         return ret;
1190 }
1191
1192 /*
1193  * Send a setup metdata command to consumer using the given channel key.
1194  *
1195  * Return 0 on success else a negative value.
1196  */
1197 int consumer_setup_metadata(struct consumer_socket *socket,
1198                 uint64_t metadata_key)
1199 {
1200         int ret;
1201         struct lttcomm_consumer_msg msg;
1202
1203         assert(socket);
1204
1205         DBG2("Consumer setup metadata channel key %" PRIu64, metadata_key);
1206
1207         memset(&msg, 0, sizeof(msg));
1208         msg.cmd_type = LTTNG_CONSUMER_SETUP_METADATA;
1209         msg.u.setup_metadata.key = metadata_key;
1210
1211         pthread_mutex_lock(socket->lock);
1212         health_code_update();
1213
1214         ret = consumer_send_msg(socket, &msg);
1215         if (ret < 0) {
1216                 goto end;
1217         }
1218
1219 end:
1220         health_code_update();
1221         pthread_mutex_unlock(socket->lock);
1222         return ret;
1223 }
1224
1225 /*
1226  * Send metadata string to consumer. Socket lock MUST be acquired.
1227  *
1228  * Return 0 on success else a negative value.
1229  */
1230 int consumer_push_metadata(struct consumer_socket *socket,
1231                 uint64_t metadata_key, char *metadata_str, size_t len,
1232                 size_t target_offset)
1233 {
1234         int ret;
1235         struct lttcomm_consumer_msg msg;
1236
1237         assert(socket);
1238
1239         DBG2("Consumer push metadata to consumer socket %d", *socket->fd_ptr);
1240
1241         memset(&msg, 0, sizeof(msg));
1242         msg.cmd_type = LTTNG_CONSUMER_PUSH_METADATA;
1243         msg.u.push_metadata.key = metadata_key;
1244         msg.u.push_metadata.target_offset = target_offset;
1245         msg.u.push_metadata.len = len;
1246
1247         health_code_update();
1248         ret = consumer_send_msg(socket, &msg);
1249         if (ret < 0 || len == 0) {
1250                 goto end;
1251         }
1252
1253         DBG3("Consumer pushing metadata on sock %d of len %zu", *socket->fd_ptr,
1254                         len);
1255
1256         ret = consumer_socket_send(socket, metadata_str, len);
1257         if (ret < 0) {
1258                 goto end;
1259         }
1260
1261         health_code_update();
1262         ret = consumer_recv_status_reply(socket);
1263         if (ret < 0) {
1264                 goto end;
1265         }
1266
1267 end:
1268         health_code_update();
1269         return ret;
1270 }
1271
1272 /*
1273  * Ask the consumer to snapshot a specific channel using the key.
1274  *
1275  * Return 0 on success or else a negative error.
1276  */
1277 int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key,
1278                 struct snapshot_output *output, int metadata, uid_t uid, gid_t gid,
1279                 const char *session_path, int wait, int max_stream_size)
1280 {
1281         int ret;
1282         struct lttcomm_consumer_msg msg;
1283
1284         assert(socket);
1285         assert(output);
1286         assert(output->consumer);
1287
1288         DBG("Consumer snapshot channel key %" PRIu64, key);
1289
1290         memset(&msg, 0, sizeof(msg));
1291         msg.cmd_type = LTTNG_CONSUMER_SNAPSHOT_CHANNEL;
1292         msg.u.snapshot_channel.key = key;
1293         msg.u.snapshot_channel.max_stream_size = max_stream_size;
1294         msg.u.snapshot_channel.metadata = metadata;
1295
1296         if (output->consumer->type == CONSUMER_DST_NET) {
1297                 msg.u.snapshot_channel.relayd_id = output->consumer->net_seq_index;
1298                 msg.u.snapshot_channel.use_relayd = 1;
1299                 ret = snprintf(msg.u.snapshot_channel.pathname,
1300                                 sizeof(msg.u.snapshot_channel.pathname),
1301                                 "%s/%s-%s-%" PRIu64 "%s", output->consumer->subdir,
1302                                 output->name, output->datetime, output->nb_snapshot,
1303                                 session_path);
1304                 if (ret < 0) {
1305                         ret = -LTTNG_ERR_NOMEM;
1306                         goto error;
1307                 }
1308         } else {
1309                 ret = snprintf(msg.u.snapshot_channel.pathname,
1310                                 sizeof(msg.u.snapshot_channel.pathname),
1311                                 "%s/%s-%s-%" PRIu64 "%s", output->consumer->dst.trace_path,
1312                                 output->name, output->datetime, output->nb_snapshot,
1313                                 session_path);
1314                 if (ret < 0) {
1315                         ret = -LTTNG_ERR_NOMEM;
1316                         goto error;
1317                 }
1318                 msg.u.snapshot_channel.relayd_id = (uint64_t) -1ULL;
1319
1320                 /* Create directory. Ignore if exist. */
1321                 ret = run_as_mkdir_recursive(msg.u.snapshot_channel.pathname,
1322                                 S_IRWXU | S_IRWXG, uid, gid);
1323                 if (ret < 0) {
1324                         if (ret != -EEXIST) {
1325                                 ERR("Trace directory creation error");
1326                                 goto error;
1327                         }
1328                 }
1329         }
1330
1331         health_code_update();
1332         ret = consumer_send_msg(socket, &msg);
1333         if (ret < 0) {
1334                 goto error;
1335         }
1336
1337 error:
1338         health_code_update();
1339         return ret;
1340 }