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 #define _LGPL_SOURCE
  20 #include <assert.h>
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <sys/stat.h>
  25 #include <sys/types.h>
  26 #include <unistd.h>
  27 #include <inttypes.h>
  28
  29 #include <common/common.h>
  30 #include <common/defaults.h>
  31 #include <common/uri.h>
  32 #include <common/relayd/relayd.h>
  33
  34 #include "consumer.h"
  35 #include "health-sessiond.h"
  36 #include "ust-app.h"
  37 #include "utils.h"
  38
  39 /*
  40  * Send a data payload using a given consumer socket of size len.
  41  *
  42  * The consumer socket lock MUST be acquired before calling this since this
  43  * function can change the fd value.
  44  *
  45  * Return 0 on success else a negative value on error.
  46  */
  47 int consumer_socket_send(struct consumer_socket *socket, void *msg, size_t len)
  48 {
  49         int fd;
  50         ssize_t size;
  51
  52         assert(socket);
  53         assert(socket->fd_ptr);
  54         assert(msg);
  55
  56         /* Consumer socket is invalid. Stopping. */
  57         fd = *socket->fd_ptr;
  58         if (fd < 0) {
  59                 goto error;
  60         }
  61
  62         size = lttcomm_send_unix_sock(fd, msg, len);
  63         if (size < 0) {
  64                 /* The above call will print a PERROR on error. */
  65                 DBG("Error when sending data to consumer on sock %d", fd);
  66                 /*
  67                  * At this point, the socket is not usable anymore thus closing it and
  68                  * setting the file descriptor to -1 so it is not reused.
  69                  */
  70
  71                 /* This call will PERROR on error. */
  72                 (void) lttcomm_close_unix_sock(fd);
  73                 *socket->fd_ptr = -1;
  74                 goto error;
  75         }
  76
  77         return 0;
  78
  79 error:
  80         return -1;
  81 }
  82
  83 /*
  84  * Receive a data payload using a given consumer socket of size len.
  85  *
  86  * The consumer socket lock MUST be acquired before calling this since this
  87  * function can change the fd value.
  88  *
  89  * Return 0 on success else a negative value on error.
  90  */
  91 int consumer_socket_recv(struct consumer_socket *socket, void *msg, size_t len)
  92 {
  93         int fd;
  94         ssize_t size;
  95
  96         assert(socket);
  97         assert(socket->fd_ptr);
  98         assert(msg);
  99
 100         /* Consumer socket is invalid. Stopping. */
 101         fd = *socket->fd_ptr;
 102         if (fd < 0) {
 103                 goto error;
 104         }
 105
 106         size = lttcomm_recv_unix_sock(fd, msg, len);
 107         if (size <= 0) {
 108                 /* The above call will print a PERROR on error. */
 109                 DBG("Error when receiving data from the consumer socket %d", fd);
 110                 /*
 111                  * At this point, the socket is not usable anymore thus closing it and
 112                  * setting the file descriptor to -1 so it is not reused.
 113                  */
 114
 115                 /* This call will PERROR on error. */
 116                 (void) lttcomm_close_unix_sock(fd);
 117                 *socket->fd_ptr = -1;
 118                 goto error;
 119         }
 120
 121         return 0;
 122
 123 error:
 124         return -1;
 125 }
 126
 127 /*
 128  * Receive a reply command status message from the consumer. Consumer socket
 129  * lock MUST be acquired before calling this function.
 130  *
 131  * Return 0 on success, -1 on recv error or a negative lttng error code which
 132  * was possibly returned by the consumer.
 133  */
 134 int consumer_recv_status_reply(struct consumer_socket *sock)
 135 {
 136         int ret;
 137         struct lttcomm_consumer_status_msg reply;
 138
 139         assert(sock);
 140
 141         ret = consumer_socket_recv(sock, &reply, sizeof(reply));
 142         if (ret < 0) {
 143                 goto end;
 144         }
 145
 146         if (reply.ret_code == LTTCOMM_CONSUMERD_SUCCESS) {
 147                 /* All good. */
 148                 ret = 0;
 149         } else {
 150                 ret = -reply.ret_code;
 151                 DBG("Consumer ret code %d", ret);
 152         }
 153
 154 end:
 155         return ret;
 156 }
 157
 158 /*
 159  * Once the ASK_CHANNEL command is sent to the consumer, the channel
 160  * information are sent back. This call receives that data and populates key
 161  * and stream_count.
 162  *
 163  * On success return 0 and both key and stream_count are set. On error, a
 164  * negative value is sent back and both parameters are untouched.
 165  */
 166 int consumer_recv_status_channel(struct consumer_socket *sock,
 167                 uint64_t *key, unsigned int *stream_count)
 168 {
 169         int ret;
 170         struct lttcomm_consumer_status_channel reply;
 171
 172         assert(sock);
 173         assert(stream_count);
 174         assert(key);
 175
 176         ret = consumer_socket_recv(sock, &reply, sizeof(reply));
 177         if (ret < 0) {
 178                 goto end;
 179         }
 180
 181         /* An error is possible so don't touch the key and stream_count. */
 182         if (reply.ret_code != LTTCOMM_CONSUMERD_SUCCESS) {
 183                 ret = -1;
 184                 goto end;
 185         }
 186
 187         *key = reply.key;
 188         *stream_count = reply.stream_count;
 189         ret = 0;
 190
 191 end:
 192         return ret;
 193 }
 194
 195 /*
 196  * Send destroy relayd command to consumer.
 197  *
 198  * On success return positive value. On error, negative value.
 199  */
 200 int consumer_send_destroy_relayd(struct consumer_socket *sock,
 201                 struct consumer_output *consumer)
 202 {
 203         int ret;
 204         struct lttcomm_consumer_msg msg;
 205
 206         assert(consumer);
 207         assert(sock);
 208
 209         DBG2("Sending destroy relayd command to consumer sock %d", *sock->fd_ptr);
 210
 211         memset(&msg, 0, sizeof(msg));
 212         msg.cmd_type = LTTNG_CONSUMER_DESTROY_RELAYD;
 213         msg.u.destroy_relayd.net_seq_idx = consumer->net_seq_index;
 214
 215         pthread_mutex_lock(sock->lock);
 216         ret = consumer_socket_send(sock, &msg, sizeof(msg));
 217         if (ret < 0) {
 218                 goto error;
 219         }
 220
 221         /* Don't check the return value. The caller will do it. */
 222         ret = consumer_recv_status_reply(sock);
 223
 224         DBG2("Consumer send destroy relayd command done");
 225
 226 error:
 227         pthread_mutex_unlock(sock->lock);
 228         return ret;
 229 }
 230
 231 /*
 232  * For each consumer socket in the consumer output object, send a destroy
 233  * relayd command.
 234  */
 235 void consumer_output_send_destroy_relayd(struct consumer_output *consumer)
 236 {
 237         struct lttng_ht_iter iter;
 238         struct consumer_socket *socket;
 239
 240         assert(consumer);
 241
 242         /* Destroy any relayd connection */
 243         if (consumer->type == CONSUMER_DST_NET) {
 244                 rcu_read_lock();
 245                 cds_lfht_for_each_entry(consumer->socks->ht, &iter.iter, socket,
 246                                 node.node) {
 247                         int ret;
 248
 249                         /* Send destroy relayd command */
 250                         ret = consumer_send_destroy_relayd(socket, consumer);
 251                         if (ret < 0) {
 252                                 DBG("Unable to send destroy relayd command to consumer");
 253                                 /* Continue since we MUST delete everything at this point. */
 254                         }
 255                 }
 256                 rcu_read_unlock();
 257         }
 258 }
 259
 260 /*
 261  * From a consumer_data structure, allocate and add a consumer socket to the
 262  * consumer output.
 263  *
 264  * Return 0 on success, else negative value on error
 265  */
 266 int consumer_create_socket(struct consumer_data *data,
 267                 struct consumer_output *output)
 268 {
 269         int ret = 0;
 270         struct consumer_socket *socket;
 271
 272         assert(data);
 273
 274         if (output == NULL || data->cmd_sock < 0) {
 275                 /*
 276                  * Not an error. Possible there is simply not spawned consumer or it's
 277                  * disabled for the tracing session asking the socket.
 278                  */
 279                 goto error;
 280         }
 281
 282         rcu_read_lock();
 283         socket = consumer_find_socket(data->cmd_sock, output);
 284         rcu_read_unlock();
 285         if (socket == NULL) {
 286                 socket = consumer_allocate_socket(&data->cmd_sock);
 287                 if (socket == NULL) {
 288                         ret = -1;
 289                         goto error;
 290                 }
 291
 292                 socket->registered = 0;
 293                 socket->lock = &data->lock;
 294                 rcu_read_lock();
 295                 consumer_add_socket(socket, output);
 296                 rcu_read_unlock();
 297         }
 298
 299         socket->type = data->type;
 300
 301         DBG3("Consumer socket created (fd: %d) and added to output",
 302                         data->cmd_sock);
 303
 304 error:
 305         return ret;
 306 }
 307
 308 /*
 309  * Return the consumer socket from the given consumer output with the right
 310  * bitness. On error, returns NULL.
 311  *
 312  * The caller MUST acquire a rcu read side lock and keep it until the socket
 313  * object reference is not needed anymore.
 314  */
 315 struct consumer_socket *consumer_find_socket_by_bitness(int bits,
 316                 struct consumer_output *consumer)
 317 {
 318         int consumer_fd;
 319         struct consumer_socket *socket = NULL;
 320
 321         switch (bits) {
 322         case 64:
 323                 consumer_fd = uatomic_read(&ust_consumerd64_fd);
 324                 break;
 325         case 32:
 326                 consumer_fd = uatomic_read(&ust_consumerd32_fd);
 327                 break;
 328         default:
 329                 assert(0);
 330                 goto end;
 331         }
 332
 333         socket = consumer_find_socket(consumer_fd, consumer);
 334         if (!socket) {
 335                 ERR("Consumer socket fd %d not found in consumer obj %p",
 336                                 consumer_fd, consumer);
 337         }
 338
 339 end:
 340         return socket;
 341 }
 342
 343 /*
 344  * Find a consumer_socket in a consumer_output hashtable. Read side lock must
 345  * be acquired before calling this function and across use of the
 346  * returned consumer_socket.
 347  */
 348 struct consumer_socket *consumer_find_socket(int key,
 349                 struct consumer_output *consumer)
 350 {
 351         struct lttng_ht_iter iter;
 352         struct lttng_ht_node_ulong *node;
 353         struct consumer_socket *socket = NULL;
 354
 355         /* Negative keys are lookup failures */
 356         if (key < 0 || consumer == NULL) {
 357                 return NULL;
 358         }
 359
 360         lttng_ht_lookup(consumer->socks, (void *)((unsigned long) key),
 361                         &iter);
 362         node = lttng_ht_iter_get_node_ulong(&iter);
 363         if (node != NULL) {
 364                 socket = caa_container_of(node, struct consumer_socket, node);
 365         }
 366
 367         return socket;
 368 }
 369
 370 /*
 371  * Allocate a new consumer_socket and return the pointer.
 372  */
 373 struct consumer_socket *consumer_allocate_socket(int *fd)
 374 {
 375         struct consumer_socket *socket = NULL;
 376
 377         assert(fd);
 378
 379         socket = zmalloc(sizeof(struct consumer_socket));
 380         if (socket == NULL) {
 381                 PERROR("zmalloc consumer socket");
 382                 goto error;
 383         }
 384
 385         socket->fd_ptr = fd;
 386         lttng_ht_node_init_ulong(&socket->node, *fd);
 387
 388 error:
 389         return socket;
 390 }
 391
 392 /*
 393  * Add consumer socket to consumer output object. Read side lock must be
 394  * acquired before calling this function.
 395  */
 396 void consumer_add_socket(struct consumer_socket *sock,
 397                 struct consumer_output *consumer)
 398 {
 399         assert(sock);
 400         assert(consumer);
 401
 402         lttng_ht_add_unique_ulong(consumer->socks, &sock->node);
 403 }
 404
 405 /*
 406  * Delte consumer socket to consumer output object. Read side lock must be
 407  * acquired before calling this function.
 408  */
 409 void consumer_del_socket(struct consumer_socket *sock,
 410                 struct consumer_output *consumer)
 411 {
 412         int ret;
 413         struct lttng_ht_iter iter;
 414
 415         assert(sock);
 416         assert(consumer);
 417
 418         iter.iter.node = &sock->node.node;
 419         ret = lttng_ht_del(consumer->socks, &iter);
 420         assert(!ret);
 421 }
 422
 423 /*
 424  * RCU destroy call function.
 425  */
 426 static void destroy_socket_rcu(struct rcu_head *head)
 427 {
 428         struct lttng_ht_node_ulong *node =
 429                 caa_container_of(head, struct lttng_ht_node_ulong, head);
 430         struct consumer_socket *socket =
 431                 caa_container_of(node, struct consumer_socket, node);
 432
 433         free(socket);
 434 }
 435
 436 /*
 437  * Destroy and free socket pointer in a call RCU. Read side lock must be
 438  * acquired before calling this function.
 439  */
 440 void consumer_destroy_socket(struct consumer_socket *sock)
 441 {
 442         assert(sock);
 443
 444         /*
 445          * We DO NOT close the file descriptor here since it is global to the
 446          * session daemon and is closed only if the consumer dies or a custom
 447          * consumer was registered,
 448          */
 449         if (sock->registered) {
 450                 DBG3("Consumer socket was registered. Closing fd %d", *sock->fd_ptr);
 451                 lttcomm_close_unix_sock(*sock->fd_ptr);
 452         }
 453
 454         call_rcu(&sock->node.head, destroy_socket_rcu);
 455 }
 456
 457 /*
 458  * Allocate and assign data to a consumer_output object.
 459  *
 460  * Return pointer to structure.
 461  */
 462 struct consumer_output *consumer_create_output(enum consumer_dst_type type)
 463 {
 464         struct consumer_output *output = NULL;
 465
 466         output = zmalloc(sizeof(struct consumer_output));
 467         if (output == NULL) {
 468                 PERROR("zmalloc consumer_output");
 469                 goto error;
 470         }
 471
 472         /* By default, consumer output is enabled */
 473         output->enabled = 1;
 474         output->type = type;
 475         output->net_seq_index = (uint64_t) -1ULL;
 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 void consumer_destroy_output(struct consumer_output *obj)
 511 {
 512         if (obj == NULL) {
 513                 return;
 514         }
 515
 516         consumer_destroy_output_sockets(obj);
 517
 518         if (obj->socks) {
 519                 /* Finally destroy HT */
 520                 ht_cleanup_push(obj->socks);
 521         }
 522
 523         free(obj);
 524 }
 525
 526 /*
 527  * Copy consumer output and returned the newly allocated copy.
 528  *
 529  * Should *NOT* be called with RCU read-side lock held.
 530  */
 531 struct consumer_output *consumer_copy_output(struct consumer_output *obj)
 532 {
 533         int ret;
 534         struct lttng_ht *tmp_ht_ptr;
 535         struct consumer_output *output;
 536
 537         assert(obj);
 538
 539         output = consumer_create_output(obj->type);
 540         if (output == NULL) {
 541                 goto error;
 542         }
 543         /* Avoid losing the HT reference after the memcpy() */
 544         tmp_ht_ptr = output->socks;
 545
 546         memcpy(output, obj, sizeof(struct consumer_output));
 547
 548         /* Putting back the HT pointer and start copying socket(s). */
 549         output->socks = tmp_ht_ptr;
 550
 551         ret = consumer_copy_sockets(output, obj);
 552         if (ret < 0) {
 553                 goto malloc_error;
 554         }
 555
 556 error:
 557         return output;
 558
 559 malloc_error:
 560         consumer_destroy_output(output);
 561         return NULL;
 562 }
 563
 564 /*
 565  * Copy consumer sockets from src to dst.
 566  *
 567  * Return 0 on success or else a negative value.
 568  */
 569 int consumer_copy_sockets(struct consumer_output *dst,
 570                 struct consumer_output *src)
 571 {
 572         int ret = 0;
 573         struct lttng_ht_iter iter;
 574         struct consumer_socket *socket, *copy_sock;
 575
 576         assert(dst);
 577         assert(src);
 578
 579         rcu_read_lock();
 580         cds_lfht_for_each_entry(src->socks->ht, &iter.iter, socket, node.node) {
 581                 /* Ignore socket that are already there. */
 582                 copy_sock = consumer_find_socket(*socket->fd_ptr, dst);
 583                 if (copy_sock) {
 584                         continue;
 585                 }
 586
 587                 /* Create new socket object. */
 588                 copy_sock = consumer_allocate_socket(socket->fd_ptr);
 589                 if (copy_sock == NULL) {
 590                         rcu_read_unlock();
 591                         ret = -ENOMEM;
 592                         goto error;
 593                 }
 594
 595                 copy_sock->registered = socket->registered;
 596                 /*
 597                  * This is valid because this lock is shared accross all consumer
 598                  * object being the global lock of the consumer data structure of the
 599                  * session daemon.
 600                  */
 601                 copy_sock->lock = socket->lock;
 602                 consumer_add_socket(copy_sock, dst);
 603         }
 604         rcu_read_unlock();
 605
 606 error:
 607         return ret;
 608 }
 609
 610 /*
 611  * Set network URI to the consumer output object.
 612  *
 613  * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
 614  * error.
 615  */
 616 int consumer_set_network_uri(struct consumer_output *obj,
 617                 struct lttng_uri *uri)
 618 {
 619         int ret;
 620         char tmp_path[PATH_MAX];
 621         char hostname[HOST_NAME_MAX];
 622         struct lttng_uri *dst_uri = NULL;
 623
 624         /* Code flow error safety net. */
 625         assert(obj);
 626         assert(uri);
 627
 628         switch (uri->stype) {
 629         case LTTNG_STREAM_CONTROL:
 630                 dst_uri = &obj->dst.net.control;
 631                 obj->dst.net.control_isset = 1;
 632                 if (uri->port == 0) {
 633                         /* Assign default port. */
 634                         uri->port = DEFAULT_NETWORK_CONTROL_PORT;
 635                 } else {
 636                         if (obj->dst.net.data_isset && uri->port ==
 637                                         obj->dst.net.data.port) {
 638                                 ret = -LTTNG_ERR_INVALID;
 639                                 goto error;
 640                         }
 641                 }
 642                 DBG3("Consumer control URI set with port %d", uri->port);
 643                 break;
 644         case LTTNG_STREAM_DATA:
 645                 dst_uri = &obj->dst.net.data;
 646                 obj->dst.net.data_isset = 1;
 647                 if (uri->port == 0) {
 648                         /* Assign default port. */
 649                         uri->port = DEFAULT_NETWORK_DATA_PORT;
 650                 } else {
 651                         if (obj->dst.net.control_isset && uri->port ==
 652                                         obj->dst.net.control.port) {
 653                                 ret = -LTTNG_ERR_INVALID;
 654                                 goto error;
 655                         }
 656                 }
 657                 DBG3("Consumer data URI set with port %d", uri->port);
 658                 break;
 659         default:
 660                 ERR("Set network uri type unknown %d", uri->stype);
 661                 ret = -LTTNG_ERR_INVALID;
 662                 goto error;
 663         }
 664
 665         ret = uri_compare(dst_uri, uri);
 666         if (!ret) {
 667                 /* Same URI, don't touch it and return success. */
 668                 DBG3("URI network compare are the same");
 669                 goto equal;
 670         }
 671
 672         /* URIs were not equal, replacing it. */
 673         memset(dst_uri, 0, sizeof(struct lttng_uri));
 674         memcpy(dst_uri, uri, sizeof(struct lttng_uri));
 675         obj->type = CONSUMER_DST_NET;
 676
 677         /* Handle subdir and add hostname in front. */
 678         if (dst_uri->stype == LTTNG_STREAM_CONTROL) {
 679                 /* Get hostname to append it in the pathname */
 680                 ret = gethostname(hostname, sizeof(hostname));
 681                 if (ret < 0) {
 682                         PERROR("gethostname. Fallback on default localhost");
 683                         strncpy(hostname, "localhost", sizeof(hostname));
 684                 }
 685                 hostname[sizeof(hostname) - 1] = '\0';
 686
 687                 /* Setup consumer subdir if none present in the control URI */
 688                 if (strlen(dst_uri->subdir) == 0) {
 689                         ret = snprintf(tmp_path, sizeof(tmp_path), "%s/%s",
 690                                         hostname, obj->subdir);
 691                 } else {
 692                         ret = snprintf(tmp_path, sizeof(tmp_path), "%s/%s",
 693                                         hostname, dst_uri->subdir);
 694                 }
 695                 if (ret < 0) {
 696                         PERROR("snprintf set consumer uri subdir");
 697                         ret = -LTTNG_ERR_NOMEM;
 698                         goto error;
 699                 }
 700
 701                 strncpy(obj->subdir, tmp_path, sizeof(obj->subdir));
 702                 DBG3("Consumer set network uri subdir path %s", tmp_path);
 703         }
 704
 705         return 0;
 706 equal:
 707         return 1;
 708 error:
 709         return ret;
 710 }
 711
 712 /*
 713  * Send file descriptor to consumer via sock.
 714  */
 715 int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd)
 716 {
 717         int ret;
 718
 719         assert(fds);
 720         assert(sock);
 721         assert(nb_fd > 0);
 722
 723         ret = lttcomm_send_fds_unix_sock(*sock->fd_ptr, fds, nb_fd);
 724         if (ret < 0) {
 725                 /* The above call will print a PERROR on error. */
 726                 DBG("Error when sending consumer fds on sock %d", *sock->fd_ptr);
 727                 goto error;
 728         }
 729
 730         ret = consumer_recv_status_reply(sock);
 731
 732 error:
 733         return ret;
 734 }
 735
 736 /*
 737  * Consumer send communication message structure to consumer.
 738  */
 739 int consumer_send_msg(struct consumer_socket *sock,
 740                 struct lttcomm_consumer_msg *msg)
 741 {
 742         int ret;
 743
 744         assert(msg);
 745         assert(sock);
 746
 747         ret = consumer_socket_send(sock, msg, sizeof(struct lttcomm_consumer_msg));
 748         if (ret < 0) {
 749                 goto error;
 750         }
 751
 752         ret = consumer_recv_status_reply(sock);
 753
 754 error:
 755         return ret;
 756 }
 757
 758 /*
 759  * Consumer send channel communication message structure to consumer.
 760  */
 761 int consumer_send_channel(struct consumer_socket *sock,
 762                 struct lttcomm_consumer_msg *msg)
 763 {
 764         int ret;
 765
 766         assert(msg);
 767         assert(sock);
 768
 769         ret = consumer_send_msg(sock, msg);
 770         if (ret < 0) {
 771                 goto error;
 772         }
 773
 774 error:
 775         return ret;
 776 }
 777
 778 /*
 779  * Populate the given consumer msg structure with the ask_channel command
 780  * information.
 781  */
 782 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 783                 uint64_t subbuf_size,
 784                 uint64_t num_subbuf,
 785                 int overwrite,
 786                 unsigned int switch_timer_interval,
 787                 unsigned int read_timer_interval,
 788                 unsigned int live_timer_interval,
 789                 int output,
 790                 int type,
 791                 uint64_t session_id,
 792                 const char *pathname,
 793                 const char *name,
 794                 uid_t uid,
 795                 gid_t gid,
 796                 uint64_t relayd_id,
 797                 uint64_t key,
 798                 unsigned char *uuid,
 799                 uint32_t chan_id,
 800                 uint64_t tracefile_size,
 801                 uint64_t tracefile_count,
 802                 uint64_t session_id_per_pid,
 803                 unsigned int monitor,
 804                 uint32_t ust_app_uid,
 805                 const char *shm_path)
 806 {
 807         assert(msg);
 808
 809         /* Zeroed structure */
 810         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 811
 812         msg->cmd_type = LTTNG_CONSUMER_ASK_CHANNEL_CREATION;
 813         msg->u.ask_channel.subbuf_size = subbuf_size;
 814         msg->u.ask_channel.num_subbuf = num_subbuf ;
 815         msg->u.ask_channel.overwrite = overwrite;
 816         msg->u.ask_channel.switch_timer_interval = switch_timer_interval;
 817         msg->u.ask_channel.read_timer_interval = read_timer_interval;
 818         msg->u.ask_channel.live_timer_interval = live_timer_interval;
 819         msg->u.ask_channel.output = output;
 820         msg->u.ask_channel.type = type;
 821         msg->u.ask_channel.session_id = session_id;
 822         msg->u.ask_channel.session_id_per_pid = session_id_per_pid;
 823         msg->u.ask_channel.uid = uid;
 824         msg->u.ask_channel.gid = gid;
 825         msg->u.ask_channel.relayd_id = relayd_id;
 826         msg->u.ask_channel.key = key;
 827         msg->u.ask_channel.chan_id = chan_id;
 828         msg->u.ask_channel.tracefile_size = tracefile_size;
 829         msg->u.ask_channel.tracefile_count = tracefile_count;
 830         msg->u.ask_channel.monitor = monitor;
 831         msg->u.ask_channel.ust_app_uid = ust_app_uid;
 832
 833         memcpy(msg->u.ask_channel.uuid, uuid, sizeof(msg->u.ask_channel.uuid));
 834
 835         if (pathname) {
 836                 strncpy(msg->u.ask_channel.pathname, pathname,
 837                                 sizeof(msg->u.ask_channel.pathname));
 838                 msg->u.ask_channel.pathname[sizeof(msg->u.ask_channel.pathname)-1] = '\0';
 839         }
 840
 841         strncpy(msg->u.ask_channel.name, name, sizeof(msg->u.ask_channel.name));
 842         msg->u.ask_channel.name[sizeof(msg->u.ask_channel.name) - 1] = '\0';
 843
 844         if (shm_path) {
 845                 strncpy(msg->u.ask_channel.shm_path, shm_path,
 846                         sizeof(msg->u.ask_channel.shm_path));
 847                 msg->u.ask_channel.shm_path[sizeof(msg->u.ask_channel.shm_path) - 1] = '\0';
 848         }
 849 }
 850
 851 /*
 852  * Init channel communication message structure.
 853  */
 854 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
 855                 enum lttng_consumer_command cmd,
 856                 uint64_t channel_key,
 857                 uint64_t session_id,
 858                 const char *pathname,
 859                 uid_t uid,
 860                 gid_t gid,
 861                 uint64_t relayd_id,
 862                 const char *name,
 863                 unsigned int nb_init_streams,
 864                 enum lttng_event_output output,
 865                 int type,
 866                 uint64_t tracefile_size,
 867                 uint64_t tracefile_count,
 868                 unsigned int monitor,
 869                 unsigned int live_timer_interval)
 870 {
 871         assert(msg);
 872
 873         /* Zeroed structure */
 874         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 875
 876         /* Send channel */
 877         msg->cmd_type = cmd;
 878         msg->u.channel.channel_key = channel_key;
 879         msg->u.channel.session_id = session_id;
 880         msg->u.channel.uid = uid;
 881         msg->u.channel.gid = gid;
 882         msg->u.channel.relayd_id = relayd_id;
 883         msg->u.channel.nb_init_streams = nb_init_streams;
 884         msg->u.channel.output = output;
 885         msg->u.channel.type = type;
 886         msg->u.channel.tracefile_size = tracefile_size;
 887         msg->u.channel.tracefile_count = tracefile_count;
 888         msg->u.channel.monitor = monitor;
 889         msg->u.channel.live_timer_interval = live_timer_interval;
 890
 891         strncpy(msg->u.channel.pathname, pathname,
 892                         sizeof(msg->u.channel.pathname));
 893         msg->u.channel.pathname[sizeof(msg->u.channel.pathname) - 1] = '\0';
 894
 895         strncpy(msg->u.channel.name, name, sizeof(msg->u.channel.name));
 896         msg->u.channel.name[sizeof(msg->u.channel.name) - 1] = '\0';
 897 }
 898
 899 /*
 900  * Init stream communication message structure.
 901  */
 902 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
 903                 enum lttng_consumer_command cmd,
 904                 uint64_t channel_key,
 905                 uint64_t stream_key,
 906                 int cpu)
 907 {
 908         assert(msg);
 909
 910         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 911
 912         msg->cmd_type = cmd;
 913         msg->u.stream.channel_key = channel_key;
 914         msg->u.stream.stream_key = stream_key;
 915         msg->u.stream.cpu = cpu;
 916 }
 917
 918 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg,
 919                 enum lttng_consumer_command cmd,
 920                 uint64_t channel_key, uint64_t net_seq_idx)
 921 {
 922         assert(msg);
 923
 924         memset(msg, 0, sizeof(struct lttcomm_consumer_msg));
 925
 926         msg->cmd_type = cmd;
 927         msg->u.sent_streams.channel_key = channel_key;
 928         msg->u.sent_streams.net_seq_idx = net_seq_idx;
 929 }
 930
 931 /*
 932  * Send stream communication structure to the consumer.
 933  */
 934 int consumer_send_stream(struct consumer_socket *sock,
 935                 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
 936                 int *fds, size_t nb_fd)
 937 {
 938         int ret;
 939
 940         assert(msg);
 941         assert(dst);
 942         assert(sock);
 943         assert(fds);
 944
 945         ret = consumer_send_msg(sock, msg);
 946         if (ret < 0) {
 947                 goto error;
 948         }
 949
 950         ret = consumer_send_fds(sock, fds, nb_fd);
 951         if (ret < 0) {
 952                 goto error;
 953         }
 954
 955 error:
 956         return ret;
 957 }
 958
 959 /*
 960  * Send relayd socket to consumer associated with a session name.
 961  *
 962  * On success return positive value. On error, negative value.
 963  */
 964 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
 965                 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
 966                 enum lttng_stream_type type, uint64_t session_id,
 967                 char *session_name, char *hostname, int session_live_timer)
 968 {
 969         int ret;
 970         struct lttcomm_consumer_msg msg;
 971
 972         /* Code flow error. Safety net. */
 973         assert(rsock);
 974         assert(consumer);
 975         assert(consumer_sock);
 976
 977         memset(&msg, 0, sizeof(msg));
 978         /* Bail out if consumer is disabled */
 979         if (!consumer->enabled) {
 980                 ret = LTTNG_OK;
 981                 goto error;
 982         }
 983
 984         if (type == LTTNG_STREAM_CONTROL) {
 985                 ret = relayd_create_session(rsock,
 986                                 &msg.u.relayd_sock.relayd_session_id,
 987                                 session_name, hostname, session_live_timer,
 988                                 consumer->snapshot);
 989                 if (ret < 0) {
 990                         /* Close the control socket. */
 991                         (void) relayd_close(rsock);
 992                         goto error;
 993                 }
 994         }
 995
 996         msg.cmd_type = LTTNG_CONSUMER_ADD_RELAYD_SOCKET;
 997         /*
 998          * Assign network consumer output index using the temporary consumer since
 999          * this call should only be made from within a set_consumer_uri() function
1000          * call in the session daemon.
1001          */
1002         msg.u.relayd_sock.net_index = consumer->net_seq_index;
1003         msg.u.relayd_sock.type = type;
1004         msg.u.relayd_sock.session_id = session_id;
1005         memcpy(&msg.u.relayd_sock.sock, rsock, sizeof(msg.u.relayd_sock.sock));
1006
1007         DBG3("Sending relayd sock info to consumer on %d", *consumer_sock->fd_ptr);
1008         ret = consumer_send_msg(consumer_sock, &msg);
1009         if (ret < 0) {
1010                 goto error;
1011         }
1012
1013         DBG3("Sending relayd socket file descriptor to consumer");
1014         ret = consumer_send_fds(consumer_sock, &rsock->sock.fd, 1);
1015         if (ret < 0) {
1016                 goto error;
1017         }
1018
1019         DBG2("Consumer relayd socket sent");
1020
1021 error:
1022         return ret;
1023 }
1024
1025 /*
1026  * Set consumer subdirectory using the session name and a generated datetime if
1027  * needed. This is appended to the current subdirectory.
1028  */
1029 int consumer_set_subdir(struct consumer_output *consumer,
1030                 const char *session_name)
1031 {
1032         int ret = 0;
1033         unsigned int have_default_name = 0;
1034         char datetime[16], tmp_path[PATH_MAX];
1035         time_t rawtime;
1036         struct tm *timeinfo;
1037
1038         assert(consumer);
1039         assert(session_name);
1040
1041         memset(tmp_path, 0, sizeof(tmp_path));
1042
1043         /* Flag if we have a default session. */
1044         if (strncmp(session_name, DEFAULT_SESSION_NAME "-",
1045                                 strlen(DEFAULT_SESSION_NAME) + 1) == 0) {
1046                 have_default_name = 1;
1047         } else {
1048                 /* Get date and time for session path */
1049                 time(&rawtime);
1050                 timeinfo = localtime(&rawtime);
1051                 strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
1052         }
1053
1054         if (have_default_name) {
1055                 ret = snprintf(tmp_path, sizeof(tmp_path),
1056                                 "%s/%s", consumer->subdir, session_name);
1057         } else {
1058                 ret = snprintf(tmp_path, sizeof(tmp_path),
1059                                 "%s/%s-%s/", consumer->subdir, session_name, datetime);
1060         }
1061         if (ret < 0) {
1062                 PERROR("snprintf session name date");
1063                 goto error;
1064         }
1065
1066         strncpy(consumer->subdir, tmp_path, sizeof(consumer->subdir));
1067         DBG2("Consumer subdir set to %s", consumer->subdir);
1068
1069 error:
1070         return ret;
1071 }
1072
1073 /*
1074  * Ask the consumer if the data is ready to read (NOT pending) for the specific
1075  * session id.
1076  *
1077  * This function has a different behavior with the consumer i.e. that it waits
1078  * for a reply from the consumer if yes or no the data is pending.
1079  */
1080 int consumer_is_data_pending(uint64_t session_id,
1081                 struct consumer_output *consumer)
1082 {
1083         int ret;
1084         int32_t ret_code = 0;  /* Default is that the data is NOT pending */
1085         struct consumer_socket *socket;
1086         struct lttng_ht_iter iter;
1087         struct lttcomm_consumer_msg msg;
1088
1089         assert(consumer);
1090
1091         DBG3("Consumer data pending for id %" PRIu64, session_id);
1092
1093         memset(&msg, 0, sizeof(msg));
1094         msg.cmd_type = LTTNG_CONSUMER_DATA_PENDING;
1095         msg.u.data_pending.session_id = session_id;
1096
1097         /* Send command for each consumer */
1098         rcu_read_lock();
1099         cds_lfht_for_each_entry(consumer->socks->ht, &iter.iter, socket,
1100                         node.node) {
1101                 pthread_mutex_lock(socket->lock);
1102                 ret = consumer_socket_send(socket, &msg, sizeof(msg));
1103                 if (ret < 0) {
1104                         pthread_mutex_unlock(socket->lock);
1105                         goto error_unlock;
1106                 }
1107
1108                 /*
1109                  * No need for a recv reply status because the answer to the command is
1110                  * the reply status message.
1111                  */
1112
1113                 ret = consumer_socket_recv(socket, &ret_code, sizeof(ret_code));
1114                 if (ret < 0) {
1115                         pthread_mutex_unlock(socket->lock);
1116                         goto error_unlock;
1117                 }
1118                 pthread_mutex_unlock(socket->lock);
1119
1120                 if (ret_code == 1) {
1121                         break;
1122                 }
1123         }
1124         rcu_read_unlock();
1125
1126         DBG("Consumer data is %s pending for session id %" PRIu64,
1127                         ret_code == 1 ? "" : "NOT", session_id);
1128         return ret_code;
1129
1130 error_unlock:
1131         rcu_read_unlock();
1132         return -1;
1133 }
1134
1135 /*
1136  * Send a flush command to consumer using the given channel key.
1137  *
1138  * Return 0 on success else a negative value.
1139  */
1140 int consumer_flush_channel(struct consumer_socket *socket, uint64_t key)
1141 {
1142         int ret;
1143         struct lttcomm_consumer_msg msg;
1144
1145         assert(socket);
1146
1147         DBG2("Consumer flush channel key %" PRIu64, key);
1148
1149         memset(&msg, 0, sizeof(msg));
1150         msg.cmd_type = LTTNG_CONSUMER_FLUSH_CHANNEL;
1151         msg.u.flush_channel.key = key;
1152
1153         pthread_mutex_lock(socket->lock);
1154         health_code_update();
1155
1156         ret = consumer_send_msg(socket, &msg);
1157         if (ret < 0) {
1158                 goto end;
1159         }
1160
1161 end:
1162         health_code_update();
1163         pthread_mutex_unlock(socket->lock);
1164         return ret;
1165 }
1166
1167 /*
1168  * Send a close metadata command to consumer using the given channel key.
1169  * Called with registry lock held.
1170  *
1171  * Return 0 on success else a negative value.
1172  */
1173 int consumer_close_metadata(struct consumer_socket *socket,
1174                 uint64_t metadata_key)
1175 {
1176         int ret;
1177         struct lttcomm_consumer_msg msg;
1178
1179         assert(socket);
1180
1181         DBG2("Consumer close metadata channel key %" PRIu64, metadata_key);
1182
1183         memset(&msg, 0, sizeof(msg));
1184         msg.cmd_type = LTTNG_CONSUMER_CLOSE_METADATA;
1185         msg.u.close_metadata.key = metadata_key;
1186
1187         pthread_mutex_lock(socket->lock);
1188         health_code_update();
1189
1190         ret = consumer_send_msg(socket, &msg);
1191         if (ret < 0) {
1192                 goto end;
1193         }
1194
1195 end:
1196         health_code_update();
1197         pthread_mutex_unlock(socket->lock);
1198         return ret;
1199 }
1200
1201 /*
1202  * Send a setup metdata command to consumer using the given channel key.
1203  *
1204  * Return 0 on success else a negative value.
1205  */
1206 int consumer_setup_metadata(struct consumer_socket *socket,
1207                 uint64_t metadata_key)
1208 {
1209         int ret;
1210         struct lttcomm_consumer_msg msg;
1211
1212         assert(socket);
1213
1214         DBG2("Consumer setup metadata channel key %" PRIu64, metadata_key);
1215
1216         memset(&msg, 0, sizeof(msg));
1217         msg.cmd_type = LTTNG_CONSUMER_SETUP_METADATA;
1218         msg.u.setup_metadata.key = metadata_key;
1219
1220         pthread_mutex_lock(socket->lock);
1221         health_code_update();
1222
1223         ret = consumer_send_msg(socket, &msg);
1224         if (ret < 0) {
1225                 goto end;
1226         }
1227
1228 end:
1229         health_code_update();
1230         pthread_mutex_unlock(socket->lock);
1231         return ret;
1232 }
1233
1234 /*
1235  * Send metadata string to consumer.
1236  * RCU read-side lock must be held to guarantee existence of socket.
1237  *
1238  * Return 0 on success else a negative value.
1239  */
1240 int consumer_push_metadata(struct consumer_socket *socket,
1241                 uint64_t metadata_key, char *metadata_str, size_t len,
1242                 size_t target_offset)
1243 {
1244         int ret;
1245         struct lttcomm_consumer_msg msg;
1246
1247         assert(socket);
1248
1249         DBG2("Consumer push metadata to consumer socket %d", *socket->fd_ptr);
1250
1251         pthread_mutex_lock(socket->lock);
1252
1253         memset(&msg, 0, sizeof(msg));
1254         msg.cmd_type = LTTNG_CONSUMER_PUSH_METADATA;
1255         msg.u.push_metadata.key = metadata_key;
1256         msg.u.push_metadata.target_offset = target_offset;
1257         msg.u.push_metadata.len = len;
1258
1259         health_code_update();
1260         ret = consumer_send_msg(socket, &msg);
1261         if (ret < 0 || len == 0) {
1262                 goto end;
1263         }
1264
1265         DBG3("Consumer pushing metadata on sock %d of len %zu", *socket->fd_ptr,
1266                         len);
1267
1268         ret = consumer_socket_send(socket, metadata_str, len);
1269         if (ret < 0) {
1270                 goto end;
1271         }
1272
1273         health_code_update();
1274         ret = consumer_recv_status_reply(socket);
1275         if (ret < 0) {
1276                 goto end;
1277         }
1278
1279 end:
1280         pthread_mutex_unlock(socket->lock);
1281         health_code_update();
1282         return ret;
1283 }
1284
1285 /*
1286  * Ask the consumer to snapshot a specific channel using the key.
1287  *
1288  * Return 0 on success or else a negative error.
1289  */
1290 int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key,
1291                 struct snapshot_output *output, int metadata, uid_t uid, gid_t gid,
1292                 const char *session_path, int wait, uint64_t nb_packets_per_stream)
1293 {
1294         int ret;
1295         struct lttcomm_consumer_msg msg;
1296
1297         assert(socket);
1298         assert(output);
1299         assert(output->consumer);
1300
1301         DBG("Consumer snapshot channel key %" PRIu64, key);
1302
1303         memset(&msg, 0, sizeof(msg));
1304         msg.cmd_type = LTTNG_CONSUMER_SNAPSHOT_CHANNEL;
1305         msg.u.snapshot_channel.key = key;
1306         msg.u.snapshot_channel.nb_packets_per_stream = nb_packets_per_stream;
1307         msg.u.snapshot_channel.metadata = metadata;
1308
1309         if (output->consumer->type == CONSUMER_DST_NET) {
1310                 msg.u.snapshot_channel.relayd_id = output->consumer->net_seq_index;
1311                 msg.u.snapshot_channel.use_relayd = 1;
1312                 ret = snprintf(msg.u.snapshot_channel.pathname,
1313                                 sizeof(msg.u.snapshot_channel.pathname),
1314                                 "%s/%s-%s-%" PRIu64 "%s", output->consumer->subdir,
1315                                 output->name, output->datetime, output->nb_snapshot,
1316                                 session_path);
1317                 if (ret < 0) {
1318                         ret = -LTTNG_ERR_NOMEM;
1319                         goto error;
1320                 }
1321         } else {
1322                 ret = snprintf(msg.u.snapshot_channel.pathname,
1323                                 sizeof(msg.u.snapshot_channel.pathname),
1324                                 "%s/%s-%s-%" PRIu64 "%s", output->consumer->dst.trace_path,
1325                                 output->name, output->datetime, output->nb_snapshot,
1326                                 session_path);
1327                 if (ret < 0) {
1328                         ret = -LTTNG_ERR_NOMEM;
1329                         goto error;
1330                 }
1331                 msg.u.snapshot_channel.relayd_id = (uint64_t) -1ULL;
1332
1333                 /* Create directory. Ignore if exist. */
1334                 ret = run_as_mkdir_recursive(msg.u.snapshot_channel.pathname,
1335                                 S_IRWXU | S_IRWXG, uid, gid);
1336                 if (ret < 0) {
1337                         if (ret != -EEXIST) {
1338                                 ERR("Trace directory creation error");
1339                                 goto error;
1340                         }
1341                 }
1342         }
1343
1344         health_code_update();
1345         ret = consumer_send_msg(socket, &msg);
1346         if (ret < 0) {
1347                 goto error;
1348         }
1349
1350 error:
1351         health_code_update();
1352         return ret;
1353 }